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 #if defined (USE_GTK) || defined (HAVE_NS)
12347 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12348 update_frame_tool_bar (f
);
12351 #else /* !USE_GTK && !HAVE_NS */
12355 struct glyph_row
*row
;
12357 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12358 do anything. This means you must start with tool-bar-lines
12359 non-zero to get the auto-sizing effect. Or in other words, you
12360 can turn off tool-bars by specifying tool-bar-lines zero. */
12361 if (!WINDOWP (f
->tool_bar_window
)
12362 || (w
= XWINDOW (f
->tool_bar_window
),
12363 WINDOW_TOTAL_LINES (w
) == 0))
12366 /* Set up an iterator for the tool-bar window. */
12367 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12368 it
.first_visible_x
= 0;
12369 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12370 row
= it
.glyph_row
;
12371 row
->reversed_p
= false;
12373 /* Build a string that represents the contents of the tool-bar. */
12374 build_desired_tool_bar_string (f
);
12375 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12376 /* FIXME: This should be controlled by a user option. But it
12377 doesn't make sense to have an R2L tool bar if the menu bar cannot
12378 be drawn also R2L, and making the menu bar R2L is tricky due
12379 toolkit-specific code that implements it. If an R2L tool bar is
12380 ever supported, display_tool_bar_line should also be augmented to
12381 call unproduce_glyphs like display_line and display_string
12383 it
.paragraph_embedding
= L2R
;
12385 if (f
->n_tool_bar_rows
== 0)
12387 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12389 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12391 x_change_tool_bar_height (f
, new_height
);
12392 frame_default_tool_bar_height
= new_height
;
12393 /* Always do that now. */
12394 clear_glyph_matrix (w
->desired_matrix
);
12395 f
->fonts_changed
= true;
12400 /* Display as many lines as needed to display all tool-bar items. */
12402 if (f
->n_tool_bar_rows
> 0)
12404 int border
, rows
, height
, extra
;
12406 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12407 border
= XINT (Vtool_bar_border
);
12408 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12409 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12410 else if (EQ (Vtool_bar_border
, Qborder_width
))
12411 border
= f
->border_width
;
12417 rows
= f
->n_tool_bar_rows
;
12418 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12419 extra
= it
.last_visible_y
- border
- height
* rows
;
12421 while (it
.current_y
< it
.last_visible_y
)
12424 if (extra
> 0 && rows
-- > 0)
12426 h
= (extra
+ rows
- 1) / rows
;
12429 display_tool_bar_line (&it
, height
+ h
);
12434 while (it
.current_y
< it
.last_visible_y
)
12435 display_tool_bar_line (&it
, 0);
12438 /* It doesn't make much sense to try scrolling in the tool-bar
12439 window, so don't do it. */
12440 w
->desired_matrix
->no_scrolling_p
= true;
12441 w
->must_be_updated_p
= true;
12443 if (!NILP (Vauto_resize_tool_bars
))
12445 bool change_height_p
= true;
12447 /* If we couldn't display everything, change the tool-bar's
12448 height if there is room for more. */
12449 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12450 change_height_p
= true;
12452 /* We subtract 1 because display_tool_bar_line advances the
12453 glyph_row pointer before returning to its caller. We want to
12454 examine the last glyph row produced by
12455 display_tool_bar_line. */
12456 row
= it
.glyph_row
- 1;
12458 /* If there are blank lines at the end, except for a partially
12459 visible blank line at the end that is smaller than
12460 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12461 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12462 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12463 change_height_p
= true;
12465 /* If row displays tool-bar items, but is partially visible,
12466 change the tool-bar's height. */
12467 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12468 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12469 change_height_p
= true;
12471 /* Resize windows as needed by changing the `tool-bar-lines'
12472 frame parameter. */
12473 if (change_height_p
)
12476 int new_height
= tool_bar_height (f
, &nrows
, true);
12478 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12479 && !f
->minimize_tool_bar_window_p
)
12480 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12481 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12482 f
->minimize_tool_bar_window_p
= false;
12484 if (change_height_p
)
12486 x_change_tool_bar_height (f
, new_height
);
12487 frame_default_tool_bar_height
= new_height
;
12488 clear_glyph_matrix (w
->desired_matrix
);
12489 f
->n_tool_bar_rows
= nrows
;
12490 f
->fonts_changed
= true;
12497 f
->minimize_tool_bar_window_p
= false;
12500 #endif /* USE_GTK || HAVE_NS */
12503 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12505 /* Get information about the tool-bar item which is displayed in GLYPH
12506 on frame F. Return in *PROP_IDX the index where tool-bar item
12507 properties start in F->tool_bar_items. Value is false if
12508 GLYPH doesn't display a tool-bar item. */
12511 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12516 /* This function can be called asynchronously, which means we must
12517 exclude any possibility that Fget_text_property signals an
12519 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12520 charpos
= max (0, charpos
);
12522 /* Get the text property `menu-item' at pos. The value of that
12523 property is the start index of this item's properties in
12524 F->tool_bar_items. */
12525 prop
= Fget_text_property (make_number (charpos
),
12526 Qmenu_item
, f
->current_tool_bar_string
);
12527 if (! INTEGERP (prop
))
12529 *prop_idx
= XINT (prop
);
12534 /* Get information about the tool-bar item at position X/Y on frame F.
12535 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12536 the current matrix of the tool-bar window of F, or NULL if not
12537 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12538 item in F->tool_bar_items. Value is
12540 -1 if X/Y is not on a tool-bar item
12541 0 if X/Y is on the same item that was highlighted before.
12545 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12546 int *hpos
, int *vpos
, int *prop_idx
)
12548 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12549 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12552 /* Find the glyph under X/Y. */
12553 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12554 if (*glyph
== NULL
)
12557 /* Get the start of this tool-bar item's properties in
12558 f->tool_bar_items. */
12559 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12562 /* Is mouse on the highlighted item? */
12563 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12564 && *vpos
>= hlinfo
->mouse_face_beg_row
12565 && *vpos
<= hlinfo
->mouse_face_end_row
12566 && (*vpos
> hlinfo
->mouse_face_beg_row
12567 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12568 && (*vpos
< hlinfo
->mouse_face_end_row
12569 || *hpos
< hlinfo
->mouse_face_end_col
12570 || hlinfo
->mouse_face_past_end
))
12578 Handle mouse button event on the tool-bar of frame F, at
12579 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12580 false for button release. MODIFIERS is event modifiers for button
12584 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12587 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12588 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12589 int hpos
, vpos
, prop_idx
;
12590 struct glyph
*glyph
;
12591 Lisp_Object enabled_p
;
12594 /* If not on the highlighted tool-bar item, and mouse-highlight is
12595 non-nil, return. This is so we generate the tool-bar button
12596 click only when the mouse button is released on the same item as
12597 where it was pressed. However, when mouse-highlight is disabled,
12598 generate the click when the button is released regardless of the
12599 highlight, since tool-bar items are not highlighted in that
12601 frame_to_window_pixel_xy (w
, &x
, &y
);
12602 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12604 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12607 /* When mouse-highlight is off, generate the click for the item
12608 where the button was pressed, disregarding where it was
12610 if (NILP (Vmouse_highlight
) && !down_p
)
12611 prop_idx
= f
->last_tool_bar_item
;
12613 /* If item is disabled, do nothing. */
12614 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12615 if (NILP (enabled_p
))
12620 /* Show item in pressed state. */
12621 if (!NILP (Vmouse_highlight
))
12622 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12623 f
->last_tool_bar_item
= prop_idx
;
12627 Lisp_Object key
, frame
;
12628 struct input_event event
;
12629 EVENT_INIT (event
);
12631 /* Show item in released state. */
12632 if (!NILP (Vmouse_highlight
))
12633 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12635 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12637 XSETFRAME (frame
, f
);
12638 event
.kind
= TOOL_BAR_EVENT
;
12639 event
.frame_or_window
= frame
;
12641 kbd_buffer_store_event (&event
);
12643 event
.kind
= TOOL_BAR_EVENT
;
12644 event
.frame_or_window
= frame
;
12646 event
.modifiers
= modifiers
;
12647 kbd_buffer_store_event (&event
);
12648 f
->last_tool_bar_item
= -1;
12653 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12654 tool-bar window-relative coordinates X/Y. Called from
12655 note_mouse_highlight. */
12658 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12660 Lisp_Object window
= f
->tool_bar_window
;
12661 struct window
*w
= XWINDOW (window
);
12662 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12663 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12665 struct glyph
*glyph
;
12666 struct glyph_row
*row
;
12668 Lisp_Object enabled_p
;
12670 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12674 /* Function note_mouse_highlight is called with negative X/Y
12675 values when mouse moves outside of the frame. */
12676 if (x
<= 0 || y
<= 0)
12678 clear_mouse_face (hlinfo
);
12682 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12685 /* Not on tool-bar item. */
12686 clear_mouse_face (hlinfo
);
12690 /* On same tool-bar item as before. */
12691 goto set_help_echo
;
12693 clear_mouse_face (hlinfo
);
12695 /* Mouse is down, but on different tool-bar item? */
12696 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12697 && f
== dpyinfo
->last_mouse_frame
);
12699 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12702 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12704 /* If tool-bar item is not enabled, don't highlight it. */
12705 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12706 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12708 /* Compute the x-position of the glyph. In front and past the
12709 image is a space. We include this in the highlighted area. */
12710 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12711 for (i
= x
= 0; i
< hpos
; ++i
)
12712 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12714 /* Record this as the current active region. */
12715 hlinfo
->mouse_face_beg_col
= hpos
;
12716 hlinfo
->mouse_face_beg_row
= vpos
;
12717 hlinfo
->mouse_face_beg_x
= x
;
12718 hlinfo
->mouse_face_past_end
= false;
12720 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12721 hlinfo
->mouse_face_end_row
= vpos
;
12722 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12723 hlinfo
->mouse_face_window
= window
;
12724 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12726 /* Display it as active. */
12727 show_mouse_face (hlinfo
, draw
);
12732 /* Set help_echo_string to a help string to display for this tool-bar item.
12733 XTread_socket does the rest. */
12734 help_echo_object
= help_echo_window
= Qnil
;
12735 help_echo_pos
= -1;
12736 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12737 if (NILP (help_echo_string
))
12738 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12741 #endif /* !USE_GTK && !HAVE_NS */
12743 #endif /* HAVE_WINDOW_SYSTEM */
12747 /************************************************************************
12748 Horizontal scrolling
12749 ************************************************************************/
12751 /* For all leaf windows in the window tree rooted at WINDOW, set their
12752 hscroll value so that PT is (i) visible in the window, and (ii) so
12753 that it is not within a certain margin at the window's left and
12754 right border. Value is true if any window's hscroll has been
12758 hscroll_window_tree (Lisp_Object window
)
12760 bool hscrolled_p
= false;
12761 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12762 int hscroll_step_abs
= 0;
12763 double hscroll_step_rel
= 0;
12765 if (hscroll_relative_p
)
12767 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12768 if (hscroll_step_rel
< 0)
12770 hscroll_relative_p
= false;
12771 hscroll_step_abs
= 0;
12774 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12776 hscroll_step_abs
= XINT (Vhscroll_step
);
12777 if (hscroll_step_abs
< 0)
12778 hscroll_step_abs
= 0;
12781 hscroll_step_abs
= 0;
12783 while (WINDOWP (window
))
12785 struct window
*w
= XWINDOW (window
);
12787 if (WINDOWP (w
->contents
))
12788 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12789 else if (w
->cursor
.vpos
>= 0)
12792 int text_area_width
;
12793 struct glyph_row
*cursor_row
;
12794 struct glyph_row
*bottom_row
;
12796 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12797 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12798 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12800 cursor_row
= bottom_row
- 1;
12802 if (!cursor_row
->enabled_p
)
12804 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12805 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12806 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12808 cursor_row
= bottom_row
- 1;
12810 bool row_r2l_p
= cursor_row
->reversed_p
;
12812 text_area_width
= window_box_width (w
, TEXT_AREA
);
12814 /* Scroll when cursor is inside this scroll margin. */
12815 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12817 /* If the position of this window's point has explicitly
12818 changed, no more suspend auto hscrolling. */
12819 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12820 w
->suspend_auto_hscroll
= false;
12822 /* Remember window point. */
12823 Fset_marker (w
->old_pointm
,
12824 ((w
== XWINDOW (selected_window
))
12825 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12826 : Fmarker_position (w
->pointm
)),
12829 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12830 && !w
->suspend_auto_hscroll
12831 /* In some pathological cases, like restoring a window
12832 configuration into a frame that is much smaller than
12833 the one from which the configuration was saved, we
12834 get glyph rows whose start and end have zero buffer
12835 positions, which we cannot handle below. Just skip
12837 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12838 /* For left-to-right rows, hscroll when cursor is either
12839 (i) inside the right hscroll margin, or (ii) if it is
12840 inside the left margin and the window is already
12843 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12844 || (cursor_row
->enabled_p
12845 && cursor_row
->truncated_on_right_p
12846 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12847 /* For right-to-left rows, the logic is similar,
12848 except that rules for scrolling to left and right
12849 are reversed. E.g., if cursor.x <= h_margin, we
12850 need to hscroll "to the right" unconditionally,
12851 and that will scroll the screen to the left so as
12852 to reveal the next portion of the row. */
12854 && ((cursor_row
->enabled_p
12855 /* FIXME: It is confusing to set the
12856 truncated_on_right_p flag when R2L rows
12857 are actually truncated on the left. */
12858 && cursor_row
->truncated_on_right_p
12859 && w
->cursor
.x
<= h_margin
)
12861 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12865 struct buffer
*saved_current_buffer
;
12869 /* Find point in a display of infinite width. */
12870 saved_current_buffer
= current_buffer
;
12871 current_buffer
= XBUFFER (w
->contents
);
12873 if (w
== XWINDOW (selected_window
))
12876 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12878 /* Move iterator to pt starting at cursor_row->start in
12879 a line with infinite width. */
12880 init_to_row_start (&it
, w
, cursor_row
);
12881 it
.last_visible_x
= INFINITY
;
12882 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12883 current_buffer
= saved_current_buffer
;
12885 /* Position cursor in window. */
12886 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12887 hscroll
= max (0, (it
.current_x
12888 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12889 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12890 : (text_area_width
/ 2))))
12891 / FRAME_COLUMN_WIDTH (it
.f
);
12892 else if ((!row_r2l_p
12893 && w
->cursor
.x
>= text_area_width
- h_margin
)
12894 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12896 if (hscroll_relative_p
)
12897 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12900 wanted_x
= text_area_width
12901 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12904 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12908 if (hscroll_relative_p
)
12909 wanted_x
= text_area_width
* hscroll_step_rel
12912 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12915 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12917 hscroll
= max (hscroll
, w
->min_hscroll
);
12919 /* Don't prevent redisplay optimizations if hscroll
12920 hasn't changed, as it will unnecessarily slow down
12922 if (w
->hscroll
!= hscroll
)
12924 struct buffer
*b
= XBUFFER (w
->contents
);
12925 b
->prevent_redisplay_optimizations_p
= true;
12926 w
->hscroll
= hscroll
;
12927 hscrolled_p
= true;
12935 /* Value is true if hscroll of any leaf window has been changed. */
12936 return hscrolled_p
;
12940 /* Set hscroll so that cursor is visible and not inside horizontal
12941 scroll margins for all windows in the tree rooted at WINDOW. See
12942 also hscroll_window_tree above. Value is true if any window's
12943 hscroll has been changed. If it has, desired matrices on the frame
12944 of WINDOW are cleared. */
12947 hscroll_windows (Lisp_Object window
)
12949 bool hscrolled_p
= hscroll_window_tree (window
);
12951 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12952 return hscrolled_p
;
12957 /************************************************************************
12959 ************************************************************************/
12961 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12962 This is sometimes handy to have in a debugger session. */
12966 /* First and last unchanged row for try_window_id. */
12968 static int debug_first_unchanged_at_end_vpos
;
12969 static int debug_last_unchanged_at_beg_vpos
;
12971 /* Delta vpos and y. */
12973 static int debug_dvpos
, debug_dy
;
12975 /* Delta in characters and bytes for try_window_id. */
12977 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12979 /* Values of window_end_pos and window_end_vpos at the end of
12982 static ptrdiff_t debug_end_vpos
;
12984 /* Append a string to W->desired_matrix->method. FMT is a printf
12985 format string. If trace_redisplay_p is true also printf the
12986 resulting string to stderr. */
12988 static void debug_method_add (struct window
*, char const *, ...)
12989 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12992 debug_method_add (struct window
*w
, char const *fmt
, ...)
12995 char *method
= w
->desired_matrix
->method
;
12996 int len
= strlen (method
);
12997 int size
= sizeof w
->desired_matrix
->method
;
12998 int remaining
= size
- len
- 1;
13001 if (len
&& remaining
)
13004 --remaining
, ++len
;
13007 va_start (ap
, fmt
);
13008 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13011 if (trace_redisplay_p
)
13012 fprintf (stderr
, "%p (%s): %s\n",
13014 ((BUFFERP (w
->contents
)
13015 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13016 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13021 #endif /* GLYPH_DEBUG */
13024 /* Value is true if all changes in window W, which displays
13025 current_buffer, are in the text between START and END. START is a
13026 buffer position, END is given as a distance from Z. Used in
13027 redisplay_internal for display optimization. */
13030 text_outside_line_unchanged_p (struct window
*w
,
13031 ptrdiff_t start
, ptrdiff_t end
)
13033 bool unchanged_p
= true;
13035 /* If text or overlays have changed, see where. */
13036 if (window_outdated (w
))
13038 /* Gap in the line? */
13039 if (GPT
< start
|| Z
- GPT
< end
)
13040 unchanged_p
= false;
13042 /* Changes start in front of the line, or end after it? */
13044 && (BEG_UNCHANGED
< start
- 1
13045 || END_UNCHANGED
< end
))
13046 unchanged_p
= false;
13048 /* If selective display, can't optimize if changes start at the
13049 beginning of the line. */
13051 && INTEGERP (BVAR (current_buffer
, selective_display
))
13052 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13053 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13054 unchanged_p
= false;
13056 /* If there are overlays at the start or end of the line, these
13057 may have overlay strings with newlines in them. A change at
13058 START, for instance, may actually concern the display of such
13059 overlay strings as well, and they are displayed on different
13060 lines. So, quickly rule out this case. (For the future, it
13061 might be desirable to implement something more telling than
13062 just BEG/END_UNCHANGED.) */
13065 if (BEG
+ BEG_UNCHANGED
== start
13066 && overlay_touches_p (start
))
13067 unchanged_p
= false;
13068 if (END_UNCHANGED
== end
13069 && overlay_touches_p (Z
- end
))
13070 unchanged_p
= false;
13073 /* Under bidi reordering, adding or deleting a character in the
13074 beginning of a paragraph, before the first strong directional
13075 character, can change the base direction of the paragraph (unless
13076 the buffer specifies a fixed paragraph direction), which will
13077 require to redisplay the whole paragraph. It might be worthwhile
13078 to find the paragraph limits and widen the range of redisplayed
13079 lines to that, but for now just give up this optimization. */
13080 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13081 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13082 unchanged_p
= false;
13085 return unchanged_p
;
13089 /* Do a frame update, taking possible shortcuts into account. This is
13090 the main external entry point for redisplay.
13092 If the last redisplay displayed an echo area message and that message
13093 is no longer requested, we clear the echo area or bring back the
13094 mini-buffer if that is in use. */
13099 redisplay_internal ();
13104 overlay_arrow_string_or_property (Lisp_Object var
)
13108 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13111 return Voverlay_arrow_string
;
13114 /* Return true if there are any overlay-arrows in current_buffer. */
13116 overlay_arrow_in_current_buffer_p (void)
13120 for (vlist
= Voverlay_arrow_variable_list
;
13122 vlist
= XCDR (vlist
))
13124 Lisp_Object var
= XCAR (vlist
);
13127 if (!SYMBOLP (var
))
13129 val
= find_symbol_value (var
);
13131 && current_buffer
== XMARKER (val
)->buffer
)
13138 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13142 overlay_arrows_changed_p (void)
13146 for (vlist
= Voverlay_arrow_variable_list
;
13148 vlist
= XCDR (vlist
))
13150 Lisp_Object var
= XCAR (vlist
);
13151 Lisp_Object val
, pstr
;
13153 if (!SYMBOLP (var
))
13155 val
= find_symbol_value (var
);
13156 if (!MARKERP (val
))
13158 if (! EQ (COERCE_MARKER (val
),
13159 Fget (var
, Qlast_arrow_position
))
13160 || ! (pstr
= overlay_arrow_string_or_property (var
),
13161 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13167 /* Mark overlay arrows to be updated on next redisplay. */
13170 update_overlay_arrows (int up_to_date
)
13174 for (vlist
= Voverlay_arrow_variable_list
;
13176 vlist
= XCDR (vlist
))
13178 Lisp_Object var
= XCAR (vlist
);
13180 if (!SYMBOLP (var
))
13183 if (up_to_date
> 0)
13185 Lisp_Object val
= find_symbol_value (var
);
13186 Fput (var
, Qlast_arrow_position
,
13187 COERCE_MARKER (val
));
13188 Fput (var
, Qlast_arrow_string
,
13189 overlay_arrow_string_or_property (var
));
13191 else if (up_to_date
< 0
13192 || !NILP (Fget (var
, Qlast_arrow_position
)))
13194 Fput (var
, Qlast_arrow_position
, Qt
);
13195 Fput (var
, Qlast_arrow_string
, Qt
);
13201 /* Return overlay arrow string to display at row.
13202 Return integer (bitmap number) for arrow bitmap in left fringe.
13203 Return nil if no overlay arrow. */
13206 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13210 for (vlist
= Voverlay_arrow_variable_list
;
13212 vlist
= XCDR (vlist
))
13214 Lisp_Object var
= XCAR (vlist
);
13217 if (!SYMBOLP (var
))
13220 val
= find_symbol_value (var
);
13223 && current_buffer
== XMARKER (val
)->buffer
13224 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13226 if (FRAME_WINDOW_P (it
->f
)
13227 /* FIXME: if ROW->reversed_p is set, this should test
13228 the right fringe, not the left one. */
13229 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13231 #ifdef HAVE_WINDOW_SYSTEM
13232 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13234 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13235 if (fringe_bitmap
!= 0)
13236 return make_number (fringe_bitmap
);
13239 return make_number (-1); /* Use default arrow bitmap. */
13241 return overlay_arrow_string_or_property (var
);
13248 /* Return true if point moved out of or into a composition. Otherwise
13249 return false. PREV_BUF and PREV_PT are the last point buffer and
13250 position. BUF and PT are the current point buffer and position. */
13253 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13254 struct buffer
*buf
, ptrdiff_t pt
)
13256 ptrdiff_t start
, end
;
13258 Lisp_Object buffer
;
13260 XSETBUFFER (buffer
, buf
);
13261 /* Check a composition at the last point if point moved within the
13263 if (prev_buf
== buf
)
13266 /* Point didn't move. */
13269 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13270 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13271 && composition_valid_p (start
, end
, prop
)
13272 && start
< prev_pt
&& end
> prev_pt
)
13273 /* The last point was within the composition. Return true iff
13274 point moved out of the composition. */
13275 return (pt
<= start
|| pt
>= end
);
13278 /* Check a composition at the current point. */
13279 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13280 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13281 && composition_valid_p (start
, end
, prop
)
13282 && start
< pt
&& end
> pt
);
13285 /* Reconsider the clip changes of buffer which is displayed in W. */
13288 reconsider_clip_changes (struct window
*w
)
13290 struct buffer
*b
= XBUFFER (w
->contents
);
13292 if (b
->clip_changed
13293 && w
->window_end_valid
13294 && w
->current_matrix
->buffer
== b
13295 && w
->current_matrix
->zv
== BUF_ZV (b
)
13296 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13297 b
->clip_changed
= false;
13299 /* If display wasn't paused, and W is not a tool bar window, see if
13300 point has been moved into or out of a composition. In that case,
13301 set b->clip_changed to force updating the screen. If
13302 b->clip_changed has already been set, skip this check. */
13303 if (!b
->clip_changed
&& w
->window_end_valid
)
13305 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13306 ? PT
: marker_position (w
->pointm
));
13308 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13309 && check_point_in_composition (w
->current_matrix
->buffer
,
13310 w
->last_point
, b
, pt
))
13311 b
->clip_changed
= true;
13316 propagate_buffer_redisplay (void)
13317 { /* Resetting b->text->redisplay is problematic!
13318 We can't just reset it in the case that some window that displays
13319 it has not been redisplayed; and such a window can stay
13320 unredisplayed for a long time if it's currently invisible.
13321 But we do want to reset it at the end of redisplay otherwise
13322 its displayed windows will keep being redisplayed over and over
13324 So we copy all b->text->redisplay flags up to their windows here,
13325 such that mark_window_display_accurate can safely reset
13326 b->text->redisplay. */
13327 Lisp_Object ws
= window_list ();
13328 for (; CONSP (ws
); ws
= XCDR (ws
))
13330 struct window
*thisw
= XWINDOW (XCAR (ws
));
13331 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13332 if (thisb
->text
->redisplay
)
13333 thisw
->redisplay
= true;
13337 #define STOP_POLLING \
13338 do { if (! polling_stopped_here) stop_polling (); \
13339 polling_stopped_here = true; } while (false)
13341 #define RESUME_POLLING \
13342 do { if (polling_stopped_here) start_polling (); \
13343 polling_stopped_here = false; } while (false)
13346 /* Perhaps in the future avoid recentering windows if it
13347 is not necessary; currently that causes some problems. */
13350 redisplay_internal (void)
13352 struct window
*w
= XWINDOW (selected_window
);
13356 bool must_finish
= false, match_p
;
13357 struct text_pos tlbufpos
, tlendpos
;
13358 int number_of_visible_frames
;
13361 bool polling_stopped_here
= false;
13362 Lisp_Object tail
, frame
;
13364 /* True means redisplay has to consider all windows on all
13365 frames. False, only selected_window is considered. */
13366 bool consider_all_windows_p
;
13368 /* True means redisplay has to redisplay the miniwindow. */
13369 bool update_miniwindow_p
= false;
13371 /* True means we need to redraw frames whose 'redisplay' bit is set. */
13372 bool consider_some_frames_p
= false;
13374 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13376 /* No redisplay if running in batch mode or frame is not yet fully
13377 initialized, or redisplay is explicitly turned off by setting
13378 Vinhibit_redisplay. */
13379 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13380 || !NILP (Vinhibit_redisplay
))
13383 /* Don't examine these until after testing Vinhibit_redisplay.
13384 When Emacs is shutting down, perhaps because its connection to
13385 X has dropped, we should not look at them at all. */
13386 fr
= XFRAME (w
->frame
);
13387 sf
= SELECTED_FRAME ();
13389 if (!fr
->glyphs_initialized_p
)
13392 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13393 if (popup_activated ())
13397 /* I don't think this happens but let's be paranoid. */
13398 if (redisplaying_p
)
13401 /* Record a function that clears redisplaying_p
13402 when we leave this function. */
13403 count
= SPECPDL_INDEX ();
13404 record_unwind_protect_void (unwind_redisplay
);
13405 redisplaying_p
= true;
13406 specbind (Qinhibit_free_realized_faces
, Qnil
);
13408 /* Record this function, so it appears on the profiler's backtraces. */
13409 record_in_backtrace (Qredisplay_internal
, 0, 0);
13411 FOR_EACH_FRAME (tail
, frame
)
13412 XFRAME (frame
)->already_hscrolled_p
= false;
13415 /* Remember the currently selected window. */
13419 forget_escape_and_glyphless_faces ();
13421 inhibit_free_realized_faces
= false;
13423 consider_some_frames_p
= false;
13425 /* If face_change, init_iterator will free all realized faces, which
13426 includes the faces referenced from current matrices. So, we
13427 can't reuse current matrices in this case. */
13429 windows_or_buffers_changed
= 47;
13431 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13432 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13434 /* Since frames on a single ASCII terminal share the same
13435 display area, displaying a different frame means redisplay
13436 the whole thing. */
13437 SET_FRAME_GARBAGED (sf
);
13439 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13441 FRAME_TTY (sf
)->previous_frame
= sf
;
13444 /* Set the visible flags for all frames. Do this before checking for
13445 resized or garbaged frames; they want to know if their frames are
13446 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13447 number_of_visible_frames
= 0;
13449 FOR_EACH_FRAME (tail
, frame
)
13451 struct frame
*f
= XFRAME (frame
);
13453 if (FRAME_VISIBLE_P (f
))
13455 ++number_of_visible_frames
;
13456 /* Adjust matrices for visible frames only. */
13457 if (f
->fonts_changed
)
13459 adjust_frame_glyphs (f
);
13460 /* Disable all redisplay optimizations for this frame.
13461 This is because adjust_frame_glyphs resets the
13462 enabled_p flag for all glyph rows of all windows, so
13463 many optimizations will fail anyway, and some might
13464 fail to test that flag and do bogus things as
13466 SET_FRAME_GARBAGED (f
);
13467 f
->fonts_changed
= false;
13469 /* If cursor type has been changed on the frame
13470 other than selected, consider all frames. */
13471 if (f
!= sf
&& f
->cursor_type_changed
)
13472 fset_redisplay (f
);
13474 clear_desired_matrices (f
);
13477 /* Notice any pending interrupt request to change frame size. */
13478 do_pending_window_change (true);
13480 /* do_pending_window_change could change the selected_window due to
13481 frame resizing which makes the selected window too small. */
13482 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13485 /* Clear frames marked as garbaged. */
13486 clear_garbaged_frames ();
13488 /* Build menubar and tool-bar items. */
13489 if (NILP (Vmemory_full
))
13490 prepare_menu_bars ();
13492 reconsider_clip_changes (w
);
13494 /* In most cases selected window displays current buffer. */
13495 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13498 /* Detect case that we need to write or remove a star in the mode line. */
13499 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13500 w
->update_mode_line
= true;
13502 if (mode_line_update_needed (w
))
13503 w
->update_mode_line
= true;
13505 /* If reconsider_clip_changes above decided that the narrowing
13506 in the current buffer changed, make sure all other windows
13507 showing that buffer will be redisplayed. */
13508 if (current_buffer
->clip_changed
)
13509 bset_update_mode_line (current_buffer
);
13512 /* Normally the message* functions will have already displayed and
13513 updated the echo area, but the frame may have been trashed, or
13514 the update may have been preempted, so display the echo area
13515 again here. Checking message_cleared_p captures the case that
13516 the echo area should be cleared. */
13517 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13518 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13519 || (message_cleared_p
13520 && minibuf_level
== 0
13521 /* If the mini-window is currently selected, this means the
13522 echo-area doesn't show through. */
13523 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13525 echo_area_display (false);
13527 if (message_cleared_p
)
13528 update_miniwindow_p
= true;
13530 must_finish
= true;
13532 /* If we don't display the current message, don't clear the
13533 message_cleared_p flag, because, if we did, we wouldn't clear
13534 the echo area in the next redisplay which doesn't preserve
13536 if (!display_last_displayed_message_p
)
13537 message_cleared_p
= false;
13539 else if (EQ (selected_window
, minibuf_window
)
13540 && (current_buffer
->clip_changed
|| window_outdated (w
))
13541 && resize_mini_window (w
, false))
13543 /* Resized active mini-window to fit the size of what it is
13544 showing if its contents might have changed. */
13545 must_finish
= true;
13547 /* If window configuration was changed, frames may have been
13548 marked garbaged. Clear them or we will experience
13549 surprises wrt scrolling. */
13550 clear_garbaged_frames ();
13553 if (windows_or_buffers_changed
&& !update_mode_lines
)
13554 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13555 only the windows's contents needs to be refreshed, or whether the
13556 mode-lines also need a refresh. */
13557 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13558 ? REDISPLAY_SOME
: 32);
13560 /* If specs for an arrow have changed, do thorough redisplay
13561 to ensure we remove any arrow that should no longer exist. */
13562 if (overlay_arrows_changed_p ())
13563 /* Apparently, this is the only case where we update other windows,
13564 without updating other mode-lines. */
13565 windows_or_buffers_changed
= 49;
13567 consider_all_windows_p
= (update_mode_lines
13568 || windows_or_buffers_changed
);
13570 #define AINC(a,i) \
13572 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13573 if (INTEGERP (entry)) \
13574 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13577 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13578 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13580 /* Optimize the case that only the line containing the cursor in the
13581 selected window has changed. Variables starting with this_ are
13582 set in display_line and record information about the line
13583 containing the cursor. */
13584 tlbufpos
= this_line_start_pos
;
13585 tlendpos
= this_line_end_pos
;
13586 if (!consider_all_windows_p
13587 && CHARPOS (tlbufpos
) > 0
13588 && !w
->update_mode_line
13589 && !current_buffer
->clip_changed
13590 && !current_buffer
->prevent_redisplay_optimizations_p
13591 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13592 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13593 && !XFRAME (w
->frame
)->cursor_type_changed
13594 && !XFRAME (w
->frame
)->face_change
13595 && !XFRAME (w
->frame
)->redisplay
13596 /* Make sure recorded data applies to current buffer, etc. */
13597 && this_line_buffer
== current_buffer
13600 && !w
->optional_new_start
13601 /* Point must be on the line that we have info recorded about. */
13602 && PT
>= CHARPOS (tlbufpos
)
13603 && PT
<= Z
- CHARPOS (tlendpos
)
13604 /* All text outside that line, including its final newline,
13605 must be unchanged. */
13606 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13607 CHARPOS (tlendpos
)))
13609 if (CHARPOS (tlbufpos
) > BEGV
13610 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13611 && (CHARPOS (tlbufpos
) == ZV
13612 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13613 /* Former continuation line has disappeared by becoming empty. */
13615 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13617 /* We have to handle the case of continuation around a
13618 wide-column character (see the comment in indent.c around
13621 For instance, in the following case:
13623 -------- Insert --------
13624 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13625 J_I_ ==> J_I_ `^^' are cursors.
13629 As we have to redraw the line above, we cannot use this
13633 int line_height_before
= this_line_pixel_height
;
13635 /* Note that start_display will handle the case that the
13636 line starting at tlbufpos is a continuation line. */
13637 start_display (&it
, w
, tlbufpos
);
13639 /* Implementation note: It this still necessary? */
13640 if (it
.current_x
!= this_line_start_x
)
13643 TRACE ((stderr
, "trying display optimization 1\n"));
13644 w
->cursor
.vpos
= -1;
13645 overlay_arrow_seen
= false;
13646 it
.vpos
= this_line_vpos
;
13647 it
.current_y
= this_line_y
;
13648 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13649 display_line (&it
);
13651 /* If line contains point, is not continued,
13652 and ends at same distance from eob as before, we win. */
13653 if (w
->cursor
.vpos
>= 0
13654 /* Line is not continued, otherwise this_line_start_pos
13655 would have been set to 0 in display_line. */
13656 && CHARPOS (this_line_start_pos
)
13657 /* Line ends as before. */
13658 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13659 /* Line has same height as before. Otherwise other lines
13660 would have to be shifted up or down. */
13661 && this_line_pixel_height
== line_height_before
)
13663 /* If this is not the window's last line, we must adjust
13664 the charstarts of the lines below. */
13665 if (it
.current_y
< it
.last_visible_y
)
13667 struct glyph_row
*row
13668 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13669 ptrdiff_t delta
, delta_bytes
;
13671 /* We used to distinguish between two cases here,
13672 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13673 when the line ends in a newline or the end of the
13674 buffer's accessible portion. But both cases did
13675 the same, so they were collapsed. */
13677 - CHARPOS (tlendpos
)
13678 - MATRIX_ROW_START_CHARPOS (row
));
13679 delta_bytes
= (Z_BYTE
13680 - BYTEPOS (tlendpos
)
13681 - MATRIX_ROW_START_BYTEPOS (row
));
13683 increment_matrix_positions (w
->current_matrix
,
13684 this_line_vpos
+ 1,
13685 w
->current_matrix
->nrows
,
13686 delta
, delta_bytes
);
13689 /* If this row displays text now but previously didn't,
13690 or vice versa, w->window_end_vpos may have to be
13692 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13694 if (w
->window_end_vpos
< this_line_vpos
)
13695 w
->window_end_vpos
= this_line_vpos
;
13697 else if (w
->window_end_vpos
== this_line_vpos
13698 && this_line_vpos
> 0)
13699 w
->window_end_vpos
= this_line_vpos
- 1;
13700 w
->window_end_valid
= false;
13702 /* Update hint: No need to try to scroll in update_window. */
13703 w
->desired_matrix
->no_scrolling_p
= true;
13706 *w
->desired_matrix
->method
= 0;
13707 debug_method_add (w
, "optimization 1");
13709 #ifdef HAVE_WINDOW_SYSTEM
13710 update_window_fringes (w
, false);
13717 else if (/* Cursor position hasn't changed. */
13718 PT
== w
->last_point
13719 /* Make sure the cursor was last displayed
13720 in this window. Otherwise we have to reposition it. */
13722 /* PXW: Must be converted to pixels, probably. */
13723 && 0 <= w
->cursor
.vpos
13724 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13728 do_pending_window_change (true);
13729 /* If selected_window changed, redisplay again. */
13730 if (WINDOWP (selected_window
)
13731 && (w
= XWINDOW (selected_window
)) != sw
)
13734 /* We used to always goto end_of_redisplay here, but this
13735 isn't enough if we have a blinking cursor. */
13736 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13737 goto end_of_redisplay
;
13741 /* If highlighting the region, or if the cursor is in the echo area,
13742 then we can't just move the cursor. */
13743 else if (NILP (Vshow_trailing_whitespace
)
13744 && !cursor_in_echo_area
)
13747 struct glyph_row
*row
;
13749 /* Skip from tlbufpos to PT and see where it is. Note that
13750 PT may be in invisible text. If so, we will end at the
13751 next visible position. */
13752 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13753 NULL
, DEFAULT_FACE_ID
);
13754 it
.current_x
= this_line_start_x
;
13755 it
.current_y
= this_line_y
;
13756 it
.vpos
= this_line_vpos
;
13758 /* The call to move_it_to stops in front of PT, but
13759 moves over before-strings. */
13760 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13762 if (it
.vpos
== this_line_vpos
13763 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13766 eassert (this_line_vpos
== it
.vpos
);
13767 eassert (this_line_y
== it
.current_y
);
13768 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13770 *w
->desired_matrix
->method
= 0;
13771 debug_method_add (w
, "optimization 3");
13780 /* Text changed drastically or point moved off of line. */
13781 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13784 CHARPOS (this_line_start_pos
) = 0;
13785 ++clear_face_cache_count
;
13786 #ifdef HAVE_WINDOW_SYSTEM
13787 ++clear_image_cache_count
;
13790 /* Build desired matrices, and update the display. If
13791 consider_all_windows_p, do it for all windows on all frames. If
13792 a frame's 'redisplay' flag is set, do it for all windows on each
13793 such frame. Otherwise do it for selected_window, only. */
13795 if (!consider_all_windows_p
)
13797 FOR_EACH_FRAME (tail
, frame
)
13799 if (XFRAME (frame
)->redisplay
13800 && XFRAME (frame
) != sf
13801 && !FRAME_INITIAL_P (XFRAME (frame
)))
13803 consider_some_frames_p
= true;
13809 if (consider_all_windows_p
|| consider_some_frames_p
)
13811 FOR_EACH_FRAME (tail
, frame
)
13813 if (XFRAME (frame
)->redisplay
|| consider_all_windows_p
)
13814 XFRAME (frame
)->updated_p
= false;
13817 propagate_buffer_redisplay ();
13819 FOR_EACH_FRAME (tail
, frame
)
13821 struct frame
*f
= XFRAME (frame
);
13823 /* We don't have to do anything for unselected terminal
13825 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13826 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13829 if (!consider_all_windows_p
&& !f
->redisplay
)
13833 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13836 /* Only GC scrollbars when we redisplay the whole frame. */
13837 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13838 /* Mark all the scroll bars to be removed; we'll redeem
13839 the ones we want when we redisplay their windows. */
13840 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13841 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13843 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13844 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13845 /* Remember that the invisible frames need to be redisplayed next
13846 time they're visible. */
13847 else if (!REDISPLAY_SOME_P ())
13848 f
->redisplay
= true;
13850 /* The X error handler may have deleted that frame. */
13851 if (!FRAME_LIVE_P (f
))
13854 /* Any scroll bars which redisplay_windows should have
13855 nuked should now go away. */
13856 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13857 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13859 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13861 /* If fonts changed on visible frame, display again. */
13862 if (f
->fonts_changed
)
13864 adjust_frame_glyphs (f
);
13865 /* Disable all redisplay optimizations for this
13866 frame. For the reasons, see the comment near
13867 the previous call to adjust_frame_glyphs above. */
13868 SET_FRAME_GARBAGED (f
);
13869 f
->fonts_changed
= false;
13873 /* See if we have to hscroll. */
13874 if (!f
->already_hscrolled_p
)
13876 f
->already_hscrolled_p
= true;
13877 if (hscroll_windows (f
->root_window
))
13881 /* Prevent various kinds of signals during display
13882 update. stdio is not robust about handling
13883 signals, which can cause an apparent I/O error. */
13884 if (interrupt_input
)
13885 unrequest_sigio ();
13888 pending
|= update_frame (f
, false, false);
13889 f
->cursor_type_changed
= false;
13890 f
->updated_p
= true;
13895 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13899 /* Do the mark_window_display_accurate after all windows have
13900 been redisplayed because this call resets flags in buffers
13901 which are needed for proper redisplay. */
13902 FOR_EACH_FRAME (tail
, frame
)
13904 struct frame
*f
= XFRAME (frame
);
13907 f
->redisplay
= false;
13908 mark_window_display_accurate (f
->root_window
, true);
13909 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13910 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13915 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13917 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13918 struct frame
*mini_frame
;
13920 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13921 /* Use list_of_error, not Qerror, so that
13922 we catch only errors and don't run the debugger. */
13923 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13925 redisplay_window_error
);
13926 if (update_miniwindow_p
)
13927 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13929 redisplay_window_error
);
13931 /* Compare desired and current matrices, perform output. */
13934 /* If fonts changed, display again. */
13935 if (sf
->fonts_changed
)
13938 /* Prevent freeing of realized faces, since desired matrices are
13939 pending that reference the faces we computed and cached. */
13940 inhibit_free_realized_faces
= true;
13942 /* Prevent various kinds of signals during display update.
13943 stdio is not robust about handling signals,
13944 which can cause an apparent I/O error. */
13945 if (interrupt_input
)
13946 unrequest_sigio ();
13949 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13951 if (hscroll_windows (selected_window
))
13954 XWINDOW (selected_window
)->must_be_updated_p
= true;
13955 pending
= update_frame (sf
, false, false);
13956 sf
->cursor_type_changed
= false;
13959 /* We may have called echo_area_display at the top of this
13960 function. If the echo area is on another frame, that may
13961 have put text on a frame other than the selected one, so the
13962 above call to update_frame would not have caught it. Catch
13964 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13965 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13967 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13969 XWINDOW (mini_window
)->must_be_updated_p
= true;
13970 pending
|= update_frame (mini_frame
, false, false);
13971 mini_frame
->cursor_type_changed
= false;
13972 if (!pending
&& hscroll_windows (mini_window
))
13977 /* If display was paused because of pending input, make sure we do a
13978 thorough update the next time. */
13981 /* Prevent the optimization at the beginning of
13982 redisplay_internal that tries a single-line update of the
13983 line containing the cursor in the selected window. */
13984 CHARPOS (this_line_start_pos
) = 0;
13986 /* Let the overlay arrow be updated the next time. */
13987 update_overlay_arrows (0);
13989 /* If we pause after scrolling, some rows in the current
13990 matrices of some windows are not valid. */
13991 if (!WINDOW_FULL_WIDTH_P (w
)
13992 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13993 update_mode_lines
= 36;
13997 if (!consider_all_windows_p
)
13999 /* This has already been done above if
14000 consider_all_windows_p is set. */
14001 if (XBUFFER (w
->contents
)->text
->redisplay
14002 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14003 /* This can happen if b->text->redisplay was set during
14005 propagate_buffer_redisplay ();
14006 mark_window_display_accurate_1 (w
, true);
14008 /* Say overlay arrows are up to date. */
14009 update_overlay_arrows (1);
14011 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14012 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14015 update_mode_lines
= 0;
14016 windows_or_buffers_changed
= 0;
14019 /* Start SIGIO interrupts coming again. Having them off during the
14020 code above makes it less likely one will discard output, but not
14021 impossible, since there might be stuff in the system buffer here.
14022 But it is much hairier to try to do anything about that. */
14023 if (interrupt_input
)
14027 /* If a frame has become visible which was not before, redisplay
14028 again, so that we display it. Expose events for such a frame
14029 (which it gets when becoming visible) don't call the parts of
14030 redisplay constructing glyphs, so simply exposing a frame won't
14031 display anything in this case. So, we have to display these
14032 frames here explicitly. */
14037 FOR_EACH_FRAME (tail
, frame
)
14039 if (XFRAME (frame
)->visible
)
14043 if (new_count
!= number_of_visible_frames
)
14044 windows_or_buffers_changed
= 52;
14047 /* Change frame size now if a change is pending. */
14048 do_pending_window_change (true);
14050 /* If we just did a pending size change, or have additional
14051 visible frames, or selected_window changed, redisplay again. */
14052 if ((windows_or_buffers_changed
&& !pending
)
14053 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14056 /* Clear the face and image caches.
14058 We used to do this only if consider_all_windows_p. But the cache
14059 needs to be cleared if a timer creates images in the current
14060 buffer (e.g. the test case in Bug#6230). */
14062 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14064 clear_face_cache (false);
14065 clear_face_cache_count
= 0;
14068 #ifdef HAVE_WINDOW_SYSTEM
14069 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14071 clear_image_caches (Qnil
);
14072 clear_image_cache_count
= 0;
14074 #endif /* HAVE_WINDOW_SYSTEM */
14078 ns_set_doc_edited ();
14080 if (interrupt_input
&& interrupts_deferred
)
14083 unbind_to (count
, Qnil
);
14088 /* Redisplay, but leave alone any recent echo area message unless
14089 another message has been requested in its place.
14091 This is useful in situations where you need to redisplay but no
14092 user action has occurred, making it inappropriate for the message
14093 area to be cleared. See tracking_off and
14094 wait_reading_process_output for examples of these situations.
14096 FROM_WHERE is an integer saying from where this function was
14097 called. This is useful for debugging. */
14100 redisplay_preserve_echo_area (int from_where
)
14102 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14104 if (!NILP (echo_area_buffer
[1]))
14106 /* We have a previously displayed message, but no current
14107 message. Redisplay the previous message. */
14108 display_last_displayed_message_p
= true;
14109 redisplay_internal ();
14110 display_last_displayed_message_p
= false;
14113 redisplay_internal ();
14115 flush_frame (SELECTED_FRAME ());
14119 /* Function registered with record_unwind_protect in redisplay_internal. */
14122 unwind_redisplay (void)
14124 redisplaying_p
= false;
14128 /* Mark the display of leaf window W as accurate or inaccurate.
14129 If ACCURATE_P, mark display of W as accurate.
14130 If !ACCURATE_P, arrange for W to be redisplayed the next
14131 time redisplay_internal is called. */
14134 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14136 struct buffer
*b
= XBUFFER (w
->contents
);
14138 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14139 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14140 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14144 b
->clip_changed
= false;
14145 b
->prevent_redisplay_optimizations_p
= false;
14146 eassert (buffer_window_count (b
) > 0);
14147 /* Resetting b->text->redisplay is problematic!
14148 In order to make it safer to do it here, redisplay_internal must
14149 have copied all b->text->redisplay to their respective windows. */
14150 b
->text
->redisplay
= false;
14152 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14153 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14154 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14155 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14157 w
->current_matrix
->buffer
= b
;
14158 w
->current_matrix
->begv
= BUF_BEGV (b
);
14159 w
->current_matrix
->zv
= BUF_ZV (b
);
14161 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14162 w
->last_cursor_off_p
= w
->cursor_off_p
;
14164 if (w
== XWINDOW (selected_window
))
14165 w
->last_point
= BUF_PT (b
);
14167 w
->last_point
= marker_position (w
->pointm
);
14169 w
->window_end_valid
= true;
14170 w
->update_mode_line
= false;
14173 w
->redisplay
= !accurate_p
;
14177 /* Mark the display of windows in the window tree rooted at WINDOW as
14178 accurate or inaccurate. If ACCURATE_P, mark display of
14179 windows as accurate. If !ACCURATE_P, arrange for windows to
14180 be redisplayed the next time redisplay_internal is called. */
14183 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14187 for (; !NILP (window
); window
= w
->next
)
14189 w
= XWINDOW (window
);
14190 if (WINDOWP (w
->contents
))
14191 mark_window_display_accurate (w
->contents
, accurate_p
);
14193 mark_window_display_accurate_1 (w
, accurate_p
);
14197 update_overlay_arrows (1);
14199 /* Force a thorough redisplay the next time by setting
14200 last_arrow_position and last_arrow_string to t, which is
14201 unequal to any useful value of Voverlay_arrow_... */
14202 update_overlay_arrows (-1);
14206 /* Return value in display table DP (Lisp_Char_Table *) for character
14207 C. Since a display table doesn't have any parent, we don't have to
14208 follow parent. Do not call this function directly but use the
14209 macro DISP_CHAR_VECTOR. */
14212 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14216 if (ASCII_CHAR_P (c
))
14219 if (SUB_CHAR_TABLE_P (val
))
14220 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14226 XSETCHAR_TABLE (table
, dp
);
14227 val
= char_table_ref (table
, c
);
14236 /***********************************************************************
14238 ***********************************************************************/
14240 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14243 redisplay_windows (Lisp_Object window
)
14245 while (!NILP (window
))
14247 struct window
*w
= XWINDOW (window
);
14249 if (WINDOWP (w
->contents
))
14250 redisplay_windows (w
->contents
);
14251 else if (BUFFERP (w
->contents
))
14253 displayed_buffer
= XBUFFER (w
->contents
);
14254 /* Use list_of_error, not Qerror, so that
14255 we catch only errors and don't run the debugger. */
14256 internal_condition_case_1 (redisplay_window_0
, window
,
14258 redisplay_window_error
);
14266 redisplay_window_error (Lisp_Object ignore
)
14268 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14273 redisplay_window_0 (Lisp_Object window
)
14275 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14276 redisplay_window (window
, false);
14281 redisplay_window_1 (Lisp_Object window
)
14283 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14284 redisplay_window (window
, true);
14289 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14290 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14291 which positions recorded in ROW differ from current buffer
14294 Return true iff cursor is on this row. */
14297 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14298 struct glyph_matrix
*matrix
,
14299 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14302 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14303 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14304 struct glyph
*cursor
= NULL
;
14305 /* The last known character position in row. */
14306 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14308 ptrdiff_t pt_old
= PT
- delta
;
14309 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14310 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14311 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14312 /* A glyph beyond the edge of TEXT_AREA which we should never
14314 struct glyph
*glyphs_end
= end
;
14315 /* True means we've found a match for cursor position, but that
14316 glyph has the avoid_cursor_p flag set. */
14317 bool match_with_avoid_cursor
= false;
14318 /* True means we've seen at least one glyph that came from a
14320 bool string_seen
= false;
14321 /* Largest and smallest buffer positions seen so far during scan of
14323 ptrdiff_t bpos_max
= pos_before
;
14324 ptrdiff_t bpos_min
= pos_after
;
14325 /* Last buffer position covered by an overlay string with an integer
14326 `cursor' property. */
14327 ptrdiff_t bpos_covered
= 0;
14328 /* True means the display string on which to display the cursor
14329 comes from a text property, not from an overlay. */
14330 bool string_from_text_prop
= false;
14332 /* Don't even try doing anything if called for a mode-line or
14333 header-line row, since the rest of the code isn't prepared to
14334 deal with such calamities. */
14335 eassert (!row
->mode_line_p
);
14336 if (row
->mode_line_p
)
14339 /* Skip over glyphs not having an object at the start and the end of
14340 the row. These are special glyphs like truncation marks on
14341 terminal frames. */
14342 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14344 if (!row
->reversed_p
)
14347 && NILP (glyph
->object
)
14348 && glyph
->charpos
< 0)
14350 x
+= glyph
->pixel_width
;
14354 && NILP ((end
- 1)->object
)
14355 /* CHARPOS is zero for blanks and stretch glyphs
14356 inserted by extend_face_to_end_of_line. */
14357 && (end
- 1)->charpos
<= 0)
14359 glyph_before
= glyph
- 1;
14366 /* If the glyph row is reversed, we need to process it from back
14367 to front, so swap the edge pointers. */
14368 glyphs_end
= end
= glyph
- 1;
14369 glyph
+= row
->used
[TEXT_AREA
] - 1;
14371 while (glyph
> end
+ 1
14372 && NILP (glyph
->object
)
14373 && glyph
->charpos
< 0)
14376 x
-= glyph
->pixel_width
;
14378 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14380 /* By default, in reversed rows we put the cursor on the
14381 rightmost (first in the reading order) glyph. */
14382 for (g
= end
+ 1; g
< glyph
; g
++)
14383 x
+= g
->pixel_width
;
14385 && NILP ((end
+ 1)->object
)
14386 && (end
+ 1)->charpos
<= 0)
14388 glyph_before
= glyph
+ 1;
14392 else if (row
->reversed_p
)
14394 /* In R2L rows that don't display text, put the cursor on the
14395 rightmost glyph. Case in point: an empty last line that is
14396 part of an R2L paragraph. */
14398 /* Avoid placing the cursor on the last glyph of the row, where
14399 on terminal frames we hold the vertical border between
14400 adjacent windows. */
14401 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14402 && !WINDOW_RIGHTMOST_P (w
)
14403 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14405 x
= -1; /* will be computed below, at label compute_x */
14408 /* Step 1: Try to find the glyph whose character position
14409 corresponds to point. If that's not possible, find 2 glyphs
14410 whose character positions are the closest to point, one before
14411 point, the other after it. */
14412 if (!row
->reversed_p
)
14413 while (/* not marched to end of glyph row */
14415 /* glyph was not inserted by redisplay for internal purposes */
14416 && !NILP (glyph
->object
))
14418 if (BUFFERP (glyph
->object
))
14420 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14422 if (glyph
->charpos
> bpos_max
)
14423 bpos_max
= glyph
->charpos
;
14424 if (glyph
->charpos
< bpos_min
)
14425 bpos_min
= glyph
->charpos
;
14426 if (!glyph
->avoid_cursor_p
)
14428 /* If we hit point, we've found the glyph on which to
14429 display the cursor. */
14432 match_with_avoid_cursor
= false;
14435 /* See if we've found a better approximation to
14436 POS_BEFORE or to POS_AFTER. */
14437 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14439 pos_before
= glyph
->charpos
;
14440 glyph_before
= glyph
;
14442 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14444 pos_after
= glyph
->charpos
;
14445 glyph_after
= glyph
;
14448 else if (dpos
== 0)
14449 match_with_avoid_cursor
= true;
14451 else if (STRINGP (glyph
->object
))
14453 Lisp_Object chprop
;
14454 ptrdiff_t glyph_pos
= glyph
->charpos
;
14456 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14458 if (!NILP (chprop
))
14460 /* If the string came from a `display' text property,
14461 look up the buffer position of that property and
14462 use that position to update bpos_max, as if we
14463 actually saw such a position in one of the row's
14464 glyphs. This helps with supporting integer values
14465 of `cursor' property on the display string in
14466 situations where most or all of the row's buffer
14467 text is completely covered by display properties,
14468 so that no glyph with valid buffer positions is
14469 ever seen in the row. */
14470 ptrdiff_t prop_pos
=
14471 string_buffer_position_lim (glyph
->object
, pos_before
,
14474 if (prop_pos
>= pos_before
)
14475 bpos_max
= prop_pos
;
14477 if (INTEGERP (chprop
))
14479 bpos_covered
= bpos_max
+ XINT (chprop
);
14480 /* If the `cursor' property covers buffer positions up
14481 to and including point, we should display cursor on
14482 this glyph. Note that, if a `cursor' property on one
14483 of the string's characters has an integer value, we
14484 will break out of the loop below _before_ we get to
14485 the position match above. IOW, integer values of
14486 the `cursor' property override the "exact match for
14487 point" strategy of positioning the cursor. */
14488 /* Implementation note: bpos_max == pt_old when, e.g.,
14489 we are in an empty line, where bpos_max is set to
14490 MATRIX_ROW_START_CHARPOS, see above. */
14491 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14498 string_seen
= true;
14500 x
+= glyph
->pixel_width
;
14503 else if (glyph
> end
) /* row is reversed */
14504 while (!NILP (glyph
->object
))
14506 if (BUFFERP (glyph
->object
))
14508 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14510 if (glyph
->charpos
> bpos_max
)
14511 bpos_max
= glyph
->charpos
;
14512 if (glyph
->charpos
< bpos_min
)
14513 bpos_min
= glyph
->charpos
;
14514 if (!glyph
->avoid_cursor_p
)
14518 match_with_avoid_cursor
= false;
14521 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14523 pos_before
= glyph
->charpos
;
14524 glyph_before
= glyph
;
14526 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14528 pos_after
= glyph
->charpos
;
14529 glyph_after
= glyph
;
14532 else if (dpos
== 0)
14533 match_with_avoid_cursor
= true;
14535 else if (STRINGP (glyph
->object
))
14537 Lisp_Object chprop
;
14538 ptrdiff_t glyph_pos
= glyph
->charpos
;
14540 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14542 if (!NILP (chprop
))
14544 ptrdiff_t prop_pos
=
14545 string_buffer_position_lim (glyph
->object
, pos_before
,
14548 if (prop_pos
>= pos_before
)
14549 bpos_max
= prop_pos
;
14551 if (INTEGERP (chprop
))
14553 bpos_covered
= bpos_max
+ XINT (chprop
);
14554 /* If the `cursor' property covers buffer positions up
14555 to and including point, we should display cursor on
14557 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14563 string_seen
= true;
14566 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14568 x
--; /* can't use any pixel_width */
14571 x
-= glyph
->pixel_width
;
14574 /* Step 2: If we didn't find an exact match for point, we need to
14575 look for a proper place to put the cursor among glyphs between
14576 GLYPH_BEFORE and GLYPH_AFTER. */
14577 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14578 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14579 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14581 /* An empty line has a single glyph whose OBJECT is nil and
14582 whose CHARPOS is the position of a newline on that line.
14583 Note that on a TTY, there are more glyphs after that, which
14584 were produced by extend_face_to_end_of_line, but their
14585 CHARPOS is zero or negative. */
14586 bool empty_line_p
=
14587 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14588 && NILP (glyph
->object
) && glyph
->charpos
> 0
14589 /* On a TTY, continued and truncated rows also have a glyph at
14590 their end whose OBJECT is nil and whose CHARPOS is
14591 positive (the continuation and truncation glyphs), but such
14592 rows are obviously not "empty". */
14593 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14595 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14597 ptrdiff_t ellipsis_pos
;
14599 /* Scan back over the ellipsis glyphs. */
14600 if (!row
->reversed_p
)
14602 ellipsis_pos
= (glyph
- 1)->charpos
;
14603 while (glyph
> row
->glyphs
[TEXT_AREA
]
14604 && (glyph
- 1)->charpos
== ellipsis_pos
)
14605 glyph
--, x
-= glyph
->pixel_width
;
14606 /* That loop always goes one position too far, including
14607 the glyph before the ellipsis. So scan forward over
14609 x
+= glyph
->pixel_width
;
14612 else /* row is reversed */
14614 ellipsis_pos
= (glyph
+ 1)->charpos
;
14615 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14616 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14617 glyph
++, x
+= glyph
->pixel_width
;
14618 x
-= glyph
->pixel_width
;
14622 else if (match_with_avoid_cursor
)
14624 cursor
= glyph_after
;
14627 else if (string_seen
)
14629 int incr
= row
->reversed_p
? -1 : +1;
14631 /* Need to find the glyph that came out of a string which is
14632 present at point. That glyph is somewhere between
14633 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14634 positioned between POS_BEFORE and POS_AFTER in the
14636 struct glyph
*start
, *stop
;
14637 ptrdiff_t pos
= pos_before
;
14641 /* If the row ends in a newline from a display string,
14642 reordering could have moved the glyphs belonging to the
14643 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14644 in this case we extend the search to the last glyph in
14645 the row that was not inserted by redisplay. */
14646 if (row
->ends_in_newline_from_string_p
)
14649 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14652 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14653 correspond to POS_BEFORE and POS_AFTER, respectively. We
14654 need START and STOP in the order that corresponds to the
14655 row's direction as given by its reversed_p flag. If the
14656 directionality of characters between POS_BEFORE and
14657 POS_AFTER is the opposite of the row's base direction,
14658 these characters will have been reordered for display,
14659 and we need to reverse START and STOP. */
14660 if (!row
->reversed_p
)
14662 start
= min (glyph_before
, glyph_after
);
14663 stop
= max (glyph_before
, glyph_after
);
14667 start
= max (glyph_before
, glyph_after
);
14668 stop
= min (glyph_before
, glyph_after
);
14670 for (glyph
= start
+ incr
;
14671 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14674 /* Any glyphs that come from the buffer are here because
14675 of bidi reordering. Skip them, and only pay
14676 attention to glyphs that came from some string. */
14677 if (STRINGP (glyph
->object
))
14681 /* If the display property covers the newline, we
14682 need to search for it one position farther. */
14683 ptrdiff_t lim
= pos_after
14684 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14686 string_from_text_prop
= false;
14687 str
= glyph
->object
;
14688 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14689 if (tem
== 0 /* from overlay */
14692 /* If the string from which this glyph came is
14693 found in the buffer at point, or at position
14694 that is closer to point than pos_after, then
14695 we've found the glyph we've been looking for.
14696 If it comes from an overlay (tem == 0), and
14697 it has the `cursor' property on one of its
14698 glyphs, record that glyph as a candidate for
14699 displaying the cursor. (As in the
14700 unidirectional version, we will display the
14701 cursor on the last candidate we find.) */
14704 || (tem
- pt_old
> 0 && tem
< pos_after
))
14706 /* The glyphs from this string could have
14707 been reordered. Find the one with the
14708 smallest string position. Or there could
14709 be a character in the string with the
14710 `cursor' property, which means display
14711 cursor on that character's glyph. */
14712 ptrdiff_t strpos
= glyph
->charpos
;
14717 string_from_text_prop
= true;
14720 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14721 && EQ (glyph
->object
, str
);
14725 ptrdiff_t gpos
= glyph
->charpos
;
14727 cprop
= Fget_char_property (make_number (gpos
),
14735 if (tem
&& glyph
->charpos
< strpos
)
14737 strpos
= glyph
->charpos
;
14743 || (tem
- pt_old
> 0 && tem
< pos_after
))
14747 pos
= tem
+ 1; /* don't find previous instances */
14749 /* This string is not what we want; skip all of the
14750 glyphs that came from it. */
14751 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14752 && EQ (glyph
->object
, str
))
14759 /* If we reached the end of the line, and END was from a string,
14760 the cursor is not on this line. */
14762 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14763 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14764 && STRINGP (end
->object
)
14765 && row
->continued_p
)
14768 /* A truncated row may not include PT among its character positions.
14769 Setting the cursor inside the scroll margin will trigger
14770 recalculation of hscroll in hscroll_window_tree. But if a
14771 display string covers point, defer to the string-handling
14772 code below to figure this out. */
14773 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14775 cursor
= glyph_before
;
14778 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14779 /* Zero-width characters produce no glyphs. */
14781 && (row
->reversed_p
14782 ? glyph_after
> glyphs_end
14783 : glyph_after
< glyphs_end
)))
14785 cursor
= glyph_after
;
14791 if (cursor
!= NULL
)
14793 else if (glyph
== glyphs_end
14794 && pos_before
== pos_after
14795 && STRINGP ((row
->reversed_p
14796 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14797 : row
->glyphs
[TEXT_AREA
])->object
))
14799 /* If all the glyphs of this row came from strings, put the
14800 cursor on the first glyph of the row. This avoids having the
14801 cursor outside of the text area in this very rare and hard
14805 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14806 : row
->glyphs
[TEXT_AREA
];
14812 /* Need to compute x that corresponds to GLYPH. */
14813 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14815 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14817 x
+= g
->pixel_width
;
14821 /* ROW could be part of a continued line, which, under bidi
14822 reordering, might have other rows whose start and end charpos
14823 occlude point. Only set w->cursor if we found a better
14824 approximation to the cursor position than we have from previously
14825 examined candidate rows belonging to the same continued line. */
14826 if (/* We already have a candidate row. */
14827 w
->cursor
.vpos
>= 0
14828 /* That candidate is not the row we are processing. */
14829 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14830 /* Make sure cursor.vpos specifies a row whose start and end
14831 charpos occlude point, and it is valid candidate for being a
14832 cursor-row. This is because some callers of this function
14833 leave cursor.vpos at the row where the cursor was displayed
14834 during the last redisplay cycle. */
14835 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14836 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14837 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14840 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14842 /* Don't consider glyphs that are outside TEXT_AREA. */
14843 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14845 /* Keep the candidate whose buffer position is the closest to
14846 point or has the `cursor' property. */
14847 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14848 w
->cursor
.hpos
>= 0
14849 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14850 && ((BUFFERP (g1
->object
)
14851 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14852 || (BUFFERP (glyph
->object
)
14853 && eabs (g1
->charpos
- pt_old
)
14854 < eabs (glyph
->charpos
- pt_old
))))
14855 /* Previous candidate is a glyph from a string that has
14856 a non-nil `cursor' property. */
14857 || (STRINGP (g1
->object
)
14858 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14859 Qcursor
, g1
->object
))
14860 /* Previous candidate is from the same display
14861 string as this one, and the display string
14862 came from a text property. */
14863 || (EQ (g1
->object
, glyph
->object
)
14864 && string_from_text_prop
)
14865 /* this candidate is from newline and its
14866 position is not an exact match */
14867 || (NILP (glyph
->object
)
14868 && glyph
->charpos
!= pt_old
)))))
14870 /* If this candidate gives an exact match, use that. */
14871 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14872 /* If this candidate is a glyph created for the
14873 terminating newline of a line, and point is on that
14874 newline, it wins because it's an exact match. */
14875 || (!row
->continued_p
14876 && NILP (glyph
->object
)
14877 && glyph
->charpos
== 0
14878 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14879 /* Otherwise, keep the candidate that comes from a row
14880 spanning less buffer positions. This may win when one or
14881 both candidate positions are on glyphs that came from
14882 display strings, for which we cannot compare buffer
14884 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14885 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14886 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14889 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14891 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14892 w
->cursor
.y
= row
->y
+ dy
;
14894 if (w
== XWINDOW (selected_window
))
14896 if (!row
->continued_p
14897 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14900 this_line_buffer
= XBUFFER (w
->contents
);
14902 CHARPOS (this_line_start_pos
)
14903 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14904 BYTEPOS (this_line_start_pos
)
14905 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14907 CHARPOS (this_line_end_pos
)
14908 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14909 BYTEPOS (this_line_end_pos
)
14910 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14912 this_line_y
= w
->cursor
.y
;
14913 this_line_pixel_height
= row
->height
;
14914 this_line_vpos
= w
->cursor
.vpos
;
14915 this_line_start_x
= row
->x
;
14918 CHARPOS (this_line_start_pos
) = 0;
14925 /* Run window scroll functions, if any, for WINDOW with new window
14926 start STARTP. Sets the window start of WINDOW to that position.
14928 We assume that the window's buffer is really current. */
14930 static struct text_pos
14931 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14933 struct window
*w
= XWINDOW (window
);
14934 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14936 eassert (current_buffer
== XBUFFER (w
->contents
));
14938 if (!NILP (Vwindow_scroll_functions
))
14940 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14941 make_number (CHARPOS (startp
)));
14942 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14943 /* In case the hook functions switch buffers. */
14944 set_buffer_internal (XBUFFER (w
->contents
));
14951 /* Make sure the line containing the cursor is fully visible.
14952 A value of true means there is nothing to be done.
14953 (Either the line is fully visible, or it cannot be made so,
14954 or we cannot tell.)
14956 If FORCE_P, return false even if partial visible cursor row
14957 is higher than window.
14959 If CURRENT_MATRIX_P, use the information from the
14960 window's current glyph matrix; otherwise use the desired glyph
14963 A value of false means the caller should do scrolling
14964 as if point had gone off the screen. */
14967 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14968 bool current_matrix_p
)
14970 struct glyph_matrix
*matrix
;
14971 struct glyph_row
*row
;
14974 if (!make_cursor_line_fully_visible_p
)
14977 /* It's not always possible to find the cursor, e.g, when a window
14978 is full of overlay strings. Don't do anything in that case. */
14979 if (w
->cursor
.vpos
< 0)
14982 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14983 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14985 /* If the cursor row is not partially visible, there's nothing to do. */
14986 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14989 /* If the row the cursor is in is taller than the window's height,
14990 it's not clear what to do, so do nothing. */
14991 window_height
= window_box_height (w
);
14992 if (row
->height
>= window_height
)
14994 if (!force_p
|| MINI_WINDOW_P (w
)
14995 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15002 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15003 means only WINDOW is redisplayed in redisplay_internal.
15004 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15005 in redisplay_window to bring a partially visible line into view in
15006 the case that only the cursor has moved.
15008 LAST_LINE_MISFIT should be true if we're scrolling because the
15009 last screen line's vertical height extends past the end of the screen.
15013 1 if scrolling succeeded
15015 0 if scrolling didn't find point.
15017 -1 if new fonts have been loaded so that we must interrupt
15018 redisplay, adjust glyph matrices, and try again. */
15024 SCROLLING_NEED_LARGER_MATRICES
15027 /* If scroll-conservatively is more than this, never recenter.
15029 If you change this, don't forget to update the doc string of
15030 `scroll-conservatively' and the Emacs manual. */
15031 #define SCROLL_LIMIT 100
15034 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15035 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15036 bool temp_scroll_step
, bool last_line_misfit
)
15038 struct window
*w
= XWINDOW (window
);
15039 struct frame
*f
= XFRAME (w
->frame
);
15040 struct text_pos pos
, startp
;
15042 int this_scroll_margin
, scroll_max
, rc
, height
;
15043 int dy
= 0, amount_to_scroll
= 0;
15044 bool scroll_down_p
= false;
15045 int extra_scroll_margin_lines
= last_line_misfit
;
15046 Lisp_Object aggressive
;
15047 /* We will never try scrolling more than this number of lines. */
15048 int scroll_limit
= SCROLL_LIMIT
;
15049 int frame_line_height
= default_line_pixel_height (w
);
15050 int window_total_lines
15051 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15054 debug_method_add (w
, "try_scrolling");
15057 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15059 /* Compute scroll margin height in pixels. We scroll when point is
15060 within this distance from the top or bottom of the window. */
15061 if (scroll_margin
> 0)
15062 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15063 * frame_line_height
;
15065 this_scroll_margin
= 0;
15067 /* Force arg_scroll_conservatively to have a reasonable value, to
15068 avoid scrolling too far away with slow move_it_* functions. Note
15069 that the user can supply scroll-conservatively equal to
15070 `most-positive-fixnum', which can be larger than INT_MAX. */
15071 if (arg_scroll_conservatively
> scroll_limit
)
15073 arg_scroll_conservatively
= scroll_limit
+ 1;
15074 scroll_max
= scroll_limit
* frame_line_height
;
15076 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15077 /* Compute how much we should try to scroll maximally to bring
15078 point into view. */
15079 scroll_max
= (max (scroll_step
,
15080 max (arg_scroll_conservatively
, temp_scroll_step
))
15081 * frame_line_height
);
15082 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15083 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15084 /* We're trying to scroll because of aggressive scrolling but no
15085 scroll_step is set. Choose an arbitrary one. */
15086 scroll_max
= 10 * frame_line_height
;
15092 /* Decide whether to scroll down. */
15093 if (PT
> CHARPOS (startp
))
15095 int scroll_margin_y
;
15097 /* Compute the pixel ypos of the scroll margin, then move IT to
15098 either that ypos or PT, whichever comes first. */
15099 start_display (&it
, w
, startp
);
15100 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15101 - frame_line_height
* extra_scroll_margin_lines
;
15102 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15103 (MOVE_TO_POS
| MOVE_TO_Y
));
15105 if (PT
> CHARPOS (it
.current
.pos
))
15107 int y0
= line_bottom_y (&it
);
15108 /* Compute how many pixels below window bottom to stop searching
15109 for PT. This avoids costly search for PT that is far away if
15110 the user limited scrolling by a small number of lines, but
15111 always finds PT if scroll_conservatively is set to a large
15112 number, such as most-positive-fixnum. */
15113 int slack
= max (scroll_max
, 10 * frame_line_height
);
15114 int y_to_move
= it
.last_visible_y
+ slack
;
15116 /* Compute the distance from the scroll margin to PT or to
15117 the scroll limit, whichever comes first. This should
15118 include the height of the cursor line, to make that line
15120 move_it_to (&it
, PT
, -1, y_to_move
,
15121 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15122 dy
= line_bottom_y (&it
) - y0
;
15124 if (dy
> scroll_max
)
15125 return SCROLLING_FAILED
;
15128 scroll_down_p
= true;
15134 /* Point is in or below the bottom scroll margin, so move the
15135 window start down. If scrolling conservatively, move it just
15136 enough down to make point visible. If scroll_step is set,
15137 move it down by scroll_step. */
15138 if (arg_scroll_conservatively
)
15140 = min (max (dy
, frame_line_height
),
15141 frame_line_height
* arg_scroll_conservatively
);
15142 else if (scroll_step
|| temp_scroll_step
)
15143 amount_to_scroll
= scroll_max
;
15146 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15147 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15148 if (NUMBERP (aggressive
))
15150 double float_amount
= XFLOATINT (aggressive
) * height
;
15151 int aggressive_scroll
= float_amount
;
15152 if (aggressive_scroll
== 0 && float_amount
> 0)
15153 aggressive_scroll
= 1;
15154 /* Don't let point enter the scroll margin near top of
15155 the window. This could happen if the value of
15156 scroll_up_aggressively is too large and there are
15157 non-zero margins, because scroll_up_aggressively
15158 means put point that fraction of window height
15159 _from_the_bottom_margin_. */
15160 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15161 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15162 amount_to_scroll
= dy
+ aggressive_scroll
;
15166 if (amount_to_scroll
<= 0)
15167 return SCROLLING_FAILED
;
15169 start_display (&it
, w
, startp
);
15170 if (arg_scroll_conservatively
<= scroll_limit
)
15171 move_it_vertically (&it
, amount_to_scroll
);
15174 /* Extra precision for users who set scroll-conservatively
15175 to a large number: make sure the amount we scroll
15176 the window start is never less than amount_to_scroll,
15177 which was computed as distance from window bottom to
15178 point. This matters when lines at window top and lines
15179 below window bottom have different height. */
15181 void *it1data
= NULL
;
15182 /* We use a temporary it1 because line_bottom_y can modify
15183 its argument, if it moves one line down; see there. */
15186 SAVE_IT (it1
, it
, it1data
);
15187 start_y
= line_bottom_y (&it1
);
15189 RESTORE_IT (&it
, &it
, it1data
);
15190 move_it_by_lines (&it
, 1);
15191 SAVE_IT (it1
, it
, it1data
);
15192 } while (IT_CHARPOS (it
) < ZV
15193 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15194 bidi_unshelve_cache (it1data
, true);
15197 /* If STARTP is unchanged, move it down another screen line. */
15198 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15199 move_it_by_lines (&it
, 1);
15200 startp
= it
.current
.pos
;
15204 struct text_pos scroll_margin_pos
= startp
;
15207 /* See if point is inside the scroll margin at the top of the
15209 if (this_scroll_margin
)
15213 start_display (&it
, w
, startp
);
15214 y_start
= it
.current_y
;
15215 move_it_vertically (&it
, this_scroll_margin
);
15216 scroll_margin_pos
= it
.current
.pos
;
15217 /* If we didn't move enough before hitting ZV, request
15218 additional amount of scroll, to move point out of the
15220 if (IT_CHARPOS (it
) == ZV
15221 && it
.current_y
- y_start
< this_scroll_margin
)
15222 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15225 if (PT
< CHARPOS (scroll_margin_pos
))
15227 /* Point is in the scroll margin at the top of the window or
15228 above what is displayed in the window. */
15231 /* Compute the vertical distance from PT to the scroll
15232 margin position. Move as far as scroll_max allows, or
15233 one screenful, or 10 screen lines, whichever is largest.
15234 Give up if distance is greater than scroll_max or if we
15235 didn't reach the scroll margin position. */
15236 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15237 start_display (&it
, w
, pos
);
15239 y_to_move
= max (it
.last_visible_y
,
15240 max (scroll_max
, 10 * frame_line_height
));
15241 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15243 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15244 dy
= it
.current_y
- y0
;
15245 if (dy
> scroll_max
15246 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15247 return SCROLLING_FAILED
;
15249 /* Additional scroll for when ZV was too close to point. */
15252 /* Compute new window start. */
15253 start_display (&it
, w
, startp
);
15255 if (arg_scroll_conservatively
)
15256 amount_to_scroll
= max (dy
, frame_line_height
15257 * max (scroll_step
, temp_scroll_step
));
15258 else if (scroll_step
|| temp_scroll_step
)
15259 amount_to_scroll
= scroll_max
;
15262 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15263 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15264 if (NUMBERP (aggressive
))
15266 double float_amount
= XFLOATINT (aggressive
) * height
;
15267 int aggressive_scroll
= float_amount
;
15268 if (aggressive_scroll
== 0 && float_amount
> 0)
15269 aggressive_scroll
= 1;
15270 /* Don't let point enter the scroll margin near
15271 bottom of the window, if the value of
15272 scroll_down_aggressively happens to be too
15274 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15275 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15276 amount_to_scroll
= dy
+ aggressive_scroll
;
15280 if (amount_to_scroll
<= 0)
15281 return SCROLLING_FAILED
;
15283 move_it_vertically_backward (&it
, amount_to_scroll
);
15284 startp
= it
.current
.pos
;
15288 /* Run window scroll functions. */
15289 startp
= run_window_scroll_functions (window
, startp
);
15291 /* Display the window. Give up if new fonts are loaded, or if point
15293 if (!try_window (window
, startp
, 0))
15294 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15295 else if (w
->cursor
.vpos
< 0)
15297 clear_glyph_matrix (w
->desired_matrix
);
15298 rc
= SCROLLING_FAILED
;
15302 /* Maybe forget recorded base line for line number display. */
15303 if (!just_this_one_p
15304 || current_buffer
->clip_changed
15305 || BEG_UNCHANGED
< CHARPOS (startp
))
15306 w
->base_line_number
= 0;
15308 /* If cursor ends up on a partially visible line,
15309 treat that as being off the bottom of the screen. */
15310 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15312 /* It's possible that the cursor is on the first line of the
15313 buffer, which is partially obscured due to a vscroll
15314 (Bug#7537). In that case, avoid looping forever. */
15315 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15317 clear_glyph_matrix (w
->desired_matrix
);
15318 ++extra_scroll_margin_lines
;
15321 rc
= SCROLLING_SUCCESS
;
15328 /* Compute a suitable window start for window W if display of W starts
15329 on a continuation line. Value is true if a new window start
15332 The new window start will be computed, based on W's width, starting
15333 from the start of the continued line. It is the start of the
15334 screen line with the minimum distance from the old start W->start. */
15337 compute_window_start_on_continuation_line (struct window
*w
)
15339 struct text_pos pos
, start_pos
;
15340 bool window_start_changed_p
= false;
15342 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15344 /* If window start is on a continuation line... Window start may be
15345 < BEGV in case there's invisible text at the start of the
15346 buffer (M-x rmail, for example). */
15347 if (CHARPOS (start_pos
) > BEGV
15348 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15351 struct glyph_row
*row
;
15353 /* Handle the case that the window start is out of range. */
15354 if (CHARPOS (start_pos
) < BEGV
)
15355 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15356 else if (CHARPOS (start_pos
) > ZV
)
15357 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15359 /* Find the start of the continued line. This should be fast
15360 because find_newline is fast (newline cache). */
15361 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15362 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15363 row
, DEFAULT_FACE_ID
);
15364 reseat_at_previous_visible_line_start (&it
);
15366 /* If the line start is "too far" away from the window start,
15367 say it takes too much time to compute a new window start. */
15368 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15369 /* PXW: Do we need upper bounds here? */
15370 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15372 int min_distance
, distance
;
15374 /* Move forward by display lines to find the new window
15375 start. If window width was enlarged, the new start can
15376 be expected to be > the old start. If window width was
15377 decreased, the new window start will be < the old start.
15378 So, we're looking for the display line start with the
15379 minimum distance from the old window start. */
15380 pos
= it
.current
.pos
;
15381 min_distance
= INFINITY
;
15382 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15383 distance
< min_distance
)
15385 min_distance
= distance
;
15386 pos
= it
.current
.pos
;
15387 if (it
.line_wrap
== WORD_WRAP
)
15389 /* Under WORD_WRAP, move_it_by_lines is likely to
15390 overshoot and stop not at the first, but the
15391 second character from the left margin. So in
15392 that case, we need a more tight control on the X
15393 coordinate of the iterator than move_it_by_lines
15394 promises in its contract. The method is to first
15395 go to the last (rightmost) visible character of a
15396 line, then move to the leftmost character on the
15397 next line in a separate call. */
15398 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15399 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15400 move_it_to (&it
, ZV
, 0,
15401 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15402 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15405 move_it_by_lines (&it
, 1);
15408 /* Set the window start there. */
15409 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15410 window_start_changed_p
= true;
15414 return window_start_changed_p
;
15418 /* Try cursor movement in case text has not changed in window WINDOW,
15419 with window start STARTP. Value is
15421 CURSOR_MOVEMENT_SUCCESS if successful
15423 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15425 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15426 display. *SCROLL_STEP is set to true, under certain circumstances, if
15427 we want to scroll as if scroll-step were set to 1. See the code.
15429 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15430 which case we have to abort this redisplay, and adjust matrices
15435 CURSOR_MOVEMENT_SUCCESS
,
15436 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15437 CURSOR_MOVEMENT_MUST_SCROLL
,
15438 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15442 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15445 struct window
*w
= XWINDOW (window
);
15446 struct frame
*f
= XFRAME (w
->frame
);
15447 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15450 if (inhibit_try_cursor_movement
)
15454 /* Previously, there was a check for Lisp integer in the
15455 if-statement below. Now, this field is converted to
15456 ptrdiff_t, thus zero means invalid position in a buffer. */
15457 eassert (w
->last_point
> 0);
15458 /* Likewise there was a check whether window_end_vpos is nil or larger
15459 than the window. Now window_end_vpos is int and so never nil, but
15460 let's leave eassert to check whether it fits in the window. */
15461 eassert (!w
->window_end_valid
15462 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15464 /* Handle case where text has not changed, only point, and it has
15465 not moved off the frame. */
15466 if (/* Point may be in this window. */
15467 PT
>= CHARPOS (startp
)
15468 /* Selective display hasn't changed. */
15469 && !current_buffer
->clip_changed
15470 /* Function force-mode-line-update is used to force a thorough
15471 redisplay. It sets either windows_or_buffers_changed or
15472 update_mode_lines. So don't take a shortcut here for these
15474 && !update_mode_lines
15475 && !windows_or_buffers_changed
15476 && !f
->cursor_type_changed
15478 && NILP (Vshow_trailing_whitespace
)
15479 /* This code is not used for mini-buffer for the sake of the case
15480 of redisplaying to replace an echo area message; since in
15481 that case the mini-buffer contents per se are usually
15482 unchanged. This code is of no real use in the mini-buffer
15483 since the handling of this_line_start_pos, etc., in redisplay
15484 handles the same cases. */
15485 && !EQ (window
, minibuf_window
)
15486 && (FRAME_WINDOW_P (f
)
15487 || !overlay_arrow_in_current_buffer_p ()))
15489 int this_scroll_margin
, top_scroll_margin
;
15490 struct glyph_row
*row
= NULL
;
15491 int frame_line_height
= default_line_pixel_height (w
);
15492 int window_total_lines
15493 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15496 debug_method_add (w
, "cursor movement");
15499 /* Scroll if point within this distance from the top or bottom
15500 of the window. This is a pixel value. */
15501 if (scroll_margin
> 0)
15503 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15504 this_scroll_margin
*= frame_line_height
;
15507 this_scroll_margin
= 0;
15509 top_scroll_margin
= this_scroll_margin
;
15510 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15511 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15513 /* Start with the row the cursor was displayed during the last
15514 not paused redisplay. Give up if that row is not valid. */
15515 if (w
->last_cursor_vpos
< 0
15516 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15517 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15520 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15521 if (row
->mode_line_p
)
15523 if (!row
->enabled_p
)
15524 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15527 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15529 bool scroll_p
= false, must_scroll
= false;
15530 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15532 if (PT
> w
->last_point
)
15534 /* Point has moved forward. */
15535 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15536 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15538 eassert (row
->enabled_p
);
15542 /* If the end position of a row equals the start
15543 position of the next row, and PT is at that position,
15544 we would rather display cursor in the next line. */
15545 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15546 && MATRIX_ROW_END_CHARPOS (row
) == PT
15547 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15548 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15549 && !cursor_row_p (row
))
15552 /* If within the scroll margin, scroll. Note that
15553 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15554 the next line would be drawn, and that
15555 this_scroll_margin can be zero. */
15556 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15557 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15558 /* Line is completely visible last line in window
15559 and PT is to be set in the next line. */
15560 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15561 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15562 && !row
->ends_at_zv_p
15563 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15566 else if (PT
< w
->last_point
)
15568 /* Cursor has to be moved backward. Note that PT >=
15569 CHARPOS (startp) because of the outer if-statement. */
15570 while (!row
->mode_line_p
15571 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15572 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15573 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15574 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15575 row
> w
->current_matrix
->rows
15576 && (row
-1)->ends_in_newline_from_string_p
))))
15577 && (row
->y
> top_scroll_margin
15578 || CHARPOS (startp
) == BEGV
))
15580 eassert (row
->enabled_p
);
15584 /* Consider the following case: Window starts at BEGV,
15585 there is invisible, intangible text at BEGV, so that
15586 display starts at some point START > BEGV. It can
15587 happen that we are called with PT somewhere between
15588 BEGV and START. Try to handle that case. */
15589 if (row
< w
->current_matrix
->rows
15590 || row
->mode_line_p
)
15592 row
= w
->current_matrix
->rows
;
15593 if (row
->mode_line_p
)
15597 /* Due to newlines in overlay strings, we may have to
15598 skip forward over overlay strings. */
15599 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15600 && MATRIX_ROW_END_CHARPOS (row
) == PT
15601 && !cursor_row_p (row
))
15604 /* If within the scroll margin, scroll. */
15605 if (row
->y
< top_scroll_margin
15606 && CHARPOS (startp
) != BEGV
)
15611 /* Cursor did not move. So don't scroll even if cursor line
15612 is partially visible, as it was so before. */
15613 rc
= CURSOR_MOVEMENT_SUCCESS
;
15616 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15617 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15619 /* if PT is not in the glyph row, give up. */
15620 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15621 must_scroll
= true;
15623 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15624 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15626 struct glyph_row
*row1
;
15628 /* If rows are bidi-reordered and point moved, back up
15629 until we find a row that does not belong to a
15630 continuation line. This is because we must consider
15631 all rows of a continued line as candidates for the
15632 new cursor positioning, since row start and end
15633 positions change non-linearly with vertical position
15635 /* FIXME: Revisit this when glyph ``spilling'' in
15636 continuation lines' rows is implemented for
15637 bidi-reordered rows. */
15638 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15639 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15642 /* If we hit the beginning of the displayed portion
15643 without finding the first row of a continued
15647 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15650 eassert (row
->enabled_p
);
15655 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15656 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15657 /* Make sure this isn't a header line by any chance, since
15658 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15659 && !row
->mode_line_p
15660 && make_cursor_line_fully_visible_p
)
15662 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15663 && !row
->ends_at_zv_p
15664 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15665 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15666 else if (row
->height
> window_box_height (w
))
15668 /* If we end up in a partially visible line, let's
15669 make it fully visible, except when it's taller
15670 than the window, in which case we can't do much
15672 *scroll_step
= true;
15673 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15677 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15678 if (!cursor_row_fully_visible_p (w
, false, true))
15679 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15681 rc
= CURSOR_MOVEMENT_SUCCESS
;
15685 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15686 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15687 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15689 /* With bidi-reordered rows, there could be more than
15690 one candidate row whose start and end positions
15691 occlude point. We need to let set_cursor_from_row
15692 find the best candidate. */
15693 /* FIXME: Revisit this when glyph ``spilling'' in
15694 continuation lines' rows is implemented for
15695 bidi-reordered rows. */
15700 bool at_zv_p
= false, exact_match_p
= false;
15702 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15703 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15704 && cursor_row_p (row
))
15705 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15707 /* As soon as we've found the exact match for point,
15708 or the first suitable row whose ends_at_zv_p flag
15709 is set, we are done. */
15712 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15713 w
->cursor
.vpos
)->ends_at_zv_p
;
15715 && w
->cursor
.hpos
>= 0
15716 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15719 struct glyph_row
*candidate
=
15720 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15722 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15723 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15726 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15727 || (NILP (g
->object
)
15728 && (g
->charpos
== PT
15729 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15731 if (at_zv_p
|| exact_match_p
)
15733 rc
= CURSOR_MOVEMENT_SUCCESS
;
15737 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15741 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15742 || row
->continued_p
)
15743 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15744 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15745 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15746 /* If we didn't find any candidate rows, or exited the
15747 loop before all the candidates were examined, signal
15748 to the caller that this method failed. */
15749 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15751 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15752 && !row
->continued_p
))
15753 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15755 rc
= CURSOR_MOVEMENT_SUCCESS
;
15761 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15763 rc
= CURSOR_MOVEMENT_SUCCESS
;
15768 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15769 && MATRIX_ROW_START_CHARPOS (row
) == PT
15770 && cursor_row_p (row
));
15780 set_vertical_scroll_bar (struct window
*w
)
15782 ptrdiff_t start
, end
, whole
;
15784 /* Calculate the start and end positions for the current window.
15785 At some point, it would be nice to choose between scrollbars
15786 which reflect the whole buffer size, with special markers
15787 indicating narrowing, and scrollbars which reflect only the
15790 Note that mini-buffers sometimes aren't displaying any text. */
15791 if (!MINI_WINDOW_P (w
)
15792 || (w
== XWINDOW (minibuf_window
)
15793 && NILP (echo_area_buffer
[0])))
15795 struct buffer
*buf
= XBUFFER (w
->contents
);
15796 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15797 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15798 /* I don't think this is guaranteed to be right. For the
15799 moment, we'll pretend it is. */
15800 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15804 if (whole
< (end
- start
))
15805 whole
= end
- start
;
15808 start
= end
= whole
= 0;
15810 /* Indicate what this scroll bar ought to be displaying now. */
15811 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15812 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15813 (w
, end
- start
, whole
, start
);
15818 set_horizontal_scroll_bar (struct window
*w
)
15820 int start
, end
, whole
, portion
;
15822 if (!MINI_WINDOW_P (w
)
15823 || (w
== XWINDOW (minibuf_window
)
15824 && NILP (echo_area_buffer
[0])))
15826 struct buffer
*b
= XBUFFER (w
->contents
);
15827 struct buffer
*old_buffer
= NULL
;
15829 struct text_pos startp
;
15831 if (b
!= current_buffer
)
15833 old_buffer
= current_buffer
;
15834 set_buffer_internal (b
);
15837 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15838 start_display (&it
, w
, startp
);
15839 it
.last_visible_x
= INT_MAX
;
15840 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15841 MOVE_TO_X
| MOVE_TO_Y
);
15842 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15843 window_box_height (w), -1,
15844 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15846 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15847 end
= start
+ window_box_width (w
, TEXT_AREA
);
15848 portion
= end
- start
;
15849 /* After enlarging a horizontally scrolled window such that it
15850 gets at least as wide as the text it contains, make sure that
15851 the thumb doesn't fill the entire scroll bar so we can still
15852 drag it back to see the entire text. */
15853 whole
= max (whole
, end
);
15859 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15860 if (EQ (pdir
, Qright_to_left
))
15862 start
= whole
- end
;
15863 end
= start
+ portion
;
15868 set_buffer_internal (old_buffer
);
15871 start
= end
= whole
= portion
= 0;
15873 w
->hscroll_whole
= whole
;
15875 /* Indicate what this scroll bar ought to be displaying now. */
15876 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15877 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15878 (w
, portion
, whole
, start
);
15882 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15883 selected_window is redisplayed.
15885 We can return without actually redisplaying the window if fonts has been
15886 changed on window's frame. In that case, redisplay_internal will retry.
15888 As one of the important parts of redisplaying a window, we need to
15889 decide whether the previous window-start position (stored in the
15890 window's w->start marker position) is still valid, and if it isn't,
15891 recompute it. Some details about that:
15893 . The previous window-start could be in a continuation line, in
15894 which case we need to recompute it when the window width
15895 changes. See compute_window_start_on_continuation_line and its
15898 . The text that changed since last redisplay could include the
15899 previous window-start position. In that case, we try to salvage
15900 what we can from the current glyph matrix by calling
15901 try_scrolling, which see.
15903 . Some Emacs command could force us to use a specific window-start
15904 position by setting the window's force_start flag, or gently
15905 propose doing that by setting the window's optional_new_start
15906 flag. In these cases, we try using the specified start point if
15907 that succeeds (i.e. the window desired matrix is successfully
15908 recomputed, and point location is within the window). In case
15909 of optional_new_start, we first check if the specified start
15910 position is feasible, i.e. if it will allow point to be
15911 displayed in the window. If using the specified start point
15912 fails, e.g., if new fonts are needed to be loaded, we abort the
15913 redisplay cycle and leave it up to the next cycle to figure out
15916 . Note that the window's force_start flag is sometimes set by
15917 redisplay itself, when it decides that the previous window start
15918 point is fine and should be kept. Search for "goto force_start"
15919 below to see the details. Like the values of window-start
15920 specified outside of redisplay, these internally-deduced values
15921 are tested for feasibility, and ignored if found to be
15924 . Note that the function try_window, used to completely redisplay
15925 a window, accepts the window's start point as its argument.
15926 This is used several times in the redisplay code to control
15927 where the window start will be, according to user options such
15928 as scroll-conservatively, and also to ensure the screen line
15929 showing point will be fully (as opposed to partially) visible on
15933 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15935 struct window
*w
= XWINDOW (window
);
15936 struct frame
*f
= XFRAME (w
->frame
);
15937 struct buffer
*buffer
= XBUFFER (w
->contents
);
15938 struct buffer
*old
= current_buffer
;
15939 struct text_pos lpoint
, opoint
, startp
;
15940 bool update_mode_line
;
15943 /* Record it now because it's overwritten. */
15944 bool current_matrix_up_to_date_p
= false;
15945 bool used_current_matrix_p
= false;
15946 /* This is less strict than current_matrix_up_to_date_p.
15947 It indicates that the buffer contents and narrowing are unchanged. */
15948 bool buffer_unchanged_p
= false;
15949 bool temp_scroll_step
= false;
15950 ptrdiff_t count
= SPECPDL_INDEX ();
15952 int centering_position
= -1;
15953 bool last_line_misfit
= false;
15954 ptrdiff_t beg_unchanged
, end_unchanged
;
15955 int frame_line_height
;
15957 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15961 *w
->desired_matrix
->method
= 0;
15964 if (!just_this_one_p
15965 && REDISPLAY_SOME_P ()
15967 && !w
->update_mode_line
15970 && !buffer
->text
->redisplay
15971 && BUF_PT (buffer
) == w
->last_point
)
15974 /* Make sure that both W's markers are valid. */
15975 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15976 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15978 /* We come here again if we need to run window-text-change-functions
15981 reconsider_clip_changes (w
);
15982 frame_line_height
= default_line_pixel_height (w
);
15984 /* Has the mode line to be updated? */
15985 update_mode_line
= (w
->update_mode_line
15986 || update_mode_lines
15987 || buffer
->clip_changed
15988 || buffer
->prevent_redisplay_optimizations_p
);
15990 if (!just_this_one_p
)
15991 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15992 cleverly elsewhere. */
15993 w
->must_be_updated_p
= true;
15995 if (MINI_WINDOW_P (w
))
15997 if (w
== XWINDOW (echo_area_window
)
15998 && !NILP (echo_area_buffer
[0]))
16000 if (update_mode_line
)
16001 /* We may have to update a tty frame's menu bar or a
16002 tool-bar. Example `M-x C-h C-h C-g'. */
16003 goto finish_menu_bars
;
16005 /* We've already displayed the echo area glyphs in this window. */
16006 goto finish_scroll_bars
;
16008 else if ((w
!= XWINDOW (minibuf_window
)
16009 || minibuf_level
== 0)
16010 /* When buffer is nonempty, redisplay window normally. */
16011 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16012 /* Quail displays non-mini buffers in minibuffer window.
16013 In that case, redisplay the window normally. */
16014 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16016 /* W is a mini-buffer window, but it's not active, so clear
16018 int yb
= window_text_bottom_y (w
);
16019 struct glyph_row
*row
;
16022 for (y
= 0, row
= w
->desired_matrix
->rows
;
16024 y
+= row
->height
, ++row
)
16025 blank_row (w
, row
, y
);
16026 goto finish_scroll_bars
;
16029 clear_glyph_matrix (w
->desired_matrix
);
16032 /* Otherwise set up data on this window; select its buffer and point
16034 /* Really select the buffer, for the sake of buffer-local
16036 set_buffer_internal_1 (XBUFFER (w
->contents
));
16038 current_matrix_up_to_date_p
16039 = (w
->window_end_valid
16040 && !current_buffer
->clip_changed
16041 && !current_buffer
->prevent_redisplay_optimizations_p
16042 && !window_outdated (w
));
16044 /* Run the window-text-change-functions
16045 if it is possible that the text on the screen has changed
16046 (either due to modification of the text, or any other reason). */
16047 if (!current_matrix_up_to_date_p
16048 && !NILP (Vwindow_text_change_functions
))
16050 safe_run_hooks (Qwindow_text_change_functions
);
16054 beg_unchanged
= BEG_UNCHANGED
;
16055 end_unchanged
= END_UNCHANGED
;
16057 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16059 specbind (Qinhibit_point_motion_hooks
, Qt
);
16062 = (w
->window_end_valid
16063 && !current_buffer
->clip_changed
16064 && !window_outdated (w
));
16066 /* When windows_or_buffers_changed is non-zero, we can't rely
16067 on the window end being valid, so set it to zero there. */
16068 if (windows_or_buffers_changed
)
16070 /* If window starts on a continuation line, maybe adjust the
16071 window start in case the window's width changed. */
16072 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16073 compute_window_start_on_continuation_line (w
);
16075 w
->window_end_valid
= false;
16076 /* If so, we also can't rely on current matrix
16077 and should not fool try_cursor_movement below. */
16078 current_matrix_up_to_date_p
= false;
16081 /* Some sanity checks. */
16082 CHECK_WINDOW_END (w
);
16083 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16085 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16088 if (mode_line_update_needed (w
))
16089 update_mode_line
= true;
16091 /* Point refers normally to the selected window. For any other
16092 window, set up appropriate value. */
16093 if (!EQ (window
, selected_window
))
16095 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16096 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16101 new_pt_byte
= BEGV_BYTE
;
16102 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16104 else if (new_pt
> (ZV
- 1))
16107 new_pt_byte
= ZV_BYTE
;
16108 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16111 /* We don't use SET_PT so that the point-motion hooks don't run. */
16112 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16115 /* If any of the character widths specified in the display table
16116 have changed, invalidate the width run cache. It's true that
16117 this may be a bit late to catch such changes, but the rest of
16118 redisplay goes (non-fatally) haywire when the display table is
16119 changed, so why should we worry about doing any better? */
16120 if (current_buffer
->width_run_cache
16121 || (current_buffer
->base_buffer
16122 && current_buffer
->base_buffer
->width_run_cache
))
16124 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16126 if (! disptab_matches_widthtab
16127 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16129 struct buffer
*buf
= current_buffer
;
16131 if (buf
->base_buffer
)
16132 buf
= buf
->base_buffer
;
16133 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16134 recompute_width_table (current_buffer
, disptab
);
16138 /* If window-start is screwed up, choose a new one. */
16139 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16142 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16144 /* If someone specified a new starting point but did not insist,
16145 check whether it can be used. */
16146 if ((w
->optional_new_start
|| window_frozen_p (w
))
16147 && CHARPOS (startp
) >= BEGV
16148 && CHARPOS (startp
) <= ZV
)
16150 ptrdiff_t it_charpos
;
16152 w
->optional_new_start
= false;
16153 start_display (&it
, w
, startp
);
16154 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16155 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16156 /* Record IT's position now, since line_bottom_y might change
16158 it_charpos
= IT_CHARPOS (it
);
16159 /* Make sure we set the force_start flag only if the cursor row
16160 will be fully visible. Otherwise, the code under force_start
16161 label below will try to move point back into view, which is
16162 not what the code which sets optional_new_start wants. */
16163 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16164 && !w
->force_start
)
16166 if (it_charpos
== PT
)
16167 w
->force_start
= true;
16168 /* IT may overshoot PT if text at PT is invisible. */
16169 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16170 w
->force_start
= true;
16172 if (w
->force_start
)
16174 if (window_frozen_p (w
))
16175 debug_method_add (w
, "set force_start from frozen window start");
16177 debug_method_add (w
, "set force_start from optional_new_start");
16185 /* Handle case where place to start displaying has been specified,
16186 unless the specified location is outside the accessible range. */
16187 if (w
->force_start
)
16189 /* We set this later on if we have to adjust point. */
16192 w
->force_start
= false;
16194 w
->window_end_valid
= false;
16196 /* Forget any recorded base line for line number display. */
16197 if (!buffer_unchanged_p
)
16198 w
->base_line_number
= 0;
16200 /* Redisplay the mode line. Select the buffer properly for that.
16201 Also, run the hook window-scroll-functions
16202 because we have scrolled. */
16203 /* Note, we do this after clearing force_start because
16204 if there's an error, it is better to forget about force_start
16205 than to get into an infinite loop calling the hook functions
16206 and having them get more errors. */
16207 if (!update_mode_line
16208 || ! NILP (Vwindow_scroll_functions
))
16210 update_mode_line
= true;
16211 w
->update_mode_line
= true;
16212 startp
= run_window_scroll_functions (window
, startp
);
16215 if (CHARPOS (startp
) < BEGV
)
16216 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16217 else if (CHARPOS (startp
) > ZV
)
16218 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16220 /* Redisplay, then check if cursor has been set during the
16221 redisplay. Give up if new fonts were loaded. */
16222 /* We used to issue a CHECK_MARGINS argument to try_window here,
16223 but this causes scrolling to fail when point begins inside
16224 the scroll margin (bug#148) -- cyd */
16225 if (!try_window (window
, startp
, 0))
16227 w
->force_start
= true;
16228 clear_glyph_matrix (w
->desired_matrix
);
16229 goto need_larger_matrices
;
16232 if (w
->cursor
.vpos
< 0)
16234 /* If point does not appear, try to move point so it does
16235 appear. The desired matrix has been built above, so we
16236 can use it here. */
16237 new_vpos
= window_box_height (w
) / 2;
16240 if (!cursor_row_fully_visible_p (w
, false, false))
16242 /* Point does appear, but on a line partly visible at end of window.
16243 Move it back to a fully-visible line. */
16244 new_vpos
= window_box_height (w
);
16245 /* But if window_box_height suggests a Y coordinate that is
16246 not less than we already have, that line will clearly not
16247 be fully visible, so give up and scroll the display.
16248 This can happen when the default face uses a font whose
16249 dimensions are different from the frame's default
16251 if (new_vpos
>= w
->cursor
.y
)
16253 w
->cursor
.vpos
= -1;
16254 clear_glyph_matrix (w
->desired_matrix
);
16255 goto try_to_scroll
;
16258 else if (w
->cursor
.vpos
>= 0)
16260 /* Some people insist on not letting point enter the scroll
16261 margin, even though this part handles windows that didn't
16263 int window_total_lines
16264 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16265 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16266 int pixel_margin
= margin
* frame_line_height
;
16267 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16269 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16270 below, which finds the row to move point to, advances by
16271 the Y coordinate of the _next_ row, see the definition of
16272 MATRIX_ROW_BOTTOM_Y. */
16273 if (w
->cursor
.vpos
< margin
+ header_line
)
16275 w
->cursor
.vpos
= -1;
16276 clear_glyph_matrix (w
->desired_matrix
);
16277 goto try_to_scroll
;
16281 int window_height
= window_box_height (w
);
16284 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16285 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16287 w
->cursor
.vpos
= -1;
16288 clear_glyph_matrix (w
->desired_matrix
);
16289 goto try_to_scroll
;
16294 /* If we need to move point for either of the above reasons,
16295 now actually do it. */
16298 struct glyph_row
*row
;
16300 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16301 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16304 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16305 MATRIX_ROW_START_BYTEPOS (row
));
16307 if (w
!= XWINDOW (selected_window
))
16308 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16309 else if (current_buffer
== old
)
16310 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16312 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16314 /* Re-run pre-redisplay-function so it can update the region
16315 according to the new position of point. */
16316 /* Other than the cursor, w's redisplay is done so we can set its
16317 redisplay to false. Also the buffer's redisplay can be set to
16318 false, since propagate_buffer_redisplay should have already
16319 propagated its info to `w' anyway. */
16320 w
->redisplay
= false;
16321 XBUFFER (w
->contents
)->text
->redisplay
= false;
16322 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16324 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16326 /* pre-redisplay-function made changes (e.g. move the region)
16327 that require another round of redisplay. */
16328 clear_glyph_matrix (w
->desired_matrix
);
16329 if (!try_window (window
, startp
, 0))
16330 goto need_larger_matrices
;
16333 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16335 clear_glyph_matrix (w
->desired_matrix
);
16336 goto try_to_scroll
;
16340 debug_method_add (w
, "forced window start");
16345 /* Handle case where text has not changed, only point, and it has
16346 not moved off the frame, and we are not retrying after hscroll.
16347 (current_matrix_up_to_date_p is true when retrying.) */
16348 if (current_matrix_up_to_date_p
16349 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16350 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16354 case CURSOR_MOVEMENT_SUCCESS
:
16355 used_current_matrix_p
= true;
16358 case CURSOR_MOVEMENT_MUST_SCROLL
:
16359 goto try_to_scroll
;
16365 /* If current starting point was originally the beginning of a line
16366 but no longer is, find a new starting point. */
16367 else if (w
->start_at_line_beg
16368 && !(CHARPOS (startp
) <= BEGV
16369 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16372 debug_method_add (w
, "recenter 1");
16377 /* Try scrolling with try_window_id. Value is > 0 if update has
16378 been done, it is -1 if we know that the same window start will
16379 not work. It is 0 if unsuccessful for some other reason. */
16380 else if ((tem
= try_window_id (w
)) != 0)
16383 debug_method_add (w
, "try_window_id %d", tem
);
16386 if (f
->fonts_changed
)
16387 goto need_larger_matrices
;
16391 /* Otherwise try_window_id has returned -1 which means that we
16392 don't want the alternative below this comment to execute. */
16394 else if (CHARPOS (startp
) >= BEGV
16395 && CHARPOS (startp
) <= ZV
16396 && PT
>= CHARPOS (startp
)
16397 && (CHARPOS (startp
) < ZV
16398 /* Avoid starting at end of buffer. */
16399 || CHARPOS (startp
) == BEGV
16400 || !window_outdated (w
)))
16402 int d1
, d2
, d5
, d6
;
16405 /* If first window line is a continuation line, and window start
16406 is inside the modified region, but the first change is before
16407 current window start, we must select a new window start.
16409 However, if this is the result of a down-mouse event (e.g. by
16410 extending the mouse-drag-overlay), we don't want to select a
16411 new window start, since that would change the position under
16412 the mouse, resulting in an unwanted mouse-movement rather
16413 than a simple mouse-click. */
16414 if (!w
->start_at_line_beg
16415 && NILP (do_mouse_tracking
)
16416 && CHARPOS (startp
) > BEGV
16417 && CHARPOS (startp
) > BEG
+ beg_unchanged
16418 && CHARPOS (startp
) <= Z
- end_unchanged
16419 /* Even if w->start_at_line_beg is nil, a new window may
16420 start at a line_beg, since that's how set_buffer_window
16421 sets it. So, we need to check the return value of
16422 compute_window_start_on_continuation_line. (See also
16424 && XMARKER (w
->start
)->buffer
== current_buffer
16425 && compute_window_start_on_continuation_line (w
)
16426 /* It doesn't make sense to force the window start like we
16427 do at label force_start if it is already known that point
16428 will not be fully visible in the resulting window, because
16429 doing so will move point from its correct position
16430 instead of scrolling the window to bring point into view.
16432 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16433 /* A very tall row could need more than the window height,
16434 in which case we accept that it is partially visible. */
16435 && (rtop
!= 0) == (rbot
!= 0))
16437 w
->force_start
= true;
16438 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16440 debug_method_add (w
, "recomputed window start in continuation line");
16446 debug_method_add (w
, "same window start");
16449 /* Try to redisplay starting at same place as before.
16450 If point has not moved off frame, accept the results. */
16451 if (!current_matrix_up_to_date_p
16452 /* Don't use try_window_reusing_current_matrix in this case
16453 because a window scroll function can have changed the
16455 || !NILP (Vwindow_scroll_functions
)
16456 || MINI_WINDOW_P (w
)
16457 || !(used_current_matrix_p
16458 = try_window_reusing_current_matrix (w
)))
16460 IF_DEBUG (debug_method_add (w
, "1"));
16461 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16462 /* -1 means we need to scroll.
16463 0 means we need new matrices, but fonts_changed
16464 is set in that case, so we will detect it below. */
16465 goto try_to_scroll
;
16468 if (f
->fonts_changed
)
16469 goto need_larger_matrices
;
16471 if (w
->cursor
.vpos
>= 0)
16473 if (!just_this_one_p
16474 || current_buffer
->clip_changed
16475 || BEG_UNCHANGED
< CHARPOS (startp
))
16476 /* Forget any recorded base line for line number display. */
16477 w
->base_line_number
= 0;
16479 if (!cursor_row_fully_visible_p (w
, true, false))
16481 clear_glyph_matrix (w
->desired_matrix
);
16482 last_line_misfit
= true;
16484 /* Drop through and scroll. */
16489 clear_glyph_matrix (w
->desired_matrix
);
16494 /* Redisplay the mode line. Select the buffer properly for that. */
16495 if (!update_mode_line
)
16497 update_mode_line
= true;
16498 w
->update_mode_line
= true;
16501 /* Try to scroll by specified few lines. */
16502 if ((scroll_conservatively
16503 || emacs_scroll_step
16504 || temp_scroll_step
16505 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16506 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16507 && CHARPOS (startp
) >= BEGV
16508 && CHARPOS (startp
) <= ZV
)
16510 /* The function returns -1 if new fonts were loaded, 1 if
16511 successful, 0 if not successful. */
16512 int ss
= try_scrolling (window
, just_this_one_p
,
16513 scroll_conservatively
,
16515 temp_scroll_step
, last_line_misfit
);
16518 case SCROLLING_SUCCESS
:
16521 case SCROLLING_NEED_LARGER_MATRICES
:
16522 goto need_larger_matrices
;
16524 case SCROLLING_FAILED
:
16532 /* Finally, just choose a place to start which positions point
16533 according to user preferences. */
16538 debug_method_add (w
, "recenter");
16541 /* Forget any previously recorded base line for line number display. */
16542 if (!buffer_unchanged_p
)
16543 w
->base_line_number
= 0;
16545 /* Determine the window start relative to point. */
16546 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16547 it
.current_y
= it
.last_visible_y
;
16548 if (centering_position
< 0)
16550 int window_total_lines
16551 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16553 = scroll_margin
> 0
16554 ? min (scroll_margin
, window_total_lines
/ 4)
16556 ptrdiff_t margin_pos
= CHARPOS (startp
);
16557 Lisp_Object aggressive
;
16560 /* If there is a scroll margin at the top of the window, find
16561 its character position. */
16563 /* Cannot call start_display if startp is not in the
16564 accessible region of the buffer. This can happen when we
16565 have just switched to a different buffer and/or changed
16566 its restriction. In that case, startp is initialized to
16567 the character position 1 (BEGV) because we did not yet
16568 have chance to display the buffer even once. */
16569 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16572 void *it1data
= NULL
;
16574 SAVE_IT (it1
, it
, it1data
);
16575 start_display (&it1
, w
, startp
);
16576 move_it_vertically (&it1
, margin
* frame_line_height
);
16577 margin_pos
= IT_CHARPOS (it1
);
16578 RESTORE_IT (&it
, &it
, it1data
);
16580 scrolling_up
= PT
> margin_pos
;
16583 ? BVAR (current_buffer
, scroll_up_aggressively
)
16584 : BVAR (current_buffer
, scroll_down_aggressively
);
16586 if (!MINI_WINDOW_P (w
)
16587 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16591 /* Setting scroll-conservatively overrides
16592 scroll-*-aggressively. */
16593 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16595 double float_amount
= XFLOATINT (aggressive
);
16597 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16598 if (pt_offset
== 0 && float_amount
> 0)
16600 if (pt_offset
&& margin
> 0)
16603 /* Compute how much to move the window start backward from
16604 point so that point will be displayed where the user
16608 centering_position
= it
.last_visible_y
;
16610 centering_position
-= pt_offset
;
16611 centering_position
-=
16612 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16613 + WINDOW_HEADER_LINE_HEIGHT (w
));
16614 /* Don't let point enter the scroll margin near top of
16616 if (centering_position
< margin
* frame_line_height
)
16617 centering_position
= margin
* frame_line_height
;
16620 centering_position
= margin
* frame_line_height
+ pt_offset
;
16623 /* Set the window start half the height of the window backward
16625 centering_position
= window_box_height (w
) / 2;
16627 move_it_vertically_backward (&it
, centering_position
);
16629 eassert (IT_CHARPOS (it
) >= BEGV
);
16631 /* The function move_it_vertically_backward may move over more
16632 than the specified y-distance. If it->w is small, e.g. a
16633 mini-buffer window, we may end up in front of the window's
16634 display area. Start displaying at the start of the line
16635 containing PT in this case. */
16636 if (it
.current_y
<= 0)
16638 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16639 move_it_vertically_backward (&it
, 0);
16643 it
.current_x
= it
.hpos
= 0;
16645 /* Set the window start position here explicitly, to avoid an
16646 infinite loop in case the functions in window-scroll-functions
16648 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16650 /* Run scroll hooks. */
16651 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16653 /* Redisplay the window. */
16654 if (!current_matrix_up_to_date_p
16655 || windows_or_buffers_changed
16656 || f
->cursor_type_changed
16657 /* Don't use try_window_reusing_current_matrix in this case
16658 because it can have changed the buffer. */
16659 || !NILP (Vwindow_scroll_functions
)
16660 || !just_this_one_p
16661 || MINI_WINDOW_P (w
)
16662 || !(used_current_matrix_p
16663 = try_window_reusing_current_matrix (w
)))
16664 try_window (window
, startp
, 0);
16666 /* If new fonts have been loaded (due to fontsets), give up. We
16667 have to start a new redisplay since we need to re-adjust glyph
16669 if (f
->fonts_changed
)
16670 goto need_larger_matrices
;
16672 /* If cursor did not appear assume that the middle of the window is
16673 in the first line of the window. Do it again with the next line.
16674 (Imagine a window of height 100, displaying two lines of height
16675 60. Moving back 50 from it->last_visible_y will end in the first
16677 if (w
->cursor
.vpos
< 0)
16679 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16681 clear_glyph_matrix (w
->desired_matrix
);
16682 move_it_by_lines (&it
, 1);
16683 try_window (window
, it
.current
.pos
, 0);
16685 else if (PT
< IT_CHARPOS (it
))
16687 clear_glyph_matrix (w
->desired_matrix
);
16688 move_it_by_lines (&it
, -1);
16689 try_window (window
, it
.current
.pos
, 0);
16693 /* Not much we can do about it. */
16697 /* Consider the following case: Window starts at BEGV, there is
16698 invisible, intangible text at BEGV, so that display starts at
16699 some point START > BEGV. It can happen that we are called with
16700 PT somewhere between BEGV and START. Try to handle that case,
16701 and similar ones. */
16702 if (w
->cursor
.vpos
< 0)
16704 /* First, try locating the proper glyph row for PT. */
16705 struct glyph_row
*row
=
16706 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16708 /* Sometimes point is at the beginning of invisible text that is
16709 before the 1st character displayed in the row. In that case,
16710 row_containing_pos fails to find the row, because no glyphs
16711 with appropriate buffer positions are present in the row.
16712 Therefore, we next try to find the row which shows the 1st
16713 position after the invisible text. */
16717 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16720 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16723 Lisp_Object invis_end
=
16724 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16727 if (NATNUMP (invis_end
))
16728 alt_pos
= XFASTINT (invis_end
);
16731 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16735 /* Finally, fall back on the first row of the window after the
16736 header line (if any). This is slightly better than not
16737 displaying the cursor at all. */
16740 row
= w
->current_matrix
->rows
;
16741 if (row
->mode_line_p
)
16744 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16747 if (!cursor_row_fully_visible_p (w
, false, false))
16749 /* If vscroll is enabled, disable it and try again. */
16753 clear_glyph_matrix (w
->desired_matrix
);
16757 /* Users who set scroll-conservatively to a large number want
16758 point just above/below the scroll margin. If we ended up
16759 with point's row partially visible, move the window start to
16760 make that row fully visible and out of the margin. */
16761 if (scroll_conservatively
> SCROLL_LIMIT
)
16763 int window_total_lines
16764 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16767 ? min (scroll_margin
, window_total_lines
/ 4)
16769 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16771 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16772 clear_glyph_matrix (w
->desired_matrix
);
16773 if (1 == try_window (window
, it
.current
.pos
,
16774 TRY_WINDOW_CHECK_MARGINS
))
16778 /* If centering point failed to make the whole line visible,
16779 put point at the top instead. That has to make the whole line
16780 visible, if it can be done. */
16781 if (centering_position
== 0)
16784 clear_glyph_matrix (w
->desired_matrix
);
16785 centering_position
= 0;
16791 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16792 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16793 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16795 /* Display the mode line, if we must. */
16796 if ((update_mode_line
16797 /* If window not full width, must redo its mode line
16798 if (a) the window to its side is being redone and
16799 (b) we do a frame-based redisplay. This is a consequence
16800 of how inverted lines are drawn in frame-based redisplay. */
16801 || (!just_this_one_p
16802 && !FRAME_WINDOW_P (f
)
16803 && !WINDOW_FULL_WIDTH_P (w
))
16804 /* Line number to display. */
16805 || w
->base_line_pos
> 0
16806 /* Column number is displayed and different from the one displayed. */
16807 || (w
->column_number_displayed
!= -1
16808 && (w
->column_number_displayed
!= current_column ())))
16809 /* This means that the window has a mode line. */
16810 && (WINDOW_WANTS_MODELINE_P (w
)
16811 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16814 display_mode_lines (w
);
16816 /* If mode line height has changed, arrange for a thorough
16817 immediate redisplay using the correct mode line height. */
16818 if (WINDOW_WANTS_MODELINE_P (w
)
16819 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16821 f
->fonts_changed
= true;
16822 w
->mode_line_height
= -1;
16823 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16824 = DESIRED_MODE_LINE_HEIGHT (w
);
16827 /* If header line height has changed, arrange for a thorough
16828 immediate redisplay using the correct header line height. */
16829 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16830 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16832 f
->fonts_changed
= true;
16833 w
->header_line_height
= -1;
16834 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16835 = DESIRED_HEADER_LINE_HEIGHT (w
);
16838 if (f
->fonts_changed
)
16839 goto need_larger_matrices
;
16842 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16844 w
->base_line_pos
= 0;
16845 w
->base_line_number
= 0;
16850 /* When we reach a frame's selected window, redo the frame's menu bar. */
16851 if (update_mode_line
16852 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16854 bool redisplay_menu_p
;
16856 if (FRAME_WINDOW_P (f
))
16858 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16859 || defined (HAVE_NS) || defined (USE_GTK)
16860 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16862 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16866 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16868 if (redisplay_menu_p
)
16869 display_menu_bar (w
);
16871 #ifdef HAVE_WINDOW_SYSTEM
16872 if (FRAME_WINDOW_P (f
))
16874 #if defined (USE_GTK) || defined (HAVE_NS)
16875 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16876 redisplay_tool_bar (f
);
16878 if (WINDOWP (f
->tool_bar_window
)
16879 && (FRAME_TOOL_BAR_LINES (f
) > 0
16880 || !NILP (Vauto_resize_tool_bars
))
16881 && redisplay_tool_bar (f
))
16882 ignore_mouse_drag_p
= true;
16888 #ifdef HAVE_WINDOW_SYSTEM
16889 if (FRAME_WINDOW_P (f
)
16890 && update_window_fringes (w
, (just_this_one_p
16891 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16892 || w
->pseudo_window_p
)))
16896 if (draw_window_fringes (w
, true))
16898 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16899 x_draw_right_divider (w
);
16901 x_draw_vertical_border (w
);
16907 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16908 x_draw_bottom_divider (w
);
16909 #endif /* HAVE_WINDOW_SYSTEM */
16911 /* We go to this label, with fonts_changed set, if it is
16912 necessary to try again using larger glyph matrices.
16913 We have to redeem the scroll bar even in this case,
16914 because the loop in redisplay_internal expects that. */
16915 need_larger_matrices
:
16917 finish_scroll_bars
:
16919 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16921 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16922 /* Set the thumb's position and size. */
16923 set_vertical_scroll_bar (w
);
16925 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16926 /* Set the thumb's position and size. */
16927 set_horizontal_scroll_bar (w
);
16929 /* Note that we actually used the scroll bar attached to this
16930 window, so it shouldn't be deleted at the end of redisplay. */
16931 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16932 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16935 /* Restore current_buffer and value of point in it. The window
16936 update may have changed the buffer, so first make sure `opoint'
16937 is still valid (Bug#6177). */
16938 if (CHARPOS (opoint
) < BEGV
)
16939 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16940 else if (CHARPOS (opoint
) > ZV
)
16941 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16943 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16945 set_buffer_internal_1 (old
);
16946 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16947 shorter. This can be caused by log truncation in *Messages*. */
16948 if (CHARPOS (lpoint
) <= ZV
)
16949 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16951 unbind_to (count
, Qnil
);
16955 /* Build the complete desired matrix of WINDOW with a window start
16956 buffer position POS.
16958 Value is 1 if successful. It is zero if fonts were loaded during
16959 redisplay which makes re-adjusting glyph matrices necessary, and -1
16960 if point would appear in the scroll margins.
16961 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16962 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16966 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16968 struct window
*w
= XWINDOW (window
);
16970 struct glyph_row
*last_text_row
= NULL
;
16971 struct frame
*f
= XFRAME (w
->frame
);
16972 int frame_line_height
= default_line_pixel_height (w
);
16974 /* Make POS the new window start. */
16975 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16977 /* Mark cursor position as unknown. No overlay arrow seen. */
16978 w
->cursor
.vpos
= -1;
16979 overlay_arrow_seen
= false;
16981 /* Initialize iterator and info to start at POS. */
16982 start_display (&it
, w
, pos
);
16983 it
.glyph_row
->reversed_p
= false;
16985 /* Display all lines of W. */
16986 while (it
.current_y
< it
.last_visible_y
)
16988 if (display_line (&it
))
16989 last_text_row
= it
.glyph_row
- 1;
16990 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16994 /* Don't let the cursor end in the scroll margins. */
16995 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16996 && !MINI_WINDOW_P (w
))
16998 int this_scroll_margin
;
16999 int window_total_lines
17000 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17002 if (scroll_margin
> 0)
17004 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17005 this_scroll_margin
*= frame_line_height
;
17008 this_scroll_margin
= 0;
17010 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17011 && w
->cursor
.y
< this_scroll_margin
17012 && CHARPOS (pos
) > BEGV
17013 && IT_CHARPOS (it
) < ZV
)
17014 /* rms: considering make_cursor_line_fully_visible_p here
17015 seems to give wrong results. We don't want to recenter
17016 when the last line is partly visible, we want to allow
17017 that case to be handled in the usual way. */
17018 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17020 w
->cursor
.vpos
= -1;
17021 clear_glyph_matrix (w
->desired_matrix
);
17026 /* If bottom moved off end of frame, change mode line percentage. */
17027 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17028 w
->update_mode_line
= true;
17030 /* Set window_end_pos to the offset of the last character displayed
17031 on the window from the end of current_buffer. Set
17032 window_end_vpos to its row number. */
17035 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17036 adjust_window_ends (w
, last_text_row
, false);
17038 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17039 w
->window_end_vpos
)));
17043 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17044 w
->window_end_pos
= Z
- ZV
;
17045 w
->window_end_vpos
= 0;
17048 /* But that is not valid info until redisplay finishes. */
17049 w
->window_end_valid
= false;
17055 /************************************************************************
17056 Window redisplay reusing current matrix when buffer has not changed
17057 ************************************************************************/
17059 /* Try redisplay of window W showing an unchanged buffer with a
17060 different window start than the last time it was displayed by
17061 reusing its current matrix. Value is true if successful.
17062 W->start is the new window start. */
17065 try_window_reusing_current_matrix (struct window
*w
)
17067 struct frame
*f
= XFRAME (w
->frame
);
17068 struct glyph_row
*bottom_row
;
17071 struct text_pos start
, new_start
;
17072 int nrows_scrolled
, i
;
17073 struct glyph_row
*last_text_row
;
17074 struct glyph_row
*last_reused_text_row
;
17075 struct glyph_row
*start_row
;
17076 int start_vpos
, min_y
, max_y
;
17079 if (inhibit_try_window_reusing
)
17083 if (/* This function doesn't handle terminal frames. */
17084 !FRAME_WINDOW_P (f
)
17085 /* Don't try to reuse the display if windows have been split
17087 || windows_or_buffers_changed
17089 || f
->cursor_type_changed
)
17092 /* Can't do this if showing trailing whitespace. */
17093 if (!NILP (Vshow_trailing_whitespace
))
17096 /* If top-line visibility has changed, give up. */
17097 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17098 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17101 /* Give up if old or new display is scrolled vertically. We could
17102 make this function handle this, but right now it doesn't. */
17103 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17104 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17107 /* The variable new_start now holds the new window start. The old
17108 start `start' can be determined from the current matrix. */
17109 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17110 start
= start_row
->minpos
;
17111 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17113 /* Clear the desired matrix for the display below. */
17114 clear_glyph_matrix (w
->desired_matrix
);
17116 if (CHARPOS (new_start
) <= CHARPOS (start
))
17118 /* Don't use this method if the display starts with an ellipsis
17119 displayed for invisible text. It's not easy to handle that case
17120 below, and it's certainly not worth the effort since this is
17121 not a frequent case. */
17122 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17125 IF_DEBUG (debug_method_add (w
, "twu1"));
17127 /* Display up to a row that can be reused. The variable
17128 last_text_row is set to the last row displayed that displays
17129 text. Note that it.vpos == 0 if or if not there is a
17130 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17131 start_display (&it
, w
, new_start
);
17132 w
->cursor
.vpos
= -1;
17133 last_text_row
= last_reused_text_row
= NULL
;
17135 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17137 /* If we have reached into the characters in the START row,
17138 that means the line boundaries have changed. So we
17139 can't start copying with the row START. Maybe it will
17140 work to start copying with the following row. */
17141 while (IT_CHARPOS (it
) > CHARPOS (start
))
17143 /* Advance to the next row as the "start". */
17145 start
= start_row
->minpos
;
17146 /* If there are no more rows to try, or just one, give up. */
17147 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17148 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17149 || CHARPOS (start
) == ZV
)
17151 clear_glyph_matrix (w
->desired_matrix
);
17155 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17157 /* If we have reached alignment, we can copy the rest of the
17159 if (IT_CHARPOS (it
) == CHARPOS (start
)
17160 /* Don't accept "alignment" inside a display vector,
17161 since start_row could have started in the middle of
17162 that same display vector (thus their character
17163 positions match), and we have no way of telling if
17164 that is the case. */
17165 && it
.current
.dpvec_index
< 0)
17168 it
.glyph_row
->reversed_p
= false;
17169 if (display_line (&it
))
17170 last_text_row
= it
.glyph_row
- 1;
17174 /* A value of current_y < last_visible_y means that we stopped
17175 at the previous window start, which in turn means that we
17176 have at least one reusable row. */
17177 if (it
.current_y
< it
.last_visible_y
)
17179 struct glyph_row
*row
;
17181 /* IT.vpos always starts from 0; it counts text lines. */
17182 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17184 /* Find PT if not already found in the lines displayed. */
17185 if (w
->cursor
.vpos
< 0)
17187 int dy
= it
.current_y
- start_row
->y
;
17189 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17190 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17192 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17193 dy
, nrows_scrolled
);
17196 clear_glyph_matrix (w
->desired_matrix
);
17201 /* Scroll the display. Do it before the current matrix is
17202 changed. The problem here is that update has not yet
17203 run, i.e. part of the current matrix is not up to date.
17204 scroll_run_hook will clear the cursor, and use the
17205 current matrix to get the height of the row the cursor is
17207 run
.current_y
= start_row
->y
;
17208 run
.desired_y
= it
.current_y
;
17209 run
.height
= it
.last_visible_y
- it
.current_y
;
17211 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17214 FRAME_RIF (f
)->update_window_begin_hook (w
);
17215 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17216 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17217 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17221 /* Shift current matrix down by nrows_scrolled lines. */
17222 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17223 rotate_matrix (w
->current_matrix
,
17225 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17228 /* Disable lines that must be updated. */
17229 for (i
= 0; i
< nrows_scrolled
; ++i
)
17230 (start_row
+ i
)->enabled_p
= false;
17232 /* Re-compute Y positions. */
17233 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17234 max_y
= it
.last_visible_y
;
17235 for (row
= start_row
+ nrows_scrolled
;
17239 row
->y
= it
.current_y
;
17240 row
->visible_height
= row
->height
;
17242 if (row
->y
< min_y
)
17243 row
->visible_height
-= min_y
- row
->y
;
17244 if (row
->y
+ row
->height
> max_y
)
17245 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17246 if (row
->fringe_bitmap_periodic_p
)
17247 row
->redraw_fringe_bitmaps_p
= true;
17249 it
.current_y
+= row
->height
;
17251 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17252 last_reused_text_row
= row
;
17253 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17257 /* Disable lines in the current matrix which are now
17258 below the window. */
17259 for (++row
; row
< bottom_row
; ++row
)
17260 row
->enabled_p
= row
->mode_line_p
= false;
17263 /* Update window_end_pos etc.; last_reused_text_row is the last
17264 reused row from the current matrix containing text, if any.
17265 The value of last_text_row is the last displayed line
17266 containing text. */
17267 if (last_reused_text_row
)
17268 adjust_window_ends (w
, last_reused_text_row
, true);
17269 else if (last_text_row
)
17270 adjust_window_ends (w
, last_text_row
, false);
17273 /* This window must be completely empty. */
17274 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17275 w
->window_end_pos
= Z
- ZV
;
17276 w
->window_end_vpos
= 0;
17278 w
->window_end_valid
= false;
17280 /* Update hint: don't try scrolling again in update_window. */
17281 w
->desired_matrix
->no_scrolling_p
= true;
17284 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17288 else if (CHARPOS (new_start
) > CHARPOS (start
))
17290 struct glyph_row
*pt_row
, *row
;
17291 struct glyph_row
*first_reusable_row
;
17292 struct glyph_row
*first_row_to_display
;
17294 int yb
= window_text_bottom_y (w
);
17296 /* Find the row starting at new_start, if there is one. Don't
17297 reuse a partially visible line at the end. */
17298 first_reusable_row
= start_row
;
17299 while (first_reusable_row
->enabled_p
17300 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17301 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17302 < CHARPOS (new_start
)))
17303 ++first_reusable_row
;
17305 /* Give up if there is no row to reuse. */
17306 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17307 || !first_reusable_row
->enabled_p
17308 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17309 != CHARPOS (new_start
)))
17312 /* We can reuse fully visible rows beginning with
17313 first_reusable_row to the end of the window. Set
17314 first_row_to_display to the first row that cannot be reused.
17315 Set pt_row to the row containing point, if there is any. */
17317 for (first_row_to_display
= first_reusable_row
;
17318 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17319 ++first_row_to_display
)
17321 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17322 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17323 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17324 && first_row_to_display
->ends_at_zv_p
17325 && pt_row
== NULL
)))
17326 pt_row
= first_row_to_display
;
17329 /* Start displaying at the start of first_row_to_display. */
17330 eassert (first_row_to_display
->y
< yb
);
17331 init_to_row_start (&it
, w
, first_row_to_display
);
17333 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17335 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17337 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17338 + WINDOW_HEADER_LINE_HEIGHT (w
));
17340 /* Display lines beginning with first_row_to_display in the
17341 desired matrix. Set last_text_row to the last row displayed
17342 that displays text. */
17343 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17344 if (pt_row
== NULL
)
17345 w
->cursor
.vpos
= -1;
17346 last_text_row
= NULL
;
17347 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17348 if (display_line (&it
))
17349 last_text_row
= it
.glyph_row
- 1;
17351 /* If point is in a reused row, adjust y and vpos of the cursor
17355 w
->cursor
.vpos
-= nrows_scrolled
;
17356 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17359 /* Give up if point isn't in a row displayed or reused. (This
17360 also handles the case where w->cursor.vpos < nrows_scrolled
17361 after the calls to display_line, which can happen with scroll
17362 margins. See bug#1295.) */
17363 if (w
->cursor
.vpos
< 0)
17365 clear_glyph_matrix (w
->desired_matrix
);
17369 /* Scroll the display. */
17370 run
.current_y
= first_reusable_row
->y
;
17371 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17372 run
.height
= it
.last_visible_y
- run
.current_y
;
17373 dy
= run
.current_y
- run
.desired_y
;
17378 FRAME_RIF (f
)->update_window_begin_hook (w
);
17379 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17380 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17381 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17385 /* Adjust Y positions of reused rows. */
17386 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17387 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17388 max_y
= it
.last_visible_y
;
17389 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17392 row
->visible_height
= row
->height
;
17393 if (row
->y
< min_y
)
17394 row
->visible_height
-= min_y
- row
->y
;
17395 if (row
->y
+ row
->height
> max_y
)
17396 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17397 if (row
->fringe_bitmap_periodic_p
)
17398 row
->redraw_fringe_bitmaps_p
= true;
17401 /* Scroll the current matrix. */
17402 eassert (nrows_scrolled
> 0);
17403 rotate_matrix (w
->current_matrix
,
17405 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17408 /* Disable rows not reused. */
17409 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17410 row
->enabled_p
= false;
17412 /* Point may have moved to a different line, so we cannot assume that
17413 the previous cursor position is valid; locate the correct row. */
17416 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17418 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17419 && !row
->ends_at_zv_p
;
17423 w
->cursor
.y
= row
->y
;
17425 if (row
< bottom_row
)
17427 /* Can't simply scan the row for point with
17428 bidi-reordered glyph rows. Let set_cursor_from_row
17429 figure out where to put the cursor, and if it fails,
17431 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17433 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17436 clear_glyph_matrix (w
->desired_matrix
);
17442 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17443 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17446 && (!BUFFERP (glyph
->object
)
17447 || glyph
->charpos
< PT
);
17451 w
->cursor
.x
+= glyph
->pixel_width
;
17457 /* Adjust window end. A null value of last_text_row means that
17458 the window end is in reused rows which in turn means that
17459 only its vpos can have changed. */
17461 adjust_window_ends (w
, last_text_row
, false);
17463 w
->window_end_vpos
-= nrows_scrolled
;
17465 w
->window_end_valid
= false;
17466 w
->desired_matrix
->no_scrolling_p
= true;
17469 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17479 /************************************************************************
17480 Window redisplay reusing current matrix when buffer has changed
17481 ************************************************************************/
17483 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17484 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17485 ptrdiff_t *, ptrdiff_t *);
17486 static struct glyph_row
*
17487 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17488 struct glyph_row
*);
17491 /* Return the last row in MATRIX displaying text. If row START is
17492 non-null, start searching with that row. IT gives the dimensions
17493 of the display. Value is null if matrix is empty; otherwise it is
17494 a pointer to the row found. */
17496 static struct glyph_row
*
17497 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17498 struct glyph_row
*start
)
17500 struct glyph_row
*row
, *row_found
;
17502 /* Set row_found to the last row in IT->w's current matrix
17503 displaying text. The loop looks funny but think of partially
17506 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17507 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17509 eassert (row
->enabled_p
);
17511 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17520 /* Return the last row in the current matrix of W that is not affected
17521 by changes at the start of current_buffer that occurred since W's
17522 current matrix was built. Value is null if no such row exists.
17524 BEG_UNCHANGED us the number of characters unchanged at the start of
17525 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17526 first changed character in current_buffer. Characters at positions <
17527 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17528 when the current matrix was built. */
17530 static struct glyph_row
*
17531 find_last_unchanged_at_beg_row (struct window
*w
)
17533 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17534 struct glyph_row
*row
;
17535 struct glyph_row
*row_found
= NULL
;
17536 int yb
= window_text_bottom_y (w
);
17538 /* Find the last row displaying unchanged text. */
17539 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17540 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17541 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17544 if (/* If row ends before first_changed_pos, it is unchanged,
17545 except in some case. */
17546 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17547 /* When row ends in ZV and we write at ZV it is not
17549 && !row
->ends_at_zv_p
17550 /* When first_changed_pos is the end of a continued line,
17551 row is not unchanged because it may be no longer
17553 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17554 && (row
->continued_p
17555 || row
->exact_window_width_line_p
))
17556 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17557 needs to be recomputed, so don't consider this row as
17558 unchanged. This happens when the last line was
17559 bidi-reordered and was killed immediately before this
17560 redisplay cycle. In that case, ROW->end stores the
17561 buffer position of the first visual-order character of
17562 the killed text, which is now beyond ZV. */
17563 && CHARPOS (row
->end
.pos
) <= ZV
)
17566 /* Stop if last visible row. */
17567 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17575 /* Find the first glyph row in the current matrix of W that is not
17576 affected by changes at the end of current_buffer since the
17577 time W's current matrix was built.
17579 Return in *DELTA the number of chars by which buffer positions in
17580 unchanged text at the end of current_buffer must be adjusted.
17582 Return in *DELTA_BYTES the corresponding number of bytes.
17584 Value is null if no such row exists, i.e. all rows are affected by
17587 static struct glyph_row
*
17588 find_first_unchanged_at_end_row (struct window
*w
,
17589 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17591 struct glyph_row
*row
;
17592 struct glyph_row
*row_found
= NULL
;
17594 *delta
= *delta_bytes
= 0;
17596 /* Display must not have been paused, otherwise the current matrix
17597 is not up to date. */
17598 eassert (w
->window_end_valid
);
17600 /* A value of window_end_pos >= END_UNCHANGED means that the window
17601 end is in the range of changed text. If so, there is no
17602 unchanged row at the end of W's current matrix. */
17603 if (w
->window_end_pos
>= END_UNCHANGED
)
17606 /* Set row to the last row in W's current matrix displaying text. */
17607 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17609 /* If matrix is entirely empty, no unchanged row exists. */
17610 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17612 /* The value of row is the last glyph row in the matrix having a
17613 meaningful buffer position in it. The end position of row
17614 corresponds to window_end_pos. This allows us to translate
17615 buffer positions in the current matrix to current buffer
17616 positions for characters not in changed text. */
17618 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17619 ptrdiff_t Z_BYTE_old
=
17620 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17621 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17622 struct glyph_row
*first_text_row
17623 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17625 *delta
= Z
- Z_old
;
17626 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17628 /* Set last_unchanged_pos to the buffer position of the last
17629 character in the buffer that has not been changed. Z is the
17630 index + 1 of the last character in current_buffer, i.e. by
17631 subtracting END_UNCHANGED we get the index of the last
17632 unchanged character, and we have to add BEG to get its buffer
17634 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17635 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17637 /* Search backward from ROW for a row displaying a line that
17638 starts at a minimum position >= last_unchanged_pos_old. */
17639 for (; row
> first_text_row
; --row
)
17641 /* This used to abort, but it can happen.
17642 It is ok to just stop the search instead here. KFS. */
17643 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17646 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17651 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17657 /* Make sure that glyph rows in the current matrix of window W
17658 reference the same glyph memory as corresponding rows in the
17659 frame's frame matrix. This function is called after scrolling W's
17660 current matrix on a terminal frame in try_window_id and
17661 try_window_reusing_current_matrix. */
17664 sync_frame_with_window_matrix_rows (struct window
*w
)
17666 struct frame
*f
= XFRAME (w
->frame
);
17667 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17669 /* Preconditions: W must be a leaf window and full-width. Its frame
17670 must have a frame matrix. */
17671 eassert (BUFFERP (w
->contents
));
17672 eassert (WINDOW_FULL_WIDTH_P (w
));
17673 eassert (!FRAME_WINDOW_P (f
));
17675 /* If W is a full-width window, glyph pointers in W's current matrix
17676 have, by definition, to be the same as glyph pointers in the
17677 corresponding frame matrix. Note that frame matrices have no
17678 marginal areas (see build_frame_matrix). */
17679 window_row
= w
->current_matrix
->rows
;
17680 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17681 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17682 while (window_row
< window_row_end
)
17684 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17685 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17687 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17688 frame_row
->glyphs
[TEXT_AREA
] = start
;
17689 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17690 frame_row
->glyphs
[LAST_AREA
] = end
;
17692 /* Disable frame rows whose corresponding window rows have
17693 been disabled in try_window_id. */
17694 if (!window_row
->enabled_p
)
17695 frame_row
->enabled_p
= false;
17697 ++window_row
, ++frame_row
;
17702 /* Find the glyph row in window W containing CHARPOS. Consider all
17703 rows between START and END (not inclusive). END null means search
17704 all rows to the end of the display area of W. Value is the row
17705 containing CHARPOS or null. */
17708 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17709 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17711 struct glyph_row
*row
= start
;
17712 struct glyph_row
*best_row
= NULL
;
17713 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17716 /* If we happen to start on a header-line, skip that. */
17717 if (row
->mode_line_p
)
17720 if ((end
&& row
>= end
) || !row
->enabled_p
)
17723 last_y
= window_text_bottom_y (w
) - dy
;
17727 /* Give up if we have gone too far. */
17728 if (end
&& row
>= end
)
17730 /* This formerly returned if they were equal.
17731 I think that both quantities are of a "last plus one" type;
17732 if so, when they are equal, the row is within the screen. -- rms. */
17733 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17736 /* If it is in this row, return this row. */
17737 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17738 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17739 /* The end position of a row equals the start
17740 position of the next row. If CHARPOS is there, we
17741 would rather consider it displayed in the next
17742 line, except when this line ends in ZV. */
17743 && !row_for_charpos_p (row
, charpos
)))
17744 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17748 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17749 || (!best_row
&& !row
->continued_p
))
17751 /* In bidi-reordered rows, there could be several rows whose
17752 edges surround CHARPOS, all of these rows belonging to
17753 the same continued line. We need to find the row which
17754 fits CHARPOS the best. */
17755 for (g
= row
->glyphs
[TEXT_AREA
];
17756 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17759 if (!STRINGP (g
->object
))
17761 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17763 mindif
= eabs (g
->charpos
- charpos
);
17765 /* Exact match always wins. */
17772 else if (best_row
&& !row
->continued_p
)
17779 /* Try to redisplay window W by reusing its existing display. W's
17780 current matrix must be up to date when this function is called,
17781 i.e., window_end_valid must be true.
17785 >= 1 if successful, i.e. display has been updated
17787 1 means the changes were in front of a newline that precedes
17788 the window start, and the whole current matrix was reused
17789 2 means the changes were after the last position displayed
17790 in the window, and the whole current matrix was reused
17791 3 means portions of the current matrix were reused, while
17792 some of the screen lines were redrawn
17793 -1 if redisplay with same window start is known not to succeed
17794 0 if otherwise unsuccessful
17796 The following steps are performed:
17798 1. Find the last row in the current matrix of W that is not
17799 affected by changes at the start of current_buffer. If no such row
17802 2. Find the first row in W's current matrix that is not affected by
17803 changes at the end of current_buffer. Maybe there is no such row.
17805 3. Display lines beginning with the row + 1 found in step 1 to the
17806 row found in step 2 or, if step 2 didn't find a row, to the end of
17809 4. If cursor is not known to appear on the window, give up.
17811 5. If display stopped at the row found in step 2, scroll the
17812 display and current matrix as needed.
17814 6. Maybe display some lines at the end of W, if we must. This can
17815 happen under various circumstances, like a partially visible line
17816 becoming fully visible, or because newly displayed lines are displayed
17817 in smaller font sizes.
17819 7. Update W's window end information. */
17822 try_window_id (struct window
*w
)
17824 struct frame
*f
= XFRAME (w
->frame
);
17825 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17826 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17827 struct glyph_row
*last_unchanged_at_beg_row
;
17828 struct glyph_row
*first_unchanged_at_end_row
;
17829 struct glyph_row
*row
;
17830 struct glyph_row
*bottom_row
;
17833 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17835 struct text_pos start_pos
;
17837 int first_unchanged_at_end_vpos
= 0;
17838 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17839 struct text_pos start
;
17840 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17843 if (inhibit_try_window_id
)
17847 /* This is handy for debugging. */
17849 #define GIVE_UP(X) \
17851 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17855 #define GIVE_UP(X) return 0
17858 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17860 /* Don't use this for mini-windows because these can show
17861 messages and mini-buffers, and we don't handle that here. */
17862 if (MINI_WINDOW_P (w
))
17865 /* This flag is used to prevent redisplay optimizations. */
17866 if (windows_or_buffers_changed
|| f
->cursor_type_changed
|| f
->redisplay
)
17869 /* This function's optimizations cannot be used if overlays have
17870 changed in the buffer displayed by the window, so give up if they
17872 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17875 /* Verify that narrowing has not changed.
17876 Also verify that we were not told to prevent redisplay optimizations.
17877 It would be nice to further
17878 reduce the number of cases where this prevents try_window_id. */
17879 if (current_buffer
->clip_changed
17880 || current_buffer
->prevent_redisplay_optimizations_p
)
17883 /* Window must either use window-based redisplay or be full width. */
17884 if (!FRAME_WINDOW_P (f
)
17885 && (!FRAME_LINE_INS_DEL_OK (f
)
17886 || !WINDOW_FULL_WIDTH_P (w
)))
17889 /* Give up if point is known NOT to appear in W. */
17890 if (PT
< CHARPOS (start
))
17893 /* Another way to prevent redisplay optimizations. */
17894 if (w
->last_modified
== 0)
17897 /* Verify that window is not hscrolled. */
17898 if (w
->hscroll
!= 0)
17901 /* Verify that display wasn't paused. */
17902 if (!w
->window_end_valid
)
17905 /* Likewise if highlighting trailing whitespace. */
17906 if (!NILP (Vshow_trailing_whitespace
))
17909 /* Can't use this if overlay arrow position and/or string have
17911 if (overlay_arrows_changed_p ())
17914 /* When word-wrap is on, adding a space to the first word of a
17915 wrapped line can change the wrap position, altering the line
17916 above it. It might be worthwhile to handle this more
17917 intelligently, but for now just redisplay from scratch. */
17918 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17921 /* Under bidi reordering, adding or deleting a character in the
17922 beginning of a paragraph, before the first strong directional
17923 character, can change the base direction of the paragraph (unless
17924 the buffer specifies a fixed paragraph direction), which will
17925 require to redisplay the whole paragraph. It might be worthwhile
17926 to find the paragraph limits and widen the range of redisplayed
17927 lines to that, but for now just give up this optimization and
17928 redisplay from scratch. */
17929 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17930 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17933 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17934 to that variable require thorough redisplay. */
17935 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
17938 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17939 only if buffer has really changed. The reason is that the gap is
17940 initially at Z for freshly visited files. The code below would
17941 set end_unchanged to 0 in that case. */
17942 if (MODIFF
> SAVE_MODIFF
17943 /* This seems to happen sometimes after saving a buffer. */
17944 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17946 if (GPT
- BEG
< BEG_UNCHANGED
)
17947 BEG_UNCHANGED
= GPT
- BEG
;
17948 if (Z
- GPT
< END_UNCHANGED
)
17949 END_UNCHANGED
= Z
- GPT
;
17952 /* The position of the first and last character that has been changed. */
17953 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17954 last_changed_charpos
= Z
- END_UNCHANGED
;
17956 /* If window starts after a line end, and the last change is in
17957 front of that newline, then changes don't affect the display.
17958 This case happens with stealth-fontification. Note that although
17959 the display is unchanged, glyph positions in the matrix have to
17960 be adjusted, of course. */
17961 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17962 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17963 && ((last_changed_charpos
< CHARPOS (start
)
17964 && CHARPOS (start
) == BEGV
)
17965 || (last_changed_charpos
< CHARPOS (start
) - 1
17966 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17968 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17969 struct glyph_row
*r0
;
17971 /* Compute how many chars/bytes have been added to or removed
17972 from the buffer. */
17973 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17974 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17975 Z_delta
= Z
- Z_old
;
17976 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17978 /* Give up if PT is not in the window. Note that it already has
17979 been checked at the start of try_window_id that PT is not in
17980 front of the window start. */
17981 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17984 /* If window start is unchanged, we can reuse the whole matrix
17985 as is, after adjusting glyph positions. No need to compute
17986 the window end again, since its offset from Z hasn't changed. */
17987 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17988 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17989 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17990 /* PT must not be in a partially visible line. */
17991 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17992 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17994 /* Adjust positions in the glyph matrix. */
17995 if (Z_delta
|| Z_delta_bytes
)
17997 struct glyph_row
*r1
17998 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17999 increment_matrix_positions (w
->current_matrix
,
18000 MATRIX_ROW_VPOS (r0
, current_matrix
),
18001 MATRIX_ROW_VPOS (r1
, current_matrix
),
18002 Z_delta
, Z_delta_bytes
);
18005 /* Set the cursor. */
18006 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18008 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18013 /* Handle the case that changes are all below what is displayed in
18014 the window, and that PT is in the window. This shortcut cannot
18015 be taken if ZV is visible in the window, and text has been added
18016 there that is visible in the window. */
18017 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18018 /* ZV is not visible in the window, or there are no
18019 changes at ZV, actually. */
18020 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18021 || first_changed_charpos
== last_changed_charpos
))
18023 struct glyph_row
*r0
;
18025 /* Give up if PT is not in the window. Note that it already has
18026 been checked at the start of try_window_id that PT is not in
18027 front of the window start. */
18028 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18031 /* If window start is unchanged, we can reuse the whole matrix
18032 as is, without changing glyph positions since no text has
18033 been added/removed in front of the window end. */
18034 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18035 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18036 /* PT must not be in a partially visible line. */
18037 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18038 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18040 /* We have to compute the window end anew since text
18041 could have been added/removed after it. */
18042 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18043 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18045 /* Set the cursor. */
18046 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18048 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18053 /* Give up if window start is in the changed area.
18055 The condition used to read
18057 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18059 but why that was tested escapes me at the moment. */
18060 if (CHARPOS (start
) >= first_changed_charpos
18061 && CHARPOS (start
) <= last_changed_charpos
)
18064 /* Check that window start agrees with the start of the first glyph
18065 row in its current matrix. Check this after we know the window
18066 start is not in changed text, otherwise positions would not be
18068 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18069 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18072 /* Give up if the window ends in strings. Overlay strings
18073 at the end are difficult to handle, so don't try. */
18074 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18075 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18078 /* Compute the position at which we have to start displaying new
18079 lines. Some of the lines at the top of the window might be
18080 reusable because they are not displaying changed text. Find the
18081 last row in W's current matrix not affected by changes at the
18082 start of current_buffer. Value is null if changes start in the
18083 first line of window. */
18084 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18085 if (last_unchanged_at_beg_row
)
18087 /* Avoid starting to display in the middle of a character, a TAB
18088 for instance. This is easier than to set up the iterator
18089 exactly, and it's not a frequent case, so the additional
18090 effort wouldn't really pay off. */
18091 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18092 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18093 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18094 --last_unchanged_at_beg_row
;
18096 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18099 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18101 start_pos
= it
.current
.pos
;
18103 /* Start displaying new lines in the desired matrix at the same
18104 vpos we would use in the current matrix, i.e. below
18105 last_unchanged_at_beg_row. */
18106 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18108 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18109 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18111 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18115 /* There are no reusable lines at the start of the window.
18116 Start displaying in the first text line. */
18117 start_display (&it
, w
, start
);
18118 it
.vpos
= it
.first_vpos
;
18119 start_pos
= it
.current
.pos
;
18122 /* Find the first row that is not affected by changes at the end of
18123 the buffer. Value will be null if there is no unchanged row, in
18124 which case we must redisplay to the end of the window. delta
18125 will be set to the value by which buffer positions beginning with
18126 first_unchanged_at_end_row have to be adjusted due to text
18128 first_unchanged_at_end_row
18129 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18130 IF_DEBUG (debug_delta
= delta
);
18131 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18133 /* Set stop_pos to the buffer position up to which we will have to
18134 display new lines. If first_unchanged_at_end_row != NULL, this
18135 is the buffer position of the start of the line displayed in that
18136 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18137 that we don't stop at a buffer position. */
18139 if (first_unchanged_at_end_row
)
18141 eassert (last_unchanged_at_beg_row
== NULL
18142 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18144 /* If this is a continuation line, move forward to the next one
18145 that isn't. Changes in lines above affect this line.
18146 Caution: this may move first_unchanged_at_end_row to a row
18147 not displaying text. */
18148 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18149 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18150 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18151 < it
.last_visible_y
))
18152 ++first_unchanged_at_end_row
;
18154 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18155 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18156 >= it
.last_visible_y
))
18157 first_unchanged_at_end_row
= NULL
;
18160 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18162 first_unchanged_at_end_vpos
18163 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18164 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18167 else if (last_unchanged_at_beg_row
== NULL
)
18173 /* Either there is no unchanged row at the end, or the one we have
18174 now displays text. This is a necessary condition for the window
18175 end pos calculation at the end of this function. */
18176 eassert (first_unchanged_at_end_row
== NULL
18177 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18179 debug_last_unchanged_at_beg_vpos
18180 = (last_unchanged_at_beg_row
18181 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18183 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18185 #endif /* GLYPH_DEBUG */
18188 /* Display new lines. Set last_text_row to the last new line
18189 displayed which has text on it, i.e. might end up as being the
18190 line where the window_end_vpos is. */
18191 w
->cursor
.vpos
= -1;
18192 last_text_row
= NULL
;
18193 overlay_arrow_seen
= false;
18194 if (it
.current_y
< it
.last_visible_y
18195 && !f
->fonts_changed
18196 && (first_unchanged_at_end_row
== NULL
18197 || IT_CHARPOS (it
) < stop_pos
))
18198 it
.glyph_row
->reversed_p
= false;
18199 while (it
.current_y
< it
.last_visible_y
18200 && !f
->fonts_changed
18201 && (first_unchanged_at_end_row
== NULL
18202 || IT_CHARPOS (it
) < stop_pos
))
18204 if (display_line (&it
))
18205 last_text_row
= it
.glyph_row
- 1;
18208 if (f
->fonts_changed
)
18211 /* The redisplay iterations in display_line above could have
18212 triggered font-lock, which could have done something that
18213 invalidates IT->w window's end-point information, on which we
18214 rely below. E.g., one package, which will remain unnamed, used
18215 to install a font-lock-fontify-region-function that called
18216 bury-buffer, whose side effect is to switch the buffer displayed
18217 by IT->w, and that predictably resets IT->w's window_end_valid
18218 flag, which we already tested at the entry to this function.
18219 Amply punish such packages/modes by giving up on this
18220 optimization in those cases. */
18221 if (!w
->window_end_valid
)
18223 clear_glyph_matrix (w
->desired_matrix
);
18227 /* Compute differences in buffer positions, y-positions etc. for
18228 lines reused at the bottom of the window. Compute what we can
18230 if (first_unchanged_at_end_row
18231 /* No lines reused because we displayed everything up to the
18232 bottom of the window. */
18233 && it
.current_y
< it
.last_visible_y
)
18236 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18238 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18239 run
.current_y
= first_unchanged_at_end_row
->y
;
18240 run
.desired_y
= run
.current_y
+ dy
;
18241 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18245 delta
= delta_bytes
= dvpos
= dy
18246 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18247 first_unchanged_at_end_row
= NULL
;
18249 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18252 /* Find the cursor if not already found. We have to decide whether
18253 PT will appear on this window (it sometimes doesn't, but this is
18254 not a very frequent case.) This decision has to be made before
18255 the current matrix is altered. A value of cursor.vpos < 0 means
18256 that PT is either in one of the lines beginning at
18257 first_unchanged_at_end_row or below the window. Don't care for
18258 lines that might be displayed later at the window end; as
18259 mentioned, this is not a frequent case. */
18260 if (w
->cursor
.vpos
< 0)
18262 /* Cursor in unchanged rows at the top? */
18263 if (PT
< CHARPOS (start_pos
)
18264 && last_unchanged_at_beg_row
)
18266 row
= row_containing_pos (w
, PT
,
18267 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18268 last_unchanged_at_beg_row
+ 1, 0);
18270 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18273 /* Start from first_unchanged_at_end_row looking for PT. */
18274 else if (first_unchanged_at_end_row
)
18276 row
= row_containing_pos (w
, PT
- delta
,
18277 first_unchanged_at_end_row
, NULL
, 0);
18279 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18280 delta_bytes
, dy
, dvpos
);
18283 /* Give up if cursor was not found. */
18284 if (w
->cursor
.vpos
< 0)
18286 clear_glyph_matrix (w
->desired_matrix
);
18291 /* Don't let the cursor end in the scroll margins. */
18293 int this_scroll_margin
, cursor_height
;
18294 int frame_line_height
= default_line_pixel_height (w
);
18295 int window_total_lines
18296 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18298 this_scroll_margin
=
18299 max (0, min (scroll_margin
, window_total_lines
/ 4));
18300 this_scroll_margin
*= frame_line_height
;
18301 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18303 if ((w
->cursor
.y
< this_scroll_margin
18304 && CHARPOS (start
) > BEGV
)
18305 /* Old redisplay didn't take scroll margin into account at the bottom,
18306 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18307 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18308 ? cursor_height
+ this_scroll_margin
18309 : 1)) > it
.last_visible_y
)
18311 w
->cursor
.vpos
= -1;
18312 clear_glyph_matrix (w
->desired_matrix
);
18317 /* Scroll the display. Do it before changing the current matrix so
18318 that xterm.c doesn't get confused about where the cursor glyph is
18320 if (dy
&& run
.height
)
18324 if (FRAME_WINDOW_P (f
))
18326 FRAME_RIF (f
)->update_window_begin_hook (w
);
18327 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18328 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18329 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18333 /* Terminal frame. In this case, dvpos gives the number of
18334 lines to scroll by; dvpos < 0 means scroll up. */
18336 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18337 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18338 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18339 + WINDOW_WANTS_HEADER_LINE_P (w
)
18340 + window_internal_height (w
));
18342 #if defined (HAVE_GPM) || defined (MSDOS)
18343 x_clear_window_mouse_face (w
);
18345 /* Perform the operation on the screen. */
18348 /* Scroll last_unchanged_at_beg_row to the end of the
18349 window down dvpos lines. */
18350 set_terminal_window (f
, end
);
18352 /* On dumb terminals delete dvpos lines at the end
18353 before inserting dvpos empty lines. */
18354 if (!FRAME_SCROLL_REGION_OK (f
))
18355 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18357 /* Insert dvpos empty lines in front of
18358 last_unchanged_at_beg_row. */
18359 ins_del_lines (f
, from
, dvpos
);
18361 else if (dvpos
< 0)
18363 /* Scroll up last_unchanged_at_beg_vpos to the end of
18364 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18365 set_terminal_window (f
, end
);
18367 /* Delete dvpos lines in front of
18368 last_unchanged_at_beg_vpos. ins_del_lines will set
18369 the cursor to the given vpos and emit |dvpos| delete
18371 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18373 /* On a dumb terminal insert dvpos empty lines at the
18375 if (!FRAME_SCROLL_REGION_OK (f
))
18376 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18379 set_terminal_window (f
, 0);
18385 /* Shift reused rows of the current matrix to the right position.
18386 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18388 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18389 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18392 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18393 bottom_vpos
, dvpos
);
18394 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18397 else if (dvpos
> 0)
18399 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18400 bottom_vpos
, dvpos
);
18401 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18402 first_unchanged_at_end_vpos
+ dvpos
);
18405 /* For frame-based redisplay, make sure that current frame and window
18406 matrix are in sync with respect to glyph memory. */
18407 if (!FRAME_WINDOW_P (f
))
18408 sync_frame_with_window_matrix_rows (w
);
18410 /* Adjust buffer positions in reused rows. */
18411 if (delta
|| delta_bytes
)
18412 increment_matrix_positions (current_matrix
,
18413 first_unchanged_at_end_vpos
+ dvpos
,
18414 bottom_vpos
, delta
, delta_bytes
);
18416 /* Adjust Y positions. */
18418 shift_glyph_matrix (w
, current_matrix
,
18419 first_unchanged_at_end_vpos
+ dvpos
,
18422 if (first_unchanged_at_end_row
)
18424 first_unchanged_at_end_row
+= dvpos
;
18425 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18426 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18427 first_unchanged_at_end_row
= NULL
;
18430 /* If scrolling up, there may be some lines to display at the end of
18432 last_text_row_at_end
= NULL
;
18435 /* Scrolling up can leave for example a partially visible line
18436 at the end of the window to be redisplayed. */
18437 /* Set last_row to the glyph row in the current matrix where the
18438 window end line is found. It has been moved up or down in
18439 the matrix by dvpos. */
18440 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18441 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18443 /* If last_row is the window end line, it should display text. */
18444 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18446 /* If window end line was partially visible before, begin
18447 displaying at that line. Otherwise begin displaying with the
18448 line following it. */
18449 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18451 init_to_row_start (&it
, w
, last_row
);
18452 it
.vpos
= last_vpos
;
18453 it
.current_y
= last_row
->y
;
18457 init_to_row_end (&it
, w
, last_row
);
18458 it
.vpos
= 1 + last_vpos
;
18459 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18463 /* We may start in a continuation line. If so, we have to
18464 get the right continuation_lines_width and current_x. */
18465 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18466 it
.hpos
= it
.current_x
= 0;
18468 /* Display the rest of the lines at the window end. */
18469 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18470 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18472 /* Is it always sure that the display agrees with lines in
18473 the current matrix? I don't think so, so we mark rows
18474 displayed invalid in the current matrix by setting their
18475 enabled_p flag to false. */
18476 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18477 if (display_line (&it
))
18478 last_text_row_at_end
= it
.glyph_row
- 1;
18482 /* Update window_end_pos and window_end_vpos. */
18483 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18485 /* Window end line if one of the preserved rows from the current
18486 matrix. Set row to the last row displaying text in current
18487 matrix starting at first_unchanged_at_end_row, after
18489 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18490 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18491 first_unchanged_at_end_row
);
18492 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18493 adjust_window_ends (w
, row
, true);
18494 eassert (w
->window_end_bytepos
>= 0);
18495 IF_DEBUG (debug_method_add (w
, "A"));
18497 else if (last_text_row_at_end
)
18499 adjust_window_ends (w
, last_text_row_at_end
, false);
18500 eassert (w
->window_end_bytepos
>= 0);
18501 IF_DEBUG (debug_method_add (w
, "B"));
18503 else if (last_text_row
)
18505 /* We have displayed either to the end of the window or at the
18506 end of the window, i.e. the last row with text is to be found
18507 in the desired matrix. */
18508 adjust_window_ends (w
, last_text_row
, false);
18509 eassert (w
->window_end_bytepos
>= 0);
18511 else if (first_unchanged_at_end_row
== NULL
18512 && last_text_row
== NULL
18513 && last_text_row_at_end
== NULL
)
18515 /* Displayed to end of window, but no line containing text was
18516 displayed. Lines were deleted at the end of the window. */
18517 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18518 int vpos
= w
->window_end_vpos
;
18519 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18520 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18523 row
== NULL
&& vpos
>= first_vpos
;
18524 --vpos
, --current_row
, --desired_row
)
18526 if (desired_row
->enabled_p
)
18528 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18531 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18535 eassert (row
!= NULL
);
18536 w
->window_end_vpos
= vpos
+ 1;
18537 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18538 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18539 eassert (w
->window_end_bytepos
>= 0);
18540 IF_DEBUG (debug_method_add (w
, "C"));
18545 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18546 debug_end_vpos
= w
->window_end_vpos
));
18548 /* Record that display has not been completed. */
18549 w
->window_end_valid
= false;
18550 w
->desired_matrix
->no_scrolling_p
= true;
18558 /***********************************************************************
18559 More debugging support
18560 ***********************************************************************/
18564 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18565 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18566 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18569 /* Dump the contents of glyph matrix MATRIX on stderr.
18571 GLYPHS 0 means don't show glyph contents.
18572 GLYPHS 1 means show glyphs in short form
18573 GLYPHS > 1 means show glyphs in long form. */
18576 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18579 for (i
= 0; i
< matrix
->nrows
; ++i
)
18580 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18584 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18585 the glyph row and area where the glyph comes from. */
18588 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18590 if (glyph
->type
== CHAR_GLYPH
18591 || glyph
->type
== GLYPHLESS_GLYPH
)
18594 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18595 glyph
- row
->glyphs
[TEXT_AREA
],
18596 (glyph
->type
== CHAR_GLYPH
18600 (BUFFERP (glyph
->object
)
18602 : (STRINGP (glyph
->object
)
18604 : (NILP (glyph
->object
)
18607 glyph
->pixel_width
,
18609 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18613 glyph
->left_box_line_p
,
18614 glyph
->right_box_line_p
);
18616 else if (glyph
->type
== STRETCH_GLYPH
)
18619 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18620 glyph
- row
->glyphs
[TEXT_AREA
],
18623 (BUFFERP (glyph
->object
)
18625 : (STRINGP (glyph
->object
)
18627 : (NILP (glyph
->object
)
18630 glyph
->pixel_width
,
18634 glyph
->left_box_line_p
,
18635 glyph
->right_box_line_p
);
18637 else if (glyph
->type
== IMAGE_GLYPH
)
18640 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18641 glyph
- row
->glyphs
[TEXT_AREA
],
18644 (BUFFERP (glyph
->object
)
18646 : (STRINGP (glyph
->object
)
18648 : (NILP (glyph
->object
)
18651 glyph
->pixel_width
,
18655 glyph
->left_box_line_p
,
18656 glyph
->right_box_line_p
);
18658 else if (glyph
->type
== COMPOSITE_GLYPH
)
18661 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18662 glyph
- row
->glyphs
[TEXT_AREA
],
18665 (BUFFERP (glyph
->object
)
18667 : (STRINGP (glyph
->object
)
18669 : (NILP (glyph
->object
)
18672 glyph
->pixel_width
,
18674 if (glyph
->u
.cmp
.automatic
)
18677 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18678 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18680 glyph
->left_box_line_p
,
18681 glyph
->right_box_line_p
);
18686 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18687 GLYPHS 0 means don't show glyph contents.
18688 GLYPHS 1 means show glyphs in short form
18689 GLYPHS > 1 means show glyphs in long form. */
18692 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18696 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18697 fprintf (stderr
, "==============================================================================\n");
18699 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18700 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18702 MATRIX_ROW_START_CHARPOS (row
),
18703 MATRIX_ROW_END_CHARPOS (row
),
18704 row
->used
[TEXT_AREA
],
18705 row
->contains_overlapping_glyphs_p
,
18707 row
->truncated_on_left_p
,
18708 row
->truncated_on_right_p
,
18710 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18711 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18714 row
->ends_in_middle_of_char_p
,
18715 row
->starts_in_middle_of_char_p
,
18721 row
->visible_height
,
18724 /* The next 3 lines should align to "Start" in the header. */
18725 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18726 row
->end
.overlay_string_index
,
18727 row
->continuation_lines_width
);
18728 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18729 CHARPOS (row
->start
.string_pos
),
18730 CHARPOS (row
->end
.string_pos
));
18731 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18732 row
->end
.dpvec_index
);
18739 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18741 struct glyph
*glyph
= row
->glyphs
[area
];
18742 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18744 /* Glyph for a line end in text. */
18745 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18748 if (glyph
< glyph_end
)
18749 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18751 for (; glyph
< glyph_end
; ++glyph
)
18752 dump_glyph (row
, glyph
, area
);
18755 else if (glyphs
== 1)
18758 char s
[SHRT_MAX
+ 4];
18760 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18764 for (i
= 0; i
< row
->used
[area
]; ++i
)
18766 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18767 if (i
== row
->used
[area
] - 1
18768 && area
== TEXT_AREA
18769 && NILP (glyph
->object
)
18770 && glyph
->type
== CHAR_GLYPH
18771 && glyph
->u
.ch
== ' ')
18773 strcpy (&s
[i
], "[\\n]");
18776 else if (glyph
->type
== CHAR_GLYPH
18777 && glyph
->u
.ch
< 0x80
18778 && glyph
->u
.ch
>= ' ')
18779 s
[i
] = glyph
->u
.ch
;
18785 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18791 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18792 Sdump_glyph_matrix
, 0, 1, "p",
18793 doc
: /* Dump the current matrix of the selected window to stderr.
18794 Shows contents of glyph row structures. With non-nil
18795 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18796 glyphs in short form, otherwise show glyphs in long form.
18798 Interactively, no argument means show glyphs in short form;
18799 with numeric argument, its value is passed as the GLYPHS flag. */)
18800 (Lisp_Object glyphs
)
18802 struct window
*w
= XWINDOW (selected_window
);
18803 struct buffer
*buffer
= XBUFFER (w
->contents
);
18805 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18806 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18807 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18808 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18809 fprintf (stderr
, "=============================================\n");
18810 dump_glyph_matrix (w
->current_matrix
,
18811 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18816 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18817 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18818 Only text-mode frames have frame glyph matrices. */)
18821 struct frame
*f
= XFRAME (selected_frame
);
18823 if (f
->current_matrix
)
18824 dump_glyph_matrix (f
->current_matrix
, 1);
18826 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18831 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18832 doc
: /* Dump glyph row ROW to stderr.
18833 GLYPH 0 means don't dump glyphs.
18834 GLYPH 1 means dump glyphs in short form.
18835 GLYPH > 1 or omitted means dump glyphs in long form. */)
18836 (Lisp_Object row
, Lisp_Object glyphs
)
18838 struct glyph_matrix
*matrix
;
18841 CHECK_NUMBER (row
);
18842 matrix
= XWINDOW (selected_window
)->current_matrix
;
18844 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18845 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18847 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18852 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18853 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18854 GLYPH 0 means don't dump glyphs.
18855 GLYPH 1 means dump glyphs in short form.
18856 GLYPH > 1 or omitted means dump glyphs in long form.
18858 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18860 (Lisp_Object row
, Lisp_Object glyphs
)
18862 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18863 struct frame
*sf
= SELECTED_FRAME ();
18864 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18867 CHECK_NUMBER (row
);
18869 if (vpos
>= 0 && vpos
< m
->nrows
)
18870 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18871 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18877 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18878 doc
: /* Toggle tracing of redisplay.
18879 With ARG, turn tracing on if and only if ARG is positive. */)
18883 trace_redisplay_p
= !trace_redisplay_p
;
18886 arg
= Fprefix_numeric_value (arg
);
18887 trace_redisplay_p
= XINT (arg
) > 0;
18894 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18895 doc
: /* Like `format', but print result to stderr.
18896 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18897 (ptrdiff_t nargs
, Lisp_Object
*args
)
18899 Lisp_Object s
= Fformat (nargs
, args
);
18900 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18904 #endif /* GLYPH_DEBUG */
18908 /***********************************************************************
18909 Building Desired Matrix Rows
18910 ***********************************************************************/
18912 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18913 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18915 static struct glyph_row
*
18916 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18918 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18919 struct buffer
*buffer
= XBUFFER (w
->contents
);
18920 struct buffer
*old
= current_buffer
;
18921 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18922 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18923 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18924 const unsigned char *p
;
18927 int n_glyphs_before
;
18929 set_buffer_temp (buffer
);
18930 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18931 scratch_glyph_row
.reversed_p
= false;
18932 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18933 SET_TEXT_POS (it
.position
, 0, 0);
18935 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18937 while (p
< arrow_end
)
18939 Lisp_Object face
, ilisp
;
18941 /* Get the next character. */
18943 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18946 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18947 if (! ASCII_CHAR_P (it
.c
))
18948 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18952 /* Get its face. */
18953 ilisp
= make_number (p
- arrow_string
);
18954 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18955 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18957 /* Compute its width, get its glyphs. */
18958 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18959 SET_TEXT_POS (it
.position
, -1, -1);
18960 PRODUCE_GLYPHS (&it
);
18962 /* If this character doesn't fit any more in the line, we have
18963 to remove some glyphs. */
18964 if (it
.current_x
> it
.last_visible_x
)
18966 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18971 set_buffer_temp (old
);
18972 return it
.glyph_row
;
18976 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18977 glyphs to insert is determined by produce_special_glyphs. */
18980 insert_left_trunc_glyphs (struct it
*it
)
18982 struct it truncate_it
;
18983 struct glyph
*from
, *end
, *to
, *toend
;
18985 eassert (!FRAME_WINDOW_P (it
->f
)
18986 || (!it
->glyph_row
->reversed_p
18987 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18988 || (it
->glyph_row
->reversed_p
18989 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18991 /* Get the truncation glyphs. */
18993 truncate_it
.current_x
= 0;
18994 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18995 truncate_it
.glyph_row
= &scratch_glyph_row
;
18996 truncate_it
.area
= TEXT_AREA
;
18997 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18998 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18999 truncate_it
.object
= Qnil
;
19000 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19002 /* Overwrite glyphs from IT with truncation glyphs. */
19003 if (!it
->glyph_row
->reversed_p
)
19005 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19007 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19008 end
= from
+ tused
;
19009 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19010 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19011 if (FRAME_WINDOW_P (it
->f
))
19013 /* On GUI frames, when variable-size fonts are displayed,
19014 the truncation glyphs may need more pixels than the row's
19015 glyphs they overwrite. We overwrite more glyphs to free
19016 enough screen real estate, and enlarge the stretch glyph
19017 on the right (see display_line), if there is one, to
19018 preserve the screen position of the truncation glyphs on
19021 struct glyph
*g
= to
;
19024 /* The first glyph could be partially visible, in which case
19025 it->glyph_row->x will be negative. But we want the left
19026 truncation glyphs to be aligned at the left margin of the
19027 window, so we override the x coordinate at which the row
19029 it
->glyph_row
->x
= 0;
19030 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19032 w
+= g
->pixel_width
;
19035 if (g
- to
- tused
> 0)
19037 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19038 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19040 used
= it
->glyph_row
->used
[TEXT_AREA
];
19041 if (it
->glyph_row
->truncated_on_right_p
19042 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19043 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19046 int extra
= w
- it
->truncation_pixel_width
;
19048 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19055 /* There may be padding glyphs left over. Overwrite them too. */
19056 if (!FRAME_WINDOW_P (it
->f
))
19058 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19060 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19067 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19071 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19073 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19074 that back to front. */
19075 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19076 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19077 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19078 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19079 if (FRAME_WINDOW_P (it
->f
))
19082 struct glyph
*g
= to
;
19084 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19086 w
+= g
->pixel_width
;
19089 if (to
- g
- tused
> 0)
19091 if (it
->glyph_row
->truncated_on_right_p
19092 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19093 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19095 int extra
= w
- it
->truncation_pixel_width
;
19097 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19101 while (from
>= end
&& to
>= toend
)
19103 if (!FRAME_WINDOW_P (it
->f
))
19105 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19108 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19109 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19110 while (from
>= end
&& to
>= toend
)
19116 /* Need to free some room before prepending additional
19118 int move_by
= from
- end
+ 1;
19119 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19120 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19122 for ( ; g
>= g0
; g
--)
19124 while (from
>= end
)
19126 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19131 /* Compute the hash code for ROW. */
19133 row_hash (struct glyph_row
*row
)
19136 unsigned hashval
= 0;
19138 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19139 for (k
= 0; k
< row
->used
[area
]; ++k
)
19140 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19141 + row
->glyphs
[area
][k
].u
.val
19142 + row
->glyphs
[area
][k
].face_id
19143 + row
->glyphs
[area
][k
].padding_p
19144 + (row
->glyphs
[area
][k
].type
<< 2));
19149 /* Compute the pixel height and width of IT->glyph_row.
19151 Most of the time, ascent and height of a display line will be equal
19152 to the max_ascent and max_height values of the display iterator
19153 structure. This is not the case if
19155 1. We hit ZV without displaying anything. In this case, max_ascent
19156 and max_height will be zero.
19158 2. We have some glyphs that don't contribute to the line height.
19159 (The glyph row flag contributes_to_line_height_p is for future
19160 pixmap extensions).
19162 The first case is easily covered by using default values because in
19163 these cases, the line height does not really matter, except that it
19164 must not be zero. */
19167 compute_line_metrics (struct it
*it
)
19169 struct glyph_row
*row
= it
->glyph_row
;
19171 if (FRAME_WINDOW_P (it
->f
))
19173 int i
, min_y
, max_y
;
19175 /* The line may consist of one space only, that was added to
19176 place the cursor on it. If so, the row's height hasn't been
19178 if (row
->height
== 0)
19180 if (it
->max_ascent
+ it
->max_descent
== 0)
19181 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19182 row
->ascent
= it
->max_ascent
;
19183 row
->height
= it
->max_ascent
+ it
->max_descent
;
19184 row
->phys_ascent
= it
->max_phys_ascent
;
19185 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19186 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19189 /* Compute the width of this line. */
19190 row
->pixel_width
= row
->x
;
19191 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19192 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19194 eassert (row
->pixel_width
>= 0);
19195 eassert (row
->ascent
>= 0 && row
->height
> 0);
19197 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19198 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19200 /* If first line's physical ascent is larger than its logical
19201 ascent, use the physical ascent, and make the row taller.
19202 This makes accented characters fully visible. */
19203 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19204 && row
->phys_ascent
> row
->ascent
)
19206 row
->height
+= row
->phys_ascent
- row
->ascent
;
19207 row
->ascent
= row
->phys_ascent
;
19210 /* Compute how much of the line is visible. */
19211 row
->visible_height
= row
->height
;
19213 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19214 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19216 if (row
->y
< min_y
)
19217 row
->visible_height
-= min_y
- row
->y
;
19218 if (row
->y
+ row
->height
> max_y
)
19219 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19223 row
->pixel_width
= row
->used
[TEXT_AREA
];
19224 if (row
->continued_p
)
19225 row
->pixel_width
-= it
->continuation_pixel_width
;
19226 else if (row
->truncated_on_right_p
)
19227 row
->pixel_width
-= it
->truncation_pixel_width
;
19228 row
->ascent
= row
->phys_ascent
= 0;
19229 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19230 row
->extra_line_spacing
= 0;
19233 /* Compute a hash code for this row. */
19234 row
->hash
= row_hash (row
);
19236 it
->max_ascent
= it
->max_descent
= 0;
19237 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19241 /* Append one space to the glyph row of iterator IT if doing a
19242 window-based redisplay. The space has the same face as
19243 IT->face_id. Value is true if a space was added.
19245 This function is called to make sure that there is always one glyph
19246 at the end of a glyph row that the cursor can be set on under
19247 window-systems. (If there weren't such a glyph we would not know
19248 how wide and tall a box cursor should be displayed).
19250 At the same time this space let's a nicely handle clearing to the
19251 end of the line if the row ends in italic text. */
19254 append_space_for_newline (struct it
*it
, bool default_face_p
)
19256 if (FRAME_WINDOW_P (it
->f
))
19258 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19260 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19261 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19263 /* Save some values that must not be changed.
19264 Must save IT->c and IT->len because otherwise
19265 ITERATOR_AT_END_P wouldn't work anymore after
19266 append_space_for_newline has been called. */
19267 enum display_element_type saved_what
= it
->what
;
19268 int saved_c
= it
->c
, saved_len
= it
->len
;
19269 int saved_char_to_display
= it
->char_to_display
;
19270 int saved_x
= it
->current_x
;
19271 int saved_face_id
= it
->face_id
;
19272 bool saved_box_end
= it
->end_of_box_run_p
;
19273 struct text_pos saved_pos
;
19274 Lisp_Object saved_object
;
19278 saved_object
= it
->object
;
19279 saved_pos
= it
->position
;
19281 it
->what
= IT_CHARACTER
;
19282 memset (&it
->position
, 0, sizeof it
->position
);
19284 it
->c
= it
->char_to_display
= ' ';
19287 /* If the default face was remapped, be sure to use the
19288 remapped face for the appended newline. */
19289 if (default_face_p
)
19290 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19291 else if (it
->face_before_selective_p
)
19292 it
->face_id
= it
->saved_face_id
;
19293 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19294 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19295 /* In R2L rows, we will prepend a stretch glyph that will
19296 have the end_of_box_run_p flag set for it, so there's no
19297 need for the appended newline glyph to have that flag
19299 if (it
->glyph_row
->reversed_p
19300 /* But if the appended newline glyph goes all the way to
19301 the end of the row, there will be no stretch glyph,
19302 so leave the box flag set. */
19303 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19304 it
->end_of_box_run_p
= false;
19306 PRODUCE_GLYPHS (it
);
19308 #ifdef HAVE_WINDOW_SYSTEM
19309 /* Make sure this space glyph has the right ascent and
19310 descent values, or else cursor at end of line will look
19311 funny, and height of empty lines will be incorrect. */
19312 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19313 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19316 Lisp_Object height
, total_height
;
19317 int extra_line_spacing
= it
->extra_line_spacing
;
19318 int boff
= font
->baseline_offset
;
19320 if (font
->vertical_centering
)
19321 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19323 it
->object
= saved_object
; /* get_it_property needs this */
19324 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19325 /* Must do a subset of line height processing from
19326 x_produce_glyph for newline characters. */
19327 height
= get_it_property (it
, Qline_height
);
19329 && CONSP (XCDR (height
))
19330 && NILP (XCDR (XCDR (height
))))
19332 total_height
= XCAR (XCDR (height
));
19333 height
= XCAR (height
);
19336 total_height
= Qnil
;
19337 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19339 if (it
->override_ascent
>= 0)
19341 it
->ascent
= it
->override_ascent
;
19342 it
->descent
= it
->override_descent
;
19343 boff
= it
->override_boff
;
19345 if (EQ (height
, Qt
))
19346 extra_line_spacing
= 0;
19349 Lisp_Object spacing
;
19351 it
->phys_ascent
= it
->ascent
;
19352 it
->phys_descent
= it
->descent
;
19354 && XINT (height
) > it
->ascent
+ it
->descent
)
19355 it
->ascent
= XINT (height
) - it
->descent
;
19357 if (!NILP (total_height
))
19358 spacing
= calc_line_height_property (it
, total_height
, font
,
19362 spacing
= get_it_property (it
, Qline_spacing
);
19363 spacing
= calc_line_height_property (it
, spacing
, font
,
19366 if (INTEGERP (spacing
))
19368 extra_line_spacing
= XINT (spacing
);
19369 if (!NILP (total_height
))
19370 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19373 if (extra_line_spacing
> 0)
19375 it
->descent
+= extra_line_spacing
;
19376 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19377 it
->max_extra_line_spacing
= extra_line_spacing
;
19379 it
->max_ascent
= it
->ascent
;
19380 it
->max_descent
= it
->descent
;
19381 /* Make sure compute_line_metrics recomputes the row height. */
19382 it
->glyph_row
->height
= 0;
19385 g
->ascent
= it
->max_ascent
;
19386 g
->descent
= it
->max_descent
;
19389 it
->override_ascent
= -1;
19390 it
->constrain_row_ascent_descent_p
= false;
19391 it
->current_x
= saved_x
;
19392 it
->object
= saved_object
;
19393 it
->position
= saved_pos
;
19394 it
->what
= saved_what
;
19395 it
->face_id
= saved_face_id
;
19396 it
->len
= saved_len
;
19398 it
->char_to_display
= saved_char_to_display
;
19399 it
->end_of_box_run_p
= saved_box_end
;
19408 /* Extend the face of the last glyph in the text area of IT->glyph_row
19409 to the end of the display line. Called from display_line. If the
19410 glyph row is empty, add a space glyph to it so that we know the
19411 face to draw. Set the glyph row flag fill_line_p. If the glyph
19412 row is R2L, prepend a stretch glyph to cover the empty space to the
19413 left of the leftmost glyph. */
19416 extend_face_to_end_of_line (struct it
*it
)
19418 struct face
*face
, *default_face
;
19419 struct frame
*f
= it
->f
;
19421 /* If line is already filled, do nothing. Non window-system frames
19422 get a grace of one more ``pixel'' because their characters are
19423 1-``pixel'' wide, so they hit the equality too early. This grace
19424 is needed only for R2L rows that are not continued, to produce
19425 one extra blank where we could display the cursor. */
19426 if ((it
->current_x
>= it
->last_visible_x
19427 + (!FRAME_WINDOW_P (f
)
19428 && it
->glyph_row
->reversed_p
19429 && !it
->glyph_row
->continued_p
))
19430 /* If the window has display margins, we will need to extend
19431 their face even if the text area is filled. */
19432 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19433 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19436 /* The default face, possibly remapped. */
19437 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19439 /* Face extension extends the background and box of IT->face_id
19440 to the end of the line. If the background equals the background
19441 of the frame, we don't have to do anything. */
19442 if (it
->face_before_selective_p
)
19443 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19445 face
= FACE_FROM_ID (f
, it
->face_id
);
19447 if (FRAME_WINDOW_P (f
)
19448 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19449 && face
->box
== FACE_NO_BOX
19450 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19451 #ifdef HAVE_WINDOW_SYSTEM
19454 && !it
->glyph_row
->reversed_p
)
19457 /* Set the glyph row flag indicating that the face of the last glyph
19458 in the text area has to be drawn to the end of the text area. */
19459 it
->glyph_row
->fill_line_p
= true;
19461 /* If current character of IT is not ASCII, make sure we have the
19462 ASCII face. This will be automatically undone the next time
19463 get_next_display_element returns a multibyte character. Note
19464 that the character will always be single byte in unibyte
19466 if (!ASCII_CHAR_P (it
->c
))
19468 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19471 if (FRAME_WINDOW_P (f
))
19473 /* If the row is empty, add a space with the current face of IT,
19474 so that we know which face to draw. */
19475 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19477 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19478 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19479 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19481 /* Mode line and the header line don't have margins, and
19482 likewise the frame's tool-bar window, if there is any. */
19483 if (!(it
->glyph_row
->mode_line_p
19484 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19485 || (WINDOWP (f
->tool_bar_window
)
19486 && it
->w
== XWINDOW (f
->tool_bar_window
))
19490 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19491 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19493 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19494 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19496 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19498 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19499 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19501 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19502 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19504 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19507 #ifdef HAVE_WINDOW_SYSTEM
19508 if (it
->glyph_row
->reversed_p
)
19510 /* Prepend a stretch glyph to the row, such that the
19511 rightmost glyph will be drawn flushed all the way to the
19512 right margin of the window. The stretch glyph that will
19513 occupy the empty space, if any, to the left of the
19515 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19516 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19517 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19519 int row_width
, stretch_ascent
, stretch_width
;
19520 struct text_pos saved_pos
;
19522 bool saved_avoid_cursor
, saved_box_start
;
19524 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19525 row_width
+= g
->pixel_width
;
19527 /* FIXME: There are various minor display glitches in R2L
19528 rows when only one of the fringes is missing. The
19529 strange condition below produces the least bad effect. */
19530 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19531 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19532 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19533 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19535 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19536 stretch_width
-= row_width
;
19538 if (stretch_width
> 0)
19541 (((it
->ascent
+ it
->descent
)
19542 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19543 saved_pos
= it
->position
;
19544 memset (&it
->position
, 0, sizeof it
->position
);
19545 saved_avoid_cursor
= it
->avoid_cursor_p
;
19546 it
->avoid_cursor_p
= true;
19547 saved_face_id
= it
->face_id
;
19548 saved_box_start
= it
->start_of_box_run_p
;
19549 /* The last row's stretch glyph should get the default
19550 face, to avoid painting the rest of the window with
19551 the region face, if the region ends at ZV. */
19552 if (it
->glyph_row
->ends_at_zv_p
)
19553 it
->face_id
= default_face
->id
;
19555 it
->face_id
= face
->id
;
19556 it
->start_of_box_run_p
= false;
19557 append_stretch_glyph (it
, Qnil
, stretch_width
,
19558 it
->ascent
+ it
->descent
, stretch_ascent
);
19559 it
->position
= saved_pos
;
19560 it
->avoid_cursor_p
= saved_avoid_cursor
;
19561 it
->face_id
= saved_face_id
;
19562 it
->start_of_box_run_p
= saved_box_start
;
19564 /* If stretch_width comes out negative, it means that the
19565 last glyph is only partially visible. In R2L rows, we
19566 want the leftmost glyph to be partially visible, so we
19567 need to give the row the corresponding left offset. */
19568 if (stretch_width
< 0)
19569 it
->glyph_row
->x
= stretch_width
;
19571 #endif /* HAVE_WINDOW_SYSTEM */
19575 /* Save some values that must not be changed. */
19576 int saved_x
= it
->current_x
;
19577 struct text_pos saved_pos
;
19578 Lisp_Object saved_object
;
19579 enum display_element_type saved_what
= it
->what
;
19580 int saved_face_id
= it
->face_id
;
19582 saved_object
= it
->object
;
19583 saved_pos
= it
->position
;
19585 it
->what
= IT_CHARACTER
;
19586 memset (&it
->position
, 0, sizeof it
->position
);
19588 it
->c
= it
->char_to_display
= ' ';
19591 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19592 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19593 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19594 && !it
->glyph_row
->mode_line_p
19595 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19597 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19598 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19600 for (it
->current_x
= 0; g
< e
; g
++)
19601 it
->current_x
+= g
->pixel_width
;
19603 it
->area
= LEFT_MARGIN_AREA
;
19604 it
->face_id
= default_face
->id
;
19605 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19606 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19608 PRODUCE_GLYPHS (it
);
19609 /* term.c:produce_glyphs advances it->current_x only for
19611 it
->current_x
+= it
->pixel_width
;
19614 it
->current_x
= saved_x
;
19615 it
->area
= TEXT_AREA
;
19618 /* The last row's blank glyphs should get the default face, to
19619 avoid painting the rest of the window with the region face,
19620 if the region ends at ZV. */
19621 if (it
->glyph_row
->ends_at_zv_p
)
19622 it
->face_id
= default_face
->id
;
19624 it
->face_id
= face
->id
;
19625 PRODUCE_GLYPHS (it
);
19627 while (it
->current_x
<= it
->last_visible_x
)
19628 PRODUCE_GLYPHS (it
);
19630 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19631 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19632 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19633 && !it
->glyph_row
->mode_line_p
19634 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19636 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19637 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19639 for ( ; g
< e
; g
++)
19640 it
->current_x
+= g
->pixel_width
;
19642 it
->area
= RIGHT_MARGIN_AREA
;
19643 it
->face_id
= default_face
->id
;
19644 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19645 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19647 PRODUCE_GLYPHS (it
);
19648 it
->current_x
+= it
->pixel_width
;
19651 it
->area
= TEXT_AREA
;
19654 /* Don't count these blanks really. It would let us insert a left
19655 truncation glyph below and make us set the cursor on them, maybe. */
19656 it
->current_x
= saved_x
;
19657 it
->object
= saved_object
;
19658 it
->position
= saved_pos
;
19659 it
->what
= saved_what
;
19660 it
->face_id
= saved_face_id
;
19665 /* Value is true if text starting at CHARPOS in current_buffer is
19666 trailing whitespace. */
19669 trailing_whitespace_p (ptrdiff_t charpos
)
19671 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19674 while (bytepos
< ZV_BYTE
19675 && (c
= FETCH_CHAR (bytepos
),
19676 c
== ' ' || c
== '\t'))
19679 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19681 if (bytepos
!= PT_BYTE
)
19688 /* Highlight trailing whitespace, if any, in ROW. */
19691 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19693 int used
= row
->used
[TEXT_AREA
];
19697 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19698 struct glyph
*glyph
= start
+ used
- 1;
19700 if (row
->reversed_p
)
19702 /* Right-to-left rows need to be processed in the opposite
19703 direction, so swap the edge pointers. */
19705 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19708 /* Skip over glyphs inserted to display the cursor at the
19709 end of a line, for extending the face of the last glyph
19710 to the end of the line on terminals, and for truncation
19711 and continuation glyphs. */
19712 if (!row
->reversed_p
)
19714 while (glyph
>= start
19715 && glyph
->type
== CHAR_GLYPH
19716 && NILP (glyph
->object
))
19721 while (glyph
<= start
19722 && glyph
->type
== CHAR_GLYPH
19723 && NILP (glyph
->object
))
19727 /* If last glyph is a space or stretch, and it's trailing
19728 whitespace, set the face of all trailing whitespace glyphs in
19729 IT->glyph_row to `trailing-whitespace'. */
19730 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19731 && BUFFERP (glyph
->object
)
19732 && (glyph
->type
== STRETCH_GLYPH
19733 || (glyph
->type
== CHAR_GLYPH
19734 && glyph
->u
.ch
== ' '))
19735 && trailing_whitespace_p (glyph
->charpos
))
19737 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19741 if (!row
->reversed_p
)
19743 while (glyph
>= start
19744 && BUFFERP (glyph
->object
)
19745 && (glyph
->type
== STRETCH_GLYPH
19746 || (glyph
->type
== CHAR_GLYPH
19747 && glyph
->u
.ch
== ' ')))
19748 (glyph
--)->face_id
= face_id
;
19752 while (glyph
<= start
19753 && BUFFERP (glyph
->object
)
19754 && (glyph
->type
== STRETCH_GLYPH
19755 || (glyph
->type
== CHAR_GLYPH
19756 && glyph
->u
.ch
== ' ')))
19757 (glyph
++)->face_id
= face_id
;
19764 /* Value is true if glyph row ROW should be
19765 considered to hold the buffer position CHARPOS. */
19768 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19770 bool result
= true;
19772 if (charpos
== CHARPOS (row
->end
.pos
)
19773 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19775 /* Suppose the row ends on a string.
19776 Unless the row is continued, that means it ends on a newline
19777 in the string. If it's anything other than a display string
19778 (e.g., a before-string from an overlay), we don't want the
19779 cursor there. (This heuristic seems to give the optimal
19780 behavior for the various types of multi-line strings.)
19781 One exception: if the string has `cursor' property on one of
19782 its characters, we _do_ want the cursor there. */
19783 if (CHARPOS (row
->end
.string_pos
) >= 0)
19785 if (row
->continued_p
)
19789 /* Check for `display' property. */
19790 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19791 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19792 struct glyph
*glyph
;
19795 for (glyph
= end
; glyph
>= beg
; --glyph
)
19796 if (STRINGP (glyph
->object
))
19799 = Fget_char_property (make_number (charpos
),
19803 && display_prop_string_p (prop
, glyph
->object
));
19804 /* If there's a `cursor' property on one of the
19805 string's characters, this row is a cursor row,
19806 even though this is not a display string. */
19809 Lisp_Object s
= glyph
->object
;
19811 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19813 ptrdiff_t gpos
= glyph
->charpos
;
19815 if (!NILP (Fget_char_property (make_number (gpos
),
19827 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19829 /* If the row ends in middle of a real character,
19830 and the line is continued, we want the cursor here.
19831 That's because CHARPOS (ROW->end.pos) would equal
19832 PT if PT is before the character. */
19833 if (!row
->ends_in_ellipsis_p
)
19834 result
= row
->continued_p
;
19836 /* If the row ends in an ellipsis, then
19837 CHARPOS (ROW->end.pos) will equal point after the
19838 invisible text. We want that position to be displayed
19839 after the ellipsis. */
19842 /* If the row ends at ZV, display the cursor at the end of that
19843 row instead of at the start of the row below. */
19845 result
= row
->ends_at_zv_p
;
19851 /* Value is true if glyph row ROW should be
19852 used to hold the cursor. */
19855 cursor_row_p (struct glyph_row
*row
)
19857 return row_for_charpos_p (row
, PT
);
19862 /* Push the property PROP so that it will be rendered at the current
19863 position in IT. Return true if PROP was successfully pushed, false
19864 otherwise. Called from handle_line_prefix to handle the
19865 `line-prefix' and `wrap-prefix' properties. */
19868 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19870 struct text_pos pos
=
19871 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19873 eassert (it
->method
== GET_FROM_BUFFER
19874 || it
->method
== GET_FROM_DISPLAY_VECTOR
19875 || it
->method
== GET_FROM_STRING
19876 || it
->method
== GET_FROM_IMAGE
);
19878 /* We need to save the current buffer/string position, so it will be
19879 restored by pop_it, because iterate_out_of_display_property
19880 depends on that being set correctly, but some situations leave
19881 it->position not yet set when this function is called. */
19882 push_it (it
, &pos
);
19884 if (STRINGP (prop
))
19886 if (SCHARS (prop
) == 0)
19893 it
->string_from_prefix_prop_p
= true;
19894 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19895 it
->current
.overlay_string_index
= -1;
19896 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19897 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19898 it
->method
= GET_FROM_STRING
;
19899 it
->stop_charpos
= 0;
19901 it
->base_level_stop
= 0;
19903 /* Force paragraph direction to be that of the parent
19905 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19906 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19908 it
->paragraph_embedding
= L2R
;
19910 /* Set up the bidi iterator for this display string. */
19913 it
->bidi_it
.string
.lstring
= it
->string
;
19914 it
->bidi_it
.string
.s
= NULL
;
19915 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19916 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19917 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19918 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19919 it
->bidi_it
.w
= it
->w
;
19920 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19923 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19925 it
->method
= GET_FROM_STRETCH
;
19928 #ifdef HAVE_WINDOW_SYSTEM
19929 else if (IMAGEP (prop
))
19931 it
->what
= IT_IMAGE
;
19932 it
->image_id
= lookup_image (it
->f
, prop
);
19933 it
->method
= GET_FROM_IMAGE
;
19935 #endif /* HAVE_WINDOW_SYSTEM */
19938 pop_it (it
); /* bogus display property, give up */
19945 /* Return the character-property PROP at the current position in IT. */
19948 get_it_property (struct it
*it
, Lisp_Object prop
)
19950 Lisp_Object position
, object
= it
->object
;
19952 if (STRINGP (object
))
19953 position
= make_number (IT_STRING_CHARPOS (*it
));
19954 else if (BUFFERP (object
))
19956 position
= make_number (IT_CHARPOS (*it
));
19957 object
= it
->window
;
19962 return Fget_char_property (position
, prop
, object
);
19965 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19968 handle_line_prefix (struct it
*it
)
19970 Lisp_Object prefix
;
19972 if (it
->continuation_lines_width
> 0)
19974 prefix
= get_it_property (it
, Qwrap_prefix
);
19976 prefix
= Vwrap_prefix
;
19980 prefix
= get_it_property (it
, Qline_prefix
);
19982 prefix
= Vline_prefix
;
19984 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19986 /* If the prefix is wider than the window, and we try to wrap
19987 it, it would acquire its own wrap prefix, and so on till the
19988 iterator stack overflows. So, don't wrap the prefix. */
19989 it
->line_wrap
= TRUNCATE
;
19990 it
->avoid_cursor_p
= true;
19996 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19997 only for R2L lines from display_line and display_string, when they
19998 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19999 the line/string needs to be continued on the next glyph row. */
20001 unproduce_glyphs (struct it
*it
, int n
)
20003 struct glyph
*glyph
, *end
;
20005 eassert (it
->glyph_row
);
20006 eassert (it
->glyph_row
->reversed_p
);
20007 eassert (it
->area
== TEXT_AREA
);
20008 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20010 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20011 n
= it
->glyph_row
->used
[TEXT_AREA
];
20012 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20013 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20014 for ( ; glyph
< end
; glyph
++)
20015 glyph
[-n
] = *glyph
;
20018 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20019 and ROW->maxpos. */
20021 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20022 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20023 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20025 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20026 lines' rows is implemented for bidi-reordered rows. */
20028 /* ROW->minpos is the value of min_pos, the minimal buffer position
20029 we have in ROW, or ROW->start.pos if that is smaller. */
20030 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20031 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20033 /* We didn't find buffer positions smaller than ROW->start, or
20034 didn't find _any_ valid buffer positions in any of the glyphs,
20035 so we must trust the iterator's computed positions. */
20036 row
->minpos
= row
->start
.pos
;
20039 max_pos
= CHARPOS (it
->current
.pos
);
20040 max_bpos
= BYTEPOS (it
->current
.pos
);
20043 /* Here are the various use-cases for ending the row, and the
20044 corresponding values for ROW->maxpos:
20046 Line ends in a newline from buffer eol_pos + 1
20047 Line is continued from buffer max_pos + 1
20048 Line is truncated on right it->current.pos
20049 Line ends in a newline from string max_pos + 1(*)
20050 (*) + 1 only when line ends in a forward scan
20051 Line is continued from string max_pos
20052 Line is continued from display vector max_pos
20053 Line is entirely from a string min_pos == max_pos
20054 Line is entirely from a display vector min_pos == max_pos
20055 Line that ends at ZV ZV
20057 If you discover other use-cases, please add them here as
20059 if (row
->ends_at_zv_p
)
20060 row
->maxpos
= it
->current
.pos
;
20061 else if (row
->used
[TEXT_AREA
])
20063 bool seen_this_string
= false;
20064 struct glyph_row
*r1
= row
- 1;
20066 /* Did we see the same display string on the previous row? */
20067 if (STRINGP (it
->object
)
20068 /* this is not the first row */
20069 && row
> it
->w
->desired_matrix
->rows
20070 /* previous row is not the header line */
20071 && !r1
->mode_line_p
20072 /* previous row also ends in a newline from a string */
20073 && r1
->ends_in_newline_from_string_p
)
20075 struct glyph
*start
, *end
;
20077 /* Search for the last glyph of the previous row that came
20078 from buffer or string. Depending on whether the row is
20079 L2R or R2L, we need to process it front to back or the
20080 other way round. */
20081 if (!r1
->reversed_p
)
20083 start
= r1
->glyphs
[TEXT_AREA
];
20084 end
= start
+ r1
->used
[TEXT_AREA
];
20085 /* Glyphs inserted by redisplay have nil as their object. */
20087 && NILP ((end
- 1)->object
)
20088 && (end
- 1)->charpos
<= 0)
20092 if (EQ ((end
- 1)->object
, it
->object
))
20093 seen_this_string
= true;
20096 /* If all the glyphs of the previous row were inserted
20097 by redisplay, it means the previous row was
20098 produced from a single newline, which is only
20099 possible if that newline came from the same string
20100 as the one which produced this ROW. */
20101 seen_this_string
= true;
20105 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20106 start
= end
+ r1
->used
[TEXT_AREA
];
20108 && NILP ((end
+ 1)->object
)
20109 && (end
+ 1)->charpos
<= 0)
20113 if (EQ ((end
+ 1)->object
, it
->object
))
20114 seen_this_string
= true;
20117 seen_this_string
= true;
20120 /* Take note of each display string that covers a newline only
20121 once, the first time we see it. This is for when a display
20122 string includes more than one newline in it. */
20123 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20125 /* If we were scanning the buffer forward when we displayed
20126 the string, we want to account for at least one buffer
20127 position that belongs to this row (position covered by
20128 the display string), so that cursor positioning will
20129 consider this row as a candidate when point is at the end
20130 of the visual line represented by this row. This is not
20131 required when scanning back, because max_pos will already
20132 have a much larger value. */
20133 if (CHARPOS (row
->end
.pos
) > max_pos
)
20134 INC_BOTH (max_pos
, max_bpos
);
20135 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20137 else if (CHARPOS (it
->eol_pos
) > 0)
20138 SET_TEXT_POS (row
->maxpos
,
20139 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20140 else if (row
->continued_p
)
20142 /* If max_pos is different from IT's current position, it
20143 means IT->method does not belong to the display element
20144 at max_pos. However, it also means that the display
20145 element at max_pos was displayed in its entirety on this
20146 line, which is equivalent to saying that the next line
20147 starts at the next buffer position. */
20148 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20149 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20152 INC_BOTH (max_pos
, max_bpos
);
20153 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20156 else if (row
->truncated_on_right_p
)
20157 /* display_line already called reseat_at_next_visible_line_start,
20158 which puts the iterator at the beginning of the next line, in
20159 the logical order. */
20160 row
->maxpos
= it
->current
.pos
;
20161 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20162 /* A line that is entirely from a string/image/stretch... */
20163 row
->maxpos
= row
->minpos
;
20168 row
->maxpos
= it
->current
.pos
;
20171 /* Construct the glyph row IT->glyph_row in the desired matrix of
20172 IT->w from text at the current position of IT. See dispextern.h
20173 for an overview of struct it. Value is true if
20174 IT->glyph_row displays text, as opposed to a line displaying ZV
20178 display_line (struct it
*it
)
20180 struct glyph_row
*row
= it
->glyph_row
;
20181 Lisp_Object overlay_arrow_string
;
20183 void *wrap_data
= NULL
;
20184 bool may_wrap
= false;
20185 int wrap_x
IF_LINT (= 0);
20186 int wrap_row_used
= -1;
20187 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20188 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20189 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20190 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20191 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20193 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20194 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20195 bool pending_handle_line_prefix
= false;
20197 /* We always start displaying at hpos zero even if hscrolled. */
20198 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20200 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20201 >= it
->w
->desired_matrix
->nrows
)
20203 it
->w
->nrows_scale_factor
++;
20204 it
->f
->fonts_changed
= true;
20208 /* Clear the result glyph row and enable it. */
20209 prepare_desired_row (it
->w
, row
, false);
20211 row
->y
= it
->current_y
;
20212 row
->start
= it
->start
;
20213 row
->continuation_lines_width
= it
->continuation_lines_width
;
20214 row
->displays_text_p
= true;
20215 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20216 it
->starts_in_middle_of_char_p
= false;
20218 /* Arrange the overlays nicely for our purposes. Usually, we call
20219 display_line on only one line at a time, in which case this
20220 can't really hurt too much, or we call it on lines which appear
20221 one after another in the buffer, in which case all calls to
20222 recenter_overlay_lists but the first will be pretty cheap. */
20223 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20225 /* Move over display elements that are not visible because we are
20226 hscrolled. This may stop at an x-position < IT->first_visible_x
20227 if the first glyph is partially visible or if we hit a line end. */
20228 if (it
->current_x
< it
->first_visible_x
)
20230 enum move_it_result move_result
;
20232 this_line_min_pos
= row
->start
.pos
;
20233 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20234 MOVE_TO_POS
| MOVE_TO_X
);
20235 /* If we are under a large hscroll, move_it_in_display_line_to
20236 could hit the end of the line without reaching
20237 it->first_visible_x. Pretend that we did reach it. This is
20238 especially important on a TTY, where we will call
20239 extend_face_to_end_of_line, which needs to know how many
20240 blank glyphs to produce. */
20241 if (it
->current_x
< it
->first_visible_x
20242 && (move_result
== MOVE_NEWLINE_OR_CR
20243 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20244 it
->current_x
= it
->first_visible_x
;
20246 /* Record the smallest positions seen while we moved over
20247 display elements that are not visible. This is needed by
20248 redisplay_internal for optimizing the case where the cursor
20249 stays inside the same line. The rest of this function only
20250 considers positions that are actually displayed, so
20251 RECORD_MAX_MIN_POS will not otherwise record positions that
20252 are hscrolled to the left of the left edge of the window. */
20253 min_pos
= CHARPOS (this_line_min_pos
);
20254 min_bpos
= BYTEPOS (this_line_min_pos
);
20256 else if (it
->area
== TEXT_AREA
)
20258 /* We only do this when not calling move_it_in_display_line_to
20259 above, because that function calls itself handle_line_prefix. */
20260 handle_line_prefix (it
);
20264 /* Line-prefix and wrap-prefix are always displayed in the text
20265 area. But if this is the first call to display_line after
20266 init_iterator, the iterator might have been set up to write
20267 into a marginal area, e.g. if the line begins with some
20268 display property that writes to the margins. So we need to
20269 wait with the call to handle_line_prefix until whatever
20270 writes to the margin has done its job. */
20271 pending_handle_line_prefix
= true;
20274 /* Get the initial row height. This is either the height of the
20275 text hscrolled, if there is any, or zero. */
20276 row
->ascent
= it
->max_ascent
;
20277 row
->height
= it
->max_ascent
+ it
->max_descent
;
20278 row
->phys_ascent
= it
->max_phys_ascent
;
20279 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20280 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20282 /* Utility macro to record max and min buffer positions seen until now. */
20283 #define RECORD_MAX_MIN_POS(IT) \
20286 bool composition_p \
20287 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20288 ptrdiff_t current_pos = \
20289 composition_p ? (IT)->cmp_it.charpos \
20290 : IT_CHARPOS (*(IT)); \
20291 ptrdiff_t current_bpos = \
20292 composition_p ? CHAR_TO_BYTE (current_pos) \
20293 : IT_BYTEPOS (*(IT)); \
20294 if (current_pos < min_pos) \
20296 min_pos = current_pos; \
20297 min_bpos = current_bpos; \
20299 if (IT_CHARPOS (*it) > max_pos) \
20301 max_pos = IT_CHARPOS (*it); \
20302 max_bpos = IT_BYTEPOS (*it); \
20307 /* Loop generating characters. The loop is left with IT on the next
20308 character to display. */
20311 int n_glyphs_before
, hpos_before
, x_before
;
20313 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20315 /* Retrieve the next thing to display. Value is false if end of
20317 if (!get_next_display_element (it
))
20319 /* Maybe add a space at the end of this line that is used to
20320 display the cursor there under X. Set the charpos of the
20321 first glyph of blank lines not corresponding to any text
20323 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20324 row
->exact_window_width_line_p
= true;
20325 else if ((append_space_for_newline (it
, true)
20326 && row
->used
[TEXT_AREA
] == 1)
20327 || row
->used
[TEXT_AREA
] == 0)
20329 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20330 row
->displays_text_p
= false;
20332 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20333 && (!MINI_WINDOW_P (it
->w
)
20334 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20335 row
->indicate_empty_line_p
= true;
20338 it
->continuation_lines_width
= 0;
20339 row
->ends_at_zv_p
= true;
20340 /* A row that displays right-to-left text must always have
20341 its last face extended all the way to the end of line,
20342 even if this row ends in ZV, because we still write to
20343 the screen left to right. We also need to extend the
20344 last face if the default face is remapped to some
20345 different face, otherwise the functions that clear
20346 portions of the screen will clear with the default face's
20347 background color. */
20348 if (row
->reversed_p
20349 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20350 extend_face_to_end_of_line (it
);
20354 /* Now, get the metrics of what we want to display. This also
20355 generates glyphs in `row' (which is IT->glyph_row). */
20356 n_glyphs_before
= row
->used
[TEXT_AREA
];
20359 /* Remember the line height so far in case the next element doesn't
20360 fit on the line. */
20361 if (it
->line_wrap
!= TRUNCATE
)
20363 ascent
= it
->max_ascent
;
20364 descent
= it
->max_descent
;
20365 phys_ascent
= it
->max_phys_ascent
;
20366 phys_descent
= it
->max_phys_descent
;
20368 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20370 if (IT_DISPLAYING_WHITESPACE (it
))
20374 SAVE_IT (wrap_it
, *it
, wrap_data
);
20376 wrap_row_used
= row
->used
[TEXT_AREA
];
20377 wrap_row_ascent
= row
->ascent
;
20378 wrap_row_height
= row
->height
;
20379 wrap_row_phys_ascent
= row
->phys_ascent
;
20380 wrap_row_phys_height
= row
->phys_height
;
20381 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20382 wrap_row_min_pos
= min_pos
;
20383 wrap_row_min_bpos
= min_bpos
;
20384 wrap_row_max_pos
= max_pos
;
20385 wrap_row_max_bpos
= max_bpos
;
20391 PRODUCE_GLYPHS (it
);
20393 /* If this display element was in marginal areas, continue with
20395 if (it
->area
!= TEXT_AREA
)
20397 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20398 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20399 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20400 row
->phys_height
= max (row
->phys_height
,
20401 it
->max_phys_ascent
+ it
->max_phys_descent
);
20402 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20403 it
->max_extra_line_spacing
);
20404 set_iterator_to_next (it
, true);
20405 /* If we didn't handle the line/wrap prefix above, and the
20406 call to set_iterator_to_next just switched to TEXT_AREA,
20407 process the prefix now. */
20408 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20410 pending_handle_line_prefix
= false;
20411 handle_line_prefix (it
);
20416 /* Does the display element fit on the line? If we truncate
20417 lines, we should draw past the right edge of the window. If
20418 we don't truncate, we want to stop so that we can display the
20419 continuation glyph before the right margin. If lines are
20420 continued, there are two possible strategies for characters
20421 resulting in more than 1 glyph (e.g. tabs): Display as many
20422 glyphs as possible in this line and leave the rest for the
20423 continuation line, or display the whole element in the next
20424 line. Original redisplay did the former, so we do it also. */
20425 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20426 hpos_before
= it
->hpos
;
20429 if (/* Not a newline. */
20431 /* Glyphs produced fit entirely in the line. */
20432 && it
->current_x
< it
->last_visible_x
)
20434 it
->hpos
+= nglyphs
;
20435 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20436 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20437 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20438 row
->phys_height
= max (row
->phys_height
,
20439 it
->max_phys_ascent
+ it
->max_phys_descent
);
20440 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20441 it
->max_extra_line_spacing
);
20442 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20443 /* In R2L rows, we arrange in extend_face_to_end_of_line
20444 to add a right offset to the line, by a suitable
20445 change to the stretch glyph that is the leftmost
20446 glyph of the line. */
20447 && !row
->reversed_p
)
20448 row
->x
= x
- it
->first_visible_x
;
20449 /* Record the maximum and minimum buffer positions seen so
20450 far in glyphs that will be displayed by this row. */
20452 RECORD_MAX_MIN_POS (it
);
20457 struct glyph
*glyph
;
20459 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20461 /* Identify the glyphs added by the last call to
20462 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20463 the previous glyphs. */
20464 if (!row
->reversed_p
)
20465 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20467 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20468 new_x
= x
+ glyph
->pixel_width
;
20470 if (/* Lines are continued. */
20471 it
->line_wrap
!= TRUNCATE
20472 && (/* Glyph doesn't fit on the line. */
20473 new_x
> it
->last_visible_x
20474 /* Or it fits exactly on a window system frame. */
20475 || (new_x
== it
->last_visible_x
20476 && FRAME_WINDOW_P (it
->f
)
20477 && (row
->reversed_p
20478 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20479 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20481 /* End of a continued line. */
20484 || (new_x
== it
->last_visible_x
20485 && FRAME_WINDOW_P (it
->f
)
20486 && (row
->reversed_p
20487 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20488 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20490 /* Current glyph is the only one on the line or
20491 fits exactly on the line. We must continue
20492 the line because we can't draw the cursor
20493 after the glyph. */
20494 row
->continued_p
= true;
20495 it
->current_x
= new_x
;
20496 it
->continuation_lines_width
+= new_x
;
20498 if (i
== nglyphs
- 1)
20500 /* If line-wrap is on, check if a previous
20501 wrap point was found. */
20502 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20503 && wrap_row_used
> 0
20504 /* Even if there is a previous wrap
20505 point, continue the line here as
20506 usual, if (i) the previous character
20507 was a space or tab AND (ii) the
20508 current character is not. */
20510 || IT_DISPLAYING_WHITESPACE (it
)))
20513 /* Record the maximum and minimum buffer
20514 positions seen so far in glyphs that will be
20515 displayed by this row. */
20517 RECORD_MAX_MIN_POS (it
);
20518 set_iterator_to_next (it
, true);
20519 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20521 if (!get_next_display_element (it
))
20523 row
->exact_window_width_line_p
= true;
20524 it
->continuation_lines_width
= 0;
20525 row
->continued_p
= false;
20526 row
->ends_at_zv_p
= true;
20528 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20530 row
->continued_p
= false;
20531 row
->exact_window_width_line_p
= true;
20533 /* If line-wrap is on, check if a
20534 previous wrap point was found. */
20535 else if (wrap_row_used
> 0
20536 /* Even if there is a previous wrap
20537 point, continue the line here as
20538 usual, if (i) the previous character
20539 was a space or tab AND (ii) the
20540 current character is not. */
20542 || IT_DISPLAYING_WHITESPACE (it
)))
20547 else if (it
->bidi_p
)
20548 RECORD_MAX_MIN_POS (it
);
20549 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20550 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20551 extend_face_to_end_of_line (it
);
20553 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20554 && !FRAME_WINDOW_P (it
->f
))
20556 /* A padding glyph that doesn't fit on this line.
20557 This means the whole character doesn't fit
20559 if (row
->reversed_p
)
20560 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20561 - n_glyphs_before
);
20562 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20564 /* Fill the rest of the row with continuation
20565 glyphs like in 20.x. */
20566 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20567 < row
->glyphs
[1 + TEXT_AREA
])
20568 produce_special_glyphs (it
, IT_CONTINUATION
);
20570 row
->continued_p
= true;
20571 it
->current_x
= x_before
;
20572 it
->continuation_lines_width
+= x_before
;
20574 /* Restore the height to what it was before the
20575 element not fitting on the line. */
20576 it
->max_ascent
= ascent
;
20577 it
->max_descent
= descent
;
20578 it
->max_phys_ascent
= phys_ascent
;
20579 it
->max_phys_descent
= phys_descent
;
20580 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20581 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20582 extend_face_to_end_of_line (it
);
20584 else if (wrap_row_used
> 0)
20587 if (row
->reversed_p
)
20588 unproduce_glyphs (it
,
20589 row
->used
[TEXT_AREA
] - wrap_row_used
);
20590 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20591 it
->continuation_lines_width
+= wrap_x
;
20592 row
->used
[TEXT_AREA
] = wrap_row_used
;
20593 row
->ascent
= wrap_row_ascent
;
20594 row
->height
= wrap_row_height
;
20595 row
->phys_ascent
= wrap_row_phys_ascent
;
20596 row
->phys_height
= wrap_row_phys_height
;
20597 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20598 min_pos
= wrap_row_min_pos
;
20599 min_bpos
= wrap_row_min_bpos
;
20600 max_pos
= wrap_row_max_pos
;
20601 max_bpos
= wrap_row_max_bpos
;
20602 row
->continued_p
= true;
20603 row
->ends_at_zv_p
= false;
20604 row
->exact_window_width_line_p
= false;
20605 it
->continuation_lines_width
+= x
;
20607 /* Make sure that a non-default face is extended
20608 up to the right margin of the window. */
20609 extend_face_to_end_of_line (it
);
20611 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20613 /* A TAB that extends past the right edge of the
20614 window. This produces a single glyph on
20615 window system frames. We leave the glyph in
20616 this row and let it fill the row, but don't
20617 consume the TAB. */
20618 if ((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 it
->continuation_lines_width
+= it
->last_visible_x
;
20623 row
->ends_in_middle_of_char_p
= true;
20624 row
->continued_p
= true;
20625 glyph
->pixel_width
= it
->last_visible_x
- x
;
20626 it
->starts_in_middle_of_char_p
= true;
20627 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20628 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20629 extend_face_to_end_of_line (it
);
20633 /* Something other than a TAB that draws past
20634 the right edge of the window. Restore
20635 positions to values before the element. */
20636 if (row
->reversed_p
)
20637 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20638 - (n_glyphs_before
+ i
));
20639 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20641 /* Display continuation glyphs. */
20642 it
->current_x
= x_before
;
20643 it
->continuation_lines_width
+= x
;
20644 if (!FRAME_WINDOW_P (it
->f
)
20645 || (row
->reversed_p
20646 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20647 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20648 produce_special_glyphs (it
, IT_CONTINUATION
);
20649 row
->continued_p
= true;
20651 extend_face_to_end_of_line (it
);
20653 if (nglyphs
> 1 && i
> 0)
20655 row
->ends_in_middle_of_char_p
= true;
20656 it
->starts_in_middle_of_char_p
= true;
20659 /* Restore the height to what it was before the
20660 element not fitting on the line. */
20661 it
->max_ascent
= ascent
;
20662 it
->max_descent
= descent
;
20663 it
->max_phys_ascent
= phys_ascent
;
20664 it
->max_phys_descent
= phys_descent
;
20669 else if (new_x
> it
->first_visible_x
)
20671 /* Increment number of glyphs actually displayed. */
20674 /* Record the maximum and minimum buffer positions
20675 seen so far in glyphs that will be displayed by
20678 RECORD_MAX_MIN_POS (it
);
20680 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20681 /* Glyph is partially visible, i.e. row starts at
20682 negative X position. Don't do that in R2L
20683 rows, where we arrange to add a right offset to
20684 the line in extend_face_to_end_of_line, by a
20685 suitable change to the stretch glyph that is
20686 the leftmost glyph of the line. */
20687 row
->x
= x
- it
->first_visible_x
;
20688 /* When the last glyph of an R2L row only fits
20689 partially on the line, we need to set row->x to a
20690 negative offset, so that the leftmost glyph is
20691 the one that is partially visible. But if we are
20692 going to produce the truncation glyph, this will
20693 be taken care of in produce_special_glyphs. */
20694 if (row
->reversed_p
20695 && new_x
> it
->last_visible_x
20696 && !(it
->line_wrap
== TRUNCATE
20697 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20699 eassert (FRAME_WINDOW_P (it
->f
));
20700 row
->x
= it
->last_visible_x
- new_x
;
20705 /* Glyph is completely off the left margin of the
20706 window. This should not happen because of the
20707 move_it_in_display_line at the start of this
20708 function, unless the text display area of the
20709 window is empty. */
20710 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20713 /* Even if this display element produced no glyphs at all,
20714 we want to record its position. */
20715 if (it
->bidi_p
&& nglyphs
== 0)
20716 RECORD_MAX_MIN_POS (it
);
20718 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20719 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20720 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20721 row
->phys_height
= max (row
->phys_height
,
20722 it
->max_phys_ascent
+ it
->max_phys_descent
);
20723 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20724 it
->max_extra_line_spacing
);
20726 /* End of this display line if row is continued. */
20727 if (row
->continued_p
|| row
->ends_at_zv_p
)
20732 /* Is this a line end? If yes, we're also done, after making
20733 sure that a non-default face is extended up to the right
20734 margin of the window. */
20735 if (ITERATOR_AT_END_OF_LINE_P (it
))
20737 int used_before
= row
->used
[TEXT_AREA
];
20739 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20741 /* Add a space at the end of the line that is used to
20742 display the cursor there. */
20743 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20744 append_space_for_newline (it
, false);
20746 /* Extend the face to the end of the line. */
20747 extend_face_to_end_of_line (it
);
20749 /* Make sure we have the position. */
20750 if (used_before
== 0)
20751 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20753 /* Record the position of the newline, for use in
20755 it
->eol_pos
= it
->current
.pos
;
20757 /* Consume the line end. This skips over invisible lines. */
20758 set_iterator_to_next (it
, true);
20759 it
->continuation_lines_width
= 0;
20763 /* Proceed with next display element. Note that this skips
20764 over lines invisible because of selective display. */
20765 set_iterator_to_next (it
, true);
20767 /* If we truncate lines, we are done when the last displayed
20768 glyphs reach past the right margin of the window. */
20769 if (it
->line_wrap
== TRUNCATE
20770 && ((FRAME_WINDOW_P (it
->f
)
20771 /* Images are preprocessed in produce_image_glyph such
20772 that they are cropped at the right edge of the
20773 window, so an image glyph will always end exactly at
20774 last_visible_x, even if there's no right fringe. */
20775 && ((row
->reversed_p
20776 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20777 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20778 || it
->what
== IT_IMAGE
))
20779 ? (it
->current_x
>= it
->last_visible_x
)
20780 : (it
->current_x
> it
->last_visible_x
)))
20782 /* Maybe add truncation glyphs. */
20783 if (!FRAME_WINDOW_P (it
->f
)
20784 || (row
->reversed_p
20785 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20786 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20790 if (!row
->reversed_p
)
20792 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20793 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20798 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20799 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20801 /* Remove any padding glyphs at the front of ROW, to
20802 make room for the truncation glyphs we will be
20803 adding below. The loop below always inserts at
20804 least one truncation glyph, so also remove the
20805 last glyph added to ROW. */
20806 unproduce_glyphs (it
, i
+ 1);
20807 /* Adjust i for the loop below. */
20808 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20811 /* produce_special_glyphs overwrites the last glyph, so
20812 we don't want that if we want to keep that last
20813 glyph, which means it's an image. */
20814 if (it
->current_x
> it
->last_visible_x
)
20816 it
->current_x
= x_before
;
20817 if (!FRAME_WINDOW_P (it
->f
))
20819 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20821 row
->used
[TEXT_AREA
] = i
;
20822 produce_special_glyphs (it
, IT_TRUNCATION
);
20827 row
->used
[TEXT_AREA
] = i
;
20828 produce_special_glyphs (it
, IT_TRUNCATION
);
20830 it
->hpos
= hpos_before
;
20833 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20835 /* Don't truncate if we can overflow newline into fringe. */
20836 if (!get_next_display_element (it
))
20838 it
->continuation_lines_width
= 0;
20839 row
->ends_at_zv_p
= true;
20840 row
->exact_window_width_line_p
= true;
20843 if (ITERATOR_AT_END_OF_LINE_P (it
))
20845 row
->exact_window_width_line_p
= true;
20846 goto at_end_of_line
;
20848 it
->current_x
= x_before
;
20849 it
->hpos
= hpos_before
;
20852 row
->truncated_on_right_p
= true;
20853 it
->continuation_lines_width
= 0;
20854 reseat_at_next_visible_line_start (it
, false);
20855 /* We insist below that IT's position be at ZV because in
20856 bidi-reordered lines the character at visible line start
20857 might not be the character that follows the newline in
20858 the logical order. */
20859 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20860 row
->ends_at_zv_p
=
20861 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20863 row
->ends_at_zv_p
= false;
20869 bidi_unshelve_cache (wrap_data
, true);
20871 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20872 at the left window margin. */
20873 if (it
->first_visible_x
20874 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20876 if (!FRAME_WINDOW_P (it
->f
)
20877 || (((row
->reversed_p
20878 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20879 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20880 /* Don't let insert_left_trunc_glyphs overwrite the
20881 first glyph of the row if it is an image. */
20882 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20883 insert_left_trunc_glyphs (it
);
20884 row
->truncated_on_left_p
= true;
20887 /* Remember the position at which this line ends.
20889 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20890 cannot be before the call to find_row_edges below, since that is
20891 where these positions are determined. */
20892 row
->end
= it
->current
;
20895 row
->minpos
= row
->start
.pos
;
20896 row
->maxpos
= row
->end
.pos
;
20900 /* ROW->minpos and ROW->maxpos must be the smallest and
20901 `1 + the largest' buffer positions in ROW. But if ROW was
20902 bidi-reordered, these two positions can be anywhere in the
20903 row, so we must determine them now. */
20904 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20907 /* If the start of this line is the overlay arrow-position, then
20908 mark this glyph row as the one containing the overlay arrow.
20909 This is clearly a mess with variable size fonts. It would be
20910 better to let it be displayed like cursors under X. */
20911 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20912 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20913 !NILP (overlay_arrow_string
)))
20915 /* Overlay arrow in window redisplay is a fringe bitmap. */
20916 if (STRINGP (overlay_arrow_string
))
20918 struct glyph_row
*arrow_row
20919 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20920 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20921 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20922 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20923 struct glyph
*p2
, *end
;
20925 /* Copy the arrow glyphs. */
20926 while (glyph
< arrow_end
)
20929 /* Throw away padding glyphs. */
20931 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20932 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20938 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20943 eassert (INTEGERP (overlay_arrow_string
));
20944 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20946 overlay_arrow_seen
= true;
20949 /* Highlight trailing whitespace. */
20950 if (!NILP (Vshow_trailing_whitespace
))
20951 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20953 /* Compute pixel dimensions of this line. */
20954 compute_line_metrics (it
);
20956 /* Implementation note: No changes in the glyphs of ROW or in their
20957 faces can be done past this point, because compute_line_metrics
20958 computes ROW's hash value and stores it within the glyph_row
20961 /* Record whether this row ends inside an ellipsis. */
20962 row
->ends_in_ellipsis_p
20963 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20964 && it
->ellipsis_p
);
20966 /* Save fringe bitmaps in this row. */
20967 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20968 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20969 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20970 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20972 it
->left_user_fringe_bitmap
= 0;
20973 it
->left_user_fringe_face_id
= 0;
20974 it
->right_user_fringe_bitmap
= 0;
20975 it
->right_user_fringe_face_id
= 0;
20977 /* Maybe set the cursor. */
20978 cvpos
= it
->w
->cursor
.vpos
;
20980 /* In bidi-reordered rows, keep checking for proper cursor
20981 position even if one has been found already, because buffer
20982 positions in such rows change non-linearly with ROW->VPOS,
20983 when a line is continued. One exception: when we are at ZV,
20984 display cursor on the first suitable glyph row, since all
20985 the empty rows after that also have their position set to ZV. */
20986 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20987 lines' rows is implemented for bidi-reordered rows. */
20989 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20990 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20991 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20992 && cursor_row_p (row
))
20993 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20995 /* Prepare for the next line. This line starts horizontally at (X
20996 HPOS) = (0 0). Vertical positions are incremented. As a
20997 convenience for the caller, IT->glyph_row is set to the next
20999 it
->current_x
= it
->hpos
= 0;
21000 it
->current_y
+= row
->height
;
21001 SET_TEXT_POS (it
->eol_pos
, 0, 0);
21004 /* The next row should by default use the same value of the
21005 reversed_p flag as this one. set_iterator_to_next decides when
21006 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21007 the flag accordingly. */
21008 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
21009 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21010 it
->start
= row
->end
;
21011 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21013 #undef RECORD_MAX_MIN_POS
21016 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21017 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21018 doc
: /* Return paragraph direction at point in BUFFER.
21019 Value is either `left-to-right' or `right-to-left'.
21020 If BUFFER is omitted or nil, it defaults to the current buffer.
21022 Paragraph direction determines how the text in the paragraph is displayed.
21023 In left-to-right paragraphs, text begins at the left margin of the window
21024 and the reading direction is generally left to right. In right-to-left
21025 paragraphs, text begins at the right margin and is read from right to left.
21027 See also `bidi-paragraph-direction'. */)
21028 (Lisp_Object buffer
)
21030 struct buffer
*buf
= current_buffer
;
21031 struct buffer
*old
= buf
;
21033 if (! NILP (buffer
))
21035 CHECK_BUFFER (buffer
);
21036 buf
= XBUFFER (buffer
);
21039 if (NILP (BVAR (buf
, bidi_display_reordering
))
21040 || NILP (BVAR (buf
, enable_multibyte_characters
))
21041 /* When we are loading loadup.el, the character property tables
21042 needed for bidi iteration are not yet available. */
21043 || !NILP (Vpurify_flag
))
21044 return Qleft_to_right
;
21045 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21046 return BVAR (buf
, bidi_paragraph_direction
);
21049 /* Determine the direction from buffer text. We could try to
21050 use current_matrix if it is up to date, but this seems fast
21051 enough as it is. */
21052 struct bidi_it itb
;
21053 ptrdiff_t pos
= BUF_PT (buf
);
21054 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21056 void *itb_data
= bidi_shelve_cache ();
21058 set_buffer_temp (buf
);
21059 /* bidi_paragraph_init finds the base direction of the paragraph
21060 by searching forward from paragraph start. We need the base
21061 direction of the current or _previous_ paragraph, so we need
21062 to make sure we are within that paragraph. To that end, find
21063 the previous non-empty line. */
21064 if (pos
>= ZV
&& pos
> BEGV
)
21065 DEC_BOTH (pos
, bytepos
);
21066 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21067 if (fast_looking_at (trailing_white_space
,
21068 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21070 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21071 || c
== ' ' || c
== '\t' || c
== '\f')
21073 if (bytepos
<= BEGV_BYTE
)
21078 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21081 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21082 itb
.paragraph_dir
= NEUTRAL_DIR
;
21083 itb
.string
.s
= NULL
;
21084 itb
.string
.lstring
= Qnil
;
21085 itb
.string
.bufpos
= 0;
21086 itb
.string
.from_disp_str
= false;
21087 itb
.string
.unibyte
= false;
21088 /* We have no window to use here for ignoring window-specific
21089 overlays. Using NULL for window pointer will cause
21090 compute_display_string_pos to use the current buffer. */
21092 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21093 bidi_unshelve_cache (itb_data
, false);
21094 set_buffer_temp (old
);
21095 switch (itb
.paragraph_dir
)
21098 return Qleft_to_right
;
21101 return Qright_to_left
;
21109 DEFUN ("bidi-find-overridden-directionality",
21110 Fbidi_find_overridden_directionality
,
21111 Sbidi_find_overridden_directionality
, 2, 3, 0,
21112 doc
: /* Return position between FROM and TO where directionality was overridden.
21114 This function returns the first character position in the specified
21115 region of OBJECT where there is a character whose `bidi-class' property
21116 is `L', but which was forced to display as `R' by a directional
21117 override, and likewise with characters whose `bidi-class' is `R'
21118 or `AL' that were forced to display as `L'.
21120 If no such character is found, the function returns nil.
21122 OBJECT is a Lisp string or buffer to search for overridden
21123 directionality, and defaults to the current buffer if nil or omitted.
21124 OBJECT can also be a window, in which case the function will search
21125 the buffer displayed in that window. Passing the window instead of
21126 a buffer is preferable when the buffer is displayed in some window,
21127 because this function will then be able to correctly account for
21128 window-specific overlays, which can affect the results.
21130 Strong directional characters `L', `R', and `AL' can have their
21131 intrinsic directionality overridden by directional override
21132 control characters RLO (u+202e) and LRO (u+202d). See the
21133 function `get-char-code-property' for a way to inquire about
21134 the `bidi-class' property of a character. */)
21135 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21137 struct buffer
*buf
= current_buffer
;
21138 struct buffer
*old
= buf
;
21139 struct window
*w
= NULL
;
21140 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21141 struct bidi_it itb
;
21142 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21145 if (!NILP (object
))
21147 if (BUFFERP (object
))
21148 buf
= XBUFFER (object
);
21149 else if (WINDOWP (object
))
21151 w
= decode_live_window (object
);
21152 buf
= XBUFFER (w
->contents
);
21153 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21156 CHECK_STRING (object
);
21159 if (STRINGP (object
))
21161 /* Characters in unibyte strings are always treated by bidi.c as
21163 if (!STRING_MULTIBYTE (object
)
21164 /* When we are loading loadup.el, the character property
21165 tables needed for bidi iteration are not yet
21167 || !NILP (Vpurify_flag
))
21170 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21171 if (from_pos
>= SCHARS (object
))
21174 /* Set up the bidi iterator. */
21175 itb_data
= bidi_shelve_cache ();
21176 itb
.paragraph_dir
= NEUTRAL_DIR
;
21177 itb
.string
.lstring
= object
;
21178 itb
.string
.s
= NULL
;
21179 itb
.string
.schars
= SCHARS (object
);
21180 itb
.string
.bufpos
= 0;
21181 itb
.string
.from_disp_str
= false;
21182 itb
.string
.unibyte
= false;
21184 bidi_init_it (0, 0, frame_window_p
, &itb
);
21188 /* Nothing this fancy can happen in unibyte buffers, or in a
21189 buffer that disabled reordering, or if FROM is at EOB. */
21190 if (NILP (BVAR (buf
, bidi_display_reordering
))
21191 || NILP (BVAR (buf
, enable_multibyte_characters
))
21192 /* When we are loading loadup.el, the character property
21193 tables needed for bidi iteration are not yet
21195 || !NILP (Vpurify_flag
))
21198 set_buffer_temp (buf
);
21199 validate_region (&from
, &to
);
21200 from_pos
= XINT (from
);
21201 to_pos
= XINT (to
);
21202 if (from_pos
>= ZV
)
21205 /* Set up the bidi iterator. */
21206 itb_data
= bidi_shelve_cache ();
21207 from_bpos
= CHAR_TO_BYTE (from_pos
);
21208 if (from_pos
== BEGV
)
21210 itb
.charpos
= BEGV
;
21211 itb
.bytepos
= BEGV_BYTE
;
21213 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21215 itb
.charpos
= from_pos
;
21216 itb
.bytepos
= from_bpos
;
21219 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21221 itb
.paragraph_dir
= NEUTRAL_DIR
;
21222 itb
.string
.s
= NULL
;
21223 itb
.string
.lstring
= Qnil
;
21224 itb
.string
.bufpos
= 0;
21225 itb
.string
.from_disp_str
= false;
21226 itb
.string
.unibyte
= false;
21228 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21233 /* For the purposes of this function, the actual base direction of
21234 the paragraph doesn't matter, so just set it to L2R. */
21235 bidi_paragraph_init (L2R
, &itb
, false);
21236 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21238 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21240 bidi_unshelve_cache (itb_data
, false);
21241 set_buffer_temp (old
);
21243 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21246 DEFUN ("move-point-visually", Fmove_point_visually
,
21247 Smove_point_visually
, 1, 1, 0,
21248 doc
: /* Move point in the visual order in the specified DIRECTION.
21249 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21252 Value is the new character position of point. */)
21253 (Lisp_Object direction
)
21255 struct window
*w
= XWINDOW (selected_window
);
21256 struct buffer
*b
= XBUFFER (w
->contents
);
21257 struct glyph_row
*row
;
21259 Lisp_Object paragraph_dir
;
21261 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21262 (!(ROW)->continued_p \
21263 && NILP ((GLYPH)->object) \
21264 && (GLYPH)->type == CHAR_GLYPH \
21265 && (GLYPH)->u.ch == ' ' \
21266 && (GLYPH)->charpos >= 0 \
21267 && !(GLYPH)->avoid_cursor_p)
21269 CHECK_NUMBER (direction
);
21270 dir
= XINT (direction
);
21276 /* If current matrix is up-to-date, we can use the information
21277 recorded in the glyphs, at least as long as the goal is on the
21279 if (w
->window_end_valid
21280 && !windows_or_buffers_changed
21282 && !b
->clip_changed
21283 && !b
->prevent_redisplay_optimizations_p
21284 && !window_outdated (w
)
21285 /* We rely below on the cursor coordinates to be up to date, but
21286 we cannot trust them if some command moved point since the
21287 last complete redisplay. */
21288 && w
->last_point
== BUF_PT (b
)
21289 && w
->cursor
.vpos
>= 0
21290 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21291 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21293 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21294 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21295 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21297 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21299 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21301 SET_PT (g
->charpos
);
21302 w
->cursor
.vpos
= -1;
21303 return make_number (PT
);
21305 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21309 if (BUFFERP (gpt
->object
))
21312 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21313 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21315 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21317 else if (BUFFERP (g
->object
))
21318 new_pos
= g
->charpos
;
21322 w
->cursor
.vpos
= -1;
21323 return make_number (PT
);
21325 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21327 /* Glyphs inserted at the end of a non-empty line for
21328 positioning the cursor have zero charpos, so we must
21329 deduce the value of point by other means. */
21330 if (g
->charpos
> 0)
21331 SET_PT (g
->charpos
);
21332 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21334 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21335 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21338 w
->cursor
.vpos
= -1;
21339 return make_number (PT
);
21342 if (g
== e
|| NILP (g
->object
))
21344 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21345 goto simulate_display
;
21346 if (!row
->reversed_p
)
21350 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21351 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21352 goto simulate_display
;
21356 if (row
->reversed_p
&& !row
->continued_p
)
21358 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21359 w
->cursor
.vpos
= -1;
21360 return make_number (PT
);
21362 g
= row
->glyphs
[TEXT_AREA
];
21363 e
= g
+ row
->used
[TEXT_AREA
];
21364 for ( ; g
< e
; g
++)
21366 if (BUFFERP (g
->object
)
21367 /* Empty lines have only one glyph, which stands
21368 for the newline, and whose charpos is the
21369 buffer position of the newline. */
21370 || ROW_GLYPH_NEWLINE_P (row
, g
)
21371 /* When the buffer ends in a newline, the line at
21372 EOB also has one glyph, but its charpos is -1. */
21373 || (row
->ends_at_zv_p
21374 && !row
->reversed_p
21375 && NILP (g
->object
)
21376 && g
->type
== CHAR_GLYPH
21377 && g
->u
.ch
== ' '))
21379 if (g
->charpos
> 0)
21380 SET_PT (g
->charpos
);
21381 else if (!row
->reversed_p
21382 && row
->ends_at_zv_p
21387 w
->cursor
.vpos
= -1;
21388 return make_number (PT
);
21394 if (!row
->reversed_p
&& !row
->continued_p
)
21396 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21397 w
->cursor
.vpos
= -1;
21398 return make_number (PT
);
21400 e
= row
->glyphs
[TEXT_AREA
];
21401 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21402 for ( ; g
>= e
; g
--)
21404 if (BUFFERP (g
->object
)
21405 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21407 /* Empty R2L lines on GUI frames have the buffer
21408 position of the newline stored in the stretch
21410 || g
->type
== STRETCH_GLYPH
21411 || (row
->ends_at_zv_p
21413 && NILP (g
->object
)
21414 && g
->type
== CHAR_GLYPH
21415 && g
->u
.ch
== ' '))
21417 if (g
->charpos
> 0)
21418 SET_PT (g
->charpos
);
21419 else if (row
->reversed_p
21420 && row
->ends_at_zv_p
21425 w
->cursor
.vpos
= -1;
21426 return make_number (PT
);
21435 /* If we wind up here, we failed to move by using the glyphs, so we
21436 need to simulate display instead. */
21439 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21441 paragraph_dir
= Qleft_to_right
;
21442 if (EQ (paragraph_dir
, Qright_to_left
))
21444 if (PT
<= BEGV
&& dir
< 0)
21445 xsignal0 (Qbeginning_of_buffer
);
21446 else if (PT
>= ZV
&& dir
> 0)
21447 xsignal0 (Qend_of_buffer
);
21450 struct text_pos pt
;
21452 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21454 bool overshoot_expected
= false;
21455 bool target_is_eol_p
= false;
21457 /* Setup the arena. */
21458 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21459 start_display (&it
, w
, pt
);
21460 /* When lines are truncated, we could be called with point
21461 outside of the windows edges, in which case move_it_*
21462 functions either prematurely stop at window's edge or jump to
21463 the next screen line, whereas we rely below on our ability to
21464 reach point, in order to start from its X coordinate. So we
21465 need to disregard the window's horizontal extent in that case. */
21466 if (it
.line_wrap
== TRUNCATE
)
21467 it
.last_visible_x
= INFINITY
;
21469 if (it
.cmp_it
.id
< 0
21470 && it
.method
== GET_FROM_STRING
21471 && it
.area
== TEXT_AREA
21472 && it
.string_from_display_prop_p
21473 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21474 overshoot_expected
= true;
21476 /* Find the X coordinate of point. We start from the beginning
21477 of this or previous line to make sure we are before point in
21478 the logical order (since the move_it_* functions can only
21481 reseat_at_previous_visible_line_start (&it
);
21482 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21483 if (IT_CHARPOS (it
) != PT
)
21485 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21486 -1, -1, -1, MOVE_TO_POS
);
21487 /* If we missed point because the character there is
21488 displayed out of a display vector that has more than one
21489 glyph, retry expecting overshoot. */
21490 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21491 && it
.current
.dpvec_index
> 0
21492 && !overshoot_expected
)
21494 overshoot_expected
= true;
21497 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21498 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21500 pt_x
= it
.current_x
;
21502 if (dir
> 0 || overshoot_expected
)
21504 struct glyph_row
*row
= it
.glyph_row
;
21506 /* When point is at beginning of line, we don't have
21507 information about the glyph there loaded into struct
21508 it. Calling get_next_display_element fixes that. */
21510 get_next_display_element (&it
);
21511 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21512 it
.glyph_row
= NULL
;
21513 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21514 it
.glyph_row
= row
;
21515 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21516 it, lest it will become out of sync with it's buffer
21518 it
.current_x
= pt_x
;
21521 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21522 pixel_width
= it
.pixel_width
;
21523 if (overshoot_expected
&& at_eol_p
)
21525 else if (pixel_width
<= 0)
21528 /* If there's a display string (or something similar) at point,
21529 we are actually at the glyph to the left of point, so we need
21530 to correct the X coordinate. */
21531 if (overshoot_expected
)
21534 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21536 pt_x
+= pixel_width
;
21539 /* Compute target X coordinate, either to the left or to the
21540 right of point. On TTY frames, all characters have the same
21541 pixel width of 1, so we can use that. On GUI frames we don't
21542 have an easy way of getting at the pixel width of the
21543 character to the left of point, so we use a different method
21544 of getting to that place. */
21546 target_x
= pt_x
+ pixel_width
;
21548 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21550 /* Target X coordinate could be one line above or below the line
21551 of point, in which case we need to adjust the target X
21552 coordinate. Also, if moving to the left, we need to begin at
21553 the left edge of the point's screen line. */
21558 start_display (&it
, w
, pt
);
21559 if (it
.line_wrap
== TRUNCATE
)
21560 it
.last_visible_x
= INFINITY
;
21561 reseat_at_previous_visible_line_start (&it
);
21562 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21564 move_it_by_lines (&it
, pt_vpos
);
21568 move_it_by_lines (&it
, -1);
21569 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21570 target_is_eol_p
= true;
21571 /* Under word-wrap, we don't know the x coordinate of
21572 the last character displayed on the previous line,
21573 which immediately precedes the wrap point. To find
21574 out its x coordinate, we try moving to the right
21575 margin of the window, which will stop at the wrap
21576 point, and then reset target_x to point at the
21577 character that precedes the wrap point. This is not
21578 needed on GUI frames, because (see below) there we
21579 move from the left margin one grapheme cluster at a
21580 time, and stop when we hit the wrap point. */
21581 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21583 void *it_data
= NULL
;
21586 SAVE_IT (it2
, it
, it_data
);
21587 move_it_in_display_line_to (&it
, ZV
, target_x
,
21588 MOVE_TO_POS
| MOVE_TO_X
);
21589 /* If we arrived at target_x, that _is_ the last
21590 character on the previous line. */
21591 if (it
.current_x
!= target_x
)
21592 target_x
= it
.current_x
- 1;
21593 RESTORE_IT (&it
, &it2
, it_data
);
21600 || (target_x
>= it
.last_visible_x
21601 && it
.line_wrap
!= TRUNCATE
))
21604 move_it_by_lines (&it
, 0);
21605 move_it_by_lines (&it
, 1);
21610 /* Move to the target X coordinate. */
21611 #ifdef HAVE_WINDOW_SYSTEM
21612 /* On GUI frames, as we don't know the X coordinate of the
21613 character to the left of point, moving point to the left
21614 requires walking, one grapheme cluster at a time, until we
21615 find ourself at a place immediately to the left of the
21616 character at point. */
21617 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21619 struct text_pos new_pos
;
21620 enum move_it_result rc
= MOVE_X_REACHED
;
21622 if (it
.current_x
== 0)
21623 get_next_display_element (&it
);
21624 if (it
.what
== IT_COMPOSITION
)
21626 new_pos
.charpos
= it
.cmp_it
.charpos
;
21627 new_pos
.bytepos
= -1;
21630 new_pos
= it
.current
.pos
;
21632 while (it
.current_x
+ it
.pixel_width
<= target_x
21633 && (rc
== MOVE_X_REACHED
21634 /* Under word-wrap, move_it_in_display_line_to
21635 stops at correct coordinates, but sometimes
21636 returns MOVE_POS_MATCH_OR_ZV. */
21637 || (it
.line_wrap
== WORD_WRAP
21638 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21640 int new_x
= it
.current_x
+ it
.pixel_width
;
21642 /* For composed characters, we want the position of the
21643 first character in the grapheme cluster (usually, the
21644 composition's base character), whereas it.current
21645 might give us the position of the _last_ one, e.g. if
21646 the composition is rendered in reverse due to bidi
21648 if (it
.what
== IT_COMPOSITION
)
21650 new_pos
.charpos
= it
.cmp_it
.charpos
;
21651 new_pos
.bytepos
= -1;
21654 new_pos
= it
.current
.pos
;
21655 if (new_x
== it
.current_x
)
21657 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21658 MOVE_TO_POS
| MOVE_TO_X
);
21659 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21662 /* The previous position we saw in the loop is the one we
21664 if (new_pos
.bytepos
== -1)
21665 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21666 it
.current
.pos
= new_pos
;
21670 if (it
.current_x
!= target_x
)
21671 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21673 /* If we ended up in a display string that covers point, move to
21674 buffer position to the right in the visual order. */
21677 while (IT_CHARPOS (it
) == PT
)
21679 set_iterator_to_next (&it
, false);
21680 if (!get_next_display_element (&it
))
21685 /* Move point to that position. */
21686 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21689 return make_number (PT
);
21691 #undef ROW_GLYPH_NEWLINE_P
21694 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21695 Sbidi_resolved_levels
, 0, 1, 0,
21696 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21698 The resolved levels are produced by the Emacs bidi reordering engine
21699 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21700 read the Unicode Standard Annex 9 (UAX#9) for background information
21701 about these levels.
21703 VPOS is the zero-based number of the current window's screen line
21704 for which to produce the resolved levels. If VPOS is nil or omitted,
21705 it defaults to the screen line of point. If the window displays a
21706 header line, VPOS of zero will report on the header line, and first
21707 line of text in the window will have VPOS of 1.
21709 Value is an array of resolved levels, indexed by glyph number.
21710 Glyphs are numbered from zero starting from the beginning of the
21711 screen line, i.e. the left edge of the window for left-to-right lines
21712 and from the right edge for right-to-left lines. The resolved levels
21713 are produced only for the window's text area; text in display margins
21716 If the selected window's display is not up-to-date, or if the specified
21717 screen line does not display text, this function returns nil. It is
21718 highly recommended to bind this function to some simple key, like F8,
21719 in order to avoid these problems.
21721 This function exists mainly for testing the correctness of the
21722 Emacs UBA implementation, in particular with the test suite. */)
21725 struct window
*w
= XWINDOW (selected_window
);
21726 struct buffer
*b
= XBUFFER (w
->contents
);
21728 struct glyph_row
*row
;
21732 int d1
, d2
, d3
, d4
, d5
;
21734 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21738 CHECK_NUMBER_COERCE_MARKER (vpos
);
21739 nrow
= XINT (vpos
);
21742 /* We require up-to-date glyph matrix for this window. */
21743 if (w
->window_end_valid
21744 && !windows_or_buffers_changed
21746 && !b
->clip_changed
21747 && !b
->prevent_redisplay_optimizations_p
21748 && !window_outdated (w
)
21750 && nrow
< w
->current_matrix
->nrows
21751 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21752 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21754 struct glyph
*g
, *e
, *g1
;
21756 Lisp_Object levels
;
21758 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21760 g
= g1
= row
->glyphs
[TEXT_AREA
];
21761 e
= g
+ row
->used
[TEXT_AREA
];
21763 /* Skip over glyphs at the start of the row that was
21764 generated by redisplay for its own needs. */
21766 && NILP (g
->object
)
21771 /* Count the "interesting" glyphs in this row. */
21772 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21775 /* Create and fill the array. */
21776 levels
= make_uninit_vector (nglyphs
);
21777 for (i
= 0; g1
< g
; i
++, g1
++)
21778 ASET (levels
, i
, make_number (g1
->resolved_level
));
21780 else /* Right-to-left glyph row. */
21782 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21783 e
= row
->glyphs
[TEXT_AREA
] - 1;
21785 && NILP (g
->object
)
21789 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21791 levels
= make_uninit_vector (nglyphs
);
21792 for (i
= 0; g1
> g
; i
++, g1
--)
21793 ASET (levels
, i
, make_number (g1
->resolved_level
));
21803 /***********************************************************************
21805 ***********************************************************************/
21807 /* Redisplay the menu bar in the frame for window W.
21809 The menu bar of X frames that don't have X toolkit support is
21810 displayed in a special window W->frame->menu_bar_window.
21812 The menu bar of terminal frames is treated specially as far as
21813 glyph matrices are concerned. Menu bar lines are not part of
21814 windows, so the update is done directly on the frame matrix rows
21815 for the menu bar. */
21818 display_menu_bar (struct window
*w
)
21820 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21825 /* Don't do all this for graphical frames. */
21827 if (FRAME_W32_P (f
))
21830 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21836 if (FRAME_NS_P (f
))
21838 #endif /* HAVE_NS */
21840 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21841 eassert (!FRAME_WINDOW_P (f
));
21842 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21843 it
.first_visible_x
= 0;
21844 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21845 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21846 if (FRAME_WINDOW_P (f
))
21848 /* Menu bar lines are displayed in the desired matrix of the
21849 dummy window menu_bar_window. */
21850 struct window
*menu_w
;
21851 menu_w
= XWINDOW (f
->menu_bar_window
);
21852 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21854 it
.first_visible_x
= 0;
21855 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21858 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21860 /* This is a TTY frame, i.e. character hpos/vpos are used as
21862 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21864 it
.first_visible_x
= 0;
21865 it
.last_visible_x
= FRAME_COLS (f
);
21868 /* FIXME: This should be controlled by a user option. See the
21869 comments in redisplay_tool_bar and display_mode_line about
21871 it
.paragraph_embedding
= L2R
;
21873 /* Clear all rows of the menu bar. */
21874 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21876 struct glyph_row
*row
= it
.glyph_row
+ i
;
21877 clear_glyph_row (row
);
21878 row
->enabled_p
= true;
21879 row
->full_width_p
= true;
21880 row
->reversed_p
= false;
21883 /* Display all items of the menu bar. */
21884 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21885 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21887 Lisp_Object string
;
21889 /* Stop at nil string. */
21890 string
= AREF (items
, i
+ 1);
21894 /* Remember where item was displayed. */
21895 ASET (items
, i
+ 3, make_number (it
.hpos
));
21897 /* Display the item, pad with one space. */
21898 if (it
.current_x
< it
.last_visible_x
)
21899 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21900 SCHARS (string
) + 1, 0, 0, -1);
21903 /* Fill out the line with spaces. */
21904 if (it
.current_x
< it
.last_visible_x
)
21905 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21907 /* Compute the total height of the lines. */
21908 compute_line_metrics (&it
);
21911 /* Deep copy of a glyph row, including the glyphs. */
21913 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21915 struct glyph
*pointers
[1 + LAST_AREA
];
21916 int to_used
= to
->used
[TEXT_AREA
];
21918 /* Save glyph pointers of TO. */
21919 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21921 /* Do a structure assignment. */
21924 /* Restore original glyph pointers of TO. */
21925 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21927 /* Copy the glyphs. */
21928 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21929 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21931 /* If we filled only part of the TO row, fill the rest with
21932 space_glyph (which will display as empty space). */
21933 if (to_used
> from
->used
[TEXT_AREA
])
21934 fill_up_frame_row_with_spaces (to
, to_used
);
21937 /* Display one menu item on a TTY, by overwriting the glyphs in the
21938 frame F's desired glyph matrix with glyphs produced from the menu
21939 item text. Called from term.c to display TTY drop-down menus one
21942 ITEM_TEXT is the menu item text as a C string.
21944 FACE_ID is the face ID to be used for this menu item. FACE_ID
21945 could specify one of 3 faces: a face for an enabled item, a face
21946 for a disabled item, or a face for a selected item.
21948 X and Y are coordinates of the first glyph in the frame's desired
21949 matrix to be overwritten by the menu item. Since this is a TTY, Y
21950 is the zero-based number of the glyph row and X is the zero-based
21951 glyph number in the row, starting from left, where to start
21952 displaying the item.
21954 SUBMENU means this menu item drops down a submenu, which
21955 should be indicated by displaying a proper visual cue after the
21959 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21960 int x
, int y
, bool submenu
)
21963 struct frame
*f
= SELECTED_FRAME ();
21964 struct window
*w
= XWINDOW (f
->selected_window
);
21965 struct glyph_row
*row
;
21966 size_t item_len
= strlen (item_text
);
21968 eassert (FRAME_TERMCAP_P (f
));
21970 /* Don't write beyond the matrix's last row. This can happen for
21971 TTY screens that are not high enough to show the entire menu.
21972 (This is actually a bit of defensive programming, as
21973 tty_menu_display already limits the number of menu items to one
21974 less than the number of screen lines.) */
21975 if (y
>= f
->desired_matrix
->nrows
)
21978 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21979 it
.first_visible_x
= 0;
21980 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21981 row
= it
.glyph_row
;
21982 /* Start with the row contents from the current matrix. */
21983 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21984 bool saved_width
= row
->full_width_p
;
21985 row
->full_width_p
= true;
21986 bool saved_reversed
= row
->reversed_p
;
21987 row
->reversed_p
= false;
21988 row
->enabled_p
= true;
21990 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21992 eassert (x
< f
->desired_matrix
->matrix_w
);
21993 it
.current_x
= it
.hpos
= x
;
21994 it
.current_y
= it
.vpos
= y
;
21995 int saved_used
= row
->used
[TEXT_AREA
];
21996 bool saved_truncated
= row
->truncated_on_right_p
;
21997 row
->used
[TEXT_AREA
] = x
;
21998 it
.face_id
= face_id
;
21999 it
.line_wrap
= TRUNCATE
;
22001 /* FIXME: This should be controlled by a user option. See the
22002 comments in redisplay_tool_bar and display_mode_line about this.
22003 Also, if paragraph_embedding could ever be R2L, changes will be
22004 needed to avoid shifting to the right the row characters in
22005 term.c:append_glyph. */
22006 it
.paragraph_embedding
= L2R
;
22008 /* Pad with a space on the left. */
22009 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22011 /* Display the menu item, pad with spaces to WIDTH. */
22014 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22015 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22017 /* Indicate with " >" that there's a submenu. */
22018 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22019 FRAME_COLS (f
) - 1, -1);
22022 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22023 width
, 0, FRAME_COLS (f
) - 1, -1);
22025 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22026 row
->truncated_on_right_p
= saved_truncated
;
22027 row
->hash
= row_hash (row
);
22028 row
->full_width_p
= saved_width
;
22029 row
->reversed_p
= saved_reversed
;
22032 /***********************************************************************
22034 ***********************************************************************/
22036 /* Redisplay mode lines in the window tree whose root is WINDOW.
22037 If FORCE, redisplay mode lines unconditionally.
22038 Otherwise, redisplay only mode lines that are garbaged. Value is
22039 the number of windows whose mode lines were redisplayed. */
22042 redisplay_mode_lines (Lisp_Object window
, bool force
)
22046 while (!NILP (window
))
22048 struct window
*w
= XWINDOW (window
);
22050 if (WINDOWP (w
->contents
))
22051 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22053 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22054 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22056 struct text_pos lpoint
;
22057 struct buffer
*old
= current_buffer
;
22059 /* Set the window's buffer for the mode line display. */
22060 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22061 set_buffer_internal_1 (XBUFFER (w
->contents
));
22063 /* Point refers normally to the selected window. For any
22064 other window, set up appropriate value. */
22065 if (!EQ (window
, selected_window
))
22067 struct text_pos pt
;
22069 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22070 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22073 /* Display mode lines. */
22074 clear_glyph_matrix (w
->desired_matrix
);
22075 if (display_mode_lines (w
))
22078 /* Restore old settings. */
22079 set_buffer_internal_1 (old
);
22080 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22090 /* Display the mode and/or header line of window W. Value is the
22091 sum number of mode lines and header lines displayed. */
22094 display_mode_lines (struct window
*w
)
22096 Lisp_Object old_selected_window
= selected_window
;
22097 Lisp_Object old_selected_frame
= selected_frame
;
22098 Lisp_Object new_frame
= w
->frame
;
22099 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22102 selected_frame
= new_frame
;
22103 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22104 or window's point, then we'd need select_window_1 here as well. */
22105 XSETWINDOW (selected_window
, w
);
22106 XFRAME (new_frame
)->selected_window
= selected_window
;
22108 /* These will be set while the mode line specs are processed. */
22109 line_number_displayed
= false;
22110 w
->column_number_displayed
= -1;
22112 if (WINDOW_WANTS_MODELINE_P (w
))
22114 struct window
*sel_w
= XWINDOW (old_selected_window
);
22116 /* Select mode line face based on the real selected window. */
22117 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22118 BVAR (current_buffer
, mode_line_format
));
22122 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22124 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22125 BVAR (current_buffer
, header_line_format
));
22129 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22130 selected_frame
= old_selected_frame
;
22131 selected_window
= old_selected_window
;
22133 w
->must_be_updated_p
= true;
22138 /* Display mode or header line of window W. FACE_ID specifies which
22139 line to display; it is either MODE_LINE_FACE_ID or
22140 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22141 display. Value is the pixel height of the mode/header line
22145 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22149 ptrdiff_t count
= SPECPDL_INDEX ();
22151 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22152 /* Don't extend on a previously drawn mode-line.
22153 This may happen if called from pos_visible_p. */
22154 it
.glyph_row
->enabled_p
= false;
22155 prepare_desired_row (w
, it
.glyph_row
, true);
22157 it
.glyph_row
->mode_line_p
= true;
22159 /* FIXME: This should be controlled by a user option. But
22160 supporting such an option is not trivial, since the mode line is
22161 made up of many separate strings. */
22162 it
.paragraph_embedding
= L2R
;
22164 record_unwind_protect (unwind_format_mode_line
,
22165 format_mode_line_unwind_data (NULL
, NULL
,
22168 mode_line_target
= MODE_LINE_DISPLAY
;
22170 /* Temporarily make frame's keyboard the current kboard so that
22171 kboard-local variables in the mode_line_format will get the right
22173 push_kboard (FRAME_KBOARD (it
.f
));
22174 record_unwind_save_match_data ();
22175 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22178 unbind_to (count
, Qnil
);
22180 /* Fill up with spaces. */
22181 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22183 compute_line_metrics (&it
);
22184 it
.glyph_row
->full_width_p
= true;
22185 it
.glyph_row
->continued_p
= false;
22186 it
.glyph_row
->truncated_on_left_p
= false;
22187 it
.glyph_row
->truncated_on_right_p
= false;
22189 /* Make a 3D mode-line have a shadow at its right end. */
22190 face
= FACE_FROM_ID (it
.f
, face_id
);
22191 extend_face_to_end_of_line (&it
);
22192 if (face
->box
!= FACE_NO_BOX
)
22194 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22195 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22196 last
->right_box_line_p
= true;
22199 return it
.glyph_row
->height
;
22202 /* Move element ELT in LIST to the front of LIST.
22203 Return the updated list. */
22206 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22208 register Lisp_Object tail
, prev
;
22209 register Lisp_Object tem
;
22213 while (CONSP (tail
))
22219 /* Splice out the link TAIL. */
22221 list
= XCDR (tail
);
22223 Fsetcdr (prev
, XCDR (tail
));
22225 /* Now make it the first. */
22226 Fsetcdr (tail
, list
);
22231 tail
= XCDR (tail
);
22235 /* Not found--return unchanged LIST. */
22239 /* Contribute ELT to the mode line for window IT->w. How it
22240 translates into text depends on its data type.
22242 IT describes the display environment in which we display, as usual.
22244 DEPTH is the depth in recursion. It is used to prevent
22245 infinite recursion here.
22247 FIELD_WIDTH is the number of characters the display of ELT should
22248 occupy in the mode line, and PRECISION is the maximum number of
22249 characters to display from ELT's representation. See
22250 display_string for details.
22252 Returns the hpos of the end of the text generated by ELT.
22254 PROPS is a property list to add to any string we encounter.
22256 If RISKY, remove (disregard) any properties in any string
22257 we encounter, and ignore :eval and :propertize.
22259 The global variable `mode_line_target' determines whether the
22260 output is passed to `store_mode_line_noprop',
22261 `store_mode_line_string', or `display_string'. */
22264 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22265 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22267 int n
= 0, field
, prec
;
22268 bool literal
= false;
22272 elt
= build_string ("*too-deep*");
22276 switch (XTYPE (elt
))
22280 /* A string: output it and check for %-constructs within it. */
22282 ptrdiff_t offset
= 0;
22284 if (SCHARS (elt
) > 0
22285 && (!NILP (props
) || risky
))
22287 Lisp_Object oprops
, aelt
;
22288 oprops
= Ftext_properties_at (make_number (0), elt
);
22290 /* If the starting string's properties are not what
22291 we want, translate the string. Also, if the string
22292 is risky, do that anyway. */
22294 if (NILP (Fequal (props
, oprops
)) || risky
)
22296 /* If the starting string has properties,
22297 merge the specified ones onto the existing ones. */
22298 if (! NILP (oprops
) && !risky
)
22302 oprops
= Fcopy_sequence (oprops
);
22304 while (CONSP (tem
))
22306 oprops
= Fplist_put (oprops
, XCAR (tem
),
22307 XCAR (XCDR (tem
)));
22308 tem
= XCDR (XCDR (tem
));
22313 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22314 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22316 /* AELT is what we want. Move it to the front
22317 without consing. */
22319 mode_line_proptrans_alist
22320 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22326 /* If AELT has the wrong props, it is useless.
22327 so get rid of it. */
22329 mode_line_proptrans_alist
22330 = Fdelq (aelt
, mode_line_proptrans_alist
);
22332 elt
= Fcopy_sequence (elt
);
22333 Fset_text_properties (make_number (0), Flength (elt
),
22335 /* Add this item to mode_line_proptrans_alist. */
22336 mode_line_proptrans_alist
22337 = Fcons (Fcons (elt
, props
),
22338 mode_line_proptrans_alist
);
22339 /* Truncate mode_line_proptrans_alist
22340 to at most 50 elements. */
22341 tem
= Fnthcdr (make_number (50),
22342 mode_line_proptrans_alist
);
22344 XSETCDR (tem
, Qnil
);
22353 prec
= precision
- n
;
22354 switch (mode_line_target
)
22356 case MODE_LINE_NOPROP
:
22357 case MODE_LINE_TITLE
:
22358 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22360 case MODE_LINE_STRING
:
22361 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22363 case MODE_LINE_DISPLAY
:
22364 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22365 0, prec
, 0, STRING_MULTIBYTE (elt
));
22372 /* Handle the non-literal case. */
22374 while ((precision
<= 0 || n
< precision
)
22375 && SREF (elt
, offset
) != 0
22376 && (mode_line_target
!= MODE_LINE_DISPLAY
22377 || it
->current_x
< it
->last_visible_x
))
22379 ptrdiff_t last_offset
= offset
;
22381 /* Advance to end of string or next format specifier. */
22382 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22385 if (offset
- 1 != last_offset
)
22387 ptrdiff_t nchars
, nbytes
;
22389 /* Output to end of string or up to '%'. Field width
22390 is length of string. Don't output more than
22391 PRECISION allows us. */
22394 prec
= c_string_width (SDATA (elt
) + last_offset
,
22395 offset
- last_offset
, precision
- n
,
22398 switch (mode_line_target
)
22400 case MODE_LINE_NOPROP
:
22401 case MODE_LINE_TITLE
:
22402 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22404 case MODE_LINE_STRING
:
22406 ptrdiff_t bytepos
= last_offset
;
22407 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22408 ptrdiff_t endpos
= (precision
<= 0
22409 ? string_byte_to_char (elt
, offset
)
22410 : charpos
+ nchars
);
22411 Lisp_Object mode_string
22412 = Fsubstring (elt
, make_number (charpos
),
22413 make_number (endpos
));
22414 n
+= store_mode_line_string (NULL
, mode_string
, false,
22418 case MODE_LINE_DISPLAY
:
22420 ptrdiff_t bytepos
= last_offset
;
22421 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22423 if (precision
<= 0)
22424 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22425 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22427 STRING_MULTIBYTE (elt
));
22432 else /* c == '%' */
22434 ptrdiff_t percent_position
= offset
;
22436 /* Get the specified minimum width. Zero means
22439 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22440 field
= field
* 10 + c
- '0';
22442 /* Don't pad beyond the total padding allowed. */
22443 if (field_width
- n
> 0 && field
> field_width
- n
)
22444 field
= field_width
- n
;
22446 /* Note that either PRECISION <= 0 or N < PRECISION. */
22447 prec
= precision
- n
;
22450 n
+= display_mode_element (it
, depth
, field
, prec
,
22451 Vglobal_mode_string
, props
,
22456 ptrdiff_t bytepos
, charpos
;
22458 Lisp_Object string
;
22460 bytepos
= percent_position
;
22461 charpos
= (STRING_MULTIBYTE (elt
)
22462 ? string_byte_to_char (elt
, bytepos
)
22464 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22465 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22467 switch (mode_line_target
)
22469 case MODE_LINE_NOPROP
:
22470 case MODE_LINE_TITLE
:
22471 n
+= store_mode_line_noprop (spec
, field
, prec
);
22473 case MODE_LINE_STRING
:
22475 Lisp_Object tem
= build_string (spec
);
22476 props
= Ftext_properties_at (make_number (charpos
), elt
);
22477 /* Should only keep face property in props */
22478 n
+= store_mode_line_string (NULL
, tem
, false,
22479 field
, prec
, props
);
22482 case MODE_LINE_DISPLAY
:
22484 int nglyphs_before
, nwritten
;
22486 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22487 nwritten
= display_string (spec
, string
, elt
,
22492 /* Assign to the glyphs written above the
22493 string where the `%x' came from, position
22497 struct glyph
*glyph
22498 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22502 for (i
= 0; i
< nwritten
; ++i
)
22504 glyph
[i
].object
= elt
;
22505 glyph
[i
].charpos
= charpos
;
22522 /* A symbol: process the value of the symbol recursively
22523 as if it appeared here directly. Avoid error if symbol void.
22524 Special case: if value of symbol is a string, output the string
22527 register Lisp_Object tem
;
22529 /* If the variable is not marked as risky to set
22530 then its contents are risky to use. */
22531 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22534 tem
= Fboundp (elt
);
22537 tem
= Fsymbol_value (elt
);
22538 /* If value is a string, output that string literally:
22539 don't check for % within it. */
22543 if (!EQ (tem
, elt
))
22545 /* Give up right away for nil or t. */
22555 register Lisp_Object car
, tem
;
22557 /* A cons cell: five distinct cases.
22558 If first element is :eval or :propertize, do something special.
22559 If first element is a string or a cons, process all the elements
22560 and effectively concatenate them.
22561 If first element is a negative number, truncate displaying cdr to
22562 at most that many characters. If positive, pad (with spaces)
22563 to at least that many characters.
22564 If first element is a symbol, process the cadr or caddr recursively
22565 according to whether the symbol's value is non-nil or nil. */
22567 if (EQ (car
, QCeval
))
22569 /* An element of the form (:eval FORM) means evaluate FORM
22570 and use the result as mode line elements. */
22575 if (CONSP (XCDR (elt
)))
22578 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22579 n
+= display_mode_element (it
, depth
, field_width
- n
,
22580 precision
- n
, spec
, props
,
22584 else if (EQ (car
, QCpropertize
))
22586 /* An element of the form (:propertize ELT PROPS...)
22587 means display ELT but applying properties PROPS. */
22592 if (CONSP (XCDR (elt
)))
22593 n
+= display_mode_element (it
, depth
, field_width
- n
,
22594 precision
- n
, XCAR (XCDR (elt
)),
22595 XCDR (XCDR (elt
)), risky
);
22597 else if (SYMBOLP (car
))
22599 tem
= Fboundp (car
);
22603 /* elt is now the cdr, and we know it is a cons cell.
22604 Use its car if CAR has a non-nil value. */
22607 tem
= Fsymbol_value (car
);
22614 /* Symbol's value is nil (or symbol is unbound)
22615 Get the cddr of the original list
22616 and if possible find the caddr and use that. */
22620 else if (!CONSP (elt
))
22625 else if (INTEGERP (car
))
22627 register int lim
= XINT (car
);
22631 /* Negative int means reduce maximum width. */
22632 if (precision
<= 0)
22635 precision
= min (precision
, -lim
);
22639 /* Padding specified. Don't let it be more than
22640 current maximum. */
22642 lim
= min (precision
, lim
);
22644 /* If that's more padding than already wanted, queue it.
22645 But don't reduce padding already specified even if
22646 that is beyond the current truncation point. */
22647 field_width
= max (lim
, field_width
);
22651 else if (STRINGP (car
) || CONSP (car
))
22653 Lisp_Object halftail
= elt
;
22657 && (precision
<= 0 || n
< precision
))
22659 n
+= display_mode_element (it
, depth
,
22660 /* Do padding only after the last
22661 element in the list. */
22662 (! CONSP (XCDR (elt
))
22665 precision
- n
, XCAR (elt
),
22669 if ((len
& 1) == 0)
22670 halftail
= XCDR (halftail
);
22671 /* Check for cycle. */
22672 if (EQ (halftail
, elt
))
22681 elt
= build_string ("*invalid*");
22685 /* Pad to FIELD_WIDTH. */
22686 if (field_width
> 0 && n
< field_width
)
22688 switch (mode_line_target
)
22690 case MODE_LINE_NOPROP
:
22691 case MODE_LINE_TITLE
:
22692 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22694 case MODE_LINE_STRING
:
22695 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22698 case MODE_LINE_DISPLAY
:
22699 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22708 /* Store a mode-line string element in mode_line_string_list.
22710 If STRING is non-null, display that C string. Otherwise, the Lisp
22711 string LISP_STRING is displayed.
22713 FIELD_WIDTH is the minimum number of output glyphs to produce.
22714 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22715 with spaces. FIELD_WIDTH <= 0 means don't pad.
22717 PRECISION is the maximum number of characters to output from
22718 STRING. PRECISION <= 0 means don't truncate the string.
22720 If COPY_STRING, make a copy of LISP_STRING before adding
22721 properties to the string.
22723 PROPS are the properties to add to the string.
22724 The mode_line_string_face face property is always added to the string.
22728 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22730 int field_width
, int precision
, Lisp_Object props
)
22735 if (string
!= NULL
)
22737 len
= strlen (string
);
22738 if (precision
> 0 && len
> precision
)
22740 lisp_string
= make_string (string
, len
);
22742 props
= mode_line_string_face_prop
;
22743 else if (!NILP (mode_line_string_face
))
22745 Lisp_Object face
= Fplist_get (props
, Qface
);
22746 props
= Fcopy_sequence (props
);
22748 face
= mode_line_string_face
;
22750 face
= list2 (face
, mode_line_string_face
);
22751 props
= Fplist_put (props
, Qface
, face
);
22753 Fadd_text_properties (make_number (0), make_number (len
),
22754 props
, lisp_string
);
22758 len
= XFASTINT (Flength (lisp_string
));
22759 if (precision
> 0 && len
> precision
)
22762 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22765 if (!NILP (mode_line_string_face
))
22769 props
= Ftext_properties_at (make_number (0), lisp_string
);
22770 face
= Fplist_get (props
, Qface
);
22772 face
= mode_line_string_face
;
22774 face
= list2 (face
, mode_line_string_face
);
22775 props
= list2 (Qface
, face
);
22777 lisp_string
= Fcopy_sequence (lisp_string
);
22780 Fadd_text_properties (make_number (0), make_number (len
),
22781 props
, lisp_string
);
22786 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22790 if (field_width
> len
)
22792 field_width
-= len
;
22793 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22795 Fadd_text_properties (make_number (0), make_number (field_width
),
22796 props
, lisp_string
);
22797 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22805 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22807 doc
: /* Format a string out of a mode line format specification.
22808 First arg FORMAT specifies the mode line format (see `mode-line-format'
22809 for details) to use.
22811 By default, the format is evaluated for the currently selected window.
22813 Optional second arg FACE specifies the face property to put on all
22814 characters for which no face is specified. The value nil means the
22815 default face. The value t means whatever face the window's mode line
22816 currently uses (either `mode-line' or `mode-line-inactive',
22817 depending on whether the window is the selected window or not).
22818 An integer value means the value string has no text
22821 Optional third and fourth args WINDOW and BUFFER specify the window
22822 and buffer to use as the context for the formatting (defaults
22823 are the selected window and the WINDOW's buffer). */)
22824 (Lisp_Object format
, Lisp_Object face
,
22825 Lisp_Object window
, Lisp_Object buffer
)
22830 struct buffer
*old_buffer
= NULL
;
22832 bool no_props
= INTEGERP (face
);
22833 ptrdiff_t count
= SPECPDL_INDEX ();
22835 int string_start
= 0;
22837 w
= decode_any_window (window
);
22838 XSETWINDOW (window
, w
);
22841 buffer
= w
->contents
;
22842 CHECK_BUFFER (buffer
);
22844 /* Make formatting the modeline a non-op when noninteractive, otherwise
22845 there will be problems later caused by a partially initialized frame. */
22846 if (NILP (format
) || noninteractive
)
22847 return empty_unibyte_string
;
22852 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22853 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22854 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22855 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22856 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22857 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22858 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22861 old_buffer
= current_buffer
;
22863 /* Save things including mode_line_proptrans_alist,
22864 and set that to nil so that we don't alter the outer value. */
22865 record_unwind_protect (unwind_format_mode_line
,
22866 format_mode_line_unwind_data
22867 (XFRAME (WINDOW_FRAME (w
)),
22868 old_buffer
, selected_window
, true));
22869 mode_line_proptrans_alist
= Qnil
;
22871 Fselect_window (window
, Qt
);
22872 set_buffer_internal_1 (XBUFFER (buffer
));
22874 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22878 mode_line_target
= MODE_LINE_NOPROP
;
22879 mode_line_string_face_prop
= Qnil
;
22880 mode_line_string_list
= Qnil
;
22881 string_start
= MODE_LINE_NOPROP_LEN (0);
22885 mode_line_target
= MODE_LINE_STRING
;
22886 mode_line_string_list
= Qnil
;
22887 mode_line_string_face
= face
;
22888 mode_line_string_face_prop
22889 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22892 push_kboard (FRAME_KBOARD (it
.f
));
22893 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22898 len
= MODE_LINE_NOPROP_LEN (string_start
);
22899 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22903 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22904 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22905 empty_unibyte_string
);
22908 unbind_to (count
, Qnil
);
22912 /* Write a null-terminated, right justified decimal representation of
22913 the positive integer D to BUF using a minimal field width WIDTH. */
22916 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22918 register char *p
= buf
;
22926 *p
++ = d
% 10 + '0';
22931 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22942 /* Write a null-terminated, right justified decimal and "human
22943 readable" representation of the nonnegative integer D to BUF using
22944 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22946 static const char power_letter
[] =
22960 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22962 /* We aim to represent the nonnegative integer D as
22963 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22964 ptrdiff_t quotient
= d
;
22966 /* -1 means: do not use TENTHS. */
22970 /* Length of QUOTIENT.TENTHS as a string. */
22976 if (quotient
>= 1000)
22978 /* Scale to the appropriate EXPONENT. */
22981 remainder
= quotient
% 1000;
22985 while (quotient
>= 1000);
22987 /* Round to nearest and decide whether to use TENTHS or not. */
22990 tenths
= remainder
/ 100;
22991 if (remainder
% 100 >= 50)
22998 if (quotient
== 10)
23006 if (remainder
>= 500)
23008 if (quotient
< 999)
23019 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23020 if (tenths
== -1 && quotient
<= 99)
23027 p
= psuffix
= buf
+ max (width
, length
);
23029 /* Print EXPONENT. */
23030 *psuffix
++ = power_letter
[exponent
];
23033 /* Print TENTHS. */
23036 *--p
= '0' + tenths
;
23040 /* Print QUOTIENT. */
23043 int digit
= quotient
% 10;
23044 *--p
= '0' + digit
;
23046 while ((quotient
/= 10) != 0);
23048 /* Print leading spaces. */
23053 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23054 If EOL_FLAG, set also a mnemonic character for end-of-line
23055 type of CODING_SYSTEM. Return updated pointer into BUF. */
23057 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23060 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23063 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23064 const unsigned char *eol_str
;
23066 /* The EOL conversion we are using. */
23067 Lisp_Object eoltype
;
23069 val
= CODING_SYSTEM_SPEC (coding_system
);
23072 if (!VECTORP (val
)) /* Not yet decided. */
23074 *buf
++ = multibyte
? '-' : ' ';
23076 eoltype
= eol_mnemonic_undecided
;
23077 /* Don't mention EOL conversion if it isn't decided. */
23082 Lisp_Object eolvalue
;
23084 attrs
= AREF (val
, 0);
23085 eolvalue
= AREF (val
, 2);
23088 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23093 /* The EOL conversion that is normal on this system. */
23095 if (NILP (eolvalue
)) /* Not yet decided. */
23096 eoltype
= eol_mnemonic_undecided
;
23097 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23098 eoltype
= eol_mnemonic_undecided
;
23099 else /* eolvalue is Qunix, Qdos, or Qmac. */
23100 eoltype
= (EQ (eolvalue
, Qunix
)
23101 ? eol_mnemonic_unix
23102 : EQ (eolvalue
, Qdos
)
23103 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23109 /* Mention the EOL conversion if it is not the usual one. */
23110 if (STRINGP (eoltype
))
23112 eol_str
= SDATA (eoltype
);
23113 eol_str_len
= SBYTES (eoltype
);
23115 else if (CHARACTERP (eoltype
))
23117 int c
= XFASTINT (eoltype
);
23118 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23122 eol_str
= invalid_eol_type
;
23123 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23125 memcpy (buf
, eol_str
, eol_str_len
);
23126 buf
+= eol_str_len
;
23132 /* Return a string for the output of a mode line %-spec for window W,
23133 generated by character C. FIELD_WIDTH > 0 means pad the string
23134 returned with spaces to that value. Return a Lisp string in
23135 *STRING if the resulting string is taken from that Lisp string.
23137 Note we operate on the current buffer for most purposes. */
23139 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23141 static const char *
23142 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23143 Lisp_Object
*string
)
23146 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23147 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23148 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23149 produce strings from numerical values, so limit preposterously
23150 large values of FIELD_WIDTH to avoid overrunning the buffer's
23151 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23152 bytes plus the terminating null. */
23153 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23154 struct buffer
*b
= current_buffer
;
23162 if (!NILP (BVAR (b
, read_only
)))
23164 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23169 /* This differs from %* only for a modified read-only buffer. */
23170 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23172 if (!NILP (BVAR (b
, read_only
)))
23177 /* This differs from %* in ignoring read-only-ness. */
23178 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23190 if (command_loop_level
> 5)
23192 p
= decode_mode_spec_buf
;
23193 for (i
= 0; i
< command_loop_level
; i
++)
23196 return decode_mode_spec_buf
;
23204 if (command_loop_level
> 5)
23206 p
= decode_mode_spec_buf
;
23207 for (i
= 0; i
< command_loop_level
; i
++)
23210 return decode_mode_spec_buf
;
23217 /* Let lots_of_dashes be a string of infinite length. */
23218 if (mode_line_target
== MODE_LINE_NOPROP
23219 || mode_line_target
== MODE_LINE_STRING
)
23221 if (field_width
<= 0
23222 || field_width
> sizeof (lots_of_dashes
))
23224 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23225 decode_mode_spec_buf
[i
] = '-';
23226 decode_mode_spec_buf
[i
] = '\0';
23227 return decode_mode_spec_buf
;
23230 return lots_of_dashes
;
23234 obj
= BVAR (b
, name
);
23238 /* %c and %l are ignored in `frame-title-format'.
23239 (In redisplay_internal, the frame title is drawn _before_ the
23240 windows are updated, so the stuff which depends on actual
23241 window contents (such as %l) may fail to render properly, or
23242 even crash emacs.) */
23243 if (mode_line_target
== MODE_LINE_TITLE
)
23247 ptrdiff_t col
= current_column ();
23248 w
->column_number_displayed
= col
;
23249 pint2str (decode_mode_spec_buf
, width
, col
);
23250 return decode_mode_spec_buf
;
23254 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23256 if (NILP (Vmemory_full
))
23259 return "!MEM FULL! ";
23266 /* %F displays the frame name. */
23267 if (!NILP (f
->title
))
23268 return SSDATA (f
->title
);
23269 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23270 return SSDATA (f
->name
);
23274 obj
= BVAR (b
, filename
);
23279 ptrdiff_t size
= ZV
- BEGV
;
23280 pint2str (decode_mode_spec_buf
, width
, size
);
23281 return decode_mode_spec_buf
;
23286 ptrdiff_t size
= ZV
- BEGV
;
23287 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23288 return decode_mode_spec_buf
;
23293 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23294 ptrdiff_t topline
, nlines
, height
;
23297 /* %c and %l are ignored in `frame-title-format'. */
23298 if (mode_line_target
== MODE_LINE_TITLE
)
23301 startpos
= marker_position (w
->start
);
23302 startpos_byte
= marker_byte_position (w
->start
);
23303 height
= WINDOW_TOTAL_LINES (w
);
23305 /* If we decided that this buffer isn't suitable for line numbers,
23306 don't forget that too fast. */
23307 if (w
->base_line_pos
== -1)
23310 /* If the buffer is very big, don't waste time. */
23311 if (INTEGERP (Vline_number_display_limit
)
23312 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23314 w
->base_line_pos
= 0;
23315 w
->base_line_number
= 0;
23319 if (w
->base_line_number
> 0
23320 && w
->base_line_pos
> 0
23321 && w
->base_line_pos
<= startpos
)
23323 line
= w
->base_line_number
;
23324 linepos
= w
->base_line_pos
;
23325 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23330 linepos
= BUF_BEGV (b
);
23331 linepos_byte
= BUF_BEGV_BYTE (b
);
23334 /* Count lines from base line to window start position. */
23335 nlines
= display_count_lines (linepos_byte
,
23339 topline
= nlines
+ line
;
23341 /* Determine a new base line, if the old one is too close
23342 or too far away, or if we did not have one.
23343 "Too close" means it's plausible a scroll-down would
23344 go back past it. */
23345 if (startpos
== BUF_BEGV (b
))
23347 w
->base_line_number
= topline
;
23348 w
->base_line_pos
= BUF_BEGV (b
);
23350 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23351 || linepos
== BUF_BEGV (b
))
23353 ptrdiff_t limit
= BUF_BEGV (b
);
23354 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23355 ptrdiff_t position
;
23356 ptrdiff_t distance
=
23357 (height
* 2 + 30) * line_number_display_limit_width
;
23359 if (startpos
- distance
> limit
)
23361 limit
= startpos
- distance
;
23362 limit_byte
= CHAR_TO_BYTE (limit
);
23365 nlines
= display_count_lines (startpos_byte
,
23367 - (height
* 2 + 30),
23369 /* If we couldn't find the lines we wanted within
23370 line_number_display_limit_width chars per line,
23371 give up on line numbers for this window. */
23372 if (position
== limit_byte
&& limit
== startpos
- distance
)
23374 w
->base_line_pos
= -1;
23375 w
->base_line_number
= 0;
23379 w
->base_line_number
= topline
- nlines
;
23380 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23383 /* Now count lines from the start pos to point. */
23384 nlines
= display_count_lines (startpos_byte
,
23385 PT_BYTE
, PT
, &junk
);
23387 /* Record that we did display the line number. */
23388 line_number_displayed
= true;
23390 /* Make the string to show. */
23391 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23392 return decode_mode_spec_buf
;
23395 char *p
= decode_mode_spec_buf
;
23396 int pad
= width
- 2;
23402 return decode_mode_spec_buf
;
23408 obj
= BVAR (b
, mode_name
);
23412 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23418 ptrdiff_t pos
= marker_position (w
->start
);
23419 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23421 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23423 if (pos
<= BUF_BEGV (b
))
23428 else if (pos
<= BUF_BEGV (b
))
23432 if (total
> 1000000)
23433 /* Do it differently for a large value, to avoid overflow. */
23434 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23436 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23437 /* We can't normally display a 3-digit number,
23438 so get us a 2-digit number that is close. */
23441 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23442 return decode_mode_spec_buf
;
23446 /* Display percentage of size above the bottom of the screen. */
23449 ptrdiff_t toppos
= marker_position (w
->start
);
23450 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23451 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23453 if (botpos
>= BUF_ZV (b
))
23455 if (toppos
<= BUF_BEGV (b
))
23462 if (total
> 1000000)
23463 /* Do it differently for a large value, to avoid overflow. */
23464 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23466 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23467 /* We can't normally display a 3-digit number,
23468 so get us a 2-digit number that is close. */
23471 if (toppos
<= BUF_BEGV (b
))
23472 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23474 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23475 return decode_mode_spec_buf
;
23480 /* status of process */
23481 obj
= Fget_buffer_process (Fcurrent_buffer ());
23483 return "no process";
23485 obj
= Fsymbol_name (Fprocess_status (obj
));
23491 ptrdiff_t count
= inhibit_garbage_collection ();
23492 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23493 Lisp_Object val
= Qnil
;
23495 if (STRINGP (curdir
))
23496 val
= call1 (intern ("file-remote-p"), curdir
);
23498 unbind_to (count
, Qnil
);
23507 /* coding-system (not including end-of-line format) */
23509 /* coding-system (including end-of-line type) */
23511 bool eol_flag
= (c
== 'Z');
23512 char *p
= decode_mode_spec_buf
;
23514 if (! FRAME_WINDOW_P (f
))
23516 /* No need to mention EOL here--the terminal never needs
23517 to do EOL conversion. */
23518 p
= decode_mode_spec_coding (CODING_ID_NAME
23519 (FRAME_KEYBOARD_CODING (f
)->id
),
23521 p
= decode_mode_spec_coding (CODING_ID_NAME
23522 (FRAME_TERMINAL_CODING (f
)->id
),
23525 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23528 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23529 #ifdef subprocesses
23530 obj
= Fget_buffer_process (Fcurrent_buffer ());
23531 if (PROCESSP (obj
))
23533 p
= decode_mode_spec_coding
23534 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23535 p
= decode_mode_spec_coding
23536 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23538 #endif /* subprocesses */
23541 return decode_mode_spec_buf
;
23548 return SSDATA (obj
);
23555 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23556 means count lines back from START_BYTE. But don't go beyond
23557 LIMIT_BYTE. Return the number of lines thus found (always
23560 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23561 either the position COUNT lines after/before START_BYTE, if we
23562 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23566 display_count_lines (ptrdiff_t start_byte
,
23567 ptrdiff_t limit_byte
, ptrdiff_t count
,
23568 ptrdiff_t *byte_pos_ptr
)
23570 register unsigned char *cursor
;
23571 unsigned char *base
;
23573 register ptrdiff_t ceiling
;
23574 register unsigned char *ceiling_addr
;
23575 ptrdiff_t orig_count
= count
;
23577 /* If we are not in selective display mode,
23578 check only for newlines. */
23579 bool selective_display
23580 = (!NILP (BVAR (current_buffer
, selective_display
))
23581 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23585 while (start_byte
< limit_byte
)
23587 ceiling
= BUFFER_CEILING_OF (start_byte
);
23588 ceiling
= min (limit_byte
- 1, ceiling
);
23589 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23590 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23594 if (selective_display
)
23596 while (*cursor
!= '\n' && *cursor
!= 015
23597 && ++cursor
!= ceiling_addr
)
23599 if (cursor
== ceiling_addr
)
23604 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23613 start_byte
+= cursor
- base
;
23614 *byte_pos_ptr
= start_byte
;
23618 while (cursor
< ceiling_addr
);
23620 start_byte
+= ceiling_addr
- base
;
23625 while (start_byte
> limit_byte
)
23627 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23628 ceiling
= max (limit_byte
, ceiling
);
23629 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23630 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23633 if (selective_display
)
23635 while (--cursor
>= ceiling_addr
23636 && *cursor
!= '\n' && *cursor
!= 015)
23638 if (cursor
< ceiling_addr
)
23643 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23650 start_byte
+= cursor
- base
+ 1;
23651 *byte_pos_ptr
= start_byte
;
23652 /* When scanning backwards, we should
23653 not count the newline posterior to which we stop. */
23654 return - orig_count
- 1;
23657 start_byte
+= ceiling_addr
- base
;
23661 *byte_pos_ptr
= limit_byte
;
23664 return - orig_count
+ count
;
23665 return orig_count
- count
;
23671 /***********************************************************************
23673 ***********************************************************************/
23675 /* Display a NUL-terminated string, starting with index START.
23677 If STRING is non-null, display that C string. Otherwise, the Lisp
23678 string LISP_STRING is displayed. There's a case that STRING is
23679 non-null and LISP_STRING is not nil. It means STRING is a string
23680 data of LISP_STRING. In that case, we display LISP_STRING while
23681 ignoring its text properties.
23683 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23684 FACE_STRING. Display STRING or LISP_STRING with the face at
23685 FACE_STRING_POS in FACE_STRING:
23687 Display the string in the environment given by IT, but use the
23688 standard display table, temporarily.
23690 FIELD_WIDTH is the minimum number of output glyphs to produce.
23691 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23692 with spaces. If STRING has more characters, more than FIELD_WIDTH
23693 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23695 PRECISION is the maximum number of characters to output from
23696 STRING. PRECISION < 0 means don't truncate the string.
23698 This is roughly equivalent to printf format specifiers:
23700 FIELD_WIDTH PRECISION PRINTF
23701 ----------------------------------------
23707 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23708 display them, and < 0 means obey the current buffer's value of
23709 enable_multibyte_characters.
23711 Value is the number of columns displayed. */
23714 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23715 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23716 int field_width
, int precision
, int max_x
, int multibyte
)
23718 int hpos_at_start
= it
->hpos
;
23719 int saved_face_id
= it
->face_id
;
23720 struct glyph_row
*row
= it
->glyph_row
;
23721 ptrdiff_t it_charpos
;
23723 /* Initialize the iterator IT for iteration over STRING beginning
23724 with index START. */
23725 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23726 precision
, field_width
, multibyte
);
23727 if (string
&& STRINGP (lisp_string
))
23728 /* LISP_STRING is the one returned by decode_mode_spec. We should
23729 ignore its text properties. */
23730 it
->stop_charpos
= it
->end_charpos
;
23732 /* If displaying STRING, set up the face of the iterator from
23733 FACE_STRING, if that's given. */
23734 if (STRINGP (face_string
))
23740 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23741 0, &endptr
, it
->base_face_id
, false);
23742 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23743 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23746 /* Set max_x to the maximum allowed X position. Don't let it go
23747 beyond the right edge of the window. */
23749 max_x
= it
->last_visible_x
;
23751 max_x
= min (max_x
, it
->last_visible_x
);
23753 /* Skip over display elements that are not visible. because IT->w is
23755 if (it
->current_x
< it
->first_visible_x
)
23756 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23757 MOVE_TO_POS
| MOVE_TO_X
);
23759 row
->ascent
= it
->max_ascent
;
23760 row
->height
= it
->max_ascent
+ it
->max_descent
;
23761 row
->phys_ascent
= it
->max_phys_ascent
;
23762 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23763 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23765 if (STRINGP (it
->string
))
23766 it_charpos
= IT_STRING_CHARPOS (*it
);
23768 it_charpos
= IT_CHARPOS (*it
);
23770 /* This condition is for the case that we are called with current_x
23771 past last_visible_x. */
23772 while (it
->current_x
< max_x
)
23774 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23776 /* Get the next display element. */
23777 if (!get_next_display_element (it
))
23780 /* Produce glyphs. */
23781 x_before
= it
->current_x
;
23782 n_glyphs_before
= row
->used
[TEXT_AREA
];
23783 PRODUCE_GLYPHS (it
);
23785 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23788 while (i
< nglyphs
)
23790 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23792 if (it
->line_wrap
!= TRUNCATE
23793 && x
+ glyph
->pixel_width
> max_x
)
23795 /* End of continued line or max_x reached. */
23796 if (CHAR_GLYPH_PADDING_P (*glyph
))
23798 /* A wide character is unbreakable. */
23799 if (row
->reversed_p
)
23800 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23801 - n_glyphs_before
);
23802 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23803 it
->current_x
= x_before
;
23807 if (row
->reversed_p
)
23808 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23809 - (n_glyphs_before
+ i
));
23810 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23815 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23817 /* Glyph is at least partially visible. */
23819 if (x
< it
->first_visible_x
)
23820 row
->x
= x
- it
->first_visible_x
;
23824 /* Glyph is off the left margin of the display area.
23825 Should not happen. */
23829 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23830 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23831 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23832 row
->phys_height
= max (row
->phys_height
,
23833 it
->max_phys_ascent
+ it
->max_phys_descent
);
23834 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23835 it
->max_extra_line_spacing
);
23836 x
+= glyph
->pixel_width
;
23840 /* Stop if max_x reached. */
23844 /* Stop at line ends. */
23845 if (ITERATOR_AT_END_OF_LINE_P (it
))
23847 it
->continuation_lines_width
= 0;
23851 set_iterator_to_next (it
, true);
23852 if (STRINGP (it
->string
))
23853 it_charpos
= IT_STRING_CHARPOS (*it
);
23855 it_charpos
= IT_CHARPOS (*it
);
23857 /* Stop if truncating at the right edge. */
23858 if (it
->line_wrap
== TRUNCATE
23859 && it
->current_x
>= it
->last_visible_x
)
23861 /* Add truncation mark, but don't do it if the line is
23862 truncated at a padding space. */
23863 if (it_charpos
< it
->string_nchars
)
23865 if (!FRAME_WINDOW_P (it
->f
))
23869 if (it
->current_x
> it
->last_visible_x
)
23871 if (!row
->reversed_p
)
23873 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23874 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23879 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23880 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23882 unproduce_glyphs (it
, ii
+ 1);
23883 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23885 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23887 row
->used
[TEXT_AREA
] = ii
;
23888 produce_special_glyphs (it
, IT_TRUNCATION
);
23891 produce_special_glyphs (it
, IT_TRUNCATION
);
23893 row
->truncated_on_right_p
= true;
23899 /* Maybe insert a truncation at the left. */
23900 if (it
->first_visible_x
23903 if (!FRAME_WINDOW_P (it
->f
)
23904 || (row
->reversed_p
23905 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23906 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23907 insert_left_trunc_glyphs (it
);
23908 row
->truncated_on_left_p
= true;
23911 it
->face_id
= saved_face_id
;
23913 /* Value is number of columns displayed. */
23914 return it
->hpos
- hpos_at_start
;
23919 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23920 appears as an element of LIST or as the car of an element of LIST.
23921 If PROPVAL is a list, compare each element against LIST in that
23922 way, and return 1/2 if any element of PROPVAL is found in LIST.
23923 Otherwise return 0. This function cannot quit.
23924 The return value is 2 if the text is invisible but with an ellipsis
23925 and 1 if it's invisible and without an ellipsis. */
23928 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23930 Lisp_Object tail
, proptail
;
23932 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23934 register Lisp_Object tem
;
23936 if (EQ (propval
, tem
))
23938 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23939 return NILP (XCDR (tem
)) ? 1 : 2;
23942 if (CONSP (propval
))
23944 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23946 Lisp_Object propelt
;
23947 propelt
= XCAR (proptail
);
23948 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23950 register Lisp_Object tem
;
23952 if (EQ (propelt
, tem
))
23954 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23955 return NILP (XCDR (tem
)) ? 1 : 2;
23963 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23964 doc
: /* Non-nil if the property makes the text invisible.
23965 POS-OR-PROP can be a marker or number, in which case it is taken to be
23966 a position in the current buffer and the value of the `invisible' property
23967 is checked; or it can be some other value, which is then presumed to be the
23968 value of the `invisible' property of the text of interest.
23969 The non-nil value returned can be t for truly invisible text or something
23970 else if the text is replaced by an ellipsis. */)
23971 (Lisp_Object pos_or_prop
)
23974 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23975 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23977 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23978 return (invis
== 0 ? Qnil
23980 : make_number (invis
));
23983 /* Calculate a width or height in pixels from a specification using
23984 the following elements:
23987 NUM - a (fractional) multiple of the default font width/height
23988 (NUM) - specifies exactly NUM pixels
23989 UNIT - a fixed number of pixels, see below.
23990 ELEMENT - size of a display element in pixels, see below.
23991 (NUM . SPEC) - equals NUM * SPEC
23992 (+ SPEC SPEC ...) - add pixel values
23993 (- SPEC SPEC ...) - subtract pixel values
23994 (- SPEC) - negate pixel value
23997 INT or FLOAT - a number constant
23998 SYMBOL - use symbol's (buffer local) variable binding.
24001 in - pixels per inch *)
24002 mm - pixels per 1/1000 meter *)
24003 cm - pixels per 1/100 meter *)
24004 width - width of current font in pixels.
24005 height - height of current font in pixels.
24007 *) using the ratio(s) defined in display-pixels-per-inch.
24011 left-fringe - left fringe width in pixels
24012 right-fringe - right fringe width in pixels
24014 left-margin - left margin width in pixels
24015 right-margin - right margin width in pixels
24017 scroll-bar - scroll-bar area width in pixels
24021 Pixels corresponding to 5 inches:
24024 Total width of non-text areas on left side of window (if scroll-bar is on left):
24025 '(space :width (+ left-fringe left-margin scroll-bar))
24027 Align to first text column (in header line):
24028 '(space :align-to 0)
24030 Align to middle of text area minus half the width of variable `my-image'
24031 containing a loaded image:
24032 '(space :align-to (0.5 . (- text my-image)))
24034 Width of left margin minus width of 1 character in the default font:
24035 '(space :width (- left-margin 1))
24037 Width of left margin minus width of 2 characters in the current font:
24038 '(space :width (- left-margin (2 . width)))
24040 Center 1 character over left-margin (in header line):
24041 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24043 Different ways to express width of left fringe plus left margin minus one pixel:
24044 '(space :width (- (+ left-fringe left-margin) (1)))
24045 '(space :width (+ left-fringe left-margin (- (1))))
24046 '(space :width (+ left-fringe left-margin (-1)))
24051 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24052 struct font
*font
, bool width_p
, int *align_to
)
24056 # define OK_PIXELS(val) (*res = (val), true)
24057 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24060 return OK_PIXELS (0);
24062 eassert (FRAME_LIVE_P (it
->f
));
24064 if (SYMBOLP (prop
))
24066 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24068 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24070 if (unit
[0] == 'i' && unit
[1] == 'n')
24072 else if (unit
[0] == 'm' && unit
[1] == 'm')
24074 else if (unit
[0] == 'c' && unit
[1] == 'm')
24080 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24081 : FRAME_RES_Y (it
->f
));
24084 return OK_PIXELS (ppi
/ pixels
);
24089 #ifdef HAVE_WINDOW_SYSTEM
24090 if (EQ (prop
, Qheight
))
24091 return OK_PIXELS (font
24092 ? normal_char_height (font
, -1)
24093 : FRAME_LINE_HEIGHT (it
->f
));
24094 if (EQ (prop
, Qwidth
))
24095 return OK_PIXELS (font
24096 ? FONT_WIDTH (font
)
24097 : FRAME_COLUMN_WIDTH (it
->f
));
24099 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24100 return OK_PIXELS (1);
24103 if (EQ (prop
, Qtext
))
24104 return OK_PIXELS (width_p
24105 ? window_box_width (it
->w
, TEXT_AREA
)
24106 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24108 if (align_to
&& *align_to
< 0)
24111 if (EQ (prop
, Qleft
))
24112 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24113 if (EQ (prop
, Qright
))
24114 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24115 if (EQ (prop
, Qcenter
))
24116 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24117 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24118 if (EQ (prop
, Qleft_fringe
))
24119 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24120 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24121 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24122 if (EQ (prop
, Qright_fringe
))
24123 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24124 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24125 : window_box_right_offset (it
->w
, TEXT_AREA
));
24126 if (EQ (prop
, Qleft_margin
))
24127 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24128 if (EQ (prop
, Qright_margin
))
24129 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24130 if (EQ (prop
, Qscroll_bar
))
24131 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24133 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24134 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24135 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24140 if (EQ (prop
, Qleft_fringe
))
24141 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24142 if (EQ (prop
, Qright_fringe
))
24143 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24144 if (EQ (prop
, Qleft_margin
))
24145 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24146 if (EQ (prop
, Qright_margin
))
24147 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24148 if (EQ (prop
, Qscroll_bar
))
24149 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24152 prop
= buffer_local_value (prop
, it
->w
->contents
);
24153 if (EQ (prop
, Qunbound
))
24157 if (NUMBERP (prop
))
24159 int base_unit
= (width_p
24160 ? FRAME_COLUMN_WIDTH (it
->f
)
24161 : FRAME_LINE_HEIGHT (it
->f
));
24162 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24167 Lisp_Object car
= XCAR (prop
);
24168 Lisp_Object cdr
= XCDR (prop
);
24172 #ifdef HAVE_WINDOW_SYSTEM
24173 if (FRAME_WINDOW_P (it
->f
)
24174 && valid_image_p (prop
))
24176 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24177 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24179 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24182 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24188 while (CONSP (cdr
))
24190 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24191 font
, width_p
, align_to
))
24194 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24199 if (EQ (car
, Qminus
))
24201 return OK_PIXELS (pixels
);
24204 car
= buffer_local_value (car
, it
->w
->contents
);
24205 if (EQ (car
, Qunbound
))
24212 pixels
= XFLOATINT (car
);
24214 return OK_PIXELS (pixels
);
24215 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24216 font
, width_p
, align_to
))
24217 return OK_PIXELS (pixels
* fact
);
24228 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24230 #ifdef HAVE_WINDOW_SYSTEM
24231 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24239 /***********************************************************************
24241 ***********************************************************************/
24243 #ifdef HAVE_WINDOW_SYSTEM
24248 dump_glyph_string (struct glyph_string
*s
)
24250 fprintf (stderr
, "glyph string\n");
24251 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24252 s
->x
, s
->y
, s
->width
, s
->height
);
24253 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24254 fprintf (stderr
, " hl = %d\n", s
->hl
);
24255 fprintf (stderr
, " left overhang = %d, right = %d\n",
24256 s
->left_overhang
, s
->right_overhang
);
24257 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24258 fprintf (stderr
, " extends to end of line = %d\n",
24259 s
->extends_to_end_of_line_p
);
24260 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24261 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24264 #endif /* GLYPH_DEBUG */
24266 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24267 of XChar2b structures for S; it can't be allocated in
24268 init_glyph_string because it must be allocated via `alloca'. W
24269 is the window on which S is drawn. ROW and AREA are the glyph row
24270 and area within the row from which S is constructed. START is the
24271 index of the first glyph structure covered by S. HL is a
24272 face-override for drawing S. */
24275 #define OPTIONAL_HDC(hdc) HDC hdc,
24276 #define DECLARE_HDC(hdc) HDC hdc;
24277 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24278 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24281 #ifndef OPTIONAL_HDC
24282 #define OPTIONAL_HDC(hdc)
24283 #define DECLARE_HDC(hdc)
24284 #define ALLOCATE_HDC(hdc, f)
24285 #define RELEASE_HDC(hdc, f)
24289 init_glyph_string (struct glyph_string
*s
,
24291 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24292 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24294 memset (s
, 0, sizeof *s
);
24296 s
->f
= XFRAME (w
->frame
);
24300 s
->display
= FRAME_X_DISPLAY (s
->f
);
24301 s
->window
= FRAME_X_WINDOW (s
->f
);
24302 s
->char2b
= char2b
;
24306 s
->first_glyph
= row
->glyphs
[area
] + start
;
24307 s
->height
= row
->height
;
24308 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24309 s
->ybase
= s
->y
+ row
->ascent
;
24313 /* Append the list of glyph strings with head H and tail T to the list
24314 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24317 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24318 struct glyph_string
*h
, struct glyph_string
*t
)
24332 /* Prepend the list of glyph strings with head H and tail T to the
24333 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24337 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24338 struct glyph_string
*h
, struct glyph_string
*t
)
24352 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24353 Set *HEAD and *TAIL to the resulting list. */
24356 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24357 struct glyph_string
*s
)
24359 s
->next
= s
->prev
= NULL
;
24360 append_glyph_string_lists (head
, tail
, s
, s
);
24364 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24365 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24366 make sure that X resources for the face returned are allocated.
24367 Value is a pointer to a realized face that is ready for display if
24370 static struct face
*
24371 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24372 XChar2b
*char2b
, bool display_p
)
24374 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24379 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24381 if (code
== FONT_INVALID_CODE
)
24384 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24386 /* Make sure X resources of the face are allocated. */
24387 #ifdef HAVE_X_WINDOWS
24391 eassert (face
!= NULL
);
24392 prepare_face_for_display (f
, face
);
24399 /* Get face and two-byte form of character glyph GLYPH on frame F.
24400 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24401 a pointer to a realized face that is ready for display. */
24403 static struct face
*
24404 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24410 eassert (glyph
->type
== CHAR_GLYPH
);
24411 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24413 /* Make sure X resources of the face are allocated. */
24414 eassert (face
!= NULL
);
24415 prepare_face_for_display (f
, face
);
24419 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24420 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24422 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24424 if (code
== FONT_INVALID_CODE
)
24428 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24433 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24434 Return true iff FONT has a glyph for C. */
24437 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24441 if (CHAR_BYTE8_P (c
))
24442 code
= CHAR_TO_BYTE8 (c
);
24444 code
= font
->driver
->encode_char (font
, c
);
24446 if (code
== FONT_INVALID_CODE
)
24448 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24453 /* Fill glyph string S with composition components specified by S->cmp.
24455 BASE_FACE is the base face of the composition.
24456 S->cmp_from is the index of the first component for S.
24458 OVERLAPS non-zero means S should draw the foreground only, and use
24459 its physical height for clipping. See also draw_glyphs.
24461 Value is the index of a component not in S. */
24464 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24468 /* For all glyphs of this composition, starting at the offset
24469 S->cmp_from, until we reach the end of the definition or encounter a
24470 glyph that requires the different face, add it to S. */
24475 s
->for_overlaps
= overlaps
;
24478 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24480 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24482 /* TAB in a composition means display glyphs with padding space
24483 on the left or right. */
24486 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24489 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24490 s
->char2b
+ i
, true);
24496 s
->font
= s
->face
->font
;
24498 else if (s
->face
!= face
)
24506 if (s
->face
== NULL
)
24508 s
->face
= base_face
->ascii_face
;
24509 s
->font
= s
->face
->font
;
24512 /* All glyph strings for the same composition has the same width,
24513 i.e. the width set for the first component of the composition. */
24514 s
->width
= s
->first_glyph
->pixel_width
;
24516 /* If the specified font could not be loaded, use the frame's
24517 default font, but record the fact that we couldn't load it in
24518 the glyph string so that we can draw rectangles for the
24519 characters of the glyph string. */
24520 if (s
->font
== NULL
)
24522 s
->font_not_found_p
= true;
24523 s
->font
= FRAME_FONT (s
->f
);
24526 /* Adjust base line for subscript/superscript text. */
24527 s
->ybase
+= s
->first_glyph
->voffset
;
24533 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24534 int start
, int end
, int overlaps
)
24536 struct glyph
*glyph
, *last
;
24537 Lisp_Object lgstring
;
24540 s
->for_overlaps
= overlaps
;
24541 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24542 last
= s
->row
->glyphs
[s
->area
] + end
;
24543 s
->cmp_id
= glyph
->u
.cmp
.id
;
24544 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24545 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24546 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24547 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24548 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24550 while (glyph
< last
24551 && glyph
->u
.cmp
.automatic
24552 && glyph
->u
.cmp
.id
== s
->cmp_id
24553 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24554 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24556 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24558 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24559 unsigned code
= LGLYPH_CODE (lglyph
);
24561 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24563 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24564 return glyph
- s
->row
->glyphs
[s
->area
];
24568 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24569 See the comment of fill_glyph_string for arguments.
24570 Value is the index of the first glyph not in S. */
24574 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24575 int start
, int end
, int overlaps
)
24577 struct glyph
*glyph
, *last
;
24580 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24581 s
->for_overlaps
= overlaps
;
24582 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24583 last
= s
->row
->glyphs
[s
->area
] + end
;
24584 voffset
= glyph
->voffset
;
24585 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24586 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24588 s
->width
= glyph
->pixel_width
;
24590 while (glyph
< last
24591 && glyph
->type
== GLYPHLESS_GLYPH
24592 && glyph
->voffset
== voffset
24593 && glyph
->face_id
== face_id
)
24596 s
->width
+= glyph
->pixel_width
;
24599 s
->ybase
+= voffset
;
24600 return glyph
- s
->row
->glyphs
[s
->area
];
24604 /* Fill glyph string S from a sequence of character glyphs.
24606 FACE_ID is the face id of the string. START is the index of the
24607 first glyph to consider, END is the index of the last + 1.
24608 OVERLAPS non-zero means S should draw the foreground only, and use
24609 its physical height for clipping. See also draw_glyphs.
24611 Value is the index of the first glyph not in S. */
24614 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24615 int start
, int end
, int overlaps
)
24617 struct glyph
*glyph
, *last
;
24619 bool glyph_not_available_p
;
24621 eassert (s
->f
== XFRAME (s
->w
->frame
));
24622 eassert (s
->nchars
== 0);
24623 eassert (start
>= 0 && end
> start
);
24625 s
->for_overlaps
= overlaps
;
24626 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24627 last
= s
->row
->glyphs
[s
->area
] + end
;
24628 voffset
= glyph
->voffset
;
24629 s
->padding_p
= glyph
->padding_p
;
24630 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24632 while (glyph
< last
24633 && glyph
->type
== CHAR_GLYPH
24634 && glyph
->voffset
== voffset
24635 /* Same face id implies same font, nowadays. */
24636 && glyph
->face_id
== face_id
24637 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24639 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24640 s
->char2b
+ s
->nchars
);
24642 eassert (s
->nchars
<= end
- start
);
24643 s
->width
+= glyph
->pixel_width
;
24644 if (glyph
++->padding_p
!= s
->padding_p
)
24648 s
->font
= s
->face
->font
;
24650 /* If the specified font could not be loaded, use the frame's font,
24651 but record the fact that we couldn't load it in
24652 S->font_not_found_p so that we can draw rectangles for the
24653 characters of the glyph string. */
24654 if (s
->font
== NULL
|| glyph_not_available_p
)
24656 s
->font_not_found_p
= true;
24657 s
->font
= FRAME_FONT (s
->f
);
24660 /* Adjust base line for subscript/superscript text. */
24661 s
->ybase
+= voffset
;
24663 eassert (s
->face
&& s
->face
->gc
);
24664 return glyph
- s
->row
->glyphs
[s
->area
];
24668 /* Fill glyph string S from image glyph S->first_glyph. */
24671 fill_image_glyph_string (struct glyph_string
*s
)
24673 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24674 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24676 s
->slice
= s
->first_glyph
->slice
.img
;
24677 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24678 s
->font
= s
->face
->font
;
24679 s
->width
= s
->first_glyph
->pixel_width
;
24681 /* Adjust base line for subscript/superscript text. */
24682 s
->ybase
+= s
->first_glyph
->voffset
;
24686 /* Fill glyph string S from a sequence of stretch glyphs.
24688 START is the index of the first glyph to consider,
24689 END is the index of the last + 1.
24691 Value is the index of the first glyph not in S. */
24694 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24696 struct glyph
*glyph
, *last
;
24697 int voffset
, face_id
;
24699 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24701 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24702 last
= s
->row
->glyphs
[s
->area
] + end
;
24703 face_id
= glyph
->face_id
;
24704 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24705 s
->font
= s
->face
->font
;
24706 s
->width
= glyph
->pixel_width
;
24708 voffset
= glyph
->voffset
;
24712 && glyph
->type
== STRETCH_GLYPH
24713 && glyph
->voffset
== voffset
24714 && glyph
->face_id
== face_id
);
24716 s
->width
+= glyph
->pixel_width
;
24718 /* Adjust base line for subscript/superscript text. */
24719 s
->ybase
+= voffset
;
24721 /* The case that face->gc == 0 is handled when drawing the glyph
24722 string by calling prepare_face_for_display. */
24724 return glyph
- s
->row
->glyphs
[s
->area
];
24727 static struct font_metrics
*
24728 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24730 static struct font_metrics metrics
;
24735 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24736 if (code
== FONT_INVALID_CODE
)
24738 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24742 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24743 for FONT. Values are taken from font-global ones, except for fonts
24744 that claim preposterously large values, but whose glyphs actually
24745 have reasonable dimensions. C is the character to use for metrics
24746 if the font-global values are too large; if C is negative, the
24747 function selects a default character. */
24749 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24751 *ascent
= FONT_BASE (font
);
24752 *descent
= FONT_DESCENT (font
);
24754 if (FONT_TOO_HIGH (font
))
24758 /* Get metrics of C, defaulting to a reasonably sized ASCII
24760 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24762 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24764 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24766 /* We add 1 pixel to character dimensions as heuristics
24767 that produces nicer display, e.g. when the face has
24768 the box attribute. */
24769 *ascent
= pcm
->ascent
+ 1;
24770 *descent
= pcm
->descent
+ 1;
24776 /* A subroutine that computes a reasonable "normal character height"
24777 for fonts that claim preposterously large vertical dimensions, but
24778 whose glyphs are actually reasonably sized. C is the character
24779 whose metrics to use for those fonts, or -1 for default
24782 normal_char_height (struct font
*font
, int c
)
24784 int ascent
, descent
;
24786 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24788 return ascent
+ descent
;
24792 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24793 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24794 assumed to be zero. */
24797 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24799 *left
= *right
= 0;
24801 if (glyph
->type
== CHAR_GLYPH
)
24804 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24807 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24810 if (pcm
->rbearing
> pcm
->width
)
24811 *right
= pcm
->rbearing
- pcm
->width
;
24812 if (pcm
->lbearing
< 0)
24813 *left
= -pcm
->lbearing
;
24817 else if (glyph
->type
== COMPOSITE_GLYPH
)
24819 if (! glyph
->u
.cmp
.automatic
)
24821 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24823 if (cmp
->rbearing
> cmp
->pixel_width
)
24824 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24825 if (cmp
->lbearing
< 0)
24826 *left
= - cmp
->lbearing
;
24830 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24831 struct font_metrics metrics
;
24833 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24834 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24835 if (metrics
.rbearing
> metrics
.width
)
24836 *right
= metrics
.rbearing
- metrics
.width
;
24837 if (metrics
.lbearing
< 0)
24838 *left
= - metrics
.lbearing
;
24844 /* Return the index of the first glyph preceding glyph string S that
24845 is overwritten by S because of S's left overhang. Value is -1
24846 if no glyphs are overwritten. */
24849 left_overwritten (struct glyph_string
*s
)
24853 if (s
->left_overhang
)
24856 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24857 int first
= s
->first_glyph
- glyphs
;
24859 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24860 x
-= glyphs
[i
].pixel_width
;
24871 /* Return the index of the first glyph preceding glyph string S that
24872 is overwriting S because of its right overhang. Value is -1 if no
24873 glyph in front of S overwrites S. */
24876 left_overwriting (struct glyph_string
*s
)
24879 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24880 int first
= s
->first_glyph
- glyphs
;
24884 for (i
= first
- 1; i
>= 0; --i
)
24887 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24890 x
-= glyphs
[i
].pixel_width
;
24897 /* Return the index of the last glyph following glyph string S that is
24898 overwritten by S because of S's right overhang. Value is -1 if
24899 no such glyph is found. */
24902 right_overwritten (struct glyph_string
*s
)
24906 if (s
->right_overhang
)
24909 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24910 int first
= (s
->first_glyph
- glyphs
24911 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24912 int end
= s
->row
->used
[s
->area
];
24914 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24915 x
+= glyphs
[i
].pixel_width
;
24924 /* Return the index of the last glyph following glyph string S that
24925 overwrites S because of its left overhang. Value is negative
24926 if no such glyph is found. */
24929 right_overwriting (struct glyph_string
*s
)
24932 int end
= s
->row
->used
[s
->area
];
24933 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24934 int first
= (s
->first_glyph
- glyphs
24935 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24939 for (i
= first
; i
< end
; ++i
)
24942 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24945 x
+= glyphs
[i
].pixel_width
;
24952 /* Set background width of glyph string S. START is the index of the
24953 first glyph following S. LAST_X is the right-most x-position + 1
24954 in the drawing area. */
24957 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24959 /* If the face of this glyph string has to be drawn to the end of
24960 the drawing area, set S->extends_to_end_of_line_p. */
24962 if (start
== s
->row
->used
[s
->area
]
24963 && ((s
->row
->fill_line_p
24964 && (s
->hl
== DRAW_NORMAL_TEXT
24965 || s
->hl
== DRAW_IMAGE_RAISED
24966 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24967 || s
->hl
== DRAW_MOUSE_FACE
))
24968 s
->extends_to_end_of_line_p
= true;
24970 /* If S extends its face to the end of the line, set its
24971 background_width to the distance to the right edge of the drawing
24973 if (s
->extends_to_end_of_line_p
)
24974 s
->background_width
= last_x
- s
->x
+ 1;
24976 s
->background_width
= s
->width
;
24980 /* Compute overhangs and x-positions for glyph string S and its
24981 predecessors, or successors. X is the starting x-position for S.
24982 BACKWARD_P means process predecessors. */
24985 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
24991 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24992 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25002 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25003 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25013 /* The following macros are only called from draw_glyphs below.
25014 They reference the following parameters of that function directly:
25015 `w', `row', `area', and `overlap_p'
25016 as well as the following local variables:
25017 `s', `f', and `hdc' (in W32) */
25020 /* On W32, silently add local `hdc' variable to argument list of
25021 init_glyph_string. */
25022 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25023 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25025 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25026 init_glyph_string (s, char2b, w, row, area, start, hl)
25029 /* Add a glyph string for a stretch glyph to the list of strings
25030 between HEAD and TAIL. START is the index of the stretch glyph in
25031 row area AREA of glyph row ROW. END is the index of the last glyph
25032 in that glyph row area. X is the current output position assigned
25033 to the new glyph string constructed. HL overrides that face of the
25034 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25035 is the right-most x-position of the drawing area. */
25037 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25038 and below -- keep them on one line. */
25039 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25042 s = alloca (sizeof *s); \
25043 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25044 START = fill_stretch_glyph_string (s, START, END); \
25045 append_glyph_string (&HEAD, &TAIL, s); \
25051 /* Add a glyph string for an image glyph to the list of strings
25052 between HEAD and TAIL. START is the index of the image glyph in
25053 row area AREA of glyph row ROW. END is the index of the last glyph
25054 in that glyph row area. X is the current output position assigned
25055 to the new glyph string constructed. HL overrides that face of the
25056 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25057 is the right-most x-position of the drawing area. */
25059 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25062 s = alloca (sizeof *s); \
25063 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25064 fill_image_glyph_string (s); \
25065 append_glyph_string (&HEAD, &TAIL, s); \
25072 /* Add a glyph string for a sequence of character glyphs to the list
25073 of strings between HEAD and TAIL. START is the index of the first
25074 glyph in row area AREA of glyph row ROW that is part of the new
25075 glyph string. END is the index of the last glyph in that glyph row
25076 area. X is the current output position assigned to the new glyph
25077 string constructed. HL overrides that face of the glyph; e.g. it
25078 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25079 right-most x-position of the drawing area. */
25081 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25087 face_id = (row)->glyphs[area][START].face_id; \
25089 s = alloca (sizeof *s); \
25090 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25091 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25092 append_glyph_string (&HEAD, &TAIL, s); \
25094 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25099 /* Add a glyph string for a composite sequence to the list of strings
25100 between HEAD and TAIL. START is the index of the first glyph in
25101 row area AREA of glyph row ROW that is part of the new glyph
25102 string. END is the index of the last glyph in that glyph row area.
25103 X is the current output position assigned to the new glyph string
25104 constructed. HL overrides that face of the glyph; e.g. it is
25105 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25106 x-position of the drawing area. */
25108 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25110 int face_id = (row)->glyphs[area][START].face_id; \
25111 struct face *base_face = FACE_FROM_ID (f, face_id); \
25112 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25113 struct composition *cmp = composition_table[cmp_id]; \
25115 struct glyph_string *first_s = NULL; \
25118 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25120 /* Make glyph_strings for each glyph sequence that is drawable by \
25121 the same face, and append them to HEAD/TAIL. */ \
25122 for (n = 0; n < cmp->glyph_len;) \
25124 s = alloca (sizeof *s); \
25125 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25126 append_glyph_string (&(HEAD), &(TAIL), s); \
25132 n = fill_composite_glyph_string (s, base_face, overlaps); \
25140 /* Add a glyph string for a glyph-string sequence to the list of strings
25141 between HEAD and TAIL. */
25143 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25147 Lisp_Object gstring; \
25149 face_id = (row)->glyphs[area][START].face_id; \
25150 gstring = (composition_gstring_from_id \
25151 ((row)->glyphs[area][START].u.cmp.id)); \
25152 s = alloca (sizeof *s); \
25153 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25154 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25155 append_glyph_string (&(HEAD), &(TAIL), s); \
25157 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25161 /* Add a glyph string for a sequence of glyphless character's glyphs
25162 to the list of strings between HEAD and TAIL. The meanings of
25163 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25165 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25170 face_id = (row)->glyphs[area][START].face_id; \
25172 s = alloca (sizeof *s); \
25173 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25174 append_glyph_string (&HEAD, &TAIL, s); \
25176 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25182 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25183 of AREA of glyph row ROW on window W between indices START and END.
25184 HL overrides the face for drawing glyph strings, e.g. it is
25185 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25186 x-positions of the drawing area.
25188 This is an ugly monster macro construct because we must use alloca
25189 to allocate glyph strings (because draw_glyphs can be called
25190 asynchronously). */
25192 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25195 HEAD = TAIL = NULL; \
25196 while (START < END) \
25198 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25199 switch (first_glyph->type) \
25202 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25206 case COMPOSITE_GLYPH: \
25207 if (first_glyph->u.cmp.automatic) \
25208 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25211 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25215 case STRETCH_GLYPH: \
25216 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25220 case IMAGE_GLYPH: \
25221 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25225 case GLYPHLESS_GLYPH: \
25226 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25236 set_glyph_string_background_width (s, START, LAST_X); \
25243 /* Draw glyphs between START and END in AREA of ROW on window W,
25244 starting at x-position X. X is relative to AREA in W. HL is a
25245 face-override with the following meaning:
25247 DRAW_NORMAL_TEXT draw normally
25248 DRAW_CURSOR draw in cursor face
25249 DRAW_MOUSE_FACE draw in mouse face.
25250 DRAW_INVERSE_VIDEO draw in mode line face
25251 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25252 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25254 If OVERLAPS is non-zero, draw only the foreground of characters and
25255 clip to the physical height of ROW. Non-zero value also defines
25256 the overlapping part to be drawn:
25258 OVERLAPS_PRED overlap with preceding rows
25259 OVERLAPS_SUCC overlap with succeeding rows
25260 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25261 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25263 Value is the x-position reached, relative to AREA of W. */
25266 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25267 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25268 enum draw_glyphs_face hl
, int overlaps
)
25270 struct glyph_string
*head
, *tail
;
25271 struct glyph_string
*s
;
25272 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25273 int i
, j
, x_reached
, last_x
, area_left
= 0;
25274 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25277 ALLOCATE_HDC (hdc
, f
);
25279 /* Let's rather be paranoid than getting a SEGV. */
25280 end
= min (end
, row
->used
[area
]);
25281 start
= clip_to_bounds (0, start
, end
);
25283 /* Translate X to frame coordinates. Set last_x to the right
25284 end of the drawing area. */
25285 if (row
->full_width_p
)
25287 /* X is relative to the left edge of W, without scroll bars
25289 area_left
= WINDOW_LEFT_EDGE_X (w
);
25290 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25291 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25295 area_left
= window_box_left (w
, area
);
25296 last_x
= area_left
+ window_box_width (w
, area
);
25300 /* Build a doubly-linked list of glyph_string structures between
25301 head and tail from what we have to draw. Note that the macro
25302 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25303 the reason we use a separate variable `i'. */
25306 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25308 x_reached
= tail
->x
+ tail
->background_width
;
25312 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25313 the row, redraw some glyphs in front or following the glyph
25314 strings built above. */
25315 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25317 struct glyph_string
*h
, *t
;
25318 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25319 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25320 bool check_mouse_face
= false;
25323 /* If mouse highlighting is on, we may need to draw adjacent
25324 glyphs using mouse-face highlighting. */
25325 if (area
== TEXT_AREA
&& row
->mouse_face_p
25326 && hlinfo
->mouse_face_beg_row
>= 0
25327 && hlinfo
->mouse_face_end_row
>= 0)
25329 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25331 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25332 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25334 check_mouse_face
= true;
25335 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25336 ? hlinfo
->mouse_face_beg_col
: 0;
25337 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25338 ? hlinfo
->mouse_face_end_col
25339 : row
->used
[TEXT_AREA
];
25343 /* Compute overhangs for all glyph strings. */
25344 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25345 for (s
= head
; s
; s
= s
->next
)
25346 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25348 /* Prepend glyph strings for glyphs in front of the first glyph
25349 string that are overwritten because of the first glyph
25350 string's left overhang. The background of all strings
25351 prepended must be drawn because the first glyph string
25353 i
= left_overwritten (head
);
25356 enum draw_glyphs_face overlap_hl
;
25358 /* If this row contains mouse highlighting, attempt to draw
25359 the overlapped glyphs with the correct highlight. This
25360 code fails if the overlap encompasses more than one glyph
25361 and mouse-highlight spans only some of these glyphs.
25362 However, making it work perfectly involves a lot more
25363 code, and I don't know if the pathological case occurs in
25364 practice, so we'll stick to this for now. --- cyd */
25365 if (check_mouse_face
25366 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25367 overlap_hl
= DRAW_MOUSE_FACE
;
25369 overlap_hl
= DRAW_NORMAL_TEXT
;
25371 if (hl
!= overlap_hl
)
25374 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25375 overlap_hl
, dummy_x
, last_x
);
25377 compute_overhangs_and_x (t
, head
->x
, true);
25378 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25379 if (clip_head
== NULL
)
25383 /* Prepend glyph strings for glyphs in front of the first glyph
25384 string that overwrite that glyph string because of their
25385 right overhang. For these strings, only the foreground must
25386 be drawn, because it draws over the glyph string at `head'.
25387 The background must not be drawn because this would overwrite
25388 right overhangs of preceding glyphs for which no glyph
25390 i
= left_overwriting (head
);
25393 enum draw_glyphs_face overlap_hl
;
25395 if (check_mouse_face
25396 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25397 overlap_hl
= DRAW_MOUSE_FACE
;
25399 overlap_hl
= DRAW_NORMAL_TEXT
;
25401 if (hl
== overlap_hl
|| clip_head
== NULL
)
25403 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25404 overlap_hl
, dummy_x
, last_x
);
25405 for (s
= h
; s
; s
= s
->next
)
25406 s
->background_filled_p
= true;
25407 compute_overhangs_and_x (t
, head
->x
, true);
25408 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25411 /* Append glyphs strings for glyphs following the last glyph
25412 string tail that are overwritten by tail. The background of
25413 these strings has to be drawn because tail's foreground draws
25415 i
= right_overwritten (tail
);
25418 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
)
25428 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25429 overlap_hl
, x
, last_x
);
25430 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25431 we don't have `end = i;' here. */
25432 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25433 append_glyph_string_lists (&head
, &tail
, h
, t
);
25434 if (clip_tail
== NULL
)
25438 /* Append glyph strings for glyphs following the last glyph
25439 string tail that overwrite tail. The foreground of such
25440 glyphs has to be drawn because it writes into the background
25441 of tail. The background must not be drawn because it could
25442 paint over the foreground of following glyphs. */
25443 i
= right_overwriting (tail
);
25446 enum draw_glyphs_face overlap_hl
;
25447 if (check_mouse_face
25448 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25449 overlap_hl
= DRAW_MOUSE_FACE
;
25451 overlap_hl
= DRAW_NORMAL_TEXT
;
25453 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25455 i
++; /* We must include the Ith glyph. */
25456 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25457 overlap_hl
, x
, last_x
);
25458 for (s
= h
; s
; s
= s
->next
)
25459 s
->background_filled_p
= true;
25460 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25461 append_glyph_string_lists (&head
, &tail
, h
, t
);
25463 if (clip_head
|| clip_tail
)
25464 for (s
= head
; s
; s
= s
->next
)
25466 s
->clip_head
= clip_head
;
25467 s
->clip_tail
= clip_tail
;
25471 /* Draw all strings. */
25472 for (s
= head
; s
; s
= s
->next
)
25473 FRAME_RIF (f
)->draw_glyph_string (s
);
25476 /* When focus a sole frame and move horizontally, this clears on_p
25477 causing a failure to erase prev cursor position. */
25478 if (area
== TEXT_AREA
25479 && !row
->full_width_p
25480 /* When drawing overlapping rows, only the glyph strings'
25481 foreground is drawn, which doesn't erase a cursor
25485 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25486 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25487 : (tail
? tail
->x
+ tail
->background_width
: x
));
25491 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25492 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25496 /* Value is the x-position up to which drawn, relative to AREA of W.
25497 This doesn't include parts drawn because of overhangs. */
25498 if (row
->full_width_p
)
25499 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25501 x_reached
-= area_left
;
25503 RELEASE_HDC (hdc
, f
);
25509 /* Expand row matrix if too narrow. Don't expand if area
25512 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25514 if (!it->f->fonts_changed \
25515 && (it->glyph_row->glyphs[area] \
25516 < it->glyph_row->glyphs[area + 1])) \
25518 it->w->ncols_scale_factor++; \
25519 it->f->fonts_changed = true; \
25523 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25524 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25527 append_glyph (struct it
*it
)
25529 struct glyph
*glyph
;
25530 enum glyph_row_area area
= it
->area
;
25532 eassert (it
->glyph_row
);
25533 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25535 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25536 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25538 /* If the glyph row is reversed, we need to prepend the glyph
25539 rather than append it. */
25540 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25544 /* Make room for the additional glyph. */
25545 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25547 glyph
= it
->glyph_row
->glyphs
[area
];
25549 glyph
->charpos
= CHARPOS (it
->position
);
25550 glyph
->object
= it
->object
;
25551 if (it
->pixel_width
> 0)
25553 glyph
->pixel_width
= it
->pixel_width
;
25554 glyph
->padding_p
= false;
25558 /* Assure at least 1-pixel width. Otherwise, cursor can't
25559 be displayed correctly. */
25560 glyph
->pixel_width
= 1;
25561 glyph
->padding_p
= true;
25563 glyph
->ascent
= it
->ascent
;
25564 glyph
->descent
= it
->descent
;
25565 glyph
->voffset
= it
->voffset
;
25566 glyph
->type
= CHAR_GLYPH
;
25567 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25568 glyph
->multibyte_p
= it
->multibyte_p
;
25569 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25571 /* In R2L rows, the left and the right box edges need to be
25572 drawn in reverse direction. */
25573 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25574 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25578 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25579 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25581 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25582 || it
->phys_descent
> it
->descent
);
25583 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25584 glyph
->face_id
= it
->face_id
;
25585 glyph
->u
.ch
= it
->char_to_display
;
25586 glyph
->slice
.img
= null_glyph_slice
;
25587 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25590 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25591 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25592 glyph
->bidi_type
= it
->bidi_it
.type
;
25596 glyph
->resolved_level
= 0;
25597 glyph
->bidi_type
= UNKNOWN_BT
;
25599 ++it
->glyph_row
->used
[area
];
25602 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25605 /* Store one glyph for the composition IT->cmp_it.id in
25606 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25610 append_composite_glyph (struct it
*it
)
25612 struct glyph
*glyph
;
25613 enum glyph_row_area area
= it
->area
;
25615 eassert (it
->glyph_row
);
25617 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25618 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25620 /* If the glyph row is reversed, we need to prepend the glyph
25621 rather than append it. */
25622 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25626 /* Make room for the new glyph. */
25627 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25629 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25631 glyph
->charpos
= it
->cmp_it
.charpos
;
25632 glyph
->object
= it
->object
;
25633 glyph
->pixel_width
= it
->pixel_width
;
25634 glyph
->ascent
= it
->ascent
;
25635 glyph
->descent
= it
->descent
;
25636 glyph
->voffset
= it
->voffset
;
25637 glyph
->type
= COMPOSITE_GLYPH
;
25638 if (it
->cmp_it
.ch
< 0)
25640 glyph
->u
.cmp
.automatic
= false;
25641 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25642 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25646 glyph
->u
.cmp
.automatic
= true;
25647 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25648 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25649 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25651 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25652 glyph
->multibyte_p
= it
->multibyte_p
;
25653 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25655 /* In R2L rows, the left and the right box edges need to be
25656 drawn in reverse direction. */
25657 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25658 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25662 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25663 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25665 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25666 || it
->phys_descent
> it
->descent
);
25667 glyph
->padding_p
= false;
25668 glyph
->glyph_not_available_p
= false;
25669 glyph
->face_id
= it
->face_id
;
25670 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25673 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25674 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25675 glyph
->bidi_type
= it
->bidi_it
.type
;
25677 ++it
->glyph_row
->used
[area
];
25680 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25684 /* Change IT->ascent and IT->height according to the setting of
25688 take_vertical_position_into_account (struct it
*it
)
25692 if (it
->voffset
< 0)
25693 /* Increase the ascent so that we can display the text higher
25695 it
->ascent
-= it
->voffset
;
25697 /* Increase the descent so that we can display the text lower
25699 it
->descent
+= it
->voffset
;
25704 /* Produce glyphs/get display metrics for the image IT is loaded with.
25705 See the description of struct display_iterator in dispextern.h for
25706 an overview of struct display_iterator. */
25709 produce_image_glyph (struct it
*it
)
25713 int glyph_ascent
, crop
;
25714 struct glyph_slice slice
;
25716 eassert (it
->what
== IT_IMAGE
);
25718 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25720 /* Make sure X resources of the face is loaded. */
25721 prepare_face_for_display (it
->f
, face
);
25723 if (it
->image_id
< 0)
25725 /* Fringe bitmap. */
25726 it
->ascent
= it
->phys_ascent
= 0;
25727 it
->descent
= it
->phys_descent
= 0;
25728 it
->pixel_width
= 0;
25733 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25735 /* Make sure X resources of the image is loaded. */
25736 prepare_image_for_display (it
->f
, img
);
25738 slice
.x
= slice
.y
= 0;
25739 slice
.width
= img
->width
;
25740 slice
.height
= img
->height
;
25742 if (INTEGERP (it
->slice
.x
))
25743 slice
.x
= XINT (it
->slice
.x
);
25744 else if (FLOATP (it
->slice
.x
))
25745 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25747 if (INTEGERP (it
->slice
.y
))
25748 slice
.y
= XINT (it
->slice
.y
);
25749 else if (FLOATP (it
->slice
.y
))
25750 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25752 if (INTEGERP (it
->slice
.width
))
25753 slice
.width
= XINT (it
->slice
.width
);
25754 else if (FLOATP (it
->slice
.width
))
25755 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25757 if (INTEGERP (it
->slice
.height
))
25758 slice
.height
= XINT (it
->slice
.height
);
25759 else if (FLOATP (it
->slice
.height
))
25760 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25762 if (slice
.x
>= img
->width
)
25763 slice
.x
= img
->width
;
25764 if (slice
.y
>= img
->height
)
25765 slice
.y
= img
->height
;
25766 if (slice
.x
+ slice
.width
>= img
->width
)
25767 slice
.width
= img
->width
- slice
.x
;
25768 if (slice
.y
+ slice
.height
> img
->height
)
25769 slice
.height
= img
->height
- slice
.y
;
25771 if (slice
.width
== 0 || slice
.height
== 0)
25774 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25776 it
->descent
= slice
.height
- glyph_ascent
;
25778 it
->descent
+= img
->vmargin
;
25779 if (slice
.y
+ slice
.height
== img
->height
)
25780 it
->descent
+= img
->vmargin
;
25781 it
->phys_descent
= it
->descent
;
25783 it
->pixel_width
= slice
.width
;
25785 it
->pixel_width
+= img
->hmargin
;
25786 if (slice
.x
+ slice
.width
== img
->width
)
25787 it
->pixel_width
+= img
->hmargin
;
25789 /* It's quite possible for images to have an ascent greater than
25790 their height, so don't get confused in that case. */
25791 if (it
->descent
< 0)
25796 if (face
->box
!= FACE_NO_BOX
)
25798 if (face
->box_line_width
> 0)
25801 it
->ascent
+= face
->box_line_width
;
25802 if (slice
.y
+ slice
.height
== img
->height
)
25803 it
->descent
+= face
->box_line_width
;
25806 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25807 it
->pixel_width
+= eabs (face
->box_line_width
);
25808 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25809 it
->pixel_width
+= eabs (face
->box_line_width
);
25812 take_vertical_position_into_account (it
);
25814 /* Automatically crop wide image glyphs at right edge so we can
25815 draw the cursor on same display row. */
25816 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25817 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25819 it
->pixel_width
-= crop
;
25820 slice
.width
-= crop
;
25825 struct glyph
*glyph
;
25826 enum glyph_row_area area
= it
->area
;
25828 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25829 if (it
->glyph_row
->reversed_p
)
25833 /* Make room for the new glyph. */
25834 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25836 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25838 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25840 glyph
->charpos
= CHARPOS (it
->position
);
25841 glyph
->object
= it
->object
;
25842 glyph
->pixel_width
= it
->pixel_width
;
25843 glyph
->ascent
= glyph_ascent
;
25844 glyph
->descent
= it
->descent
;
25845 glyph
->voffset
= it
->voffset
;
25846 glyph
->type
= IMAGE_GLYPH
;
25847 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25848 glyph
->multibyte_p
= it
->multibyte_p
;
25849 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25851 /* In R2L rows, the left and the right box edges need to be
25852 drawn in reverse direction. */
25853 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25854 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25858 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25859 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25861 glyph
->overlaps_vertically_p
= false;
25862 glyph
->padding_p
= false;
25863 glyph
->glyph_not_available_p
= false;
25864 glyph
->face_id
= it
->face_id
;
25865 glyph
->u
.img_id
= img
->id
;
25866 glyph
->slice
.img
= slice
;
25867 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25870 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25871 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25872 glyph
->bidi_type
= it
->bidi_it
.type
;
25874 ++it
->glyph_row
->used
[area
];
25877 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25882 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25883 of the glyph, WIDTH and HEIGHT are the width and height of the
25884 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25887 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25888 int width
, int height
, int ascent
)
25890 struct glyph
*glyph
;
25891 enum glyph_row_area area
= it
->area
;
25893 eassert (ascent
>= 0 && ascent
<= height
);
25895 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25896 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25898 /* If the glyph row is reversed, we need to prepend the glyph
25899 rather than append it. */
25900 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25904 /* Make room for the additional glyph. */
25905 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25907 glyph
= it
->glyph_row
->glyphs
[area
];
25909 /* Decrease the width of the first glyph of the row that
25910 begins before first_visible_x (e.g., due to hscroll).
25911 This is so the overall width of the row becomes smaller
25912 by the scroll amount, and the stretch glyph appended by
25913 extend_face_to_end_of_line will be wider, to shift the
25914 row glyphs to the right. (In L2R rows, the corresponding
25915 left-shift effect is accomplished by setting row->x to a
25916 negative value, which won't work with R2L rows.)
25918 This must leave us with a positive value of WIDTH, since
25919 otherwise the call to move_it_in_display_line_to at the
25920 beginning of display_line would have got past the entire
25921 first glyph, and then it->current_x would have been
25922 greater or equal to it->first_visible_x. */
25923 if (it
->current_x
< it
->first_visible_x
)
25924 width
-= it
->first_visible_x
- it
->current_x
;
25925 eassert (width
> 0);
25927 glyph
->charpos
= CHARPOS (it
->position
);
25928 glyph
->object
= object
;
25929 glyph
->pixel_width
= width
;
25930 glyph
->ascent
= ascent
;
25931 glyph
->descent
= height
- ascent
;
25932 glyph
->voffset
= it
->voffset
;
25933 glyph
->type
= STRETCH_GLYPH
;
25934 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25935 glyph
->multibyte_p
= it
->multibyte_p
;
25936 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25938 /* In R2L rows, the left and the right box edges need to be
25939 drawn in reverse direction. */
25940 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25941 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25945 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25946 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25948 glyph
->overlaps_vertically_p
= false;
25949 glyph
->padding_p
= false;
25950 glyph
->glyph_not_available_p
= false;
25951 glyph
->face_id
= it
->face_id
;
25952 glyph
->u
.stretch
.ascent
= ascent
;
25953 glyph
->u
.stretch
.height
= height
;
25954 glyph
->slice
.img
= null_glyph_slice
;
25955 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25958 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25959 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25960 glyph
->bidi_type
= it
->bidi_it
.type
;
25964 glyph
->resolved_level
= 0;
25965 glyph
->bidi_type
= UNKNOWN_BT
;
25967 ++it
->glyph_row
->used
[area
];
25970 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25973 #endif /* HAVE_WINDOW_SYSTEM */
25975 /* Produce a stretch glyph for iterator IT. IT->object is the value
25976 of the glyph property displayed. The value must be a list
25977 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25980 1. `:width WIDTH' specifies that the space should be WIDTH *
25981 canonical char width wide. WIDTH may be an integer or floating
25984 2. `:relative-width FACTOR' specifies that the width of the stretch
25985 should be computed from the width of the first character having the
25986 `glyph' property, and should be FACTOR times that width.
25988 3. `:align-to HPOS' specifies that the space should be wide enough
25989 to reach HPOS, a value in canonical character units.
25991 Exactly one of the above pairs must be present.
25993 4. `:height HEIGHT' specifies that the height of the stretch produced
25994 should be HEIGHT, measured in canonical character units.
25996 5. `:relative-height FACTOR' specifies that the height of the
25997 stretch should be FACTOR times the height of the characters having
25998 the glyph property.
26000 Either none or exactly one of 4 or 5 must be present.
26002 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26003 of the stretch should be used for the ascent of the stretch.
26004 ASCENT must be in the range 0 <= ASCENT <= 100. */
26007 produce_stretch_glyph (struct it
*it
)
26009 /* (space :width WIDTH :height HEIGHT ...) */
26010 Lisp_Object prop
, plist
;
26011 int width
= 0, height
= 0, align_to
= -1;
26012 bool zero_width_ok_p
= false;
26014 struct font
*font
= NULL
;
26016 #ifdef HAVE_WINDOW_SYSTEM
26018 bool zero_height_ok_p
= false;
26020 if (FRAME_WINDOW_P (it
->f
))
26022 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26023 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26024 prepare_face_for_display (it
->f
, face
);
26028 /* List should start with `space'. */
26029 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26030 plist
= XCDR (it
->object
);
26032 /* Compute the width of the stretch. */
26033 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26034 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26036 /* Absolute width `:width WIDTH' specified and valid. */
26037 zero_width_ok_p
= true;
26040 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26042 /* Relative width `:relative-width FACTOR' specified and valid.
26043 Compute the width of the characters having the `glyph'
26046 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26049 if (it
->multibyte_p
)
26050 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26053 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26054 if (! ASCII_CHAR_P (it2
.c
))
26055 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26058 it2
.glyph_row
= NULL
;
26059 it2
.what
= IT_CHARACTER
;
26060 PRODUCE_GLYPHS (&it2
);
26061 width
= NUMVAL (prop
) * it2
.pixel_width
;
26063 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26064 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26067 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26068 align_to
= (align_to
< 0
26070 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26071 else if (align_to
< 0)
26072 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26073 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26074 zero_width_ok_p
= true;
26077 /* Nothing specified -> width defaults to canonical char width. */
26078 width
= FRAME_COLUMN_WIDTH (it
->f
);
26080 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26083 #ifdef HAVE_WINDOW_SYSTEM
26084 /* Compute height. */
26085 if (FRAME_WINDOW_P (it
->f
))
26087 int default_height
= normal_char_height (font
, ' ');
26089 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26090 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26093 zero_height_ok_p
= true;
26095 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26097 height
= default_height
* NUMVAL (prop
);
26099 height
= default_height
;
26101 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26104 /* Compute percentage of height used for ascent. If
26105 `:ascent ASCENT' is present and valid, use that. Otherwise,
26106 derive the ascent from the font in use. */
26107 if (prop
= Fplist_get (plist
, QCascent
),
26108 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26109 ascent
= height
* NUMVAL (prop
) / 100.0;
26110 else if (!NILP (prop
)
26111 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26112 ascent
= min (max (0, (int)tem
), height
);
26114 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26117 #endif /* HAVE_WINDOW_SYSTEM */
26120 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26121 && it
->current_x
+ width
> it
->last_visible_x
)
26123 width
= it
->last_visible_x
- it
->current_x
;
26124 #ifdef HAVE_WINDOW_SYSTEM
26125 /* Subtract one more pixel from the stretch width, but only on
26126 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26127 width
-= FRAME_WINDOW_P (it
->f
);
26131 if (width
> 0 && height
> 0 && it
->glyph_row
)
26133 Lisp_Object o_object
= it
->object
;
26134 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26137 if (!STRINGP (object
))
26138 object
= it
->w
->contents
;
26139 #ifdef HAVE_WINDOW_SYSTEM
26140 if (FRAME_WINDOW_P (it
->f
))
26141 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26145 it
->object
= object
;
26146 it
->char_to_display
= ' ';
26147 it
->pixel_width
= it
->len
= 1;
26149 tty_append_glyph (it
);
26150 it
->object
= o_object
;
26154 it
->pixel_width
= width
;
26155 #ifdef HAVE_WINDOW_SYSTEM
26156 if (FRAME_WINDOW_P (it
->f
))
26158 it
->ascent
= it
->phys_ascent
= ascent
;
26159 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26160 it
->nglyphs
= width
> 0 && height
> 0;
26161 take_vertical_position_into_account (it
);
26165 it
->nglyphs
= width
;
26168 /* Get information about special display element WHAT in an
26169 environment described by IT. WHAT is one of IT_TRUNCATION or
26170 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26171 non-null glyph_row member. This function ensures that fields like
26172 face_id, c, len of IT are left untouched. */
26175 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26182 temp_it
.object
= Qnil
;
26183 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26185 if (what
== IT_CONTINUATION
)
26187 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26188 if (it
->bidi_it
.paragraph_dir
== R2L
)
26189 SET_GLYPH_FROM_CHAR (glyph
, '/');
26191 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26193 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26195 /* FIXME: Should we mirror GC for R2L lines? */
26196 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26197 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26200 else if (what
== IT_TRUNCATION
)
26202 /* Truncation glyph. */
26203 SET_GLYPH_FROM_CHAR (glyph
, '$');
26205 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26207 /* FIXME: Should we mirror GC for R2L lines? */
26208 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26209 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26215 #ifdef HAVE_WINDOW_SYSTEM
26216 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26217 is turned off, we precede the truncation/continuation glyphs by a
26218 stretch glyph whose width is computed such that these special
26219 glyphs are aligned at the window margin, even when very different
26220 fonts are used in different glyph rows. */
26221 if (FRAME_WINDOW_P (temp_it
.f
)
26222 /* init_iterator calls this with it->glyph_row == NULL, and it
26223 wants only the pixel width of the truncation/continuation
26225 && temp_it
.glyph_row
26226 /* insert_left_trunc_glyphs calls us at the beginning of the
26227 row, and it has its own calculation of the stretch glyph
26229 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26230 && (temp_it
.glyph_row
->reversed_p
26231 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26232 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26234 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26236 if (stretch_width
> 0)
26238 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26239 struct font
*font
=
26240 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26241 int stretch_ascent
=
26242 (((temp_it
.ascent
+ temp_it
.descent
)
26243 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26245 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26246 temp_it
.ascent
+ temp_it
.descent
,
26253 temp_it
.what
= IT_CHARACTER
;
26254 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26255 temp_it
.face_id
= GLYPH_FACE (glyph
);
26256 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26258 PRODUCE_GLYPHS (&temp_it
);
26259 it
->pixel_width
= temp_it
.pixel_width
;
26260 it
->nglyphs
= temp_it
.nglyphs
;
26263 #ifdef HAVE_WINDOW_SYSTEM
26265 /* Calculate line-height and line-spacing properties.
26266 An integer value specifies explicit pixel value.
26267 A float value specifies relative value to current face height.
26268 A cons (float . face-name) specifies relative value to
26269 height of specified face font.
26271 Returns height in pixels, or nil. */
26274 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26275 int boff
, bool override
)
26277 Lisp_Object face_name
= Qnil
;
26278 int ascent
, descent
, height
;
26280 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26285 face_name
= XCAR (val
);
26287 if (!NUMBERP (val
))
26288 val
= make_number (1);
26289 if (NILP (face_name
))
26291 height
= it
->ascent
+ it
->descent
;
26296 if (NILP (face_name
))
26298 font
= FRAME_FONT (it
->f
);
26299 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26301 else if (EQ (face_name
, Qt
))
26310 face_id
= lookup_named_face (it
->f
, face_name
, false);
26312 return make_number (-1);
26314 face
= FACE_FROM_ID (it
->f
, face_id
);
26317 return make_number (-1);
26318 boff
= font
->baseline_offset
;
26319 if (font
->vertical_centering
)
26320 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26323 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26327 it
->override_ascent
= ascent
;
26328 it
->override_descent
= descent
;
26329 it
->override_boff
= boff
;
26332 height
= ascent
+ descent
;
26336 height
= (int)(XFLOAT_DATA (val
) * height
);
26337 else if (INTEGERP (val
))
26338 height
*= XINT (val
);
26340 return make_number (height
);
26344 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26345 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26346 and only if this is for a character for which no font was found.
26348 If the display method (it->glyphless_method) is
26349 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26350 length of the acronym or the hexadecimal string, UPPER_XOFF and
26351 UPPER_YOFF are pixel offsets for the upper part of the string,
26352 LOWER_XOFF and LOWER_YOFF are for the lower part.
26354 For the other display methods, LEN through LOWER_YOFF are zero. */
26357 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26358 short upper_xoff
, short upper_yoff
,
26359 short lower_xoff
, short lower_yoff
)
26361 struct glyph
*glyph
;
26362 enum glyph_row_area area
= it
->area
;
26364 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26365 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26367 /* If the glyph row is reversed, we need to prepend the glyph
26368 rather than append it. */
26369 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26373 /* Make room for the additional glyph. */
26374 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26376 glyph
= it
->glyph_row
->glyphs
[area
];
26378 glyph
->charpos
= CHARPOS (it
->position
);
26379 glyph
->object
= it
->object
;
26380 glyph
->pixel_width
= it
->pixel_width
;
26381 glyph
->ascent
= it
->ascent
;
26382 glyph
->descent
= it
->descent
;
26383 glyph
->voffset
= it
->voffset
;
26384 glyph
->type
= GLYPHLESS_GLYPH
;
26385 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26386 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26387 glyph
->u
.glyphless
.len
= len
;
26388 glyph
->u
.glyphless
.ch
= it
->c
;
26389 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26390 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26391 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26392 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26393 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26394 glyph
->multibyte_p
= it
->multibyte_p
;
26395 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26397 /* In R2L rows, the left and the right box edges need to be
26398 drawn in reverse direction. */
26399 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26400 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26404 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26405 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26407 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26408 || it
->phys_descent
> it
->descent
);
26409 glyph
->padding_p
= false;
26410 glyph
->glyph_not_available_p
= false;
26411 glyph
->face_id
= face_id
;
26412 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26415 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26416 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26417 glyph
->bidi_type
= it
->bidi_it
.type
;
26419 ++it
->glyph_row
->used
[area
];
26422 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26426 /* Produce a glyph for a glyphless character for iterator IT.
26427 IT->glyphless_method specifies which method to use for displaying
26428 the character. See the description of enum
26429 glyphless_display_method in dispextern.h for the detail.
26431 FOR_NO_FONT is true if and only if this is for a character for
26432 which no font was found. ACRONYM, if non-nil, is an acronym string
26433 for the character. */
26436 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26441 int base_width
, base_height
, width
, height
;
26442 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26445 /* Get the metrics of the base font. We always refer to the current
26447 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26448 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26449 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26450 it
->ascent
+= font
->baseline_offset
;
26451 it
->descent
-= font
->baseline_offset
;
26452 base_height
= it
->ascent
+ it
->descent
;
26453 base_width
= font
->average_width
;
26455 face_id
= merge_glyphless_glyph_face (it
);
26457 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26459 it
->pixel_width
= THIN_SPACE_WIDTH
;
26461 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26463 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26465 width
= CHAR_WIDTH (it
->c
);
26468 else if (width
> 4)
26470 it
->pixel_width
= base_width
* width
;
26472 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26478 unsigned int code
[6];
26480 int ascent
, descent
;
26481 struct font_metrics metrics_upper
, metrics_lower
;
26483 face
= FACE_FROM_ID (it
->f
, face_id
);
26484 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26485 prepare_face_for_display (it
->f
, face
);
26487 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26489 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26490 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26491 if (CONSP (acronym
))
26492 acronym
= XCAR (acronym
);
26493 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26497 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26498 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26501 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26502 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26503 upper_len
= (len
+ 1) / 2;
26504 font
->driver
->text_extents (font
, code
, upper_len
,
26506 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26511 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26512 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26513 upper_xoff
= upper_yoff
= 2; /* the typical case */
26514 if (base_width
>= width
)
26516 /* Align the upper to the left, the lower to the right. */
26517 it
->pixel_width
= base_width
;
26518 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26522 /* Center the shorter one. */
26523 it
->pixel_width
= width
;
26524 if (metrics_upper
.width
>= metrics_lower
.width
)
26525 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26528 /* FIXME: This code doesn't look right. It formerly was
26529 missing the "lower_xoff = 0;", which couldn't have
26530 been right since it left lower_xoff uninitialized. */
26532 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26536 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26537 top, bottom, and between upper and lower strings. */
26538 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26539 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26540 /* Center vertically.
26541 H:base_height, D:base_descent
26542 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26544 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26545 descent = D - H/2 + h/2;
26546 lower_yoff = descent - 2 - ld;
26547 upper_yoff = lower_yoff - la - 1 - ud; */
26548 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26549 descent
= it
->descent
- (base_height
- height
) / 2;
26550 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26551 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26552 - metrics_upper
.descent
);
26553 /* Don't make the height shorter than the base height. */
26554 if (height
> base_height
)
26556 it
->ascent
= ascent
;
26557 it
->descent
= descent
;
26561 it
->phys_ascent
= it
->ascent
;
26562 it
->phys_descent
= it
->descent
;
26564 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26565 upper_xoff
, upper_yoff
,
26566 lower_xoff
, lower_yoff
);
26568 take_vertical_position_into_account (it
);
26573 Produce glyphs/get display metrics for the display element IT is
26574 loaded with. See the description of struct it in dispextern.h
26575 for an overview of struct it. */
26578 x_produce_glyphs (struct it
*it
)
26580 int extra_line_spacing
= it
->extra_line_spacing
;
26582 it
->glyph_not_available_p
= false;
26584 if (it
->what
== IT_CHARACTER
)
26587 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26588 struct font
*font
= face
->font
;
26589 struct font_metrics
*pcm
= NULL
;
26590 int boff
; /* Baseline offset. */
26594 /* When no suitable font is found, display this character by
26595 the method specified in the first extra slot of
26596 Vglyphless_char_display. */
26597 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26599 eassert (it
->what
== IT_GLYPHLESS
);
26600 produce_glyphless_glyph (it
, true,
26601 STRINGP (acronym
) ? acronym
: Qnil
);
26605 boff
= font
->baseline_offset
;
26606 if (font
->vertical_centering
)
26607 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26609 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26613 if (it
->override_ascent
>= 0)
26615 it
->ascent
= it
->override_ascent
;
26616 it
->descent
= it
->override_descent
;
26617 boff
= it
->override_boff
;
26621 it
->ascent
= FONT_BASE (font
) + boff
;
26622 it
->descent
= FONT_DESCENT (font
) - boff
;
26625 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26627 pcm
= get_per_char_metric (font
, &char2b
);
26628 if (pcm
->width
== 0
26629 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26635 it
->phys_ascent
= pcm
->ascent
+ boff
;
26636 it
->phys_descent
= pcm
->descent
- boff
;
26637 it
->pixel_width
= pcm
->width
;
26638 /* Don't use font-global values for ascent and descent
26639 if they result in an exceedingly large line height. */
26640 if (it
->override_ascent
< 0)
26642 if (FONT_TOO_HIGH (font
))
26644 it
->ascent
= it
->phys_ascent
;
26645 it
->descent
= it
->phys_descent
;
26646 /* These limitations are enforced by an
26647 assertion near the end of this function. */
26648 if (it
->ascent
< 0)
26650 if (it
->descent
< 0)
26657 it
->glyph_not_available_p
= true;
26658 it
->phys_ascent
= it
->ascent
;
26659 it
->phys_descent
= it
->descent
;
26660 it
->pixel_width
= font
->space_width
;
26663 if (it
->constrain_row_ascent_descent_p
)
26665 if (it
->descent
> it
->max_descent
)
26667 it
->ascent
+= it
->descent
- it
->max_descent
;
26668 it
->descent
= it
->max_descent
;
26670 if (it
->ascent
> it
->max_ascent
)
26672 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26673 it
->ascent
= it
->max_ascent
;
26675 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26676 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26677 extra_line_spacing
= 0;
26680 /* If this is a space inside a region of text with
26681 `space-width' property, change its width. */
26683 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26685 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26687 /* If face has a box, add the box thickness to the character
26688 height. If character has a box line to the left and/or
26689 right, add the box line width to the character's width. */
26690 if (face
->box
!= FACE_NO_BOX
)
26692 int thick
= face
->box_line_width
;
26696 it
->ascent
+= thick
;
26697 it
->descent
+= thick
;
26702 if (it
->start_of_box_run_p
)
26703 it
->pixel_width
+= thick
;
26704 if (it
->end_of_box_run_p
)
26705 it
->pixel_width
+= thick
;
26708 /* If face has an overline, add the height of the overline
26709 (1 pixel) and a 1 pixel margin to the character height. */
26710 if (face
->overline_p
)
26711 it
->ascent
+= overline_margin
;
26713 if (it
->constrain_row_ascent_descent_p
)
26715 if (it
->ascent
> it
->max_ascent
)
26716 it
->ascent
= it
->max_ascent
;
26717 if (it
->descent
> it
->max_descent
)
26718 it
->descent
= it
->max_descent
;
26721 take_vertical_position_into_account (it
);
26723 /* If we have to actually produce glyphs, do it. */
26728 /* Translate a space with a `space-width' property
26729 into a stretch glyph. */
26730 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26731 / FONT_HEIGHT (font
));
26732 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26733 it
->ascent
+ it
->descent
, ascent
);
26738 /* If characters with lbearing or rbearing are displayed
26739 in this line, record that fact in a flag of the
26740 glyph row. This is used to optimize X output code. */
26741 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26742 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26744 if (! stretched_p
&& it
->pixel_width
== 0)
26745 /* We assure that all visible glyphs have at least 1-pixel
26747 it
->pixel_width
= 1;
26749 else if (it
->char_to_display
== '\n')
26751 /* A newline has no width, but we need the height of the
26752 line. But if previous part of the line sets a height,
26753 don't increase that height. */
26755 Lisp_Object height
;
26756 Lisp_Object total_height
= Qnil
;
26758 it
->override_ascent
= -1;
26759 it
->pixel_width
= 0;
26762 height
= get_it_property (it
, Qline_height
);
26763 /* Split (line-height total-height) list. */
26765 && CONSP (XCDR (height
))
26766 && NILP (XCDR (XCDR (height
))))
26768 total_height
= XCAR (XCDR (height
));
26769 height
= XCAR (height
);
26771 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26773 if (it
->override_ascent
>= 0)
26775 it
->ascent
= it
->override_ascent
;
26776 it
->descent
= it
->override_descent
;
26777 boff
= it
->override_boff
;
26781 if (FONT_TOO_HIGH (font
))
26783 it
->ascent
= font
->pixel_size
+ boff
- 1;
26784 it
->descent
= -boff
+ 1;
26785 if (it
->descent
< 0)
26790 it
->ascent
= FONT_BASE (font
) + boff
;
26791 it
->descent
= FONT_DESCENT (font
) - boff
;
26795 if (EQ (height
, Qt
))
26797 if (it
->descent
> it
->max_descent
)
26799 it
->ascent
+= it
->descent
- it
->max_descent
;
26800 it
->descent
= it
->max_descent
;
26802 if (it
->ascent
> it
->max_ascent
)
26804 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26805 it
->ascent
= it
->max_ascent
;
26807 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26808 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26809 it
->constrain_row_ascent_descent_p
= true;
26810 extra_line_spacing
= 0;
26814 Lisp_Object spacing
;
26816 it
->phys_ascent
= it
->ascent
;
26817 it
->phys_descent
= it
->descent
;
26819 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26820 && face
->box
!= FACE_NO_BOX
26821 && face
->box_line_width
> 0)
26823 it
->ascent
+= face
->box_line_width
;
26824 it
->descent
+= face
->box_line_width
;
26827 && XINT (height
) > it
->ascent
+ it
->descent
)
26828 it
->ascent
= XINT (height
) - it
->descent
;
26830 if (!NILP (total_height
))
26831 spacing
= calc_line_height_property (it
, total_height
, font
,
26835 spacing
= get_it_property (it
, Qline_spacing
);
26836 spacing
= calc_line_height_property (it
, spacing
, font
,
26839 if (INTEGERP (spacing
))
26841 extra_line_spacing
= XINT (spacing
);
26842 if (!NILP (total_height
))
26843 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26847 else /* i.e. (it->char_to_display == '\t') */
26849 if (font
->space_width
> 0)
26851 int tab_width
= it
->tab_width
* font
->space_width
;
26852 int x
= it
->current_x
+ it
->continuation_lines_width
;
26853 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26855 /* If the distance from the current position to the next tab
26856 stop is less than a space character width, use the
26857 tab stop after that. */
26858 if (next_tab_x
- x
< font
->space_width
)
26859 next_tab_x
+= tab_width
;
26861 it
->pixel_width
= next_tab_x
- x
;
26863 if (FONT_TOO_HIGH (font
))
26865 if (get_char_glyph_code (' ', font
, &char2b
))
26867 pcm
= get_per_char_metric (font
, &char2b
);
26868 if (pcm
->width
== 0
26869 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26875 it
->ascent
= pcm
->ascent
+ boff
;
26876 it
->descent
= pcm
->descent
- boff
;
26880 it
->ascent
= font
->pixel_size
+ boff
- 1;
26881 it
->descent
= -boff
+ 1;
26883 if (it
->ascent
< 0)
26885 if (it
->descent
< 0)
26890 it
->ascent
= FONT_BASE (font
) + boff
;
26891 it
->descent
= FONT_DESCENT (font
) - boff
;
26893 it
->phys_ascent
= it
->ascent
;
26894 it
->phys_descent
= it
->descent
;
26898 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26899 it
->ascent
+ it
->descent
, it
->ascent
);
26904 it
->pixel_width
= 0;
26909 if (FONT_TOO_HIGH (font
))
26911 int font_ascent
, font_descent
;
26913 /* For very large fonts, where we ignore the declared font
26914 dimensions, and go by per-character metrics instead,
26915 don't let the row ascent and descent values (and the row
26916 height computed from them) be smaller than the "normal"
26917 character metrics. This avoids unpleasant effects
26918 whereby lines on display would change their height
26919 depending on which characters are shown. */
26920 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26921 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
26922 it
->max_descent
= max (it
->max_descent
, font_descent
);
26925 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26927 /* A static composition.
26929 Note: A composition is represented as one glyph in the
26930 glyph matrix. There are no padding glyphs.
26932 Important note: pixel_width, ascent, and descent are the
26933 values of what is drawn by draw_glyphs (i.e. the values of
26934 the overall glyphs composed). */
26935 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26936 int boff
; /* baseline offset */
26937 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26938 int glyph_len
= cmp
->glyph_len
;
26939 struct font
*font
= face
->font
;
26943 /* If we have not yet calculated pixel size data of glyphs of
26944 the composition for the current face font, calculate them
26945 now. Theoretically, we have to check all fonts for the
26946 glyphs, but that requires much time and memory space. So,
26947 here we check only the font of the first glyph. This may
26948 lead to incorrect display, but it's very rare, and C-l
26949 (recenter-top-bottom) can correct the display anyway. */
26950 if (! cmp
->font
|| cmp
->font
!= font
)
26952 /* Ascent and descent of the font of the first character
26953 of this composition (adjusted by baseline offset).
26954 Ascent and descent of overall glyphs should not be less
26955 than these, respectively. */
26956 int font_ascent
, font_descent
, font_height
;
26957 /* Bounding box of the overall glyphs. */
26958 int leftmost
, rightmost
, lowest
, highest
;
26959 int lbearing
, rbearing
;
26960 int i
, width
, ascent
, descent
;
26961 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26963 struct font_metrics
*pcm
;
26966 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26967 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26969 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26970 for (i
= 0; i
< glyph_len
; i
++)
26972 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26974 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26976 bool left_padded
= i
> 0;
26978 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26979 : IT_CHARPOS (*it
));
26980 /* If no suitable font is found, use the default font. */
26981 bool font_not_found_p
= font
== NULL
;
26982 if (font_not_found_p
)
26984 face
= face
->ascii_face
;
26987 boff
= font
->baseline_offset
;
26988 if (font
->vertical_centering
)
26989 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26990 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26991 font_ascent
+= boff
;
26992 font_descent
-= boff
;
26993 font_height
= font_ascent
+ font_descent
;
26998 if (! font_not_found_p
)
27000 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27002 pcm
= get_per_char_metric (font
, &char2b
);
27005 /* Initialize the bounding box. */
27008 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27009 ascent
= pcm
->ascent
;
27010 descent
= pcm
->descent
;
27011 lbearing
= pcm
->lbearing
;
27012 rbearing
= pcm
->rbearing
;
27016 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27017 ascent
= FONT_BASE (font
);
27018 descent
= FONT_DESCENT (font
);
27025 lowest
= - descent
+ boff
;
27026 highest
= ascent
+ boff
;
27028 if (! font_not_found_p
27029 && font
->default_ascent
27030 && CHAR_TABLE_P (Vuse_default_ascent
)
27031 && !NILP (Faref (Vuse_default_ascent
,
27032 make_number (it
->char_to_display
))))
27033 highest
= font
->default_ascent
+ boff
;
27035 /* Draw the first glyph at the normal position. It may be
27036 shifted to right later if some other glyphs are drawn
27038 cmp
->offsets
[i
* 2] = 0;
27039 cmp
->offsets
[i
* 2 + 1] = boff
;
27040 cmp
->lbearing
= lbearing
;
27041 cmp
->rbearing
= rbearing
;
27043 /* Set cmp->offsets for the remaining glyphs. */
27044 for (i
++; i
< glyph_len
; i
++)
27046 int left
, right
, btm
, top
;
27047 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27049 struct face
*this_face
;
27053 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27054 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27055 font
= this_face
->font
;
27061 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27063 pcm
= get_per_char_metric (font
, &char2b
);
27066 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27069 width
= pcm
->width
;
27070 ascent
= pcm
->ascent
;
27071 descent
= pcm
->descent
;
27072 lbearing
= pcm
->lbearing
;
27073 rbearing
= pcm
->rbearing
;
27074 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27076 /* Relative composition with or without
27077 alternate chars. */
27078 left
= (leftmost
+ rightmost
- width
) / 2;
27079 btm
= - descent
+ boff
;
27080 if (font
->relative_compose
27081 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27082 || NILP (Faref (Vignore_relative_composition
,
27083 make_number (ch
)))))
27086 if (- descent
>= font
->relative_compose
)
27087 /* One extra pixel between two glyphs. */
27089 else if (ascent
<= 0)
27090 /* One extra pixel between two glyphs. */
27091 btm
= lowest
- 1 - ascent
- descent
;
27096 /* A composition rule is specified by an integer
27097 value that encodes global and new reference
27098 points (GREF and NREF). GREF and NREF are
27099 specified by numbers as below:
27101 0---1---2 -- ascent
27105 9--10--11 -- center
27107 ---3---4---5--- baseline
27109 6---7---8 -- descent
27111 int rule
= COMPOSITION_RULE (cmp
, i
);
27112 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27114 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27115 grefx
= gref
% 3, nrefx
= nref
% 3;
27116 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27118 xoff
= font_height
* (xoff
- 128) / 256;
27120 yoff
= font_height
* (yoff
- 128) / 256;
27123 + grefx
* (rightmost
- leftmost
) / 2
27124 - nrefx
* width
/ 2
27127 btm
= ((grefy
== 0 ? highest
27129 : grefy
== 2 ? lowest
27130 : (highest
+ lowest
) / 2)
27131 - (nrefy
== 0 ? ascent
+ descent
27132 : nrefy
== 1 ? descent
- boff
27134 : (ascent
+ descent
) / 2)
27138 cmp
->offsets
[i
* 2] = left
;
27139 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27141 /* Update the bounding box of the overall glyphs. */
27144 right
= left
+ width
;
27145 if (left
< leftmost
)
27147 if (right
> rightmost
)
27150 top
= btm
+ descent
+ ascent
;
27156 if (cmp
->lbearing
> left
+ lbearing
)
27157 cmp
->lbearing
= left
+ lbearing
;
27158 if (cmp
->rbearing
< left
+ rbearing
)
27159 cmp
->rbearing
= left
+ rbearing
;
27163 /* If there are glyphs whose x-offsets are negative,
27164 shift all glyphs to the right and make all x-offsets
27168 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27169 cmp
->offsets
[i
* 2] -= leftmost
;
27170 rightmost
-= leftmost
;
27171 cmp
->lbearing
-= leftmost
;
27172 cmp
->rbearing
-= leftmost
;
27175 if (left_padded
&& cmp
->lbearing
< 0)
27177 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27178 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27179 rightmost
-= cmp
->lbearing
;
27180 cmp
->rbearing
-= cmp
->lbearing
;
27183 if (right_padded
&& rightmost
< cmp
->rbearing
)
27185 rightmost
= cmp
->rbearing
;
27188 cmp
->pixel_width
= rightmost
;
27189 cmp
->ascent
= highest
;
27190 cmp
->descent
= - lowest
;
27191 if (cmp
->ascent
< font_ascent
)
27192 cmp
->ascent
= font_ascent
;
27193 if (cmp
->descent
< font_descent
)
27194 cmp
->descent
= font_descent
;
27198 && (cmp
->lbearing
< 0
27199 || cmp
->rbearing
> cmp
->pixel_width
))
27200 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27202 it
->pixel_width
= cmp
->pixel_width
;
27203 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27204 it
->descent
= it
->phys_descent
= cmp
->descent
;
27205 if (face
->box
!= FACE_NO_BOX
)
27207 int thick
= face
->box_line_width
;
27211 it
->ascent
+= thick
;
27212 it
->descent
+= thick
;
27217 if (it
->start_of_box_run_p
)
27218 it
->pixel_width
+= thick
;
27219 if (it
->end_of_box_run_p
)
27220 it
->pixel_width
+= thick
;
27223 /* If face has an overline, add the height of the overline
27224 (1 pixel) and a 1 pixel margin to the character height. */
27225 if (face
->overline_p
)
27226 it
->ascent
+= overline_margin
;
27228 take_vertical_position_into_account (it
);
27229 if (it
->ascent
< 0)
27231 if (it
->descent
< 0)
27234 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27235 append_composite_glyph (it
);
27237 else if (it
->what
== IT_COMPOSITION
)
27239 /* A dynamic (automatic) composition. */
27240 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27241 Lisp_Object gstring
;
27242 struct font_metrics metrics
;
27246 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27248 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27251 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27252 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27253 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27254 it
->descent
= it
->phys_descent
= metrics
.descent
;
27255 if (face
->box
!= FACE_NO_BOX
)
27257 int thick
= face
->box_line_width
;
27261 it
->ascent
+= thick
;
27262 it
->descent
+= thick
;
27267 if (it
->start_of_box_run_p
)
27268 it
->pixel_width
+= thick
;
27269 if (it
->end_of_box_run_p
)
27270 it
->pixel_width
+= thick
;
27272 /* If face has an overline, add the height of the overline
27273 (1 pixel) and a 1 pixel margin to the character height. */
27274 if (face
->overline_p
)
27275 it
->ascent
+= overline_margin
;
27276 take_vertical_position_into_account (it
);
27277 if (it
->ascent
< 0)
27279 if (it
->descent
< 0)
27283 append_composite_glyph (it
);
27285 else if (it
->what
== IT_GLYPHLESS
)
27286 produce_glyphless_glyph (it
, false, Qnil
);
27287 else if (it
->what
== IT_IMAGE
)
27288 produce_image_glyph (it
);
27289 else if (it
->what
== IT_STRETCH
)
27290 produce_stretch_glyph (it
);
27293 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27294 because this isn't true for images with `:ascent 100'. */
27295 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27296 if (it
->area
== TEXT_AREA
)
27297 it
->current_x
+= it
->pixel_width
;
27299 if (extra_line_spacing
> 0)
27301 it
->descent
+= extra_line_spacing
;
27302 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27303 it
->max_extra_line_spacing
= extra_line_spacing
;
27306 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27307 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27308 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27309 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27313 Output LEN glyphs starting at START at the nominal cursor position.
27314 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27315 being updated, and UPDATED_AREA is the area of that row being updated. */
27318 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27319 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27321 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27323 eassert (updated_row
);
27324 /* When the window is hscrolled, cursor hpos can legitimately be out
27325 of bounds, but we draw the cursor at the corresponding window
27326 margin in that case. */
27327 if (!updated_row
->reversed_p
&& chpos
< 0)
27329 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27330 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27334 /* Write glyphs. */
27336 hpos
= start
- updated_row
->glyphs
[updated_area
];
27337 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27338 updated_row
, updated_area
,
27340 DRAW_NORMAL_TEXT
, 0);
27342 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27343 if (updated_area
== TEXT_AREA
27344 && w
->phys_cursor_on_p
27345 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27347 && chpos
< hpos
+ len
)
27348 w
->phys_cursor_on_p
= false;
27352 /* Advance the output cursor. */
27353 w
->output_cursor
.hpos
+= len
;
27354 w
->output_cursor
.x
= x
;
27359 Insert LEN glyphs from START at the nominal cursor position. */
27362 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27363 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27366 int line_height
, shift_by_width
, shifted_region_width
;
27367 struct glyph_row
*row
;
27368 struct glyph
*glyph
;
27369 int frame_x
, frame_y
;
27372 eassert (updated_row
);
27374 f
= XFRAME (WINDOW_FRAME (w
));
27376 /* Get the height of the line we are in. */
27378 line_height
= row
->height
;
27380 /* Get the width of the glyphs to insert. */
27381 shift_by_width
= 0;
27382 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27383 shift_by_width
+= glyph
->pixel_width
;
27385 /* Get the width of the region to shift right. */
27386 shifted_region_width
= (window_box_width (w
, updated_area
)
27387 - w
->output_cursor
.x
27391 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27392 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27394 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27395 line_height
, shift_by_width
);
27397 /* Write the glyphs. */
27398 hpos
= start
- row
->glyphs
[updated_area
];
27399 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27401 DRAW_NORMAL_TEXT
, 0);
27403 /* Advance the output cursor. */
27404 w
->output_cursor
.hpos
+= len
;
27405 w
->output_cursor
.x
+= shift_by_width
;
27411 Erase the current text line from the nominal cursor position
27412 (inclusive) to pixel column TO_X (exclusive). The idea is that
27413 everything from TO_X onward is already erased.
27415 TO_X is a pixel position relative to UPDATED_AREA of currently
27416 updated window W. TO_X == -1 means clear to the end of this area. */
27419 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27420 enum glyph_row_area updated_area
, int to_x
)
27423 int max_x
, min_y
, max_y
;
27424 int from_x
, from_y
, to_y
;
27426 eassert (updated_row
);
27427 f
= XFRAME (w
->frame
);
27429 if (updated_row
->full_width_p
)
27430 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27431 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27433 max_x
= window_box_width (w
, updated_area
);
27434 max_y
= window_text_bottom_y (w
);
27436 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27437 of window. For TO_X > 0, truncate to end of drawing area. */
27443 to_x
= min (to_x
, max_x
);
27445 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27447 /* Notice if the cursor will be cleared by this operation. */
27448 if (!updated_row
->full_width_p
)
27449 notice_overwritten_cursor (w
, updated_area
,
27450 w
->output_cursor
.x
, -1,
27452 MATRIX_ROW_BOTTOM_Y (updated_row
));
27454 from_x
= w
->output_cursor
.x
;
27456 /* Translate to frame coordinates. */
27457 if (updated_row
->full_width_p
)
27459 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27460 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27464 int area_left
= window_box_left (w
, updated_area
);
27465 from_x
+= area_left
;
27469 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27470 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27471 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27473 /* Prevent inadvertently clearing to end of the X window. */
27474 if (to_x
> from_x
&& to_y
> from_y
)
27477 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27478 to_x
- from_x
, to_y
- from_y
);
27483 #endif /* HAVE_WINDOW_SYSTEM */
27487 /***********************************************************************
27489 ***********************************************************************/
27491 /* Value is the internal representation of the specified cursor type
27492 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27493 of the bar cursor. */
27495 static enum text_cursor_kinds
27496 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27498 enum text_cursor_kinds type
;
27503 if (EQ (arg
, Qbox
))
27504 return FILLED_BOX_CURSOR
;
27506 if (EQ (arg
, Qhollow
))
27507 return HOLLOW_BOX_CURSOR
;
27509 if (EQ (arg
, Qbar
))
27516 && EQ (XCAR (arg
), Qbar
)
27517 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27519 *width
= XINT (XCDR (arg
));
27523 if (EQ (arg
, Qhbar
))
27526 return HBAR_CURSOR
;
27530 && EQ (XCAR (arg
), Qhbar
)
27531 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27533 *width
= XINT (XCDR (arg
));
27534 return HBAR_CURSOR
;
27537 /* Treat anything unknown as "hollow box cursor".
27538 It was bad to signal an error; people have trouble fixing
27539 .Xdefaults with Emacs, when it has something bad in it. */
27540 type
= HOLLOW_BOX_CURSOR
;
27545 /* Set the default cursor types for specified frame. */
27547 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27552 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27553 FRAME_CURSOR_WIDTH (f
) = width
;
27555 /* By default, set up the blink-off state depending on the on-state. */
27557 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27560 FRAME_BLINK_OFF_CURSOR (f
)
27561 = get_specified_cursor_type (XCDR (tem
), &width
);
27562 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27565 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27567 /* Make sure the cursor gets redrawn. */
27568 f
->cursor_type_changed
= true;
27572 #ifdef HAVE_WINDOW_SYSTEM
27574 /* Return the cursor we want to be displayed in window W. Return
27575 width of bar/hbar cursor through WIDTH arg. Return with
27576 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27577 (i.e. if the `system caret' should track this cursor).
27579 In a mini-buffer window, we want the cursor only to appear if we
27580 are reading input from this window. For the selected window, we
27581 want the cursor type given by the frame parameter or buffer local
27582 setting of cursor-type. If explicitly marked off, draw no cursor.
27583 In all other cases, we want a hollow box cursor. */
27585 static enum text_cursor_kinds
27586 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27587 bool *active_cursor
)
27589 struct frame
*f
= XFRAME (w
->frame
);
27590 struct buffer
*b
= XBUFFER (w
->contents
);
27591 int cursor_type
= DEFAULT_CURSOR
;
27592 Lisp_Object alt_cursor
;
27593 bool non_selected
= false;
27595 *active_cursor
= true;
27598 if (cursor_in_echo_area
27599 && FRAME_HAS_MINIBUF_P (f
)
27600 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27602 if (w
== XWINDOW (echo_area_window
))
27604 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27606 *width
= FRAME_CURSOR_WIDTH (f
);
27607 return FRAME_DESIRED_CURSOR (f
);
27610 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27613 *active_cursor
= false;
27614 non_selected
= true;
27617 /* Detect a nonselected window or nonselected frame. */
27618 else if (w
!= XWINDOW (f
->selected_window
)
27619 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27621 *active_cursor
= false;
27623 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27626 non_selected
= true;
27629 /* Never display a cursor in a window in which cursor-type is nil. */
27630 if (NILP (BVAR (b
, cursor_type
)))
27633 /* Get the normal cursor type for this window. */
27634 if (EQ (BVAR (b
, cursor_type
), Qt
))
27636 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27637 *width
= FRAME_CURSOR_WIDTH (f
);
27640 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27642 /* Use cursor-in-non-selected-windows instead
27643 for non-selected window or frame. */
27646 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27647 if (!EQ (Qt
, alt_cursor
))
27648 return get_specified_cursor_type (alt_cursor
, width
);
27649 /* t means modify the normal cursor type. */
27650 if (cursor_type
== FILLED_BOX_CURSOR
)
27651 cursor_type
= HOLLOW_BOX_CURSOR
;
27652 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27654 return cursor_type
;
27657 /* Use normal cursor if not blinked off. */
27658 if (!w
->cursor_off_p
)
27660 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27662 if (cursor_type
== FILLED_BOX_CURSOR
)
27664 /* Using a block cursor on large images can be very annoying.
27665 So use a hollow cursor for "large" images.
27666 If image is not transparent (no mask), also use hollow cursor. */
27667 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27668 if (img
!= NULL
&& IMAGEP (img
->spec
))
27670 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27671 where N = size of default frame font size.
27672 This should cover most of the "tiny" icons people may use. */
27674 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27675 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27676 cursor_type
= HOLLOW_BOX_CURSOR
;
27679 else if (cursor_type
!= NO_CURSOR
)
27681 /* Display current only supports BOX and HOLLOW cursors for images.
27682 So for now, unconditionally use a HOLLOW cursor when cursor is
27683 not a solid box cursor. */
27684 cursor_type
= HOLLOW_BOX_CURSOR
;
27687 return cursor_type
;
27690 /* Cursor is blinked off, so determine how to "toggle" it. */
27692 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27693 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27694 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27696 /* Then see if frame has specified a specific blink off cursor type. */
27697 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27699 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27700 return FRAME_BLINK_OFF_CURSOR (f
);
27704 /* Some people liked having a permanently visible blinking cursor,
27705 while others had very strong opinions against it. So it was
27706 decided to remove it. KFS 2003-09-03 */
27708 /* Finally perform built-in cursor blinking:
27709 filled box <-> hollow box
27710 wide [h]bar <-> narrow [h]bar
27711 narrow [h]bar <-> no cursor
27712 other type <-> no cursor */
27714 if (cursor_type
== FILLED_BOX_CURSOR
)
27715 return HOLLOW_BOX_CURSOR
;
27717 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27720 return cursor_type
;
27728 /* Notice when the text cursor of window W has been completely
27729 overwritten by a drawing operation that outputs glyphs in AREA
27730 starting at X0 and ending at X1 in the line starting at Y0 and
27731 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27732 the rest of the line after X0 has been written. Y coordinates
27733 are window-relative. */
27736 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27737 int x0
, int x1
, int y0
, int y1
)
27739 int cx0
, cx1
, cy0
, cy1
;
27740 struct glyph_row
*row
;
27742 if (!w
->phys_cursor_on_p
)
27744 if (area
!= TEXT_AREA
)
27747 if (w
->phys_cursor
.vpos
< 0
27748 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27749 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27750 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27753 if (row
->cursor_in_fringe_p
)
27755 row
->cursor_in_fringe_p
= false;
27756 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27757 w
->phys_cursor_on_p
= false;
27761 cx0
= w
->phys_cursor
.x
;
27762 cx1
= cx0
+ w
->phys_cursor_width
;
27763 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27766 /* The cursor image will be completely removed from the
27767 screen if the output area intersects the cursor area in
27768 y-direction. When we draw in [y0 y1[, and some part of
27769 the cursor is at y < y0, that part must have been drawn
27770 before. When scrolling, the cursor is erased before
27771 actually scrolling, so we don't come here. When not
27772 scrolling, the rows above the old cursor row must have
27773 changed, and in this case these rows must have written
27774 over the cursor image.
27776 Likewise if part of the cursor is below y1, with the
27777 exception of the cursor being in the first blank row at
27778 the buffer and window end because update_text_area
27779 doesn't draw that row. (Except when it does, but
27780 that's handled in update_text_area.) */
27782 cy0
= w
->phys_cursor
.y
;
27783 cy1
= cy0
+ w
->phys_cursor_height
;
27784 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27787 w
->phys_cursor_on_p
= false;
27790 #endif /* HAVE_WINDOW_SYSTEM */
27793 /************************************************************************
27795 ************************************************************************/
27797 #ifdef HAVE_WINDOW_SYSTEM
27800 Fix the display of area AREA of overlapping row ROW in window W
27801 with respect to the overlapping part OVERLAPS. */
27804 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27805 enum glyph_row_area area
, int overlaps
)
27812 for (i
= 0; i
< row
->used
[area
];)
27814 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27816 int start
= i
, start_x
= x
;
27820 x
+= row
->glyphs
[area
][i
].pixel_width
;
27823 while (i
< row
->used
[area
]
27824 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27826 draw_glyphs (w
, start_x
, row
, area
,
27828 DRAW_NORMAL_TEXT
, overlaps
);
27832 x
+= row
->glyphs
[area
][i
].pixel_width
;
27842 Draw the cursor glyph of window W in glyph row ROW. See the
27843 comment of draw_glyphs for the meaning of HL. */
27846 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27847 enum draw_glyphs_face hl
)
27849 /* If cursor hpos is out of bounds, don't draw garbage. This can
27850 happen in mini-buffer windows when switching between echo area
27851 glyphs and mini-buffer. */
27852 if ((row
->reversed_p
27853 ? (w
->phys_cursor
.hpos
>= 0)
27854 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27856 bool on_p
= w
->phys_cursor_on_p
;
27858 int hpos
= w
->phys_cursor
.hpos
;
27860 /* When the window is hscrolled, cursor hpos can legitimately be
27861 out of bounds, but we draw the cursor at the corresponding
27862 window margin in that case. */
27863 if (!row
->reversed_p
&& hpos
< 0)
27865 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27866 hpos
= row
->used
[TEXT_AREA
] - 1;
27868 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27870 w
->phys_cursor_on_p
= on_p
;
27872 if (hl
== DRAW_CURSOR
)
27873 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27874 /* When we erase the cursor, and ROW is overlapped by other
27875 rows, make sure that these overlapping parts of other rows
27877 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27879 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27881 if (row
> w
->current_matrix
->rows
27882 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27883 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27884 OVERLAPS_ERASED_CURSOR
);
27886 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27887 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27888 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27889 OVERLAPS_ERASED_CURSOR
);
27895 /* Erase the image of a cursor of window W from the screen. */
27898 erase_phys_cursor (struct window
*w
)
27900 struct frame
*f
= XFRAME (w
->frame
);
27901 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27902 int hpos
= w
->phys_cursor
.hpos
;
27903 int vpos
= w
->phys_cursor
.vpos
;
27904 bool mouse_face_here_p
= false;
27905 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27906 struct glyph_row
*cursor_row
;
27907 struct glyph
*cursor_glyph
;
27908 enum draw_glyphs_face hl
;
27910 /* No cursor displayed or row invalidated => nothing to do on the
27912 if (w
->phys_cursor_type
== NO_CURSOR
)
27913 goto mark_cursor_off
;
27915 /* VPOS >= active_glyphs->nrows means that window has been resized.
27916 Don't bother to erase the cursor. */
27917 if (vpos
>= active_glyphs
->nrows
)
27918 goto mark_cursor_off
;
27920 /* If row containing cursor is marked invalid, there is nothing we
27922 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27923 if (!cursor_row
->enabled_p
)
27924 goto mark_cursor_off
;
27926 /* If line spacing is > 0, old cursor may only be partially visible in
27927 window after split-window. So adjust visible height. */
27928 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27929 window_text_bottom_y (w
) - cursor_row
->y
);
27931 /* If row is completely invisible, don't attempt to delete a cursor which
27932 isn't there. This can happen if cursor is at top of a window, and
27933 we switch to a buffer with a header line in that window. */
27934 if (cursor_row
->visible_height
<= 0)
27935 goto mark_cursor_off
;
27937 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27938 if (cursor_row
->cursor_in_fringe_p
)
27940 cursor_row
->cursor_in_fringe_p
= false;
27941 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27942 goto mark_cursor_off
;
27945 /* This can happen when the new row is shorter than the old one.
27946 In this case, either draw_glyphs or clear_end_of_line
27947 should have cleared the cursor. Note that we wouldn't be
27948 able to erase the cursor in this case because we don't have a
27949 cursor glyph at hand. */
27950 if ((cursor_row
->reversed_p
27951 ? (w
->phys_cursor
.hpos
< 0)
27952 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27953 goto mark_cursor_off
;
27955 /* When the window is hscrolled, cursor hpos can legitimately be out
27956 of bounds, but we draw the cursor at the corresponding window
27957 margin in that case. */
27958 if (!cursor_row
->reversed_p
&& hpos
< 0)
27960 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27961 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27963 /* If the cursor is in the mouse face area, redisplay that when
27964 we clear the cursor. */
27965 if (! NILP (hlinfo
->mouse_face_window
)
27966 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27967 /* Don't redraw the cursor's spot in mouse face if it is at the
27968 end of a line (on a newline). The cursor appears there, but
27969 mouse highlighting does not. */
27970 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27971 mouse_face_here_p
= true;
27973 /* Maybe clear the display under the cursor. */
27974 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27977 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27980 cursor_glyph
= get_phys_cursor_glyph (w
);
27981 if (cursor_glyph
== NULL
)
27982 goto mark_cursor_off
;
27984 width
= cursor_glyph
->pixel_width
;
27985 x
= w
->phys_cursor
.x
;
27991 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27992 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27993 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27996 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27999 /* Erase the cursor by redrawing the character underneath it. */
28000 if (mouse_face_here_p
)
28001 hl
= DRAW_MOUSE_FACE
;
28003 hl
= DRAW_NORMAL_TEXT
;
28004 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28007 w
->phys_cursor_on_p
= false;
28008 w
->phys_cursor_type
= NO_CURSOR
;
28012 /* Display or clear cursor of window W. If !ON, clear the cursor.
28013 If ON, display the cursor; where to put the cursor is specified by
28014 HPOS, VPOS, X and Y. */
28017 display_and_set_cursor (struct window
*w
, bool on
,
28018 int hpos
, int vpos
, int x
, int y
)
28020 struct frame
*f
= XFRAME (w
->frame
);
28021 int new_cursor_type
;
28022 int new_cursor_width
;
28023 bool active_cursor
;
28024 struct glyph_row
*glyph_row
;
28025 struct glyph
*glyph
;
28027 /* This is pointless on invisible frames, and dangerous on garbaged
28028 windows and frames; in the latter case, the frame or window may
28029 be in the midst of changing its size, and x and y may be off the
28031 if (! FRAME_VISIBLE_P (f
)
28032 || FRAME_GARBAGED_P (f
)
28033 || vpos
>= w
->current_matrix
->nrows
28034 || hpos
>= w
->current_matrix
->matrix_w
)
28037 /* If cursor is off and we want it off, return quickly. */
28038 if (!on
&& !w
->phys_cursor_on_p
)
28041 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28042 /* If cursor row is not enabled, we don't really know where to
28043 display the cursor. */
28044 if (!glyph_row
->enabled_p
)
28046 w
->phys_cursor_on_p
= false;
28051 if (!glyph_row
->exact_window_width_line_p
28052 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28053 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28055 eassert (input_blocked_p ());
28057 /* Set new_cursor_type to the cursor we want to be displayed. */
28058 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28059 &new_cursor_width
, &active_cursor
);
28061 /* If cursor is currently being shown and we don't want it to be or
28062 it is in the wrong place, or the cursor type is not what we want,
28064 if (w
->phys_cursor_on_p
28066 || w
->phys_cursor
.x
!= x
28067 || w
->phys_cursor
.y
!= y
28068 /* HPOS can be negative in R2L rows whose
28069 exact_window_width_line_p flag is set (i.e. their newline
28070 would "overflow into the fringe"). */
28072 || new_cursor_type
!= w
->phys_cursor_type
28073 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28074 && new_cursor_width
!= w
->phys_cursor_width
)))
28075 erase_phys_cursor (w
);
28077 /* Don't check phys_cursor_on_p here because that flag is only set
28078 to false in some cases where we know that the cursor has been
28079 completely erased, to avoid the extra work of erasing the cursor
28080 twice. In other words, phys_cursor_on_p can be true and the cursor
28081 still not be visible, or it has only been partly erased. */
28084 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28085 w
->phys_cursor_height
= glyph_row
->height
;
28087 /* Set phys_cursor_.* before x_draw_.* is called because some
28088 of them may need the information. */
28089 w
->phys_cursor
.x
= x
;
28090 w
->phys_cursor
.y
= glyph_row
->y
;
28091 w
->phys_cursor
.hpos
= hpos
;
28092 w
->phys_cursor
.vpos
= vpos
;
28095 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28096 new_cursor_type
, new_cursor_width
,
28097 on
, active_cursor
);
28101 /* Switch the display of W's cursor on or off, according to the value
28105 update_window_cursor (struct window
*w
, bool on
)
28107 /* Don't update cursor in windows whose frame is in the process
28108 of being deleted. */
28109 if (w
->current_matrix
)
28111 int hpos
= w
->phys_cursor
.hpos
;
28112 int vpos
= w
->phys_cursor
.vpos
;
28113 struct glyph_row
*row
;
28115 if (vpos
>= w
->current_matrix
->nrows
28116 || hpos
>= w
->current_matrix
->matrix_w
)
28119 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28121 /* When the window is hscrolled, cursor hpos can legitimately be
28122 out of bounds, but we draw the cursor at the corresponding
28123 window margin in that case. */
28124 if (!row
->reversed_p
&& hpos
< 0)
28126 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28127 hpos
= row
->used
[TEXT_AREA
] - 1;
28130 display_and_set_cursor (w
, on
, hpos
, vpos
,
28131 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28137 /* Call update_window_cursor with parameter ON_P on all leaf windows
28138 in the window tree rooted at W. */
28141 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28145 if (WINDOWP (w
->contents
))
28146 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28148 update_window_cursor (w
, on_p
);
28150 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28156 Display the cursor on window W, or clear it, according to ON_P.
28157 Don't change the cursor's position. */
28160 x_update_cursor (struct frame
*f
, bool on_p
)
28162 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28167 Clear the cursor of window W to background color, and mark the
28168 cursor as not shown. This is used when the text where the cursor
28169 is about to be rewritten. */
28172 x_clear_cursor (struct window
*w
)
28174 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28175 update_window_cursor (w
, false);
28178 #endif /* HAVE_WINDOW_SYSTEM */
28180 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28183 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28184 int start_hpos
, int end_hpos
,
28185 enum draw_glyphs_face draw
)
28187 #ifdef HAVE_WINDOW_SYSTEM
28188 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28190 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28194 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28195 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28199 /* Display the active region described by mouse_face_* according to DRAW. */
28202 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28204 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28205 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28207 if (/* If window is in the process of being destroyed, don't bother
28209 w
->current_matrix
!= NULL
28210 /* Don't update mouse highlight if hidden. */
28211 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28212 /* Recognize when we are called to operate on rows that don't exist
28213 anymore. This can happen when a window is split. */
28214 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28216 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28217 struct glyph_row
*row
, *first
, *last
;
28219 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28220 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28222 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28224 int start_hpos
, end_hpos
, start_x
;
28226 /* For all but the first row, the highlight starts at column 0. */
28229 /* R2L rows have BEG and END in reversed order, but the
28230 screen drawing geometry is always left to right. So
28231 we need to mirror the beginning and end of the
28232 highlighted area in R2L rows. */
28233 if (!row
->reversed_p
)
28235 start_hpos
= hlinfo
->mouse_face_beg_col
;
28236 start_x
= hlinfo
->mouse_face_beg_x
;
28238 else if (row
== last
)
28240 start_hpos
= hlinfo
->mouse_face_end_col
;
28241 start_x
= hlinfo
->mouse_face_end_x
;
28249 else if (row
->reversed_p
&& row
== last
)
28251 start_hpos
= hlinfo
->mouse_face_end_col
;
28252 start_x
= hlinfo
->mouse_face_end_x
;
28262 if (!row
->reversed_p
)
28263 end_hpos
= hlinfo
->mouse_face_end_col
;
28264 else if (row
== first
)
28265 end_hpos
= hlinfo
->mouse_face_beg_col
;
28268 end_hpos
= row
->used
[TEXT_AREA
];
28269 if (draw
== DRAW_NORMAL_TEXT
)
28270 row
->fill_line_p
= true; /* Clear to end of line. */
28273 else if (row
->reversed_p
&& row
== first
)
28274 end_hpos
= hlinfo
->mouse_face_beg_col
;
28277 end_hpos
= row
->used
[TEXT_AREA
];
28278 if (draw
== DRAW_NORMAL_TEXT
)
28279 row
->fill_line_p
= true; /* Clear to end of line. */
28282 if (end_hpos
> start_hpos
)
28284 draw_row_with_mouse_face (w
, start_x
, row
,
28285 start_hpos
, end_hpos
, draw
);
28288 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28292 #ifdef HAVE_WINDOW_SYSTEM
28293 /* When we've written over the cursor, arrange for it to
28294 be displayed again. */
28295 if (FRAME_WINDOW_P (f
)
28296 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28298 int hpos
= w
->phys_cursor
.hpos
;
28300 /* When the window is hscrolled, cursor hpos can legitimately be
28301 out of bounds, but we draw the cursor at the corresponding
28302 window margin in that case. */
28303 if (!row
->reversed_p
&& hpos
< 0)
28305 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28306 hpos
= row
->used
[TEXT_AREA
] - 1;
28309 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28310 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28313 #endif /* HAVE_WINDOW_SYSTEM */
28316 #ifdef HAVE_WINDOW_SYSTEM
28317 /* Change the mouse cursor. */
28318 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28320 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28321 if (draw
== DRAW_NORMAL_TEXT
28322 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28323 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28326 if (draw
== DRAW_MOUSE_FACE
)
28327 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28329 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28331 #endif /* HAVE_WINDOW_SYSTEM */
28335 Clear out the mouse-highlighted active region.
28336 Redraw it un-highlighted first. Value is true if mouse
28337 face was actually drawn unhighlighted. */
28340 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28343 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28345 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28346 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28347 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28348 hlinfo
->mouse_face_window
= Qnil
;
28349 hlinfo
->mouse_face_overlay
= Qnil
;
28353 /* Return true if the coordinates HPOS and VPOS on windows W are
28354 within the mouse face on that window. */
28356 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28358 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28360 /* Quickly resolve the easy cases. */
28361 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28362 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28364 if (vpos
< hlinfo
->mouse_face_beg_row
28365 || vpos
> hlinfo
->mouse_face_end_row
)
28367 if (vpos
> hlinfo
->mouse_face_beg_row
28368 && vpos
< hlinfo
->mouse_face_end_row
)
28371 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28373 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28375 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28378 else if ((vpos
== hlinfo
->mouse_face_beg_row
28379 && hpos
>= hlinfo
->mouse_face_beg_col
)
28380 || (vpos
== hlinfo
->mouse_face_end_row
28381 && hpos
< hlinfo
->mouse_face_end_col
))
28386 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28388 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28391 else if ((vpos
== hlinfo
->mouse_face_beg_row
28392 && hpos
<= hlinfo
->mouse_face_beg_col
)
28393 || (vpos
== hlinfo
->mouse_face_end_row
28394 && hpos
> hlinfo
->mouse_face_end_col
))
28402 True if physical cursor of window W is within mouse face. */
28405 cursor_in_mouse_face_p (struct window
*w
)
28407 int hpos
= w
->phys_cursor
.hpos
;
28408 int vpos
= w
->phys_cursor
.vpos
;
28409 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28411 /* When the window is hscrolled, cursor hpos can legitimately be out
28412 of bounds, but we draw the cursor at the corresponding window
28413 margin in that case. */
28414 if (!row
->reversed_p
&& hpos
< 0)
28416 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28417 hpos
= row
->used
[TEXT_AREA
] - 1;
28419 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28424 /* Find the glyph rows START_ROW and END_ROW of window W that display
28425 characters between buffer positions START_CHARPOS and END_CHARPOS
28426 (excluding END_CHARPOS). DISP_STRING is a display string that
28427 covers these buffer positions. This is similar to
28428 row_containing_pos, but is more accurate when bidi reordering makes
28429 buffer positions change non-linearly with glyph rows. */
28431 rows_from_pos_range (struct window
*w
,
28432 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28433 Lisp_Object disp_string
,
28434 struct glyph_row
**start
, struct glyph_row
**end
)
28436 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28437 int last_y
= window_text_bottom_y (w
);
28438 struct glyph_row
*row
;
28443 while (!first
->enabled_p
28444 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28447 /* Find the START row. */
28449 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28452 /* A row can potentially be the START row if the range of the
28453 characters it displays intersects the range
28454 [START_CHARPOS..END_CHARPOS). */
28455 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28456 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28457 /* See the commentary in row_containing_pos, for the
28458 explanation of the complicated way to check whether
28459 some position is beyond the end of the characters
28460 displayed by a row. */
28461 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28462 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28463 && !row
->ends_at_zv_p
28464 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28465 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28466 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28467 && !row
->ends_at_zv_p
28468 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28470 /* Found a candidate row. Now make sure at least one of the
28471 glyphs it displays has a charpos from the range
28472 [START_CHARPOS..END_CHARPOS).
28474 This is not obvious because bidi reordering could make
28475 buffer positions of a row be 1,2,3,102,101,100, and if we
28476 want to highlight characters in [50..60), we don't want
28477 this row, even though [50..60) does intersect [1..103),
28478 the range of character positions given by the row's start
28479 and end positions. */
28480 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28481 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28485 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28486 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28487 /* A glyph that comes from DISP_STRING is by
28488 definition to be highlighted. */
28489 || EQ (g
->object
, disp_string
))
28498 /* Find the END row. */
28500 /* If the last row is partially visible, start looking for END
28501 from that row, instead of starting from FIRST. */
28502 && !(row
->enabled_p
28503 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28505 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28507 struct glyph_row
*next
= row
+ 1;
28508 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28510 if (!next
->enabled_p
28511 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28512 /* The first row >= START whose range of displayed characters
28513 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28514 is the row END + 1. */
28515 || (start_charpos
< next_start
28516 && end_charpos
< next_start
)
28517 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28518 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28519 && !next
->ends_at_zv_p
28520 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28521 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28522 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28523 && !next
->ends_at_zv_p
28524 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28531 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28532 but none of the characters it displays are in the range, it is
28534 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28535 struct glyph
*s
= g
;
28536 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28540 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28541 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28542 /* If the buffer position of the first glyph in
28543 the row is equal to END_CHARPOS, it means
28544 the last character to be highlighted is the
28545 newline of ROW, and we must consider NEXT as
28547 || (((!next
->reversed_p
&& g
== s
)
28548 || (next
->reversed_p
&& g
== e
- 1))
28549 && (g
->charpos
== end_charpos
28550 /* Special case for when NEXT is an
28551 empty line at ZV. */
28552 || (g
->charpos
== -1
28553 && !row
->ends_at_zv_p
28554 && next_start
== end_charpos
)))))
28555 /* A glyph that comes from DISP_STRING is by
28556 definition to be highlighted. */
28557 || EQ (g
->object
, disp_string
))
28566 /* The first row that ends at ZV must be the last to be
28568 else if (next
->ends_at_zv_p
)
28577 /* This function sets the mouse_face_* elements of HLINFO, assuming
28578 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28579 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28580 for the overlay or run of text properties specifying the mouse
28581 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28582 before-string and after-string that must also be highlighted.
28583 DISP_STRING, if non-nil, is a display string that may cover some
28584 or all of the highlighted text. */
28587 mouse_face_from_buffer_pos (Lisp_Object window
,
28588 Mouse_HLInfo
*hlinfo
,
28589 ptrdiff_t mouse_charpos
,
28590 ptrdiff_t start_charpos
,
28591 ptrdiff_t end_charpos
,
28592 Lisp_Object before_string
,
28593 Lisp_Object after_string
,
28594 Lisp_Object disp_string
)
28596 struct window
*w
= XWINDOW (window
);
28597 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28598 struct glyph_row
*r1
, *r2
;
28599 struct glyph
*glyph
, *end
;
28600 ptrdiff_t ignore
, pos
;
28603 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28604 eassert (NILP (before_string
) || STRINGP (before_string
));
28605 eassert (NILP (after_string
) || STRINGP (after_string
));
28607 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28608 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28610 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28611 /* If the before-string or display-string contains newlines,
28612 rows_from_pos_range skips to its last row. Move back. */
28613 if (!NILP (before_string
) || !NILP (disp_string
))
28615 struct glyph_row
*prev
;
28616 while ((prev
= r1
- 1, prev
>= first
)
28617 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28618 && prev
->used
[TEXT_AREA
] > 0)
28620 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28621 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28622 while (--glyph
>= beg
&& NILP (glyph
->object
));
28624 || !(EQ (glyph
->object
, before_string
)
28625 || EQ (glyph
->object
, disp_string
)))
28632 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28633 hlinfo
->mouse_face_past_end
= true;
28635 else if (!NILP (after_string
))
28637 /* If the after-string has newlines, advance to its last row. */
28638 struct glyph_row
*next
;
28639 struct glyph_row
*last
28640 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28642 for (next
= r2
+ 1;
28644 && next
->used
[TEXT_AREA
] > 0
28645 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28649 /* The rest of the display engine assumes that mouse_face_beg_row is
28650 either above mouse_face_end_row or identical to it. But with
28651 bidi-reordered continued lines, the row for START_CHARPOS could
28652 be below the row for END_CHARPOS. If so, swap the rows and store
28653 them in correct order. */
28656 struct glyph_row
*tem
= r2
;
28662 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28663 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28665 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28666 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28667 could be anywhere in the row and in any order. The strategy
28668 below is to find the leftmost and the rightmost glyph that
28669 belongs to either of these 3 strings, or whose position is
28670 between START_CHARPOS and END_CHARPOS, and highlight all the
28671 glyphs between those two. This may cover more than just the text
28672 between START_CHARPOS and END_CHARPOS if the range of characters
28673 strides the bidi level boundary, e.g. if the beginning is in R2L
28674 text while the end is in L2R text or vice versa. */
28675 if (!r1
->reversed_p
)
28677 /* This row is in a left to right paragraph. Scan it left to
28679 glyph
= r1
->glyphs
[TEXT_AREA
];
28680 end
= glyph
+ r1
->used
[TEXT_AREA
];
28683 /* Skip truncation glyphs at the start of the glyph row. */
28684 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28686 && NILP (glyph
->object
)
28687 && glyph
->charpos
< 0;
28689 x
+= glyph
->pixel_width
;
28691 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28692 or DISP_STRING, and the first glyph from buffer whose
28693 position is between START_CHARPOS and END_CHARPOS. */
28695 && !NILP (glyph
->object
)
28696 && !EQ (glyph
->object
, disp_string
)
28697 && !(BUFFERP (glyph
->object
)
28698 && (glyph
->charpos
>= start_charpos
28699 && glyph
->charpos
< end_charpos
));
28702 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28703 are present at buffer positions between START_CHARPOS and
28704 END_CHARPOS, or if they come from an overlay. */
28705 if (EQ (glyph
->object
, before_string
))
28707 pos
= string_buffer_position (before_string
,
28709 /* If pos == 0, it means before_string came from an
28710 overlay, not from a buffer position. */
28711 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28714 else if (EQ (glyph
->object
, after_string
))
28716 pos
= string_buffer_position (after_string
, end_charpos
);
28717 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28720 x
+= glyph
->pixel_width
;
28722 hlinfo
->mouse_face_beg_x
= x
;
28723 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28727 /* This row is in a right to left paragraph. Scan it right to
28731 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28732 glyph
= end
+ r1
->used
[TEXT_AREA
];
28734 /* Skip truncation glyphs at the start of the glyph row. */
28735 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28737 && NILP (glyph
->object
)
28738 && glyph
->charpos
< 0;
28742 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28743 or DISP_STRING, and the first glyph from buffer whose
28744 position is between START_CHARPOS and END_CHARPOS. */
28746 && !NILP (glyph
->object
)
28747 && !EQ (glyph
->object
, disp_string
)
28748 && !(BUFFERP (glyph
->object
)
28749 && (glyph
->charpos
>= start_charpos
28750 && glyph
->charpos
< end_charpos
));
28753 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28754 are present at buffer positions between START_CHARPOS and
28755 END_CHARPOS, or if they come from an overlay. */
28756 if (EQ (glyph
->object
, before_string
))
28758 pos
= string_buffer_position (before_string
, start_charpos
);
28759 /* If pos == 0, it means before_string came from an
28760 overlay, not from a buffer position. */
28761 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28764 else if (EQ (glyph
->object
, after_string
))
28766 pos
= string_buffer_position (after_string
, end_charpos
);
28767 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28772 glyph
++; /* first glyph to the right of the highlighted area */
28773 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28774 x
+= g
->pixel_width
;
28775 hlinfo
->mouse_face_beg_x
= x
;
28776 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28779 /* If the highlight ends in a different row, compute GLYPH and END
28780 for the end row. Otherwise, reuse the values computed above for
28781 the row where the highlight begins. */
28784 if (!r2
->reversed_p
)
28786 glyph
= r2
->glyphs
[TEXT_AREA
];
28787 end
= glyph
+ r2
->used
[TEXT_AREA
];
28792 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28793 glyph
= end
+ r2
->used
[TEXT_AREA
];
28797 if (!r2
->reversed_p
)
28799 /* Skip truncation and continuation glyphs near the end of the
28800 row, and also blanks and stretch glyphs inserted by
28801 extend_face_to_end_of_line. */
28803 && NILP ((end
- 1)->object
))
28805 /* Scan the rest of the glyph row from the end, looking for the
28806 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28807 DISP_STRING, or whose position is between START_CHARPOS
28811 && !NILP (end
->object
)
28812 && !EQ (end
->object
, disp_string
)
28813 && !(BUFFERP (end
->object
)
28814 && (end
->charpos
>= start_charpos
28815 && end
->charpos
< end_charpos
));
28818 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28819 are present at buffer positions between START_CHARPOS and
28820 END_CHARPOS, or if they come from an overlay. */
28821 if (EQ (end
->object
, before_string
))
28823 pos
= string_buffer_position (before_string
, start_charpos
);
28824 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28827 else if (EQ (end
->object
, after_string
))
28829 pos
= string_buffer_position (after_string
, end_charpos
);
28830 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28834 /* Find the X coordinate of the last glyph to be highlighted. */
28835 for (; glyph
<= end
; ++glyph
)
28836 x
+= glyph
->pixel_width
;
28838 hlinfo
->mouse_face_end_x
= x
;
28839 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28843 /* Skip truncation and continuation glyphs near the end of the
28844 row, and also blanks and stretch glyphs inserted by
28845 extend_face_to_end_of_line. */
28849 && NILP (end
->object
))
28851 x
+= end
->pixel_width
;
28854 /* Scan the rest of the glyph row from the end, looking for the
28855 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28856 DISP_STRING, or whose position is between START_CHARPOS
28860 && !NILP (end
->object
)
28861 && !EQ (end
->object
, disp_string
)
28862 && !(BUFFERP (end
->object
)
28863 && (end
->charpos
>= start_charpos
28864 && end
->charpos
< end_charpos
));
28867 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28868 are present at buffer positions between START_CHARPOS and
28869 END_CHARPOS, or if they come from an overlay. */
28870 if (EQ (end
->object
, before_string
))
28872 pos
= string_buffer_position (before_string
, start_charpos
);
28873 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28876 else if (EQ (end
->object
, after_string
))
28878 pos
= string_buffer_position (after_string
, end_charpos
);
28879 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28882 x
+= end
->pixel_width
;
28884 /* If we exited the above loop because we arrived at the last
28885 glyph of the row, and its buffer position is still not in
28886 range, it means the last character in range is the preceding
28887 newline. Bump the end column and x values to get past the
28890 && BUFFERP (end
->object
)
28891 && (end
->charpos
< start_charpos
28892 || end
->charpos
>= end_charpos
))
28894 x
+= end
->pixel_width
;
28897 hlinfo
->mouse_face_end_x
= x
;
28898 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28901 hlinfo
->mouse_face_window
= window
;
28902 hlinfo
->mouse_face_face_id
28903 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28905 !hlinfo
->mouse_face_hidden
, -1);
28906 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28909 /* The following function is not used anymore (replaced with
28910 mouse_face_from_string_pos), but I leave it here for the time
28911 being, in case someone would. */
28913 #if false /* not used */
28915 /* Find the position of the glyph for position POS in OBJECT in
28916 window W's current matrix, and return in *X, *Y the pixel
28917 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28919 RIGHT_P means return the position of the right edge of the glyph.
28920 !RIGHT_P means return the left edge position.
28922 If no glyph for POS exists in the matrix, return the position of
28923 the glyph with the next smaller position that is in the matrix, if
28924 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28925 exists in the matrix, return the position of the glyph with the
28926 next larger position in OBJECT.
28928 Value is true if a glyph was found. */
28931 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28932 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28934 int yb
= window_text_bottom_y (w
);
28935 struct glyph_row
*r
;
28936 struct glyph
*best_glyph
= NULL
;
28937 struct glyph_row
*best_row
= NULL
;
28940 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28941 r
->enabled_p
&& r
->y
< yb
;
28944 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28945 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28948 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28949 if (EQ (g
->object
, object
))
28951 if (g
->charpos
== pos
)
28958 else if (best_glyph
== NULL
28959 || ((eabs (g
->charpos
- pos
)
28960 < eabs (best_glyph
->charpos
- pos
))
28963 : g
->charpos
> pos
)))
28977 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28981 *x
+= best_glyph
->pixel_width
;
28986 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28989 return best_glyph
!= NULL
;
28991 #endif /* not used */
28993 /* Find the positions of the first and the last glyphs in window W's
28994 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28995 (assumed to be a string), and return in HLINFO's mouse_face_*
28996 members the pixel and column/row coordinates of those glyphs. */
28999 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29000 Lisp_Object object
,
29001 ptrdiff_t startpos
, ptrdiff_t endpos
)
29003 int yb
= window_text_bottom_y (w
);
29004 struct glyph_row
*r
;
29005 struct glyph
*g
, *e
;
29007 bool found
= false;
29009 /* Find the glyph row with at least one position in the range
29010 [STARTPOS..ENDPOS), and the first glyph in that row whose
29011 position belongs to that range. */
29012 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29013 r
->enabled_p
&& r
->y
< yb
;
29016 if (!r
->reversed_p
)
29018 g
= r
->glyphs
[TEXT_AREA
];
29019 e
= g
+ r
->used
[TEXT_AREA
];
29020 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29021 if (EQ (g
->object
, object
)
29022 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29024 hlinfo
->mouse_face_beg_row
29025 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29026 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29027 hlinfo
->mouse_face_beg_x
= gx
;
29036 e
= r
->glyphs
[TEXT_AREA
];
29037 g
= e
+ r
->used
[TEXT_AREA
];
29038 for ( ; g
> e
; --g
)
29039 if (EQ ((g
-1)->object
, object
)
29040 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29042 hlinfo
->mouse_face_beg_row
29043 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29044 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29045 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29046 gx
+= g1
->pixel_width
;
29047 hlinfo
->mouse_face_beg_x
= gx
;
29059 /* Starting with the next row, look for the first row which does NOT
29060 include any glyphs whose positions are in the range. */
29061 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29063 g
= r
->glyphs
[TEXT_AREA
];
29064 e
= g
+ r
->used
[TEXT_AREA
];
29066 for ( ; g
< e
; ++g
)
29067 if (EQ (g
->object
, object
)
29068 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29077 /* The highlighted region ends on the previous row. */
29080 /* Set the end row. */
29081 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29083 /* Compute and set the end column and the end column's horizontal
29084 pixel coordinate. */
29085 if (!r
->reversed_p
)
29087 g
= r
->glyphs
[TEXT_AREA
];
29088 e
= g
+ r
->used
[TEXT_AREA
];
29089 for ( ; e
> g
; --e
)
29090 if (EQ ((e
-1)->object
, object
)
29091 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29093 hlinfo
->mouse_face_end_col
= e
- g
;
29095 for (gx
= r
->x
; g
< e
; ++g
)
29096 gx
+= g
->pixel_width
;
29097 hlinfo
->mouse_face_end_x
= gx
;
29101 e
= r
->glyphs
[TEXT_AREA
];
29102 g
= e
+ r
->used
[TEXT_AREA
];
29103 for (gx
= r
->x
; e
< g
; ++e
)
29105 if (EQ (e
->object
, object
)
29106 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29108 gx
+= e
->pixel_width
;
29110 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29111 hlinfo
->mouse_face_end_x
= gx
;
29115 #ifdef HAVE_WINDOW_SYSTEM
29117 /* See if position X, Y is within a hot-spot of an image. */
29120 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29122 if (!CONSP (hot_spot
))
29125 if (EQ (XCAR (hot_spot
), Qrect
))
29127 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29128 Lisp_Object rect
= XCDR (hot_spot
);
29132 if (!CONSP (XCAR (rect
)))
29134 if (!CONSP (XCDR (rect
)))
29136 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29138 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29140 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29142 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29146 else if (EQ (XCAR (hot_spot
), Qcircle
))
29148 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29149 Lisp_Object circ
= XCDR (hot_spot
);
29150 Lisp_Object lr
, lx0
, ly0
;
29152 && CONSP (XCAR (circ
))
29153 && (lr
= XCDR (circ
), NUMBERP (lr
))
29154 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29155 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29157 double r
= XFLOATINT (lr
);
29158 double dx
= XINT (lx0
) - x
;
29159 double dy
= XINT (ly0
) - y
;
29160 return (dx
* dx
+ dy
* dy
<= r
* r
);
29163 else if (EQ (XCAR (hot_spot
), Qpoly
))
29165 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29166 if (VECTORP (XCDR (hot_spot
)))
29168 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29169 Lisp_Object
*poly
= v
->contents
;
29170 ptrdiff_t n
= v
->header
.size
;
29172 bool inside
= false;
29173 Lisp_Object lx
, ly
;
29176 /* Need an even number of coordinates, and at least 3 edges. */
29177 if (n
< 6 || n
& 1)
29180 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29181 If count is odd, we are inside polygon. Pixels on edges
29182 may or may not be included depending on actual geometry of the
29184 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29185 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29187 x0
= XINT (lx
), y0
= XINT (ly
);
29188 for (i
= 0; i
< n
; i
+= 2)
29190 int x1
= x0
, y1
= y0
;
29191 if ((lx
= poly
[i
], !INTEGERP (lx
))
29192 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29194 x0
= XINT (lx
), y0
= XINT (ly
);
29196 /* Does this segment cross the X line? */
29204 if (y
> y0
&& y
> y1
)
29206 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29216 find_hot_spot (Lisp_Object map
, int x
, int y
)
29218 while (CONSP (map
))
29220 if (CONSP (XCAR (map
))
29221 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29229 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29231 doc
: /* Lookup in image map MAP coordinates X and Y.
29232 An image map is an alist where each element has the format (AREA ID PLIST).
29233 An AREA is specified as either a rectangle, a circle, or a polygon:
29234 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29235 pixel coordinates of the upper left and bottom right corners.
29236 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29237 and the radius of the circle; r may be a float or integer.
29238 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29239 vector describes one corner in the polygon.
29240 Returns the alist element for the first matching AREA in MAP. */)
29241 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29249 return find_hot_spot (map
,
29250 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29251 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29255 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29257 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29259 /* Do not change cursor shape while dragging mouse. */
29260 if (EQ (do_mouse_tracking
, Qdragging
))
29263 if (!NILP (pointer
))
29265 if (EQ (pointer
, Qarrow
))
29266 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29267 else if (EQ (pointer
, Qhand
))
29268 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29269 else if (EQ (pointer
, Qtext
))
29270 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29271 else if (EQ (pointer
, intern ("hdrag")))
29272 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29273 else if (EQ (pointer
, intern ("nhdrag")))
29274 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29275 #ifdef HAVE_X_WINDOWS
29276 else if (EQ (pointer
, intern ("vdrag")))
29277 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29279 else if (EQ (pointer
, intern ("hourglass")))
29280 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29281 else if (EQ (pointer
, Qmodeline
))
29282 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29284 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29287 if (cursor
!= No_Cursor
)
29288 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29291 #endif /* HAVE_WINDOW_SYSTEM */
29293 /* Take proper action when mouse has moved to the mode or header line
29294 or marginal area AREA of window W, x-position X and y-position Y.
29295 X is relative to the start of the text display area of W, so the
29296 width of bitmap areas and scroll bars must be subtracted to get a
29297 position relative to the start of the mode line. */
29300 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29301 enum window_part area
)
29303 struct window
*w
= XWINDOW (window
);
29304 struct frame
*f
= XFRAME (w
->frame
);
29305 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29306 #ifdef HAVE_WINDOW_SYSTEM
29307 Display_Info
*dpyinfo
;
29309 Cursor cursor
= No_Cursor
;
29310 Lisp_Object pointer
= Qnil
;
29311 int dx
, dy
, width
, height
;
29313 Lisp_Object string
, object
= Qnil
;
29314 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29316 Lisp_Object mouse_face
;
29317 int original_x_pixel
= x
;
29318 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29319 struct glyph_row
*row
IF_LINT (= 0);
29321 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29326 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29327 returns them in row/column units! */
29328 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29329 &object
, &dx
, &dy
, &width
, &height
);
29331 row
= (area
== ON_MODE_LINE
29332 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29333 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29335 /* Find the glyph under the mouse pointer. */
29336 if (row
->mode_line_p
&& row
->enabled_p
)
29338 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29339 end
= glyph
+ row
->used
[TEXT_AREA
];
29341 for (x0
= original_x_pixel
;
29342 glyph
< end
&& x0
>= glyph
->pixel_width
;
29344 x0
-= glyph
->pixel_width
;
29352 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29353 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29354 returns them in row/column units! */
29355 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29356 &object
, &dx
, &dy
, &width
, &height
);
29361 #ifdef HAVE_WINDOW_SYSTEM
29362 if (IMAGEP (object
))
29364 Lisp_Object image_map
, hotspot
;
29365 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29367 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29369 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29373 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29374 If so, we could look for mouse-enter, mouse-leave
29375 properties in PLIST (and do something...). */
29376 hotspot
= XCDR (hotspot
);
29377 if (CONSP (hotspot
)
29378 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29380 pointer
= Fplist_get (plist
, Qpointer
);
29381 if (NILP (pointer
))
29383 help
= Fplist_get (plist
, Qhelp_echo
);
29386 help_echo_string
= help
;
29387 XSETWINDOW (help_echo_window
, w
);
29388 help_echo_object
= w
->contents
;
29389 help_echo_pos
= charpos
;
29393 if (NILP (pointer
))
29394 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29396 #endif /* HAVE_WINDOW_SYSTEM */
29398 if (STRINGP (string
))
29399 pos
= make_number (charpos
);
29401 /* Set the help text and mouse pointer. If the mouse is on a part
29402 of the mode line without any text (e.g. past the right edge of
29403 the mode line text), use the default help text and pointer. */
29404 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29406 /* Arrange to display the help by setting the global variables
29407 help_echo_string, help_echo_object, and help_echo_pos. */
29410 if (STRINGP (string
))
29411 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29415 help_echo_string
= help
;
29416 XSETWINDOW (help_echo_window
, w
);
29417 help_echo_object
= string
;
29418 help_echo_pos
= charpos
;
29420 else if (area
== ON_MODE_LINE
)
29422 Lisp_Object default_help
29423 = buffer_local_value (Qmode_line_default_help_echo
,
29426 if (STRINGP (default_help
))
29428 help_echo_string
= default_help
;
29429 XSETWINDOW (help_echo_window
, w
);
29430 help_echo_object
= Qnil
;
29431 help_echo_pos
= -1;
29436 #ifdef HAVE_WINDOW_SYSTEM
29437 /* Change the mouse pointer according to what is under it. */
29438 if (FRAME_WINDOW_P (f
))
29440 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29442 || NILP (Vresize_mini_windows
));
29444 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29445 if (STRINGP (string
))
29447 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29449 if (NILP (pointer
))
29450 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29452 /* Change the mouse pointer according to what is under X/Y. */
29454 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29457 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29458 if (!KEYMAPP (map
))
29459 map
= Fget_text_property (pos
, Qkeymap
, string
);
29460 if (!KEYMAPP (map
) && draggable
)
29461 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29464 else if (draggable
)
29465 /* Default mode-line pointer. */
29466 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29471 /* Change the mouse face according to what is under X/Y. */
29472 bool mouse_face_shown
= false;
29473 if (STRINGP (string
))
29475 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29476 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29477 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29482 struct glyph
* tmp_glyph
;
29486 int total_pixel_width
;
29487 ptrdiff_t begpos
, endpos
, ignore
;
29491 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29492 Qmouse_face
, string
, Qnil
);
29498 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29500 endpos
= SCHARS (string
);
29504 /* Calculate the glyph position GPOS of GLYPH in the
29505 displayed string, relative to the beginning of the
29506 highlighted part of the string.
29508 Note: GPOS is different from CHARPOS. CHARPOS is the
29509 position of GLYPH in the internal string object. A mode
29510 line string format has structures which are converted to
29511 a flattened string by the Emacs Lisp interpreter. The
29512 internal string is an element of those structures. The
29513 displayed string is the flattened string. */
29514 tmp_glyph
= row_start_glyph
;
29515 while (tmp_glyph
< glyph
29516 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29517 && begpos
<= tmp_glyph
->charpos
29518 && tmp_glyph
->charpos
< endpos
)))
29520 gpos
= glyph
- tmp_glyph
;
29522 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29523 the highlighted part of the displayed string to which
29524 GLYPH belongs. Note: GSEQ_LENGTH is different from
29525 SCHARS (STRING), because the latter returns the length of
29526 the internal string. */
29527 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29529 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29530 && begpos
<= tmp_glyph
->charpos
29531 && tmp_glyph
->charpos
< endpos
));
29534 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29536 /* Calculate the total pixel width of all the glyphs between
29537 the beginning of the highlighted area and GLYPH. */
29538 total_pixel_width
= 0;
29539 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29540 total_pixel_width
+= tmp_glyph
->pixel_width
;
29542 /* Pre calculation of re-rendering position. Note: X is in
29543 column units here, after the call to mode_line_string or
29544 marginal_area_string. */
29546 vpos
= (area
== ON_MODE_LINE
29547 ? (w
->current_matrix
)->nrows
- 1
29550 /* If GLYPH's position is included in the region that is
29551 already drawn in mouse face, we have nothing to do. */
29552 if ( EQ (window
, hlinfo
->mouse_face_window
)
29553 && (!row
->reversed_p
29554 ? (hlinfo
->mouse_face_beg_col
<= hpos
29555 && hpos
< hlinfo
->mouse_face_end_col
)
29556 /* In R2L rows we swap BEG and END, see below. */
29557 : (hlinfo
->mouse_face_end_col
<= hpos
29558 && hpos
< hlinfo
->mouse_face_beg_col
))
29559 && hlinfo
->mouse_face_beg_row
== vpos
)
29562 if (clear_mouse_face (hlinfo
))
29563 cursor
= No_Cursor
;
29565 if (!row
->reversed_p
)
29567 hlinfo
->mouse_face_beg_col
= hpos
;
29568 hlinfo
->mouse_face_beg_x
= original_x_pixel
29569 - (total_pixel_width
+ dx
);
29570 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29571 hlinfo
->mouse_face_end_x
= 0;
29575 /* In R2L rows, show_mouse_face expects BEG and END
29576 coordinates to be swapped. */
29577 hlinfo
->mouse_face_end_col
= hpos
;
29578 hlinfo
->mouse_face_end_x
= original_x_pixel
29579 - (total_pixel_width
+ dx
);
29580 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29581 hlinfo
->mouse_face_beg_x
= 0;
29584 hlinfo
->mouse_face_beg_row
= vpos
;
29585 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29586 hlinfo
->mouse_face_past_end
= false;
29587 hlinfo
->mouse_face_window
= window
;
29589 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29594 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29595 mouse_face_shown
= true;
29597 if (NILP (pointer
))
29602 /* If mouse-face doesn't need to be shown, clear any existing
29604 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29605 clear_mouse_face (hlinfo
);
29607 #ifdef HAVE_WINDOW_SYSTEM
29608 if (FRAME_WINDOW_P (f
))
29609 define_frame_cursor1 (f
, cursor
, pointer
);
29615 Take proper action when the mouse has moved to position X, Y on
29616 frame F with regards to highlighting portions of display that have
29617 mouse-face properties. Also de-highlight portions of display where
29618 the mouse was before, set the mouse pointer shape as appropriate
29619 for the mouse coordinates, and activate help echo (tooltips).
29620 X and Y can be negative or out of range. */
29623 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29625 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29626 enum window_part part
= ON_NOTHING
;
29627 Lisp_Object window
;
29629 Cursor cursor
= No_Cursor
;
29630 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29633 /* When a menu is active, don't highlight because this looks odd. */
29634 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29635 if (popup_activated ())
29639 if (!f
->glyphs_initialized_p
29640 || f
->pointer_invisible
)
29643 hlinfo
->mouse_face_mouse_x
= x
;
29644 hlinfo
->mouse_face_mouse_y
= y
;
29645 hlinfo
->mouse_face_mouse_frame
= f
;
29647 if (hlinfo
->mouse_face_defer
)
29650 /* Which window is that in? */
29651 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29653 /* If displaying active text in another window, clear that. */
29654 if (! EQ (window
, hlinfo
->mouse_face_window
)
29655 /* Also clear if we move out of text area in same window. */
29656 || (!NILP (hlinfo
->mouse_face_window
)
29659 && part
!= ON_MODE_LINE
29660 && part
!= ON_HEADER_LINE
))
29661 clear_mouse_face (hlinfo
);
29663 /* Not on a window -> return. */
29664 if (!WINDOWP (window
))
29667 /* Reset help_echo_string. It will get recomputed below. */
29668 help_echo_string
= Qnil
;
29670 /* Convert to window-relative pixel coordinates. */
29671 w
= XWINDOW (window
);
29672 frame_to_window_pixel_xy (w
, &x
, &y
);
29674 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29675 /* Handle tool-bar window differently since it doesn't display a
29677 if (EQ (window
, f
->tool_bar_window
))
29679 note_tool_bar_highlight (f
, x
, y
);
29684 /* Mouse is on the mode, header line or margin? */
29685 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29686 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29688 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29690 #ifdef HAVE_WINDOW_SYSTEM
29691 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29693 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29694 /* Show non-text cursor (Bug#16647). */
29702 #ifdef HAVE_WINDOW_SYSTEM
29703 if (part
== ON_VERTICAL_BORDER
)
29705 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29706 help_echo_string
= build_string ("drag-mouse-1: resize");
29708 else if (part
== ON_RIGHT_DIVIDER
)
29710 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29711 help_echo_string
= build_string ("drag-mouse-1: resize");
29713 else if (part
== ON_BOTTOM_DIVIDER
)
29714 if (! WINDOW_BOTTOMMOST_P (w
)
29716 || NILP (Vresize_mini_windows
))
29718 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29719 help_echo_string
= build_string ("drag-mouse-1: resize");
29722 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29723 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29724 || part
== ON_VERTICAL_SCROLL_BAR
29725 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29726 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29728 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29731 /* Are we in a window whose display is up to date?
29732 And verify the buffer's text has not changed. */
29733 b
= XBUFFER (w
->contents
);
29734 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29736 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29738 struct glyph
*glyph
;
29739 Lisp_Object object
;
29740 Lisp_Object mouse_face
= Qnil
, position
;
29741 Lisp_Object
*overlay_vec
= NULL
;
29742 ptrdiff_t i
, noverlays
;
29743 struct buffer
*obuf
;
29744 ptrdiff_t obegv
, ozv
;
29747 /* Find the glyph under X/Y. */
29748 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29750 #ifdef HAVE_WINDOW_SYSTEM
29751 /* Look for :pointer property on image. */
29752 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29754 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29755 if (img
!= NULL
&& IMAGEP (img
->spec
))
29757 Lisp_Object image_map
, hotspot
;
29758 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29760 && (hotspot
= find_hot_spot (image_map
,
29761 glyph
->slice
.img
.x
+ dx
,
29762 glyph
->slice
.img
.y
+ dy
),
29764 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29768 /* Could check XCAR (hotspot) to see if we enter/leave
29770 If so, we could look for mouse-enter, mouse-leave
29771 properties in PLIST (and do something...). */
29772 hotspot
= XCDR (hotspot
);
29773 if (CONSP (hotspot
)
29774 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29776 pointer
= Fplist_get (plist
, Qpointer
);
29777 if (NILP (pointer
))
29779 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29780 if (!NILP (help_echo_string
))
29782 help_echo_window
= window
;
29783 help_echo_object
= glyph
->object
;
29784 help_echo_pos
= glyph
->charpos
;
29788 if (NILP (pointer
))
29789 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29792 #endif /* HAVE_WINDOW_SYSTEM */
29794 /* Clear mouse face if X/Y not over text. */
29796 || area
!= TEXT_AREA
29797 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29798 /* Glyph's OBJECT is nil for glyphs inserted by the
29799 display engine for its internal purposes, like truncation
29800 and continuation glyphs and blanks beyond the end of
29801 line's text on text terminals. If we are over such a
29802 glyph, we are not over any text. */
29803 || NILP (glyph
->object
)
29804 /* R2L rows have a stretch glyph at their front, which
29805 stands for no text, whereas L2R rows have no glyphs at
29806 all beyond the end of text. Treat such stretch glyphs
29807 like we do with NULL glyphs in L2R rows. */
29808 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29809 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29810 && glyph
->type
== STRETCH_GLYPH
29811 && glyph
->avoid_cursor_p
))
29813 if (clear_mouse_face (hlinfo
))
29814 cursor
= No_Cursor
;
29815 #ifdef HAVE_WINDOW_SYSTEM
29816 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29818 if (area
!= TEXT_AREA
)
29819 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29821 pointer
= Vvoid_text_area_pointer
;
29827 pos
= glyph
->charpos
;
29828 object
= glyph
->object
;
29829 if (!STRINGP (object
) && !BUFFERP (object
))
29832 /* If we get an out-of-range value, return now; avoid an error. */
29833 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29836 /* Make the window's buffer temporarily current for
29837 overlays_at and compute_char_face. */
29838 obuf
= current_buffer
;
29839 current_buffer
= b
;
29845 /* Is this char mouse-active or does it have help-echo? */
29846 position
= make_number (pos
);
29850 if (BUFFERP (object
))
29852 /* Put all the overlays we want in a vector in overlay_vec. */
29853 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29854 /* Sort overlays into increasing priority order. */
29855 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29860 if (NILP (Vmouse_highlight
))
29862 clear_mouse_face (hlinfo
);
29863 goto check_help_echo
;
29866 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29869 cursor
= No_Cursor
;
29871 /* Check mouse-face highlighting. */
29873 /* If there exists an overlay with mouse-face overlapping
29874 the one we are currently highlighting, we have to
29875 check if we enter the overlapping overlay, and then
29876 highlight only that. */
29877 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29878 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29880 /* Find the highest priority overlay with a mouse-face. */
29881 Lisp_Object overlay
= Qnil
;
29882 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29884 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29885 if (!NILP (mouse_face
))
29886 overlay
= overlay_vec
[i
];
29889 /* If we're highlighting the same overlay as before, there's
29890 no need to do that again. */
29891 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29892 goto check_help_echo
;
29893 hlinfo
->mouse_face_overlay
= overlay
;
29895 /* Clear the display of the old active region, if any. */
29896 if (clear_mouse_face (hlinfo
))
29897 cursor
= No_Cursor
;
29899 /* If no overlay applies, get a text property. */
29900 if (NILP (overlay
))
29901 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29903 /* Next, compute the bounds of the mouse highlighting and
29905 if (!NILP (mouse_face
) && STRINGP (object
))
29907 /* The mouse-highlighting comes from a display string
29908 with a mouse-face. */
29912 s
= Fprevious_single_property_change
29913 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29914 e
= Fnext_single_property_change
29915 (position
, Qmouse_face
, object
, Qnil
);
29917 s
= make_number (0);
29919 e
= make_number (SCHARS (object
));
29920 mouse_face_from_string_pos (w
, hlinfo
, object
,
29921 XINT (s
), XINT (e
));
29922 hlinfo
->mouse_face_past_end
= false;
29923 hlinfo
->mouse_face_window
= window
;
29924 hlinfo
->mouse_face_face_id
29925 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29926 glyph
->face_id
, true);
29927 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29928 cursor
= No_Cursor
;
29932 /* The mouse-highlighting, if any, comes from an overlay
29933 or text property in the buffer. */
29934 Lisp_Object buffer
IF_LINT (= Qnil
);
29935 Lisp_Object disp_string
IF_LINT (= Qnil
);
29937 if (STRINGP (object
))
29939 /* If we are on a display string with no mouse-face,
29940 check if the text under it has one. */
29941 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29942 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29943 pos
= string_buffer_position (object
, start
);
29946 mouse_face
= get_char_property_and_overlay
29947 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29948 buffer
= w
->contents
;
29949 disp_string
= object
;
29955 disp_string
= Qnil
;
29958 if (!NILP (mouse_face
))
29960 Lisp_Object before
, after
;
29961 Lisp_Object before_string
, after_string
;
29962 /* To correctly find the limits of mouse highlight
29963 in a bidi-reordered buffer, we must not use the
29964 optimization of limiting the search in
29965 previous-single-property-change and
29966 next-single-property-change, because
29967 rows_from_pos_range needs the real start and end
29968 positions to DTRT in this case. That's because
29969 the first row visible in a window does not
29970 necessarily display the character whose position
29971 is the smallest. */
29973 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29974 ? Fmarker_position (w
->start
)
29977 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29978 ? make_number (BUF_Z (XBUFFER (buffer
))
29979 - w
->window_end_pos
)
29982 if (NILP (overlay
))
29984 /* Handle the text property case. */
29985 before
= Fprevious_single_property_change
29986 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29987 after
= Fnext_single_property_change
29988 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29989 before_string
= after_string
= Qnil
;
29993 /* Handle the overlay case. */
29994 before
= Foverlay_start (overlay
);
29995 after
= Foverlay_end (overlay
);
29996 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29997 after_string
= Foverlay_get (overlay
, Qafter_string
);
29999 if (!STRINGP (before_string
)) before_string
= Qnil
;
30000 if (!STRINGP (after_string
)) after_string
= Qnil
;
30003 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30006 : XFASTINT (before
),
30008 ? BUF_Z (XBUFFER (buffer
))
30009 : XFASTINT (after
),
30010 before_string
, after_string
,
30012 cursor
= No_Cursor
;
30019 /* Look for a `help-echo' property. */
30020 if (NILP (help_echo_string
)) {
30021 Lisp_Object help
, overlay
;
30023 /* Check overlays first. */
30024 help
= overlay
= Qnil
;
30025 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30027 overlay
= overlay_vec
[i
];
30028 help
= Foverlay_get (overlay
, Qhelp_echo
);
30033 help_echo_string
= help
;
30034 help_echo_window
= window
;
30035 help_echo_object
= overlay
;
30036 help_echo_pos
= pos
;
30040 Lisp_Object obj
= glyph
->object
;
30041 ptrdiff_t charpos
= glyph
->charpos
;
30043 /* Try text properties. */
30046 && charpos
< SCHARS (obj
))
30048 help
= Fget_text_property (make_number (charpos
),
30052 /* If the string itself doesn't specify a help-echo,
30053 see if the buffer text ``under'' it does. */
30054 struct glyph_row
*r
30055 = MATRIX_ROW (w
->current_matrix
, vpos
);
30056 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30057 ptrdiff_t p
= string_buffer_position (obj
, start
);
30060 help
= Fget_char_property (make_number (p
),
30061 Qhelp_echo
, w
->contents
);
30070 else if (BUFFERP (obj
)
30073 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30078 help_echo_string
= help
;
30079 help_echo_window
= window
;
30080 help_echo_object
= obj
;
30081 help_echo_pos
= charpos
;
30086 #ifdef HAVE_WINDOW_SYSTEM
30087 /* Look for a `pointer' property. */
30088 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30090 /* Check overlays first. */
30091 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30092 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30094 if (NILP (pointer
))
30096 Lisp_Object obj
= glyph
->object
;
30097 ptrdiff_t charpos
= glyph
->charpos
;
30099 /* Try text properties. */
30102 && charpos
< SCHARS (obj
))
30104 pointer
= Fget_text_property (make_number (charpos
),
30106 if (NILP (pointer
))
30108 /* If the string itself doesn't specify a pointer,
30109 see if the buffer text ``under'' it does. */
30110 struct glyph_row
*r
30111 = MATRIX_ROW (w
->current_matrix
, vpos
);
30112 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30113 ptrdiff_t p
= string_buffer_position (obj
, start
);
30115 pointer
= Fget_char_property (make_number (p
),
30116 Qpointer
, w
->contents
);
30119 else if (BUFFERP (obj
)
30122 pointer
= Fget_text_property (make_number (charpos
),
30126 #endif /* HAVE_WINDOW_SYSTEM */
30130 current_buffer
= obuf
;
30136 #ifdef HAVE_WINDOW_SYSTEM
30137 if (FRAME_WINDOW_P (f
))
30138 define_frame_cursor1 (f
, cursor
, pointer
);
30140 /* This is here to prevent a compiler error, about "label at end of
30141 compound statement". */
30148 Clear any mouse-face on window W. This function is part of the
30149 redisplay interface, and is called from try_window_id and similar
30150 functions to ensure the mouse-highlight is off. */
30153 x_clear_window_mouse_face (struct window
*w
)
30155 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30156 Lisp_Object window
;
30159 XSETWINDOW (window
, w
);
30160 if (EQ (window
, hlinfo
->mouse_face_window
))
30161 clear_mouse_face (hlinfo
);
30167 Just discard the mouse face information for frame F, if any.
30168 This is used when the size of F is changed. */
30171 cancel_mouse_face (struct frame
*f
)
30173 Lisp_Object window
;
30174 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30176 window
= hlinfo
->mouse_face_window
;
30177 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30178 reset_mouse_highlight (hlinfo
);
30183 /***********************************************************************
30185 ***********************************************************************/
30187 #ifdef HAVE_WINDOW_SYSTEM
30189 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30190 which intersects rectangle R. R is in window-relative coordinates. */
30193 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30194 enum glyph_row_area area
)
30196 struct glyph
*first
= row
->glyphs
[area
];
30197 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30198 struct glyph
*last
;
30199 int first_x
, start_x
, x
;
30201 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30202 /* If row extends face to end of line write the whole line. */
30203 draw_glyphs (w
, 0, row
, area
,
30204 0, row
->used
[area
],
30205 DRAW_NORMAL_TEXT
, 0);
30208 /* Set START_X to the window-relative start position for drawing glyphs of
30209 AREA. The first glyph of the text area can be partially visible.
30210 The first glyphs of other areas cannot. */
30211 start_x
= window_box_left_offset (w
, area
);
30213 if (area
== TEXT_AREA
)
30216 /* Find the first glyph that must be redrawn. */
30218 && x
+ first
->pixel_width
< r
->x
)
30220 x
+= first
->pixel_width
;
30224 /* Find the last one. */
30227 /* Use a signed int intermediate value to avoid catastrophic
30228 failures due to comparison between signed and unsigned, when
30229 x is negative (can happen for wide images that are hscrolled). */
30230 int r_end
= r
->x
+ r
->width
;
30231 while (last
< end
&& x
< r_end
)
30233 x
+= last
->pixel_width
;
30239 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30240 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30241 DRAW_NORMAL_TEXT
, 0);
30246 /* Redraw the parts of the glyph row ROW on window W intersecting
30247 rectangle R. R is in window-relative coordinates. Value is
30248 true if mouse-face was overwritten. */
30251 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30253 eassert (row
->enabled_p
);
30255 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30256 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30257 0, row
->used
[TEXT_AREA
],
30258 DRAW_NORMAL_TEXT
, 0);
30261 if (row
->used
[LEFT_MARGIN_AREA
])
30262 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30263 if (row
->used
[TEXT_AREA
])
30264 expose_area (w
, row
, r
, TEXT_AREA
);
30265 if (row
->used
[RIGHT_MARGIN_AREA
])
30266 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30267 draw_row_fringe_bitmaps (w
, row
);
30270 return row
->mouse_face_p
;
30274 /* Redraw those parts of glyphs rows during expose event handling that
30275 overlap other rows. Redrawing of an exposed line writes over parts
30276 of lines overlapping that exposed line; this function fixes that.
30278 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30279 row in W's current matrix that is exposed and overlaps other rows.
30280 LAST_OVERLAPPING_ROW is the last such row. */
30283 expose_overlaps (struct window
*w
,
30284 struct glyph_row
*first_overlapping_row
,
30285 struct glyph_row
*last_overlapping_row
,
30288 struct glyph_row
*row
;
30290 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30291 if (row
->overlapping_p
)
30293 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30296 if (row
->used
[LEFT_MARGIN_AREA
])
30297 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30299 if (row
->used
[TEXT_AREA
])
30300 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30302 if (row
->used
[RIGHT_MARGIN_AREA
])
30303 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30309 /* Return true if W's cursor intersects rectangle R. */
30312 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30314 XRectangle cr
, result
;
30315 struct glyph
*cursor_glyph
;
30316 struct glyph_row
*row
;
30318 if (w
->phys_cursor
.vpos
>= 0
30319 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30320 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30322 && row
->cursor_in_fringe_p
)
30324 /* Cursor is in the fringe. */
30325 cr
.x
= window_box_right_offset (w
,
30326 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30327 ? RIGHT_MARGIN_AREA
30330 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30331 cr
.height
= row
->height
;
30332 return x_intersect_rectangles (&cr
, r
, &result
);
30335 cursor_glyph
= get_phys_cursor_glyph (w
);
30338 /* r is relative to W's box, but w->phys_cursor.x is relative
30339 to left edge of W's TEXT area. Adjust it. */
30340 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30341 cr
.y
= w
->phys_cursor
.y
;
30342 cr
.width
= cursor_glyph
->pixel_width
;
30343 cr
.height
= w
->phys_cursor_height
;
30344 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30345 I assume the effect is the same -- and this is portable. */
30346 return x_intersect_rectangles (&cr
, r
, &result
);
30348 /* If we don't understand the format, pretend we're not in the hot-spot. */
30354 Draw a vertical window border to the right of window W if W doesn't
30355 have vertical scroll bars. */
30358 x_draw_vertical_border (struct window
*w
)
30360 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30362 /* We could do better, if we knew what type of scroll-bar the adjacent
30363 windows (on either side) have... But we don't :-(
30364 However, I think this works ok. ++KFS 2003-04-25 */
30366 /* Redraw borders between horizontally adjacent windows. Don't
30367 do it for frames with vertical scroll bars because either the
30368 right scroll bar of a window, or the left scroll bar of its
30369 neighbor will suffice as a border. */
30370 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30373 /* Note: It is necessary to redraw both the left and the right
30374 borders, for when only this single window W is being
30376 if (!WINDOW_RIGHTMOST_P (w
)
30377 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30379 int x0
, x1
, y0
, y1
;
30381 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30384 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30387 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30390 if (!WINDOW_LEFTMOST_P (w
)
30391 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30393 int x0
, x1
, y0
, y1
;
30395 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30398 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30401 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30406 /* Draw window dividers for window W. */
30409 x_draw_right_divider (struct window
*w
)
30411 struct frame
*f
= WINDOW_XFRAME (w
);
30413 if (w
->mini
|| w
->pseudo_window_p
)
30415 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30417 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30418 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30419 int y0
= WINDOW_TOP_EDGE_Y (w
);
30420 /* The bottom divider prevails. */
30421 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30423 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30428 x_draw_bottom_divider (struct window
*w
)
30430 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30432 if (w
->mini
|| w
->pseudo_window_p
)
30434 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30436 int x0
= WINDOW_LEFT_EDGE_X (w
);
30437 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30438 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30439 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30441 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30445 /* Redraw the part of window W intersection rectangle FR. Pixel
30446 coordinates in FR are frame-relative. Call this function with
30447 input blocked. Value is true if the exposure overwrites
30451 expose_window (struct window
*w
, XRectangle
*fr
)
30453 struct frame
*f
= XFRAME (w
->frame
);
30455 bool mouse_face_overwritten_p
= false;
30457 /* If window is not yet fully initialized, do nothing. This can
30458 happen when toolkit scroll bars are used and a window is split.
30459 Reconfiguring the scroll bar will generate an expose for a newly
30461 if (w
->current_matrix
== NULL
)
30464 /* When we're currently updating the window, display and current
30465 matrix usually don't agree. Arrange for a thorough display
30467 if (w
->must_be_updated_p
)
30469 SET_FRAME_GARBAGED (f
);
30473 /* Frame-relative pixel rectangle of W. */
30474 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30475 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30476 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30477 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30479 if (x_intersect_rectangles (fr
, &wr
, &r
))
30481 int yb
= window_text_bottom_y (w
);
30482 struct glyph_row
*row
;
30483 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30485 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30486 r
.x
, r
.y
, r
.width
, r
.height
));
30488 /* Convert to window coordinates. */
30489 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30490 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30492 /* Turn off the cursor. */
30493 bool cursor_cleared_p
= (!w
->pseudo_window_p
30494 && phys_cursor_in_rect_p (w
, &r
));
30495 if (cursor_cleared_p
)
30496 x_clear_cursor (w
);
30498 /* If the row containing the cursor extends face to end of line,
30499 then expose_area might overwrite the cursor outside the
30500 rectangle and thus notice_overwritten_cursor might clear
30501 w->phys_cursor_on_p. We remember the original value and
30502 check later if it is changed. */
30503 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30505 /* Use a signed int intermediate value to avoid catastrophic
30506 failures due to comparison between signed and unsigned, when
30507 y0 or y1 is negative (can happen for tall images). */
30508 int r_bottom
= r
.y
+ r
.height
;
30510 /* Update lines intersecting rectangle R. */
30511 first_overlapping_row
= last_overlapping_row
= NULL
;
30512 for (row
= w
->current_matrix
->rows
;
30517 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30519 if ((y0
>= r
.y
&& y0
< r_bottom
)
30520 || (y1
> r
.y
&& y1
< r_bottom
)
30521 || (r
.y
>= y0
&& r
.y
< y1
)
30522 || (r_bottom
> y0
&& r_bottom
< y1
))
30524 /* A header line may be overlapping, but there is no need
30525 to fix overlapping areas for them. KFS 2005-02-12 */
30526 if (row
->overlapping_p
&& !row
->mode_line_p
)
30528 if (first_overlapping_row
== NULL
)
30529 first_overlapping_row
= row
;
30530 last_overlapping_row
= row
;
30534 if (expose_line (w
, row
, &r
))
30535 mouse_face_overwritten_p
= true;
30538 else if (row
->overlapping_p
)
30540 /* We must redraw a row overlapping the exposed area. */
30542 ? y0
+ row
->phys_height
> r
.y
30543 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30545 if (first_overlapping_row
== NULL
)
30546 first_overlapping_row
= row
;
30547 last_overlapping_row
= row
;
30555 /* Display the mode line if there is one. */
30556 if (WINDOW_WANTS_MODELINE_P (w
)
30557 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30559 && row
->y
< r_bottom
)
30561 if (expose_line (w
, row
, &r
))
30562 mouse_face_overwritten_p
= true;
30565 if (!w
->pseudo_window_p
)
30567 /* Fix the display of overlapping rows. */
30568 if (first_overlapping_row
)
30569 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30572 /* Draw border between windows. */
30573 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30574 x_draw_right_divider (w
);
30576 x_draw_vertical_border (w
);
30578 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30579 x_draw_bottom_divider (w
);
30581 /* Turn the cursor on again. */
30582 if (cursor_cleared_p
30583 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30584 update_window_cursor (w
, true);
30588 return mouse_face_overwritten_p
;
30593 /* Redraw (parts) of all windows in the window tree rooted at W that
30594 intersect R. R contains frame pixel coordinates. Value is
30595 true if the exposure overwrites mouse-face. */
30598 expose_window_tree (struct window
*w
, XRectangle
*r
)
30600 struct frame
*f
= XFRAME (w
->frame
);
30601 bool mouse_face_overwritten_p
= false;
30603 while (w
&& !FRAME_GARBAGED_P (f
))
30605 mouse_face_overwritten_p
30606 |= (WINDOWP (w
->contents
)
30607 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30608 : expose_window (w
, r
));
30610 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30613 return mouse_face_overwritten_p
;
30618 Redisplay an exposed area of frame F. X and Y are the upper-left
30619 corner of the exposed rectangle. W and H are width and height of
30620 the exposed area. All are pixel values. W or H zero means redraw
30621 the entire frame. */
30624 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30627 bool mouse_face_overwritten_p
= false;
30629 TRACE ((stderr
, "expose_frame "));
30631 /* No need to redraw if frame will be redrawn soon. */
30632 if (FRAME_GARBAGED_P (f
))
30634 TRACE ((stderr
, " garbaged\n"));
30638 /* If basic faces haven't been realized yet, there is no point in
30639 trying to redraw anything. This can happen when we get an expose
30640 event while Emacs is starting, e.g. by moving another window. */
30641 if (FRAME_FACE_CACHE (f
) == NULL
30642 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30644 TRACE ((stderr
, " no faces\n"));
30648 if (w
== 0 || h
== 0)
30651 r
.width
= FRAME_TEXT_WIDTH (f
);
30652 r
.height
= FRAME_TEXT_HEIGHT (f
);
30662 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30663 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30665 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30666 if (WINDOWP (f
->tool_bar_window
))
30667 mouse_face_overwritten_p
30668 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30671 #ifdef HAVE_X_WINDOWS
30673 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30674 if (WINDOWP (f
->menu_bar_window
))
30675 mouse_face_overwritten_p
30676 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30677 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30681 /* Some window managers support a focus-follows-mouse style with
30682 delayed raising of frames. Imagine a partially obscured frame,
30683 and moving the mouse into partially obscured mouse-face on that
30684 frame. The visible part of the mouse-face will be highlighted,
30685 then the WM raises the obscured frame. With at least one WM, KDE
30686 2.1, Emacs is not getting any event for the raising of the frame
30687 (even tried with SubstructureRedirectMask), only Expose events.
30688 These expose events will draw text normally, i.e. not
30689 highlighted. Which means we must redo the highlight here.
30690 Subsume it under ``we love X''. --gerd 2001-08-15 */
30691 /* Included in Windows version because Windows most likely does not
30692 do the right thing if any third party tool offers
30693 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30694 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30696 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30697 if (f
== hlinfo
->mouse_face_mouse_frame
)
30699 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30700 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30701 clear_mouse_face (hlinfo
);
30702 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30709 Determine the intersection of two rectangles R1 and R2. Return
30710 the intersection in *RESULT. Value is true if RESULT is not
30714 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30716 XRectangle
*left
, *right
;
30717 XRectangle
*upper
, *lower
;
30718 bool intersection_p
= false;
30720 /* Rearrange so that R1 is the left-most rectangle. */
30722 left
= r1
, right
= r2
;
30724 left
= r2
, right
= r1
;
30726 /* X0 of the intersection is right.x0, if this is inside R1,
30727 otherwise there is no intersection. */
30728 if (right
->x
<= left
->x
+ left
->width
)
30730 result
->x
= right
->x
;
30732 /* The right end of the intersection is the minimum of
30733 the right ends of left and right. */
30734 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30737 /* Same game for Y. */
30739 upper
= r1
, lower
= r2
;
30741 upper
= r2
, lower
= r1
;
30743 /* The upper end of the intersection is lower.y0, if this is inside
30744 of upper. Otherwise, there is no intersection. */
30745 if (lower
->y
<= upper
->y
+ upper
->height
)
30747 result
->y
= lower
->y
;
30749 /* The lower end of the intersection is the minimum of the lower
30750 ends of upper and lower. */
30751 result
->height
= (min (lower
->y
+ lower
->height
,
30752 upper
->y
+ upper
->height
)
30754 intersection_p
= true;
30758 return intersection_p
;
30761 #endif /* HAVE_WINDOW_SYSTEM */
30764 /***********************************************************************
30766 ***********************************************************************/
30769 syms_of_xdisp (void)
30771 Vwith_echo_area_save_vector
= Qnil
;
30772 staticpro (&Vwith_echo_area_save_vector
);
30774 Vmessage_stack
= Qnil
;
30775 staticpro (&Vmessage_stack
);
30777 /* Non-nil means don't actually do any redisplay. */
30778 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30780 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30782 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30783 doc
: /* Non-nil means calls to `message' are not displayed.
30784 They are still logged to the *Messages* buffer. */);
30785 inhibit_message
= 0;
30787 message_dolog_marker1
= Fmake_marker ();
30788 staticpro (&message_dolog_marker1
);
30789 message_dolog_marker2
= Fmake_marker ();
30790 staticpro (&message_dolog_marker2
);
30791 message_dolog_marker3
= Fmake_marker ();
30792 staticpro (&message_dolog_marker3
);
30795 defsubr (&Sdump_frame_glyph_matrix
);
30796 defsubr (&Sdump_glyph_matrix
);
30797 defsubr (&Sdump_glyph_row
);
30798 defsubr (&Sdump_tool_bar_row
);
30799 defsubr (&Strace_redisplay
);
30800 defsubr (&Strace_to_stderr
);
30802 #ifdef HAVE_WINDOW_SYSTEM
30803 defsubr (&Stool_bar_height
);
30804 defsubr (&Slookup_image_map
);
30806 defsubr (&Sline_pixel_height
);
30807 defsubr (&Sformat_mode_line
);
30808 defsubr (&Sinvisible_p
);
30809 defsubr (&Scurrent_bidi_paragraph_direction
);
30810 defsubr (&Swindow_text_pixel_size
);
30811 defsubr (&Smove_point_visually
);
30812 defsubr (&Sbidi_find_overridden_directionality
);
30814 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30815 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30816 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30817 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30818 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30819 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30820 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30821 DEFSYM (Qeval
, "eval");
30822 DEFSYM (QCdata
, ":data");
30824 /* Names of text properties relevant for redisplay. */
30825 DEFSYM (Qdisplay
, "display");
30826 DEFSYM (Qspace_width
, "space-width");
30827 DEFSYM (Qraise
, "raise");
30828 DEFSYM (Qslice
, "slice");
30829 DEFSYM (Qspace
, "space");
30830 DEFSYM (Qmargin
, "margin");
30831 DEFSYM (Qpointer
, "pointer");
30832 DEFSYM (Qleft_margin
, "left-margin");
30833 DEFSYM (Qright_margin
, "right-margin");
30834 DEFSYM (Qcenter
, "center");
30835 DEFSYM (Qline_height
, "line-height");
30836 DEFSYM (QCalign_to
, ":align-to");
30837 DEFSYM (QCrelative_width
, ":relative-width");
30838 DEFSYM (QCrelative_height
, ":relative-height");
30839 DEFSYM (QCeval
, ":eval");
30840 DEFSYM (QCpropertize
, ":propertize");
30841 DEFSYM (QCfile
, ":file");
30842 DEFSYM (Qfontified
, "fontified");
30843 DEFSYM (Qfontification_functions
, "fontification-functions");
30845 /* Name of the face used to highlight trailing whitespace. */
30846 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30848 /* Name and number of the face used to highlight escape glyphs. */
30849 DEFSYM (Qescape_glyph
, "escape-glyph");
30851 /* Name and number of the face used to highlight non-breaking spaces. */
30852 DEFSYM (Qnobreak_space
, "nobreak-space");
30854 /* The symbol 'image' which is the car of the lists used to represent
30855 images in Lisp. Also a tool bar style. */
30856 DEFSYM (Qimage
, "image");
30858 /* Tool bar styles. */
30859 DEFSYM (Qtext
, "text");
30860 DEFSYM (Qboth
, "both");
30861 DEFSYM (Qboth_horiz
, "both-horiz");
30862 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30864 /* The image map types. */
30865 DEFSYM (QCmap
, ":map");
30866 DEFSYM (QCpointer
, ":pointer");
30867 DEFSYM (Qrect
, "rect");
30868 DEFSYM (Qcircle
, "circle");
30869 DEFSYM (Qpoly
, "poly");
30871 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30873 DEFSYM (Qgrow_only
, "grow-only");
30874 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30875 DEFSYM (Qposition
, "position");
30876 DEFSYM (Qbuffer_position
, "buffer-position");
30877 DEFSYM (Qobject
, "object");
30879 /* Cursor shapes. */
30880 DEFSYM (Qbar
, "bar");
30881 DEFSYM (Qhbar
, "hbar");
30882 DEFSYM (Qbox
, "box");
30883 DEFSYM (Qhollow
, "hollow");
30885 /* Pointer shapes. */
30886 DEFSYM (Qhand
, "hand");
30887 DEFSYM (Qarrow
, "arrow");
30890 DEFSYM (Qdragging
, "dragging");
30892 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30894 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30895 staticpro (&list_of_error
);
30897 /* Values of those variables at last redisplay are stored as
30898 properties on 'overlay-arrow-position' symbol. However, if
30899 Voverlay_arrow_position is a marker, last-arrow-position is its
30900 numerical position. */
30901 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30902 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30904 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30905 properties on a symbol in overlay-arrow-variable-list. */
30906 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30907 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30909 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30910 staticpro (&echo_buffer
[0]);
30911 staticpro (&echo_buffer
[1]);
30913 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30914 staticpro (&echo_area_buffer
[0]);
30915 staticpro (&echo_area_buffer
[1]);
30917 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30918 staticpro (&Vmessages_buffer_name
);
30920 mode_line_proptrans_alist
= Qnil
;
30921 staticpro (&mode_line_proptrans_alist
);
30922 mode_line_string_list
= Qnil
;
30923 staticpro (&mode_line_string_list
);
30924 mode_line_string_face
= Qnil
;
30925 staticpro (&mode_line_string_face
);
30926 mode_line_string_face_prop
= Qnil
;
30927 staticpro (&mode_line_string_face_prop
);
30928 Vmode_line_unwind_vector
= Qnil
;
30929 staticpro (&Vmode_line_unwind_vector
);
30931 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30933 help_echo_string
= Qnil
;
30934 staticpro (&help_echo_string
);
30935 help_echo_object
= Qnil
;
30936 staticpro (&help_echo_object
);
30937 help_echo_window
= Qnil
;
30938 staticpro (&help_echo_window
);
30939 previous_help_echo_string
= Qnil
;
30940 staticpro (&previous_help_echo_string
);
30941 help_echo_pos
= -1;
30943 DEFSYM (Qright_to_left
, "right-to-left");
30944 DEFSYM (Qleft_to_right
, "left-to-right");
30945 defsubr (&Sbidi_resolved_levels
);
30947 #ifdef HAVE_WINDOW_SYSTEM
30948 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30949 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30950 For example, if a block cursor is over a tab, it will be drawn as
30951 wide as that tab on the display. */);
30952 x_stretch_cursor_p
= 0;
30955 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30956 doc
: /* Non-nil means highlight trailing whitespace.
30957 The face used for trailing whitespace is `trailing-whitespace'. */);
30958 Vshow_trailing_whitespace
= Qnil
;
30960 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30961 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30962 If the value is t, Emacs highlights non-ASCII chars which have the
30963 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30964 or `escape-glyph' face respectively.
30966 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30967 U+2011 (non-breaking hyphen) are affected.
30969 Any other non-nil value means to display these characters as a escape
30970 glyph followed by an ordinary space or hyphen.
30972 A value of nil means no special handling of these characters. */);
30973 Vnobreak_char_display
= Qt
;
30975 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30976 doc
: /* The pointer shape to show in void text areas.
30977 A value of nil means to show the text pointer. Other options are
30978 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30980 Vvoid_text_area_pointer
= Qarrow
;
30982 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30983 doc
: /* Non-nil means don't actually do any redisplay.
30984 This is used for internal purposes. */);
30985 Vinhibit_redisplay
= Qnil
;
30987 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30988 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30989 Vglobal_mode_string
= Qnil
;
30991 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30992 doc
: /* Marker for where to display an arrow on top of the buffer text.
30993 This must be the beginning of a line in order to work.
30994 See also `overlay-arrow-string'. */);
30995 Voverlay_arrow_position
= Qnil
;
30997 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30998 doc
: /* String to display as an arrow in non-window frames.
30999 See also `overlay-arrow-position'. */);
31000 Voverlay_arrow_string
= build_pure_c_string ("=>");
31002 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31003 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31004 The symbols on this list are examined during redisplay to determine
31005 where to display overlay arrows. */);
31006 Voverlay_arrow_variable_list
31007 = list1 (intern_c_string ("overlay-arrow-position"));
31009 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31010 doc
: /* The number of lines to try scrolling a window by when point moves out.
31011 If that fails to bring point back on frame, point is centered instead.
31012 If this is zero, point is always centered after it moves off frame.
31013 If you want scrolling to always be a line at a time, you should set
31014 `scroll-conservatively' to a large value rather than set this to 1. */);
31016 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31017 doc
: /* Scroll up to this many lines, to bring point back on screen.
31018 If point moves off-screen, redisplay will scroll by up to
31019 `scroll-conservatively' lines in order to bring point just barely
31020 onto the screen again. If that cannot be done, then redisplay
31021 recenters point as usual.
31023 If the value is greater than 100, redisplay will never recenter point,
31024 but will always scroll just enough text to bring point into view, even
31025 if you move far away.
31027 A value of zero means always recenter point if it moves off screen. */);
31028 scroll_conservatively
= 0;
31030 DEFVAR_INT ("scroll-margin", scroll_margin
,
31031 doc
: /* Number of lines of margin at the top and bottom of a window.
31032 Recenter the window whenever point gets within this many lines
31033 of the top or bottom of the window. */);
31036 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31037 doc
: /* Pixels per inch value for non-window system displays.
31038 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31039 Vdisplay_pixels_per_inch
= make_float (72.0);
31042 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31045 DEFVAR_LISP ("truncate-partial-width-windows",
31046 Vtruncate_partial_width_windows
,
31047 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31048 For an integer value, truncate lines in each window narrower than the
31049 full frame width, provided the window width is less than that integer;
31050 otherwise, respect the value of `truncate-lines'.
31052 For any other non-nil value, truncate lines in all windows that do
31053 not span the full frame width.
31055 A value of nil means to respect the value of `truncate-lines'.
31057 If `word-wrap' is enabled, you might want to reduce this. */);
31058 Vtruncate_partial_width_windows
= make_number (50);
31060 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31061 doc
: /* Maximum buffer size for which line number should be displayed.
31062 If the buffer is bigger than this, the line number does not appear
31063 in the mode line. A value of nil means no limit. */);
31064 Vline_number_display_limit
= Qnil
;
31066 DEFVAR_INT ("line-number-display-limit-width",
31067 line_number_display_limit_width
,
31068 doc
: /* Maximum line width (in characters) for line number display.
31069 If the average length of the lines near point is bigger than this, then the
31070 line number may be omitted from the mode line. */);
31071 line_number_display_limit_width
= 200;
31073 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31074 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31075 highlight_nonselected_windows
= false;
31077 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31078 doc
: /* Non-nil if more than one frame is visible on this display.
31079 Minibuffer-only frames don't count, but iconified frames do.
31080 This variable is not guaranteed to be accurate except while processing
31081 `frame-title-format' and `icon-title-format'. */);
31083 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31084 doc
: /* Template for displaying the title bar of visible frames.
31085 (Assuming the window manager supports this feature.)
31087 This variable has the same structure as `mode-line-format', except that
31088 the %c and %l constructs are ignored. It is used only on frames for
31089 which no explicit name has been set (see `modify-frame-parameters'). */);
31091 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31092 doc
: /* Template for displaying the title bar of an iconified frame.
31093 (Assuming the window manager supports this feature.)
31094 This variable has the same structure as `mode-line-format' (which see),
31095 and is used only on frames for which no explicit name has been set
31096 (see `modify-frame-parameters'). */);
31098 = Vframe_title_format
31099 = listn (CONSTYPE_PURE
, 3,
31100 intern_c_string ("multiple-frames"),
31101 build_pure_c_string ("%b"),
31102 listn (CONSTYPE_PURE
, 4,
31103 empty_unibyte_string
,
31104 intern_c_string ("invocation-name"),
31105 build_pure_c_string ("@"),
31106 intern_c_string ("system-name")));
31108 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31109 doc
: /* Maximum number of lines to keep in the message log buffer.
31110 If nil, disable message logging. If t, log messages but don't truncate
31111 the buffer when it becomes large. */);
31112 Vmessage_log_max
= make_number (1000);
31114 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31115 doc
: /* Functions called before redisplay, if window sizes have changed.
31116 The value should be a list of functions that take one argument.
31117 Just before redisplay, for each frame, if any of its windows have changed
31118 size since the last redisplay, or have been split or deleted,
31119 all the functions in the list are called, with the frame as argument. */);
31120 Vwindow_size_change_functions
= Qnil
;
31122 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31123 doc
: /* List of functions to call before redisplaying a window with scrolling.
31124 Each function is called with two arguments, the window and its new
31125 display-start position.
31126 These functions are called whenever the `window-start' marker is modified,
31127 either to point into another buffer (e.g. via `set-window-buffer') or another
31128 place in the same buffer.
31129 Note that the value of `window-end' is not valid when these functions are
31132 Warning: Do not use this feature to alter the way the window
31133 is scrolled. It is not designed for that, and such use probably won't
31135 Vwindow_scroll_functions
= Qnil
;
31137 DEFVAR_LISP ("window-text-change-functions",
31138 Vwindow_text_change_functions
,
31139 doc
: /* Functions to call in redisplay when text in the window might change. */);
31140 Vwindow_text_change_functions
= Qnil
;
31142 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31143 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31144 Each function is called with two arguments, the window and the end trigger value.
31145 See `set-window-redisplay-end-trigger'. */);
31146 Vredisplay_end_trigger_functions
= Qnil
;
31148 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31149 doc
: /* Non-nil means autoselect window with mouse pointer.
31150 If nil, do not autoselect windows.
31151 A positive number means delay autoselection by that many seconds: a
31152 window is autoselected only after the mouse has remained in that
31153 window for the duration of the delay.
31154 A negative number has a similar effect, but causes windows to be
31155 autoselected only after the mouse has stopped moving. (Because of
31156 the way Emacs compares mouse events, you will occasionally wait twice
31157 that time before the window gets selected.)
31158 Any other value means to autoselect window instantaneously when the
31159 mouse pointer enters it.
31161 Autoselection selects the minibuffer only if it is active, and never
31162 unselects the minibuffer if it is active.
31164 When customizing this variable make sure that the actual value of
31165 `focus-follows-mouse' matches the behavior of your window manager. */);
31166 Vmouse_autoselect_window
= Qnil
;
31168 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31169 doc
: /* Non-nil means automatically resize tool-bars.
31170 This dynamically changes the tool-bar's height to the minimum height
31171 that is needed to make all tool-bar items visible.
31172 If value is `grow-only', the tool-bar's height is only increased
31173 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31174 Vauto_resize_tool_bars
= Qt
;
31176 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31177 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31178 auto_raise_tool_bar_buttons_p
= true;
31180 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31181 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31182 make_cursor_line_fully_visible_p
= true;
31184 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31185 doc
: /* Border below tool-bar in pixels.
31186 If an integer, use it as the height of the border.
31187 If it is one of `internal-border-width' or `border-width', use the
31188 value of the corresponding frame parameter.
31189 Otherwise, no border is added below the tool-bar. */);
31190 Vtool_bar_border
= Qinternal_border_width
;
31192 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31193 doc
: /* Margin around tool-bar buttons in pixels.
31194 If an integer, use that for both horizontal and vertical margins.
31195 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31196 HORZ specifying the horizontal margin, and VERT specifying the
31197 vertical margin. */);
31198 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31200 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31201 doc
: /* Relief thickness of tool-bar buttons. */);
31202 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31204 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31205 doc
: /* Tool bar style to use.
31207 image - show images only
31208 text - show text only
31209 both - show both, text below image
31210 both-horiz - show text to the right of the image
31211 text-image-horiz - show text to the left of the image
31212 any other - use system default or image if no system default.
31214 This variable only affects the GTK+ toolkit version of Emacs. */);
31215 Vtool_bar_style
= Qnil
;
31217 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31218 doc
: /* Maximum number of characters a label can have to be shown.
31219 The tool bar style must also show labels for this to have any effect, see
31220 `tool-bar-style'. */);
31221 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31223 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31224 doc
: /* List of functions to call to fontify regions of text.
31225 Each function is called with one argument POS. Functions must
31226 fontify a region starting at POS in the current buffer, and give
31227 fontified regions the property `fontified'. */);
31228 Vfontification_functions
= Qnil
;
31229 Fmake_variable_buffer_local (Qfontification_functions
);
31231 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31232 unibyte_display_via_language_environment
,
31233 doc
: /* Non-nil means display unibyte text according to language environment.
31234 Specifically, this means that raw bytes in the range 160-255 decimal
31235 are displayed by converting them to the equivalent multibyte characters
31236 according to the current language environment. As a result, they are
31237 displayed according to the current fontset.
31239 Note that this variable affects only how these bytes are displayed,
31240 but does not change the fact they are interpreted as raw bytes. */);
31241 unibyte_display_via_language_environment
= false;
31243 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31244 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31245 If a float, it specifies a fraction of the mini-window frame's height.
31246 If an integer, it specifies a number of lines. */);
31247 Vmax_mini_window_height
= make_float (0.25);
31249 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31250 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31251 A value of nil means don't automatically resize mini-windows.
31252 A value of t means resize them to fit the text displayed in them.
31253 A value of `grow-only', the default, means let mini-windows grow only;
31254 they return to their normal size when the minibuffer is closed, or the
31255 echo area becomes empty. */);
31256 Vresize_mini_windows
= Qgrow_only
;
31258 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31259 doc
: /* Alist specifying how to blink the cursor off.
31260 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31261 `cursor-type' frame-parameter or variable equals ON-STATE,
31262 comparing using `equal', Emacs uses OFF-STATE to specify
31263 how to blink it off. ON-STATE and OFF-STATE are values for
31264 the `cursor-type' frame parameter.
31266 If a frame's ON-STATE has no entry in this list,
31267 the frame's other specifications determine how to blink the cursor off. */);
31268 Vblink_cursor_alist
= Qnil
;
31270 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31271 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31272 If non-nil, windows are automatically scrolled horizontally to make
31273 point visible. */);
31274 automatic_hscrolling_p
= true;
31275 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31277 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31278 doc
: /* How many columns away from the window edge point is allowed to get
31279 before automatic hscrolling will horizontally scroll the window. */);
31280 hscroll_margin
= 5;
31282 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31283 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31284 When point is less than `hscroll-margin' columns from the window
31285 edge, automatic hscrolling will scroll the window by the amount of columns
31286 determined by this variable. If its value is a positive integer, scroll that
31287 many columns. If it's a positive floating-point number, it specifies the
31288 fraction of the window's width to scroll. If it's nil or zero, point will be
31289 centered horizontally after the scroll. Any other value, including negative
31290 numbers, are treated as if the value were zero.
31292 Automatic hscrolling always moves point outside the scroll margin, so if
31293 point was more than scroll step columns inside the margin, the window will
31294 scroll more than the value given by the scroll step.
31296 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31297 and `scroll-right' overrides this variable's effect. */);
31298 Vhscroll_step
= make_number (0);
31300 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31301 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31302 Bind this around calls to `message' to let it take effect. */);
31303 message_truncate_lines
= false;
31305 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31306 doc
: /* Normal hook run to update the menu bar definitions.
31307 Redisplay runs this hook before it redisplays the menu bar.
31308 This is used to update menus such as Buffers, whose contents depend on
31310 Vmenu_bar_update_hook
= Qnil
;
31312 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31313 doc
: /* Frame for which we are updating a menu.
31314 The enable predicate for a menu binding should check this variable. */);
31315 Vmenu_updating_frame
= Qnil
;
31317 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31318 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31319 inhibit_menubar_update
= false;
31321 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31322 doc
: /* Prefix prepended to all continuation lines at display time.
31323 The value may be a string, an image, or a stretch-glyph; it is
31324 interpreted in the same way as the value of a `display' text property.
31326 This variable is overridden by any `wrap-prefix' text or overlay
31329 To add a prefix to non-continuation lines, use `line-prefix'. */);
31330 Vwrap_prefix
= Qnil
;
31331 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31332 Fmake_variable_buffer_local (Qwrap_prefix
);
31334 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31335 doc
: /* Prefix prepended to all non-continuation lines at display time.
31336 The value may be a string, an image, or a stretch-glyph; it is
31337 interpreted in the same way as the value of a `display' text property.
31339 This variable is overridden by any `line-prefix' text or overlay
31342 To add a prefix to continuation lines, use `wrap-prefix'. */);
31343 Vline_prefix
= Qnil
;
31344 DEFSYM (Qline_prefix
, "line-prefix");
31345 Fmake_variable_buffer_local (Qline_prefix
);
31347 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31348 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31349 inhibit_eval_during_redisplay
= false;
31351 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31352 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31353 inhibit_free_realized_faces
= false;
31355 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31356 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31357 Intended for use during debugging and for testing bidi display;
31358 see biditest.el in the test suite. */);
31359 inhibit_bidi_mirroring
= false;
31362 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31363 doc
: /* Inhibit try_window_id display optimization. */);
31364 inhibit_try_window_id
= false;
31366 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31367 doc
: /* Inhibit try_window_reusing display optimization. */);
31368 inhibit_try_window_reusing
= false;
31370 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31371 doc
: /* Inhibit try_cursor_movement display optimization. */);
31372 inhibit_try_cursor_movement
= false;
31373 #endif /* GLYPH_DEBUG */
31375 DEFVAR_INT ("overline-margin", overline_margin
,
31376 doc
: /* Space between overline and text, in pixels.
31377 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31378 margin to the character height. */);
31379 overline_margin
= 2;
31381 DEFVAR_INT ("underline-minimum-offset",
31382 underline_minimum_offset
,
31383 doc
: /* Minimum distance between baseline and underline.
31384 This can improve legibility of underlined text at small font sizes,
31385 particularly when using variable `x-use-underline-position-properties'
31386 with fonts that specify an UNDERLINE_POSITION relatively close to the
31387 baseline. The default value is 1. */);
31388 underline_minimum_offset
= 1;
31390 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31391 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31392 This feature only works when on a window system that can change
31393 cursor shapes. */);
31394 display_hourglass_p
= true;
31396 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31397 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31398 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31400 #ifdef HAVE_WINDOW_SYSTEM
31401 hourglass_atimer
= NULL
;
31402 hourglass_shown_p
= false;
31403 #endif /* HAVE_WINDOW_SYSTEM */
31405 /* Name of the face used to display glyphless characters. */
31406 DEFSYM (Qglyphless_char
, "glyphless-char");
31408 /* Method symbols for Vglyphless_char_display. */
31409 DEFSYM (Qhex_code
, "hex-code");
31410 DEFSYM (Qempty_box
, "empty-box");
31411 DEFSYM (Qthin_space
, "thin-space");
31412 DEFSYM (Qzero_width
, "zero-width");
31414 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31415 doc
: /* Function run just before redisplay.
31416 It is called with one argument, which is the set of windows that are to
31417 be redisplayed. This set can be nil (meaning, only the selected window),
31418 or t (meaning all windows). */);
31419 Vpre_redisplay_function
= intern ("ignore");
31421 /* Symbol for the purpose of Vglyphless_char_display. */
31422 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31423 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31425 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31426 doc
: /* Char-table defining glyphless characters.
31427 Each element, if non-nil, should be one of the following:
31428 an ASCII acronym string: display this string in a box
31429 `hex-code': display the hexadecimal code of a character in a box
31430 `empty-box': display as an empty box
31431 `thin-space': display as 1-pixel width space
31432 `zero-width': don't display
31433 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31434 display method for graphical terminals and text terminals respectively.
31435 GRAPHICAL and TEXT should each have one of the values listed above.
31437 The char-table has one extra slot to control the display of a character for
31438 which no font is found. This slot only takes effect on graphical terminals.
31439 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31440 `thin-space'. The default is `empty-box'.
31442 If a character has a non-nil entry in an active display table, the
31443 display table takes effect; in this case, Emacs does not consult
31444 `glyphless-char-display' at all. */);
31445 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31446 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31449 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31450 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31451 Vdebug_on_message
= Qnil
;
31453 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31455 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31457 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31459 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31463 /* Initialize this module when Emacs starts. */
31468 CHARPOS (this_line_start_pos
) = 0;
31470 if (!noninteractive
)
31472 struct window
*m
= XWINDOW (minibuf_window
);
31473 Lisp_Object frame
= m
->frame
;
31474 struct frame
*f
= XFRAME (frame
);
31475 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31476 struct window
*r
= XWINDOW (root
);
31479 echo_area_window
= minibuf_window
;
31481 r
->top_line
= FRAME_TOP_MARGIN (f
);
31482 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31483 r
->total_cols
= FRAME_COLS (f
);
31484 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31485 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31486 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31488 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31489 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31490 m
->total_cols
= FRAME_COLS (f
);
31491 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31492 m
->total_lines
= 1;
31493 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31495 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31496 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31497 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31499 /* The default ellipsis glyphs `...'. */
31500 for (i
= 0; i
< 3; ++i
)
31501 default_invis_vector
[i
] = make_number ('.');
31505 /* Allocate the buffer for frame titles.
31506 Also used for `format-mode-line'. */
31508 mode_line_noprop_buf
= xmalloc (size
);
31509 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31510 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31511 mode_line_target
= MODE_LINE_DISPLAY
;
31514 help_echo_showing_p
= false;
31517 #ifdef HAVE_WINDOW_SYSTEM
31519 /* Platform-independent portion of hourglass implementation. */
31521 /* Timer function of hourglass_atimer. */
31524 show_hourglass (struct atimer
*timer
)
31526 /* The timer implementation will cancel this timer automatically
31527 after this function has run. Set hourglass_atimer to null
31528 so that we know the timer doesn't have to be canceled. */
31529 hourglass_atimer
= NULL
;
31531 if (!hourglass_shown_p
)
31533 Lisp_Object tail
, frame
;
31537 FOR_EACH_FRAME (tail
, frame
)
31539 struct frame
*f
= XFRAME (frame
);
31541 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31542 && FRAME_RIF (f
)->show_hourglass
)
31543 FRAME_RIF (f
)->show_hourglass (f
);
31546 hourglass_shown_p
= true;
31551 /* Cancel a currently active hourglass timer, and start a new one. */
31554 start_hourglass (void)
31556 struct timespec delay
;
31558 cancel_hourglass ();
31560 if (INTEGERP (Vhourglass_delay
)
31561 && XINT (Vhourglass_delay
) > 0)
31562 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31563 TYPE_MAXIMUM (time_t)),
31565 else if (FLOATP (Vhourglass_delay
)
31566 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31567 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31569 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31571 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31572 show_hourglass
, NULL
);
31575 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31579 cancel_hourglass (void)
31581 if (hourglass_atimer
)
31583 cancel_atimer (hourglass_atimer
);
31584 hourglass_atimer
= NULL
;
31587 if (hourglass_shown_p
)
31589 Lisp_Object tail
, frame
;
31593 FOR_EACH_FRAME (tail
, frame
)
31595 struct frame
*f
= XFRAME (frame
);
31597 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31598 && FRAME_RIF (f
)->hide_hourglass
)
31599 FRAME_RIF (f
)->hide_hourglass (f
);
31601 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31602 else if (!FRAME_W32_P (f
))
31603 w32_arrow_cursor ();
31607 hourglass_shown_p
= false;
31612 #endif /* HAVE_WINDOW_SYSTEM */