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 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13373 /* No redisplay if running in batch mode or frame is not yet fully
13374 initialized, or redisplay is explicitly turned off by setting
13375 Vinhibit_redisplay. */
13376 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13377 || !NILP (Vinhibit_redisplay
))
13380 /* Don't examine these until after testing Vinhibit_redisplay.
13381 When Emacs is shutting down, perhaps because its connection to
13382 X has dropped, we should not look at them at all. */
13383 fr
= XFRAME (w
->frame
);
13384 sf
= SELECTED_FRAME ();
13386 if (!fr
->glyphs_initialized_p
)
13389 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13390 if (popup_activated ())
13394 /* I don't think this happens but let's be paranoid. */
13395 if (redisplaying_p
)
13398 /* Record a function that clears redisplaying_p
13399 when we leave this function. */
13400 count
= SPECPDL_INDEX ();
13401 record_unwind_protect_void (unwind_redisplay
);
13402 redisplaying_p
= true;
13403 specbind (Qinhibit_free_realized_faces
, Qnil
);
13405 /* Record this function, so it appears on the profiler's backtraces. */
13406 record_in_backtrace (Qredisplay_internal
, 0, 0);
13408 FOR_EACH_FRAME (tail
, frame
)
13409 XFRAME (frame
)->already_hscrolled_p
= false;
13412 /* Remember the currently selected window. */
13416 forget_escape_and_glyphless_faces ();
13418 inhibit_free_realized_faces
= false;
13420 /* If face_change, init_iterator will free all realized faces, which
13421 includes the faces referenced from current matrices. So, we
13422 can't reuse current matrices in this case. */
13424 windows_or_buffers_changed
= 47;
13426 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13427 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13429 /* Since frames on a single ASCII terminal share the same
13430 display area, displaying a different frame means redisplay
13431 the whole thing. */
13432 SET_FRAME_GARBAGED (sf
);
13434 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13436 FRAME_TTY (sf
)->previous_frame
= sf
;
13439 /* Set the visible flags for all frames. Do this before checking for
13440 resized or garbaged frames; they want to know if their frames are
13441 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13442 number_of_visible_frames
= 0;
13444 FOR_EACH_FRAME (tail
, frame
)
13446 struct frame
*f
= XFRAME (frame
);
13448 if (FRAME_VISIBLE_P (f
))
13450 ++number_of_visible_frames
;
13451 /* Adjust matrices for visible frames only. */
13452 if (f
->fonts_changed
)
13454 adjust_frame_glyphs (f
);
13455 /* Disable all redisplay optimizations for this frame.
13456 This is because adjust_frame_glyphs resets the
13457 enabled_p flag for all glyph rows of all windows, so
13458 many optimizations will fail anyway, and some might
13459 fail to test that flag and do bogus things as
13461 SET_FRAME_GARBAGED (f
);
13462 f
->fonts_changed
= false;
13464 /* If cursor type has been changed on the frame
13465 other than selected, consider all frames. */
13466 if (f
!= sf
&& f
->cursor_type_changed
)
13467 fset_redisplay (f
);
13469 clear_desired_matrices (f
);
13472 /* Notice any pending interrupt request to change frame size. */
13473 do_pending_window_change (true);
13475 /* do_pending_window_change could change the selected_window due to
13476 frame resizing which makes the selected window too small. */
13477 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13480 /* Clear frames marked as garbaged. */
13481 clear_garbaged_frames ();
13483 /* Build menubar and tool-bar items. */
13484 if (NILP (Vmemory_full
))
13485 prepare_menu_bars ();
13487 reconsider_clip_changes (w
);
13489 /* In most cases selected window displays current buffer. */
13490 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13493 /* Detect case that we need to write or remove a star in the mode line. */
13494 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13495 w
->update_mode_line
= true;
13497 if (mode_line_update_needed (w
))
13498 w
->update_mode_line
= true;
13500 /* If reconsider_clip_changes above decided that the narrowing
13501 in the current buffer changed, make sure all other windows
13502 showing that buffer will be redisplayed. */
13503 if (current_buffer
->clip_changed
)
13504 bset_update_mode_line (current_buffer
);
13507 /* Normally the message* functions will have already displayed and
13508 updated the echo area, but the frame may have been trashed, or
13509 the update may have been preempted, so display the echo area
13510 again here. Checking message_cleared_p captures the case that
13511 the echo area should be cleared. */
13512 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13513 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13514 || (message_cleared_p
13515 && minibuf_level
== 0
13516 /* If the mini-window is currently selected, this means the
13517 echo-area doesn't show through. */
13518 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13520 echo_area_display (false);
13522 if (message_cleared_p
)
13523 update_miniwindow_p
= true;
13525 must_finish
= true;
13527 /* If we don't display the current message, don't clear the
13528 message_cleared_p flag, because, if we did, we wouldn't clear
13529 the echo area in the next redisplay which doesn't preserve
13531 if (!display_last_displayed_message_p
)
13532 message_cleared_p
= false;
13534 else if (EQ (selected_window
, minibuf_window
)
13535 && (current_buffer
->clip_changed
|| window_outdated (w
))
13536 && resize_mini_window (w
, false))
13538 /* Resized active mini-window to fit the size of what it is
13539 showing if its contents might have changed. */
13540 must_finish
= true;
13542 /* If window configuration was changed, frames may have been
13543 marked garbaged. Clear them or we will experience
13544 surprises wrt scrolling. */
13545 clear_garbaged_frames ();
13548 if (windows_or_buffers_changed
&& !update_mode_lines
)
13549 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13550 only the windows's contents needs to be refreshed, or whether the
13551 mode-lines also need a refresh. */
13552 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13553 ? REDISPLAY_SOME
: 32);
13555 /* If specs for an arrow have changed, do thorough redisplay
13556 to ensure we remove any arrow that should no longer exist. */
13557 if (overlay_arrows_changed_p ())
13558 /* Apparently, this is the only case where we update other windows,
13559 without updating other mode-lines. */
13560 windows_or_buffers_changed
= 49;
13562 consider_all_windows_p
= (update_mode_lines
13563 || windows_or_buffers_changed
);
13565 #define AINC(a,i) \
13567 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13568 if (INTEGERP (entry)) \
13569 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13572 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13573 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13575 /* Optimize the case that only the line containing the cursor in the
13576 selected window has changed. Variables starting with this_ are
13577 set in display_line and record information about the line
13578 containing the cursor. */
13579 tlbufpos
= this_line_start_pos
;
13580 tlendpos
= this_line_end_pos
;
13581 if (!consider_all_windows_p
13582 && CHARPOS (tlbufpos
) > 0
13583 && !w
->update_mode_line
13584 && !current_buffer
->clip_changed
13585 && !current_buffer
->prevent_redisplay_optimizations_p
13586 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13587 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13588 && !XFRAME (w
->frame
)->cursor_type_changed
13589 && !XFRAME (w
->frame
)->face_change
13590 /* Make sure recorded data applies to current buffer, etc. */
13591 && this_line_buffer
== current_buffer
13594 && !w
->optional_new_start
13595 /* Point must be on the line that we have info recorded about. */
13596 && PT
>= CHARPOS (tlbufpos
)
13597 && PT
<= Z
- CHARPOS (tlendpos
)
13598 /* All text outside that line, including its final newline,
13599 must be unchanged. */
13600 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13601 CHARPOS (tlendpos
)))
13603 if (CHARPOS (tlbufpos
) > BEGV
13604 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13605 && (CHARPOS (tlbufpos
) == ZV
13606 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13607 /* Former continuation line has disappeared by becoming empty. */
13609 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13611 /* We have to handle the case of continuation around a
13612 wide-column character (see the comment in indent.c around
13615 For instance, in the following case:
13617 -------- Insert --------
13618 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13619 J_I_ ==> J_I_ `^^' are cursors.
13623 As we have to redraw the line above, we cannot use this
13627 int line_height_before
= this_line_pixel_height
;
13629 /* Note that start_display will handle the case that the
13630 line starting at tlbufpos is a continuation line. */
13631 start_display (&it
, w
, tlbufpos
);
13633 /* Implementation note: It this still necessary? */
13634 if (it
.current_x
!= this_line_start_x
)
13637 TRACE ((stderr
, "trying display optimization 1\n"));
13638 w
->cursor
.vpos
= -1;
13639 overlay_arrow_seen
= false;
13640 it
.vpos
= this_line_vpos
;
13641 it
.current_y
= this_line_y
;
13642 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13643 display_line (&it
);
13645 /* If line contains point, is not continued,
13646 and ends at same distance from eob as before, we win. */
13647 if (w
->cursor
.vpos
>= 0
13648 /* Line is not continued, otherwise this_line_start_pos
13649 would have been set to 0 in display_line. */
13650 && CHARPOS (this_line_start_pos
)
13651 /* Line ends as before. */
13652 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13653 /* Line has same height as before. Otherwise other lines
13654 would have to be shifted up or down. */
13655 && this_line_pixel_height
== line_height_before
)
13657 /* If this is not the window's last line, we must adjust
13658 the charstarts of the lines below. */
13659 if (it
.current_y
< it
.last_visible_y
)
13661 struct glyph_row
*row
13662 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13663 ptrdiff_t delta
, delta_bytes
;
13665 /* We used to distinguish between two cases here,
13666 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13667 when the line ends in a newline or the end of the
13668 buffer's accessible portion. But both cases did
13669 the same, so they were collapsed. */
13671 - CHARPOS (tlendpos
)
13672 - MATRIX_ROW_START_CHARPOS (row
));
13673 delta_bytes
= (Z_BYTE
13674 - BYTEPOS (tlendpos
)
13675 - MATRIX_ROW_START_BYTEPOS (row
));
13677 increment_matrix_positions (w
->current_matrix
,
13678 this_line_vpos
+ 1,
13679 w
->current_matrix
->nrows
,
13680 delta
, delta_bytes
);
13683 /* If this row displays text now but previously didn't,
13684 or vice versa, w->window_end_vpos may have to be
13686 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13688 if (w
->window_end_vpos
< this_line_vpos
)
13689 w
->window_end_vpos
= this_line_vpos
;
13691 else if (w
->window_end_vpos
== this_line_vpos
13692 && this_line_vpos
> 0)
13693 w
->window_end_vpos
= this_line_vpos
- 1;
13694 w
->window_end_valid
= false;
13696 /* Update hint: No need to try to scroll in update_window. */
13697 w
->desired_matrix
->no_scrolling_p
= true;
13700 *w
->desired_matrix
->method
= 0;
13701 debug_method_add (w
, "optimization 1");
13703 #ifdef HAVE_WINDOW_SYSTEM
13704 update_window_fringes (w
, false);
13711 else if (/* Cursor position hasn't changed. */
13712 PT
== w
->last_point
13713 /* Make sure the cursor was last displayed
13714 in this window. Otherwise we have to reposition it. */
13716 /* PXW: Must be converted to pixels, probably. */
13717 && 0 <= w
->cursor
.vpos
13718 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13722 do_pending_window_change (true);
13723 /* If selected_window changed, redisplay again. */
13724 if (WINDOWP (selected_window
)
13725 && (w
= XWINDOW (selected_window
)) != sw
)
13728 /* We used to always goto end_of_redisplay here, but this
13729 isn't enough if we have a blinking cursor. */
13730 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13731 goto end_of_redisplay
;
13735 /* If highlighting the region, or if the cursor is in the echo area,
13736 then we can't just move the cursor. */
13737 else if (NILP (Vshow_trailing_whitespace
)
13738 && !cursor_in_echo_area
)
13741 struct glyph_row
*row
;
13743 /* Skip from tlbufpos to PT and see where it is. Note that
13744 PT may be in invisible text. If so, we will end at the
13745 next visible position. */
13746 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13747 NULL
, DEFAULT_FACE_ID
);
13748 it
.current_x
= this_line_start_x
;
13749 it
.current_y
= this_line_y
;
13750 it
.vpos
= this_line_vpos
;
13752 /* The call to move_it_to stops in front of PT, but
13753 moves over before-strings. */
13754 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13756 if (it
.vpos
== this_line_vpos
13757 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13760 eassert (this_line_vpos
== it
.vpos
);
13761 eassert (this_line_y
== it
.current_y
);
13762 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13764 *w
->desired_matrix
->method
= 0;
13765 debug_method_add (w
, "optimization 3");
13774 /* Text changed drastically or point moved off of line. */
13775 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13778 CHARPOS (this_line_start_pos
) = 0;
13779 ++clear_face_cache_count
;
13780 #ifdef HAVE_WINDOW_SYSTEM
13781 ++clear_image_cache_count
;
13784 /* Build desired matrices, and update the display. If
13785 consider_all_windows_p, do it for all windows on all frames that
13786 require redisplay, as specified by their 'redisplay' flag.
13787 Otherwise do it for selected_window, only. */
13789 if (consider_all_windows_p
)
13791 FOR_EACH_FRAME (tail
, frame
)
13792 XFRAME (frame
)->updated_p
= false;
13794 propagate_buffer_redisplay ();
13796 FOR_EACH_FRAME (tail
, frame
)
13798 struct frame
*f
= XFRAME (frame
);
13800 /* We don't have to do anything for unselected terminal
13802 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13803 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13807 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13810 /* Only GC scrollbars when we redisplay the whole frame. */
13811 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13812 /* Mark all the scroll bars to be removed; we'll redeem
13813 the ones we want when we redisplay their windows. */
13814 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13815 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13817 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13818 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13819 /* Remember that the invisible frames need to be redisplayed next
13820 time they're visible. */
13821 else if (!REDISPLAY_SOME_P ())
13822 f
->redisplay
= true;
13824 /* The X error handler may have deleted that frame. */
13825 if (!FRAME_LIVE_P (f
))
13828 /* Any scroll bars which redisplay_windows should have
13829 nuked should now go away. */
13830 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13831 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13833 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13835 /* If fonts changed on visible frame, display again. */
13836 if (f
->fonts_changed
)
13838 adjust_frame_glyphs (f
);
13839 /* Disable all redisplay optimizations for this
13840 frame. For the reasons, see the comment near
13841 the previous call to adjust_frame_glyphs above. */
13842 SET_FRAME_GARBAGED (f
);
13843 f
->fonts_changed
= false;
13847 /* See if we have to hscroll. */
13848 if (!f
->already_hscrolled_p
)
13850 f
->already_hscrolled_p
= true;
13851 if (hscroll_windows (f
->root_window
))
13855 /* Prevent various kinds of signals during display
13856 update. stdio is not robust about handling
13857 signals, which can cause an apparent I/O error. */
13858 if (interrupt_input
)
13859 unrequest_sigio ();
13862 pending
|= update_frame (f
, false, false);
13863 f
->cursor_type_changed
= false;
13864 f
->updated_p
= true;
13869 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13873 /* Do the mark_window_display_accurate after all windows have
13874 been redisplayed because this call resets flags in buffers
13875 which are needed for proper redisplay. */
13876 FOR_EACH_FRAME (tail
, frame
)
13878 struct frame
*f
= XFRAME (frame
);
13881 f
->redisplay
= false;
13882 mark_window_display_accurate (f
->root_window
, true);
13883 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13884 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13889 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13891 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13892 struct frame
*mini_frame
;
13894 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13895 /* Use list_of_error, not Qerror, so that
13896 we catch only errors and don't run the debugger. */
13897 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13899 redisplay_window_error
);
13900 if (update_miniwindow_p
)
13901 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13903 redisplay_window_error
);
13905 /* Compare desired and current matrices, perform output. */
13908 /* If fonts changed, display again. */
13909 if (sf
->fonts_changed
)
13912 /* Prevent freeing of realized faces, since desired matrices are
13913 pending that reference the faces we computed and cached. */
13914 inhibit_free_realized_faces
= true;
13916 /* Prevent various kinds of signals during display update.
13917 stdio is not robust about handling signals,
13918 which can cause an apparent I/O error. */
13919 if (interrupt_input
)
13920 unrequest_sigio ();
13923 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13925 if (hscroll_windows (selected_window
))
13928 XWINDOW (selected_window
)->must_be_updated_p
= true;
13929 pending
= update_frame (sf
, false, false);
13930 sf
->cursor_type_changed
= false;
13933 /* We may have called echo_area_display at the top of this
13934 function. If the echo area is on another frame, that may
13935 have put text on a frame other than the selected one, so the
13936 above call to update_frame would not have caught it. Catch
13938 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13939 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13941 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13943 XWINDOW (mini_window
)->must_be_updated_p
= true;
13944 pending
|= update_frame (mini_frame
, false, false);
13945 mini_frame
->cursor_type_changed
= false;
13946 if (!pending
&& hscroll_windows (mini_window
))
13951 /* If display was paused because of pending input, make sure we do a
13952 thorough update the next time. */
13955 /* Prevent the optimization at the beginning of
13956 redisplay_internal that tries a single-line update of the
13957 line containing the cursor in the selected window. */
13958 CHARPOS (this_line_start_pos
) = 0;
13960 /* Let the overlay arrow be updated the next time. */
13961 update_overlay_arrows (0);
13963 /* If we pause after scrolling, some rows in the current
13964 matrices of some windows are not valid. */
13965 if (!WINDOW_FULL_WIDTH_P (w
)
13966 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13967 update_mode_lines
= 36;
13971 if (!consider_all_windows_p
)
13973 /* This has already been done above if
13974 consider_all_windows_p is set. */
13975 if (XBUFFER (w
->contents
)->text
->redisplay
13976 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13977 /* This can happen if b->text->redisplay was set during
13979 propagate_buffer_redisplay ();
13980 mark_window_display_accurate_1 (w
, true);
13982 /* Say overlay arrows are up to date. */
13983 update_overlay_arrows (1);
13985 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13986 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13989 update_mode_lines
= 0;
13990 windows_or_buffers_changed
= 0;
13993 /* Start SIGIO interrupts coming again. Having them off during the
13994 code above makes it less likely one will discard output, but not
13995 impossible, since there might be stuff in the system buffer here.
13996 But it is much hairier to try to do anything about that. */
13997 if (interrupt_input
)
14001 /* If a frame has become visible which was not before, redisplay
14002 again, so that we display it. Expose events for such a frame
14003 (which it gets when becoming visible) don't call the parts of
14004 redisplay constructing glyphs, so simply exposing a frame won't
14005 display anything in this case. So, we have to display these
14006 frames here explicitly. */
14011 FOR_EACH_FRAME (tail
, frame
)
14013 if (XFRAME (frame
)->visible
)
14017 if (new_count
!= number_of_visible_frames
)
14018 windows_or_buffers_changed
= 52;
14021 /* Change frame size now if a change is pending. */
14022 do_pending_window_change (true);
14024 /* If we just did a pending size change, or have additional
14025 visible frames, or selected_window changed, redisplay again. */
14026 if ((windows_or_buffers_changed
&& !pending
)
14027 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14030 /* Clear the face and image caches.
14032 We used to do this only if consider_all_windows_p. But the cache
14033 needs to be cleared if a timer creates images in the current
14034 buffer (e.g. the test case in Bug#6230). */
14036 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14038 clear_face_cache (false);
14039 clear_face_cache_count
= 0;
14042 #ifdef HAVE_WINDOW_SYSTEM
14043 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14045 clear_image_caches (Qnil
);
14046 clear_image_cache_count
= 0;
14048 #endif /* HAVE_WINDOW_SYSTEM */
14052 ns_set_doc_edited ();
14054 if (interrupt_input
&& interrupts_deferred
)
14057 unbind_to (count
, Qnil
);
14062 /* Redisplay, but leave alone any recent echo area message unless
14063 another message has been requested in its place.
14065 This is useful in situations where you need to redisplay but no
14066 user action has occurred, making it inappropriate for the message
14067 area to be cleared. See tracking_off and
14068 wait_reading_process_output for examples of these situations.
14070 FROM_WHERE is an integer saying from where this function was
14071 called. This is useful for debugging. */
14074 redisplay_preserve_echo_area (int from_where
)
14076 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14078 if (!NILP (echo_area_buffer
[1]))
14080 /* We have a previously displayed message, but no current
14081 message. Redisplay the previous message. */
14082 display_last_displayed_message_p
= true;
14083 redisplay_internal ();
14084 display_last_displayed_message_p
= false;
14087 redisplay_internal ();
14089 flush_frame (SELECTED_FRAME ());
14093 /* Function registered with record_unwind_protect in redisplay_internal. */
14096 unwind_redisplay (void)
14098 redisplaying_p
= false;
14102 /* Mark the display of leaf window W as accurate or inaccurate.
14103 If ACCURATE_P, mark display of W as accurate.
14104 If !ACCURATE_P, arrange for W to be redisplayed the next
14105 time redisplay_internal is called. */
14108 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14110 struct buffer
*b
= XBUFFER (w
->contents
);
14112 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14113 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14114 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14118 b
->clip_changed
= false;
14119 b
->prevent_redisplay_optimizations_p
= false;
14120 eassert (buffer_window_count (b
) > 0);
14121 /* Resetting b->text->redisplay is problematic!
14122 In order to make it safer to do it here, redisplay_internal must
14123 have copied all b->text->redisplay to their respective windows. */
14124 b
->text
->redisplay
= false;
14126 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14127 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14128 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14129 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14131 w
->current_matrix
->buffer
= b
;
14132 w
->current_matrix
->begv
= BUF_BEGV (b
);
14133 w
->current_matrix
->zv
= BUF_ZV (b
);
14135 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14136 w
->last_cursor_off_p
= w
->cursor_off_p
;
14138 if (w
== XWINDOW (selected_window
))
14139 w
->last_point
= BUF_PT (b
);
14141 w
->last_point
= marker_position (w
->pointm
);
14143 w
->window_end_valid
= true;
14144 w
->update_mode_line
= false;
14147 w
->redisplay
= !accurate_p
;
14151 /* Mark the display of windows in the window tree rooted at WINDOW as
14152 accurate or inaccurate. If ACCURATE_P, mark display of
14153 windows as accurate. If !ACCURATE_P, arrange for windows to
14154 be redisplayed the next time redisplay_internal is called. */
14157 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14161 for (; !NILP (window
); window
= w
->next
)
14163 w
= XWINDOW (window
);
14164 if (WINDOWP (w
->contents
))
14165 mark_window_display_accurate (w
->contents
, accurate_p
);
14167 mark_window_display_accurate_1 (w
, accurate_p
);
14171 update_overlay_arrows (1);
14173 /* Force a thorough redisplay the next time by setting
14174 last_arrow_position and last_arrow_string to t, which is
14175 unequal to any useful value of Voverlay_arrow_... */
14176 update_overlay_arrows (-1);
14180 /* Return value in display table DP (Lisp_Char_Table *) for character
14181 C. Since a display table doesn't have any parent, we don't have to
14182 follow parent. Do not call this function directly but use the
14183 macro DISP_CHAR_VECTOR. */
14186 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14190 if (ASCII_CHAR_P (c
))
14193 if (SUB_CHAR_TABLE_P (val
))
14194 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14200 XSETCHAR_TABLE (table
, dp
);
14201 val
= char_table_ref (table
, c
);
14210 /***********************************************************************
14212 ***********************************************************************/
14214 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14217 redisplay_windows (Lisp_Object window
)
14219 while (!NILP (window
))
14221 struct window
*w
= XWINDOW (window
);
14223 if (WINDOWP (w
->contents
))
14224 redisplay_windows (w
->contents
);
14225 else if (BUFFERP (w
->contents
))
14227 displayed_buffer
= XBUFFER (w
->contents
);
14228 /* Use list_of_error, not Qerror, so that
14229 we catch only errors and don't run the debugger. */
14230 internal_condition_case_1 (redisplay_window_0
, window
,
14232 redisplay_window_error
);
14240 redisplay_window_error (Lisp_Object ignore
)
14242 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14247 redisplay_window_0 (Lisp_Object window
)
14249 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14250 redisplay_window (window
, false);
14255 redisplay_window_1 (Lisp_Object window
)
14257 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14258 redisplay_window (window
, true);
14263 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14264 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14265 which positions recorded in ROW differ from current buffer
14268 Return true iff cursor is on this row. */
14271 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14272 struct glyph_matrix
*matrix
,
14273 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14276 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14277 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14278 struct glyph
*cursor
= NULL
;
14279 /* The last known character position in row. */
14280 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14282 ptrdiff_t pt_old
= PT
- delta
;
14283 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14284 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14285 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14286 /* A glyph beyond the edge of TEXT_AREA which we should never
14288 struct glyph
*glyphs_end
= end
;
14289 /* True means we've found a match for cursor position, but that
14290 glyph has the avoid_cursor_p flag set. */
14291 bool match_with_avoid_cursor
= false;
14292 /* True means we've seen at least one glyph that came from a
14294 bool string_seen
= false;
14295 /* Largest and smallest buffer positions seen so far during scan of
14297 ptrdiff_t bpos_max
= pos_before
;
14298 ptrdiff_t bpos_min
= pos_after
;
14299 /* Last buffer position covered by an overlay string with an integer
14300 `cursor' property. */
14301 ptrdiff_t bpos_covered
= 0;
14302 /* True means the display string on which to display the cursor
14303 comes from a text property, not from an overlay. */
14304 bool string_from_text_prop
= false;
14306 /* Don't even try doing anything if called for a mode-line or
14307 header-line row, since the rest of the code isn't prepared to
14308 deal with such calamities. */
14309 eassert (!row
->mode_line_p
);
14310 if (row
->mode_line_p
)
14313 /* Skip over glyphs not having an object at the start and the end of
14314 the row. These are special glyphs like truncation marks on
14315 terminal frames. */
14316 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14318 if (!row
->reversed_p
)
14321 && NILP (glyph
->object
)
14322 && glyph
->charpos
< 0)
14324 x
+= glyph
->pixel_width
;
14328 && NILP ((end
- 1)->object
)
14329 /* CHARPOS is zero for blanks and stretch glyphs
14330 inserted by extend_face_to_end_of_line. */
14331 && (end
- 1)->charpos
<= 0)
14333 glyph_before
= glyph
- 1;
14340 /* If the glyph row is reversed, we need to process it from back
14341 to front, so swap the edge pointers. */
14342 glyphs_end
= end
= glyph
- 1;
14343 glyph
+= row
->used
[TEXT_AREA
] - 1;
14345 while (glyph
> end
+ 1
14346 && NILP (glyph
->object
)
14347 && glyph
->charpos
< 0)
14350 x
-= glyph
->pixel_width
;
14352 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14354 /* By default, in reversed rows we put the cursor on the
14355 rightmost (first in the reading order) glyph. */
14356 for (g
= end
+ 1; g
< glyph
; g
++)
14357 x
+= g
->pixel_width
;
14359 && NILP ((end
+ 1)->object
)
14360 && (end
+ 1)->charpos
<= 0)
14362 glyph_before
= glyph
+ 1;
14366 else if (row
->reversed_p
)
14368 /* In R2L rows that don't display text, put the cursor on the
14369 rightmost glyph. Case in point: an empty last line that is
14370 part of an R2L paragraph. */
14372 /* Avoid placing the cursor on the last glyph of the row, where
14373 on terminal frames we hold the vertical border between
14374 adjacent windows. */
14375 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14376 && !WINDOW_RIGHTMOST_P (w
)
14377 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14379 x
= -1; /* will be computed below, at label compute_x */
14382 /* Step 1: Try to find the glyph whose character position
14383 corresponds to point. If that's not possible, find 2 glyphs
14384 whose character positions are the closest to point, one before
14385 point, the other after it. */
14386 if (!row
->reversed_p
)
14387 while (/* not marched to end of glyph row */
14389 /* glyph was not inserted by redisplay for internal purposes */
14390 && !NILP (glyph
->object
))
14392 if (BUFFERP (glyph
->object
))
14394 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14396 if (glyph
->charpos
> bpos_max
)
14397 bpos_max
= glyph
->charpos
;
14398 if (glyph
->charpos
< bpos_min
)
14399 bpos_min
= glyph
->charpos
;
14400 if (!glyph
->avoid_cursor_p
)
14402 /* If we hit point, we've found the glyph on which to
14403 display the cursor. */
14406 match_with_avoid_cursor
= false;
14409 /* See if we've found a better approximation to
14410 POS_BEFORE or to POS_AFTER. */
14411 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14413 pos_before
= glyph
->charpos
;
14414 glyph_before
= glyph
;
14416 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14418 pos_after
= glyph
->charpos
;
14419 glyph_after
= glyph
;
14422 else if (dpos
== 0)
14423 match_with_avoid_cursor
= true;
14425 else if (STRINGP (glyph
->object
))
14427 Lisp_Object chprop
;
14428 ptrdiff_t glyph_pos
= glyph
->charpos
;
14430 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14432 if (!NILP (chprop
))
14434 /* If the string came from a `display' text property,
14435 look up the buffer position of that property and
14436 use that position to update bpos_max, as if we
14437 actually saw such a position in one of the row's
14438 glyphs. This helps with supporting integer values
14439 of `cursor' property on the display string in
14440 situations where most or all of the row's buffer
14441 text is completely covered by display properties,
14442 so that no glyph with valid buffer positions is
14443 ever seen in the row. */
14444 ptrdiff_t prop_pos
=
14445 string_buffer_position_lim (glyph
->object
, pos_before
,
14448 if (prop_pos
>= pos_before
)
14449 bpos_max
= prop_pos
;
14451 if (INTEGERP (chprop
))
14453 bpos_covered
= bpos_max
+ XINT (chprop
);
14454 /* If the `cursor' property covers buffer positions up
14455 to and including point, we should display cursor on
14456 this glyph. Note that, if a `cursor' property on one
14457 of the string's characters has an integer value, we
14458 will break out of the loop below _before_ we get to
14459 the position match above. IOW, integer values of
14460 the `cursor' property override the "exact match for
14461 point" strategy of positioning the cursor. */
14462 /* Implementation note: bpos_max == pt_old when, e.g.,
14463 we are in an empty line, where bpos_max is set to
14464 MATRIX_ROW_START_CHARPOS, see above. */
14465 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14472 string_seen
= true;
14474 x
+= glyph
->pixel_width
;
14477 else if (glyph
> end
) /* row is reversed */
14478 while (!NILP (glyph
->object
))
14480 if (BUFFERP (glyph
->object
))
14482 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14484 if (glyph
->charpos
> bpos_max
)
14485 bpos_max
= glyph
->charpos
;
14486 if (glyph
->charpos
< bpos_min
)
14487 bpos_min
= glyph
->charpos
;
14488 if (!glyph
->avoid_cursor_p
)
14492 match_with_avoid_cursor
= false;
14495 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14497 pos_before
= glyph
->charpos
;
14498 glyph_before
= glyph
;
14500 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14502 pos_after
= glyph
->charpos
;
14503 glyph_after
= glyph
;
14506 else if (dpos
== 0)
14507 match_with_avoid_cursor
= true;
14509 else if (STRINGP (glyph
->object
))
14511 Lisp_Object chprop
;
14512 ptrdiff_t glyph_pos
= glyph
->charpos
;
14514 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14516 if (!NILP (chprop
))
14518 ptrdiff_t prop_pos
=
14519 string_buffer_position_lim (glyph
->object
, pos_before
,
14522 if (prop_pos
>= pos_before
)
14523 bpos_max
= prop_pos
;
14525 if (INTEGERP (chprop
))
14527 bpos_covered
= bpos_max
+ XINT (chprop
);
14528 /* If the `cursor' property covers buffer positions up
14529 to and including point, we should display cursor on
14531 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14537 string_seen
= true;
14540 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14542 x
--; /* can't use any pixel_width */
14545 x
-= glyph
->pixel_width
;
14548 /* Step 2: If we didn't find an exact match for point, we need to
14549 look for a proper place to put the cursor among glyphs between
14550 GLYPH_BEFORE and GLYPH_AFTER. */
14551 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14552 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14553 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14555 /* An empty line has a single glyph whose OBJECT is nil and
14556 whose CHARPOS is the position of a newline on that line.
14557 Note that on a TTY, there are more glyphs after that, which
14558 were produced by extend_face_to_end_of_line, but their
14559 CHARPOS is zero or negative. */
14560 bool empty_line_p
=
14561 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14562 && NILP (glyph
->object
) && glyph
->charpos
> 0
14563 /* On a TTY, continued and truncated rows also have a glyph at
14564 their end whose OBJECT is nil and whose CHARPOS is
14565 positive (the continuation and truncation glyphs), but such
14566 rows are obviously not "empty". */
14567 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14569 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14571 ptrdiff_t ellipsis_pos
;
14573 /* Scan back over the ellipsis glyphs. */
14574 if (!row
->reversed_p
)
14576 ellipsis_pos
= (glyph
- 1)->charpos
;
14577 while (glyph
> row
->glyphs
[TEXT_AREA
]
14578 && (glyph
- 1)->charpos
== ellipsis_pos
)
14579 glyph
--, x
-= glyph
->pixel_width
;
14580 /* That loop always goes one position too far, including
14581 the glyph before the ellipsis. So scan forward over
14583 x
+= glyph
->pixel_width
;
14586 else /* row is reversed */
14588 ellipsis_pos
= (glyph
+ 1)->charpos
;
14589 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14590 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14591 glyph
++, x
+= glyph
->pixel_width
;
14592 x
-= glyph
->pixel_width
;
14596 else if (match_with_avoid_cursor
)
14598 cursor
= glyph_after
;
14601 else if (string_seen
)
14603 int incr
= row
->reversed_p
? -1 : +1;
14605 /* Need to find the glyph that came out of a string which is
14606 present at point. That glyph is somewhere between
14607 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14608 positioned between POS_BEFORE and POS_AFTER in the
14610 struct glyph
*start
, *stop
;
14611 ptrdiff_t pos
= pos_before
;
14615 /* If the row ends in a newline from a display string,
14616 reordering could have moved the glyphs belonging to the
14617 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14618 in this case we extend the search to the last glyph in
14619 the row that was not inserted by redisplay. */
14620 if (row
->ends_in_newline_from_string_p
)
14623 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14626 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14627 correspond to POS_BEFORE and POS_AFTER, respectively. We
14628 need START and STOP in the order that corresponds to the
14629 row's direction as given by its reversed_p flag. If the
14630 directionality of characters between POS_BEFORE and
14631 POS_AFTER is the opposite of the row's base direction,
14632 these characters will have been reordered for display,
14633 and we need to reverse START and STOP. */
14634 if (!row
->reversed_p
)
14636 start
= min (glyph_before
, glyph_after
);
14637 stop
= max (glyph_before
, glyph_after
);
14641 start
= max (glyph_before
, glyph_after
);
14642 stop
= min (glyph_before
, glyph_after
);
14644 for (glyph
= start
+ incr
;
14645 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14648 /* Any glyphs that come from the buffer are here because
14649 of bidi reordering. Skip them, and only pay
14650 attention to glyphs that came from some string. */
14651 if (STRINGP (glyph
->object
))
14655 /* If the display property covers the newline, we
14656 need to search for it one position farther. */
14657 ptrdiff_t lim
= pos_after
14658 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14660 string_from_text_prop
= false;
14661 str
= glyph
->object
;
14662 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14663 if (tem
== 0 /* from overlay */
14666 /* If the string from which this glyph came is
14667 found in the buffer at point, or at position
14668 that is closer to point than pos_after, then
14669 we've found the glyph we've been looking for.
14670 If it comes from an overlay (tem == 0), and
14671 it has the `cursor' property on one of its
14672 glyphs, record that glyph as a candidate for
14673 displaying the cursor. (As in the
14674 unidirectional version, we will display the
14675 cursor on the last candidate we find.) */
14678 || (tem
- pt_old
> 0 && tem
< pos_after
))
14680 /* The glyphs from this string could have
14681 been reordered. Find the one with the
14682 smallest string position. Or there could
14683 be a character in the string with the
14684 `cursor' property, which means display
14685 cursor on that character's glyph. */
14686 ptrdiff_t strpos
= glyph
->charpos
;
14691 string_from_text_prop
= true;
14694 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14695 && EQ (glyph
->object
, str
);
14699 ptrdiff_t gpos
= glyph
->charpos
;
14701 cprop
= Fget_char_property (make_number (gpos
),
14709 if (tem
&& glyph
->charpos
< strpos
)
14711 strpos
= glyph
->charpos
;
14717 || (tem
- pt_old
> 0 && tem
< pos_after
))
14721 pos
= tem
+ 1; /* don't find previous instances */
14723 /* This string is not what we want; skip all of the
14724 glyphs that came from it. */
14725 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14726 && EQ (glyph
->object
, str
))
14733 /* If we reached the end of the line, and END was from a string,
14734 the cursor is not on this line. */
14736 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14737 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14738 && STRINGP (end
->object
)
14739 && row
->continued_p
)
14742 /* A truncated row may not include PT among its character positions.
14743 Setting the cursor inside the scroll margin will trigger
14744 recalculation of hscroll in hscroll_window_tree. But if a
14745 display string covers point, defer to the string-handling
14746 code below to figure this out. */
14747 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14749 cursor
= glyph_before
;
14752 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14753 /* Zero-width characters produce no glyphs. */
14755 && (row
->reversed_p
14756 ? glyph_after
> glyphs_end
14757 : glyph_after
< glyphs_end
)))
14759 cursor
= glyph_after
;
14765 if (cursor
!= NULL
)
14767 else if (glyph
== glyphs_end
14768 && pos_before
== pos_after
14769 && STRINGP ((row
->reversed_p
14770 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14771 : row
->glyphs
[TEXT_AREA
])->object
))
14773 /* If all the glyphs of this row came from strings, put the
14774 cursor on the first glyph of the row. This avoids having the
14775 cursor outside of the text area in this very rare and hard
14779 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14780 : row
->glyphs
[TEXT_AREA
];
14786 /* Need to compute x that corresponds to GLYPH. */
14787 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14789 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14791 x
+= g
->pixel_width
;
14795 /* ROW could be part of a continued line, which, under bidi
14796 reordering, might have other rows whose start and end charpos
14797 occlude point. Only set w->cursor if we found a better
14798 approximation to the cursor position than we have from previously
14799 examined candidate rows belonging to the same continued line. */
14800 if (/* We already have a candidate row. */
14801 w
->cursor
.vpos
>= 0
14802 /* That candidate is not the row we are processing. */
14803 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14804 /* Make sure cursor.vpos specifies a row whose start and end
14805 charpos occlude point, and it is valid candidate for being a
14806 cursor-row. This is because some callers of this function
14807 leave cursor.vpos at the row where the cursor was displayed
14808 during the last redisplay cycle. */
14809 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14810 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14811 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14814 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14816 /* Don't consider glyphs that are outside TEXT_AREA. */
14817 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14819 /* Keep the candidate whose buffer position is the closest to
14820 point or has the `cursor' property. */
14821 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14822 w
->cursor
.hpos
>= 0
14823 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14824 && ((BUFFERP (g1
->object
)
14825 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14826 || (BUFFERP (glyph
->object
)
14827 && eabs (g1
->charpos
- pt_old
)
14828 < eabs (glyph
->charpos
- pt_old
))))
14829 /* Previous candidate is a glyph from a string that has
14830 a non-nil `cursor' property. */
14831 || (STRINGP (g1
->object
)
14832 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14833 Qcursor
, g1
->object
))
14834 /* Previous candidate is from the same display
14835 string as this one, and the display string
14836 came from a text property. */
14837 || (EQ (g1
->object
, glyph
->object
)
14838 && string_from_text_prop
)
14839 /* this candidate is from newline and its
14840 position is not an exact match */
14841 || (NILP (glyph
->object
)
14842 && glyph
->charpos
!= pt_old
)))))
14844 /* If this candidate gives an exact match, use that. */
14845 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14846 /* If this candidate is a glyph created for the
14847 terminating newline of a line, and point is on that
14848 newline, it wins because it's an exact match. */
14849 || (!row
->continued_p
14850 && NILP (glyph
->object
)
14851 && glyph
->charpos
== 0
14852 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14853 /* Otherwise, keep the candidate that comes from a row
14854 spanning less buffer positions. This may win when one or
14855 both candidate positions are on glyphs that came from
14856 display strings, for which we cannot compare buffer
14858 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14859 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14860 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14863 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14865 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14866 w
->cursor
.y
= row
->y
+ dy
;
14868 if (w
== XWINDOW (selected_window
))
14870 if (!row
->continued_p
14871 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14874 this_line_buffer
= XBUFFER (w
->contents
);
14876 CHARPOS (this_line_start_pos
)
14877 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14878 BYTEPOS (this_line_start_pos
)
14879 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14881 CHARPOS (this_line_end_pos
)
14882 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14883 BYTEPOS (this_line_end_pos
)
14884 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14886 this_line_y
= w
->cursor
.y
;
14887 this_line_pixel_height
= row
->height
;
14888 this_line_vpos
= w
->cursor
.vpos
;
14889 this_line_start_x
= row
->x
;
14892 CHARPOS (this_line_start_pos
) = 0;
14899 /* Run window scroll functions, if any, for WINDOW with new window
14900 start STARTP. Sets the window start of WINDOW to that position.
14902 We assume that the window's buffer is really current. */
14904 static struct text_pos
14905 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14907 struct window
*w
= XWINDOW (window
);
14908 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14910 eassert (current_buffer
== XBUFFER (w
->contents
));
14912 if (!NILP (Vwindow_scroll_functions
))
14914 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14915 make_number (CHARPOS (startp
)));
14916 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14917 /* In case the hook functions switch buffers. */
14918 set_buffer_internal (XBUFFER (w
->contents
));
14925 /* Make sure the line containing the cursor is fully visible.
14926 A value of true means there is nothing to be done.
14927 (Either the line is fully visible, or it cannot be made so,
14928 or we cannot tell.)
14930 If FORCE_P, return false even if partial visible cursor row
14931 is higher than window.
14933 If CURRENT_MATRIX_P, use the information from the
14934 window's current glyph matrix; otherwise use the desired glyph
14937 A value of false means the caller should do scrolling
14938 as if point had gone off the screen. */
14941 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14942 bool current_matrix_p
)
14944 struct glyph_matrix
*matrix
;
14945 struct glyph_row
*row
;
14948 if (!make_cursor_line_fully_visible_p
)
14951 /* It's not always possible to find the cursor, e.g, when a window
14952 is full of overlay strings. Don't do anything in that case. */
14953 if (w
->cursor
.vpos
< 0)
14956 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14957 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14959 /* If the cursor row is not partially visible, there's nothing to do. */
14960 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14963 /* If the row the cursor is in is taller than the window's height,
14964 it's not clear what to do, so do nothing. */
14965 window_height
= window_box_height (w
);
14966 if (row
->height
>= window_height
)
14968 if (!force_p
|| MINI_WINDOW_P (w
)
14969 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14976 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14977 means only WINDOW is redisplayed in redisplay_internal.
14978 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14979 in redisplay_window to bring a partially visible line into view in
14980 the case that only the cursor has moved.
14982 LAST_LINE_MISFIT should be true if we're scrolling because the
14983 last screen line's vertical height extends past the end of the screen.
14987 1 if scrolling succeeded
14989 0 if scrolling didn't find point.
14991 -1 if new fonts have been loaded so that we must interrupt
14992 redisplay, adjust glyph matrices, and try again. */
14998 SCROLLING_NEED_LARGER_MATRICES
15001 /* If scroll-conservatively is more than this, never recenter.
15003 If you change this, don't forget to update the doc string of
15004 `scroll-conservatively' and the Emacs manual. */
15005 #define SCROLL_LIMIT 100
15008 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15009 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15010 bool temp_scroll_step
, bool last_line_misfit
)
15012 struct window
*w
= XWINDOW (window
);
15013 struct frame
*f
= XFRAME (w
->frame
);
15014 struct text_pos pos
, startp
;
15016 int this_scroll_margin
, scroll_max
, rc
, height
;
15017 int dy
= 0, amount_to_scroll
= 0;
15018 bool scroll_down_p
= false;
15019 int extra_scroll_margin_lines
= last_line_misfit
;
15020 Lisp_Object aggressive
;
15021 /* We will never try scrolling more than this number of lines. */
15022 int scroll_limit
= SCROLL_LIMIT
;
15023 int frame_line_height
= default_line_pixel_height (w
);
15024 int window_total_lines
15025 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15028 debug_method_add (w
, "try_scrolling");
15031 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15033 /* Compute scroll margin height in pixels. We scroll when point is
15034 within this distance from the top or bottom of the window. */
15035 if (scroll_margin
> 0)
15036 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15037 * frame_line_height
;
15039 this_scroll_margin
= 0;
15041 /* Force arg_scroll_conservatively to have a reasonable value, to
15042 avoid scrolling too far away with slow move_it_* functions. Note
15043 that the user can supply scroll-conservatively equal to
15044 `most-positive-fixnum', which can be larger than INT_MAX. */
15045 if (arg_scroll_conservatively
> scroll_limit
)
15047 arg_scroll_conservatively
= scroll_limit
+ 1;
15048 scroll_max
= scroll_limit
* frame_line_height
;
15050 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15051 /* Compute how much we should try to scroll maximally to bring
15052 point into view. */
15053 scroll_max
= (max (scroll_step
,
15054 max (arg_scroll_conservatively
, temp_scroll_step
))
15055 * frame_line_height
);
15056 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15057 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15058 /* We're trying to scroll because of aggressive scrolling but no
15059 scroll_step is set. Choose an arbitrary one. */
15060 scroll_max
= 10 * frame_line_height
;
15066 /* Decide whether to scroll down. */
15067 if (PT
> CHARPOS (startp
))
15069 int scroll_margin_y
;
15071 /* Compute the pixel ypos of the scroll margin, then move IT to
15072 either that ypos or PT, whichever comes first. */
15073 start_display (&it
, w
, startp
);
15074 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15075 - frame_line_height
* extra_scroll_margin_lines
;
15076 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15077 (MOVE_TO_POS
| MOVE_TO_Y
));
15079 if (PT
> CHARPOS (it
.current
.pos
))
15081 int y0
= line_bottom_y (&it
);
15082 /* Compute how many pixels below window bottom to stop searching
15083 for PT. This avoids costly search for PT that is far away if
15084 the user limited scrolling by a small number of lines, but
15085 always finds PT if scroll_conservatively is set to a large
15086 number, such as most-positive-fixnum. */
15087 int slack
= max (scroll_max
, 10 * frame_line_height
);
15088 int y_to_move
= it
.last_visible_y
+ slack
;
15090 /* Compute the distance from the scroll margin to PT or to
15091 the scroll limit, whichever comes first. This should
15092 include the height of the cursor line, to make that line
15094 move_it_to (&it
, PT
, -1, y_to_move
,
15095 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15096 dy
= line_bottom_y (&it
) - y0
;
15098 if (dy
> scroll_max
)
15099 return SCROLLING_FAILED
;
15102 scroll_down_p
= true;
15108 /* Point is in or below the bottom scroll margin, so move the
15109 window start down. If scrolling conservatively, move it just
15110 enough down to make point visible. If scroll_step is set,
15111 move it down by scroll_step. */
15112 if (arg_scroll_conservatively
)
15114 = min (max (dy
, frame_line_height
),
15115 frame_line_height
* arg_scroll_conservatively
);
15116 else if (scroll_step
|| temp_scroll_step
)
15117 amount_to_scroll
= scroll_max
;
15120 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15121 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15122 if (NUMBERP (aggressive
))
15124 double float_amount
= XFLOATINT (aggressive
) * height
;
15125 int aggressive_scroll
= float_amount
;
15126 if (aggressive_scroll
== 0 && float_amount
> 0)
15127 aggressive_scroll
= 1;
15128 /* Don't let point enter the scroll margin near top of
15129 the window. This could happen if the value of
15130 scroll_up_aggressively is too large and there are
15131 non-zero margins, because scroll_up_aggressively
15132 means put point that fraction of window height
15133 _from_the_bottom_margin_. */
15134 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15135 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15136 amount_to_scroll
= dy
+ aggressive_scroll
;
15140 if (amount_to_scroll
<= 0)
15141 return SCROLLING_FAILED
;
15143 start_display (&it
, w
, startp
);
15144 if (arg_scroll_conservatively
<= scroll_limit
)
15145 move_it_vertically (&it
, amount_to_scroll
);
15148 /* Extra precision for users who set scroll-conservatively
15149 to a large number: make sure the amount we scroll
15150 the window start is never less than amount_to_scroll,
15151 which was computed as distance from window bottom to
15152 point. This matters when lines at window top and lines
15153 below window bottom have different height. */
15155 void *it1data
= NULL
;
15156 /* We use a temporary it1 because line_bottom_y can modify
15157 its argument, if it moves one line down; see there. */
15160 SAVE_IT (it1
, it
, it1data
);
15161 start_y
= line_bottom_y (&it1
);
15163 RESTORE_IT (&it
, &it
, it1data
);
15164 move_it_by_lines (&it
, 1);
15165 SAVE_IT (it1
, it
, it1data
);
15166 } while (IT_CHARPOS (it
) < ZV
15167 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15168 bidi_unshelve_cache (it1data
, true);
15171 /* If STARTP is unchanged, move it down another screen line. */
15172 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15173 move_it_by_lines (&it
, 1);
15174 startp
= it
.current
.pos
;
15178 struct text_pos scroll_margin_pos
= startp
;
15181 /* See if point is inside the scroll margin at the top of the
15183 if (this_scroll_margin
)
15187 start_display (&it
, w
, startp
);
15188 y_start
= it
.current_y
;
15189 move_it_vertically (&it
, this_scroll_margin
);
15190 scroll_margin_pos
= it
.current
.pos
;
15191 /* If we didn't move enough before hitting ZV, request
15192 additional amount of scroll, to move point out of the
15194 if (IT_CHARPOS (it
) == ZV
15195 && it
.current_y
- y_start
< this_scroll_margin
)
15196 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15199 if (PT
< CHARPOS (scroll_margin_pos
))
15201 /* Point is in the scroll margin at the top of the window or
15202 above what is displayed in the window. */
15205 /* Compute the vertical distance from PT to the scroll
15206 margin position. Move as far as scroll_max allows, or
15207 one screenful, or 10 screen lines, whichever is largest.
15208 Give up if distance is greater than scroll_max or if we
15209 didn't reach the scroll margin position. */
15210 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15211 start_display (&it
, w
, pos
);
15213 y_to_move
= max (it
.last_visible_y
,
15214 max (scroll_max
, 10 * frame_line_height
));
15215 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15217 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15218 dy
= it
.current_y
- y0
;
15219 if (dy
> scroll_max
15220 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15221 return SCROLLING_FAILED
;
15223 /* Additional scroll for when ZV was too close to point. */
15226 /* Compute new window start. */
15227 start_display (&it
, w
, startp
);
15229 if (arg_scroll_conservatively
)
15230 amount_to_scroll
= max (dy
, frame_line_height
15231 * max (scroll_step
, temp_scroll_step
));
15232 else if (scroll_step
|| temp_scroll_step
)
15233 amount_to_scroll
= scroll_max
;
15236 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15237 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15238 if (NUMBERP (aggressive
))
15240 double float_amount
= XFLOATINT (aggressive
) * height
;
15241 int aggressive_scroll
= float_amount
;
15242 if (aggressive_scroll
== 0 && float_amount
> 0)
15243 aggressive_scroll
= 1;
15244 /* Don't let point enter the scroll margin near
15245 bottom of the window, if the value of
15246 scroll_down_aggressively happens to be too
15248 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15249 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15250 amount_to_scroll
= dy
+ aggressive_scroll
;
15254 if (amount_to_scroll
<= 0)
15255 return SCROLLING_FAILED
;
15257 move_it_vertically_backward (&it
, amount_to_scroll
);
15258 startp
= it
.current
.pos
;
15262 /* Run window scroll functions. */
15263 startp
= run_window_scroll_functions (window
, startp
);
15265 /* Display the window. Give up if new fonts are loaded, or if point
15267 if (!try_window (window
, startp
, 0))
15268 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15269 else if (w
->cursor
.vpos
< 0)
15271 clear_glyph_matrix (w
->desired_matrix
);
15272 rc
= SCROLLING_FAILED
;
15276 /* Maybe forget recorded base line for line number display. */
15277 if (!just_this_one_p
15278 || current_buffer
->clip_changed
15279 || BEG_UNCHANGED
< CHARPOS (startp
))
15280 w
->base_line_number
= 0;
15282 /* If cursor ends up on a partially visible line,
15283 treat that as being off the bottom of the screen. */
15284 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15286 /* It's possible that the cursor is on the first line of the
15287 buffer, which is partially obscured due to a vscroll
15288 (Bug#7537). In that case, avoid looping forever. */
15289 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15291 clear_glyph_matrix (w
->desired_matrix
);
15292 ++extra_scroll_margin_lines
;
15295 rc
= SCROLLING_SUCCESS
;
15302 /* Compute a suitable window start for window W if display of W starts
15303 on a continuation line. Value is true if a new window start
15306 The new window start will be computed, based on W's width, starting
15307 from the start of the continued line. It is the start of the
15308 screen line with the minimum distance from the old start W->start. */
15311 compute_window_start_on_continuation_line (struct window
*w
)
15313 struct text_pos pos
, start_pos
;
15314 bool window_start_changed_p
= false;
15316 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15318 /* If window start is on a continuation line... Window start may be
15319 < BEGV in case there's invisible text at the start of the
15320 buffer (M-x rmail, for example). */
15321 if (CHARPOS (start_pos
) > BEGV
15322 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15325 struct glyph_row
*row
;
15327 /* Handle the case that the window start is out of range. */
15328 if (CHARPOS (start_pos
) < BEGV
)
15329 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15330 else if (CHARPOS (start_pos
) > ZV
)
15331 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15333 /* Find the start of the continued line. This should be fast
15334 because find_newline is fast (newline cache). */
15335 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15336 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15337 row
, DEFAULT_FACE_ID
);
15338 reseat_at_previous_visible_line_start (&it
);
15340 /* If the line start is "too far" away from the window start,
15341 say it takes too much time to compute a new window start. */
15342 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15343 /* PXW: Do we need upper bounds here? */
15344 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15346 int min_distance
, distance
;
15348 /* Move forward by display lines to find the new window
15349 start. If window width was enlarged, the new start can
15350 be expected to be > the old start. If window width was
15351 decreased, the new window start will be < the old start.
15352 So, we're looking for the display line start with the
15353 minimum distance from the old window start. */
15354 pos
= it
.current
.pos
;
15355 min_distance
= INFINITY
;
15356 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15357 distance
< min_distance
)
15359 min_distance
= distance
;
15360 pos
= it
.current
.pos
;
15361 if (it
.line_wrap
== WORD_WRAP
)
15363 /* Under WORD_WRAP, move_it_by_lines is likely to
15364 overshoot and stop not at the first, but the
15365 second character from the left margin. So in
15366 that case, we need a more tight control on the X
15367 coordinate of the iterator than move_it_by_lines
15368 promises in its contract. The method is to first
15369 go to the last (rightmost) visible character of a
15370 line, then move to the leftmost character on the
15371 next line in a separate call. */
15372 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15373 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15374 move_it_to (&it
, ZV
, 0,
15375 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15376 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15379 move_it_by_lines (&it
, 1);
15382 /* Set the window start there. */
15383 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15384 window_start_changed_p
= true;
15388 return window_start_changed_p
;
15392 /* Try cursor movement in case text has not changed in window WINDOW,
15393 with window start STARTP. Value is
15395 CURSOR_MOVEMENT_SUCCESS if successful
15397 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15399 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15400 display. *SCROLL_STEP is set to true, under certain circumstances, if
15401 we want to scroll as if scroll-step were set to 1. See the code.
15403 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15404 which case we have to abort this redisplay, and adjust matrices
15409 CURSOR_MOVEMENT_SUCCESS
,
15410 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15411 CURSOR_MOVEMENT_MUST_SCROLL
,
15412 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15416 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15419 struct window
*w
= XWINDOW (window
);
15420 struct frame
*f
= XFRAME (w
->frame
);
15421 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15424 if (inhibit_try_cursor_movement
)
15428 /* Previously, there was a check for Lisp integer in the
15429 if-statement below. Now, this field is converted to
15430 ptrdiff_t, thus zero means invalid position in a buffer. */
15431 eassert (w
->last_point
> 0);
15432 /* Likewise there was a check whether window_end_vpos is nil or larger
15433 than the window. Now window_end_vpos is int and so never nil, but
15434 let's leave eassert to check whether it fits in the window. */
15435 eassert (!w
->window_end_valid
15436 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15438 /* Handle case where text has not changed, only point, and it has
15439 not moved off the frame. */
15440 if (/* Point may be in this window. */
15441 PT
>= CHARPOS (startp
)
15442 /* Selective display hasn't changed. */
15443 && !current_buffer
->clip_changed
15444 /* Function force-mode-line-update is used to force a thorough
15445 redisplay. It sets either windows_or_buffers_changed or
15446 update_mode_lines. So don't take a shortcut here for these
15448 && !update_mode_lines
15449 && !windows_or_buffers_changed
15450 && !f
->cursor_type_changed
15451 && NILP (Vshow_trailing_whitespace
)
15452 /* This code is not used for mini-buffer for the sake of the case
15453 of redisplaying to replace an echo area message; since in
15454 that case the mini-buffer contents per se are usually
15455 unchanged. This code is of no real use in the mini-buffer
15456 since the handling of this_line_start_pos, etc., in redisplay
15457 handles the same cases. */
15458 && !EQ (window
, minibuf_window
)
15459 && (FRAME_WINDOW_P (f
)
15460 || !overlay_arrow_in_current_buffer_p ()))
15462 int this_scroll_margin
, top_scroll_margin
;
15463 struct glyph_row
*row
= NULL
;
15464 int frame_line_height
= default_line_pixel_height (w
);
15465 int window_total_lines
15466 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15469 debug_method_add (w
, "cursor movement");
15472 /* Scroll if point within this distance from the top or bottom
15473 of the window. This is a pixel value. */
15474 if (scroll_margin
> 0)
15476 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15477 this_scroll_margin
*= frame_line_height
;
15480 this_scroll_margin
= 0;
15482 top_scroll_margin
= this_scroll_margin
;
15483 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15484 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15486 /* Start with the row the cursor was displayed during the last
15487 not paused redisplay. Give up if that row is not valid. */
15488 if (w
->last_cursor_vpos
< 0
15489 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15490 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15493 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15494 if (row
->mode_line_p
)
15496 if (!row
->enabled_p
)
15497 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15500 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15502 bool scroll_p
= false, must_scroll
= false;
15503 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15505 if (PT
> w
->last_point
)
15507 /* Point has moved forward. */
15508 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15509 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15511 eassert (row
->enabled_p
);
15515 /* If the end position of a row equals the start
15516 position of the next row, and PT is at that position,
15517 we would rather display cursor in the next line. */
15518 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15519 && MATRIX_ROW_END_CHARPOS (row
) == PT
15520 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15521 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15522 && !cursor_row_p (row
))
15525 /* If within the scroll margin, scroll. Note that
15526 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15527 the next line would be drawn, and that
15528 this_scroll_margin can be zero. */
15529 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15530 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15531 /* Line is completely visible last line in window
15532 and PT is to be set in the next line. */
15533 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15534 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15535 && !row
->ends_at_zv_p
15536 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15539 else if (PT
< w
->last_point
)
15541 /* Cursor has to be moved backward. Note that PT >=
15542 CHARPOS (startp) because of the outer if-statement. */
15543 while (!row
->mode_line_p
15544 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15545 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15546 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15547 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15548 row
> w
->current_matrix
->rows
15549 && (row
-1)->ends_in_newline_from_string_p
))))
15550 && (row
->y
> top_scroll_margin
15551 || CHARPOS (startp
) == BEGV
))
15553 eassert (row
->enabled_p
);
15557 /* Consider the following case: Window starts at BEGV,
15558 there is invisible, intangible text at BEGV, so that
15559 display starts at some point START > BEGV. It can
15560 happen that we are called with PT somewhere between
15561 BEGV and START. Try to handle that case. */
15562 if (row
< w
->current_matrix
->rows
15563 || row
->mode_line_p
)
15565 row
= w
->current_matrix
->rows
;
15566 if (row
->mode_line_p
)
15570 /* Due to newlines in overlay strings, we may have to
15571 skip forward over overlay strings. */
15572 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15573 && MATRIX_ROW_END_CHARPOS (row
) == PT
15574 && !cursor_row_p (row
))
15577 /* If within the scroll margin, scroll. */
15578 if (row
->y
< top_scroll_margin
15579 && CHARPOS (startp
) != BEGV
)
15584 /* Cursor did not move. So don't scroll even if cursor line
15585 is partially visible, as it was so before. */
15586 rc
= CURSOR_MOVEMENT_SUCCESS
;
15589 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15590 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15592 /* if PT is not in the glyph row, give up. */
15593 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15594 must_scroll
= true;
15596 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15597 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15599 struct glyph_row
*row1
;
15601 /* If rows are bidi-reordered and point moved, back up
15602 until we find a row that does not belong to a
15603 continuation line. This is because we must consider
15604 all rows of a continued line as candidates for the
15605 new cursor positioning, since row start and end
15606 positions change non-linearly with vertical position
15608 /* FIXME: Revisit this when glyph ``spilling'' in
15609 continuation lines' rows is implemented for
15610 bidi-reordered rows. */
15611 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15612 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15615 /* If we hit the beginning of the displayed portion
15616 without finding the first row of a continued
15620 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15623 eassert (row
->enabled_p
);
15628 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15629 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15630 /* Make sure this isn't a header line by any chance, since
15631 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15632 && !row
->mode_line_p
15633 && make_cursor_line_fully_visible_p
)
15635 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15636 && !row
->ends_at_zv_p
15637 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15638 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15639 else if (row
->height
> window_box_height (w
))
15641 /* If we end up in a partially visible line, let's
15642 make it fully visible, except when it's taller
15643 than the window, in which case we can't do much
15645 *scroll_step
= true;
15646 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15650 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15651 if (!cursor_row_fully_visible_p (w
, false, true))
15652 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15654 rc
= CURSOR_MOVEMENT_SUCCESS
;
15658 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15659 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15660 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15662 /* With bidi-reordered rows, there could be more than
15663 one candidate row whose start and end positions
15664 occlude point. We need to let set_cursor_from_row
15665 find the best candidate. */
15666 /* FIXME: Revisit this when glyph ``spilling'' in
15667 continuation lines' rows is implemented for
15668 bidi-reordered rows. */
15673 bool at_zv_p
= false, exact_match_p
= false;
15675 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15676 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15677 && cursor_row_p (row
))
15678 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15680 /* As soon as we've found the exact match for point,
15681 or the first suitable row whose ends_at_zv_p flag
15682 is set, we are done. */
15685 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15686 w
->cursor
.vpos
)->ends_at_zv_p
;
15688 && w
->cursor
.hpos
>= 0
15689 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15692 struct glyph_row
*candidate
=
15693 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15695 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15696 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15699 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15700 || (NILP (g
->object
)
15701 && (g
->charpos
== PT
15702 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15704 if (at_zv_p
|| exact_match_p
)
15706 rc
= CURSOR_MOVEMENT_SUCCESS
;
15710 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15714 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15715 || row
->continued_p
)
15716 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15717 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15718 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15719 /* If we didn't find any candidate rows, or exited the
15720 loop before all the candidates were examined, signal
15721 to the caller that this method failed. */
15722 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15724 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15725 && !row
->continued_p
))
15726 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15728 rc
= CURSOR_MOVEMENT_SUCCESS
;
15734 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15736 rc
= CURSOR_MOVEMENT_SUCCESS
;
15741 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15742 && MATRIX_ROW_START_CHARPOS (row
) == PT
15743 && cursor_row_p (row
));
15753 set_vertical_scroll_bar (struct window
*w
)
15755 ptrdiff_t start
, end
, whole
;
15757 /* Calculate the start and end positions for the current window.
15758 At some point, it would be nice to choose between scrollbars
15759 which reflect the whole buffer size, with special markers
15760 indicating narrowing, and scrollbars which reflect only the
15763 Note that mini-buffers sometimes aren't displaying any text. */
15764 if (!MINI_WINDOW_P (w
)
15765 || (w
== XWINDOW (minibuf_window
)
15766 && NILP (echo_area_buffer
[0])))
15768 struct buffer
*buf
= XBUFFER (w
->contents
);
15769 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15770 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15771 /* I don't think this is guaranteed to be right. For the
15772 moment, we'll pretend it is. */
15773 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15777 if (whole
< (end
- start
))
15778 whole
= end
- start
;
15781 start
= end
= whole
= 0;
15783 /* Indicate what this scroll bar ought to be displaying now. */
15784 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15785 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15786 (w
, end
- start
, whole
, start
);
15791 set_horizontal_scroll_bar (struct window
*w
)
15793 int start
, end
, whole
, portion
;
15795 if (!MINI_WINDOW_P (w
)
15796 || (w
== XWINDOW (minibuf_window
)
15797 && NILP (echo_area_buffer
[0])))
15799 struct buffer
*b
= XBUFFER (w
->contents
);
15800 struct buffer
*old_buffer
= NULL
;
15802 struct text_pos startp
;
15804 if (b
!= current_buffer
)
15806 old_buffer
= current_buffer
;
15807 set_buffer_internal (b
);
15810 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15811 start_display (&it
, w
, startp
);
15812 it
.last_visible_x
= INT_MAX
;
15813 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15814 MOVE_TO_X
| MOVE_TO_Y
);
15815 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15816 window_box_height (w), -1,
15817 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15819 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15820 end
= start
+ window_box_width (w
, TEXT_AREA
);
15821 portion
= end
- start
;
15822 /* After enlarging a horizontally scrolled window such that it
15823 gets at least as wide as the text it contains, make sure that
15824 the thumb doesn't fill the entire scroll bar so we can still
15825 drag it back to see the entire text. */
15826 whole
= max (whole
, end
);
15832 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15833 if (EQ (pdir
, Qright_to_left
))
15835 start
= whole
- end
;
15836 end
= start
+ portion
;
15841 set_buffer_internal (old_buffer
);
15844 start
= end
= whole
= portion
= 0;
15846 w
->hscroll_whole
= whole
;
15848 /* Indicate what this scroll bar ought to be displaying now. */
15849 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15850 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15851 (w
, portion
, whole
, start
);
15855 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15856 selected_window is redisplayed.
15858 We can return without actually redisplaying the window if fonts has been
15859 changed on window's frame. In that case, redisplay_internal will retry.
15861 As one of the important parts of redisplaying a window, we need to
15862 decide whether the previous window-start position (stored in the
15863 window's w->start marker position) is still valid, and if it isn't,
15864 recompute it. Some details about that:
15866 . The previous window-start could be in a continuation line, in
15867 which case we need to recompute it when the window width
15868 changes. See compute_window_start_on_continuation_line and its
15871 . The text that changed since last redisplay could include the
15872 previous window-start position. In that case, we try to salvage
15873 what we can from the current glyph matrix by calling
15874 try_scrolling, which see.
15876 . Some Emacs command could force us to use a specific window-start
15877 position by setting the window's force_start flag, or gently
15878 propose doing that by setting the window's optional_new_start
15879 flag. In these cases, we try using the specified start point if
15880 that succeeds (i.e. the window desired matrix is successfully
15881 recomputed, and point location is within the window). In case
15882 of optional_new_start, we first check if the specified start
15883 position is feasible, i.e. if it will allow point to be
15884 displayed in the window. If using the specified start point
15885 fails, e.g., if new fonts are needed to be loaded, we abort the
15886 redisplay cycle and leave it up to the next cycle to figure out
15889 . Note that the window's force_start flag is sometimes set by
15890 redisplay itself, when it decides that the previous window start
15891 point is fine and should be kept. Search for "goto force_start"
15892 below to see the details. Like the values of window-start
15893 specified outside of redisplay, these internally-deduced values
15894 are tested for feasibility, and ignored if found to be
15897 . Note that the function try_window, used to completely redisplay
15898 a window, accepts the window's start point as its argument.
15899 This is used several times in the redisplay code to control
15900 where the window start will be, according to user options such
15901 as scroll-conservatively, and also to ensure the screen line
15902 showing point will be fully (as opposed to partially) visible on
15906 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15908 struct window
*w
= XWINDOW (window
);
15909 struct frame
*f
= XFRAME (w
->frame
);
15910 struct buffer
*buffer
= XBUFFER (w
->contents
);
15911 struct buffer
*old
= current_buffer
;
15912 struct text_pos lpoint
, opoint
, startp
;
15913 bool update_mode_line
;
15916 /* Record it now because it's overwritten. */
15917 bool current_matrix_up_to_date_p
= false;
15918 bool used_current_matrix_p
= false;
15919 /* This is less strict than current_matrix_up_to_date_p.
15920 It indicates that the buffer contents and narrowing are unchanged. */
15921 bool buffer_unchanged_p
= false;
15922 bool temp_scroll_step
= false;
15923 ptrdiff_t count
= SPECPDL_INDEX ();
15925 int centering_position
= -1;
15926 bool last_line_misfit
= false;
15927 ptrdiff_t beg_unchanged
, end_unchanged
;
15928 int frame_line_height
;
15930 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15934 *w
->desired_matrix
->method
= 0;
15937 if (!just_this_one_p
15938 && REDISPLAY_SOME_P ()
15940 && !w
->update_mode_line
15943 && !buffer
->text
->redisplay
15944 && BUF_PT (buffer
) == w
->last_point
)
15947 /* Make sure that both W's markers are valid. */
15948 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15949 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15951 /* We come here again if we need to run window-text-change-functions
15954 reconsider_clip_changes (w
);
15955 frame_line_height
= default_line_pixel_height (w
);
15957 /* Has the mode line to be updated? */
15958 update_mode_line
= (w
->update_mode_line
15959 || update_mode_lines
15960 || buffer
->clip_changed
15961 || buffer
->prevent_redisplay_optimizations_p
);
15963 if (!just_this_one_p
)
15964 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15965 cleverly elsewhere. */
15966 w
->must_be_updated_p
= true;
15968 if (MINI_WINDOW_P (w
))
15970 if (w
== XWINDOW (echo_area_window
)
15971 && !NILP (echo_area_buffer
[0]))
15973 if (update_mode_line
)
15974 /* We may have to update a tty frame's menu bar or a
15975 tool-bar. Example `M-x C-h C-h C-g'. */
15976 goto finish_menu_bars
;
15978 /* We've already displayed the echo area glyphs in this window. */
15979 goto finish_scroll_bars
;
15981 else if ((w
!= XWINDOW (minibuf_window
)
15982 || minibuf_level
== 0)
15983 /* When buffer is nonempty, redisplay window normally. */
15984 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15985 /* Quail displays non-mini buffers in minibuffer window.
15986 In that case, redisplay the window normally. */
15987 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15989 /* W is a mini-buffer window, but it's not active, so clear
15991 int yb
= window_text_bottom_y (w
);
15992 struct glyph_row
*row
;
15995 for (y
= 0, row
= w
->desired_matrix
->rows
;
15997 y
+= row
->height
, ++row
)
15998 blank_row (w
, row
, y
);
15999 goto finish_scroll_bars
;
16002 clear_glyph_matrix (w
->desired_matrix
);
16005 /* Otherwise set up data on this window; select its buffer and point
16007 /* Really select the buffer, for the sake of buffer-local
16009 set_buffer_internal_1 (XBUFFER (w
->contents
));
16011 current_matrix_up_to_date_p
16012 = (w
->window_end_valid
16013 && !current_buffer
->clip_changed
16014 && !current_buffer
->prevent_redisplay_optimizations_p
16015 && !window_outdated (w
));
16017 /* Run the window-text-change-functions
16018 if it is possible that the text on the screen has changed
16019 (either due to modification of the text, or any other reason). */
16020 if (!current_matrix_up_to_date_p
16021 && !NILP (Vwindow_text_change_functions
))
16023 safe_run_hooks (Qwindow_text_change_functions
);
16027 beg_unchanged
= BEG_UNCHANGED
;
16028 end_unchanged
= END_UNCHANGED
;
16030 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16032 specbind (Qinhibit_point_motion_hooks
, Qt
);
16035 = (w
->window_end_valid
16036 && !current_buffer
->clip_changed
16037 && !window_outdated (w
));
16039 /* When windows_or_buffers_changed is non-zero, we can't rely
16040 on the window end being valid, so set it to zero there. */
16041 if (windows_or_buffers_changed
)
16043 /* If window starts on a continuation line, maybe adjust the
16044 window start in case the window's width changed. */
16045 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16046 compute_window_start_on_continuation_line (w
);
16048 w
->window_end_valid
= false;
16049 /* If so, we also can't rely on current matrix
16050 and should not fool try_cursor_movement below. */
16051 current_matrix_up_to_date_p
= false;
16054 /* Some sanity checks. */
16055 CHECK_WINDOW_END (w
);
16056 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16058 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16061 if (mode_line_update_needed (w
))
16062 update_mode_line
= true;
16064 /* Point refers normally to the selected window. For any other
16065 window, set up appropriate value. */
16066 if (!EQ (window
, selected_window
))
16068 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16069 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16074 new_pt_byte
= BEGV_BYTE
;
16075 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16077 else if (new_pt
> (ZV
- 1))
16080 new_pt_byte
= ZV_BYTE
;
16081 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16084 /* We don't use SET_PT so that the point-motion hooks don't run. */
16085 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16088 /* If any of the character widths specified in the display table
16089 have changed, invalidate the width run cache. It's true that
16090 this may be a bit late to catch such changes, but the rest of
16091 redisplay goes (non-fatally) haywire when the display table is
16092 changed, so why should we worry about doing any better? */
16093 if (current_buffer
->width_run_cache
16094 || (current_buffer
->base_buffer
16095 && current_buffer
->base_buffer
->width_run_cache
))
16097 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16099 if (! disptab_matches_widthtab
16100 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16102 struct buffer
*buf
= current_buffer
;
16104 if (buf
->base_buffer
)
16105 buf
= buf
->base_buffer
;
16106 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16107 recompute_width_table (current_buffer
, disptab
);
16111 /* If window-start is screwed up, choose a new one. */
16112 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16115 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16117 /* If someone specified a new starting point but did not insist,
16118 check whether it can be used. */
16119 if ((w
->optional_new_start
|| window_frozen_p (w
))
16120 && CHARPOS (startp
) >= BEGV
16121 && CHARPOS (startp
) <= ZV
)
16123 ptrdiff_t it_charpos
;
16125 w
->optional_new_start
= false;
16126 start_display (&it
, w
, startp
);
16127 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16128 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16129 /* Record IT's position now, since line_bottom_y might change
16131 it_charpos
= IT_CHARPOS (it
);
16132 /* Make sure we set the force_start flag only if the cursor row
16133 will be fully visible. Otherwise, the code under force_start
16134 label below will try to move point back into view, which is
16135 not what the code which sets optional_new_start wants. */
16136 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16137 && !w
->force_start
)
16139 if (it_charpos
== PT
)
16140 w
->force_start
= true;
16141 /* IT may overshoot PT if text at PT is invisible. */
16142 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16143 w
->force_start
= true;
16145 if (w
->force_start
)
16147 if (window_frozen_p (w
))
16148 debug_method_add (w
, "set force_start from frozen window start");
16150 debug_method_add (w
, "set force_start from optional_new_start");
16158 /* Handle case where place to start displaying has been specified,
16159 unless the specified location is outside the accessible range. */
16160 if (w
->force_start
)
16162 /* We set this later on if we have to adjust point. */
16165 w
->force_start
= false;
16167 w
->window_end_valid
= false;
16169 /* Forget any recorded base line for line number display. */
16170 if (!buffer_unchanged_p
)
16171 w
->base_line_number
= 0;
16173 /* Redisplay the mode line. Select the buffer properly for that.
16174 Also, run the hook window-scroll-functions
16175 because we have scrolled. */
16176 /* Note, we do this after clearing force_start because
16177 if there's an error, it is better to forget about force_start
16178 than to get into an infinite loop calling the hook functions
16179 and having them get more errors. */
16180 if (!update_mode_line
16181 || ! NILP (Vwindow_scroll_functions
))
16183 update_mode_line
= true;
16184 w
->update_mode_line
= true;
16185 startp
= run_window_scroll_functions (window
, startp
);
16188 if (CHARPOS (startp
) < BEGV
)
16189 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16190 else if (CHARPOS (startp
) > ZV
)
16191 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16193 /* Redisplay, then check if cursor has been set during the
16194 redisplay. Give up if new fonts were loaded. */
16195 /* We used to issue a CHECK_MARGINS argument to try_window here,
16196 but this causes scrolling to fail when point begins inside
16197 the scroll margin (bug#148) -- cyd */
16198 if (!try_window (window
, startp
, 0))
16200 w
->force_start
= true;
16201 clear_glyph_matrix (w
->desired_matrix
);
16202 goto need_larger_matrices
;
16205 if (w
->cursor
.vpos
< 0)
16207 /* If point does not appear, try to move point so it does
16208 appear. The desired matrix has been built above, so we
16209 can use it here. */
16210 new_vpos
= window_box_height (w
) / 2;
16213 if (!cursor_row_fully_visible_p (w
, false, false))
16215 /* Point does appear, but on a line partly visible at end of window.
16216 Move it back to a fully-visible line. */
16217 new_vpos
= window_box_height (w
);
16218 /* But if window_box_height suggests a Y coordinate that is
16219 not less than we already have, that line will clearly not
16220 be fully visible, so give up and scroll the display.
16221 This can happen when the default face uses a font whose
16222 dimensions are different from the frame's default
16224 if (new_vpos
>= w
->cursor
.y
)
16226 w
->cursor
.vpos
= -1;
16227 clear_glyph_matrix (w
->desired_matrix
);
16228 goto try_to_scroll
;
16231 else if (w
->cursor
.vpos
>= 0)
16233 /* Some people insist on not letting point enter the scroll
16234 margin, even though this part handles windows that didn't
16236 int window_total_lines
16237 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16238 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16239 int pixel_margin
= margin
* frame_line_height
;
16240 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16242 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16243 below, which finds the row to move point to, advances by
16244 the Y coordinate of the _next_ row, see the definition of
16245 MATRIX_ROW_BOTTOM_Y. */
16246 if (w
->cursor
.vpos
< margin
+ header_line
)
16248 w
->cursor
.vpos
= -1;
16249 clear_glyph_matrix (w
->desired_matrix
);
16250 goto try_to_scroll
;
16254 int window_height
= window_box_height (w
);
16257 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16258 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16260 w
->cursor
.vpos
= -1;
16261 clear_glyph_matrix (w
->desired_matrix
);
16262 goto try_to_scroll
;
16267 /* If we need to move point for either of the above reasons,
16268 now actually do it. */
16271 struct glyph_row
*row
;
16273 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16274 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16277 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16278 MATRIX_ROW_START_BYTEPOS (row
));
16280 if (w
!= XWINDOW (selected_window
))
16281 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16282 else if (current_buffer
== old
)
16283 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16285 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16287 /* Re-run pre-redisplay-function so it can update the region
16288 according to the new position of point. */
16289 /* Other than the cursor, w's redisplay is done so we can set its
16290 redisplay to false. Also the buffer's redisplay can be set to
16291 false, since propagate_buffer_redisplay should have already
16292 propagated its info to `w' anyway. */
16293 w
->redisplay
= false;
16294 XBUFFER (w
->contents
)->text
->redisplay
= false;
16295 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16297 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16299 /* pre-redisplay-function made changes (e.g. move the region)
16300 that require another round of redisplay. */
16301 clear_glyph_matrix (w
->desired_matrix
);
16302 if (!try_window (window
, startp
, 0))
16303 goto need_larger_matrices
;
16306 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16308 clear_glyph_matrix (w
->desired_matrix
);
16309 goto try_to_scroll
;
16313 debug_method_add (w
, "forced window start");
16318 /* Handle case where text has not changed, only point, and it has
16319 not moved off the frame, and we are not retrying after hscroll.
16320 (current_matrix_up_to_date_p is true when retrying.) */
16321 if (current_matrix_up_to_date_p
16322 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16323 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16327 case CURSOR_MOVEMENT_SUCCESS
:
16328 used_current_matrix_p
= true;
16331 case CURSOR_MOVEMENT_MUST_SCROLL
:
16332 goto try_to_scroll
;
16338 /* If current starting point was originally the beginning of a line
16339 but no longer is, find a new starting point. */
16340 else if (w
->start_at_line_beg
16341 && !(CHARPOS (startp
) <= BEGV
16342 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16345 debug_method_add (w
, "recenter 1");
16350 /* Try scrolling with try_window_id. Value is > 0 if update has
16351 been done, it is -1 if we know that the same window start will
16352 not work. It is 0 if unsuccessful for some other reason. */
16353 else if ((tem
= try_window_id (w
)) != 0)
16356 debug_method_add (w
, "try_window_id %d", tem
);
16359 if (f
->fonts_changed
)
16360 goto need_larger_matrices
;
16364 /* Otherwise try_window_id has returned -1 which means that we
16365 don't want the alternative below this comment to execute. */
16367 else if (CHARPOS (startp
) >= BEGV
16368 && CHARPOS (startp
) <= ZV
16369 && PT
>= CHARPOS (startp
)
16370 && (CHARPOS (startp
) < ZV
16371 /* Avoid starting at end of buffer. */
16372 || CHARPOS (startp
) == BEGV
16373 || !window_outdated (w
)))
16375 int d1
, d2
, d5
, d6
;
16378 /* If first window line is a continuation line, and window start
16379 is inside the modified region, but the first change is before
16380 current window start, we must select a new window start.
16382 However, if this is the result of a down-mouse event (e.g. by
16383 extending the mouse-drag-overlay), we don't want to select a
16384 new window start, since that would change the position under
16385 the mouse, resulting in an unwanted mouse-movement rather
16386 than a simple mouse-click. */
16387 if (!w
->start_at_line_beg
16388 && NILP (do_mouse_tracking
)
16389 && CHARPOS (startp
) > BEGV
16390 && CHARPOS (startp
) > BEG
+ beg_unchanged
16391 && CHARPOS (startp
) <= Z
- end_unchanged
16392 /* Even if w->start_at_line_beg is nil, a new window may
16393 start at a line_beg, since that's how set_buffer_window
16394 sets it. So, we need to check the return value of
16395 compute_window_start_on_continuation_line. (See also
16397 && XMARKER (w
->start
)->buffer
== current_buffer
16398 && compute_window_start_on_continuation_line (w
)
16399 /* It doesn't make sense to force the window start like we
16400 do at label force_start if it is already known that point
16401 will not be fully visible in the resulting window, because
16402 doing so will move point from its correct position
16403 instead of scrolling the window to bring point into view.
16405 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16406 /* A very tall row could need more than the window height,
16407 in which case we accept that it is partially visible. */
16408 && (rtop
!= 0) == (rbot
!= 0))
16410 w
->force_start
= true;
16411 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16413 debug_method_add (w
, "recomputed window start in continuation line");
16419 debug_method_add (w
, "same window start");
16422 /* Try to redisplay starting at same place as before.
16423 If point has not moved off frame, accept the results. */
16424 if (!current_matrix_up_to_date_p
16425 /* Don't use try_window_reusing_current_matrix in this case
16426 because a window scroll function can have changed the
16428 || !NILP (Vwindow_scroll_functions
)
16429 || MINI_WINDOW_P (w
)
16430 || !(used_current_matrix_p
16431 = try_window_reusing_current_matrix (w
)))
16433 IF_DEBUG (debug_method_add (w
, "1"));
16434 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16435 /* -1 means we need to scroll.
16436 0 means we need new matrices, but fonts_changed
16437 is set in that case, so we will detect it below. */
16438 goto try_to_scroll
;
16441 if (f
->fonts_changed
)
16442 goto need_larger_matrices
;
16444 if (w
->cursor
.vpos
>= 0)
16446 if (!just_this_one_p
16447 || current_buffer
->clip_changed
16448 || BEG_UNCHANGED
< CHARPOS (startp
))
16449 /* Forget any recorded base line for line number display. */
16450 w
->base_line_number
= 0;
16452 if (!cursor_row_fully_visible_p (w
, true, false))
16454 clear_glyph_matrix (w
->desired_matrix
);
16455 last_line_misfit
= true;
16457 /* Drop through and scroll. */
16462 clear_glyph_matrix (w
->desired_matrix
);
16467 /* Redisplay the mode line. Select the buffer properly for that. */
16468 if (!update_mode_line
)
16470 update_mode_line
= true;
16471 w
->update_mode_line
= true;
16474 /* Try to scroll by specified few lines. */
16475 if ((scroll_conservatively
16476 || emacs_scroll_step
16477 || temp_scroll_step
16478 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16479 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16480 && CHARPOS (startp
) >= BEGV
16481 && CHARPOS (startp
) <= ZV
)
16483 /* The function returns -1 if new fonts were loaded, 1 if
16484 successful, 0 if not successful. */
16485 int ss
= try_scrolling (window
, just_this_one_p
,
16486 scroll_conservatively
,
16488 temp_scroll_step
, last_line_misfit
);
16491 case SCROLLING_SUCCESS
:
16494 case SCROLLING_NEED_LARGER_MATRICES
:
16495 goto need_larger_matrices
;
16497 case SCROLLING_FAILED
:
16505 /* Finally, just choose a place to start which positions point
16506 according to user preferences. */
16511 debug_method_add (w
, "recenter");
16514 /* Forget any previously recorded base line for line number display. */
16515 if (!buffer_unchanged_p
)
16516 w
->base_line_number
= 0;
16518 /* Determine the window start relative to point. */
16519 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16520 it
.current_y
= it
.last_visible_y
;
16521 if (centering_position
< 0)
16523 int window_total_lines
16524 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16526 = scroll_margin
> 0
16527 ? min (scroll_margin
, window_total_lines
/ 4)
16529 ptrdiff_t margin_pos
= CHARPOS (startp
);
16530 Lisp_Object aggressive
;
16533 /* If there is a scroll margin at the top of the window, find
16534 its character position. */
16536 /* Cannot call start_display if startp is not in the
16537 accessible region of the buffer. This can happen when we
16538 have just switched to a different buffer and/or changed
16539 its restriction. In that case, startp is initialized to
16540 the character position 1 (BEGV) because we did not yet
16541 have chance to display the buffer even once. */
16542 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16545 void *it1data
= NULL
;
16547 SAVE_IT (it1
, it
, it1data
);
16548 start_display (&it1
, w
, startp
);
16549 move_it_vertically (&it1
, margin
* frame_line_height
);
16550 margin_pos
= IT_CHARPOS (it1
);
16551 RESTORE_IT (&it
, &it
, it1data
);
16553 scrolling_up
= PT
> margin_pos
;
16556 ? BVAR (current_buffer
, scroll_up_aggressively
)
16557 : BVAR (current_buffer
, scroll_down_aggressively
);
16559 if (!MINI_WINDOW_P (w
)
16560 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16564 /* Setting scroll-conservatively overrides
16565 scroll-*-aggressively. */
16566 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16568 double float_amount
= XFLOATINT (aggressive
);
16570 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16571 if (pt_offset
== 0 && float_amount
> 0)
16573 if (pt_offset
&& margin
> 0)
16576 /* Compute how much to move the window start backward from
16577 point so that point will be displayed where the user
16581 centering_position
= it
.last_visible_y
;
16583 centering_position
-= pt_offset
;
16584 centering_position
-=
16585 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16586 + WINDOW_HEADER_LINE_HEIGHT (w
));
16587 /* Don't let point enter the scroll margin near top of
16589 if (centering_position
< margin
* frame_line_height
)
16590 centering_position
= margin
* frame_line_height
;
16593 centering_position
= margin
* frame_line_height
+ pt_offset
;
16596 /* Set the window start half the height of the window backward
16598 centering_position
= window_box_height (w
) / 2;
16600 move_it_vertically_backward (&it
, centering_position
);
16602 eassert (IT_CHARPOS (it
) >= BEGV
);
16604 /* The function move_it_vertically_backward may move over more
16605 than the specified y-distance. If it->w is small, e.g. a
16606 mini-buffer window, we may end up in front of the window's
16607 display area. Start displaying at the start of the line
16608 containing PT in this case. */
16609 if (it
.current_y
<= 0)
16611 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16612 move_it_vertically_backward (&it
, 0);
16616 it
.current_x
= it
.hpos
= 0;
16618 /* Set the window start position here explicitly, to avoid an
16619 infinite loop in case the functions in window-scroll-functions
16621 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16623 /* Run scroll hooks. */
16624 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16626 /* Redisplay the window. */
16627 if (!current_matrix_up_to_date_p
16628 || windows_or_buffers_changed
16629 || f
->cursor_type_changed
16630 /* Don't use try_window_reusing_current_matrix in this case
16631 because it can have changed the buffer. */
16632 || !NILP (Vwindow_scroll_functions
)
16633 || !just_this_one_p
16634 || MINI_WINDOW_P (w
)
16635 || !(used_current_matrix_p
16636 = try_window_reusing_current_matrix (w
)))
16637 try_window (window
, startp
, 0);
16639 /* If new fonts have been loaded (due to fontsets), give up. We
16640 have to start a new redisplay since we need to re-adjust glyph
16642 if (f
->fonts_changed
)
16643 goto need_larger_matrices
;
16645 /* If cursor did not appear assume that the middle of the window is
16646 in the first line of the window. Do it again with the next line.
16647 (Imagine a window of height 100, displaying two lines of height
16648 60. Moving back 50 from it->last_visible_y will end in the first
16650 if (w
->cursor
.vpos
< 0)
16652 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16654 clear_glyph_matrix (w
->desired_matrix
);
16655 move_it_by_lines (&it
, 1);
16656 try_window (window
, it
.current
.pos
, 0);
16658 else if (PT
< IT_CHARPOS (it
))
16660 clear_glyph_matrix (w
->desired_matrix
);
16661 move_it_by_lines (&it
, -1);
16662 try_window (window
, it
.current
.pos
, 0);
16666 /* Not much we can do about it. */
16670 /* Consider the following case: Window starts at BEGV, there is
16671 invisible, intangible text at BEGV, so that display starts at
16672 some point START > BEGV. It can happen that we are called with
16673 PT somewhere between BEGV and START. Try to handle that case,
16674 and similar ones. */
16675 if (w
->cursor
.vpos
< 0)
16677 /* First, try locating the proper glyph row for PT. */
16678 struct glyph_row
*row
=
16679 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16681 /* Sometimes point is at the beginning of invisible text that is
16682 before the 1st character displayed in the row. In that case,
16683 row_containing_pos fails to find the row, because no glyphs
16684 with appropriate buffer positions are present in the row.
16685 Therefore, we next try to find the row which shows the 1st
16686 position after the invisible text. */
16690 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16693 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16696 Lisp_Object invis_end
=
16697 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16700 if (NATNUMP (invis_end
))
16701 alt_pos
= XFASTINT (invis_end
);
16704 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16708 /* Finally, fall back on the first row of the window after the
16709 header line (if any). This is slightly better than not
16710 displaying the cursor at all. */
16713 row
= w
->current_matrix
->rows
;
16714 if (row
->mode_line_p
)
16717 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16720 if (!cursor_row_fully_visible_p (w
, false, false))
16722 /* If vscroll is enabled, disable it and try again. */
16726 clear_glyph_matrix (w
->desired_matrix
);
16730 /* Users who set scroll-conservatively to a large number want
16731 point just above/below the scroll margin. If we ended up
16732 with point's row partially visible, move the window start to
16733 make that row fully visible and out of the margin. */
16734 if (scroll_conservatively
> SCROLL_LIMIT
)
16736 int window_total_lines
16737 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16740 ? min (scroll_margin
, window_total_lines
/ 4)
16742 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16744 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16745 clear_glyph_matrix (w
->desired_matrix
);
16746 if (1 == try_window (window
, it
.current
.pos
,
16747 TRY_WINDOW_CHECK_MARGINS
))
16751 /* If centering point failed to make the whole line visible,
16752 put point at the top instead. That has to make the whole line
16753 visible, if it can be done. */
16754 if (centering_position
== 0)
16757 clear_glyph_matrix (w
->desired_matrix
);
16758 centering_position
= 0;
16764 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16765 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16766 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16768 /* Display the mode line, if we must. */
16769 if ((update_mode_line
16770 /* If window not full width, must redo its mode line
16771 if (a) the window to its side is being redone and
16772 (b) we do a frame-based redisplay. This is a consequence
16773 of how inverted lines are drawn in frame-based redisplay. */
16774 || (!just_this_one_p
16775 && !FRAME_WINDOW_P (f
)
16776 && !WINDOW_FULL_WIDTH_P (w
))
16777 /* Line number to display. */
16778 || w
->base_line_pos
> 0
16779 /* Column number is displayed and different from the one displayed. */
16780 || (w
->column_number_displayed
!= -1
16781 && (w
->column_number_displayed
!= current_column ())))
16782 /* This means that the window has a mode line. */
16783 && (WINDOW_WANTS_MODELINE_P (w
)
16784 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16787 display_mode_lines (w
);
16789 /* If mode line height has changed, arrange for a thorough
16790 immediate redisplay using the correct mode line height. */
16791 if (WINDOW_WANTS_MODELINE_P (w
)
16792 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16794 f
->fonts_changed
= true;
16795 w
->mode_line_height
= -1;
16796 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16797 = DESIRED_MODE_LINE_HEIGHT (w
);
16800 /* If header line height has changed, arrange for a thorough
16801 immediate redisplay using the correct header line height. */
16802 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16803 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16805 f
->fonts_changed
= true;
16806 w
->header_line_height
= -1;
16807 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16808 = DESIRED_HEADER_LINE_HEIGHT (w
);
16811 if (f
->fonts_changed
)
16812 goto need_larger_matrices
;
16815 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16817 w
->base_line_pos
= 0;
16818 w
->base_line_number
= 0;
16823 /* When we reach a frame's selected window, redo the frame's menu bar. */
16824 if (update_mode_line
16825 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16827 bool redisplay_menu_p
;
16829 if (FRAME_WINDOW_P (f
))
16831 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16832 || defined (HAVE_NS) || defined (USE_GTK)
16833 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16835 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16839 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16841 if (redisplay_menu_p
)
16842 display_menu_bar (w
);
16844 #ifdef HAVE_WINDOW_SYSTEM
16845 if (FRAME_WINDOW_P (f
))
16847 #if defined (USE_GTK) || defined (HAVE_NS)
16848 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16849 redisplay_tool_bar (f
);
16851 if (WINDOWP (f
->tool_bar_window
)
16852 && (FRAME_TOOL_BAR_LINES (f
) > 0
16853 || !NILP (Vauto_resize_tool_bars
))
16854 && redisplay_tool_bar (f
))
16855 ignore_mouse_drag_p
= true;
16861 #ifdef HAVE_WINDOW_SYSTEM
16862 if (FRAME_WINDOW_P (f
)
16863 && update_window_fringes (w
, (just_this_one_p
16864 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16865 || w
->pseudo_window_p
)))
16869 if (draw_window_fringes (w
, true))
16871 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16872 x_draw_right_divider (w
);
16874 x_draw_vertical_border (w
);
16880 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16881 x_draw_bottom_divider (w
);
16882 #endif /* HAVE_WINDOW_SYSTEM */
16884 /* We go to this label, with fonts_changed set, if it is
16885 necessary to try again using larger glyph matrices.
16886 We have to redeem the scroll bar even in this case,
16887 because the loop in redisplay_internal expects that. */
16888 need_larger_matrices
:
16890 finish_scroll_bars
:
16892 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16894 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16895 /* Set the thumb's position and size. */
16896 set_vertical_scroll_bar (w
);
16898 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16899 /* Set the thumb's position and size. */
16900 set_horizontal_scroll_bar (w
);
16902 /* Note that we actually used the scroll bar attached to this
16903 window, so it shouldn't be deleted at the end of redisplay. */
16904 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16905 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16908 /* Restore current_buffer and value of point in it. The window
16909 update may have changed the buffer, so first make sure `opoint'
16910 is still valid (Bug#6177). */
16911 if (CHARPOS (opoint
) < BEGV
)
16912 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16913 else if (CHARPOS (opoint
) > ZV
)
16914 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16916 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16918 set_buffer_internal_1 (old
);
16919 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16920 shorter. This can be caused by log truncation in *Messages*. */
16921 if (CHARPOS (lpoint
) <= ZV
)
16922 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16924 unbind_to (count
, Qnil
);
16928 /* Build the complete desired matrix of WINDOW with a window start
16929 buffer position POS.
16931 Value is 1 if successful. It is zero if fonts were loaded during
16932 redisplay which makes re-adjusting glyph matrices necessary, and -1
16933 if point would appear in the scroll margins.
16934 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16935 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16939 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16941 struct window
*w
= XWINDOW (window
);
16943 struct glyph_row
*last_text_row
= NULL
;
16944 struct frame
*f
= XFRAME (w
->frame
);
16945 int frame_line_height
= default_line_pixel_height (w
);
16947 /* Make POS the new window start. */
16948 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16950 /* Mark cursor position as unknown. No overlay arrow seen. */
16951 w
->cursor
.vpos
= -1;
16952 overlay_arrow_seen
= false;
16954 /* Initialize iterator and info to start at POS. */
16955 start_display (&it
, w
, pos
);
16956 it
.glyph_row
->reversed_p
= false;
16958 /* Display all lines of W. */
16959 while (it
.current_y
< it
.last_visible_y
)
16961 if (display_line (&it
))
16962 last_text_row
= it
.glyph_row
- 1;
16963 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16967 /* Don't let the cursor end in the scroll margins. */
16968 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16969 && !MINI_WINDOW_P (w
))
16971 int this_scroll_margin
;
16972 int window_total_lines
16973 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16975 if (scroll_margin
> 0)
16977 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16978 this_scroll_margin
*= frame_line_height
;
16981 this_scroll_margin
= 0;
16983 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16984 && w
->cursor
.y
< this_scroll_margin
16985 && CHARPOS (pos
) > BEGV
16986 && IT_CHARPOS (it
) < ZV
)
16987 /* rms: considering make_cursor_line_fully_visible_p here
16988 seems to give wrong results. We don't want to recenter
16989 when the last line is partly visible, we want to allow
16990 that case to be handled in the usual way. */
16991 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16993 w
->cursor
.vpos
= -1;
16994 clear_glyph_matrix (w
->desired_matrix
);
16999 /* If bottom moved off end of frame, change mode line percentage. */
17000 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17001 w
->update_mode_line
= true;
17003 /* Set window_end_pos to the offset of the last character displayed
17004 on the window from the end of current_buffer. Set
17005 window_end_vpos to its row number. */
17008 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17009 adjust_window_ends (w
, last_text_row
, false);
17011 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17012 w
->window_end_vpos
)));
17016 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17017 w
->window_end_pos
= Z
- ZV
;
17018 w
->window_end_vpos
= 0;
17021 /* But that is not valid info until redisplay finishes. */
17022 w
->window_end_valid
= false;
17028 /************************************************************************
17029 Window redisplay reusing current matrix when buffer has not changed
17030 ************************************************************************/
17032 /* Try redisplay of window W showing an unchanged buffer with a
17033 different window start than the last time it was displayed by
17034 reusing its current matrix. Value is true if successful.
17035 W->start is the new window start. */
17038 try_window_reusing_current_matrix (struct window
*w
)
17040 struct frame
*f
= XFRAME (w
->frame
);
17041 struct glyph_row
*bottom_row
;
17044 struct text_pos start
, new_start
;
17045 int nrows_scrolled
, i
;
17046 struct glyph_row
*last_text_row
;
17047 struct glyph_row
*last_reused_text_row
;
17048 struct glyph_row
*start_row
;
17049 int start_vpos
, min_y
, max_y
;
17052 if (inhibit_try_window_reusing
)
17056 if (/* This function doesn't handle terminal frames. */
17057 !FRAME_WINDOW_P (f
)
17058 /* Don't try to reuse the display if windows have been split
17060 || windows_or_buffers_changed
17061 || f
->cursor_type_changed
)
17064 /* Can't do this if showing trailing whitespace. */
17065 if (!NILP (Vshow_trailing_whitespace
))
17068 /* If top-line visibility has changed, give up. */
17069 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17070 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17073 /* Give up if old or new display is scrolled vertically. We could
17074 make this function handle this, but right now it doesn't. */
17075 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17076 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17079 /* The variable new_start now holds the new window start. The old
17080 start `start' can be determined from the current matrix. */
17081 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17082 start
= start_row
->minpos
;
17083 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17085 /* Clear the desired matrix for the display below. */
17086 clear_glyph_matrix (w
->desired_matrix
);
17088 if (CHARPOS (new_start
) <= CHARPOS (start
))
17090 /* Don't use this method if the display starts with an ellipsis
17091 displayed for invisible text. It's not easy to handle that case
17092 below, and it's certainly not worth the effort since this is
17093 not a frequent case. */
17094 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17097 IF_DEBUG (debug_method_add (w
, "twu1"));
17099 /* Display up to a row that can be reused. The variable
17100 last_text_row is set to the last row displayed that displays
17101 text. Note that it.vpos == 0 if or if not there is a
17102 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17103 start_display (&it
, w
, new_start
);
17104 w
->cursor
.vpos
= -1;
17105 last_text_row
= last_reused_text_row
= NULL
;
17107 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17109 /* If we have reached into the characters in the START row,
17110 that means the line boundaries have changed. So we
17111 can't start copying with the row START. Maybe it will
17112 work to start copying with the following row. */
17113 while (IT_CHARPOS (it
) > CHARPOS (start
))
17115 /* Advance to the next row as the "start". */
17117 start
= start_row
->minpos
;
17118 /* If there are no more rows to try, or just one, give up. */
17119 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17120 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17121 || CHARPOS (start
) == ZV
)
17123 clear_glyph_matrix (w
->desired_matrix
);
17127 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17129 /* If we have reached alignment, we can copy the rest of the
17131 if (IT_CHARPOS (it
) == CHARPOS (start
)
17132 /* Don't accept "alignment" inside a display vector,
17133 since start_row could have started in the middle of
17134 that same display vector (thus their character
17135 positions match), and we have no way of telling if
17136 that is the case. */
17137 && it
.current
.dpvec_index
< 0)
17140 it
.glyph_row
->reversed_p
= false;
17141 if (display_line (&it
))
17142 last_text_row
= it
.glyph_row
- 1;
17146 /* A value of current_y < last_visible_y means that we stopped
17147 at the previous window start, which in turn means that we
17148 have at least one reusable row. */
17149 if (it
.current_y
< it
.last_visible_y
)
17151 struct glyph_row
*row
;
17153 /* IT.vpos always starts from 0; it counts text lines. */
17154 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17156 /* Find PT if not already found in the lines displayed. */
17157 if (w
->cursor
.vpos
< 0)
17159 int dy
= it
.current_y
- start_row
->y
;
17161 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17162 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17164 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17165 dy
, nrows_scrolled
);
17168 clear_glyph_matrix (w
->desired_matrix
);
17173 /* Scroll the display. Do it before the current matrix is
17174 changed. The problem here is that update has not yet
17175 run, i.e. part of the current matrix is not up to date.
17176 scroll_run_hook will clear the cursor, and use the
17177 current matrix to get the height of the row the cursor is
17179 run
.current_y
= start_row
->y
;
17180 run
.desired_y
= it
.current_y
;
17181 run
.height
= it
.last_visible_y
- it
.current_y
;
17183 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17186 FRAME_RIF (f
)->update_window_begin_hook (w
);
17187 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17188 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17189 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17193 /* Shift current matrix down by nrows_scrolled lines. */
17194 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17195 rotate_matrix (w
->current_matrix
,
17197 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17200 /* Disable lines that must be updated. */
17201 for (i
= 0; i
< nrows_scrolled
; ++i
)
17202 (start_row
+ i
)->enabled_p
= false;
17204 /* Re-compute Y positions. */
17205 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17206 max_y
= it
.last_visible_y
;
17207 for (row
= start_row
+ nrows_scrolled
;
17211 row
->y
= it
.current_y
;
17212 row
->visible_height
= row
->height
;
17214 if (row
->y
< min_y
)
17215 row
->visible_height
-= min_y
- row
->y
;
17216 if (row
->y
+ row
->height
> max_y
)
17217 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17218 if (row
->fringe_bitmap_periodic_p
)
17219 row
->redraw_fringe_bitmaps_p
= true;
17221 it
.current_y
+= row
->height
;
17223 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17224 last_reused_text_row
= row
;
17225 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17229 /* Disable lines in the current matrix which are now
17230 below the window. */
17231 for (++row
; row
< bottom_row
; ++row
)
17232 row
->enabled_p
= row
->mode_line_p
= false;
17235 /* Update window_end_pos etc.; last_reused_text_row is the last
17236 reused row from the current matrix containing text, if any.
17237 The value of last_text_row is the last displayed line
17238 containing text. */
17239 if (last_reused_text_row
)
17240 adjust_window_ends (w
, last_reused_text_row
, true);
17241 else if (last_text_row
)
17242 adjust_window_ends (w
, last_text_row
, false);
17245 /* This window must be completely empty. */
17246 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17247 w
->window_end_pos
= Z
- ZV
;
17248 w
->window_end_vpos
= 0;
17250 w
->window_end_valid
= false;
17252 /* Update hint: don't try scrolling again in update_window. */
17253 w
->desired_matrix
->no_scrolling_p
= true;
17256 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17260 else if (CHARPOS (new_start
) > CHARPOS (start
))
17262 struct glyph_row
*pt_row
, *row
;
17263 struct glyph_row
*first_reusable_row
;
17264 struct glyph_row
*first_row_to_display
;
17266 int yb
= window_text_bottom_y (w
);
17268 /* Find the row starting at new_start, if there is one. Don't
17269 reuse a partially visible line at the end. */
17270 first_reusable_row
= start_row
;
17271 while (first_reusable_row
->enabled_p
17272 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17273 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17274 < CHARPOS (new_start
)))
17275 ++first_reusable_row
;
17277 /* Give up if there is no row to reuse. */
17278 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17279 || !first_reusable_row
->enabled_p
17280 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17281 != CHARPOS (new_start
)))
17284 /* We can reuse fully visible rows beginning with
17285 first_reusable_row to the end of the window. Set
17286 first_row_to_display to the first row that cannot be reused.
17287 Set pt_row to the row containing point, if there is any. */
17289 for (first_row_to_display
= first_reusable_row
;
17290 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17291 ++first_row_to_display
)
17293 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17294 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17295 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17296 && first_row_to_display
->ends_at_zv_p
17297 && pt_row
== NULL
)))
17298 pt_row
= first_row_to_display
;
17301 /* Start displaying at the start of first_row_to_display. */
17302 eassert (first_row_to_display
->y
< yb
);
17303 init_to_row_start (&it
, w
, first_row_to_display
);
17305 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17307 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17309 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17310 + WINDOW_HEADER_LINE_HEIGHT (w
));
17312 /* Display lines beginning with first_row_to_display in the
17313 desired matrix. Set last_text_row to the last row displayed
17314 that displays text. */
17315 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17316 if (pt_row
== NULL
)
17317 w
->cursor
.vpos
= -1;
17318 last_text_row
= NULL
;
17319 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17320 if (display_line (&it
))
17321 last_text_row
= it
.glyph_row
- 1;
17323 /* If point is in a reused row, adjust y and vpos of the cursor
17327 w
->cursor
.vpos
-= nrows_scrolled
;
17328 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17331 /* Give up if point isn't in a row displayed or reused. (This
17332 also handles the case where w->cursor.vpos < nrows_scrolled
17333 after the calls to display_line, which can happen with scroll
17334 margins. See bug#1295.) */
17335 if (w
->cursor
.vpos
< 0)
17337 clear_glyph_matrix (w
->desired_matrix
);
17341 /* Scroll the display. */
17342 run
.current_y
= first_reusable_row
->y
;
17343 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17344 run
.height
= it
.last_visible_y
- run
.current_y
;
17345 dy
= run
.current_y
- run
.desired_y
;
17350 FRAME_RIF (f
)->update_window_begin_hook (w
);
17351 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17352 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17353 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17357 /* Adjust Y positions of reused rows. */
17358 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17359 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17360 max_y
= it
.last_visible_y
;
17361 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17364 row
->visible_height
= row
->height
;
17365 if (row
->y
< min_y
)
17366 row
->visible_height
-= min_y
- row
->y
;
17367 if (row
->y
+ row
->height
> max_y
)
17368 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17369 if (row
->fringe_bitmap_periodic_p
)
17370 row
->redraw_fringe_bitmaps_p
= true;
17373 /* Scroll the current matrix. */
17374 eassert (nrows_scrolled
> 0);
17375 rotate_matrix (w
->current_matrix
,
17377 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17380 /* Disable rows not reused. */
17381 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17382 row
->enabled_p
= false;
17384 /* Point may have moved to a different line, so we cannot assume that
17385 the previous cursor position is valid; locate the correct row. */
17388 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17390 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17391 && !row
->ends_at_zv_p
;
17395 w
->cursor
.y
= row
->y
;
17397 if (row
< bottom_row
)
17399 /* Can't simply scan the row for point with
17400 bidi-reordered glyph rows. Let set_cursor_from_row
17401 figure out where to put the cursor, and if it fails,
17403 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17405 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17408 clear_glyph_matrix (w
->desired_matrix
);
17414 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17415 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17418 && (!BUFFERP (glyph
->object
)
17419 || glyph
->charpos
< PT
);
17423 w
->cursor
.x
+= glyph
->pixel_width
;
17429 /* Adjust window end. A null value of last_text_row means that
17430 the window end is in reused rows which in turn means that
17431 only its vpos can have changed. */
17433 adjust_window_ends (w
, last_text_row
, false);
17435 w
->window_end_vpos
-= nrows_scrolled
;
17437 w
->window_end_valid
= false;
17438 w
->desired_matrix
->no_scrolling_p
= true;
17441 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17451 /************************************************************************
17452 Window redisplay reusing current matrix when buffer has changed
17453 ************************************************************************/
17455 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17456 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17457 ptrdiff_t *, ptrdiff_t *);
17458 static struct glyph_row
*
17459 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17460 struct glyph_row
*);
17463 /* Return the last row in MATRIX displaying text. If row START is
17464 non-null, start searching with that row. IT gives the dimensions
17465 of the display. Value is null if matrix is empty; otherwise it is
17466 a pointer to the row found. */
17468 static struct glyph_row
*
17469 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17470 struct glyph_row
*start
)
17472 struct glyph_row
*row
, *row_found
;
17474 /* Set row_found to the last row in IT->w's current matrix
17475 displaying text. The loop looks funny but think of partially
17478 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17479 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17481 eassert (row
->enabled_p
);
17483 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17492 /* Return the last row in the current matrix of W that is not affected
17493 by changes at the start of current_buffer that occurred since W's
17494 current matrix was built. Value is null if no such row exists.
17496 BEG_UNCHANGED us the number of characters unchanged at the start of
17497 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17498 first changed character in current_buffer. Characters at positions <
17499 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17500 when the current matrix was built. */
17502 static struct glyph_row
*
17503 find_last_unchanged_at_beg_row (struct window
*w
)
17505 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17506 struct glyph_row
*row
;
17507 struct glyph_row
*row_found
= NULL
;
17508 int yb
= window_text_bottom_y (w
);
17510 /* Find the last row displaying unchanged text. */
17511 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17512 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17513 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17516 if (/* If row ends before first_changed_pos, it is unchanged,
17517 except in some case. */
17518 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17519 /* When row ends in ZV and we write at ZV it is not
17521 && !row
->ends_at_zv_p
17522 /* When first_changed_pos is the end of a continued line,
17523 row is not unchanged because it may be no longer
17525 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17526 && (row
->continued_p
17527 || row
->exact_window_width_line_p
))
17528 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17529 needs to be recomputed, so don't consider this row as
17530 unchanged. This happens when the last line was
17531 bidi-reordered and was killed immediately before this
17532 redisplay cycle. In that case, ROW->end stores the
17533 buffer position of the first visual-order character of
17534 the killed text, which is now beyond ZV. */
17535 && CHARPOS (row
->end
.pos
) <= ZV
)
17538 /* Stop if last visible row. */
17539 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17547 /* Find the first glyph row in the current matrix of W that is not
17548 affected by changes at the end of current_buffer since the
17549 time W's current matrix was built.
17551 Return in *DELTA the number of chars by which buffer positions in
17552 unchanged text at the end of current_buffer must be adjusted.
17554 Return in *DELTA_BYTES the corresponding number of bytes.
17556 Value is null if no such row exists, i.e. all rows are affected by
17559 static struct glyph_row
*
17560 find_first_unchanged_at_end_row (struct window
*w
,
17561 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17563 struct glyph_row
*row
;
17564 struct glyph_row
*row_found
= NULL
;
17566 *delta
= *delta_bytes
= 0;
17568 /* Display must not have been paused, otherwise the current matrix
17569 is not up to date. */
17570 eassert (w
->window_end_valid
);
17572 /* A value of window_end_pos >= END_UNCHANGED means that the window
17573 end is in the range of changed text. If so, there is no
17574 unchanged row at the end of W's current matrix. */
17575 if (w
->window_end_pos
>= END_UNCHANGED
)
17578 /* Set row to the last row in W's current matrix displaying text. */
17579 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17581 /* If matrix is entirely empty, no unchanged row exists. */
17582 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17584 /* The value of row is the last glyph row in the matrix having a
17585 meaningful buffer position in it. The end position of row
17586 corresponds to window_end_pos. This allows us to translate
17587 buffer positions in the current matrix to current buffer
17588 positions for characters not in changed text. */
17590 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17591 ptrdiff_t Z_BYTE_old
=
17592 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17593 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17594 struct glyph_row
*first_text_row
17595 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17597 *delta
= Z
- Z_old
;
17598 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17600 /* Set last_unchanged_pos to the buffer position of the last
17601 character in the buffer that has not been changed. Z is the
17602 index + 1 of the last character in current_buffer, i.e. by
17603 subtracting END_UNCHANGED we get the index of the last
17604 unchanged character, and we have to add BEG to get its buffer
17606 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17607 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17609 /* Search backward from ROW for a row displaying a line that
17610 starts at a minimum position >= last_unchanged_pos_old. */
17611 for (; row
> first_text_row
; --row
)
17613 /* This used to abort, but it can happen.
17614 It is ok to just stop the search instead here. KFS. */
17615 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17618 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17623 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17629 /* Make sure that glyph rows in the current matrix of window W
17630 reference the same glyph memory as corresponding rows in the
17631 frame's frame matrix. This function is called after scrolling W's
17632 current matrix on a terminal frame in try_window_id and
17633 try_window_reusing_current_matrix. */
17636 sync_frame_with_window_matrix_rows (struct window
*w
)
17638 struct frame
*f
= XFRAME (w
->frame
);
17639 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17641 /* Preconditions: W must be a leaf window and full-width. Its frame
17642 must have a frame matrix. */
17643 eassert (BUFFERP (w
->contents
));
17644 eassert (WINDOW_FULL_WIDTH_P (w
));
17645 eassert (!FRAME_WINDOW_P (f
));
17647 /* If W is a full-width window, glyph pointers in W's current matrix
17648 have, by definition, to be the same as glyph pointers in the
17649 corresponding frame matrix. Note that frame matrices have no
17650 marginal areas (see build_frame_matrix). */
17651 window_row
= w
->current_matrix
->rows
;
17652 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17653 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17654 while (window_row
< window_row_end
)
17656 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17657 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17659 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17660 frame_row
->glyphs
[TEXT_AREA
] = start
;
17661 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17662 frame_row
->glyphs
[LAST_AREA
] = end
;
17664 /* Disable frame rows whose corresponding window rows have
17665 been disabled in try_window_id. */
17666 if (!window_row
->enabled_p
)
17667 frame_row
->enabled_p
= false;
17669 ++window_row
, ++frame_row
;
17674 /* Find the glyph row in window W containing CHARPOS. Consider all
17675 rows between START and END (not inclusive). END null means search
17676 all rows to the end of the display area of W. Value is the row
17677 containing CHARPOS or null. */
17680 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17681 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17683 struct glyph_row
*row
= start
;
17684 struct glyph_row
*best_row
= NULL
;
17685 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17688 /* If we happen to start on a header-line, skip that. */
17689 if (row
->mode_line_p
)
17692 if ((end
&& row
>= end
) || !row
->enabled_p
)
17695 last_y
= window_text_bottom_y (w
) - dy
;
17699 /* Give up if we have gone too far. */
17700 if (end
&& row
>= end
)
17702 /* This formerly returned if they were equal.
17703 I think that both quantities are of a "last plus one" type;
17704 if so, when they are equal, the row is within the screen. -- rms. */
17705 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17708 /* If it is in this row, return this row. */
17709 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17710 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17711 /* The end position of a row equals the start
17712 position of the next row. If CHARPOS is there, we
17713 would rather consider it displayed in the next
17714 line, except when this line ends in ZV. */
17715 && !row_for_charpos_p (row
, charpos
)))
17716 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17720 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17721 || (!best_row
&& !row
->continued_p
))
17723 /* In bidi-reordered rows, there could be several rows whose
17724 edges surround CHARPOS, all of these rows belonging to
17725 the same continued line. We need to find the row which
17726 fits CHARPOS the best. */
17727 for (g
= row
->glyphs
[TEXT_AREA
];
17728 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17731 if (!STRINGP (g
->object
))
17733 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17735 mindif
= eabs (g
->charpos
- charpos
);
17737 /* Exact match always wins. */
17744 else if (best_row
&& !row
->continued_p
)
17751 /* Try to redisplay window W by reusing its existing display. W's
17752 current matrix must be up to date when this function is called,
17753 i.e., window_end_valid must be true.
17757 >= 1 if successful, i.e. display has been updated
17759 1 means the changes were in front of a newline that precedes
17760 the window start, and the whole current matrix was reused
17761 2 means the changes were after the last position displayed
17762 in the window, and the whole current matrix was reused
17763 3 means portions of the current matrix were reused, while
17764 some of the screen lines were redrawn
17765 -1 if redisplay with same window start is known not to succeed
17766 0 if otherwise unsuccessful
17768 The following steps are performed:
17770 1. Find the last row in the current matrix of W that is not
17771 affected by changes at the start of current_buffer. If no such row
17774 2. Find the first row in W's current matrix that is not affected by
17775 changes at the end of current_buffer. Maybe there is no such row.
17777 3. Display lines beginning with the row + 1 found in step 1 to the
17778 row found in step 2 or, if step 2 didn't find a row, to the end of
17781 4. If cursor is not known to appear on the window, give up.
17783 5. If display stopped at the row found in step 2, scroll the
17784 display and current matrix as needed.
17786 6. Maybe display some lines at the end of W, if we must. This can
17787 happen under various circumstances, like a partially visible line
17788 becoming fully visible, or because newly displayed lines are displayed
17789 in smaller font sizes.
17791 7. Update W's window end information. */
17794 try_window_id (struct window
*w
)
17796 struct frame
*f
= XFRAME (w
->frame
);
17797 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17798 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17799 struct glyph_row
*last_unchanged_at_beg_row
;
17800 struct glyph_row
*first_unchanged_at_end_row
;
17801 struct glyph_row
*row
;
17802 struct glyph_row
*bottom_row
;
17805 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17807 struct text_pos start_pos
;
17809 int first_unchanged_at_end_vpos
= 0;
17810 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17811 struct text_pos start
;
17812 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17815 if (inhibit_try_window_id
)
17819 /* This is handy for debugging. */
17821 #define GIVE_UP(X) \
17823 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17827 #define GIVE_UP(X) return 0
17830 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17832 /* Don't use this for mini-windows because these can show
17833 messages and mini-buffers, and we don't handle that here. */
17834 if (MINI_WINDOW_P (w
))
17837 /* This flag is used to prevent redisplay optimizations. */
17838 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17841 /* This function's optimizations cannot be used if overlays have
17842 changed in the buffer displayed by the window, so give up if they
17844 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17847 /* Verify that narrowing has not changed.
17848 Also verify that we were not told to prevent redisplay optimizations.
17849 It would be nice to further
17850 reduce the number of cases where this prevents try_window_id. */
17851 if (current_buffer
->clip_changed
17852 || current_buffer
->prevent_redisplay_optimizations_p
)
17855 /* Window must either use window-based redisplay or be full width. */
17856 if (!FRAME_WINDOW_P (f
)
17857 && (!FRAME_LINE_INS_DEL_OK (f
)
17858 || !WINDOW_FULL_WIDTH_P (w
)))
17861 /* Give up if point is known NOT to appear in W. */
17862 if (PT
< CHARPOS (start
))
17865 /* Another way to prevent redisplay optimizations. */
17866 if (w
->last_modified
== 0)
17869 /* Verify that window is not hscrolled. */
17870 if (w
->hscroll
!= 0)
17873 /* Verify that display wasn't paused. */
17874 if (!w
->window_end_valid
)
17877 /* Likewise if highlighting trailing whitespace. */
17878 if (!NILP (Vshow_trailing_whitespace
))
17881 /* Can't use this if overlay arrow position and/or string have
17883 if (overlay_arrows_changed_p ())
17886 /* When word-wrap is on, adding a space to the first word of a
17887 wrapped line can change the wrap position, altering the line
17888 above it. It might be worthwhile to handle this more
17889 intelligently, but for now just redisplay from scratch. */
17890 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17893 /* Under bidi reordering, adding or deleting a character in the
17894 beginning of a paragraph, before the first strong directional
17895 character, can change the base direction of the paragraph (unless
17896 the buffer specifies a fixed paragraph direction), which will
17897 require to redisplay the whole paragraph. It might be worthwhile
17898 to find the paragraph limits and widen the range of redisplayed
17899 lines to that, but for now just give up this optimization and
17900 redisplay from scratch. */
17901 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17902 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17905 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17906 to that variable require thorough redisplay. */
17907 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
17910 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17911 only if buffer has really changed. The reason is that the gap is
17912 initially at Z for freshly visited files. The code below would
17913 set end_unchanged to 0 in that case. */
17914 if (MODIFF
> SAVE_MODIFF
17915 /* This seems to happen sometimes after saving a buffer. */
17916 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17918 if (GPT
- BEG
< BEG_UNCHANGED
)
17919 BEG_UNCHANGED
= GPT
- BEG
;
17920 if (Z
- GPT
< END_UNCHANGED
)
17921 END_UNCHANGED
= Z
- GPT
;
17924 /* The position of the first and last character that has been changed. */
17925 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17926 last_changed_charpos
= Z
- END_UNCHANGED
;
17928 /* If window starts after a line end, and the last change is in
17929 front of that newline, then changes don't affect the display.
17930 This case happens with stealth-fontification. Note that although
17931 the display is unchanged, glyph positions in the matrix have to
17932 be adjusted, of course. */
17933 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17934 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17935 && ((last_changed_charpos
< CHARPOS (start
)
17936 && CHARPOS (start
) == BEGV
)
17937 || (last_changed_charpos
< CHARPOS (start
) - 1
17938 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17940 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17941 struct glyph_row
*r0
;
17943 /* Compute how many chars/bytes have been added to or removed
17944 from the buffer. */
17945 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17946 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17947 Z_delta
= Z
- Z_old
;
17948 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17950 /* Give up if PT is not in the window. Note that it already has
17951 been checked at the start of try_window_id that PT is not in
17952 front of the window start. */
17953 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17956 /* If window start is unchanged, we can reuse the whole matrix
17957 as is, after adjusting glyph positions. No need to compute
17958 the window end again, since its offset from Z hasn't changed. */
17959 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17960 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17961 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17962 /* PT must not be in a partially visible line. */
17963 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17964 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17966 /* Adjust positions in the glyph matrix. */
17967 if (Z_delta
|| Z_delta_bytes
)
17969 struct glyph_row
*r1
17970 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17971 increment_matrix_positions (w
->current_matrix
,
17972 MATRIX_ROW_VPOS (r0
, current_matrix
),
17973 MATRIX_ROW_VPOS (r1
, current_matrix
),
17974 Z_delta
, Z_delta_bytes
);
17977 /* Set the cursor. */
17978 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17980 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17985 /* Handle the case that changes are all below what is displayed in
17986 the window, and that PT is in the window. This shortcut cannot
17987 be taken if ZV is visible in the window, and text has been added
17988 there that is visible in the window. */
17989 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17990 /* ZV is not visible in the window, or there are no
17991 changes at ZV, actually. */
17992 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17993 || first_changed_charpos
== last_changed_charpos
))
17995 struct glyph_row
*r0
;
17997 /* Give up if PT is not in the window. Note that it already has
17998 been checked at the start of try_window_id that PT is not in
17999 front of the window start. */
18000 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18003 /* If window start is unchanged, we can reuse the whole matrix
18004 as is, without changing glyph positions since no text has
18005 been added/removed in front of the window end. */
18006 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18007 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18008 /* PT must not be in a partially visible line. */
18009 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18010 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18012 /* We have to compute the window end anew since text
18013 could have been added/removed after it. */
18014 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18015 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18017 /* Set the cursor. */
18018 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18020 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18025 /* Give up if window start is in the changed area.
18027 The condition used to read
18029 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18031 but why that was tested escapes me at the moment. */
18032 if (CHARPOS (start
) >= first_changed_charpos
18033 && CHARPOS (start
) <= last_changed_charpos
)
18036 /* Check that window start agrees with the start of the first glyph
18037 row in its current matrix. Check this after we know the window
18038 start is not in changed text, otherwise positions would not be
18040 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18041 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18044 /* Give up if the window ends in strings. Overlay strings
18045 at the end are difficult to handle, so don't try. */
18046 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18047 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18050 /* Compute the position at which we have to start displaying new
18051 lines. Some of the lines at the top of the window might be
18052 reusable because they are not displaying changed text. Find the
18053 last row in W's current matrix not affected by changes at the
18054 start of current_buffer. Value is null if changes start in the
18055 first line of window. */
18056 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18057 if (last_unchanged_at_beg_row
)
18059 /* Avoid starting to display in the middle of a character, a TAB
18060 for instance. This is easier than to set up the iterator
18061 exactly, and it's not a frequent case, so the additional
18062 effort wouldn't really pay off. */
18063 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18064 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18065 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18066 --last_unchanged_at_beg_row
;
18068 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18071 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18073 start_pos
= it
.current
.pos
;
18075 /* Start displaying new lines in the desired matrix at the same
18076 vpos we would use in the current matrix, i.e. below
18077 last_unchanged_at_beg_row. */
18078 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18080 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18081 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18083 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18087 /* There are no reusable lines at the start of the window.
18088 Start displaying in the first text line. */
18089 start_display (&it
, w
, start
);
18090 it
.vpos
= it
.first_vpos
;
18091 start_pos
= it
.current
.pos
;
18094 /* Find the first row that is not affected by changes at the end of
18095 the buffer. Value will be null if there is no unchanged row, in
18096 which case we must redisplay to the end of the window. delta
18097 will be set to the value by which buffer positions beginning with
18098 first_unchanged_at_end_row have to be adjusted due to text
18100 first_unchanged_at_end_row
18101 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18102 IF_DEBUG (debug_delta
= delta
);
18103 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18105 /* Set stop_pos to the buffer position up to which we will have to
18106 display new lines. If first_unchanged_at_end_row != NULL, this
18107 is the buffer position of the start of the line displayed in that
18108 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18109 that we don't stop at a buffer position. */
18111 if (first_unchanged_at_end_row
)
18113 eassert (last_unchanged_at_beg_row
== NULL
18114 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18116 /* If this is a continuation line, move forward to the next one
18117 that isn't. Changes in lines above affect this line.
18118 Caution: this may move first_unchanged_at_end_row to a row
18119 not displaying text. */
18120 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18121 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18122 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18123 < it
.last_visible_y
))
18124 ++first_unchanged_at_end_row
;
18126 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18127 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18128 >= it
.last_visible_y
))
18129 first_unchanged_at_end_row
= NULL
;
18132 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18134 first_unchanged_at_end_vpos
18135 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18136 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18139 else if (last_unchanged_at_beg_row
== NULL
)
18145 /* Either there is no unchanged row at the end, or the one we have
18146 now displays text. This is a necessary condition for the window
18147 end pos calculation at the end of this function. */
18148 eassert (first_unchanged_at_end_row
== NULL
18149 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18151 debug_last_unchanged_at_beg_vpos
18152 = (last_unchanged_at_beg_row
18153 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18155 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18157 #endif /* GLYPH_DEBUG */
18160 /* Display new lines. Set last_text_row to the last new line
18161 displayed which has text on it, i.e. might end up as being the
18162 line where the window_end_vpos is. */
18163 w
->cursor
.vpos
= -1;
18164 last_text_row
= NULL
;
18165 overlay_arrow_seen
= false;
18166 if (it
.current_y
< it
.last_visible_y
18167 && !f
->fonts_changed
18168 && (first_unchanged_at_end_row
== NULL
18169 || IT_CHARPOS (it
) < stop_pos
))
18170 it
.glyph_row
->reversed_p
= false;
18171 while (it
.current_y
< it
.last_visible_y
18172 && !f
->fonts_changed
18173 && (first_unchanged_at_end_row
== NULL
18174 || IT_CHARPOS (it
) < stop_pos
))
18176 if (display_line (&it
))
18177 last_text_row
= it
.glyph_row
- 1;
18180 if (f
->fonts_changed
)
18183 /* The redisplay iterations in display_line above could have
18184 triggered font-lock, which could have done something that
18185 invalidates IT->w window's end-point information, on which we
18186 rely below. E.g., one package, which will remain unnamed, used
18187 to install a font-lock-fontify-region-function that called
18188 bury-buffer, whose side effect is to switch the buffer displayed
18189 by IT->w, and that predictably resets IT->w's window_end_valid
18190 flag, which we already tested at the entry to this function.
18191 Amply punish such packages/modes by giving up on this
18192 optimization in those cases. */
18193 if (!w
->window_end_valid
)
18195 clear_glyph_matrix (w
->desired_matrix
);
18199 /* Compute differences in buffer positions, y-positions etc. for
18200 lines reused at the bottom of the window. Compute what we can
18202 if (first_unchanged_at_end_row
18203 /* No lines reused because we displayed everything up to the
18204 bottom of the window. */
18205 && it
.current_y
< it
.last_visible_y
)
18208 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18210 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18211 run
.current_y
= first_unchanged_at_end_row
->y
;
18212 run
.desired_y
= run
.current_y
+ dy
;
18213 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18217 delta
= delta_bytes
= dvpos
= dy
18218 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18219 first_unchanged_at_end_row
= NULL
;
18221 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18224 /* Find the cursor if not already found. We have to decide whether
18225 PT will appear on this window (it sometimes doesn't, but this is
18226 not a very frequent case.) This decision has to be made before
18227 the current matrix is altered. A value of cursor.vpos < 0 means
18228 that PT is either in one of the lines beginning at
18229 first_unchanged_at_end_row or below the window. Don't care for
18230 lines that might be displayed later at the window end; as
18231 mentioned, this is not a frequent case. */
18232 if (w
->cursor
.vpos
< 0)
18234 /* Cursor in unchanged rows at the top? */
18235 if (PT
< CHARPOS (start_pos
)
18236 && last_unchanged_at_beg_row
)
18238 row
= row_containing_pos (w
, PT
,
18239 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18240 last_unchanged_at_beg_row
+ 1, 0);
18242 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18245 /* Start from first_unchanged_at_end_row looking for PT. */
18246 else if (first_unchanged_at_end_row
)
18248 row
= row_containing_pos (w
, PT
- delta
,
18249 first_unchanged_at_end_row
, NULL
, 0);
18251 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18252 delta_bytes
, dy
, dvpos
);
18255 /* Give up if cursor was not found. */
18256 if (w
->cursor
.vpos
< 0)
18258 clear_glyph_matrix (w
->desired_matrix
);
18263 /* Don't let the cursor end in the scroll margins. */
18265 int this_scroll_margin
, cursor_height
;
18266 int frame_line_height
= default_line_pixel_height (w
);
18267 int window_total_lines
18268 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18270 this_scroll_margin
=
18271 max (0, min (scroll_margin
, window_total_lines
/ 4));
18272 this_scroll_margin
*= frame_line_height
;
18273 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18275 if ((w
->cursor
.y
< this_scroll_margin
18276 && CHARPOS (start
) > BEGV
)
18277 /* Old redisplay didn't take scroll margin into account at the bottom,
18278 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18279 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18280 ? cursor_height
+ this_scroll_margin
18281 : 1)) > it
.last_visible_y
)
18283 w
->cursor
.vpos
= -1;
18284 clear_glyph_matrix (w
->desired_matrix
);
18289 /* Scroll the display. Do it before changing the current matrix so
18290 that xterm.c doesn't get confused about where the cursor glyph is
18292 if (dy
&& run
.height
)
18296 if (FRAME_WINDOW_P (f
))
18298 FRAME_RIF (f
)->update_window_begin_hook (w
);
18299 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18300 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18301 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18305 /* Terminal frame. In this case, dvpos gives the number of
18306 lines to scroll by; dvpos < 0 means scroll up. */
18308 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18309 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18310 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18311 + WINDOW_WANTS_HEADER_LINE_P (w
)
18312 + window_internal_height (w
));
18314 #if defined (HAVE_GPM) || defined (MSDOS)
18315 x_clear_window_mouse_face (w
);
18317 /* Perform the operation on the screen. */
18320 /* Scroll last_unchanged_at_beg_row to the end of the
18321 window down dvpos lines. */
18322 set_terminal_window (f
, end
);
18324 /* On dumb terminals delete dvpos lines at the end
18325 before inserting dvpos empty lines. */
18326 if (!FRAME_SCROLL_REGION_OK (f
))
18327 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18329 /* Insert dvpos empty lines in front of
18330 last_unchanged_at_beg_row. */
18331 ins_del_lines (f
, from
, dvpos
);
18333 else if (dvpos
< 0)
18335 /* Scroll up last_unchanged_at_beg_vpos to the end of
18336 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18337 set_terminal_window (f
, end
);
18339 /* Delete dvpos lines in front of
18340 last_unchanged_at_beg_vpos. ins_del_lines will set
18341 the cursor to the given vpos and emit |dvpos| delete
18343 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18345 /* On a dumb terminal insert dvpos empty lines at the
18347 if (!FRAME_SCROLL_REGION_OK (f
))
18348 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18351 set_terminal_window (f
, 0);
18357 /* Shift reused rows of the current matrix to the right position.
18358 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18360 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18361 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18364 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18365 bottom_vpos
, dvpos
);
18366 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18369 else if (dvpos
> 0)
18371 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18372 bottom_vpos
, dvpos
);
18373 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18374 first_unchanged_at_end_vpos
+ dvpos
);
18377 /* For frame-based redisplay, make sure that current frame and window
18378 matrix are in sync with respect to glyph memory. */
18379 if (!FRAME_WINDOW_P (f
))
18380 sync_frame_with_window_matrix_rows (w
);
18382 /* Adjust buffer positions in reused rows. */
18383 if (delta
|| delta_bytes
)
18384 increment_matrix_positions (current_matrix
,
18385 first_unchanged_at_end_vpos
+ dvpos
,
18386 bottom_vpos
, delta
, delta_bytes
);
18388 /* Adjust Y positions. */
18390 shift_glyph_matrix (w
, current_matrix
,
18391 first_unchanged_at_end_vpos
+ dvpos
,
18394 if (first_unchanged_at_end_row
)
18396 first_unchanged_at_end_row
+= dvpos
;
18397 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18398 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18399 first_unchanged_at_end_row
= NULL
;
18402 /* If scrolling up, there may be some lines to display at the end of
18404 last_text_row_at_end
= NULL
;
18407 /* Scrolling up can leave for example a partially visible line
18408 at the end of the window to be redisplayed. */
18409 /* Set last_row to the glyph row in the current matrix where the
18410 window end line is found. It has been moved up or down in
18411 the matrix by dvpos. */
18412 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18413 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18415 /* If last_row is the window end line, it should display text. */
18416 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18418 /* If window end line was partially visible before, begin
18419 displaying at that line. Otherwise begin displaying with the
18420 line following it. */
18421 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18423 init_to_row_start (&it
, w
, last_row
);
18424 it
.vpos
= last_vpos
;
18425 it
.current_y
= last_row
->y
;
18429 init_to_row_end (&it
, w
, last_row
);
18430 it
.vpos
= 1 + last_vpos
;
18431 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18435 /* We may start in a continuation line. If so, we have to
18436 get the right continuation_lines_width and current_x. */
18437 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18438 it
.hpos
= it
.current_x
= 0;
18440 /* Display the rest of the lines at the window end. */
18441 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18442 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18444 /* Is it always sure that the display agrees with lines in
18445 the current matrix? I don't think so, so we mark rows
18446 displayed invalid in the current matrix by setting their
18447 enabled_p flag to false. */
18448 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18449 if (display_line (&it
))
18450 last_text_row_at_end
= it
.glyph_row
- 1;
18454 /* Update window_end_pos and window_end_vpos. */
18455 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18457 /* Window end line if one of the preserved rows from the current
18458 matrix. Set row to the last row displaying text in current
18459 matrix starting at first_unchanged_at_end_row, after
18461 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18462 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18463 first_unchanged_at_end_row
);
18464 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18465 adjust_window_ends (w
, row
, true);
18466 eassert (w
->window_end_bytepos
>= 0);
18467 IF_DEBUG (debug_method_add (w
, "A"));
18469 else if (last_text_row_at_end
)
18471 adjust_window_ends (w
, last_text_row_at_end
, false);
18472 eassert (w
->window_end_bytepos
>= 0);
18473 IF_DEBUG (debug_method_add (w
, "B"));
18475 else if (last_text_row
)
18477 /* We have displayed either to the end of the window or at the
18478 end of the window, i.e. the last row with text is to be found
18479 in the desired matrix. */
18480 adjust_window_ends (w
, last_text_row
, false);
18481 eassert (w
->window_end_bytepos
>= 0);
18483 else if (first_unchanged_at_end_row
== NULL
18484 && last_text_row
== NULL
18485 && last_text_row_at_end
== NULL
)
18487 /* Displayed to end of window, but no line containing text was
18488 displayed. Lines were deleted at the end of the window. */
18489 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18490 int vpos
= w
->window_end_vpos
;
18491 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18492 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18495 row
== NULL
&& vpos
>= first_vpos
;
18496 --vpos
, --current_row
, --desired_row
)
18498 if (desired_row
->enabled_p
)
18500 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18503 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18507 eassert (row
!= NULL
);
18508 w
->window_end_vpos
= vpos
+ 1;
18509 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18510 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18511 eassert (w
->window_end_bytepos
>= 0);
18512 IF_DEBUG (debug_method_add (w
, "C"));
18517 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18518 debug_end_vpos
= w
->window_end_vpos
));
18520 /* Record that display has not been completed. */
18521 w
->window_end_valid
= false;
18522 w
->desired_matrix
->no_scrolling_p
= true;
18530 /***********************************************************************
18531 More debugging support
18532 ***********************************************************************/
18536 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18537 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18538 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18541 /* Dump the contents of glyph matrix MATRIX on stderr.
18543 GLYPHS 0 means don't show glyph contents.
18544 GLYPHS 1 means show glyphs in short form
18545 GLYPHS > 1 means show glyphs in long form. */
18548 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18551 for (i
= 0; i
< matrix
->nrows
; ++i
)
18552 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18556 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18557 the glyph row and area where the glyph comes from. */
18560 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18562 if (glyph
->type
== CHAR_GLYPH
18563 || glyph
->type
== GLYPHLESS_GLYPH
)
18566 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18567 glyph
- row
->glyphs
[TEXT_AREA
],
18568 (glyph
->type
== CHAR_GLYPH
18572 (BUFFERP (glyph
->object
)
18574 : (STRINGP (glyph
->object
)
18576 : (NILP (glyph
->object
)
18579 glyph
->pixel_width
,
18581 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18585 glyph
->left_box_line_p
,
18586 glyph
->right_box_line_p
);
18588 else if (glyph
->type
== STRETCH_GLYPH
)
18591 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18592 glyph
- row
->glyphs
[TEXT_AREA
],
18595 (BUFFERP (glyph
->object
)
18597 : (STRINGP (glyph
->object
)
18599 : (NILP (glyph
->object
)
18602 glyph
->pixel_width
,
18606 glyph
->left_box_line_p
,
18607 glyph
->right_box_line_p
);
18609 else if (glyph
->type
== IMAGE_GLYPH
)
18612 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18613 glyph
- row
->glyphs
[TEXT_AREA
],
18616 (BUFFERP (glyph
->object
)
18618 : (STRINGP (glyph
->object
)
18620 : (NILP (glyph
->object
)
18623 glyph
->pixel_width
,
18627 glyph
->left_box_line_p
,
18628 glyph
->right_box_line_p
);
18630 else if (glyph
->type
== COMPOSITE_GLYPH
)
18633 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18634 glyph
- row
->glyphs
[TEXT_AREA
],
18637 (BUFFERP (glyph
->object
)
18639 : (STRINGP (glyph
->object
)
18641 : (NILP (glyph
->object
)
18644 glyph
->pixel_width
,
18646 if (glyph
->u
.cmp
.automatic
)
18649 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18650 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18652 glyph
->left_box_line_p
,
18653 glyph
->right_box_line_p
);
18658 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18659 GLYPHS 0 means don't show glyph contents.
18660 GLYPHS 1 means show glyphs in short form
18661 GLYPHS > 1 means show glyphs in long form. */
18664 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18668 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18669 fprintf (stderr
, "==============================================================================\n");
18671 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18672 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18674 MATRIX_ROW_START_CHARPOS (row
),
18675 MATRIX_ROW_END_CHARPOS (row
),
18676 row
->used
[TEXT_AREA
],
18677 row
->contains_overlapping_glyphs_p
,
18679 row
->truncated_on_left_p
,
18680 row
->truncated_on_right_p
,
18682 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18683 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18686 row
->ends_in_middle_of_char_p
,
18687 row
->starts_in_middle_of_char_p
,
18693 row
->visible_height
,
18696 /* The next 3 lines should align to "Start" in the header. */
18697 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18698 row
->end
.overlay_string_index
,
18699 row
->continuation_lines_width
);
18700 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18701 CHARPOS (row
->start
.string_pos
),
18702 CHARPOS (row
->end
.string_pos
));
18703 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18704 row
->end
.dpvec_index
);
18711 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18713 struct glyph
*glyph
= row
->glyphs
[area
];
18714 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18716 /* Glyph for a line end in text. */
18717 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18720 if (glyph
< glyph_end
)
18721 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18723 for (; glyph
< glyph_end
; ++glyph
)
18724 dump_glyph (row
, glyph
, area
);
18727 else if (glyphs
== 1)
18730 char s
[SHRT_MAX
+ 4];
18732 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18736 for (i
= 0; i
< row
->used
[area
]; ++i
)
18738 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18739 if (i
== row
->used
[area
] - 1
18740 && area
== TEXT_AREA
18741 && NILP (glyph
->object
)
18742 && glyph
->type
== CHAR_GLYPH
18743 && glyph
->u
.ch
== ' ')
18745 strcpy (&s
[i
], "[\\n]");
18748 else if (glyph
->type
== CHAR_GLYPH
18749 && glyph
->u
.ch
< 0x80
18750 && glyph
->u
.ch
>= ' ')
18751 s
[i
] = glyph
->u
.ch
;
18757 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18763 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18764 Sdump_glyph_matrix
, 0, 1, "p",
18765 doc
: /* Dump the current matrix of the selected window to stderr.
18766 Shows contents of glyph row structures. With non-nil
18767 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18768 glyphs in short form, otherwise show glyphs in long form.
18770 Interactively, no argument means show glyphs in short form;
18771 with numeric argument, its value is passed as the GLYPHS flag. */)
18772 (Lisp_Object glyphs
)
18774 struct window
*w
= XWINDOW (selected_window
);
18775 struct buffer
*buffer
= XBUFFER (w
->contents
);
18777 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18778 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18779 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18780 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18781 fprintf (stderr
, "=============================================\n");
18782 dump_glyph_matrix (w
->current_matrix
,
18783 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18788 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18789 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18790 Only text-mode frames have frame glyph matrices. */)
18793 struct frame
*f
= XFRAME (selected_frame
);
18795 if (f
->current_matrix
)
18796 dump_glyph_matrix (f
->current_matrix
, 1);
18798 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18803 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18804 doc
: /* Dump glyph row ROW to stderr.
18805 GLYPH 0 means don't dump glyphs.
18806 GLYPH 1 means dump glyphs in short form.
18807 GLYPH > 1 or omitted means dump glyphs in long form. */)
18808 (Lisp_Object row
, Lisp_Object glyphs
)
18810 struct glyph_matrix
*matrix
;
18813 CHECK_NUMBER (row
);
18814 matrix
= XWINDOW (selected_window
)->current_matrix
;
18816 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18817 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18819 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18824 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18825 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18826 GLYPH 0 means don't dump glyphs.
18827 GLYPH 1 means dump glyphs in short form.
18828 GLYPH > 1 or omitted means dump glyphs in long form.
18830 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18832 (Lisp_Object row
, Lisp_Object glyphs
)
18834 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18835 struct frame
*sf
= SELECTED_FRAME ();
18836 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18839 CHECK_NUMBER (row
);
18841 if (vpos
>= 0 && vpos
< m
->nrows
)
18842 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18843 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18849 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18850 doc
: /* Toggle tracing of redisplay.
18851 With ARG, turn tracing on if and only if ARG is positive. */)
18855 trace_redisplay_p
= !trace_redisplay_p
;
18858 arg
= Fprefix_numeric_value (arg
);
18859 trace_redisplay_p
= XINT (arg
) > 0;
18866 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18867 doc
: /* Like `format', but print result to stderr.
18868 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18869 (ptrdiff_t nargs
, Lisp_Object
*args
)
18871 Lisp_Object s
= Fformat (nargs
, args
);
18872 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18876 #endif /* GLYPH_DEBUG */
18880 /***********************************************************************
18881 Building Desired Matrix Rows
18882 ***********************************************************************/
18884 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18885 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18887 static struct glyph_row
*
18888 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18890 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18891 struct buffer
*buffer
= XBUFFER (w
->contents
);
18892 struct buffer
*old
= current_buffer
;
18893 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18894 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18895 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18896 const unsigned char *p
;
18899 int n_glyphs_before
;
18901 set_buffer_temp (buffer
);
18902 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18903 scratch_glyph_row
.reversed_p
= false;
18904 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18905 SET_TEXT_POS (it
.position
, 0, 0);
18907 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18909 while (p
< arrow_end
)
18911 Lisp_Object face
, ilisp
;
18913 /* Get the next character. */
18915 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18918 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18919 if (! ASCII_CHAR_P (it
.c
))
18920 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18924 /* Get its face. */
18925 ilisp
= make_number (p
- arrow_string
);
18926 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18927 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18929 /* Compute its width, get its glyphs. */
18930 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18931 SET_TEXT_POS (it
.position
, -1, -1);
18932 PRODUCE_GLYPHS (&it
);
18934 /* If this character doesn't fit any more in the line, we have
18935 to remove some glyphs. */
18936 if (it
.current_x
> it
.last_visible_x
)
18938 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18943 set_buffer_temp (old
);
18944 return it
.glyph_row
;
18948 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18949 glyphs to insert is determined by produce_special_glyphs. */
18952 insert_left_trunc_glyphs (struct it
*it
)
18954 struct it truncate_it
;
18955 struct glyph
*from
, *end
, *to
, *toend
;
18957 eassert (!FRAME_WINDOW_P (it
->f
)
18958 || (!it
->glyph_row
->reversed_p
18959 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18960 || (it
->glyph_row
->reversed_p
18961 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18963 /* Get the truncation glyphs. */
18965 truncate_it
.current_x
= 0;
18966 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18967 truncate_it
.glyph_row
= &scratch_glyph_row
;
18968 truncate_it
.area
= TEXT_AREA
;
18969 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18970 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18971 truncate_it
.object
= Qnil
;
18972 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18974 /* Overwrite glyphs from IT with truncation glyphs. */
18975 if (!it
->glyph_row
->reversed_p
)
18977 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18979 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18980 end
= from
+ tused
;
18981 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18982 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18983 if (FRAME_WINDOW_P (it
->f
))
18985 /* On GUI frames, when variable-size fonts are displayed,
18986 the truncation glyphs may need more pixels than the row's
18987 glyphs they overwrite. We overwrite more glyphs to free
18988 enough screen real estate, and enlarge the stretch glyph
18989 on the right (see display_line), if there is one, to
18990 preserve the screen position of the truncation glyphs on
18993 struct glyph
*g
= to
;
18996 /* The first glyph could be partially visible, in which case
18997 it->glyph_row->x will be negative. But we want the left
18998 truncation glyphs to be aligned at the left margin of the
18999 window, so we override the x coordinate at which the row
19001 it
->glyph_row
->x
= 0;
19002 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19004 w
+= g
->pixel_width
;
19007 if (g
- to
- tused
> 0)
19009 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19010 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19012 used
= it
->glyph_row
->used
[TEXT_AREA
];
19013 if (it
->glyph_row
->truncated_on_right_p
19014 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19015 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19018 int extra
= w
- it
->truncation_pixel_width
;
19020 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19027 /* There may be padding glyphs left over. Overwrite them too. */
19028 if (!FRAME_WINDOW_P (it
->f
))
19030 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19032 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19039 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19043 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19045 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19046 that back to front. */
19047 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19048 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19049 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19050 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19051 if (FRAME_WINDOW_P (it
->f
))
19054 struct glyph
*g
= to
;
19056 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19058 w
+= g
->pixel_width
;
19061 if (to
- g
- tused
> 0)
19063 if (it
->glyph_row
->truncated_on_right_p
19064 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19065 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19067 int extra
= w
- it
->truncation_pixel_width
;
19069 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19073 while (from
>= end
&& to
>= toend
)
19075 if (!FRAME_WINDOW_P (it
->f
))
19077 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19080 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19081 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19082 while (from
>= end
&& to
>= toend
)
19088 /* Need to free some room before prepending additional
19090 int move_by
= from
- end
+ 1;
19091 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19092 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19094 for ( ; g
>= g0
; g
--)
19096 while (from
>= end
)
19098 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19103 /* Compute the hash code for ROW. */
19105 row_hash (struct glyph_row
*row
)
19108 unsigned hashval
= 0;
19110 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19111 for (k
= 0; k
< row
->used
[area
]; ++k
)
19112 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19113 + row
->glyphs
[area
][k
].u
.val
19114 + row
->glyphs
[area
][k
].face_id
19115 + row
->glyphs
[area
][k
].padding_p
19116 + (row
->glyphs
[area
][k
].type
<< 2));
19121 /* Compute the pixel height and width of IT->glyph_row.
19123 Most of the time, ascent and height of a display line will be equal
19124 to the max_ascent and max_height values of the display iterator
19125 structure. This is not the case if
19127 1. We hit ZV without displaying anything. In this case, max_ascent
19128 and max_height will be zero.
19130 2. We have some glyphs that don't contribute to the line height.
19131 (The glyph row flag contributes_to_line_height_p is for future
19132 pixmap extensions).
19134 The first case is easily covered by using default values because in
19135 these cases, the line height does not really matter, except that it
19136 must not be zero. */
19139 compute_line_metrics (struct it
*it
)
19141 struct glyph_row
*row
= it
->glyph_row
;
19143 if (FRAME_WINDOW_P (it
->f
))
19145 int i
, min_y
, max_y
;
19147 /* The line may consist of one space only, that was added to
19148 place the cursor on it. If so, the row's height hasn't been
19150 if (row
->height
== 0)
19152 if (it
->max_ascent
+ it
->max_descent
== 0)
19153 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19154 row
->ascent
= it
->max_ascent
;
19155 row
->height
= it
->max_ascent
+ it
->max_descent
;
19156 row
->phys_ascent
= it
->max_phys_ascent
;
19157 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19158 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19161 /* Compute the width of this line. */
19162 row
->pixel_width
= row
->x
;
19163 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19164 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19166 eassert (row
->pixel_width
>= 0);
19167 eassert (row
->ascent
>= 0 && row
->height
> 0);
19169 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19170 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19172 /* If first line's physical ascent is larger than its logical
19173 ascent, use the physical ascent, and make the row taller.
19174 This makes accented characters fully visible. */
19175 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19176 && row
->phys_ascent
> row
->ascent
)
19178 row
->height
+= row
->phys_ascent
- row
->ascent
;
19179 row
->ascent
= row
->phys_ascent
;
19182 /* Compute how much of the line is visible. */
19183 row
->visible_height
= row
->height
;
19185 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19186 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19188 if (row
->y
< min_y
)
19189 row
->visible_height
-= min_y
- row
->y
;
19190 if (row
->y
+ row
->height
> max_y
)
19191 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19195 row
->pixel_width
= row
->used
[TEXT_AREA
];
19196 if (row
->continued_p
)
19197 row
->pixel_width
-= it
->continuation_pixel_width
;
19198 else if (row
->truncated_on_right_p
)
19199 row
->pixel_width
-= it
->truncation_pixel_width
;
19200 row
->ascent
= row
->phys_ascent
= 0;
19201 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19202 row
->extra_line_spacing
= 0;
19205 /* Compute a hash code for this row. */
19206 row
->hash
= row_hash (row
);
19208 it
->max_ascent
= it
->max_descent
= 0;
19209 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19213 /* Append one space to the glyph row of iterator IT if doing a
19214 window-based redisplay. The space has the same face as
19215 IT->face_id. Value is true if a space was added.
19217 This function is called to make sure that there is always one glyph
19218 at the end of a glyph row that the cursor can be set on under
19219 window-systems. (If there weren't such a glyph we would not know
19220 how wide and tall a box cursor should be displayed).
19222 At the same time this space let's a nicely handle clearing to the
19223 end of the line if the row ends in italic text. */
19226 append_space_for_newline (struct it
*it
, bool default_face_p
)
19228 if (FRAME_WINDOW_P (it
->f
))
19230 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19232 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19233 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19235 /* Save some values that must not be changed.
19236 Must save IT->c and IT->len because otherwise
19237 ITERATOR_AT_END_P wouldn't work anymore after
19238 append_space_for_newline has been called. */
19239 enum display_element_type saved_what
= it
->what
;
19240 int saved_c
= it
->c
, saved_len
= it
->len
;
19241 int saved_char_to_display
= it
->char_to_display
;
19242 int saved_x
= it
->current_x
;
19243 int saved_face_id
= it
->face_id
;
19244 bool saved_box_end
= it
->end_of_box_run_p
;
19245 struct text_pos saved_pos
;
19246 Lisp_Object saved_object
;
19250 saved_object
= it
->object
;
19251 saved_pos
= it
->position
;
19253 it
->what
= IT_CHARACTER
;
19254 memset (&it
->position
, 0, sizeof it
->position
);
19256 it
->c
= it
->char_to_display
= ' ';
19259 /* If the default face was remapped, be sure to use the
19260 remapped face for the appended newline. */
19261 if (default_face_p
)
19262 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19263 else if (it
->face_before_selective_p
)
19264 it
->face_id
= it
->saved_face_id
;
19265 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19266 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19267 /* In R2L rows, we will prepend a stretch glyph that will
19268 have the end_of_box_run_p flag set for it, so there's no
19269 need for the appended newline glyph to have that flag
19271 if (it
->glyph_row
->reversed_p
19272 /* But if the appended newline glyph goes all the way to
19273 the end of the row, there will be no stretch glyph,
19274 so leave the box flag set. */
19275 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19276 it
->end_of_box_run_p
= false;
19278 PRODUCE_GLYPHS (it
);
19280 #ifdef HAVE_WINDOW_SYSTEM
19281 /* Make sure this space glyph has the right ascent and
19282 descent values, or else cursor at end of line will look
19283 funny, and height of empty lines will be incorrect. */
19284 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19285 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19288 Lisp_Object height
, total_height
;
19289 int extra_line_spacing
= it
->extra_line_spacing
;
19290 int boff
= font
->baseline_offset
;
19292 if (font
->vertical_centering
)
19293 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19295 it
->object
= saved_object
; /* get_it_property needs this */
19296 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19297 /* Must do a subset of line height processing from
19298 x_produce_glyph for newline characters. */
19299 height
= get_it_property (it
, Qline_height
);
19301 && CONSP (XCDR (height
))
19302 && NILP (XCDR (XCDR (height
))))
19304 total_height
= XCAR (XCDR (height
));
19305 height
= XCAR (height
);
19308 total_height
= Qnil
;
19309 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19311 if (it
->override_ascent
>= 0)
19313 it
->ascent
= it
->override_ascent
;
19314 it
->descent
= it
->override_descent
;
19315 boff
= it
->override_boff
;
19317 if (EQ (height
, Qt
))
19318 extra_line_spacing
= 0;
19321 Lisp_Object spacing
;
19323 it
->phys_ascent
= it
->ascent
;
19324 it
->phys_descent
= it
->descent
;
19326 && XINT (height
) > it
->ascent
+ it
->descent
)
19327 it
->ascent
= XINT (height
) - it
->descent
;
19329 if (!NILP (total_height
))
19330 spacing
= calc_line_height_property (it
, total_height
, font
,
19334 spacing
= get_it_property (it
, Qline_spacing
);
19335 spacing
= calc_line_height_property (it
, spacing
, font
,
19338 if (INTEGERP (spacing
))
19340 extra_line_spacing
= XINT (spacing
);
19341 if (!NILP (total_height
))
19342 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19345 if (extra_line_spacing
> 0)
19347 it
->descent
+= extra_line_spacing
;
19348 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19349 it
->max_extra_line_spacing
= extra_line_spacing
;
19351 it
->max_ascent
= it
->ascent
;
19352 it
->max_descent
= it
->descent
;
19353 /* Make sure compute_line_metrics recomputes the row height. */
19354 it
->glyph_row
->height
= 0;
19357 g
->ascent
= it
->max_ascent
;
19358 g
->descent
= it
->max_descent
;
19361 it
->override_ascent
= -1;
19362 it
->constrain_row_ascent_descent_p
= false;
19363 it
->current_x
= saved_x
;
19364 it
->object
= saved_object
;
19365 it
->position
= saved_pos
;
19366 it
->what
= saved_what
;
19367 it
->face_id
= saved_face_id
;
19368 it
->len
= saved_len
;
19370 it
->char_to_display
= saved_char_to_display
;
19371 it
->end_of_box_run_p
= saved_box_end
;
19380 /* Extend the face of the last glyph in the text area of IT->glyph_row
19381 to the end of the display line. Called from display_line. If the
19382 glyph row is empty, add a space glyph to it so that we know the
19383 face to draw. Set the glyph row flag fill_line_p. If the glyph
19384 row is R2L, prepend a stretch glyph to cover the empty space to the
19385 left of the leftmost glyph. */
19388 extend_face_to_end_of_line (struct it
*it
)
19390 struct face
*face
, *default_face
;
19391 struct frame
*f
= it
->f
;
19393 /* If line is already filled, do nothing. Non window-system frames
19394 get a grace of one more ``pixel'' because their characters are
19395 1-``pixel'' wide, so they hit the equality too early. This grace
19396 is needed only for R2L rows that are not continued, to produce
19397 one extra blank where we could display the cursor. */
19398 if ((it
->current_x
>= it
->last_visible_x
19399 + (!FRAME_WINDOW_P (f
)
19400 && it
->glyph_row
->reversed_p
19401 && !it
->glyph_row
->continued_p
))
19402 /* If the window has display margins, we will need to extend
19403 their face even if the text area is filled. */
19404 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19405 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19408 /* The default face, possibly remapped. */
19409 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19411 /* Face extension extends the background and box of IT->face_id
19412 to the end of the line. If the background equals the background
19413 of the frame, we don't have to do anything. */
19414 if (it
->face_before_selective_p
)
19415 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19417 face
= FACE_FROM_ID (f
, it
->face_id
);
19419 if (FRAME_WINDOW_P (f
)
19420 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19421 && face
->box
== FACE_NO_BOX
19422 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19423 #ifdef HAVE_WINDOW_SYSTEM
19426 && !it
->glyph_row
->reversed_p
)
19429 /* Set the glyph row flag indicating that the face of the last glyph
19430 in the text area has to be drawn to the end of the text area. */
19431 it
->glyph_row
->fill_line_p
= true;
19433 /* If current character of IT is not ASCII, make sure we have the
19434 ASCII face. This will be automatically undone the next time
19435 get_next_display_element returns a multibyte character. Note
19436 that the character will always be single byte in unibyte
19438 if (!ASCII_CHAR_P (it
->c
))
19440 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19443 if (FRAME_WINDOW_P (f
))
19445 /* If the row is empty, add a space with the current face of IT,
19446 so that we know which face to draw. */
19447 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19449 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19450 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19451 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19453 /* Mode line and the header line don't have margins, and
19454 likewise the frame's tool-bar window, if there is any. */
19455 if (!(it
->glyph_row
->mode_line_p
19456 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19457 || (WINDOWP (f
->tool_bar_window
)
19458 && it
->w
== XWINDOW (f
->tool_bar_window
))
19462 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19463 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19465 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19466 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19468 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19470 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19471 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19473 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19474 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19476 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19479 #ifdef HAVE_WINDOW_SYSTEM
19480 if (it
->glyph_row
->reversed_p
)
19482 /* Prepend a stretch glyph to the row, such that the
19483 rightmost glyph will be drawn flushed all the way to the
19484 right margin of the window. The stretch glyph that will
19485 occupy the empty space, if any, to the left of the
19487 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19488 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19489 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19491 int row_width
, stretch_ascent
, stretch_width
;
19492 struct text_pos saved_pos
;
19494 bool saved_avoid_cursor
, saved_box_start
;
19496 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19497 row_width
+= g
->pixel_width
;
19499 /* FIXME: There are various minor display glitches in R2L
19500 rows when only one of the fringes is missing. The
19501 strange condition below produces the least bad effect. */
19502 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19503 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19504 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19505 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19507 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19508 stretch_width
-= row_width
;
19510 if (stretch_width
> 0)
19513 (((it
->ascent
+ it
->descent
)
19514 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19515 saved_pos
= it
->position
;
19516 memset (&it
->position
, 0, sizeof it
->position
);
19517 saved_avoid_cursor
= it
->avoid_cursor_p
;
19518 it
->avoid_cursor_p
= true;
19519 saved_face_id
= it
->face_id
;
19520 saved_box_start
= it
->start_of_box_run_p
;
19521 /* The last row's stretch glyph should get the default
19522 face, to avoid painting the rest of the window with
19523 the region face, if the region ends at ZV. */
19524 if (it
->glyph_row
->ends_at_zv_p
)
19525 it
->face_id
= default_face
->id
;
19527 it
->face_id
= face
->id
;
19528 it
->start_of_box_run_p
= false;
19529 append_stretch_glyph (it
, Qnil
, stretch_width
,
19530 it
->ascent
+ it
->descent
, stretch_ascent
);
19531 it
->position
= saved_pos
;
19532 it
->avoid_cursor_p
= saved_avoid_cursor
;
19533 it
->face_id
= saved_face_id
;
19534 it
->start_of_box_run_p
= saved_box_start
;
19536 /* If stretch_width comes out negative, it means that the
19537 last glyph is only partially visible. In R2L rows, we
19538 want the leftmost glyph to be partially visible, so we
19539 need to give the row the corresponding left offset. */
19540 if (stretch_width
< 0)
19541 it
->glyph_row
->x
= stretch_width
;
19543 #endif /* HAVE_WINDOW_SYSTEM */
19547 /* Save some values that must not be changed. */
19548 int saved_x
= it
->current_x
;
19549 struct text_pos saved_pos
;
19550 Lisp_Object saved_object
;
19551 enum display_element_type saved_what
= it
->what
;
19552 int saved_face_id
= it
->face_id
;
19554 saved_object
= it
->object
;
19555 saved_pos
= it
->position
;
19557 it
->what
= IT_CHARACTER
;
19558 memset (&it
->position
, 0, sizeof it
->position
);
19560 it
->c
= it
->char_to_display
= ' ';
19563 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19564 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19565 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19566 && !it
->glyph_row
->mode_line_p
19567 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19569 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19570 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19572 for (it
->current_x
= 0; g
< e
; g
++)
19573 it
->current_x
+= g
->pixel_width
;
19575 it
->area
= LEFT_MARGIN_AREA
;
19576 it
->face_id
= default_face
->id
;
19577 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19578 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19580 PRODUCE_GLYPHS (it
);
19581 /* term.c:produce_glyphs advances it->current_x only for
19583 it
->current_x
+= it
->pixel_width
;
19586 it
->current_x
= saved_x
;
19587 it
->area
= TEXT_AREA
;
19590 /* The last row's blank glyphs should get the default face, to
19591 avoid painting the rest of the window with the region face,
19592 if the region ends at ZV. */
19593 if (it
->glyph_row
->ends_at_zv_p
)
19594 it
->face_id
= default_face
->id
;
19596 it
->face_id
= face
->id
;
19597 PRODUCE_GLYPHS (it
);
19599 while (it
->current_x
<= it
->last_visible_x
)
19600 PRODUCE_GLYPHS (it
);
19602 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19603 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19604 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19605 && !it
->glyph_row
->mode_line_p
19606 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19608 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19609 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19611 for ( ; g
< e
; g
++)
19612 it
->current_x
+= g
->pixel_width
;
19614 it
->area
= RIGHT_MARGIN_AREA
;
19615 it
->face_id
= default_face
->id
;
19616 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19617 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19619 PRODUCE_GLYPHS (it
);
19620 it
->current_x
+= it
->pixel_width
;
19623 it
->area
= TEXT_AREA
;
19626 /* Don't count these blanks really. It would let us insert a left
19627 truncation glyph below and make us set the cursor on them, maybe. */
19628 it
->current_x
= saved_x
;
19629 it
->object
= saved_object
;
19630 it
->position
= saved_pos
;
19631 it
->what
= saved_what
;
19632 it
->face_id
= saved_face_id
;
19637 /* Value is true if text starting at CHARPOS in current_buffer is
19638 trailing whitespace. */
19641 trailing_whitespace_p (ptrdiff_t charpos
)
19643 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19646 while (bytepos
< ZV_BYTE
19647 && (c
= FETCH_CHAR (bytepos
),
19648 c
== ' ' || c
== '\t'))
19651 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19653 if (bytepos
!= PT_BYTE
)
19660 /* Highlight trailing whitespace, if any, in ROW. */
19663 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19665 int used
= row
->used
[TEXT_AREA
];
19669 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19670 struct glyph
*glyph
= start
+ used
- 1;
19672 if (row
->reversed_p
)
19674 /* Right-to-left rows need to be processed in the opposite
19675 direction, so swap the edge pointers. */
19677 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19680 /* Skip over glyphs inserted to display the cursor at the
19681 end of a line, for extending the face of the last glyph
19682 to the end of the line on terminals, and for truncation
19683 and continuation glyphs. */
19684 if (!row
->reversed_p
)
19686 while (glyph
>= start
19687 && glyph
->type
== CHAR_GLYPH
19688 && NILP (glyph
->object
))
19693 while (glyph
<= start
19694 && glyph
->type
== CHAR_GLYPH
19695 && NILP (glyph
->object
))
19699 /* If last glyph is a space or stretch, and it's trailing
19700 whitespace, set the face of all trailing whitespace glyphs in
19701 IT->glyph_row to `trailing-whitespace'. */
19702 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19703 && BUFFERP (glyph
->object
)
19704 && (glyph
->type
== STRETCH_GLYPH
19705 || (glyph
->type
== CHAR_GLYPH
19706 && glyph
->u
.ch
== ' '))
19707 && trailing_whitespace_p (glyph
->charpos
))
19709 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19713 if (!row
->reversed_p
)
19715 while (glyph
>= start
19716 && BUFFERP (glyph
->object
)
19717 && (glyph
->type
== STRETCH_GLYPH
19718 || (glyph
->type
== CHAR_GLYPH
19719 && glyph
->u
.ch
== ' ')))
19720 (glyph
--)->face_id
= face_id
;
19724 while (glyph
<= start
19725 && BUFFERP (glyph
->object
)
19726 && (glyph
->type
== STRETCH_GLYPH
19727 || (glyph
->type
== CHAR_GLYPH
19728 && glyph
->u
.ch
== ' ')))
19729 (glyph
++)->face_id
= face_id
;
19736 /* Value is true if glyph row ROW should be
19737 considered to hold the buffer position CHARPOS. */
19740 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19742 bool result
= true;
19744 if (charpos
== CHARPOS (row
->end
.pos
)
19745 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19747 /* Suppose the row ends on a string.
19748 Unless the row is continued, that means it ends on a newline
19749 in the string. If it's anything other than a display string
19750 (e.g., a before-string from an overlay), we don't want the
19751 cursor there. (This heuristic seems to give the optimal
19752 behavior for the various types of multi-line strings.)
19753 One exception: if the string has `cursor' property on one of
19754 its characters, we _do_ want the cursor there. */
19755 if (CHARPOS (row
->end
.string_pos
) >= 0)
19757 if (row
->continued_p
)
19761 /* Check for `display' property. */
19762 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19763 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19764 struct glyph
*glyph
;
19767 for (glyph
= end
; glyph
>= beg
; --glyph
)
19768 if (STRINGP (glyph
->object
))
19771 = Fget_char_property (make_number (charpos
),
19775 && display_prop_string_p (prop
, glyph
->object
));
19776 /* If there's a `cursor' property on one of the
19777 string's characters, this row is a cursor row,
19778 even though this is not a display string. */
19781 Lisp_Object s
= glyph
->object
;
19783 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19785 ptrdiff_t gpos
= glyph
->charpos
;
19787 if (!NILP (Fget_char_property (make_number (gpos
),
19799 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19801 /* If the row ends in middle of a real character,
19802 and the line is continued, we want the cursor here.
19803 That's because CHARPOS (ROW->end.pos) would equal
19804 PT if PT is before the character. */
19805 if (!row
->ends_in_ellipsis_p
)
19806 result
= row
->continued_p
;
19808 /* If the row ends in an ellipsis, then
19809 CHARPOS (ROW->end.pos) will equal point after the
19810 invisible text. We want that position to be displayed
19811 after the ellipsis. */
19814 /* If the row ends at ZV, display the cursor at the end of that
19815 row instead of at the start of the row below. */
19817 result
= row
->ends_at_zv_p
;
19823 /* Value is true if glyph row ROW should be
19824 used to hold the cursor. */
19827 cursor_row_p (struct glyph_row
*row
)
19829 return row_for_charpos_p (row
, PT
);
19834 /* Push the property PROP so that it will be rendered at the current
19835 position in IT. Return true if PROP was successfully pushed, false
19836 otherwise. Called from handle_line_prefix to handle the
19837 `line-prefix' and `wrap-prefix' properties. */
19840 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19842 struct text_pos pos
=
19843 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19845 eassert (it
->method
== GET_FROM_BUFFER
19846 || it
->method
== GET_FROM_DISPLAY_VECTOR
19847 || it
->method
== GET_FROM_STRING
19848 || it
->method
== GET_FROM_IMAGE
);
19850 /* We need to save the current buffer/string position, so it will be
19851 restored by pop_it, because iterate_out_of_display_property
19852 depends on that being set correctly, but some situations leave
19853 it->position not yet set when this function is called. */
19854 push_it (it
, &pos
);
19856 if (STRINGP (prop
))
19858 if (SCHARS (prop
) == 0)
19865 it
->string_from_prefix_prop_p
= true;
19866 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19867 it
->current
.overlay_string_index
= -1;
19868 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19869 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19870 it
->method
= GET_FROM_STRING
;
19871 it
->stop_charpos
= 0;
19873 it
->base_level_stop
= 0;
19875 /* Force paragraph direction to be that of the parent
19877 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19878 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19880 it
->paragraph_embedding
= L2R
;
19882 /* Set up the bidi iterator for this display string. */
19885 it
->bidi_it
.string
.lstring
= it
->string
;
19886 it
->bidi_it
.string
.s
= NULL
;
19887 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19888 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19889 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19890 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19891 it
->bidi_it
.w
= it
->w
;
19892 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19895 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19897 it
->method
= GET_FROM_STRETCH
;
19900 #ifdef HAVE_WINDOW_SYSTEM
19901 else if (IMAGEP (prop
))
19903 it
->what
= IT_IMAGE
;
19904 it
->image_id
= lookup_image (it
->f
, prop
);
19905 it
->method
= GET_FROM_IMAGE
;
19907 #endif /* HAVE_WINDOW_SYSTEM */
19910 pop_it (it
); /* bogus display property, give up */
19917 /* Return the character-property PROP at the current position in IT. */
19920 get_it_property (struct it
*it
, Lisp_Object prop
)
19922 Lisp_Object position
, object
= it
->object
;
19924 if (STRINGP (object
))
19925 position
= make_number (IT_STRING_CHARPOS (*it
));
19926 else if (BUFFERP (object
))
19928 position
= make_number (IT_CHARPOS (*it
));
19929 object
= it
->window
;
19934 return Fget_char_property (position
, prop
, object
);
19937 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19940 handle_line_prefix (struct it
*it
)
19942 Lisp_Object prefix
;
19944 if (it
->continuation_lines_width
> 0)
19946 prefix
= get_it_property (it
, Qwrap_prefix
);
19948 prefix
= Vwrap_prefix
;
19952 prefix
= get_it_property (it
, Qline_prefix
);
19954 prefix
= Vline_prefix
;
19956 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19958 /* If the prefix is wider than the window, and we try to wrap
19959 it, it would acquire its own wrap prefix, and so on till the
19960 iterator stack overflows. So, don't wrap the prefix. */
19961 it
->line_wrap
= TRUNCATE
;
19962 it
->avoid_cursor_p
= true;
19968 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19969 only for R2L lines from display_line and display_string, when they
19970 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19971 the line/string needs to be continued on the next glyph row. */
19973 unproduce_glyphs (struct it
*it
, int n
)
19975 struct glyph
*glyph
, *end
;
19977 eassert (it
->glyph_row
);
19978 eassert (it
->glyph_row
->reversed_p
);
19979 eassert (it
->area
== TEXT_AREA
);
19980 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19982 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19983 n
= it
->glyph_row
->used
[TEXT_AREA
];
19984 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19985 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19986 for ( ; glyph
< end
; glyph
++)
19987 glyph
[-n
] = *glyph
;
19990 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19991 and ROW->maxpos. */
19993 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19994 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19995 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19997 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19998 lines' rows is implemented for bidi-reordered rows. */
20000 /* ROW->minpos is the value of min_pos, the minimal buffer position
20001 we have in ROW, or ROW->start.pos if that is smaller. */
20002 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20003 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20005 /* We didn't find buffer positions smaller than ROW->start, or
20006 didn't find _any_ valid buffer positions in any of the glyphs,
20007 so we must trust the iterator's computed positions. */
20008 row
->minpos
= row
->start
.pos
;
20011 max_pos
= CHARPOS (it
->current
.pos
);
20012 max_bpos
= BYTEPOS (it
->current
.pos
);
20015 /* Here are the various use-cases for ending the row, and the
20016 corresponding values for ROW->maxpos:
20018 Line ends in a newline from buffer eol_pos + 1
20019 Line is continued from buffer max_pos + 1
20020 Line is truncated on right it->current.pos
20021 Line ends in a newline from string max_pos + 1(*)
20022 (*) + 1 only when line ends in a forward scan
20023 Line is continued from string max_pos
20024 Line is continued from display vector max_pos
20025 Line is entirely from a string min_pos == max_pos
20026 Line is entirely from a display vector min_pos == max_pos
20027 Line that ends at ZV ZV
20029 If you discover other use-cases, please add them here as
20031 if (row
->ends_at_zv_p
)
20032 row
->maxpos
= it
->current
.pos
;
20033 else if (row
->used
[TEXT_AREA
])
20035 bool seen_this_string
= false;
20036 struct glyph_row
*r1
= row
- 1;
20038 /* Did we see the same display string on the previous row? */
20039 if (STRINGP (it
->object
)
20040 /* this is not the first row */
20041 && row
> it
->w
->desired_matrix
->rows
20042 /* previous row is not the header line */
20043 && !r1
->mode_line_p
20044 /* previous row also ends in a newline from a string */
20045 && r1
->ends_in_newline_from_string_p
)
20047 struct glyph
*start
, *end
;
20049 /* Search for the last glyph of the previous row that came
20050 from buffer or string. Depending on whether the row is
20051 L2R or R2L, we need to process it front to back or the
20052 other way round. */
20053 if (!r1
->reversed_p
)
20055 start
= r1
->glyphs
[TEXT_AREA
];
20056 end
= start
+ r1
->used
[TEXT_AREA
];
20057 /* Glyphs inserted by redisplay have nil as their object. */
20059 && NILP ((end
- 1)->object
)
20060 && (end
- 1)->charpos
<= 0)
20064 if (EQ ((end
- 1)->object
, it
->object
))
20065 seen_this_string
= true;
20068 /* If all the glyphs of the previous row were inserted
20069 by redisplay, it means the previous row was
20070 produced from a single newline, which is only
20071 possible if that newline came from the same string
20072 as the one which produced this ROW. */
20073 seen_this_string
= true;
20077 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20078 start
= end
+ r1
->used
[TEXT_AREA
];
20080 && NILP ((end
+ 1)->object
)
20081 && (end
+ 1)->charpos
<= 0)
20085 if (EQ ((end
+ 1)->object
, it
->object
))
20086 seen_this_string
= true;
20089 seen_this_string
= true;
20092 /* Take note of each display string that covers a newline only
20093 once, the first time we see it. This is for when a display
20094 string includes more than one newline in it. */
20095 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20097 /* If we were scanning the buffer forward when we displayed
20098 the string, we want to account for at least one buffer
20099 position that belongs to this row (position covered by
20100 the display string), so that cursor positioning will
20101 consider this row as a candidate when point is at the end
20102 of the visual line represented by this row. This is not
20103 required when scanning back, because max_pos will already
20104 have a much larger value. */
20105 if (CHARPOS (row
->end
.pos
) > max_pos
)
20106 INC_BOTH (max_pos
, max_bpos
);
20107 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20109 else if (CHARPOS (it
->eol_pos
) > 0)
20110 SET_TEXT_POS (row
->maxpos
,
20111 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20112 else if (row
->continued_p
)
20114 /* If max_pos is different from IT's current position, it
20115 means IT->method does not belong to the display element
20116 at max_pos. However, it also means that the display
20117 element at max_pos was displayed in its entirety on this
20118 line, which is equivalent to saying that the next line
20119 starts at the next buffer position. */
20120 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20121 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20124 INC_BOTH (max_pos
, max_bpos
);
20125 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20128 else if (row
->truncated_on_right_p
)
20129 /* display_line already called reseat_at_next_visible_line_start,
20130 which puts the iterator at the beginning of the next line, in
20131 the logical order. */
20132 row
->maxpos
= it
->current
.pos
;
20133 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20134 /* A line that is entirely from a string/image/stretch... */
20135 row
->maxpos
= row
->minpos
;
20140 row
->maxpos
= it
->current
.pos
;
20143 /* Construct the glyph row IT->glyph_row in the desired matrix of
20144 IT->w from text at the current position of IT. See dispextern.h
20145 for an overview of struct it. Value is true if
20146 IT->glyph_row displays text, as opposed to a line displaying ZV
20150 display_line (struct it
*it
)
20152 struct glyph_row
*row
= it
->glyph_row
;
20153 Lisp_Object overlay_arrow_string
;
20155 void *wrap_data
= NULL
;
20156 bool may_wrap
= false;
20157 int wrap_x
IF_LINT (= 0);
20158 int wrap_row_used
= -1;
20159 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20160 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20161 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20162 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20163 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20165 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20166 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20167 bool pending_handle_line_prefix
= false;
20169 /* We always start displaying at hpos zero even if hscrolled. */
20170 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20172 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20173 >= it
->w
->desired_matrix
->nrows
)
20175 it
->w
->nrows_scale_factor
++;
20176 it
->f
->fonts_changed
= true;
20180 /* Clear the result glyph row and enable it. */
20181 prepare_desired_row (it
->w
, row
, false);
20183 row
->y
= it
->current_y
;
20184 row
->start
= it
->start
;
20185 row
->continuation_lines_width
= it
->continuation_lines_width
;
20186 row
->displays_text_p
= true;
20187 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20188 it
->starts_in_middle_of_char_p
= false;
20190 /* Arrange the overlays nicely for our purposes. Usually, we call
20191 display_line on only one line at a time, in which case this
20192 can't really hurt too much, or we call it on lines which appear
20193 one after another in the buffer, in which case all calls to
20194 recenter_overlay_lists but the first will be pretty cheap. */
20195 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20197 /* Move over display elements that are not visible because we are
20198 hscrolled. This may stop at an x-position < IT->first_visible_x
20199 if the first glyph is partially visible or if we hit a line end. */
20200 if (it
->current_x
< it
->first_visible_x
)
20202 enum move_it_result move_result
;
20204 this_line_min_pos
= row
->start
.pos
;
20205 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20206 MOVE_TO_POS
| MOVE_TO_X
);
20207 /* If we are under a large hscroll, move_it_in_display_line_to
20208 could hit the end of the line without reaching
20209 it->first_visible_x. Pretend that we did reach it. This is
20210 especially important on a TTY, where we will call
20211 extend_face_to_end_of_line, which needs to know how many
20212 blank glyphs to produce. */
20213 if (it
->current_x
< it
->first_visible_x
20214 && (move_result
== MOVE_NEWLINE_OR_CR
20215 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20216 it
->current_x
= it
->first_visible_x
;
20218 /* Record the smallest positions seen while we moved over
20219 display elements that are not visible. This is needed by
20220 redisplay_internal for optimizing the case where the cursor
20221 stays inside the same line. The rest of this function only
20222 considers positions that are actually displayed, so
20223 RECORD_MAX_MIN_POS will not otherwise record positions that
20224 are hscrolled to the left of the left edge of the window. */
20225 min_pos
= CHARPOS (this_line_min_pos
);
20226 min_bpos
= BYTEPOS (this_line_min_pos
);
20228 else if (it
->area
== TEXT_AREA
)
20230 /* We only do this when not calling move_it_in_display_line_to
20231 above, because that function calls itself handle_line_prefix. */
20232 handle_line_prefix (it
);
20236 /* Line-prefix and wrap-prefix are always displayed in the text
20237 area. But if this is the first call to display_line after
20238 init_iterator, the iterator might have been set up to write
20239 into a marginal area, e.g. if the line begins with some
20240 display property that writes to the margins. So we need to
20241 wait with the call to handle_line_prefix until whatever
20242 writes to the margin has done its job. */
20243 pending_handle_line_prefix
= true;
20246 /* Get the initial row height. This is either the height of the
20247 text hscrolled, if there is any, or zero. */
20248 row
->ascent
= it
->max_ascent
;
20249 row
->height
= it
->max_ascent
+ it
->max_descent
;
20250 row
->phys_ascent
= it
->max_phys_ascent
;
20251 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20252 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20254 /* Utility macro to record max and min buffer positions seen until now. */
20255 #define RECORD_MAX_MIN_POS(IT) \
20258 bool composition_p \
20259 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20260 ptrdiff_t current_pos = \
20261 composition_p ? (IT)->cmp_it.charpos \
20262 : IT_CHARPOS (*(IT)); \
20263 ptrdiff_t current_bpos = \
20264 composition_p ? CHAR_TO_BYTE (current_pos) \
20265 : IT_BYTEPOS (*(IT)); \
20266 if (current_pos < min_pos) \
20268 min_pos = current_pos; \
20269 min_bpos = current_bpos; \
20271 if (IT_CHARPOS (*it) > max_pos) \
20273 max_pos = IT_CHARPOS (*it); \
20274 max_bpos = IT_BYTEPOS (*it); \
20279 /* Loop generating characters. The loop is left with IT on the next
20280 character to display. */
20283 int n_glyphs_before
, hpos_before
, x_before
;
20285 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20287 /* Retrieve the next thing to display. Value is false if end of
20289 if (!get_next_display_element (it
))
20291 /* Maybe add a space at the end of this line that is used to
20292 display the cursor there under X. Set the charpos of the
20293 first glyph of blank lines not corresponding to any text
20295 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20296 row
->exact_window_width_line_p
= true;
20297 else if ((append_space_for_newline (it
, true)
20298 && row
->used
[TEXT_AREA
] == 1)
20299 || row
->used
[TEXT_AREA
] == 0)
20301 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20302 row
->displays_text_p
= false;
20304 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20305 && (!MINI_WINDOW_P (it
->w
)
20306 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20307 row
->indicate_empty_line_p
= true;
20310 it
->continuation_lines_width
= 0;
20311 row
->ends_at_zv_p
= true;
20312 /* A row that displays right-to-left text must always have
20313 its last face extended all the way to the end of line,
20314 even if this row ends in ZV, because we still write to
20315 the screen left to right. We also need to extend the
20316 last face if the default face is remapped to some
20317 different face, otherwise the functions that clear
20318 portions of the screen will clear with the default face's
20319 background color. */
20320 if (row
->reversed_p
20321 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20322 extend_face_to_end_of_line (it
);
20326 /* Now, get the metrics of what we want to display. This also
20327 generates glyphs in `row' (which is IT->glyph_row). */
20328 n_glyphs_before
= row
->used
[TEXT_AREA
];
20331 /* Remember the line height so far in case the next element doesn't
20332 fit on the line. */
20333 if (it
->line_wrap
!= TRUNCATE
)
20335 ascent
= it
->max_ascent
;
20336 descent
= it
->max_descent
;
20337 phys_ascent
= it
->max_phys_ascent
;
20338 phys_descent
= it
->max_phys_descent
;
20340 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20342 if (IT_DISPLAYING_WHITESPACE (it
))
20346 SAVE_IT (wrap_it
, *it
, wrap_data
);
20348 wrap_row_used
= row
->used
[TEXT_AREA
];
20349 wrap_row_ascent
= row
->ascent
;
20350 wrap_row_height
= row
->height
;
20351 wrap_row_phys_ascent
= row
->phys_ascent
;
20352 wrap_row_phys_height
= row
->phys_height
;
20353 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20354 wrap_row_min_pos
= min_pos
;
20355 wrap_row_min_bpos
= min_bpos
;
20356 wrap_row_max_pos
= max_pos
;
20357 wrap_row_max_bpos
= max_bpos
;
20363 PRODUCE_GLYPHS (it
);
20365 /* If this display element was in marginal areas, continue with
20367 if (it
->area
!= TEXT_AREA
)
20369 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20370 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20371 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20372 row
->phys_height
= max (row
->phys_height
,
20373 it
->max_phys_ascent
+ it
->max_phys_descent
);
20374 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20375 it
->max_extra_line_spacing
);
20376 set_iterator_to_next (it
, true);
20377 /* If we didn't handle the line/wrap prefix above, and the
20378 call to set_iterator_to_next just switched to TEXT_AREA,
20379 process the prefix now. */
20380 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20382 pending_handle_line_prefix
= false;
20383 handle_line_prefix (it
);
20388 /* Does the display element fit on the line? If we truncate
20389 lines, we should draw past the right edge of the window. If
20390 we don't truncate, we want to stop so that we can display the
20391 continuation glyph before the right margin. If lines are
20392 continued, there are two possible strategies for characters
20393 resulting in more than 1 glyph (e.g. tabs): Display as many
20394 glyphs as possible in this line and leave the rest for the
20395 continuation line, or display the whole element in the next
20396 line. Original redisplay did the former, so we do it also. */
20397 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20398 hpos_before
= it
->hpos
;
20401 if (/* Not a newline. */
20403 /* Glyphs produced fit entirely in the line. */
20404 && it
->current_x
< it
->last_visible_x
)
20406 it
->hpos
+= nglyphs
;
20407 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20408 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20409 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20410 row
->phys_height
= max (row
->phys_height
,
20411 it
->max_phys_ascent
+ it
->max_phys_descent
);
20412 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20413 it
->max_extra_line_spacing
);
20414 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20415 /* In R2L rows, we arrange in extend_face_to_end_of_line
20416 to add a right offset to the line, by a suitable
20417 change to the stretch glyph that is the leftmost
20418 glyph of the line. */
20419 && !row
->reversed_p
)
20420 row
->x
= x
- it
->first_visible_x
;
20421 /* Record the maximum and minimum buffer positions seen so
20422 far in glyphs that will be displayed by this row. */
20424 RECORD_MAX_MIN_POS (it
);
20429 struct glyph
*glyph
;
20431 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20433 /* Identify the glyphs added by the last call to
20434 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20435 the previous glyphs. */
20436 if (!row
->reversed_p
)
20437 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20439 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20440 new_x
= x
+ glyph
->pixel_width
;
20442 if (/* Lines are continued. */
20443 it
->line_wrap
!= TRUNCATE
20444 && (/* Glyph doesn't fit on the line. */
20445 new_x
> it
->last_visible_x
20446 /* Or it fits exactly on a window system frame. */
20447 || (new_x
== it
->last_visible_x
20448 && FRAME_WINDOW_P (it
->f
)
20449 && (row
->reversed_p
20450 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20451 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20453 /* End of a continued line. */
20456 || (new_x
== it
->last_visible_x
20457 && FRAME_WINDOW_P (it
->f
)
20458 && (row
->reversed_p
20459 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20460 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20462 /* Current glyph is the only one on the line or
20463 fits exactly on the line. We must continue
20464 the line because we can't draw the cursor
20465 after the glyph. */
20466 row
->continued_p
= true;
20467 it
->current_x
= new_x
;
20468 it
->continuation_lines_width
+= new_x
;
20470 if (i
== nglyphs
- 1)
20472 /* If line-wrap is on, check if a previous
20473 wrap point was found. */
20474 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20475 && wrap_row_used
> 0
20476 /* Even if there is a previous wrap
20477 point, continue the line here as
20478 usual, if (i) the previous character
20479 was a space or tab AND (ii) the
20480 current character is not. */
20482 || IT_DISPLAYING_WHITESPACE (it
)))
20485 /* Record the maximum and minimum buffer
20486 positions seen so far in glyphs that will be
20487 displayed by this row. */
20489 RECORD_MAX_MIN_POS (it
);
20490 set_iterator_to_next (it
, true);
20491 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20493 if (!get_next_display_element (it
))
20495 row
->exact_window_width_line_p
= true;
20496 it
->continuation_lines_width
= 0;
20497 row
->continued_p
= false;
20498 row
->ends_at_zv_p
= true;
20500 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20502 row
->continued_p
= false;
20503 row
->exact_window_width_line_p
= true;
20505 /* If line-wrap is on, check if a
20506 previous wrap point was found. */
20507 else if (wrap_row_used
> 0
20508 /* Even if there is a previous wrap
20509 point, continue the line here as
20510 usual, if (i) the previous character
20511 was a space or tab AND (ii) the
20512 current character is not. */
20514 || IT_DISPLAYING_WHITESPACE (it
)))
20519 else if (it
->bidi_p
)
20520 RECORD_MAX_MIN_POS (it
);
20521 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20522 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20523 extend_face_to_end_of_line (it
);
20525 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20526 && !FRAME_WINDOW_P (it
->f
))
20528 /* A padding glyph that doesn't fit on this line.
20529 This means the whole character doesn't fit
20531 if (row
->reversed_p
)
20532 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20533 - n_glyphs_before
);
20534 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20536 /* Fill the rest of the row with continuation
20537 glyphs like in 20.x. */
20538 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20539 < row
->glyphs
[1 + TEXT_AREA
])
20540 produce_special_glyphs (it
, IT_CONTINUATION
);
20542 row
->continued_p
= true;
20543 it
->current_x
= x_before
;
20544 it
->continuation_lines_width
+= x_before
;
20546 /* Restore the height to what it was before the
20547 element not fitting on the line. */
20548 it
->max_ascent
= ascent
;
20549 it
->max_descent
= descent
;
20550 it
->max_phys_ascent
= phys_ascent
;
20551 it
->max_phys_descent
= phys_descent
;
20552 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20553 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20554 extend_face_to_end_of_line (it
);
20556 else if (wrap_row_used
> 0)
20559 if (row
->reversed_p
)
20560 unproduce_glyphs (it
,
20561 row
->used
[TEXT_AREA
] - wrap_row_used
);
20562 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20563 it
->continuation_lines_width
+= wrap_x
;
20564 row
->used
[TEXT_AREA
] = wrap_row_used
;
20565 row
->ascent
= wrap_row_ascent
;
20566 row
->height
= wrap_row_height
;
20567 row
->phys_ascent
= wrap_row_phys_ascent
;
20568 row
->phys_height
= wrap_row_phys_height
;
20569 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20570 min_pos
= wrap_row_min_pos
;
20571 min_bpos
= wrap_row_min_bpos
;
20572 max_pos
= wrap_row_max_pos
;
20573 max_bpos
= wrap_row_max_bpos
;
20574 row
->continued_p
= true;
20575 row
->ends_at_zv_p
= false;
20576 row
->exact_window_width_line_p
= false;
20577 it
->continuation_lines_width
+= x
;
20579 /* Make sure that a non-default face is extended
20580 up to the right margin of the window. */
20581 extend_face_to_end_of_line (it
);
20583 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20585 /* A TAB that extends past the right edge of the
20586 window. This produces a single glyph on
20587 window system frames. We leave the glyph in
20588 this row and let it fill the row, but don't
20589 consume the TAB. */
20590 if ((row
->reversed_p
20591 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20592 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20593 produce_special_glyphs (it
, IT_CONTINUATION
);
20594 it
->continuation_lines_width
+= it
->last_visible_x
;
20595 row
->ends_in_middle_of_char_p
= true;
20596 row
->continued_p
= true;
20597 glyph
->pixel_width
= it
->last_visible_x
- x
;
20598 it
->starts_in_middle_of_char_p
= true;
20599 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20600 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20601 extend_face_to_end_of_line (it
);
20605 /* Something other than a TAB that draws past
20606 the right edge of the window. Restore
20607 positions to values before the element. */
20608 if (row
->reversed_p
)
20609 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20610 - (n_glyphs_before
+ i
));
20611 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20613 /* Display continuation glyphs. */
20614 it
->current_x
= x_before
;
20615 it
->continuation_lines_width
+= x
;
20616 if (!FRAME_WINDOW_P (it
->f
)
20617 || (row
->reversed_p
20618 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20619 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20620 produce_special_glyphs (it
, IT_CONTINUATION
);
20621 row
->continued_p
= true;
20623 extend_face_to_end_of_line (it
);
20625 if (nglyphs
> 1 && i
> 0)
20627 row
->ends_in_middle_of_char_p
= true;
20628 it
->starts_in_middle_of_char_p
= true;
20631 /* Restore the height to what it was before the
20632 element not fitting on the line. */
20633 it
->max_ascent
= ascent
;
20634 it
->max_descent
= descent
;
20635 it
->max_phys_ascent
= phys_ascent
;
20636 it
->max_phys_descent
= phys_descent
;
20641 else if (new_x
> it
->first_visible_x
)
20643 /* Increment number of glyphs actually displayed. */
20646 /* Record the maximum and minimum buffer positions
20647 seen so far in glyphs that will be displayed by
20650 RECORD_MAX_MIN_POS (it
);
20652 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20653 /* Glyph is partially visible, i.e. row starts at
20654 negative X position. Don't do that in R2L
20655 rows, where we arrange to add a right offset to
20656 the line in extend_face_to_end_of_line, by a
20657 suitable change to the stretch glyph that is
20658 the leftmost glyph of the line. */
20659 row
->x
= x
- it
->first_visible_x
;
20660 /* When the last glyph of an R2L row only fits
20661 partially on the line, we need to set row->x to a
20662 negative offset, so that the leftmost glyph is
20663 the one that is partially visible. But if we are
20664 going to produce the truncation glyph, this will
20665 be taken care of in produce_special_glyphs. */
20666 if (row
->reversed_p
20667 && new_x
> it
->last_visible_x
20668 && !(it
->line_wrap
== TRUNCATE
20669 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20671 eassert (FRAME_WINDOW_P (it
->f
));
20672 row
->x
= it
->last_visible_x
- new_x
;
20677 /* Glyph is completely off the left margin of the
20678 window. This should not happen because of the
20679 move_it_in_display_line at the start of this
20680 function, unless the text display area of the
20681 window is empty. */
20682 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20685 /* Even if this display element produced no glyphs at all,
20686 we want to record its position. */
20687 if (it
->bidi_p
&& nglyphs
== 0)
20688 RECORD_MAX_MIN_POS (it
);
20690 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20691 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20692 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20693 row
->phys_height
= max (row
->phys_height
,
20694 it
->max_phys_ascent
+ it
->max_phys_descent
);
20695 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20696 it
->max_extra_line_spacing
);
20698 /* End of this display line if row is continued. */
20699 if (row
->continued_p
|| row
->ends_at_zv_p
)
20704 /* Is this a line end? If yes, we're also done, after making
20705 sure that a non-default face is extended up to the right
20706 margin of the window. */
20707 if (ITERATOR_AT_END_OF_LINE_P (it
))
20709 int used_before
= row
->used
[TEXT_AREA
];
20711 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20713 /* Add a space at the end of the line that is used to
20714 display the cursor there. */
20715 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20716 append_space_for_newline (it
, false);
20718 /* Extend the face to the end of the line. */
20719 extend_face_to_end_of_line (it
);
20721 /* Make sure we have the position. */
20722 if (used_before
== 0)
20723 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20725 /* Record the position of the newline, for use in
20727 it
->eol_pos
= it
->current
.pos
;
20729 /* Consume the line end. This skips over invisible lines. */
20730 set_iterator_to_next (it
, true);
20731 it
->continuation_lines_width
= 0;
20735 /* Proceed with next display element. Note that this skips
20736 over lines invisible because of selective display. */
20737 set_iterator_to_next (it
, true);
20739 /* If we truncate lines, we are done when the last displayed
20740 glyphs reach past the right margin of the window. */
20741 if (it
->line_wrap
== TRUNCATE
20742 && ((FRAME_WINDOW_P (it
->f
)
20743 /* Images are preprocessed in produce_image_glyph such
20744 that they are cropped at the right edge of the
20745 window, so an image glyph will always end exactly at
20746 last_visible_x, even if there's no right fringe. */
20747 && ((row
->reversed_p
20748 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20749 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20750 || it
->what
== IT_IMAGE
))
20751 ? (it
->current_x
>= it
->last_visible_x
)
20752 : (it
->current_x
> it
->last_visible_x
)))
20754 /* Maybe add truncation glyphs. */
20755 if (!FRAME_WINDOW_P (it
->f
)
20756 || (row
->reversed_p
20757 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20758 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20762 if (!row
->reversed_p
)
20764 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20765 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20770 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20771 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20773 /* Remove any padding glyphs at the front of ROW, to
20774 make room for the truncation glyphs we will be
20775 adding below. The loop below always inserts at
20776 least one truncation glyph, so also remove the
20777 last glyph added to ROW. */
20778 unproduce_glyphs (it
, i
+ 1);
20779 /* Adjust i for the loop below. */
20780 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20783 /* produce_special_glyphs overwrites the last glyph, so
20784 we don't want that if we want to keep that last
20785 glyph, which means it's an image. */
20786 if (it
->current_x
> it
->last_visible_x
)
20788 it
->current_x
= x_before
;
20789 if (!FRAME_WINDOW_P (it
->f
))
20791 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20793 row
->used
[TEXT_AREA
] = i
;
20794 produce_special_glyphs (it
, IT_TRUNCATION
);
20799 row
->used
[TEXT_AREA
] = i
;
20800 produce_special_glyphs (it
, IT_TRUNCATION
);
20802 it
->hpos
= hpos_before
;
20805 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20807 /* Don't truncate if we can overflow newline into fringe. */
20808 if (!get_next_display_element (it
))
20810 it
->continuation_lines_width
= 0;
20811 row
->ends_at_zv_p
= true;
20812 row
->exact_window_width_line_p
= true;
20815 if (ITERATOR_AT_END_OF_LINE_P (it
))
20817 row
->exact_window_width_line_p
= true;
20818 goto at_end_of_line
;
20820 it
->current_x
= x_before
;
20821 it
->hpos
= hpos_before
;
20824 row
->truncated_on_right_p
= true;
20825 it
->continuation_lines_width
= 0;
20826 reseat_at_next_visible_line_start (it
, false);
20827 /* We insist below that IT's position be at ZV because in
20828 bidi-reordered lines the character at visible line start
20829 might not be the character that follows the newline in
20830 the logical order. */
20831 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20832 row
->ends_at_zv_p
=
20833 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20835 row
->ends_at_zv_p
= false;
20841 bidi_unshelve_cache (wrap_data
, true);
20843 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20844 at the left window margin. */
20845 if (it
->first_visible_x
20846 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20848 if (!FRAME_WINDOW_P (it
->f
)
20849 || (((row
->reversed_p
20850 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20851 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20852 /* Don't let insert_left_trunc_glyphs overwrite the
20853 first glyph of the row if it is an image. */
20854 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20855 insert_left_trunc_glyphs (it
);
20856 row
->truncated_on_left_p
= true;
20859 /* Remember the position at which this line ends.
20861 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20862 cannot be before the call to find_row_edges below, since that is
20863 where these positions are determined. */
20864 row
->end
= it
->current
;
20867 row
->minpos
= row
->start
.pos
;
20868 row
->maxpos
= row
->end
.pos
;
20872 /* ROW->minpos and ROW->maxpos must be the smallest and
20873 `1 + the largest' buffer positions in ROW. But if ROW was
20874 bidi-reordered, these two positions can be anywhere in the
20875 row, so we must determine them now. */
20876 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20879 /* If the start of this line is the overlay arrow-position, then
20880 mark this glyph row as the one containing the overlay arrow.
20881 This is clearly a mess with variable size fonts. It would be
20882 better to let it be displayed like cursors under X. */
20883 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20884 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20885 !NILP (overlay_arrow_string
)))
20887 /* Overlay arrow in window redisplay is a fringe bitmap. */
20888 if (STRINGP (overlay_arrow_string
))
20890 struct glyph_row
*arrow_row
20891 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20892 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20893 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20894 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20895 struct glyph
*p2
, *end
;
20897 /* Copy the arrow glyphs. */
20898 while (glyph
< arrow_end
)
20901 /* Throw away padding glyphs. */
20903 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20904 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20910 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20915 eassert (INTEGERP (overlay_arrow_string
));
20916 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20918 overlay_arrow_seen
= true;
20921 /* Highlight trailing whitespace. */
20922 if (!NILP (Vshow_trailing_whitespace
))
20923 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20925 /* Compute pixel dimensions of this line. */
20926 compute_line_metrics (it
);
20928 /* Implementation note: No changes in the glyphs of ROW or in their
20929 faces can be done past this point, because compute_line_metrics
20930 computes ROW's hash value and stores it within the glyph_row
20933 /* Record whether this row ends inside an ellipsis. */
20934 row
->ends_in_ellipsis_p
20935 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20936 && it
->ellipsis_p
);
20938 /* Save fringe bitmaps in this row. */
20939 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20940 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20941 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20942 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20944 it
->left_user_fringe_bitmap
= 0;
20945 it
->left_user_fringe_face_id
= 0;
20946 it
->right_user_fringe_bitmap
= 0;
20947 it
->right_user_fringe_face_id
= 0;
20949 /* Maybe set the cursor. */
20950 cvpos
= it
->w
->cursor
.vpos
;
20952 /* In bidi-reordered rows, keep checking for proper cursor
20953 position even if one has been found already, because buffer
20954 positions in such rows change non-linearly with ROW->VPOS,
20955 when a line is continued. One exception: when we are at ZV,
20956 display cursor on the first suitable glyph row, since all
20957 the empty rows after that also have their position set to ZV. */
20958 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20959 lines' rows is implemented for bidi-reordered rows. */
20961 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20962 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20963 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20964 && cursor_row_p (row
))
20965 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20967 /* Prepare for the next line. This line starts horizontally at (X
20968 HPOS) = (0 0). Vertical positions are incremented. As a
20969 convenience for the caller, IT->glyph_row is set to the next
20971 it
->current_x
= it
->hpos
= 0;
20972 it
->current_y
+= row
->height
;
20973 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20976 /* The next row should by default use the same value of the
20977 reversed_p flag as this one. set_iterator_to_next decides when
20978 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20979 the flag accordingly. */
20980 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20981 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20982 it
->start
= row
->end
;
20983 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20985 #undef RECORD_MAX_MIN_POS
20988 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20989 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20990 doc
: /* Return paragraph direction at point in BUFFER.
20991 Value is either `left-to-right' or `right-to-left'.
20992 If BUFFER is omitted or nil, it defaults to the current buffer.
20994 Paragraph direction determines how the text in the paragraph is displayed.
20995 In left-to-right paragraphs, text begins at the left margin of the window
20996 and the reading direction is generally left to right. In right-to-left
20997 paragraphs, text begins at the right margin and is read from right to left.
20999 See also `bidi-paragraph-direction'. */)
21000 (Lisp_Object buffer
)
21002 struct buffer
*buf
= current_buffer
;
21003 struct buffer
*old
= buf
;
21005 if (! NILP (buffer
))
21007 CHECK_BUFFER (buffer
);
21008 buf
= XBUFFER (buffer
);
21011 if (NILP (BVAR (buf
, bidi_display_reordering
))
21012 || NILP (BVAR (buf
, enable_multibyte_characters
))
21013 /* When we are loading loadup.el, the character property tables
21014 needed for bidi iteration are not yet available. */
21015 || !NILP (Vpurify_flag
))
21016 return Qleft_to_right
;
21017 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21018 return BVAR (buf
, bidi_paragraph_direction
);
21021 /* Determine the direction from buffer text. We could try to
21022 use current_matrix if it is up to date, but this seems fast
21023 enough as it is. */
21024 struct bidi_it itb
;
21025 ptrdiff_t pos
= BUF_PT (buf
);
21026 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21028 void *itb_data
= bidi_shelve_cache ();
21030 set_buffer_temp (buf
);
21031 /* bidi_paragraph_init finds the base direction of the paragraph
21032 by searching forward from paragraph start. We need the base
21033 direction of the current or _previous_ paragraph, so we need
21034 to make sure we are within that paragraph. To that end, find
21035 the previous non-empty line. */
21036 if (pos
>= ZV
&& pos
> BEGV
)
21037 DEC_BOTH (pos
, bytepos
);
21038 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21039 if (fast_looking_at (trailing_white_space
,
21040 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21042 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21043 || c
== ' ' || c
== '\t' || c
== '\f')
21045 if (bytepos
<= BEGV_BYTE
)
21050 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21053 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21054 itb
.paragraph_dir
= NEUTRAL_DIR
;
21055 itb
.string
.s
= NULL
;
21056 itb
.string
.lstring
= Qnil
;
21057 itb
.string
.bufpos
= 0;
21058 itb
.string
.from_disp_str
= false;
21059 itb
.string
.unibyte
= false;
21060 /* We have no window to use here for ignoring window-specific
21061 overlays. Using NULL for window pointer will cause
21062 compute_display_string_pos to use the current buffer. */
21064 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21065 bidi_unshelve_cache (itb_data
, false);
21066 set_buffer_temp (old
);
21067 switch (itb
.paragraph_dir
)
21070 return Qleft_to_right
;
21073 return Qright_to_left
;
21081 DEFUN ("bidi-find-overridden-directionality",
21082 Fbidi_find_overridden_directionality
,
21083 Sbidi_find_overridden_directionality
, 2, 3, 0,
21084 doc
: /* Return position between FROM and TO where directionality was overridden.
21086 This function returns the first character position in the specified
21087 region of OBJECT where there is a character whose `bidi-class' property
21088 is `L', but which was forced to display as `R' by a directional
21089 override, and likewise with characters whose `bidi-class' is `R'
21090 or `AL' that were forced to display as `L'.
21092 If no such character is found, the function returns nil.
21094 OBJECT is a Lisp string or buffer to search for overridden
21095 directionality, and defaults to the current buffer if nil or omitted.
21096 OBJECT can also be a window, in which case the function will search
21097 the buffer displayed in that window. Passing the window instead of
21098 a buffer is preferable when the buffer is displayed in some window,
21099 because this function will then be able to correctly account for
21100 window-specific overlays, which can affect the results.
21102 Strong directional characters `L', `R', and `AL' can have their
21103 intrinsic directionality overridden by directional override
21104 control characters RLO (u+202e) and LRO (u+202d). See the
21105 function `get-char-code-property' for a way to inquire about
21106 the `bidi-class' property of a character. */)
21107 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21109 struct buffer
*buf
= current_buffer
;
21110 struct buffer
*old
= buf
;
21111 struct window
*w
= NULL
;
21112 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21113 struct bidi_it itb
;
21114 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21117 if (!NILP (object
))
21119 if (BUFFERP (object
))
21120 buf
= XBUFFER (object
);
21121 else if (WINDOWP (object
))
21123 w
= decode_live_window (object
);
21124 buf
= XBUFFER (w
->contents
);
21125 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21128 CHECK_STRING (object
);
21131 if (STRINGP (object
))
21133 /* Characters in unibyte strings are always treated by bidi.c as
21135 if (!STRING_MULTIBYTE (object
)
21136 /* When we are loading loadup.el, the character property
21137 tables needed for bidi iteration are not yet
21139 || !NILP (Vpurify_flag
))
21142 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21143 if (from_pos
>= SCHARS (object
))
21146 /* Set up the bidi iterator. */
21147 itb_data
= bidi_shelve_cache ();
21148 itb
.paragraph_dir
= NEUTRAL_DIR
;
21149 itb
.string
.lstring
= object
;
21150 itb
.string
.s
= NULL
;
21151 itb
.string
.schars
= SCHARS (object
);
21152 itb
.string
.bufpos
= 0;
21153 itb
.string
.from_disp_str
= false;
21154 itb
.string
.unibyte
= false;
21156 bidi_init_it (0, 0, frame_window_p
, &itb
);
21160 /* Nothing this fancy can happen in unibyte buffers, or in a
21161 buffer that disabled reordering, or if FROM is at EOB. */
21162 if (NILP (BVAR (buf
, bidi_display_reordering
))
21163 || NILP (BVAR (buf
, enable_multibyte_characters
))
21164 /* When we are loading loadup.el, the character property
21165 tables needed for bidi iteration are not yet
21167 || !NILP (Vpurify_flag
))
21170 set_buffer_temp (buf
);
21171 validate_region (&from
, &to
);
21172 from_pos
= XINT (from
);
21173 to_pos
= XINT (to
);
21174 if (from_pos
>= ZV
)
21177 /* Set up the bidi iterator. */
21178 itb_data
= bidi_shelve_cache ();
21179 from_bpos
= CHAR_TO_BYTE (from_pos
);
21180 if (from_pos
== BEGV
)
21182 itb
.charpos
= BEGV
;
21183 itb
.bytepos
= BEGV_BYTE
;
21185 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21187 itb
.charpos
= from_pos
;
21188 itb
.bytepos
= from_bpos
;
21191 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21193 itb
.paragraph_dir
= NEUTRAL_DIR
;
21194 itb
.string
.s
= NULL
;
21195 itb
.string
.lstring
= Qnil
;
21196 itb
.string
.bufpos
= 0;
21197 itb
.string
.from_disp_str
= false;
21198 itb
.string
.unibyte
= false;
21200 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21205 /* For the purposes of this function, the actual base direction of
21206 the paragraph doesn't matter, so just set it to L2R. */
21207 bidi_paragraph_init (L2R
, &itb
, false);
21208 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21210 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21212 bidi_unshelve_cache (itb_data
, false);
21213 set_buffer_temp (old
);
21215 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21218 DEFUN ("move-point-visually", Fmove_point_visually
,
21219 Smove_point_visually
, 1, 1, 0,
21220 doc
: /* Move point in the visual order in the specified DIRECTION.
21221 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21224 Value is the new character position of point. */)
21225 (Lisp_Object direction
)
21227 struct window
*w
= XWINDOW (selected_window
);
21228 struct buffer
*b
= XBUFFER (w
->contents
);
21229 struct glyph_row
*row
;
21231 Lisp_Object paragraph_dir
;
21233 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21234 (!(ROW)->continued_p \
21235 && NILP ((GLYPH)->object) \
21236 && (GLYPH)->type == CHAR_GLYPH \
21237 && (GLYPH)->u.ch == ' ' \
21238 && (GLYPH)->charpos >= 0 \
21239 && !(GLYPH)->avoid_cursor_p)
21241 CHECK_NUMBER (direction
);
21242 dir
= XINT (direction
);
21248 /* If current matrix is up-to-date, we can use the information
21249 recorded in the glyphs, at least as long as the goal is on the
21251 if (w
->window_end_valid
21252 && !windows_or_buffers_changed
21254 && !b
->clip_changed
21255 && !b
->prevent_redisplay_optimizations_p
21256 && !window_outdated (w
)
21257 /* We rely below on the cursor coordinates to be up to date, but
21258 we cannot trust them if some command moved point since the
21259 last complete redisplay. */
21260 && w
->last_point
== BUF_PT (b
)
21261 && w
->cursor
.vpos
>= 0
21262 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21263 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21265 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21266 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21267 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21269 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21271 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21273 SET_PT (g
->charpos
);
21274 w
->cursor
.vpos
= -1;
21275 return make_number (PT
);
21277 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21281 if (BUFFERP (gpt
->object
))
21284 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21285 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21287 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21289 else if (BUFFERP (g
->object
))
21290 new_pos
= g
->charpos
;
21294 w
->cursor
.vpos
= -1;
21295 return make_number (PT
);
21297 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21299 /* Glyphs inserted at the end of a non-empty line for
21300 positioning the cursor have zero charpos, so we must
21301 deduce the value of point by other means. */
21302 if (g
->charpos
> 0)
21303 SET_PT (g
->charpos
);
21304 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21306 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21307 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21310 w
->cursor
.vpos
= -1;
21311 return make_number (PT
);
21314 if (g
== e
|| NILP (g
->object
))
21316 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21317 goto simulate_display
;
21318 if (!row
->reversed_p
)
21322 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21323 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21324 goto simulate_display
;
21328 if (row
->reversed_p
&& !row
->continued_p
)
21330 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21331 w
->cursor
.vpos
= -1;
21332 return make_number (PT
);
21334 g
= row
->glyphs
[TEXT_AREA
];
21335 e
= g
+ row
->used
[TEXT_AREA
];
21336 for ( ; g
< e
; g
++)
21338 if (BUFFERP (g
->object
)
21339 /* Empty lines have only one glyph, which stands
21340 for the newline, and whose charpos is the
21341 buffer position of the newline. */
21342 || ROW_GLYPH_NEWLINE_P (row
, g
)
21343 /* When the buffer ends in a newline, the line at
21344 EOB also has one glyph, but its charpos is -1. */
21345 || (row
->ends_at_zv_p
21346 && !row
->reversed_p
21347 && NILP (g
->object
)
21348 && g
->type
== CHAR_GLYPH
21349 && g
->u
.ch
== ' '))
21351 if (g
->charpos
> 0)
21352 SET_PT (g
->charpos
);
21353 else if (!row
->reversed_p
21354 && row
->ends_at_zv_p
21359 w
->cursor
.vpos
= -1;
21360 return make_number (PT
);
21366 if (!row
->reversed_p
&& !row
->continued_p
)
21368 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21369 w
->cursor
.vpos
= -1;
21370 return make_number (PT
);
21372 e
= row
->glyphs
[TEXT_AREA
];
21373 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21374 for ( ; g
>= e
; g
--)
21376 if (BUFFERP (g
->object
)
21377 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21379 /* Empty R2L lines on GUI frames have the buffer
21380 position of the newline stored in the stretch
21382 || g
->type
== STRETCH_GLYPH
21383 || (row
->ends_at_zv_p
21385 && NILP (g
->object
)
21386 && g
->type
== CHAR_GLYPH
21387 && g
->u
.ch
== ' '))
21389 if (g
->charpos
> 0)
21390 SET_PT (g
->charpos
);
21391 else if (row
->reversed_p
21392 && row
->ends_at_zv_p
21397 w
->cursor
.vpos
= -1;
21398 return make_number (PT
);
21407 /* If we wind up here, we failed to move by using the glyphs, so we
21408 need to simulate display instead. */
21411 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21413 paragraph_dir
= Qleft_to_right
;
21414 if (EQ (paragraph_dir
, Qright_to_left
))
21416 if (PT
<= BEGV
&& dir
< 0)
21417 xsignal0 (Qbeginning_of_buffer
);
21418 else if (PT
>= ZV
&& dir
> 0)
21419 xsignal0 (Qend_of_buffer
);
21422 struct text_pos pt
;
21424 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21426 bool overshoot_expected
= false;
21427 bool target_is_eol_p
= false;
21429 /* Setup the arena. */
21430 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21431 start_display (&it
, w
, pt
);
21432 /* When lines are truncated, we could be called with point
21433 outside of the windows edges, in which case move_it_*
21434 functions either prematurely stop at window's edge or jump to
21435 the next screen line, whereas we rely below on our ability to
21436 reach point, in order to start from its X coordinate. So we
21437 need to disregard the window's horizontal extent in that case. */
21438 if (it
.line_wrap
== TRUNCATE
)
21439 it
.last_visible_x
= INFINITY
;
21441 if (it
.cmp_it
.id
< 0
21442 && it
.method
== GET_FROM_STRING
21443 && it
.area
== TEXT_AREA
21444 && it
.string_from_display_prop_p
21445 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21446 overshoot_expected
= true;
21448 /* Find the X coordinate of point. We start from the beginning
21449 of this or previous line to make sure we are before point in
21450 the logical order (since the move_it_* functions can only
21453 reseat_at_previous_visible_line_start (&it
);
21454 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21455 if (IT_CHARPOS (it
) != PT
)
21457 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21458 -1, -1, -1, MOVE_TO_POS
);
21459 /* If we missed point because the character there is
21460 displayed out of a display vector that has more than one
21461 glyph, retry expecting overshoot. */
21462 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21463 && it
.current
.dpvec_index
> 0
21464 && !overshoot_expected
)
21466 overshoot_expected
= true;
21469 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21470 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21472 pt_x
= it
.current_x
;
21474 if (dir
> 0 || overshoot_expected
)
21476 struct glyph_row
*row
= it
.glyph_row
;
21478 /* When point is at beginning of line, we don't have
21479 information about the glyph there loaded into struct
21480 it. Calling get_next_display_element fixes that. */
21482 get_next_display_element (&it
);
21483 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21484 it
.glyph_row
= NULL
;
21485 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21486 it
.glyph_row
= row
;
21487 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21488 it, lest it will become out of sync with it's buffer
21490 it
.current_x
= pt_x
;
21493 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21494 pixel_width
= it
.pixel_width
;
21495 if (overshoot_expected
&& at_eol_p
)
21497 else if (pixel_width
<= 0)
21500 /* If there's a display string (or something similar) at point,
21501 we are actually at the glyph to the left of point, so we need
21502 to correct the X coordinate. */
21503 if (overshoot_expected
)
21506 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21508 pt_x
+= pixel_width
;
21511 /* Compute target X coordinate, either to the left or to the
21512 right of point. On TTY frames, all characters have the same
21513 pixel width of 1, so we can use that. On GUI frames we don't
21514 have an easy way of getting at the pixel width of the
21515 character to the left of point, so we use a different method
21516 of getting to that place. */
21518 target_x
= pt_x
+ pixel_width
;
21520 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21522 /* Target X coordinate could be one line above or below the line
21523 of point, in which case we need to adjust the target X
21524 coordinate. Also, if moving to the left, we need to begin at
21525 the left edge of the point's screen line. */
21530 start_display (&it
, w
, pt
);
21531 if (it
.line_wrap
== TRUNCATE
)
21532 it
.last_visible_x
= INFINITY
;
21533 reseat_at_previous_visible_line_start (&it
);
21534 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21536 move_it_by_lines (&it
, pt_vpos
);
21540 move_it_by_lines (&it
, -1);
21541 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21542 target_is_eol_p
= true;
21543 /* Under word-wrap, we don't know the x coordinate of
21544 the last character displayed on the previous line,
21545 which immediately precedes the wrap point. To find
21546 out its x coordinate, we try moving to the right
21547 margin of the window, which will stop at the wrap
21548 point, and then reset target_x to point at the
21549 character that precedes the wrap point. This is not
21550 needed on GUI frames, because (see below) there we
21551 move from the left margin one grapheme cluster at a
21552 time, and stop when we hit the wrap point. */
21553 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21555 void *it_data
= NULL
;
21558 SAVE_IT (it2
, it
, it_data
);
21559 move_it_in_display_line_to (&it
, ZV
, target_x
,
21560 MOVE_TO_POS
| MOVE_TO_X
);
21561 /* If we arrived at target_x, that _is_ the last
21562 character on the previous line. */
21563 if (it
.current_x
!= target_x
)
21564 target_x
= it
.current_x
- 1;
21565 RESTORE_IT (&it
, &it2
, it_data
);
21572 || (target_x
>= it
.last_visible_x
21573 && it
.line_wrap
!= TRUNCATE
))
21576 move_it_by_lines (&it
, 0);
21577 move_it_by_lines (&it
, 1);
21582 /* Move to the target X coordinate. */
21583 #ifdef HAVE_WINDOW_SYSTEM
21584 /* On GUI frames, as we don't know the X coordinate of the
21585 character to the left of point, moving point to the left
21586 requires walking, one grapheme cluster at a time, until we
21587 find ourself at a place immediately to the left of the
21588 character at point. */
21589 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21591 struct text_pos new_pos
;
21592 enum move_it_result rc
= MOVE_X_REACHED
;
21594 if (it
.current_x
== 0)
21595 get_next_display_element (&it
);
21596 if (it
.what
== IT_COMPOSITION
)
21598 new_pos
.charpos
= it
.cmp_it
.charpos
;
21599 new_pos
.bytepos
= -1;
21602 new_pos
= it
.current
.pos
;
21604 while (it
.current_x
+ it
.pixel_width
<= target_x
21605 && (rc
== MOVE_X_REACHED
21606 /* Under word-wrap, move_it_in_display_line_to
21607 stops at correct coordinates, but sometimes
21608 returns MOVE_POS_MATCH_OR_ZV. */
21609 || (it
.line_wrap
== WORD_WRAP
21610 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21612 int new_x
= it
.current_x
+ it
.pixel_width
;
21614 /* For composed characters, we want the position of the
21615 first character in the grapheme cluster (usually, the
21616 composition's base character), whereas it.current
21617 might give us the position of the _last_ one, e.g. if
21618 the composition is rendered in reverse due to bidi
21620 if (it
.what
== IT_COMPOSITION
)
21622 new_pos
.charpos
= it
.cmp_it
.charpos
;
21623 new_pos
.bytepos
= -1;
21626 new_pos
= it
.current
.pos
;
21627 if (new_x
== it
.current_x
)
21629 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21630 MOVE_TO_POS
| MOVE_TO_X
);
21631 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21634 /* The previous position we saw in the loop is the one we
21636 if (new_pos
.bytepos
== -1)
21637 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21638 it
.current
.pos
= new_pos
;
21642 if (it
.current_x
!= target_x
)
21643 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21645 /* If we ended up in a display string that covers point, move to
21646 buffer position to the right in the visual order. */
21649 while (IT_CHARPOS (it
) == PT
)
21651 set_iterator_to_next (&it
, false);
21652 if (!get_next_display_element (&it
))
21657 /* Move point to that position. */
21658 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21661 return make_number (PT
);
21663 #undef ROW_GLYPH_NEWLINE_P
21666 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21667 Sbidi_resolved_levels
, 0, 1, 0,
21668 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21670 The resolved levels are produced by the Emacs bidi reordering engine
21671 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21672 read the Unicode Standard Annex 9 (UAX#9) for background information
21673 about these levels.
21675 VPOS is the zero-based number of the current window's screen line
21676 for which to produce the resolved levels. If VPOS is nil or omitted,
21677 it defaults to the screen line of point. If the window displays a
21678 header line, VPOS of zero will report on the header line, and first
21679 line of text in the window will have VPOS of 1.
21681 Value is an array of resolved levels, indexed by glyph number.
21682 Glyphs are numbered from zero starting from the beginning of the
21683 screen line, i.e. the left edge of the window for left-to-right lines
21684 and from the right edge for right-to-left lines. The resolved levels
21685 are produced only for the window's text area; text in display margins
21688 If the selected window's display is not up-to-date, or if the specified
21689 screen line does not display text, this function returns nil. It is
21690 highly recommended to bind this function to some simple key, like F8,
21691 in order to avoid these problems.
21693 This function exists mainly for testing the correctness of the
21694 Emacs UBA implementation, in particular with the test suite. */)
21697 struct window
*w
= XWINDOW (selected_window
);
21698 struct buffer
*b
= XBUFFER (w
->contents
);
21700 struct glyph_row
*row
;
21704 int d1
, d2
, d3
, d4
, d5
;
21706 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21710 CHECK_NUMBER_COERCE_MARKER (vpos
);
21711 nrow
= XINT (vpos
);
21714 /* We require up-to-date glyph matrix for this window. */
21715 if (w
->window_end_valid
21716 && !windows_or_buffers_changed
21718 && !b
->clip_changed
21719 && !b
->prevent_redisplay_optimizations_p
21720 && !window_outdated (w
)
21722 && nrow
< w
->current_matrix
->nrows
21723 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21724 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21726 struct glyph
*g
, *e
, *g1
;
21728 Lisp_Object levels
;
21730 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21732 g
= g1
= row
->glyphs
[TEXT_AREA
];
21733 e
= g
+ row
->used
[TEXT_AREA
];
21735 /* Skip over glyphs at the start of the row that was
21736 generated by redisplay for its own needs. */
21738 && NILP (g
->object
)
21743 /* Count the "interesting" glyphs in this row. */
21744 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21747 /* Create and fill the array. */
21748 levels
= make_uninit_vector (nglyphs
);
21749 for (i
= 0; g1
< g
; i
++, g1
++)
21750 ASET (levels
, i
, make_number (g1
->resolved_level
));
21752 else /* Right-to-left glyph row. */
21754 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21755 e
= row
->glyphs
[TEXT_AREA
] - 1;
21757 && NILP (g
->object
)
21761 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21763 levels
= make_uninit_vector (nglyphs
);
21764 for (i
= 0; g1
> g
; i
++, g1
--)
21765 ASET (levels
, i
, make_number (g1
->resolved_level
));
21775 /***********************************************************************
21777 ***********************************************************************/
21779 /* Redisplay the menu bar in the frame for window W.
21781 The menu bar of X frames that don't have X toolkit support is
21782 displayed in a special window W->frame->menu_bar_window.
21784 The menu bar of terminal frames is treated specially as far as
21785 glyph matrices are concerned. Menu bar lines are not part of
21786 windows, so the update is done directly on the frame matrix rows
21787 for the menu bar. */
21790 display_menu_bar (struct window
*w
)
21792 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21797 /* Don't do all this for graphical frames. */
21799 if (FRAME_W32_P (f
))
21802 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21808 if (FRAME_NS_P (f
))
21810 #endif /* HAVE_NS */
21812 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21813 eassert (!FRAME_WINDOW_P (f
));
21814 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21815 it
.first_visible_x
= 0;
21816 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21817 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21818 if (FRAME_WINDOW_P (f
))
21820 /* Menu bar lines are displayed in the desired matrix of the
21821 dummy window menu_bar_window. */
21822 struct window
*menu_w
;
21823 menu_w
= XWINDOW (f
->menu_bar_window
);
21824 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21826 it
.first_visible_x
= 0;
21827 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21830 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21832 /* This is a TTY frame, i.e. character hpos/vpos are used as
21834 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21836 it
.first_visible_x
= 0;
21837 it
.last_visible_x
= FRAME_COLS (f
);
21840 /* FIXME: This should be controlled by a user option. See the
21841 comments in redisplay_tool_bar and display_mode_line about
21843 it
.paragraph_embedding
= L2R
;
21845 /* Clear all rows of the menu bar. */
21846 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21848 struct glyph_row
*row
= it
.glyph_row
+ i
;
21849 clear_glyph_row (row
);
21850 row
->enabled_p
= true;
21851 row
->full_width_p
= true;
21852 row
->reversed_p
= false;
21855 /* Display all items of the menu bar. */
21856 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21857 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21859 Lisp_Object string
;
21861 /* Stop at nil string. */
21862 string
= AREF (items
, i
+ 1);
21866 /* Remember where item was displayed. */
21867 ASET (items
, i
+ 3, make_number (it
.hpos
));
21869 /* Display the item, pad with one space. */
21870 if (it
.current_x
< it
.last_visible_x
)
21871 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21872 SCHARS (string
) + 1, 0, 0, -1);
21875 /* Fill out the line with spaces. */
21876 if (it
.current_x
< it
.last_visible_x
)
21877 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21879 /* Compute the total height of the lines. */
21880 compute_line_metrics (&it
);
21883 /* Deep copy of a glyph row, including the glyphs. */
21885 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21887 struct glyph
*pointers
[1 + LAST_AREA
];
21888 int to_used
= to
->used
[TEXT_AREA
];
21890 /* Save glyph pointers of TO. */
21891 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21893 /* Do a structure assignment. */
21896 /* Restore original glyph pointers of TO. */
21897 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21899 /* Copy the glyphs. */
21900 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21901 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21903 /* If we filled only part of the TO row, fill the rest with
21904 space_glyph (which will display as empty space). */
21905 if (to_used
> from
->used
[TEXT_AREA
])
21906 fill_up_frame_row_with_spaces (to
, to_used
);
21909 /* Display one menu item on a TTY, by overwriting the glyphs in the
21910 frame F's desired glyph matrix with glyphs produced from the menu
21911 item text. Called from term.c to display TTY drop-down menus one
21914 ITEM_TEXT is the menu item text as a C string.
21916 FACE_ID is the face ID to be used for this menu item. FACE_ID
21917 could specify one of 3 faces: a face for an enabled item, a face
21918 for a disabled item, or a face for a selected item.
21920 X and Y are coordinates of the first glyph in the frame's desired
21921 matrix to be overwritten by the menu item. Since this is a TTY, Y
21922 is the zero-based number of the glyph row and X is the zero-based
21923 glyph number in the row, starting from left, where to start
21924 displaying the item.
21926 SUBMENU means this menu item drops down a submenu, which
21927 should be indicated by displaying a proper visual cue after the
21931 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21932 int x
, int y
, bool submenu
)
21935 struct frame
*f
= SELECTED_FRAME ();
21936 struct window
*w
= XWINDOW (f
->selected_window
);
21937 struct glyph_row
*row
;
21938 size_t item_len
= strlen (item_text
);
21940 eassert (FRAME_TERMCAP_P (f
));
21942 /* Don't write beyond the matrix's last row. This can happen for
21943 TTY screens that are not high enough to show the entire menu.
21944 (This is actually a bit of defensive programming, as
21945 tty_menu_display already limits the number of menu items to one
21946 less than the number of screen lines.) */
21947 if (y
>= f
->desired_matrix
->nrows
)
21950 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21951 it
.first_visible_x
= 0;
21952 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21953 row
= it
.glyph_row
;
21954 /* Start with the row contents from the current matrix. */
21955 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21956 bool saved_width
= row
->full_width_p
;
21957 row
->full_width_p
= true;
21958 bool saved_reversed
= row
->reversed_p
;
21959 row
->reversed_p
= false;
21960 row
->enabled_p
= true;
21962 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21964 eassert (x
< f
->desired_matrix
->matrix_w
);
21965 it
.current_x
= it
.hpos
= x
;
21966 it
.current_y
= it
.vpos
= y
;
21967 int saved_used
= row
->used
[TEXT_AREA
];
21968 bool saved_truncated
= row
->truncated_on_right_p
;
21969 row
->used
[TEXT_AREA
] = x
;
21970 it
.face_id
= face_id
;
21971 it
.line_wrap
= TRUNCATE
;
21973 /* FIXME: This should be controlled by a user option. See the
21974 comments in redisplay_tool_bar and display_mode_line about this.
21975 Also, if paragraph_embedding could ever be R2L, changes will be
21976 needed to avoid shifting to the right the row characters in
21977 term.c:append_glyph. */
21978 it
.paragraph_embedding
= L2R
;
21980 /* Pad with a space on the left. */
21981 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21983 /* Display the menu item, pad with spaces to WIDTH. */
21986 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21987 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21989 /* Indicate with " >" that there's a submenu. */
21990 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21991 FRAME_COLS (f
) - 1, -1);
21994 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21995 width
, 0, FRAME_COLS (f
) - 1, -1);
21997 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21998 row
->truncated_on_right_p
= saved_truncated
;
21999 row
->hash
= row_hash (row
);
22000 row
->full_width_p
= saved_width
;
22001 row
->reversed_p
= saved_reversed
;
22004 /***********************************************************************
22006 ***********************************************************************/
22008 /* Redisplay mode lines in the window tree whose root is WINDOW.
22009 If FORCE, redisplay mode lines unconditionally.
22010 Otherwise, redisplay only mode lines that are garbaged. Value is
22011 the number of windows whose mode lines were redisplayed. */
22014 redisplay_mode_lines (Lisp_Object window
, bool force
)
22018 while (!NILP (window
))
22020 struct window
*w
= XWINDOW (window
);
22022 if (WINDOWP (w
->contents
))
22023 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22025 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22026 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22028 struct text_pos lpoint
;
22029 struct buffer
*old
= current_buffer
;
22031 /* Set the window's buffer for the mode line display. */
22032 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22033 set_buffer_internal_1 (XBUFFER (w
->contents
));
22035 /* Point refers normally to the selected window. For any
22036 other window, set up appropriate value. */
22037 if (!EQ (window
, selected_window
))
22039 struct text_pos pt
;
22041 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22042 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22045 /* Display mode lines. */
22046 clear_glyph_matrix (w
->desired_matrix
);
22047 if (display_mode_lines (w
))
22050 /* Restore old settings. */
22051 set_buffer_internal_1 (old
);
22052 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22062 /* Display the mode and/or header line of window W. Value is the
22063 sum number of mode lines and header lines displayed. */
22066 display_mode_lines (struct window
*w
)
22068 Lisp_Object old_selected_window
= selected_window
;
22069 Lisp_Object old_selected_frame
= selected_frame
;
22070 Lisp_Object new_frame
= w
->frame
;
22071 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22074 selected_frame
= new_frame
;
22075 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22076 or window's point, then we'd need select_window_1 here as well. */
22077 XSETWINDOW (selected_window
, w
);
22078 XFRAME (new_frame
)->selected_window
= selected_window
;
22080 /* These will be set while the mode line specs are processed. */
22081 line_number_displayed
= false;
22082 w
->column_number_displayed
= -1;
22084 if (WINDOW_WANTS_MODELINE_P (w
))
22086 struct window
*sel_w
= XWINDOW (old_selected_window
);
22088 /* Select mode line face based on the real selected window. */
22089 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22090 BVAR (current_buffer
, mode_line_format
));
22094 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22096 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22097 BVAR (current_buffer
, header_line_format
));
22101 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22102 selected_frame
= old_selected_frame
;
22103 selected_window
= old_selected_window
;
22105 w
->must_be_updated_p
= true;
22110 /* Display mode or header line of window W. FACE_ID specifies which
22111 line to display; it is either MODE_LINE_FACE_ID or
22112 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22113 display. Value is the pixel height of the mode/header line
22117 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22121 ptrdiff_t count
= SPECPDL_INDEX ();
22123 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22124 /* Don't extend on a previously drawn mode-line.
22125 This may happen if called from pos_visible_p. */
22126 it
.glyph_row
->enabled_p
= false;
22127 prepare_desired_row (w
, it
.glyph_row
, true);
22129 it
.glyph_row
->mode_line_p
= true;
22131 /* FIXME: This should be controlled by a user option. But
22132 supporting such an option is not trivial, since the mode line is
22133 made up of many separate strings. */
22134 it
.paragraph_embedding
= L2R
;
22136 record_unwind_protect (unwind_format_mode_line
,
22137 format_mode_line_unwind_data (NULL
, NULL
,
22140 mode_line_target
= MODE_LINE_DISPLAY
;
22142 /* Temporarily make frame's keyboard the current kboard so that
22143 kboard-local variables in the mode_line_format will get the right
22145 push_kboard (FRAME_KBOARD (it
.f
));
22146 record_unwind_save_match_data ();
22147 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22150 unbind_to (count
, Qnil
);
22152 /* Fill up with spaces. */
22153 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22155 compute_line_metrics (&it
);
22156 it
.glyph_row
->full_width_p
= true;
22157 it
.glyph_row
->continued_p
= false;
22158 it
.glyph_row
->truncated_on_left_p
= false;
22159 it
.glyph_row
->truncated_on_right_p
= false;
22161 /* Make a 3D mode-line have a shadow at its right end. */
22162 face
= FACE_FROM_ID (it
.f
, face_id
);
22163 extend_face_to_end_of_line (&it
);
22164 if (face
->box
!= FACE_NO_BOX
)
22166 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22167 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22168 last
->right_box_line_p
= true;
22171 return it
.glyph_row
->height
;
22174 /* Move element ELT in LIST to the front of LIST.
22175 Return the updated list. */
22178 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22180 register Lisp_Object tail
, prev
;
22181 register Lisp_Object tem
;
22185 while (CONSP (tail
))
22191 /* Splice out the link TAIL. */
22193 list
= XCDR (tail
);
22195 Fsetcdr (prev
, XCDR (tail
));
22197 /* Now make it the first. */
22198 Fsetcdr (tail
, list
);
22203 tail
= XCDR (tail
);
22207 /* Not found--return unchanged LIST. */
22211 /* Contribute ELT to the mode line for window IT->w. How it
22212 translates into text depends on its data type.
22214 IT describes the display environment in which we display, as usual.
22216 DEPTH is the depth in recursion. It is used to prevent
22217 infinite recursion here.
22219 FIELD_WIDTH is the number of characters the display of ELT should
22220 occupy in the mode line, and PRECISION is the maximum number of
22221 characters to display from ELT's representation. See
22222 display_string for details.
22224 Returns the hpos of the end of the text generated by ELT.
22226 PROPS is a property list to add to any string we encounter.
22228 If RISKY, remove (disregard) any properties in any string
22229 we encounter, and ignore :eval and :propertize.
22231 The global variable `mode_line_target' determines whether the
22232 output is passed to `store_mode_line_noprop',
22233 `store_mode_line_string', or `display_string'. */
22236 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22237 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22239 int n
= 0, field
, prec
;
22240 bool literal
= false;
22244 elt
= build_string ("*too-deep*");
22248 switch (XTYPE (elt
))
22252 /* A string: output it and check for %-constructs within it. */
22254 ptrdiff_t offset
= 0;
22256 if (SCHARS (elt
) > 0
22257 && (!NILP (props
) || risky
))
22259 Lisp_Object oprops
, aelt
;
22260 oprops
= Ftext_properties_at (make_number (0), elt
);
22262 /* If the starting string's properties are not what
22263 we want, translate the string. Also, if the string
22264 is risky, do that anyway. */
22266 if (NILP (Fequal (props
, oprops
)) || risky
)
22268 /* If the starting string has properties,
22269 merge the specified ones onto the existing ones. */
22270 if (! NILP (oprops
) && !risky
)
22274 oprops
= Fcopy_sequence (oprops
);
22276 while (CONSP (tem
))
22278 oprops
= Fplist_put (oprops
, XCAR (tem
),
22279 XCAR (XCDR (tem
)));
22280 tem
= XCDR (XCDR (tem
));
22285 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22286 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22288 /* AELT is what we want. Move it to the front
22289 without consing. */
22291 mode_line_proptrans_alist
22292 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22298 /* If AELT has the wrong props, it is useless.
22299 so get rid of it. */
22301 mode_line_proptrans_alist
22302 = Fdelq (aelt
, mode_line_proptrans_alist
);
22304 elt
= Fcopy_sequence (elt
);
22305 Fset_text_properties (make_number (0), Flength (elt
),
22307 /* Add this item to mode_line_proptrans_alist. */
22308 mode_line_proptrans_alist
22309 = Fcons (Fcons (elt
, props
),
22310 mode_line_proptrans_alist
);
22311 /* Truncate mode_line_proptrans_alist
22312 to at most 50 elements. */
22313 tem
= Fnthcdr (make_number (50),
22314 mode_line_proptrans_alist
);
22316 XSETCDR (tem
, Qnil
);
22325 prec
= precision
- n
;
22326 switch (mode_line_target
)
22328 case MODE_LINE_NOPROP
:
22329 case MODE_LINE_TITLE
:
22330 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22332 case MODE_LINE_STRING
:
22333 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22335 case MODE_LINE_DISPLAY
:
22336 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22337 0, prec
, 0, STRING_MULTIBYTE (elt
));
22344 /* Handle the non-literal case. */
22346 while ((precision
<= 0 || n
< precision
)
22347 && SREF (elt
, offset
) != 0
22348 && (mode_line_target
!= MODE_LINE_DISPLAY
22349 || it
->current_x
< it
->last_visible_x
))
22351 ptrdiff_t last_offset
= offset
;
22353 /* Advance to end of string or next format specifier. */
22354 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22357 if (offset
- 1 != last_offset
)
22359 ptrdiff_t nchars
, nbytes
;
22361 /* Output to end of string or up to '%'. Field width
22362 is length of string. Don't output more than
22363 PRECISION allows us. */
22366 prec
= c_string_width (SDATA (elt
) + last_offset
,
22367 offset
- last_offset
, precision
- n
,
22370 switch (mode_line_target
)
22372 case MODE_LINE_NOPROP
:
22373 case MODE_LINE_TITLE
:
22374 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22376 case MODE_LINE_STRING
:
22378 ptrdiff_t bytepos
= last_offset
;
22379 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22380 ptrdiff_t endpos
= (precision
<= 0
22381 ? string_byte_to_char (elt
, offset
)
22382 : charpos
+ nchars
);
22383 Lisp_Object mode_string
22384 = Fsubstring (elt
, make_number (charpos
),
22385 make_number (endpos
));
22386 n
+= store_mode_line_string (NULL
, mode_string
, false,
22390 case MODE_LINE_DISPLAY
:
22392 ptrdiff_t bytepos
= last_offset
;
22393 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22395 if (precision
<= 0)
22396 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22397 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22399 STRING_MULTIBYTE (elt
));
22404 else /* c == '%' */
22406 ptrdiff_t percent_position
= offset
;
22408 /* Get the specified minimum width. Zero means
22411 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22412 field
= field
* 10 + c
- '0';
22414 /* Don't pad beyond the total padding allowed. */
22415 if (field_width
- n
> 0 && field
> field_width
- n
)
22416 field
= field_width
- n
;
22418 /* Note that either PRECISION <= 0 or N < PRECISION. */
22419 prec
= precision
- n
;
22422 n
+= display_mode_element (it
, depth
, field
, prec
,
22423 Vglobal_mode_string
, props
,
22428 ptrdiff_t bytepos
, charpos
;
22430 Lisp_Object string
;
22432 bytepos
= percent_position
;
22433 charpos
= (STRING_MULTIBYTE (elt
)
22434 ? string_byte_to_char (elt
, bytepos
)
22436 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22437 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22439 switch (mode_line_target
)
22441 case MODE_LINE_NOPROP
:
22442 case MODE_LINE_TITLE
:
22443 n
+= store_mode_line_noprop (spec
, field
, prec
);
22445 case MODE_LINE_STRING
:
22447 Lisp_Object tem
= build_string (spec
);
22448 props
= Ftext_properties_at (make_number (charpos
), elt
);
22449 /* Should only keep face property in props */
22450 n
+= store_mode_line_string (NULL
, tem
, false,
22451 field
, prec
, props
);
22454 case MODE_LINE_DISPLAY
:
22456 int nglyphs_before
, nwritten
;
22458 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22459 nwritten
= display_string (spec
, string
, elt
,
22464 /* Assign to the glyphs written above the
22465 string where the `%x' came from, position
22469 struct glyph
*glyph
22470 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22474 for (i
= 0; i
< nwritten
; ++i
)
22476 glyph
[i
].object
= elt
;
22477 glyph
[i
].charpos
= charpos
;
22494 /* A symbol: process the value of the symbol recursively
22495 as if it appeared here directly. Avoid error if symbol void.
22496 Special case: if value of symbol is a string, output the string
22499 register Lisp_Object tem
;
22501 /* If the variable is not marked as risky to set
22502 then its contents are risky to use. */
22503 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22506 tem
= Fboundp (elt
);
22509 tem
= Fsymbol_value (elt
);
22510 /* If value is a string, output that string literally:
22511 don't check for % within it. */
22515 if (!EQ (tem
, elt
))
22517 /* Give up right away for nil or t. */
22527 register Lisp_Object car
, tem
;
22529 /* A cons cell: five distinct cases.
22530 If first element is :eval or :propertize, do something special.
22531 If first element is a string or a cons, process all the elements
22532 and effectively concatenate them.
22533 If first element is a negative number, truncate displaying cdr to
22534 at most that many characters. If positive, pad (with spaces)
22535 to at least that many characters.
22536 If first element is a symbol, process the cadr or caddr recursively
22537 according to whether the symbol's value is non-nil or nil. */
22539 if (EQ (car
, QCeval
))
22541 /* An element of the form (:eval FORM) means evaluate FORM
22542 and use the result as mode line elements. */
22547 if (CONSP (XCDR (elt
)))
22550 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22551 n
+= display_mode_element (it
, depth
, field_width
- n
,
22552 precision
- n
, spec
, props
,
22556 else if (EQ (car
, QCpropertize
))
22558 /* An element of the form (:propertize ELT PROPS...)
22559 means display ELT but applying properties PROPS. */
22564 if (CONSP (XCDR (elt
)))
22565 n
+= display_mode_element (it
, depth
, field_width
- n
,
22566 precision
- n
, XCAR (XCDR (elt
)),
22567 XCDR (XCDR (elt
)), risky
);
22569 else if (SYMBOLP (car
))
22571 tem
= Fboundp (car
);
22575 /* elt is now the cdr, and we know it is a cons cell.
22576 Use its car if CAR has a non-nil value. */
22579 tem
= Fsymbol_value (car
);
22586 /* Symbol's value is nil (or symbol is unbound)
22587 Get the cddr of the original list
22588 and if possible find the caddr and use that. */
22592 else if (!CONSP (elt
))
22597 else if (INTEGERP (car
))
22599 register int lim
= XINT (car
);
22603 /* Negative int means reduce maximum width. */
22604 if (precision
<= 0)
22607 precision
= min (precision
, -lim
);
22611 /* Padding specified. Don't let it be more than
22612 current maximum. */
22614 lim
= min (precision
, lim
);
22616 /* If that's more padding than already wanted, queue it.
22617 But don't reduce padding already specified even if
22618 that is beyond the current truncation point. */
22619 field_width
= max (lim
, field_width
);
22623 else if (STRINGP (car
) || CONSP (car
))
22625 Lisp_Object halftail
= elt
;
22629 && (precision
<= 0 || n
< precision
))
22631 n
+= display_mode_element (it
, depth
,
22632 /* Do padding only after the last
22633 element in the list. */
22634 (! CONSP (XCDR (elt
))
22637 precision
- n
, XCAR (elt
),
22641 if ((len
& 1) == 0)
22642 halftail
= XCDR (halftail
);
22643 /* Check for cycle. */
22644 if (EQ (halftail
, elt
))
22653 elt
= build_string ("*invalid*");
22657 /* Pad to FIELD_WIDTH. */
22658 if (field_width
> 0 && n
< field_width
)
22660 switch (mode_line_target
)
22662 case MODE_LINE_NOPROP
:
22663 case MODE_LINE_TITLE
:
22664 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22666 case MODE_LINE_STRING
:
22667 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22670 case MODE_LINE_DISPLAY
:
22671 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22680 /* Store a mode-line string element in mode_line_string_list.
22682 If STRING is non-null, display that C string. Otherwise, the Lisp
22683 string LISP_STRING is displayed.
22685 FIELD_WIDTH is the minimum number of output glyphs to produce.
22686 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22687 with spaces. FIELD_WIDTH <= 0 means don't pad.
22689 PRECISION is the maximum number of characters to output from
22690 STRING. PRECISION <= 0 means don't truncate the string.
22692 If COPY_STRING, make a copy of LISP_STRING before adding
22693 properties to the string.
22695 PROPS are the properties to add to the string.
22696 The mode_line_string_face face property is always added to the string.
22700 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22702 int field_width
, int precision
, Lisp_Object props
)
22707 if (string
!= NULL
)
22709 len
= strlen (string
);
22710 if (precision
> 0 && len
> precision
)
22712 lisp_string
= make_string (string
, len
);
22714 props
= mode_line_string_face_prop
;
22715 else if (!NILP (mode_line_string_face
))
22717 Lisp_Object face
= Fplist_get (props
, Qface
);
22718 props
= Fcopy_sequence (props
);
22720 face
= mode_line_string_face
;
22722 face
= list2 (face
, mode_line_string_face
);
22723 props
= Fplist_put (props
, Qface
, face
);
22725 Fadd_text_properties (make_number (0), make_number (len
),
22726 props
, lisp_string
);
22730 len
= XFASTINT (Flength (lisp_string
));
22731 if (precision
> 0 && len
> precision
)
22734 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22737 if (!NILP (mode_line_string_face
))
22741 props
= Ftext_properties_at (make_number (0), lisp_string
);
22742 face
= Fplist_get (props
, Qface
);
22744 face
= mode_line_string_face
;
22746 face
= list2 (face
, mode_line_string_face
);
22747 props
= list2 (Qface
, face
);
22749 lisp_string
= Fcopy_sequence (lisp_string
);
22752 Fadd_text_properties (make_number (0), make_number (len
),
22753 props
, lisp_string
);
22758 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22762 if (field_width
> len
)
22764 field_width
-= len
;
22765 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22767 Fadd_text_properties (make_number (0), make_number (field_width
),
22768 props
, lisp_string
);
22769 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22777 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22779 doc
: /* Format a string out of a mode line format specification.
22780 First arg FORMAT specifies the mode line format (see `mode-line-format'
22781 for details) to use.
22783 By default, the format is evaluated for the currently selected window.
22785 Optional second arg FACE specifies the face property to put on all
22786 characters for which no face is specified. The value nil means the
22787 default face. The value t means whatever face the window's mode line
22788 currently uses (either `mode-line' or `mode-line-inactive',
22789 depending on whether the window is the selected window or not).
22790 An integer value means the value string has no text
22793 Optional third and fourth args WINDOW and BUFFER specify the window
22794 and buffer to use as the context for the formatting (defaults
22795 are the selected window and the WINDOW's buffer). */)
22796 (Lisp_Object format
, Lisp_Object face
,
22797 Lisp_Object window
, Lisp_Object buffer
)
22802 struct buffer
*old_buffer
= NULL
;
22804 bool no_props
= INTEGERP (face
);
22805 ptrdiff_t count
= SPECPDL_INDEX ();
22807 int string_start
= 0;
22809 w
= decode_any_window (window
);
22810 XSETWINDOW (window
, w
);
22813 buffer
= w
->contents
;
22814 CHECK_BUFFER (buffer
);
22816 /* Make formatting the modeline a non-op when noninteractive, otherwise
22817 there will be problems later caused by a partially initialized frame. */
22818 if (NILP (format
) || noninteractive
)
22819 return empty_unibyte_string
;
22824 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22825 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22826 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22827 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22828 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22829 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22830 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22833 old_buffer
= current_buffer
;
22835 /* Save things including mode_line_proptrans_alist,
22836 and set that to nil so that we don't alter the outer value. */
22837 record_unwind_protect (unwind_format_mode_line
,
22838 format_mode_line_unwind_data
22839 (XFRAME (WINDOW_FRAME (w
)),
22840 old_buffer
, selected_window
, true));
22841 mode_line_proptrans_alist
= Qnil
;
22843 Fselect_window (window
, Qt
);
22844 set_buffer_internal_1 (XBUFFER (buffer
));
22846 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22850 mode_line_target
= MODE_LINE_NOPROP
;
22851 mode_line_string_face_prop
= Qnil
;
22852 mode_line_string_list
= Qnil
;
22853 string_start
= MODE_LINE_NOPROP_LEN (0);
22857 mode_line_target
= MODE_LINE_STRING
;
22858 mode_line_string_list
= Qnil
;
22859 mode_line_string_face
= face
;
22860 mode_line_string_face_prop
22861 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22864 push_kboard (FRAME_KBOARD (it
.f
));
22865 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22870 len
= MODE_LINE_NOPROP_LEN (string_start
);
22871 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22875 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22876 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22877 empty_unibyte_string
);
22880 unbind_to (count
, Qnil
);
22884 /* Write a null-terminated, right justified decimal representation of
22885 the positive integer D to BUF using a minimal field width WIDTH. */
22888 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22890 register char *p
= buf
;
22898 *p
++ = d
% 10 + '0';
22903 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22914 /* Write a null-terminated, right justified decimal and "human
22915 readable" representation of the nonnegative integer D to BUF using
22916 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22918 static const char power_letter
[] =
22932 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22934 /* We aim to represent the nonnegative integer D as
22935 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22936 ptrdiff_t quotient
= d
;
22938 /* -1 means: do not use TENTHS. */
22942 /* Length of QUOTIENT.TENTHS as a string. */
22948 if (quotient
>= 1000)
22950 /* Scale to the appropriate EXPONENT. */
22953 remainder
= quotient
% 1000;
22957 while (quotient
>= 1000);
22959 /* Round to nearest and decide whether to use TENTHS or not. */
22962 tenths
= remainder
/ 100;
22963 if (remainder
% 100 >= 50)
22970 if (quotient
== 10)
22978 if (remainder
>= 500)
22980 if (quotient
< 999)
22991 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22992 if (tenths
== -1 && quotient
<= 99)
22999 p
= psuffix
= buf
+ max (width
, length
);
23001 /* Print EXPONENT. */
23002 *psuffix
++ = power_letter
[exponent
];
23005 /* Print TENTHS. */
23008 *--p
= '0' + tenths
;
23012 /* Print QUOTIENT. */
23015 int digit
= quotient
% 10;
23016 *--p
= '0' + digit
;
23018 while ((quotient
/= 10) != 0);
23020 /* Print leading spaces. */
23025 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23026 If EOL_FLAG, set also a mnemonic character for end-of-line
23027 type of CODING_SYSTEM. Return updated pointer into BUF. */
23029 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23032 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23035 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23036 const unsigned char *eol_str
;
23038 /* The EOL conversion we are using. */
23039 Lisp_Object eoltype
;
23041 val
= CODING_SYSTEM_SPEC (coding_system
);
23044 if (!VECTORP (val
)) /* Not yet decided. */
23046 *buf
++ = multibyte
? '-' : ' ';
23048 eoltype
= eol_mnemonic_undecided
;
23049 /* Don't mention EOL conversion if it isn't decided. */
23054 Lisp_Object eolvalue
;
23056 attrs
= AREF (val
, 0);
23057 eolvalue
= AREF (val
, 2);
23060 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23065 /* The EOL conversion that is normal on this system. */
23067 if (NILP (eolvalue
)) /* Not yet decided. */
23068 eoltype
= eol_mnemonic_undecided
;
23069 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23070 eoltype
= eol_mnemonic_undecided
;
23071 else /* eolvalue is Qunix, Qdos, or Qmac. */
23072 eoltype
= (EQ (eolvalue
, Qunix
)
23073 ? eol_mnemonic_unix
23074 : EQ (eolvalue
, Qdos
)
23075 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23081 /* Mention the EOL conversion if it is not the usual one. */
23082 if (STRINGP (eoltype
))
23084 eol_str
= SDATA (eoltype
);
23085 eol_str_len
= SBYTES (eoltype
);
23087 else if (CHARACTERP (eoltype
))
23089 int c
= XFASTINT (eoltype
);
23090 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23094 eol_str
= invalid_eol_type
;
23095 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23097 memcpy (buf
, eol_str
, eol_str_len
);
23098 buf
+= eol_str_len
;
23104 /* Return a string for the output of a mode line %-spec for window W,
23105 generated by character C. FIELD_WIDTH > 0 means pad the string
23106 returned with spaces to that value. Return a Lisp string in
23107 *STRING if the resulting string is taken from that Lisp string.
23109 Note we operate on the current buffer for most purposes. */
23111 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23113 static const char *
23114 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23115 Lisp_Object
*string
)
23118 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23119 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23120 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23121 produce strings from numerical values, so limit preposterously
23122 large values of FIELD_WIDTH to avoid overrunning the buffer's
23123 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23124 bytes plus the terminating null. */
23125 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23126 struct buffer
*b
= current_buffer
;
23134 if (!NILP (BVAR (b
, read_only
)))
23136 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23141 /* This differs from %* only for a modified read-only buffer. */
23142 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23144 if (!NILP (BVAR (b
, read_only
)))
23149 /* This differs from %* in ignoring read-only-ness. */
23150 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23162 if (command_loop_level
> 5)
23164 p
= decode_mode_spec_buf
;
23165 for (i
= 0; i
< command_loop_level
; i
++)
23168 return decode_mode_spec_buf
;
23176 if (command_loop_level
> 5)
23178 p
= decode_mode_spec_buf
;
23179 for (i
= 0; i
< command_loop_level
; i
++)
23182 return decode_mode_spec_buf
;
23189 /* Let lots_of_dashes be a string of infinite length. */
23190 if (mode_line_target
== MODE_LINE_NOPROP
23191 || mode_line_target
== MODE_LINE_STRING
)
23193 if (field_width
<= 0
23194 || field_width
> sizeof (lots_of_dashes
))
23196 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23197 decode_mode_spec_buf
[i
] = '-';
23198 decode_mode_spec_buf
[i
] = '\0';
23199 return decode_mode_spec_buf
;
23202 return lots_of_dashes
;
23206 obj
= BVAR (b
, name
);
23210 /* %c and %l are ignored in `frame-title-format'.
23211 (In redisplay_internal, the frame title is drawn _before_ the
23212 windows are updated, so the stuff which depends on actual
23213 window contents (such as %l) may fail to render properly, or
23214 even crash emacs.) */
23215 if (mode_line_target
== MODE_LINE_TITLE
)
23219 ptrdiff_t col
= current_column ();
23220 w
->column_number_displayed
= col
;
23221 pint2str (decode_mode_spec_buf
, width
, col
);
23222 return decode_mode_spec_buf
;
23226 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23228 if (NILP (Vmemory_full
))
23231 return "!MEM FULL! ";
23238 /* %F displays the frame name. */
23239 if (!NILP (f
->title
))
23240 return SSDATA (f
->title
);
23241 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23242 return SSDATA (f
->name
);
23246 obj
= BVAR (b
, filename
);
23251 ptrdiff_t size
= ZV
- BEGV
;
23252 pint2str (decode_mode_spec_buf
, width
, size
);
23253 return decode_mode_spec_buf
;
23258 ptrdiff_t size
= ZV
- BEGV
;
23259 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23260 return decode_mode_spec_buf
;
23265 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23266 ptrdiff_t topline
, nlines
, height
;
23269 /* %c and %l are ignored in `frame-title-format'. */
23270 if (mode_line_target
== MODE_LINE_TITLE
)
23273 startpos
= marker_position (w
->start
);
23274 startpos_byte
= marker_byte_position (w
->start
);
23275 height
= WINDOW_TOTAL_LINES (w
);
23277 /* If we decided that this buffer isn't suitable for line numbers,
23278 don't forget that too fast. */
23279 if (w
->base_line_pos
== -1)
23282 /* If the buffer is very big, don't waste time. */
23283 if (INTEGERP (Vline_number_display_limit
)
23284 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23286 w
->base_line_pos
= 0;
23287 w
->base_line_number
= 0;
23291 if (w
->base_line_number
> 0
23292 && w
->base_line_pos
> 0
23293 && w
->base_line_pos
<= startpos
)
23295 line
= w
->base_line_number
;
23296 linepos
= w
->base_line_pos
;
23297 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23302 linepos
= BUF_BEGV (b
);
23303 linepos_byte
= BUF_BEGV_BYTE (b
);
23306 /* Count lines from base line to window start position. */
23307 nlines
= display_count_lines (linepos_byte
,
23311 topline
= nlines
+ line
;
23313 /* Determine a new base line, if the old one is too close
23314 or too far away, or if we did not have one.
23315 "Too close" means it's plausible a scroll-down would
23316 go back past it. */
23317 if (startpos
== BUF_BEGV (b
))
23319 w
->base_line_number
= topline
;
23320 w
->base_line_pos
= BUF_BEGV (b
);
23322 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23323 || linepos
== BUF_BEGV (b
))
23325 ptrdiff_t limit
= BUF_BEGV (b
);
23326 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23327 ptrdiff_t position
;
23328 ptrdiff_t distance
=
23329 (height
* 2 + 30) * line_number_display_limit_width
;
23331 if (startpos
- distance
> limit
)
23333 limit
= startpos
- distance
;
23334 limit_byte
= CHAR_TO_BYTE (limit
);
23337 nlines
= display_count_lines (startpos_byte
,
23339 - (height
* 2 + 30),
23341 /* If we couldn't find the lines we wanted within
23342 line_number_display_limit_width chars per line,
23343 give up on line numbers for this window. */
23344 if (position
== limit_byte
&& limit
== startpos
- distance
)
23346 w
->base_line_pos
= -1;
23347 w
->base_line_number
= 0;
23351 w
->base_line_number
= topline
- nlines
;
23352 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23355 /* Now count lines from the start pos to point. */
23356 nlines
= display_count_lines (startpos_byte
,
23357 PT_BYTE
, PT
, &junk
);
23359 /* Record that we did display the line number. */
23360 line_number_displayed
= true;
23362 /* Make the string to show. */
23363 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23364 return decode_mode_spec_buf
;
23367 char *p
= decode_mode_spec_buf
;
23368 int pad
= width
- 2;
23374 return decode_mode_spec_buf
;
23380 obj
= BVAR (b
, mode_name
);
23384 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23390 ptrdiff_t pos
= marker_position (w
->start
);
23391 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23393 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23395 if (pos
<= BUF_BEGV (b
))
23400 else if (pos
<= BUF_BEGV (b
))
23404 if (total
> 1000000)
23405 /* Do it differently for a large value, to avoid overflow. */
23406 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23408 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23409 /* We can't normally display a 3-digit number,
23410 so get us a 2-digit number that is close. */
23413 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23414 return decode_mode_spec_buf
;
23418 /* Display percentage of size above the bottom of the screen. */
23421 ptrdiff_t toppos
= marker_position (w
->start
);
23422 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23423 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23425 if (botpos
>= BUF_ZV (b
))
23427 if (toppos
<= BUF_BEGV (b
))
23434 if (total
> 1000000)
23435 /* Do it differently for a large value, to avoid overflow. */
23436 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23438 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23439 /* We can't normally display a 3-digit number,
23440 so get us a 2-digit number that is close. */
23443 if (toppos
<= BUF_BEGV (b
))
23444 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23446 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23447 return decode_mode_spec_buf
;
23452 /* status of process */
23453 obj
= Fget_buffer_process (Fcurrent_buffer ());
23455 return "no process";
23457 obj
= Fsymbol_name (Fprocess_status (obj
));
23463 ptrdiff_t count
= inhibit_garbage_collection ();
23464 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23465 Lisp_Object val
= Qnil
;
23467 if (STRINGP (curdir
))
23468 val
= call1 (intern ("file-remote-p"), curdir
);
23470 unbind_to (count
, Qnil
);
23479 /* coding-system (not including end-of-line format) */
23481 /* coding-system (including end-of-line type) */
23483 bool eol_flag
= (c
== 'Z');
23484 char *p
= decode_mode_spec_buf
;
23486 if (! FRAME_WINDOW_P (f
))
23488 /* No need to mention EOL here--the terminal never needs
23489 to do EOL conversion. */
23490 p
= decode_mode_spec_coding (CODING_ID_NAME
23491 (FRAME_KEYBOARD_CODING (f
)->id
),
23493 p
= decode_mode_spec_coding (CODING_ID_NAME
23494 (FRAME_TERMINAL_CODING (f
)->id
),
23497 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23500 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23501 #ifdef subprocesses
23502 obj
= Fget_buffer_process (Fcurrent_buffer ());
23503 if (PROCESSP (obj
))
23505 p
= decode_mode_spec_coding
23506 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23507 p
= decode_mode_spec_coding
23508 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23510 #endif /* subprocesses */
23513 return decode_mode_spec_buf
;
23520 return SSDATA (obj
);
23527 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23528 means count lines back from START_BYTE. But don't go beyond
23529 LIMIT_BYTE. Return the number of lines thus found (always
23532 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23533 either the position COUNT lines after/before START_BYTE, if we
23534 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23538 display_count_lines (ptrdiff_t start_byte
,
23539 ptrdiff_t limit_byte
, ptrdiff_t count
,
23540 ptrdiff_t *byte_pos_ptr
)
23542 register unsigned char *cursor
;
23543 unsigned char *base
;
23545 register ptrdiff_t ceiling
;
23546 register unsigned char *ceiling_addr
;
23547 ptrdiff_t orig_count
= count
;
23549 /* If we are not in selective display mode,
23550 check only for newlines. */
23551 bool selective_display
23552 = (!NILP (BVAR (current_buffer
, selective_display
))
23553 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23557 while (start_byte
< limit_byte
)
23559 ceiling
= BUFFER_CEILING_OF (start_byte
);
23560 ceiling
= min (limit_byte
- 1, ceiling
);
23561 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23562 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23566 if (selective_display
)
23568 while (*cursor
!= '\n' && *cursor
!= 015
23569 && ++cursor
!= ceiling_addr
)
23571 if (cursor
== ceiling_addr
)
23576 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23585 start_byte
+= cursor
- base
;
23586 *byte_pos_ptr
= start_byte
;
23590 while (cursor
< ceiling_addr
);
23592 start_byte
+= ceiling_addr
- base
;
23597 while (start_byte
> limit_byte
)
23599 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23600 ceiling
= max (limit_byte
, ceiling
);
23601 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23602 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23605 if (selective_display
)
23607 while (--cursor
>= ceiling_addr
23608 && *cursor
!= '\n' && *cursor
!= 015)
23610 if (cursor
< ceiling_addr
)
23615 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23622 start_byte
+= cursor
- base
+ 1;
23623 *byte_pos_ptr
= start_byte
;
23624 /* When scanning backwards, we should
23625 not count the newline posterior to which we stop. */
23626 return - orig_count
- 1;
23629 start_byte
+= ceiling_addr
- base
;
23633 *byte_pos_ptr
= limit_byte
;
23636 return - orig_count
+ count
;
23637 return orig_count
- count
;
23643 /***********************************************************************
23645 ***********************************************************************/
23647 /* Display a NUL-terminated string, starting with index START.
23649 If STRING is non-null, display that C string. Otherwise, the Lisp
23650 string LISP_STRING is displayed. There's a case that STRING is
23651 non-null and LISP_STRING is not nil. It means STRING is a string
23652 data of LISP_STRING. In that case, we display LISP_STRING while
23653 ignoring its text properties.
23655 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23656 FACE_STRING. Display STRING or LISP_STRING with the face at
23657 FACE_STRING_POS in FACE_STRING:
23659 Display the string in the environment given by IT, but use the
23660 standard display table, temporarily.
23662 FIELD_WIDTH is the minimum number of output glyphs to produce.
23663 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23664 with spaces. If STRING has more characters, more than FIELD_WIDTH
23665 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23667 PRECISION is the maximum number of characters to output from
23668 STRING. PRECISION < 0 means don't truncate the string.
23670 This is roughly equivalent to printf format specifiers:
23672 FIELD_WIDTH PRECISION PRINTF
23673 ----------------------------------------
23679 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23680 display them, and < 0 means obey the current buffer's value of
23681 enable_multibyte_characters.
23683 Value is the number of columns displayed. */
23686 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23687 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23688 int field_width
, int precision
, int max_x
, int multibyte
)
23690 int hpos_at_start
= it
->hpos
;
23691 int saved_face_id
= it
->face_id
;
23692 struct glyph_row
*row
= it
->glyph_row
;
23693 ptrdiff_t it_charpos
;
23695 /* Initialize the iterator IT for iteration over STRING beginning
23696 with index START. */
23697 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23698 precision
, field_width
, multibyte
);
23699 if (string
&& STRINGP (lisp_string
))
23700 /* LISP_STRING is the one returned by decode_mode_spec. We should
23701 ignore its text properties. */
23702 it
->stop_charpos
= it
->end_charpos
;
23704 /* If displaying STRING, set up the face of the iterator from
23705 FACE_STRING, if that's given. */
23706 if (STRINGP (face_string
))
23712 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23713 0, &endptr
, it
->base_face_id
, false);
23714 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23715 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23718 /* Set max_x to the maximum allowed X position. Don't let it go
23719 beyond the right edge of the window. */
23721 max_x
= it
->last_visible_x
;
23723 max_x
= min (max_x
, it
->last_visible_x
);
23725 /* Skip over display elements that are not visible. because IT->w is
23727 if (it
->current_x
< it
->first_visible_x
)
23728 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23729 MOVE_TO_POS
| MOVE_TO_X
);
23731 row
->ascent
= it
->max_ascent
;
23732 row
->height
= it
->max_ascent
+ it
->max_descent
;
23733 row
->phys_ascent
= it
->max_phys_ascent
;
23734 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23735 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23737 if (STRINGP (it
->string
))
23738 it_charpos
= IT_STRING_CHARPOS (*it
);
23740 it_charpos
= IT_CHARPOS (*it
);
23742 /* This condition is for the case that we are called with current_x
23743 past last_visible_x. */
23744 while (it
->current_x
< max_x
)
23746 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23748 /* Get the next display element. */
23749 if (!get_next_display_element (it
))
23752 /* Produce glyphs. */
23753 x_before
= it
->current_x
;
23754 n_glyphs_before
= row
->used
[TEXT_AREA
];
23755 PRODUCE_GLYPHS (it
);
23757 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23760 while (i
< nglyphs
)
23762 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23764 if (it
->line_wrap
!= TRUNCATE
23765 && x
+ glyph
->pixel_width
> max_x
)
23767 /* End of continued line or max_x reached. */
23768 if (CHAR_GLYPH_PADDING_P (*glyph
))
23770 /* A wide character is unbreakable. */
23771 if (row
->reversed_p
)
23772 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23773 - n_glyphs_before
);
23774 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23775 it
->current_x
= x_before
;
23779 if (row
->reversed_p
)
23780 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23781 - (n_glyphs_before
+ i
));
23782 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23787 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23789 /* Glyph is at least partially visible. */
23791 if (x
< it
->first_visible_x
)
23792 row
->x
= x
- it
->first_visible_x
;
23796 /* Glyph is off the left margin of the display area.
23797 Should not happen. */
23801 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23802 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23803 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23804 row
->phys_height
= max (row
->phys_height
,
23805 it
->max_phys_ascent
+ it
->max_phys_descent
);
23806 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23807 it
->max_extra_line_spacing
);
23808 x
+= glyph
->pixel_width
;
23812 /* Stop if max_x reached. */
23816 /* Stop at line ends. */
23817 if (ITERATOR_AT_END_OF_LINE_P (it
))
23819 it
->continuation_lines_width
= 0;
23823 set_iterator_to_next (it
, true);
23824 if (STRINGP (it
->string
))
23825 it_charpos
= IT_STRING_CHARPOS (*it
);
23827 it_charpos
= IT_CHARPOS (*it
);
23829 /* Stop if truncating at the right edge. */
23830 if (it
->line_wrap
== TRUNCATE
23831 && it
->current_x
>= it
->last_visible_x
)
23833 /* Add truncation mark, but don't do it if the line is
23834 truncated at a padding space. */
23835 if (it_charpos
< it
->string_nchars
)
23837 if (!FRAME_WINDOW_P (it
->f
))
23841 if (it
->current_x
> it
->last_visible_x
)
23843 if (!row
->reversed_p
)
23845 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23846 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23851 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23852 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23854 unproduce_glyphs (it
, ii
+ 1);
23855 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23857 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23859 row
->used
[TEXT_AREA
] = ii
;
23860 produce_special_glyphs (it
, IT_TRUNCATION
);
23863 produce_special_glyphs (it
, IT_TRUNCATION
);
23865 row
->truncated_on_right_p
= true;
23871 /* Maybe insert a truncation at the left. */
23872 if (it
->first_visible_x
23875 if (!FRAME_WINDOW_P (it
->f
)
23876 || (row
->reversed_p
23877 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23878 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23879 insert_left_trunc_glyphs (it
);
23880 row
->truncated_on_left_p
= true;
23883 it
->face_id
= saved_face_id
;
23885 /* Value is number of columns displayed. */
23886 return it
->hpos
- hpos_at_start
;
23891 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23892 appears as an element of LIST or as the car of an element of LIST.
23893 If PROPVAL is a list, compare each element against LIST in that
23894 way, and return 1/2 if any element of PROPVAL is found in LIST.
23895 Otherwise return 0. This function cannot quit.
23896 The return value is 2 if the text is invisible but with an ellipsis
23897 and 1 if it's invisible and without an ellipsis. */
23900 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23902 Lisp_Object tail
, proptail
;
23904 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23906 register Lisp_Object tem
;
23908 if (EQ (propval
, tem
))
23910 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23911 return NILP (XCDR (tem
)) ? 1 : 2;
23914 if (CONSP (propval
))
23916 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23918 Lisp_Object propelt
;
23919 propelt
= XCAR (proptail
);
23920 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23922 register Lisp_Object tem
;
23924 if (EQ (propelt
, tem
))
23926 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23927 return NILP (XCDR (tem
)) ? 1 : 2;
23935 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23936 doc
: /* Non-nil if the property makes the text invisible.
23937 POS-OR-PROP can be a marker or number, in which case it is taken to be
23938 a position in the current buffer and the value of the `invisible' property
23939 is checked; or it can be some other value, which is then presumed to be the
23940 value of the `invisible' property of the text of interest.
23941 The non-nil value returned can be t for truly invisible text or something
23942 else if the text is replaced by an ellipsis. */)
23943 (Lisp_Object pos_or_prop
)
23946 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23947 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23949 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23950 return (invis
== 0 ? Qnil
23952 : make_number (invis
));
23955 /* Calculate a width or height in pixels from a specification using
23956 the following elements:
23959 NUM - a (fractional) multiple of the default font width/height
23960 (NUM) - specifies exactly NUM pixels
23961 UNIT - a fixed number of pixels, see below.
23962 ELEMENT - size of a display element in pixels, see below.
23963 (NUM . SPEC) - equals NUM * SPEC
23964 (+ SPEC SPEC ...) - add pixel values
23965 (- SPEC SPEC ...) - subtract pixel values
23966 (- SPEC) - negate pixel value
23969 INT or FLOAT - a number constant
23970 SYMBOL - use symbol's (buffer local) variable binding.
23973 in - pixels per inch *)
23974 mm - pixels per 1/1000 meter *)
23975 cm - pixels per 1/100 meter *)
23976 width - width of current font in pixels.
23977 height - height of current font in pixels.
23979 *) using the ratio(s) defined in display-pixels-per-inch.
23983 left-fringe - left fringe width in pixels
23984 right-fringe - right fringe width in pixels
23986 left-margin - left margin width in pixels
23987 right-margin - right margin width in pixels
23989 scroll-bar - scroll-bar area width in pixels
23993 Pixels corresponding to 5 inches:
23996 Total width of non-text areas on left side of window (if scroll-bar is on left):
23997 '(space :width (+ left-fringe left-margin scroll-bar))
23999 Align to first text column (in header line):
24000 '(space :align-to 0)
24002 Align to middle of text area minus half the width of variable `my-image'
24003 containing a loaded image:
24004 '(space :align-to (0.5 . (- text my-image)))
24006 Width of left margin minus width of 1 character in the default font:
24007 '(space :width (- left-margin 1))
24009 Width of left margin minus width of 2 characters in the current font:
24010 '(space :width (- left-margin (2 . width)))
24012 Center 1 character over left-margin (in header line):
24013 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24015 Different ways to express width of left fringe plus left margin minus one pixel:
24016 '(space :width (- (+ left-fringe left-margin) (1)))
24017 '(space :width (+ left-fringe left-margin (- (1))))
24018 '(space :width (+ left-fringe left-margin (-1)))
24023 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24024 struct font
*font
, bool width_p
, int *align_to
)
24028 # define OK_PIXELS(val) (*res = (val), true)
24029 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24032 return OK_PIXELS (0);
24034 eassert (FRAME_LIVE_P (it
->f
));
24036 if (SYMBOLP (prop
))
24038 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24040 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24042 if (unit
[0] == 'i' && unit
[1] == 'n')
24044 else if (unit
[0] == 'm' && unit
[1] == 'm')
24046 else if (unit
[0] == 'c' && unit
[1] == 'm')
24052 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24053 : FRAME_RES_Y (it
->f
));
24056 return OK_PIXELS (ppi
/ pixels
);
24061 #ifdef HAVE_WINDOW_SYSTEM
24062 if (EQ (prop
, Qheight
))
24063 return OK_PIXELS (font
24064 ? normal_char_height (font
, -1)
24065 : FRAME_LINE_HEIGHT (it
->f
));
24066 if (EQ (prop
, Qwidth
))
24067 return OK_PIXELS (font
24068 ? FONT_WIDTH (font
)
24069 : FRAME_COLUMN_WIDTH (it
->f
));
24071 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24072 return OK_PIXELS (1);
24075 if (EQ (prop
, Qtext
))
24076 return OK_PIXELS (width_p
24077 ? window_box_width (it
->w
, TEXT_AREA
)
24078 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24080 if (align_to
&& *align_to
< 0)
24083 if (EQ (prop
, Qleft
))
24084 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24085 if (EQ (prop
, Qright
))
24086 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24087 if (EQ (prop
, Qcenter
))
24088 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24089 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24090 if (EQ (prop
, Qleft_fringe
))
24091 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24092 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24093 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24094 if (EQ (prop
, Qright_fringe
))
24095 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24096 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24097 : window_box_right_offset (it
->w
, TEXT_AREA
));
24098 if (EQ (prop
, Qleft_margin
))
24099 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24100 if (EQ (prop
, Qright_margin
))
24101 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24102 if (EQ (prop
, Qscroll_bar
))
24103 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24105 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24106 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24107 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24112 if (EQ (prop
, Qleft_fringe
))
24113 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24114 if (EQ (prop
, Qright_fringe
))
24115 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24116 if (EQ (prop
, Qleft_margin
))
24117 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24118 if (EQ (prop
, Qright_margin
))
24119 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24120 if (EQ (prop
, Qscroll_bar
))
24121 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24124 prop
= buffer_local_value (prop
, it
->w
->contents
);
24125 if (EQ (prop
, Qunbound
))
24129 if (NUMBERP (prop
))
24131 int base_unit
= (width_p
24132 ? FRAME_COLUMN_WIDTH (it
->f
)
24133 : FRAME_LINE_HEIGHT (it
->f
));
24134 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24139 Lisp_Object car
= XCAR (prop
);
24140 Lisp_Object cdr
= XCDR (prop
);
24144 #ifdef HAVE_WINDOW_SYSTEM
24145 if (FRAME_WINDOW_P (it
->f
)
24146 && valid_image_p (prop
))
24148 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24149 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24151 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24154 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24160 while (CONSP (cdr
))
24162 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24163 font
, width_p
, align_to
))
24166 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24171 if (EQ (car
, Qminus
))
24173 return OK_PIXELS (pixels
);
24176 car
= buffer_local_value (car
, it
->w
->contents
);
24177 if (EQ (car
, Qunbound
))
24184 pixels
= XFLOATINT (car
);
24186 return OK_PIXELS (pixels
);
24187 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24188 font
, width_p
, align_to
))
24189 return OK_PIXELS (pixels
* fact
);
24200 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24202 #ifdef HAVE_WINDOW_SYSTEM
24203 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24211 /***********************************************************************
24213 ***********************************************************************/
24215 #ifdef HAVE_WINDOW_SYSTEM
24220 dump_glyph_string (struct glyph_string
*s
)
24222 fprintf (stderr
, "glyph string\n");
24223 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24224 s
->x
, s
->y
, s
->width
, s
->height
);
24225 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24226 fprintf (stderr
, " hl = %d\n", s
->hl
);
24227 fprintf (stderr
, " left overhang = %d, right = %d\n",
24228 s
->left_overhang
, s
->right_overhang
);
24229 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24230 fprintf (stderr
, " extends to end of line = %d\n",
24231 s
->extends_to_end_of_line_p
);
24232 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24233 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24236 #endif /* GLYPH_DEBUG */
24238 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24239 of XChar2b structures for S; it can't be allocated in
24240 init_glyph_string because it must be allocated via `alloca'. W
24241 is the window on which S is drawn. ROW and AREA are the glyph row
24242 and area within the row from which S is constructed. START is the
24243 index of the first glyph structure covered by S. HL is a
24244 face-override for drawing S. */
24247 #define OPTIONAL_HDC(hdc) HDC hdc,
24248 #define DECLARE_HDC(hdc) HDC hdc;
24249 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24250 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24253 #ifndef OPTIONAL_HDC
24254 #define OPTIONAL_HDC(hdc)
24255 #define DECLARE_HDC(hdc)
24256 #define ALLOCATE_HDC(hdc, f)
24257 #define RELEASE_HDC(hdc, f)
24261 init_glyph_string (struct glyph_string
*s
,
24263 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24264 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24266 memset (s
, 0, sizeof *s
);
24268 s
->f
= XFRAME (w
->frame
);
24272 s
->display
= FRAME_X_DISPLAY (s
->f
);
24273 s
->window
= FRAME_X_WINDOW (s
->f
);
24274 s
->char2b
= char2b
;
24278 s
->first_glyph
= row
->glyphs
[area
] + start
;
24279 s
->height
= row
->height
;
24280 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24281 s
->ybase
= s
->y
+ row
->ascent
;
24285 /* Append the list of glyph strings with head H and tail T to the list
24286 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24289 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24290 struct glyph_string
*h
, struct glyph_string
*t
)
24304 /* Prepend the list of glyph strings with head H and tail T to the
24305 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24309 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24310 struct glyph_string
*h
, struct glyph_string
*t
)
24324 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24325 Set *HEAD and *TAIL to the resulting list. */
24328 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24329 struct glyph_string
*s
)
24331 s
->next
= s
->prev
= NULL
;
24332 append_glyph_string_lists (head
, tail
, s
, s
);
24336 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24337 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24338 make sure that X resources for the face returned are allocated.
24339 Value is a pointer to a realized face that is ready for display if
24342 static struct face
*
24343 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24344 XChar2b
*char2b
, bool display_p
)
24346 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24351 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24353 if (code
== FONT_INVALID_CODE
)
24356 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24358 /* Make sure X resources of the face are allocated. */
24359 #ifdef HAVE_X_WINDOWS
24363 eassert (face
!= NULL
);
24364 prepare_face_for_display (f
, face
);
24371 /* Get face and two-byte form of character glyph GLYPH on frame F.
24372 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24373 a pointer to a realized face that is ready for display. */
24375 static struct face
*
24376 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24382 eassert (glyph
->type
== CHAR_GLYPH
);
24383 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24385 /* Make sure X resources of the face are allocated. */
24386 eassert (face
!= NULL
);
24387 prepare_face_for_display (f
, face
);
24391 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24392 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24394 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24396 if (code
== FONT_INVALID_CODE
)
24400 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24405 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24406 Return true iff FONT has a glyph for C. */
24409 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24413 if (CHAR_BYTE8_P (c
))
24414 code
= CHAR_TO_BYTE8 (c
);
24416 code
= font
->driver
->encode_char (font
, c
);
24418 if (code
== FONT_INVALID_CODE
)
24420 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24425 /* Fill glyph string S with composition components specified by S->cmp.
24427 BASE_FACE is the base face of the composition.
24428 S->cmp_from is the index of the first component for S.
24430 OVERLAPS non-zero means S should draw the foreground only, and use
24431 its physical height for clipping. See also draw_glyphs.
24433 Value is the index of a component not in S. */
24436 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24440 /* For all glyphs of this composition, starting at the offset
24441 S->cmp_from, until we reach the end of the definition or encounter a
24442 glyph that requires the different face, add it to S. */
24447 s
->for_overlaps
= overlaps
;
24450 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24452 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24454 /* TAB in a composition means display glyphs with padding space
24455 on the left or right. */
24458 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24461 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24462 s
->char2b
+ i
, true);
24468 s
->font
= s
->face
->font
;
24470 else if (s
->face
!= face
)
24478 if (s
->face
== NULL
)
24480 s
->face
= base_face
->ascii_face
;
24481 s
->font
= s
->face
->font
;
24484 /* All glyph strings for the same composition has the same width,
24485 i.e. the width set for the first component of the composition. */
24486 s
->width
= s
->first_glyph
->pixel_width
;
24488 /* If the specified font could not be loaded, use the frame's
24489 default font, but record the fact that we couldn't load it in
24490 the glyph string so that we can draw rectangles for the
24491 characters of the glyph string. */
24492 if (s
->font
== NULL
)
24494 s
->font_not_found_p
= true;
24495 s
->font
= FRAME_FONT (s
->f
);
24498 /* Adjust base line for subscript/superscript text. */
24499 s
->ybase
+= s
->first_glyph
->voffset
;
24505 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24506 int start
, int end
, int overlaps
)
24508 struct glyph
*glyph
, *last
;
24509 Lisp_Object lgstring
;
24512 s
->for_overlaps
= overlaps
;
24513 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24514 last
= s
->row
->glyphs
[s
->area
] + end
;
24515 s
->cmp_id
= glyph
->u
.cmp
.id
;
24516 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24517 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24518 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24519 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24520 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24522 while (glyph
< last
24523 && glyph
->u
.cmp
.automatic
24524 && glyph
->u
.cmp
.id
== s
->cmp_id
24525 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24526 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24528 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24530 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24531 unsigned code
= LGLYPH_CODE (lglyph
);
24533 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24535 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24536 return glyph
- s
->row
->glyphs
[s
->area
];
24540 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24541 See the comment of fill_glyph_string for arguments.
24542 Value is the index of the first glyph not in S. */
24546 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24547 int start
, int end
, int overlaps
)
24549 struct glyph
*glyph
, *last
;
24552 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24553 s
->for_overlaps
= overlaps
;
24554 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24555 last
= s
->row
->glyphs
[s
->area
] + end
;
24556 voffset
= glyph
->voffset
;
24557 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24558 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24560 s
->width
= glyph
->pixel_width
;
24562 while (glyph
< last
24563 && glyph
->type
== GLYPHLESS_GLYPH
24564 && glyph
->voffset
== voffset
24565 && glyph
->face_id
== face_id
)
24568 s
->width
+= glyph
->pixel_width
;
24571 s
->ybase
+= voffset
;
24572 return glyph
- s
->row
->glyphs
[s
->area
];
24576 /* Fill glyph string S from a sequence of character glyphs.
24578 FACE_ID is the face id of the string. START is the index of the
24579 first glyph to consider, END is the index of the last + 1.
24580 OVERLAPS non-zero means S should draw the foreground only, and use
24581 its physical height for clipping. See also draw_glyphs.
24583 Value is the index of the first glyph not in S. */
24586 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24587 int start
, int end
, int overlaps
)
24589 struct glyph
*glyph
, *last
;
24591 bool glyph_not_available_p
;
24593 eassert (s
->f
== XFRAME (s
->w
->frame
));
24594 eassert (s
->nchars
== 0);
24595 eassert (start
>= 0 && end
> start
);
24597 s
->for_overlaps
= overlaps
;
24598 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24599 last
= s
->row
->glyphs
[s
->area
] + end
;
24600 voffset
= glyph
->voffset
;
24601 s
->padding_p
= glyph
->padding_p
;
24602 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24604 while (glyph
< last
24605 && glyph
->type
== CHAR_GLYPH
24606 && glyph
->voffset
== voffset
24607 /* Same face id implies same font, nowadays. */
24608 && glyph
->face_id
== face_id
24609 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24611 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24612 s
->char2b
+ s
->nchars
);
24614 eassert (s
->nchars
<= end
- start
);
24615 s
->width
+= glyph
->pixel_width
;
24616 if (glyph
++->padding_p
!= s
->padding_p
)
24620 s
->font
= s
->face
->font
;
24622 /* If the specified font could not be loaded, use the frame's font,
24623 but record the fact that we couldn't load it in
24624 S->font_not_found_p so that we can draw rectangles for the
24625 characters of the glyph string. */
24626 if (s
->font
== NULL
|| glyph_not_available_p
)
24628 s
->font_not_found_p
= true;
24629 s
->font
= FRAME_FONT (s
->f
);
24632 /* Adjust base line for subscript/superscript text. */
24633 s
->ybase
+= voffset
;
24635 eassert (s
->face
&& s
->face
->gc
);
24636 return glyph
- s
->row
->glyphs
[s
->area
];
24640 /* Fill glyph string S from image glyph S->first_glyph. */
24643 fill_image_glyph_string (struct glyph_string
*s
)
24645 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24646 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24648 s
->slice
= s
->first_glyph
->slice
.img
;
24649 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24650 s
->font
= s
->face
->font
;
24651 s
->width
= s
->first_glyph
->pixel_width
;
24653 /* Adjust base line for subscript/superscript text. */
24654 s
->ybase
+= s
->first_glyph
->voffset
;
24658 /* Fill glyph string S from a sequence of stretch glyphs.
24660 START is the index of the first glyph to consider,
24661 END is the index of the last + 1.
24663 Value is the index of the first glyph not in S. */
24666 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24668 struct glyph
*glyph
, *last
;
24669 int voffset
, face_id
;
24671 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24673 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24674 last
= s
->row
->glyphs
[s
->area
] + end
;
24675 face_id
= glyph
->face_id
;
24676 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24677 s
->font
= s
->face
->font
;
24678 s
->width
= glyph
->pixel_width
;
24680 voffset
= glyph
->voffset
;
24684 && glyph
->type
== STRETCH_GLYPH
24685 && glyph
->voffset
== voffset
24686 && glyph
->face_id
== face_id
);
24688 s
->width
+= glyph
->pixel_width
;
24690 /* Adjust base line for subscript/superscript text. */
24691 s
->ybase
+= voffset
;
24693 /* The case that face->gc == 0 is handled when drawing the glyph
24694 string by calling prepare_face_for_display. */
24696 return glyph
- s
->row
->glyphs
[s
->area
];
24699 static struct font_metrics
*
24700 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24702 static struct font_metrics metrics
;
24707 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24708 if (code
== FONT_INVALID_CODE
)
24710 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24714 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24715 for FONT. Values are taken from font-global ones, except for fonts
24716 that claim preposterously large values, but whose glyphs actually
24717 have reasonable dimensions. C is the character to use for metrics
24718 if the font-global values are too large; if C is negative, the
24719 function selects a default character. */
24721 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24723 *ascent
= FONT_BASE (font
);
24724 *descent
= FONT_DESCENT (font
);
24726 if (FONT_TOO_HIGH (font
))
24730 /* Get metrics of C, defaulting to a reasonably sized ASCII
24732 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24734 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24736 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24738 /* We add 1 pixel to character dimensions as heuristics
24739 that produces nicer display, e.g. when the face has
24740 the box attribute. */
24741 *ascent
= pcm
->ascent
+ 1;
24742 *descent
= pcm
->descent
+ 1;
24748 /* A subroutine that computes a reasonable "normal character height"
24749 for fonts that claim preposterously large vertical dimensions, but
24750 whose glyphs are actually reasonably sized. C is the character
24751 whose metrics to use for those fonts, or -1 for default
24754 normal_char_height (struct font
*font
, int c
)
24756 int ascent
, descent
;
24758 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24760 return ascent
+ descent
;
24764 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24765 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24766 assumed to be zero. */
24769 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24771 *left
= *right
= 0;
24773 if (glyph
->type
== CHAR_GLYPH
)
24776 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24779 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24782 if (pcm
->rbearing
> pcm
->width
)
24783 *right
= pcm
->rbearing
- pcm
->width
;
24784 if (pcm
->lbearing
< 0)
24785 *left
= -pcm
->lbearing
;
24789 else if (glyph
->type
== COMPOSITE_GLYPH
)
24791 if (! glyph
->u
.cmp
.automatic
)
24793 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24795 if (cmp
->rbearing
> cmp
->pixel_width
)
24796 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24797 if (cmp
->lbearing
< 0)
24798 *left
= - cmp
->lbearing
;
24802 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24803 struct font_metrics metrics
;
24805 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24806 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24807 if (metrics
.rbearing
> metrics
.width
)
24808 *right
= metrics
.rbearing
- metrics
.width
;
24809 if (metrics
.lbearing
< 0)
24810 *left
= - metrics
.lbearing
;
24816 /* Return the index of the first glyph preceding glyph string S that
24817 is overwritten by S because of S's left overhang. Value is -1
24818 if no glyphs are overwritten. */
24821 left_overwritten (struct glyph_string
*s
)
24825 if (s
->left_overhang
)
24828 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24829 int first
= s
->first_glyph
- glyphs
;
24831 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24832 x
-= glyphs
[i
].pixel_width
;
24843 /* Return the index of the first glyph preceding glyph string S that
24844 is overwriting S because of its right overhang. Value is -1 if no
24845 glyph in front of S overwrites S. */
24848 left_overwriting (struct glyph_string
*s
)
24851 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24852 int first
= s
->first_glyph
- glyphs
;
24856 for (i
= first
- 1; i
>= 0; --i
)
24859 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24862 x
-= glyphs
[i
].pixel_width
;
24869 /* Return the index of the last glyph following glyph string S that is
24870 overwritten by S because of S's right overhang. Value is -1 if
24871 no such glyph is found. */
24874 right_overwritten (struct glyph_string
*s
)
24878 if (s
->right_overhang
)
24881 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24882 int first
= (s
->first_glyph
- glyphs
24883 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24884 int end
= s
->row
->used
[s
->area
];
24886 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24887 x
+= glyphs
[i
].pixel_width
;
24896 /* Return the index of the last glyph following glyph string S that
24897 overwrites S because of its left overhang. Value is negative
24898 if no such glyph is found. */
24901 right_overwriting (struct glyph_string
*s
)
24904 int end
= s
->row
->used
[s
->area
];
24905 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24906 int first
= (s
->first_glyph
- glyphs
24907 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24911 for (i
= first
; i
< end
; ++i
)
24914 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24917 x
+= glyphs
[i
].pixel_width
;
24924 /* Set background width of glyph string S. START is the index of the
24925 first glyph following S. LAST_X is the right-most x-position + 1
24926 in the drawing area. */
24929 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24931 /* If the face of this glyph string has to be drawn to the end of
24932 the drawing area, set S->extends_to_end_of_line_p. */
24934 if (start
== s
->row
->used
[s
->area
]
24935 && ((s
->row
->fill_line_p
24936 && (s
->hl
== DRAW_NORMAL_TEXT
24937 || s
->hl
== DRAW_IMAGE_RAISED
24938 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24939 || s
->hl
== DRAW_MOUSE_FACE
))
24940 s
->extends_to_end_of_line_p
= true;
24942 /* If S extends its face to the end of the line, set its
24943 background_width to the distance to the right edge of the drawing
24945 if (s
->extends_to_end_of_line_p
)
24946 s
->background_width
= last_x
- s
->x
+ 1;
24948 s
->background_width
= s
->width
;
24952 /* Compute overhangs and x-positions for glyph string S and its
24953 predecessors, or successors. X is the starting x-position for S.
24954 BACKWARD_P means process predecessors. */
24957 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
24963 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24964 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24974 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24975 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24985 /* The following macros are only called from draw_glyphs below.
24986 They reference the following parameters of that function directly:
24987 `w', `row', `area', and `overlap_p'
24988 as well as the following local variables:
24989 `s', `f', and `hdc' (in W32) */
24992 /* On W32, silently add local `hdc' variable to argument list of
24993 init_glyph_string. */
24994 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24995 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24997 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24998 init_glyph_string (s, char2b, w, row, area, start, hl)
25001 /* Add a glyph string for a stretch glyph to the list of strings
25002 between HEAD and TAIL. START is the index of the stretch glyph in
25003 row area AREA of glyph row ROW. END is the index of the last glyph
25004 in that glyph row area. X is the current output position assigned
25005 to the new glyph string constructed. HL overrides that face of the
25006 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25007 is the right-most x-position of the drawing area. */
25009 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25010 and below -- keep them on one line. */
25011 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25014 s = alloca (sizeof *s); \
25015 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25016 START = fill_stretch_glyph_string (s, START, END); \
25017 append_glyph_string (&HEAD, &TAIL, s); \
25023 /* Add a glyph string for an image glyph to the list of strings
25024 between HEAD and TAIL. START is the index of the image glyph in
25025 row area AREA of glyph row ROW. END is the index of the last glyph
25026 in that glyph row area. X is the current output position assigned
25027 to the new glyph string constructed. HL overrides that face of the
25028 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25029 is the right-most x-position of the drawing area. */
25031 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25034 s = alloca (sizeof *s); \
25035 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25036 fill_image_glyph_string (s); \
25037 append_glyph_string (&HEAD, &TAIL, s); \
25044 /* Add a glyph string for a sequence of character glyphs to the list
25045 of strings between HEAD and TAIL. START is the index of the first
25046 glyph in row area AREA of glyph row ROW that is part of the new
25047 glyph string. END is the index of the last glyph in that glyph row
25048 area. X is the current output position assigned to the new glyph
25049 string constructed. HL overrides that face of the glyph; e.g. it
25050 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25051 right-most x-position of the drawing area. */
25053 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25059 face_id = (row)->glyphs[area][START].face_id; \
25061 s = alloca (sizeof *s); \
25062 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25063 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25064 append_glyph_string (&HEAD, &TAIL, s); \
25066 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25071 /* Add a glyph string for a composite sequence to the list of strings
25072 between HEAD and TAIL. START is the index of the first glyph in
25073 row area AREA of glyph row ROW that is part of the new glyph
25074 string. END is the index of the last glyph in that glyph row area.
25075 X is the current output position assigned to the new glyph string
25076 constructed. HL overrides that face of the glyph; e.g. it is
25077 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25078 x-position of the drawing area. */
25080 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25082 int face_id = (row)->glyphs[area][START].face_id; \
25083 struct face *base_face = FACE_FROM_ID (f, face_id); \
25084 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25085 struct composition *cmp = composition_table[cmp_id]; \
25087 struct glyph_string *first_s = NULL; \
25090 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25092 /* Make glyph_strings for each glyph sequence that is drawable by \
25093 the same face, and append them to HEAD/TAIL. */ \
25094 for (n = 0; n < cmp->glyph_len;) \
25096 s = alloca (sizeof *s); \
25097 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25098 append_glyph_string (&(HEAD), &(TAIL), s); \
25104 n = fill_composite_glyph_string (s, base_face, overlaps); \
25112 /* Add a glyph string for a glyph-string sequence to the list of strings
25113 between HEAD and TAIL. */
25115 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25119 Lisp_Object gstring; \
25121 face_id = (row)->glyphs[area][START].face_id; \
25122 gstring = (composition_gstring_from_id \
25123 ((row)->glyphs[area][START].u.cmp.id)); \
25124 s = alloca (sizeof *s); \
25125 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25126 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25127 append_glyph_string (&(HEAD), &(TAIL), s); \
25129 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25133 /* Add a glyph string for a sequence of glyphless character's glyphs
25134 to the list of strings between HEAD and TAIL. The meanings of
25135 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25137 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25142 face_id = (row)->glyphs[area][START].face_id; \
25144 s = alloca (sizeof *s); \
25145 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25146 append_glyph_string (&HEAD, &TAIL, s); \
25148 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25154 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25155 of AREA of glyph row ROW on window W between indices START and END.
25156 HL overrides the face for drawing glyph strings, e.g. it is
25157 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25158 x-positions of the drawing area.
25160 This is an ugly monster macro construct because we must use alloca
25161 to allocate glyph strings (because draw_glyphs can be called
25162 asynchronously). */
25164 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25167 HEAD = TAIL = NULL; \
25168 while (START < END) \
25170 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25171 switch (first_glyph->type) \
25174 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25178 case COMPOSITE_GLYPH: \
25179 if (first_glyph->u.cmp.automatic) \
25180 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25183 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25187 case STRETCH_GLYPH: \
25188 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25192 case IMAGE_GLYPH: \
25193 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25197 case GLYPHLESS_GLYPH: \
25198 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25208 set_glyph_string_background_width (s, START, LAST_X); \
25215 /* Draw glyphs between START and END in AREA of ROW on window W,
25216 starting at x-position X. X is relative to AREA in W. HL is a
25217 face-override with the following meaning:
25219 DRAW_NORMAL_TEXT draw normally
25220 DRAW_CURSOR draw in cursor face
25221 DRAW_MOUSE_FACE draw in mouse face.
25222 DRAW_INVERSE_VIDEO draw in mode line face
25223 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25224 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25226 If OVERLAPS is non-zero, draw only the foreground of characters and
25227 clip to the physical height of ROW. Non-zero value also defines
25228 the overlapping part to be drawn:
25230 OVERLAPS_PRED overlap with preceding rows
25231 OVERLAPS_SUCC overlap with succeeding rows
25232 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25233 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25235 Value is the x-position reached, relative to AREA of W. */
25238 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25239 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25240 enum draw_glyphs_face hl
, int overlaps
)
25242 struct glyph_string
*head
, *tail
;
25243 struct glyph_string
*s
;
25244 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25245 int i
, j
, x_reached
, last_x
, area_left
= 0;
25246 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25249 ALLOCATE_HDC (hdc
, f
);
25251 /* Let's rather be paranoid than getting a SEGV. */
25252 end
= min (end
, row
->used
[area
]);
25253 start
= clip_to_bounds (0, start
, end
);
25255 /* Translate X to frame coordinates. Set last_x to the right
25256 end of the drawing area. */
25257 if (row
->full_width_p
)
25259 /* X is relative to the left edge of W, without scroll bars
25261 area_left
= WINDOW_LEFT_EDGE_X (w
);
25262 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25263 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25267 area_left
= window_box_left (w
, area
);
25268 last_x
= area_left
+ window_box_width (w
, area
);
25272 /* Build a doubly-linked list of glyph_string structures between
25273 head and tail from what we have to draw. Note that the macro
25274 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25275 the reason we use a separate variable `i'. */
25278 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25280 x_reached
= tail
->x
+ tail
->background_width
;
25284 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25285 the row, redraw some glyphs in front or following the glyph
25286 strings built above. */
25287 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25289 struct glyph_string
*h
, *t
;
25290 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25291 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25292 bool check_mouse_face
= false;
25295 /* If mouse highlighting is on, we may need to draw adjacent
25296 glyphs using mouse-face highlighting. */
25297 if (area
== TEXT_AREA
&& row
->mouse_face_p
25298 && hlinfo
->mouse_face_beg_row
>= 0
25299 && hlinfo
->mouse_face_end_row
>= 0)
25301 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25303 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25304 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25306 check_mouse_face
= true;
25307 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25308 ? hlinfo
->mouse_face_beg_col
: 0;
25309 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25310 ? hlinfo
->mouse_face_end_col
25311 : row
->used
[TEXT_AREA
];
25315 /* Compute overhangs for all glyph strings. */
25316 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25317 for (s
= head
; s
; s
= s
->next
)
25318 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25320 /* Prepend glyph strings for glyphs in front of the first glyph
25321 string that are overwritten because of the first glyph
25322 string's left overhang. The background of all strings
25323 prepended must be drawn because the first glyph string
25325 i
= left_overwritten (head
);
25328 enum draw_glyphs_face overlap_hl
;
25330 /* If this row contains mouse highlighting, attempt to draw
25331 the overlapped glyphs with the correct highlight. This
25332 code fails if the overlap encompasses more than one glyph
25333 and mouse-highlight spans only some of these glyphs.
25334 However, making it work perfectly involves a lot more
25335 code, and I don't know if the pathological case occurs in
25336 practice, so we'll stick to this for now. --- cyd */
25337 if (check_mouse_face
25338 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25339 overlap_hl
= DRAW_MOUSE_FACE
;
25341 overlap_hl
= DRAW_NORMAL_TEXT
;
25343 if (hl
!= overlap_hl
)
25346 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25347 overlap_hl
, dummy_x
, last_x
);
25349 compute_overhangs_and_x (t
, head
->x
, true);
25350 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25351 if (clip_head
== NULL
)
25355 /* Prepend glyph strings for glyphs in front of the first glyph
25356 string that overwrite that glyph string because of their
25357 right overhang. For these strings, only the foreground must
25358 be drawn, because it draws over the glyph string at `head'.
25359 The background must not be drawn because this would overwrite
25360 right overhangs of preceding glyphs for which no glyph
25362 i
= left_overwriting (head
);
25365 enum draw_glyphs_face overlap_hl
;
25367 if (check_mouse_face
25368 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25369 overlap_hl
= DRAW_MOUSE_FACE
;
25371 overlap_hl
= DRAW_NORMAL_TEXT
;
25373 if (hl
== overlap_hl
|| clip_head
== NULL
)
25375 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25376 overlap_hl
, dummy_x
, last_x
);
25377 for (s
= h
; s
; s
= s
->next
)
25378 s
->background_filled_p
= true;
25379 compute_overhangs_and_x (t
, head
->x
, true);
25380 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25383 /* Append glyphs strings for glyphs following the last glyph
25384 string tail that are overwritten by tail. The background of
25385 these strings has to be drawn because tail's foreground draws
25387 i
= right_overwritten (tail
);
25390 enum draw_glyphs_face overlap_hl
;
25392 if (check_mouse_face
25393 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25394 overlap_hl
= DRAW_MOUSE_FACE
;
25396 overlap_hl
= DRAW_NORMAL_TEXT
;
25398 if (hl
!= overlap_hl
)
25400 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25401 overlap_hl
, x
, last_x
);
25402 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25403 we don't have `end = i;' here. */
25404 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25405 append_glyph_string_lists (&head
, &tail
, h
, t
);
25406 if (clip_tail
== NULL
)
25410 /* Append glyph strings for glyphs following the last glyph
25411 string tail that overwrite tail. The foreground of such
25412 glyphs has to be drawn because it writes into the background
25413 of tail. The background must not be drawn because it could
25414 paint over the foreground of following glyphs. */
25415 i
= right_overwriting (tail
);
25418 enum draw_glyphs_face overlap_hl
;
25419 if (check_mouse_face
25420 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25421 overlap_hl
= DRAW_MOUSE_FACE
;
25423 overlap_hl
= DRAW_NORMAL_TEXT
;
25425 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25427 i
++; /* We must include the Ith glyph. */
25428 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25429 overlap_hl
, x
, last_x
);
25430 for (s
= h
; s
; s
= s
->next
)
25431 s
->background_filled_p
= true;
25432 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25433 append_glyph_string_lists (&head
, &tail
, h
, t
);
25435 if (clip_head
|| clip_tail
)
25436 for (s
= head
; s
; s
= s
->next
)
25438 s
->clip_head
= clip_head
;
25439 s
->clip_tail
= clip_tail
;
25443 /* Draw all strings. */
25444 for (s
= head
; s
; s
= s
->next
)
25445 FRAME_RIF (f
)->draw_glyph_string (s
);
25448 /* When focus a sole frame and move horizontally, this clears on_p
25449 causing a failure to erase prev cursor position. */
25450 if (area
== TEXT_AREA
25451 && !row
->full_width_p
25452 /* When drawing overlapping rows, only the glyph strings'
25453 foreground is drawn, which doesn't erase a cursor
25457 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25458 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25459 : (tail
? tail
->x
+ tail
->background_width
: x
));
25463 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25464 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25468 /* Value is the x-position up to which drawn, relative to AREA of W.
25469 This doesn't include parts drawn because of overhangs. */
25470 if (row
->full_width_p
)
25471 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25473 x_reached
-= area_left
;
25475 RELEASE_HDC (hdc
, f
);
25481 /* Expand row matrix if too narrow. Don't expand if area
25484 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25486 if (!it->f->fonts_changed \
25487 && (it->glyph_row->glyphs[area] \
25488 < it->glyph_row->glyphs[area + 1])) \
25490 it->w->ncols_scale_factor++; \
25491 it->f->fonts_changed = true; \
25495 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25496 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25499 append_glyph (struct it
*it
)
25501 struct glyph
*glyph
;
25502 enum glyph_row_area area
= it
->area
;
25504 eassert (it
->glyph_row
);
25505 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25507 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25508 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25510 /* If the glyph row is reversed, we need to prepend the glyph
25511 rather than append it. */
25512 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25516 /* Make room for the additional glyph. */
25517 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25519 glyph
= it
->glyph_row
->glyphs
[area
];
25521 glyph
->charpos
= CHARPOS (it
->position
);
25522 glyph
->object
= it
->object
;
25523 if (it
->pixel_width
> 0)
25525 glyph
->pixel_width
= it
->pixel_width
;
25526 glyph
->padding_p
= false;
25530 /* Assure at least 1-pixel width. Otherwise, cursor can't
25531 be displayed correctly. */
25532 glyph
->pixel_width
= 1;
25533 glyph
->padding_p
= true;
25535 glyph
->ascent
= it
->ascent
;
25536 glyph
->descent
= it
->descent
;
25537 glyph
->voffset
= it
->voffset
;
25538 glyph
->type
= CHAR_GLYPH
;
25539 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25540 glyph
->multibyte_p
= it
->multibyte_p
;
25541 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25543 /* In R2L rows, the left and the right box edges need to be
25544 drawn in reverse direction. */
25545 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25546 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25550 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25551 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25553 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25554 || it
->phys_descent
> it
->descent
);
25555 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25556 glyph
->face_id
= it
->face_id
;
25557 glyph
->u
.ch
= it
->char_to_display
;
25558 glyph
->slice
.img
= null_glyph_slice
;
25559 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25562 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25563 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25564 glyph
->bidi_type
= it
->bidi_it
.type
;
25568 glyph
->resolved_level
= 0;
25569 glyph
->bidi_type
= UNKNOWN_BT
;
25571 ++it
->glyph_row
->used
[area
];
25574 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25577 /* Store one glyph for the composition IT->cmp_it.id in
25578 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25582 append_composite_glyph (struct it
*it
)
25584 struct glyph
*glyph
;
25585 enum glyph_row_area area
= it
->area
;
25587 eassert (it
->glyph_row
);
25589 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25590 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25592 /* If the glyph row is reversed, we need to prepend the glyph
25593 rather than append it. */
25594 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25598 /* Make room for the new glyph. */
25599 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25601 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25603 glyph
->charpos
= it
->cmp_it
.charpos
;
25604 glyph
->object
= it
->object
;
25605 glyph
->pixel_width
= it
->pixel_width
;
25606 glyph
->ascent
= it
->ascent
;
25607 glyph
->descent
= it
->descent
;
25608 glyph
->voffset
= it
->voffset
;
25609 glyph
->type
= COMPOSITE_GLYPH
;
25610 if (it
->cmp_it
.ch
< 0)
25612 glyph
->u
.cmp
.automatic
= false;
25613 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25614 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25618 glyph
->u
.cmp
.automatic
= true;
25619 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25620 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25621 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25623 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25624 glyph
->multibyte_p
= it
->multibyte_p
;
25625 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25627 /* In R2L rows, the left and the right box edges need to be
25628 drawn in reverse direction. */
25629 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25630 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25634 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25635 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25637 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25638 || it
->phys_descent
> it
->descent
);
25639 glyph
->padding_p
= false;
25640 glyph
->glyph_not_available_p
= false;
25641 glyph
->face_id
= it
->face_id
;
25642 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25645 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25646 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25647 glyph
->bidi_type
= it
->bidi_it
.type
;
25649 ++it
->glyph_row
->used
[area
];
25652 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25656 /* Change IT->ascent and IT->height according to the setting of
25660 take_vertical_position_into_account (struct it
*it
)
25664 if (it
->voffset
< 0)
25665 /* Increase the ascent so that we can display the text higher
25667 it
->ascent
-= it
->voffset
;
25669 /* Increase the descent so that we can display the text lower
25671 it
->descent
+= it
->voffset
;
25676 /* Produce glyphs/get display metrics for the image IT is loaded with.
25677 See the description of struct display_iterator in dispextern.h for
25678 an overview of struct display_iterator. */
25681 produce_image_glyph (struct it
*it
)
25685 int glyph_ascent
, crop
;
25686 struct glyph_slice slice
;
25688 eassert (it
->what
== IT_IMAGE
);
25690 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25692 /* Make sure X resources of the face is loaded. */
25693 prepare_face_for_display (it
->f
, face
);
25695 if (it
->image_id
< 0)
25697 /* Fringe bitmap. */
25698 it
->ascent
= it
->phys_ascent
= 0;
25699 it
->descent
= it
->phys_descent
= 0;
25700 it
->pixel_width
= 0;
25705 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25707 /* Make sure X resources of the image is loaded. */
25708 prepare_image_for_display (it
->f
, img
);
25710 slice
.x
= slice
.y
= 0;
25711 slice
.width
= img
->width
;
25712 slice
.height
= img
->height
;
25714 if (INTEGERP (it
->slice
.x
))
25715 slice
.x
= XINT (it
->slice
.x
);
25716 else if (FLOATP (it
->slice
.x
))
25717 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25719 if (INTEGERP (it
->slice
.y
))
25720 slice
.y
= XINT (it
->slice
.y
);
25721 else if (FLOATP (it
->slice
.y
))
25722 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25724 if (INTEGERP (it
->slice
.width
))
25725 slice
.width
= XINT (it
->slice
.width
);
25726 else if (FLOATP (it
->slice
.width
))
25727 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25729 if (INTEGERP (it
->slice
.height
))
25730 slice
.height
= XINT (it
->slice
.height
);
25731 else if (FLOATP (it
->slice
.height
))
25732 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25734 if (slice
.x
>= img
->width
)
25735 slice
.x
= img
->width
;
25736 if (slice
.y
>= img
->height
)
25737 slice
.y
= img
->height
;
25738 if (slice
.x
+ slice
.width
>= img
->width
)
25739 slice
.width
= img
->width
- slice
.x
;
25740 if (slice
.y
+ slice
.height
> img
->height
)
25741 slice
.height
= img
->height
- slice
.y
;
25743 if (slice
.width
== 0 || slice
.height
== 0)
25746 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25748 it
->descent
= slice
.height
- glyph_ascent
;
25750 it
->descent
+= img
->vmargin
;
25751 if (slice
.y
+ slice
.height
== img
->height
)
25752 it
->descent
+= img
->vmargin
;
25753 it
->phys_descent
= it
->descent
;
25755 it
->pixel_width
= slice
.width
;
25757 it
->pixel_width
+= img
->hmargin
;
25758 if (slice
.x
+ slice
.width
== img
->width
)
25759 it
->pixel_width
+= img
->hmargin
;
25761 /* It's quite possible for images to have an ascent greater than
25762 their height, so don't get confused in that case. */
25763 if (it
->descent
< 0)
25768 if (face
->box
!= FACE_NO_BOX
)
25770 if (face
->box_line_width
> 0)
25773 it
->ascent
+= face
->box_line_width
;
25774 if (slice
.y
+ slice
.height
== img
->height
)
25775 it
->descent
+= face
->box_line_width
;
25778 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25779 it
->pixel_width
+= eabs (face
->box_line_width
);
25780 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25781 it
->pixel_width
+= eabs (face
->box_line_width
);
25784 take_vertical_position_into_account (it
);
25786 /* Automatically crop wide image glyphs at right edge so we can
25787 draw the cursor on same display row. */
25788 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25789 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25791 it
->pixel_width
-= crop
;
25792 slice
.width
-= crop
;
25797 struct glyph
*glyph
;
25798 enum glyph_row_area area
= it
->area
;
25800 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25801 if (it
->glyph_row
->reversed_p
)
25805 /* Make room for the new glyph. */
25806 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25808 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25810 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25812 glyph
->charpos
= CHARPOS (it
->position
);
25813 glyph
->object
= it
->object
;
25814 glyph
->pixel_width
= it
->pixel_width
;
25815 glyph
->ascent
= glyph_ascent
;
25816 glyph
->descent
= it
->descent
;
25817 glyph
->voffset
= it
->voffset
;
25818 glyph
->type
= IMAGE_GLYPH
;
25819 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25820 glyph
->multibyte_p
= it
->multibyte_p
;
25821 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25823 /* In R2L rows, the left and the right box edges need to be
25824 drawn in reverse direction. */
25825 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25826 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25830 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25831 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25833 glyph
->overlaps_vertically_p
= false;
25834 glyph
->padding_p
= false;
25835 glyph
->glyph_not_available_p
= false;
25836 glyph
->face_id
= it
->face_id
;
25837 glyph
->u
.img_id
= img
->id
;
25838 glyph
->slice
.img
= slice
;
25839 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25842 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25843 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25844 glyph
->bidi_type
= it
->bidi_it
.type
;
25846 ++it
->glyph_row
->used
[area
];
25849 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25854 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25855 of the glyph, WIDTH and HEIGHT are the width and height of the
25856 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25859 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25860 int width
, int height
, int ascent
)
25862 struct glyph
*glyph
;
25863 enum glyph_row_area area
= it
->area
;
25865 eassert (ascent
>= 0 && ascent
<= height
);
25867 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25868 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25870 /* If the glyph row is reversed, we need to prepend the glyph
25871 rather than append it. */
25872 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25876 /* Make room for the additional glyph. */
25877 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25879 glyph
= it
->glyph_row
->glyphs
[area
];
25881 /* Decrease the width of the first glyph of the row that
25882 begins before first_visible_x (e.g., due to hscroll).
25883 This is so the overall width of the row becomes smaller
25884 by the scroll amount, and the stretch glyph appended by
25885 extend_face_to_end_of_line will be wider, to shift the
25886 row glyphs to the right. (In L2R rows, the corresponding
25887 left-shift effect is accomplished by setting row->x to a
25888 negative value, which won't work with R2L rows.)
25890 This must leave us with a positive value of WIDTH, since
25891 otherwise the call to move_it_in_display_line_to at the
25892 beginning of display_line would have got past the entire
25893 first glyph, and then it->current_x would have been
25894 greater or equal to it->first_visible_x. */
25895 if (it
->current_x
< it
->first_visible_x
)
25896 width
-= it
->first_visible_x
- it
->current_x
;
25897 eassert (width
> 0);
25899 glyph
->charpos
= CHARPOS (it
->position
);
25900 glyph
->object
= object
;
25901 glyph
->pixel_width
= width
;
25902 glyph
->ascent
= ascent
;
25903 glyph
->descent
= height
- ascent
;
25904 glyph
->voffset
= it
->voffset
;
25905 glyph
->type
= STRETCH_GLYPH
;
25906 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25907 glyph
->multibyte_p
= it
->multibyte_p
;
25908 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25910 /* In R2L rows, the left and the right box edges need to be
25911 drawn in reverse direction. */
25912 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25913 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25917 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25918 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25920 glyph
->overlaps_vertically_p
= false;
25921 glyph
->padding_p
= false;
25922 glyph
->glyph_not_available_p
= false;
25923 glyph
->face_id
= it
->face_id
;
25924 glyph
->u
.stretch
.ascent
= ascent
;
25925 glyph
->u
.stretch
.height
= height
;
25926 glyph
->slice
.img
= null_glyph_slice
;
25927 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25930 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25931 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25932 glyph
->bidi_type
= it
->bidi_it
.type
;
25936 glyph
->resolved_level
= 0;
25937 glyph
->bidi_type
= UNKNOWN_BT
;
25939 ++it
->glyph_row
->used
[area
];
25942 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25945 #endif /* HAVE_WINDOW_SYSTEM */
25947 /* Produce a stretch glyph for iterator IT. IT->object is the value
25948 of the glyph property displayed. The value must be a list
25949 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25952 1. `:width WIDTH' specifies that the space should be WIDTH *
25953 canonical char width wide. WIDTH may be an integer or floating
25956 2. `:relative-width FACTOR' specifies that the width of the stretch
25957 should be computed from the width of the first character having the
25958 `glyph' property, and should be FACTOR times that width.
25960 3. `:align-to HPOS' specifies that the space should be wide enough
25961 to reach HPOS, a value in canonical character units.
25963 Exactly one of the above pairs must be present.
25965 4. `:height HEIGHT' specifies that the height of the stretch produced
25966 should be HEIGHT, measured in canonical character units.
25968 5. `:relative-height FACTOR' specifies that the height of the
25969 stretch should be FACTOR times the height of the characters having
25970 the glyph property.
25972 Either none or exactly one of 4 or 5 must be present.
25974 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25975 of the stretch should be used for the ascent of the stretch.
25976 ASCENT must be in the range 0 <= ASCENT <= 100. */
25979 produce_stretch_glyph (struct it
*it
)
25981 /* (space :width WIDTH :height HEIGHT ...) */
25982 Lisp_Object prop
, plist
;
25983 int width
= 0, height
= 0, align_to
= -1;
25984 bool zero_width_ok_p
= false;
25986 struct font
*font
= NULL
;
25988 #ifdef HAVE_WINDOW_SYSTEM
25990 bool zero_height_ok_p
= false;
25992 if (FRAME_WINDOW_P (it
->f
))
25994 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25995 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25996 prepare_face_for_display (it
->f
, face
);
26000 /* List should start with `space'. */
26001 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26002 plist
= XCDR (it
->object
);
26004 /* Compute the width of the stretch. */
26005 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26006 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26008 /* Absolute width `:width WIDTH' specified and valid. */
26009 zero_width_ok_p
= true;
26012 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26014 /* Relative width `:relative-width FACTOR' specified and valid.
26015 Compute the width of the characters having the `glyph'
26018 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26021 if (it
->multibyte_p
)
26022 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26025 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26026 if (! ASCII_CHAR_P (it2
.c
))
26027 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26030 it2
.glyph_row
= NULL
;
26031 it2
.what
= IT_CHARACTER
;
26032 PRODUCE_GLYPHS (&it2
);
26033 width
= NUMVAL (prop
) * it2
.pixel_width
;
26035 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26036 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26039 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26040 align_to
= (align_to
< 0
26042 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26043 else if (align_to
< 0)
26044 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26045 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26046 zero_width_ok_p
= true;
26049 /* Nothing specified -> width defaults to canonical char width. */
26050 width
= FRAME_COLUMN_WIDTH (it
->f
);
26052 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26055 #ifdef HAVE_WINDOW_SYSTEM
26056 /* Compute height. */
26057 if (FRAME_WINDOW_P (it
->f
))
26059 int default_height
= normal_char_height (font
, ' ');
26061 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26062 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26065 zero_height_ok_p
= true;
26067 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26069 height
= default_height
* NUMVAL (prop
);
26071 height
= default_height
;
26073 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26076 /* Compute percentage of height used for ascent. If
26077 `:ascent ASCENT' is present and valid, use that. Otherwise,
26078 derive the ascent from the font in use. */
26079 if (prop
= Fplist_get (plist
, QCascent
),
26080 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26081 ascent
= height
* NUMVAL (prop
) / 100.0;
26082 else if (!NILP (prop
)
26083 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26084 ascent
= min (max (0, (int)tem
), height
);
26086 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26089 #endif /* HAVE_WINDOW_SYSTEM */
26092 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26093 && it
->current_x
+ width
> it
->last_visible_x
)
26095 width
= it
->last_visible_x
- it
->current_x
;
26096 #ifdef HAVE_WINDOW_SYSTEM
26097 /* Subtract one more pixel from the stretch width, but only on
26098 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26099 width
-= FRAME_WINDOW_P (it
->f
);
26103 if (width
> 0 && height
> 0 && it
->glyph_row
)
26105 Lisp_Object o_object
= it
->object
;
26106 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26109 if (!STRINGP (object
))
26110 object
= it
->w
->contents
;
26111 #ifdef HAVE_WINDOW_SYSTEM
26112 if (FRAME_WINDOW_P (it
->f
))
26113 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26117 it
->object
= object
;
26118 it
->char_to_display
= ' ';
26119 it
->pixel_width
= it
->len
= 1;
26121 tty_append_glyph (it
);
26122 it
->object
= o_object
;
26126 it
->pixel_width
= width
;
26127 #ifdef HAVE_WINDOW_SYSTEM
26128 if (FRAME_WINDOW_P (it
->f
))
26130 it
->ascent
= it
->phys_ascent
= ascent
;
26131 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26132 it
->nglyphs
= width
> 0 && height
> 0;
26133 take_vertical_position_into_account (it
);
26137 it
->nglyphs
= width
;
26140 /* Get information about special display element WHAT in an
26141 environment described by IT. WHAT is one of IT_TRUNCATION or
26142 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26143 non-null glyph_row member. This function ensures that fields like
26144 face_id, c, len of IT are left untouched. */
26147 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26154 temp_it
.object
= Qnil
;
26155 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26157 if (what
== IT_CONTINUATION
)
26159 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26160 if (it
->bidi_it
.paragraph_dir
== R2L
)
26161 SET_GLYPH_FROM_CHAR (glyph
, '/');
26163 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26165 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26167 /* FIXME: Should we mirror GC for R2L lines? */
26168 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26169 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26172 else if (what
== IT_TRUNCATION
)
26174 /* Truncation glyph. */
26175 SET_GLYPH_FROM_CHAR (glyph
, '$');
26177 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26179 /* FIXME: Should we mirror GC for R2L lines? */
26180 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26181 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26187 #ifdef HAVE_WINDOW_SYSTEM
26188 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26189 is turned off, we precede the truncation/continuation glyphs by a
26190 stretch glyph whose width is computed such that these special
26191 glyphs are aligned at the window margin, even when very different
26192 fonts are used in different glyph rows. */
26193 if (FRAME_WINDOW_P (temp_it
.f
)
26194 /* init_iterator calls this with it->glyph_row == NULL, and it
26195 wants only the pixel width of the truncation/continuation
26197 && temp_it
.glyph_row
26198 /* insert_left_trunc_glyphs calls us at the beginning of the
26199 row, and it has its own calculation of the stretch glyph
26201 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26202 && (temp_it
.glyph_row
->reversed_p
26203 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26204 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26206 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26208 if (stretch_width
> 0)
26210 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26211 struct font
*font
=
26212 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26213 int stretch_ascent
=
26214 (((temp_it
.ascent
+ temp_it
.descent
)
26215 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26217 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26218 temp_it
.ascent
+ temp_it
.descent
,
26225 temp_it
.what
= IT_CHARACTER
;
26226 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26227 temp_it
.face_id
= GLYPH_FACE (glyph
);
26228 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26230 PRODUCE_GLYPHS (&temp_it
);
26231 it
->pixel_width
= temp_it
.pixel_width
;
26232 it
->nglyphs
= temp_it
.nglyphs
;
26235 #ifdef HAVE_WINDOW_SYSTEM
26237 /* Calculate line-height and line-spacing properties.
26238 An integer value specifies explicit pixel value.
26239 A float value specifies relative value to current face height.
26240 A cons (float . face-name) specifies relative value to
26241 height of specified face font.
26243 Returns height in pixels, or nil. */
26246 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26247 int boff
, bool override
)
26249 Lisp_Object face_name
= Qnil
;
26250 int ascent
, descent
, height
;
26252 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26257 face_name
= XCAR (val
);
26259 if (!NUMBERP (val
))
26260 val
= make_number (1);
26261 if (NILP (face_name
))
26263 height
= it
->ascent
+ it
->descent
;
26268 if (NILP (face_name
))
26270 font
= FRAME_FONT (it
->f
);
26271 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26273 else if (EQ (face_name
, Qt
))
26282 face_id
= lookup_named_face (it
->f
, face_name
, false);
26284 return make_number (-1);
26286 face
= FACE_FROM_ID (it
->f
, face_id
);
26289 return make_number (-1);
26290 boff
= font
->baseline_offset
;
26291 if (font
->vertical_centering
)
26292 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26295 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26299 it
->override_ascent
= ascent
;
26300 it
->override_descent
= descent
;
26301 it
->override_boff
= boff
;
26304 height
= ascent
+ descent
;
26308 height
= (int)(XFLOAT_DATA (val
) * height
);
26309 else if (INTEGERP (val
))
26310 height
*= XINT (val
);
26312 return make_number (height
);
26316 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26317 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26318 and only if this is for a character for which no font was found.
26320 If the display method (it->glyphless_method) is
26321 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26322 length of the acronym or the hexadecimal string, UPPER_XOFF and
26323 UPPER_YOFF are pixel offsets for the upper part of the string,
26324 LOWER_XOFF and LOWER_YOFF are for the lower part.
26326 For the other display methods, LEN through LOWER_YOFF are zero. */
26329 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26330 short upper_xoff
, short upper_yoff
,
26331 short lower_xoff
, short lower_yoff
)
26333 struct glyph
*glyph
;
26334 enum glyph_row_area area
= it
->area
;
26336 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26337 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26339 /* If the glyph row is reversed, we need to prepend the glyph
26340 rather than append it. */
26341 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26345 /* Make room for the additional glyph. */
26346 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26348 glyph
= it
->glyph_row
->glyphs
[area
];
26350 glyph
->charpos
= CHARPOS (it
->position
);
26351 glyph
->object
= it
->object
;
26352 glyph
->pixel_width
= it
->pixel_width
;
26353 glyph
->ascent
= it
->ascent
;
26354 glyph
->descent
= it
->descent
;
26355 glyph
->voffset
= it
->voffset
;
26356 glyph
->type
= GLYPHLESS_GLYPH
;
26357 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26358 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26359 glyph
->u
.glyphless
.len
= len
;
26360 glyph
->u
.glyphless
.ch
= it
->c
;
26361 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26362 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26363 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26364 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26365 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26366 glyph
->multibyte_p
= it
->multibyte_p
;
26367 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26369 /* In R2L rows, the left and the right box edges need to be
26370 drawn in reverse direction. */
26371 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26372 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26376 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26377 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26379 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26380 || it
->phys_descent
> it
->descent
);
26381 glyph
->padding_p
= false;
26382 glyph
->glyph_not_available_p
= false;
26383 glyph
->face_id
= face_id
;
26384 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26387 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26388 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26389 glyph
->bidi_type
= it
->bidi_it
.type
;
26391 ++it
->glyph_row
->used
[area
];
26394 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26398 /* Produce a glyph for a glyphless character for iterator IT.
26399 IT->glyphless_method specifies which method to use for displaying
26400 the character. See the description of enum
26401 glyphless_display_method in dispextern.h for the detail.
26403 FOR_NO_FONT is true if and only if this is for a character for
26404 which no font was found. ACRONYM, if non-nil, is an acronym string
26405 for the character. */
26408 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26413 int base_width
, base_height
, width
, height
;
26414 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26417 /* Get the metrics of the base font. We always refer to the current
26419 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26420 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26421 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26422 it
->ascent
+= font
->baseline_offset
;
26423 it
->descent
-= font
->baseline_offset
;
26424 base_height
= it
->ascent
+ it
->descent
;
26425 base_width
= font
->average_width
;
26427 face_id
= merge_glyphless_glyph_face (it
);
26429 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26431 it
->pixel_width
= THIN_SPACE_WIDTH
;
26433 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26435 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26437 width
= CHAR_WIDTH (it
->c
);
26440 else if (width
> 4)
26442 it
->pixel_width
= base_width
* width
;
26444 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26450 unsigned int code
[6];
26452 int ascent
, descent
;
26453 struct font_metrics metrics_upper
, metrics_lower
;
26455 face
= FACE_FROM_ID (it
->f
, face_id
);
26456 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26457 prepare_face_for_display (it
->f
, face
);
26459 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26461 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26462 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26463 if (CONSP (acronym
))
26464 acronym
= XCAR (acronym
);
26465 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26469 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26470 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26473 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26474 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26475 upper_len
= (len
+ 1) / 2;
26476 font
->driver
->text_extents (font
, code
, upper_len
,
26478 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26483 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26484 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26485 upper_xoff
= upper_yoff
= 2; /* the typical case */
26486 if (base_width
>= width
)
26488 /* Align the upper to the left, the lower to the right. */
26489 it
->pixel_width
= base_width
;
26490 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26494 /* Center the shorter one. */
26495 it
->pixel_width
= width
;
26496 if (metrics_upper
.width
>= metrics_lower
.width
)
26497 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26500 /* FIXME: This code doesn't look right. It formerly was
26501 missing the "lower_xoff = 0;", which couldn't have
26502 been right since it left lower_xoff uninitialized. */
26504 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26508 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26509 top, bottom, and between upper and lower strings. */
26510 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26511 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26512 /* Center vertically.
26513 H:base_height, D:base_descent
26514 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26516 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26517 descent = D - H/2 + h/2;
26518 lower_yoff = descent - 2 - ld;
26519 upper_yoff = lower_yoff - la - 1 - ud; */
26520 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26521 descent
= it
->descent
- (base_height
- height
) / 2;
26522 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26523 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26524 - metrics_upper
.descent
);
26525 /* Don't make the height shorter than the base height. */
26526 if (height
> base_height
)
26528 it
->ascent
= ascent
;
26529 it
->descent
= descent
;
26533 it
->phys_ascent
= it
->ascent
;
26534 it
->phys_descent
= it
->descent
;
26536 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26537 upper_xoff
, upper_yoff
,
26538 lower_xoff
, lower_yoff
);
26540 take_vertical_position_into_account (it
);
26545 Produce glyphs/get display metrics for the display element IT is
26546 loaded with. See the description of struct it in dispextern.h
26547 for an overview of struct it. */
26550 x_produce_glyphs (struct it
*it
)
26552 int extra_line_spacing
= it
->extra_line_spacing
;
26554 it
->glyph_not_available_p
= false;
26556 if (it
->what
== IT_CHARACTER
)
26559 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26560 struct font
*font
= face
->font
;
26561 struct font_metrics
*pcm
= NULL
;
26562 int boff
; /* Baseline offset. */
26566 /* When no suitable font is found, display this character by
26567 the method specified in the first extra slot of
26568 Vglyphless_char_display. */
26569 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26571 eassert (it
->what
== IT_GLYPHLESS
);
26572 produce_glyphless_glyph (it
, true,
26573 STRINGP (acronym
) ? acronym
: Qnil
);
26577 boff
= font
->baseline_offset
;
26578 if (font
->vertical_centering
)
26579 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26581 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26585 if (it
->override_ascent
>= 0)
26587 it
->ascent
= it
->override_ascent
;
26588 it
->descent
= it
->override_descent
;
26589 boff
= it
->override_boff
;
26593 it
->ascent
= FONT_BASE (font
) + boff
;
26594 it
->descent
= FONT_DESCENT (font
) - boff
;
26597 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26599 pcm
= get_per_char_metric (font
, &char2b
);
26600 if (pcm
->width
== 0
26601 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26607 it
->phys_ascent
= pcm
->ascent
+ boff
;
26608 it
->phys_descent
= pcm
->descent
- boff
;
26609 it
->pixel_width
= pcm
->width
;
26610 /* Don't use font-global values for ascent and descent
26611 if they result in an exceedingly large line height. */
26612 if (it
->override_ascent
< 0)
26614 if (FONT_TOO_HIGH (font
))
26616 it
->ascent
= it
->phys_ascent
;
26617 it
->descent
= it
->phys_descent
;
26618 /* These limitations are enforced by an
26619 assertion near the end of this function. */
26620 if (it
->ascent
< 0)
26622 if (it
->descent
< 0)
26629 it
->glyph_not_available_p
= true;
26630 it
->phys_ascent
= it
->ascent
;
26631 it
->phys_descent
= it
->descent
;
26632 it
->pixel_width
= font
->space_width
;
26635 if (it
->constrain_row_ascent_descent_p
)
26637 if (it
->descent
> it
->max_descent
)
26639 it
->ascent
+= it
->descent
- it
->max_descent
;
26640 it
->descent
= it
->max_descent
;
26642 if (it
->ascent
> it
->max_ascent
)
26644 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26645 it
->ascent
= it
->max_ascent
;
26647 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26648 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26649 extra_line_spacing
= 0;
26652 /* If this is a space inside a region of text with
26653 `space-width' property, change its width. */
26655 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26657 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26659 /* If face has a box, add the box thickness to the character
26660 height. If character has a box line to the left and/or
26661 right, add the box line width to the character's width. */
26662 if (face
->box
!= FACE_NO_BOX
)
26664 int thick
= face
->box_line_width
;
26668 it
->ascent
+= thick
;
26669 it
->descent
+= thick
;
26674 if (it
->start_of_box_run_p
)
26675 it
->pixel_width
+= thick
;
26676 if (it
->end_of_box_run_p
)
26677 it
->pixel_width
+= thick
;
26680 /* If face has an overline, add the height of the overline
26681 (1 pixel) and a 1 pixel margin to the character height. */
26682 if (face
->overline_p
)
26683 it
->ascent
+= overline_margin
;
26685 if (it
->constrain_row_ascent_descent_p
)
26687 if (it
->ascent
> it
->max_ascent
)
26688 it
->ascent
= it
->max_ascent
;
26689 if (it
->descent
> it
->max_descent
)
26690 it
->descent
= it
->max_descent
;
26693 take_vertical_position_into_account (it
);
26695 /* If we have to actually produce glyphs, do it. */
26700 /* Translate a space with a `space-width' property
26701 into a stretch glyph. */
26702 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26703 / FONT_HEIGHT (font
));
26704 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26705 it
->ascent
+ it
->descent
, ascent
);
26710 /* If characters with lbearing or rbearing are displayed
26711 in this line, record that fact in a flag of the
26712 glyph row. This is used to optimize X output code. */
26713 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26714 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26716 if (! stretched_p
&& it
->pixel_width
== 0)
26717 /* We assure that all visible glyphs have at least 1-pixel
26719 it
->pixel_width
= 1;
26721 else if (it
->char_to_display
== '\n')
26723 /* A newline has no width, but we need the height of the
26724 line. But if previous part of the line sets a height,
26725 don't increase that height. */
26727 Lisp_Object height
;
26728 Lisp_Object total_height
= Qnil
;
26730 it
->override_ascent
= -1;
26731 it
->pixel_width
= 0;
26734 height
= get_it_property (it
, Qline_height
);
26735 /* Split (line-height total-height) list. */
26737 && CONSP (XCDR (height
))
26738 && NILP (XCDR (XCDR (height
))))
26740 total_height
= XCAR (XCDR (height
));
26741 height
= XCAR (height
);
26743 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26745 if (it
->override_ascent
>= 0)
26747 it
->ascent
= it
->override_ascent
;
26748 it
->descent
= it
->override_descent
;
26749 boff
= it
->override_boff
;
26753 if (FONT_TOO_HIGH (font
))
26755 it
->ascent
= font
->pixel_size
+ boff
- 1;
26756 it
->descent
= -boff
+ 1;
26757 if (it
->descent
< 0)
26762 it
->ascent
= FONT_BASE (font
) + boff
;
26763 it
->descent
= FONT_DESCENT (font
) - boff
;
26767 if (EQ (height
, Qt
))
26769 if (it
->descent
> it
->max_descent
)
26771 it
->ascent
+= it
->descent
- it
->max_descent
;
26772 it
->descent
= it
->max_descent
;
26774 if (it
->ascent
> it
->max_ascent
)
26776 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26777 it
->ascent
= it
->max_ascent
;
26779 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26780 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26781 it
->constrain_row_ascent_descent_p
= true;
26782 extra_line_spacing
= 0;
26786 Lisp_Object spacing
;
26788 it
->phys_ascent
= it
->ascent
;
26789 it
->phys_descent
= it
->descent
;
26791 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26792 && face
->box
!= FACE_NO_BOX
26793 && face
->box_line_width
> 0)
26795 it
->ascent
+= face
->box_line_width
;
26796 it
->descent
+= face
->box_line_width
;
26799 && XINT (height
) > it
->ascent
+ it
->descent
)
26800 it
->ascent
= XINT (height
) - it
->descent
;
26802 if (!NILP (total_height
))
26803 spacing
= calc_line_height_property (it
, total_height
, font
,
26807 spacing
= get_it_property (it
, Qline_spacing
);
26808 spacing
= calc_line_height_property (it
, spacing
, font
,
26811 if (INTEGERP (spacing
))
26813 extra_line_spacing
= XINT (spacing
);
26814 if (!NILP (total_height
))
26815 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26819 else /* i.e. (it->char_to_display == '\t') */
26821 if (font
->space_width
> 0)
26823 int tab_width
= it
->tab_width
* font
->space_width
;
26824 int x
= it
->current_x
+ it
->continuation_lines_width
;
26825 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26827 /* If the distance from the current position to the next tab
26828 stop is less than a space character width, use the
26829 tab stop after that. */
26830 if (next_tab_x
- x
< font
->space_width
)
26831 next_tab_x
+= tab_width
;
26833 it
->pixel_width
= next_tab_x
- x
;
26835 if (FONT_TOO_HIGH (font
))
26837 if (get_char_glyph_code (' ', font
, &char2b
))
26839 pcm
= get_per_char_metric (font
, &char2b
);
26840 if (pcm
->width
== 0
26841 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26847 it
->ascent
= pcm
->ascent
+ boff
;
26848 it
->descent
= pcm
->descent
- boff
;
26852 it
->ascent
= font
->pixel_size
+ boff
- 1;
26853 it
->descent
= -boff
+ 1;
26855 if (it
->ascent
< 0)
26857 if (it
->descent
< 0)
26862 it
->ascent
= FONT_BASE (font
) + boff
;
26863 it
->descent
= FONT_DESCENT (font
) - boff
;
26865 it
->phys_ascent
= it
->ascent
;
26866 it
->phys_descent
= it
->descent
;
26870 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26871 it
->ascent
+ it
->descent
, it
->ascent
);
26876 it
->pixel_width
= 0;
26881 if (FONT_TOO_HIGH (font
))
26883 int font_ascent
, font_descent
;
26885 /* For very large fonts, where we ignore the declared font
26886 dimensions, and go by per-character metrics instead,
26887 don't let the row ascent and descent values (and the row
26888 height computed from them) be smaller than the "normal"
26889 character metrics. This avoids unpleasant effects
26890 whereby lines on display would change their height
26891 depending on which characters are shown. */
26892 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26893 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
26894 it
->max_descent
= max (it
->max_descent
, font_descent
);
26897 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26899 /* A static composition.
26901 Note: A composition is represented as one glyph in the
26902 glyph matrix. There are no padding glyphs.
26904 Important note: pixel_width, ascent, and descent are the
26905 values of what is drawn by draw_glyphs (i.e. the values of
26906 the overall glyphs composed). */
26907 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26908 int boff
; /* baseline offset */
26909 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26910 int glyph_len
= cmp
->glyph_len
;
26911 struct font
*font
= face
->font
;
26915 /* If we have not yet calculated pixel size data of glyphs of
26916 the composition for the current face font, calculate them
26917 now. Theoretically, we have to check all fonts for the
26918 glyphs, but that requires much time and memory space. So,
26919 here we check only the font of the first glyph. This may
26920 lead to incorrect display, but it's very rare, and C-l
26921 (recenter-top-bottom) can correct the display anyway. */
26922 if (! cmp
->font
|| cmp
->font
!= font
)
26924 /* Ascent and descent of the font of the first character
26925 of this composition (adjusted by baseline offset).
26926 Ascent and descent of overall glyphs should not be less
26927 than these, respectively. */
26928 int font_ascent
, font_descent
, font_height
;
26929 /* Bounding box of the overall glyphs. */
26930 int leftmost
, rightmost
, lowest
, highest
;
26931 int lbearing
, rbearing
;
26932 int i
, width
, ascent
, descent
;
26933 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26935 struct font_metrics
*pcm
;
26938 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26939 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26941 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26942 for (i
= 0; i
< glyph_len
; i
++)
26944 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26946 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26948 bool left_padded
= i
> 0;
26950 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26951 : IT_CHARPOS (*it
));
26952 /* If no suitable font is found, use the default font. */
26953 bool font_not_found_p
= font
== NULL
;
26954 if (font_not_found_p
)
26956 face
= face
->ascii_face
;
26959 boff
= font
->baseline_offset
;
26960 if (font
->vertical_centering
)
26961 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26962 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26963 font_ascent
+= boff
;
26964 font_descent
-= boff
;
26965 font_height
= font_ascent
+ font_descent
;
26970 if (! font_not_found_p
)
26972 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26974 pcm
= get_per_char_metric (font
, &char2b
);
26977 /* Initialize the bounding box. */
26980 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26981 ascent
= pcm
->ascent
;
26982 descent
= pcm
->descent
;
26983 lbearing
= pcm
->lbearing
;
26984 rbearing
= pcm
->rbearing
;
26988 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26989 ascent
= FONT_BASE (font
);
26990 descent
= FONT_DESCENT (font
);
26997 lowest
= - descent
+ boff
;
26998 highest
= ascent
+ boff
;
27000 if (! font_not_found_p
27001 && font
->default_ascent
27002 && CHAR_TABLE_P (Vuse_default_ascent
)
27003 && !NILP (Faref (Vuse_default_ascent
,
27004 make_number (it
->char_to_display
))))
27005 highest
= font
->default_ascent
+ boff
;
27007 /* Draw the first glyph at the normal position. It may be
27008 shifted to right later if some other glyphs are drawn
27010 cmp
->offsets
[i
* 2] = 0;
27011 cmp
->offsets
[i
* 2 + 1] = boff
;
27012 cmp
->lbearing
= lbearing
;
27013 cmp
->rbearing
= rbearing
;
27015 /* Set cmp->offsets for the remaining glyphs. */
27016 for (i
++; i
< glyph_len
; i
++)
27018 int left
, right
, btm
, top
;
27019 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27021 struct face
*this_face
;
27025 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27026 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27027 font
= this_face
->font
;
27033 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27035 pcm
= get_per_char_metric (font
, &char2b
);
27038 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27041 width
= pcm
->width
;
27042 ascent
= pcm
->ascent
;
27043 descent
= pcm
->descent
;
27044 lbearing
= pcm
->lbearing
;
27045 rbearing
= pcm
->rbearing
;
27046 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27048 /* Relative composition with or without
27049 alternate chars. */
27050 left
= (leftmost
+ rightmost
- width
) / 2;
27051 btm
= - descent
+ boff
;
27052 if (font
->relative_compose
27053 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27054 || NILP (Faref (Vignore_relative_composition
,
27055 make_number (ch
)))))
27058 if (- descent
>= font
->relative_compose
)
27059 /* One extra pixel between two glyphs. */
27061 else if (ascent
<= 0)
27062 /* One extra pixel between two glyphs. */
27063 btm
= lowest
- 1 - ascent
- descent
;
27068 /* A composition rule is specified by an integer
27069 value that encodes global and new reference
27070 points (GREF and NREF). GREF and NREF are
27071 specified by numbers as below:
27073 0---1---2 -- ascent
27077 9--10--11 -- center
27079 ---3---4---5--- baseline
27081 6---7---8 -- descent
27083 int rule
= COMPOSITION_RULE (cmp
, i
);
27084 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27086 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27087 grefx
= gref
% 3, nrefx
= nref
% 3;
27088 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27090 xoff
= font_height
* (xoff
- 128) / 256;
27092 yoff
= font_height
* (yoff
- 128) / 256;
27095 + grefx
* (rightmost
- leftmost
) / 2
27096 - nrefx
* width
/ 2
27099 btm
= ((grefy
== 0 ? highest
27101 : grefy
== 2 ? lowest
27102 : (highest
+ lowest
) / 2)
27103 - (nrefy
== 0 ? ascent
+ descent
27104 : nrefy
== 1 ? descent
- boff
27106 : (ascent
+ descent
) / 2)
27110 cmp
->offsets
[i
* 2] = left
;
27111 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27113 /* Update the bounding box of the overall glyphs. */
27116 right
= left
+ width
;
27117 if (left
< leftmost
)
27119 if (right
> rightmost
)
27122 top
= btm
+ descent
+ ascent
;
27128 if (cmp
->lbearing
> left
+ lbearing
)
27129 cmp
->lbearing
= left
+ lbearing
;
27130 if (cmp
->rbearing
< left
+ rbearing
)
27131 cmp
->rbearing
= left
+ rbearing
;
27135 /* If there are glyphs whose x-offsets are negative,
27136 shift all glyphs to the right and make all x-offsets
27140 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27141 cmp
->offsets
[i
* 2] -= leftmost
;
27142 rightmost
-= leftmost
;
27143 cmp
->lbearing
-= leftmost
;
27144 cmp
->rbearing
-= leftmost
;
27147 if (left_padded
&& cmp
->lbearing
< 0)
27149 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27150 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27151 rightmost
-= cmp
->lbearing
;
27152 cmp
->rbearing
-= cmp
->lbearing
;
27155 if (right_padded
&& rightmost
< cmp
->rbearing
)
27157 rightmost
= cmp
->rbearing
;
27160 cmp
->pixel_width
= rightmost
;
27161 cmp
->ascent
= highest
;
27162 cmp
->descent
= - lowest
;
27163 if (cmp
->ascent
< font_ascent
)
27164 cmp
->ascent
= font_ascent
;
27165 if (cmp
->descent
< font_descent
)
27166 cmp
->descent
= font_descent
;
27170 && (cmp
->lbearing
< 0
27171 || cmp
->rbearing
> cmp
->pixel_width
))
27172 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27174 it
->pixel_width
= cmp
->pixel_width
;
27175 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27176 it
->descent
= it
->phys_descent
= cmp
->descent
;
27177 if (face
->box
!= FACE_NO_BOX
)
27179 int thick
= face
->box_line_width
;
27183 it
->ascent
+= thick
;
27184 it
->descent
+= thick
;
27189 if (it
->start_of_box_run_p
)
27190 it
->pixel_width
+= thick
;
27191 if (it
->end_of_box_run_p
)
27192 it
->pixel_width
+= thick
;
27195 /* If face has an overline, add the height of the overline
27196 (1 pixel) and a 1 pixel margin to the character height. */
27197 if (face
->overline_p
)
27198 it
->ascent
+= overline_margin
;
27200 take_vertical_position_into_account (it
);
27201 if (it
->ascent
< 0)
27203 if (it
->descent
< 0)
27206 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27207 append_composite_glyph (it
);
27209 else if (it
->what
== IT_COMPOSITION
)
27211 /* A dynamic (automatic) composition. */
27212 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27213 Lisp_Object gstring
;
27214 struct font_metrics metrics
;
27218 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27220 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27223 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27224 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27225 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27226 it
->descent
= it
->phys_descent
= metrics
.descent
;
27227 if (face
->box
!= FACE_NO_BOX
)
27229 int thick
= face
->box_line_width
;
27233 it
->ascent
+= thick
;
27234 it
->descent
+= thick
;
27239 if (it
->start_of_box_run_p
)
27240 it
->pixel_width
+= thick
;
27241 if (it
->end_of_box_run_p
)
27242 it
->pixel_width
+= thick
;
27244 /* If face has an overline, add the height of the overline
27245 (1 pixel) and a 1 pixel margin to the character height. */
27246 if (face
->overline_p
)
27247 it
->ascent
+= overline_margin
;
27248 take_vertical_position_into_account (it
);
27249 if (it
->ascent
< 0)
27251 if (it
->descent
< 0)
27255 append_composite_glyph (it
);
27257 else if (it
->what
== IT_GLYPHLESS
)
27258 produce_glyphless_glyph (it
, false, Qnil
);
27259 else if (it
->what
== IT_IMAGE
)
27260 produce_image_glyph (it
);
27261 else if (it
->what
== IT_STRETCH
)
27262 produce_stretch_glyph (it
);
27265 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27266 because this isn't true for images with `:ascent 100'. */
27267 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27268 if (it
->area
== TEXT_AREA
)
27269 it
->current_x
+= it
->pixel_width
;
27271 if (extra_line_spacing
> 0)
27273 it
->descent
+= extra_line_spacing
;
27274 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27275 it
->max_extra_line_spacing
= extra_line_spacing
;
27278 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27279 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27280 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27281 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27285 Output LEN glyphs starting at START at the nominal cursor position.
27286 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27287 being updated, and UPDATED_AREA is the area of that row being updated. */
27290 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27291 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27293 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27295 eassert (updated_row
);
27296 /* When the window is hscrolled, cursor hpos can legitimately be out
27297 of bounds, but we draw the cursor at the corresponding window
27298 margin in that case. */
27299 if (!updated_row
->reversed_p
&& chpos
< 0)
27301 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27302 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27306 /* Write glyphs. */
27308 hpos
= start
- updated_row
->glyphs
[updated_area
];
27309 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27310 updated_row
, updated_area
,
27312 DRAW_NORMAL_TEXT
, 0);
27314 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27315 if (updated_area
== TEXT_AREA
27316 && w
->phys_cursor_on_p
27317 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27319 && chpos
< hpos
+ len
)
27320 w
->phys_cursor_on_p
= false;
27324 /* Advance the output cursor. */
27325 w
->output_cursor
.hpos
+= len
;
27326 w
->output_cursor
.x
= x
;
27331 Insert LEN glyphs from START at the nominal cursor position. */
27334 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27335 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27338 int line_height
, shift_by_width
, shifted_region_width
;
27339 struct glyph_row
*row
;
27340 struct glyph
*glyph
;
27341 int frame_x
, frame_y
;
27344 eassert (updated_row
);
27346 f
= XFRAME (WINDOW_FRAME (w
));
27348 /* Get the height of the line we are in. */
27350 line_height
= row
->height
;
27352 /* Get the width of the glyphs to insert. */
27353 shift_by_width
= 0;
27354 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27355 shift_by_width
+= glyph
->pixel_width
;
27357 /* Get the width of the region to shift right. */
27358 shifted_region_width
= (window_box_width (w
, updated_area
)
27359 - w
->output_cursor
.x
27363 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27364 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27366 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27367 line_height
, shift_by_width
);
27369 /* Write the glyphs. */
27370 hpos
= start
- row
->glyphs
[updated_area
];
27371 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27373 DRAW_NORMAL_TEXT
, 0);
27375 /* Advance the output cursor. */
27376 w
->output_cursor
.hpos
+= len
;
27377 w
->output_cursor
.x
+= shift_by_width
;
27383 Erase the current text line from the nominal cursor position
27384 (inclusive) to pixel column TO_X (exclusive). The idea is that
27385 everything from TO_X onward is already erased.
27387 TO_X is a pixel position relative to UPDATED_AREA of currently
27388 updated window W. TO_X == -1 means clear to the end of this area. */
27391 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27392 enum glyph_row_area updated_area
, int to_x
)
27395 int max_x
, min_y
, max_y
;
27396 int from_x
, from_y
, to_y
;
27398 eassert (updated_row
);
27399 f
= XFRAME (w
->frame
);
27401 if (updated_row
->full_width_p
)
27402 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27403 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27405 max_x
= window_box_width (w
, updated_area
);
27406 max_y
= window_text_bottom_y (w
);
27408 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27409 of window. For TO_X > 0, truncate to end of drawing area. */
27415 to_x
= min (to_x
, max_x
);
27417 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27419 /* Notice if the cursor will be cleared by this operation. */
27420 if (!updated_row
->full_width_p
)
27421 notice_overwritten_cursor (w
, updated_area
,
27422 w
->output_cursor
.x
, -1,
27424 MATRIX_ROW_BOTTOM_Y (updated_row
));
27426 from_x
= w
->output_cursor
.x
;
27428 /* Translate to frame coordinates. */
27429 if (updated_row
->full_width_p
)
27431 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27432 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27436 int area_left
= window_box_left (w
, updated_area
);
27437 from_x
+= area_left
;
27441 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27442 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27443 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27445 /* Prevent inadvertently clearing to end of the X window. */
27446 if (to_x
> from_x
&& to_y
> from_y
)
27449 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27450 to_x
- from_x
, to_y
- from_y
);
27455 #endif /* HAVE_WINDOW_SYSTEM */
27459 /***********************************************************************
27461 ***********************************************************************/
27463 /* Value is the internal representation of the specified cursor type
27464 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27465 of the bar cursor. */
27467 static enum text_cursor_kinds
27468 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27470 enum text_cursor_kinds type
;
27475 if (EQ (arg
, Qbox
))
27476 return FILLED_BOX_CURSOR
;
27478 if (EQ (arg
, Qhollow
))
27479 return HOLLOW_BOX_CURSOR
;
27481 if (EQ (arg
, Qbar
))
27488 && EQ (XCAR (arg
), Qbar
)
27489 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27491 *width
= XINT (XCDR (arg
));
27495 if (EQ (arg
, Qhbar
))
27498 return HBAR_CURSOR
;
27502 && EQ (XCAR (arg
), Qhbar
)
27503 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27505 *width
= XINT (XCDR (arg
));
27506 return HBAR_CURSOR
;
27509 /* Treat anything unknown as "hollow box cursor".
27510 It was bad to signal an error; people have trouble fixing
27511 .Xdefaults with Emacs, when it has something bad in it. */
27512 type
= HOLLOW_BOX_CURSOR
;
27517 /* Set the default cursor types for specified frame. */
27519 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27524 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27525 FRAME_CURSOR_WIDTH (f
) = width
;
27527 /* By default, set up the blink-off state depending on the on-state. */
27529 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27532 FRAME_BLINK_OFF_CURSOR (f
)
27533 = get_specified_cursor_type (XCDR (tem
), &width
);
27534 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27537 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27539 /* Make sure the cursor gets redrawn. */
27540 f
->cursor_type_changed
= true;
27544 #ifdef HAVE_WINDOW_SYSTEM
27546 /* Return the cursor we want to be displayed in window W. Return
27547 width of bar/hbar cursor through WIDTH arg. Return with
27548 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27549 (i.e. if the `system caret' should track this cursor).
27551 In a mini-buffer window, we want the cursor only to appear if we
27552 are reading input from this window. For the selected window, we
27553 want the cursor type given by the frame parameter or buffer local
27554 setting of cursor-type. If explicitly marked off, draw no cursor.
27555 In all other cases, we want a hollow box cursor. */
27557 static enum text_cursor_kinds
27558 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27559 bool *active_cursor
)
27561 struct frame
*f
= XFRAME (w
->frame
);
27562 struct buffer
*b
= XBUFFER (w
->contents
);
27563 int cursor_type
= DEFAULT_CURSOR
;
27564 Lisp_Object alt_cursor
;
27565 bool non_selected
= false;
27567 *active_cursor
= true;
27570 if (cursor_in_echo_area
27571 && FRAME_HAS_MINIBUF_P (f
)
27572 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27574 if (w
== XWINDOW (echo_area_window
))
27576 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27578 *width
= FRAME_CURSOR_WIDTH (f
);
27579 return FRAME_DESIRED_CURSOR (f
);
27582 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27585 *active_cursor
= false;
27586 non_selected
= true;
27589 /* Detect a nonselected window or nonselected frame. */
27590 else if (w
!= XWINDOW (f
->selected_window
)
27591 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27593 *active_cursor
= false;
27595 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27598 non_selected
= true;
27601 /* Never display a cursor in a window in which cursor-type is nil. */
27602 if (NILP (BVAR (b
, cursor_type
)))
27605 /* Get the normal cursor type for this window. */
27606 if (EQ (BVAR (b
, cursor_type
), Qt
))
27608 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27609 *width
= FRAME_CURSOR_WIDTH (f
);
27612 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27614 /* Use cursor-in-non-selected-windows instead
27615 for non-selected window or frame. */
27618 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27619 if (!EQ (Qt
, alt_cursor
))
27620 return get_specified_cursor_type (alt_cursor
, width
);
27621 /* t means modify the normal cursor type. */
27622 if (cursor_type
== FILLED_BOX_CURSOR
)
27623 cursor_type
= HOLLOW_BOX_CURSOR
;
27624 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27626 return cursor_type
;
27629 /* Use normal cursor if not blinked off. */
27630 if (!w
->cursor_off_p
)
27632 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27634 if (cursor_type
== FILLED_BOX_CURSOR
)
27636 /* Using a block cursor on large images can be very annoying.
27637 So use a hollow cursor for "large" images.
27638 If image is not transparent (no mask), also use hollow cursor. */
27639 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27640 if (img
!= NULL
&& IMAGEP (img
->spec
))
27642 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27643 where N = size of default frame font size.
27644 This should cover most of the "tiny" icons people may use. */
27646 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27647 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27648 cursor_type
= HOLLOW_BOX_CURSOR
;
27651 else if (cursor_type
!= NO_CURSOR
)
27653 /* Display current only supports BOX and HOLLOW cursors for images.
27654 So for now, unconditionally use a HOLLOW cursor when cursor is
27655 not a solid box cursor. */
27656 cursor_type
= HOLLOW_BOX_CURSOR
;
27659 return cursor_type
;
27662 /* Cursor is blinked off, so determine how to "toggle" it. */
27664 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27665 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27666 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27668 /* Then see if frame has specified a specific blink off cursor type. */
27669 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27671 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27672 return FRAME_BLINK_OFF_CURSOR (f
);
27676 /* Some people liked having a permanently visible blinking cursor,
27677 while others had very strong opinions against it. So it was
27678 decided to remove it. KFS 2003-09-03 */
27680 /* Finally perform built-in cursor blinking:
27681 filled box <-> hollow box
27682 wide [h]bar <-> narrow [h]bar
27683 narrow [h]bar <-> no cursor
27684 other type <-> no cursor */
27686 if (cursor_type
== FILLED_BOX_CURSOR
)
27687 return HOLLOW_BOX_CURSOR
;
27689 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27692 return cursor_type
;
27700 /* Notice when the text cursor of window W has been completely
27701 overwritten by a drawing operation that outputs glyphs in AREA
27702 starting at X0 and ending at X1 in the line starting at Y0 and
27703 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27704 the rest of the line after X0 has been written. Y coordinates
27705 are window-relative. */
27708 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27709 int x0
, int x1
, int y0
, int y1
)
27711 int cx0
, cx1
, cy0
, cy1
;
27712 struct glyph_row
*row
;
27714 if (!w
->phys_cursor_on_p
)
27716 if (area
!= TEXT_AREA
)
27719 if (w
->phys_cursor
.vpos
< 0
27720 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27721 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27722 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27725 if (row
->cursor_in_fringe_p
)
27727 row
->cursor_in_fringe_p
= false;
27728 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27729 w
->phys_cursor_on_p
= false;
27733 cx0
= w
->phys_cursor
.x
;
27734 cx1
= cx0
+ w
->phys_cursor_width
;
27735 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27738 /* The cursor image will be completely removed from the
27739 screen if the output area intersects the cursor area in
27740 y-direction. When we draw in [y0 y1[, and some part of
27741 the cursor is at y < y0, that part must have been drawn
27742 before. When scrolling, the cursor is erased before
27743 actually scrolling, so we don't come here. When not
27744 scrolling, the rows above the old cursor row must have
27745 changed, and in this case these rows must have written
27746 over the cursor image.
27748 Likewise if part of the cursor is below y1, with the
27749 exception of the cursor being in the first blank row at
27750 the buffer and window end because update_text_area
27751 doesn't draw that row. (Except when it does, but
27752 that's handled in update_text_area.) */
27754 cy0
= w
->phys_cursor
.y
;
27755 cy1
= cy0
+ w
->phys_cursor_height
;
27756 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27759 w
->phys_cursor_on_p
= false;
27762 #endif /* HAVE_WINDOW_SYSTEM */
27765 /************************************************************************
27767 ************************************************************************/
27769 #ifdef HAVE_WINDOW_SYSTEM
27772 Fix the display of area AREA of overlapping row ROW in window W
27773 with respect to the overlapping part OVERLAPS. */
27776 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27777 enum glyph_row_area area
, int overlaps
)
27784 for (i
= 0; i
< row
->used
[area
];)
27786 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27788 int start
= i
, start_x
= x
;
27792 x
+= row
->glyphs
[area
][i
].pixel_width
;
27795 while (i
< row
->used
[area
]
27796 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27798 draw_glyphs (w
, start_x
, row
, area
,
27800 DRAW_NORMAL_TEXT
, overlaps
);
27804 x
+= row
->glyphs
[area
][i
].pixel_width
;
27814 Draw the cursor glyph of window W in glyph row ROW. See the
27815 comment of draw_glyphs for the meaning of HL. */
27818 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27819 enum draw_glyphs_face hl
)
27821 /* If cursor hpos is out of bounds, don't draw garbage. This can
27822 happen in mini-buffer windows when switching between echo area
27823 glyphs and mini-buffer. */
27824 if ((row
->reversed_p
27825 ? (w
->phys_cursor
.hpos
>= 0)
27826 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27828 bool on_p
= w
->phys_cursor_on_p
;
27830 int hpos
= w
->phys_cursor
.hpos
;
27832 /* When the window is hscrolled, cursor hpos can legitimately be
27833 out of bounds, but we draw the cursor at the corresponding
27834 window margin in that case. */
27835 if (!row
->reversed_p
&& hpos
< 0)
27837 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27838 hpos
= row
->used
[TEXT_AREA
] - 1;
27840 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27842 w
->phys_cursor_on_p
= on_p
;
27844 if (hl
== DRAW_CURSOR
)
27845 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27846 /* When we erase the cursor, and ROW is overlapped by other
27847 rows, make sure that these overlapping parts of other rows
27849 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27851 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27853 if (row
> w
->current_matrix
->rows
27854 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27855 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27856 OVERLAPS_ERASED_CURSOR
);
27858 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27859 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27860 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27861 OVERLAPS_ERASED_CURSOR
);
27867 /* Erase the image of a cursor of window W from the screen. */
27870 erase_phys_cursor (struct window
*w
)
27872 struct frame
*f
= XFRAME (w
->frame
);
27873 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27874 int hpos
= w
->phys_cursor
.hpos
;
27875 int vpos
= w
->phys_cursor
.vpos
;
27876 bool mouse_face_here_p
= false;
27877 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27878 struct glyph_row
*cursor_row
;
27879 struct glyph
*cursor_glyph
;
27880 enum draw_glyphs_face hl
;
27882 /* No cursor displayed or row invalidated => nothing to do on the
27884 if (w
->phys_cursor_type
== NO_CURSOR
)
27885 goto mark_cursor_off
;
27887 /* VPOS >= active_glyphs->nrows means that window has been resized.
27888 Don't bother to erase the cursor. */
27889 if (vpos
>= active_glyphs
->nrows
)
27890 goto mark_cursor_off
;
27892 /* If row containing cursor is marked invalid, there is nothing we
27894 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27895 if (!cursor_row
->enabled_p
)
27896 goto mark_cursor_off
;
27898 /* If line spacing is > 0, old cursor may only be partially visible in
27899 window after split-window. So adjust visible height. */
27900 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27901 window_text_bottom_y (w
) - cursor_row
->y
);
27903 /* If row is completely invisible, don't attempt to delete a cursor which
27904 isn't there. This can happen if cursor is at top of a window, and
27905 we switch to a buffer with a header line in that window. */
27906 if (cursor_row
->visible_height
<= 0)
27907 goto mark_cursor_off
;
27909 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27910 if (cursor_row
->cursor_in_fringe_p
)
27912 cursor_row
->cursor_in_fringe_p
= false;
27913 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27914 goto mark_cursor_off
;
27917 /* This can happen when the new row is shorter than the old one.
27918 In this case, either draw_glyphs or clear_end_of_line
27919 should have cleared the cursor. Note that we wouldn't be
27920 able to erase the cursor in this case because we don't have a
27921 cursor glyph at hand. */
27922 if ((cursor_row
->reversed_p
27923 ? (w
->phys_cursor
.hpos
< 0)
27924 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27925 goto mark_cursor_off
;
27927 /* When the window is hscrolled, cursor hpos can legitimately be out
27928 of bounds, but we draw the cursor at the corresponding window
27929 margin in that case. */
27930 if (!cursor_row
->reversed_p
&& hpos
< 0)
27932 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27933 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27935 /* If the cursor is in the mouse face area, redisplay that when
27936 we clear the cursor. */
27937 if (! NILP (hlinfo
->mouse_face_window
)
27938 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27939 /* Don't redraw the cursor's spot in mouse face if it is at the
27940 end of a line (on a newline). The cursor appears there, but
27941 mouse highlighting does not. */
27942 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27943 mouse_face_here_p
= true;
27945 /* Maybe clear the display under the cursor. */
27946 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27949 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27952 cursor_glyph
= get_phys_cursor_glyph (w
);
27953 if (cursor_glyph
== NULL
)
27954 goto mark_cursor_off
;
27956 width
= cursor_glyph
->pixel_width
;
27957 x
= w
->phys_cursor
.x
;
27963 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27964 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27965 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27968 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27971 /* Erase the cursor by redrawing the character underneath it. */
27972 if (mouse_face_here_p
)
27973 hl
= DRAW_MOUSE_FACE
;
27975 hl
= DRAW_NORMAL_TEXT
;
27976 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27979 w
->phys_cursor_on_p
= false;
27980 w
->phys_cursor_type
= NO_CURSOR
;
27984 /* Display or clear cursor of window W. If !ON, clear the cursor.
27985 If ON, display the cursor; where to put the cursor is specified by
27986 HPOS, VPOS, X and Y. */
27989 display_and_set_cursor (struct window
*w
, bool on
,
27990 int hpos
, int vpos
, int x
, int y
)
27992 struct frame
*f
= XFRAME (w
->frame
);
27993 int new_cursor_type
;
27994 int new_cursor_width
;
27995 bool active_cursor
;
27996 struct glyph_row
*glyph_row
;
27997 struct glyph
*glyph
;
27999 /* This is pointless on invisible frames, and dangerous on garbaged
28000 windows and frames; in the latter case, the frame or window may
28001 be in the midst of changing its size, and x and y may be off the
28003 if (! FRAME_VISIBLE_P (f
)
28004 || FRAME_GARBAGED_P (f
)
28005 || vpos
>= w
->current_matrix
->nrows
28006 || hpos
>= w
->current_matrix
->matrix_w
)
28009 /* If cursor is off and we want it off, return quickly. */
28010 if (!on
&& !w
->phys_cursor_on_p
)
28013 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28014 /* If cursor row is not enabled, we don't really know where to
28015 display the cursor. */
28016 if (!glyph_row
->enabled_p
)
28018 w
->phys_cursor_on_p
= false;
28023 if (!glyph_row
->exact_window_width_line_p
28024 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28025 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28027 eassert (input_blocked_p ());
28029 /* Set new_cursor_type to the cursor we want to be displayed. */
28030 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28031 &new_cursor_width
, &active_cursor
);
28033 /* If cursor is currently being shown and we don't want it to be or
28034 it is in the wrong place, or the cursor type is not what we want,
28036 if (w
->phys_cursor_on_p
28038 || w
->phys_cursor
.x
!= x
28039 || w
->phys_cursor
.y
!= y
28040 /* HPOS can be negative in R2L rows whose
28041 exact_window_width_line_p flag is set (i.e. their newline
28042 would "overflow into the fringe"). */
28044 || new_cursor_type
!= w
->phys_cursor_type
28045 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28046 && new_cursor_width
!= w
->phys_cursor_width
)))
28047 erase_phys_cursor (w
);
28049 /* Don't check phys_cursor_on_p here because that flag is only set
28050 to false in some cases where we know that the cursor has been
28051 completely erased, to avoid the extra work of erasing the cursor
28052 twice. In other words, phys_cursor_on_p can be true and the cursor
28053 still not be visible, or it has only been partly erased. */
28056 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28057 w
->phys_cursor_height
= glyph_row
->height
;
28059 /* Set phys_cursor_.* before x_draw_.* is called because some
28060 of them may need the information. */
28061 w
->phys_cursor
.x
= x
;
28062 w
->phys_cursor
.y
= glyph_row
->y
;
28063 w
->phys_cursor
.hpos
= hpos
;
28064 w
->phys_cursor
.vpos
= vpos
;
28067 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28068 new_cursor_type
, new_cursor_width
,
28069 on
, active_cursor
);
28073 /* Switch the display of W's cursor on or off, according to the value
28077 update_window_cursor (struct window
*w
, bool on
)
28079 /* Don't update cursor in windows whose frame is in the process
28080 of being deleted. */
28081 if (w
->current_matrix
)
28083 int hpos
= w
->phys_cursor
.hpos
;
28084 int vpos
= w
->phys_cursor
.vpos
;
28085 struct glyph_row
*row
;
28087 if (vpos
>= w
->current_matrix
->nrows
28088 || hpos
>= w
->current_matrix
->matrix_w
)
28091 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28093 /* When the window is hscrolled, cursor hpos can legitimately be
28094 out of bounds, but we draw the cursor at the corresponding
28095 window margin in that case. */
28096 if (!row
->reversed_p
&& hpos
< 0)
28098 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28099 hpos
= row
->used
[TEXT_AREA
] - 1;
28102 display_and_set_cursor (w
, on
, hpos
, vpos
,
28103 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28109 /* Call update_window_cursor with parameter ON_P on all leaf windows
28110 in the window tree rooted at W. */
28113 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28117 if (WINDOWP (w
->contents
))
28118 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28120 update_window_cursor (w
, on_p
);
28122 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28128 Display the cursor on window W, or clear it, according to ON_P.
28129 Don't change the cursor's position. */
28132 x_update_cursor (struct frame
*f
, bool on_p
)
28134 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28139 Clear the cursor of window W to background color, and mark the
28140 cursor as not shown. This is used when the text where the cursor
28141 is about to be rewritten. */
28144 x_clear_cursor (struct window
*w
)
28146 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28147 update_window_cursor (w
, false);
28150 #endif /* HAVE_WINDOW_SYSTEM */
28152 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28155 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28156 int start_hpos
, int end_hpos
,
28157 enum draw_glyphs_face draw
)
28159 #ifdef HAVE_WINDOW_SYSTEM
28160 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28162 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28166 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28167 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28171 /* Display the active region described by mouse_face_* according to DRAW. */
28174 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28176 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28177 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28179 if (/* If window is in the process of being destroyed, don't bother
28181 w
->current_matrix
!= NULL
28182 /* Don't update mouse highlight if hidden. */
28183 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28184 /* Recognize when we are called to operate on rows that don't exist
28185 anymore. This can happen when a window is split. */
28186 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28188 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28189 struct glyph_row
*row
, *first
, *last
;
28191 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28192 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28194 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28196 int start_hpos
, end_hpos
, start_x
;
28198 /* For all but the first row, the highlight starts at column 0. */
28201 /* R2L rows have BEG and END in reversed order, but the
28202 screen drawing geometry is always left to right. So
28203 we need to mirror the beginning and end of the
28204 highlighted area in R2L rows. */
28205 if (!row
->reversed_p
)
28207 start_hpos
= hlinfo
->mouse_face_beg_col
;
28208 start_x
= hlinfo
->mouse_face_beg_x
;
28210 else if (row
== last
)
28212 start_hpos
= hlinfo
->mouse_face_end_col
;
28213 start_x
= hlinfo
->mouse_face_end_x
;
28221 else if (row
->reversed_p
&& row
== last
)
28223 start_hpos
= hlinfo
->mouse_face_end_col
;
28224 start_x
= hlinfo
->mouse_face_end_x
;
28234 if (!row
->reversed_p
)
28235 end_hpos
= hlinfo
->mouse_face_end_col
;
28236 else if (row
== first
)
28237 end_hpos
= hlinfo
->mouse_face_beg_col
;
28240 end_hpos
= row
->used
[TEXT_AREA
];
28241 if (draw
== DRAW_NORMAL_TEXT
)
28242 row
->fill_line_p
= true; /* Clear to end of line. */
28245 else if (row
->reversed_p
&& row
== first
)
28246 end_hpos
= hlinfo
->mouse_face_beg_col
;
28249 end_hpos
= row
->used
[TEXT_AREA
];
28250 if (draw
== DRAW_NORMAL_TEXT
)
28251 row
->fill_line_p
= true; /* Clear to end of line. */
28254 if (end_hpos
> start_hpos
)
28256 draw_row_with_mouse_face (w
, start_x
, row
,
28257 start_hpos
, end_hpos
, draw
);
28260 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28264 #ifdef HAVE_WINDOW_SYSTEM
28265 /* When we've written over the cursor, arrange for it to
28266 be displayed again. */
28267 if (FRAME_WINDOW_P (f
)
28268 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28270 int hpos
= w
->phys_cursor
.hpos
;
28272 /* When the window is hscrolled, cursor hpos can legitimately be
28273 out of bounds, but we draw the cursor at the corresponding
28274 window margin in that case. */
28275 if (!row
->reversed_p
&& hpos
< 0)
28277 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28278 hpos
= row
->used
[TEXT_AREA
] - 1;
28281 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28282 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28285 #endif /* HAVE_WINDOW_SYSTEM */
28288 #ifdef HAVE_WINDOW_SYSTEM
28289 /* Change the mouse cursor. */
28290 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28292 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28293 if (draw
== DRAW_NORMAL_TEXT
28294 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28295 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28298 if (draw
== DRAW_MOUSE_FACE
)
28299 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28301 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28303 #endif /* HAVE_WINDOW_SYSTEM */
28307 Clear out the mouse-highlighted active region.
28308 Redraw it un-highlighted first. Value is true if mouse
28309 face was actually drawn unhighlighted. */
28312 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28315 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28317 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28318 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28319 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28320 hlinfo
->mouse_face_window
= Qnil
;
28321 hlinfo
->mouse_face_overlay
= Qnil
;
28325 /* Return true if the coordinates HPOS and VPOS on windows W are
28326 within the mouse face on that window. */
28328 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28330 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28332 /* Quickly resolve the easy cases. */
28333 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28334 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28336 if (vpos
< hlinfo
->mouse_face_beg_row
28337 || vpos
> hlinfo
->mouse_face_end_row
)
28339 if (vpos
> hlinfo
->mouse_face_beg_row
28340 && vpos
< hlinfo
->mouse_face_end_row
)
28343 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28345 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28347 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28350 else if ((vpos
== hlinfo
->mouse_face_beg_row
28351 && hpos
>= hlinfo
->mouse_face_beg_col
)
28352 || (vpos
== hlinfo
->mouse_face_end_row
28353 && hpos
< hlinfo
->mouse_face_end_col
))
28358 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28360 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28363 else if ((vpos
== hlinfo
->mouse_face_beg_row
28364 && hpos
<= hlinfo
->mouse_face_beg_col
)
28365 || (vpos
== hlinfo
->mouse_face_end_row
28366 && hpos
> hlinfo
->mouse_face_end_col
))
28374 True if physical cursor of window W is within mouse face. */
28377 cursor_in_mouse_face_p (struct window
*w
)
28379 int hpos
= w
->phys_cursor
.hpos
;
28380 int vpos
= w
->phys_cursor
.vpos
;
28381 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28383 /* When the window is hscrolled, cursor hpos can legitimately be out
28384 of bounds, but we draw the cursor at the corresponding window
28385 margin in that case. */
28386 if (!row
->reversed_p
&& hpos
< 0)
28388 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28389 hpos
= row
->used
[TEXT_AREA
] - 1;
28391 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28396 /* Find the glyph rows START_ROW and END_ROW of window W that display
28397 characters between buffer positions START_CHARPOS and END_CHARPOS
28398 (excluding END_CHARPOS). DISP_STRING is a display string that
28399 covers these buffer positions. This is similar to
28400 row_containing_pos, but is more accurate when bidi reordering makes
28401 buffer positions change non-linearly with glyph rows. */
28403 rows_from_pos_range (struct window
*w
,
28404 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28405 Lisp_Object disp_string
,
28406 struct glyph_row
**start
, struct glyph_row
**end
)
28408 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28409 int last_y
= window_text_bottom_y (w
);
28410 struct glyph_row
*row
;
28415 while (!first
->enabled_p
28416 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28419 /* Find the START row. */
28421 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28424 /* A row can potentially be the START row if the range of the
28425 characters it displays intersects the range
28426 [START_CHARPOS..END_CHARPOS). */
28427 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28428 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28429 /* See the commentary in row_containing_pos, for the
28430 explanation of the complicated way to check whether
28431 some position is beyond the end of the characters
28432 displayed by a row. */
28433 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28434 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28435 && !row
->ends_at_zv_p
28436 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28437 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28438 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28439 && !row
->ends_at_zv_p
28440 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28442 /* Found a candidate row. Now make sure at least one of the
28443 glyphs it displays has a charpos from the range
28444 [START_CHARPOS..END_CHARPOS).
28446 This is not obvious because bidi reordering could make
28447 buffer positions of a row be 1,2,3,102,101,100, and if we
28448 want to highlight characters in [50..60), we don't want
28449 this row, even though [50..60) does intersect [1..103),
28450 the range of character positions given by the row's start
28451 and end positions. */
28452 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28453 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28457 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28458 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28459 /* A glyph that comes from DISP_STRING is by
28460 definition to be highlighted. */
28461 || EQ (g
->object
, disp_string
))
28470 /* Find the END row. */
28472 /* If the last row is partially visible, start looking for END
28473 from that row, instead of starting from FIRST. */
28474 && !(row
->enabled_p
28475 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28477 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28479 struct glyph_row
*next
= row
+ 1;
28480 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28482 if (!next
->enabled_p
28483 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28484 /* The first row >= START whose range of displayed characters
28485 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28486 is the row END + 1. */
28487 || (start_charpos
< next_start
28488 && end_charpos
< next_start
)
28489 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28490 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28491 && !next
->ends_at_zv_p
28492 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28493 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28494 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28495 && !next
->ends_at_zv_p
28496 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28503 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28504 but none of the characters it displays are in the range, it is
28506 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28507 struct glyph
*s
= g
;
28508 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28512 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28513 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28514 /* If the buffer position of the first glyph in
28515 the row is equal to END_CHARPOS, it means
28516 the last character to be highlighted is the
28517 newline of ROW, and we must consider NEXT as
28519 || (((!next
->reversed_p
&& g
== s
)
28520 || (next
->reversed_p
&& g
== e
- 1))
28521 && (g
->charpos
== end_charpos
28522 /* Special case for when NEXT is an
28523 empty line at ZV. */
28524 || (g
->charpos
== -1
28525 && !row
->ends_at_zv_p
28526 && next_start
== end_charpos
)))))
28527 /* A glyph that comes from DISP_STRING is by
28528 definition to be highlighted. */
28529 || EQ (g
->object
, disp_string
))
28538 /* The first row that ends at ZV must be the last to be
28540 else if (next
->ends_at_zv_p
)
28549 /* This function sets the mouse_face_* elements of HLINFO, assuming
28550 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28551 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28552 for the overlay or run of text properties specifying the mouse
28553 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28554 before-string and after-string that must also be highlighted.
28555 DISP_STRING, if non-nil, is a display string that may cover some
28556 or all of the highlighted text. */
28559 mouse_face_from_buffer_pos (Lisp_Object window
,
28560 Mouse_HLInfo
*hlinfo
,
28561 ptrdiff_t mouse_charpos
,
28562 ptrdiff_t start_charpos
,
28563 ptrdiff_t end_charpos
,
28564 Lisp_Object before_string
,
28565 Lisp_Object after_string
,
28566 Lisp_Object disp_string
)
28568 struct window
*w
= XWINDOW (window
);
28569 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28570 struct glyph_row
*r1
, *r2
;
28571 struct glyph
*glyph
, *end
;
28572 ptrdiff_t ignore
, pos
;
28575 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28576 eassert (NILP (before_string
) || STRINGP (before_string
));
28577 eassert (NILP (after_string
) || STRINGP (after_string
));
28579 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28580 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28582 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28583 /* If the before-string or display-string contains newlines,
28584 rows_from_pos_range skips to its last row. Move back. */
28585 if (!NILP (before_string
) || !NILP (disp_string
))
28587 struct glyph_row
*prev
;
28588 while ((prev
= r1
- 1, prev
>= first
)
28589 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28590 && prev
->used
[TEXT_AREA
] > 0)
28592 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28593 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28594 while (--glyph
>= beg
&& NILP (glyph
->object
));
28596 || !(EQ (glyph
->object
, before_string
)
28597 || EQ (glyph
->object
, disp_string
)))
28604 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28605 hlinfo
->mouse_face_past_end
= true;
28607 else if (!NILP (after_string
))
28609 /* If the after-string has newlines, advance to its last row. */
28610 struct glyph_row
*next
;
28611 struct glyph_row
*last
28612 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28614 for (next
= r2
+ 1;
28616 && next
->used
[TEXT_AREA
] > 0
28617 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28621 /* The rest of the display engine assumes that mouse_face_beg_row is
28622 either above mouse_face_end_row or identical to it. But with
28623 bidi-reordered continued lines, the row for START_CHARPOS could
28624 be below the row for END_CHARPOS. If so, swap the rows and store
28625 them in correct order. */
28628 struct glyph_row
*tem
= r2
;
28634 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28635 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28637 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28638 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28639 could be anywhere in the row and in any order. The strategy
28640 below is to find the leftmost and the rightmost glyph that
28641 belongs to either of these 3 strings, or whose position is
28642 between START_CHARPOS and END_CHARPOS, and highlight all the
28643 glyphs between those two. This may cover more than just the text
28644 between START_CHARPOS and END_CHARPOS if the range of characters
28645 strides the bidi level boundary, e.g. if the beginning is in R2L
28646 text while the end is in L2R text or vice versa. */
28647 if (!r1
->reversed_p
)
28649 /* This row is in a left to right paragraph. Scan it left to
28651 glyph
= r1
->glyphs
[TEXT_AREA
];
28652 end
= glyph
+ r1
->used
[TEXT_AREA
];
28655 /* Skip truncation glyphs at the start of the glyph row. */
28656 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28658 && NILP (glyph
->object
)
28659 && glyph
->charpos
< 0;
28661 x
+= glyph
->pixel_width
;
28663 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28664 or DISP_STRING, and the first glyph from buffer whose
28665 position is between START_CHARPOS and END_CHARPOS. */
28667 && !NILP (glyph
->object
)
28668 && !EQ (glyph
->object
, disp_string
)
28669 && !(BUFFERP (glyph
->object
)
28670 && (glyph
->charpos
>= start_charpos
28671 && glyph
->charpos
< end_charpos
));
28674 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28675 are present at buffer positions between START_CHARPOS and
28676 END_CHARPOS, or if they come from an overlay. */
28677 if (EQ (glyph
->object
, before_string
))
28679 pos
= string_buffer_position (before_string
,
28681 /* If pos == 0, it means before_string came from an
28682 overlay, not from a buffer position. */
28683 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28686 else if (EQ (glyph
->object
, after_string
))
28688 pos
= string_buffer_position (after_string
, end_charpos
);
28689 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28692 x
+= glyph
->pixel_width
;
28694 hlinfo
->mouse_face_beg_x
= x
;
28695 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28699 /* This row is in a right to left paragraph. Scan it right to
28703 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28704 glyph
= end
+ r1
->used
[TEXT_AREA
];
28706 /* Skip truncation glyphs at the start of the glyph row. */
28707 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28709 && NILP (glyph
->object
)
28710 && glyph
->charpos
< 0;
28714 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28715 or DISP_STRING, and the first glyph from buffer whose
28716 position is between START_CHARPOS and END_CHARPOS. */
28718 && !NILP (glyph
->object
)
28719 && !EQ (glyph
->object
, disp_string
)
28720 && !(BUFFERP (glyph
->object
)
28721 && (glyph
->charpos
>= start_charpos
28722 && glyph
->charpos
< end_charpos
));
28725 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28726 are present at buffer positions between START_CHARPOS and
28727 END_CHARPOS, or if they come from an overlay. */
28728 if (EQ (glyph
->object
, before_string
))
28730 pos
= string_buffer_position (before_string
, start_charpos
);
28731 /* If pos == 0, it means before_string came from an
28732 overlay, not from a buffer position. */
28733 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28736 else if (EQ (glyph
->object
, after_string
))
28738 pos
= string_buffer_position (after_string
, end_charpos
);
28739 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28744 glyph
++; /* first glyph to the right of the highlighted area */
28745 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28746 x
+= g
->pixel_width
;
28747 hlinfo
->mouse_face_beg_x
= x
;
28748 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28751 /* If the highlight ends in a different row, compute GLYPH and END
28752 for the end row. Otherwise, reuse the values computed above for
28753 the row where the highlight begins. */
28756 if (!r2
->reversed_p
)
28758 glyph
= r2
->glyphs
[TEXT_AREA
];
28759 end
= glyph
+ r2
->used
[TEXT_AREA
];
28764 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28765 glyph
= end
+ r2
->used
[TEXT_AREA
];
28769 if (!r2
->reversed_p
)
28771 /* Skip truncation and continuation glyphs near the end of the
28772 row, and also blanks and stretch glyphs inserted by
28773 extend_face_to_end_of_line. */
28775 && NILP ((end
- 1)->object
))
28777 /* Scan the rest of the glyph row from the end, looking for the
28778 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28779 DISP_STRING, or whose position is between START_CHARPOS
28783 && !NILP (end
->object
)
28784 && !EQ (end
->object
, disp_string
)
28785 && !(BUFFERP (end
->object
)
28786 && (end
->charpos
>= start_charpos
28787 && end
->charpos
< end_charpos
));
28790 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28791 are present at buffer positions between START_CHARPOS and
28792 END_CHARPOS, or if they come from an overlay. */
28793 if (EQ (end
->object
, before_string
))
28795 pos
= string_buffer_position (before_string
, start_charpos
);
28796 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28799 else if (EQ (end
->object
, after_string
))
28801 pos
= string_buffer_position (after_string
, end_charpos
);
28802 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28806 /* Find the X coordinate of the last glyph to be highlighted. */
28807 for (; glyph
<= end
; ++glyph
)
28808 x
+= glyph
->pixel_width
;
28810 hlinfo
->mouse_face_end_x
= x
;
28811 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28815 /* Skip truncation and continuation glyphs near the end of the
28816 row, and also blanks and stretch glyphs inserted by
28817 extend_face_to_end_of_line. */
28821 && NILP (end
->object
))
28823 x
+= end
->pixel_width
;
28826 /* Scan the rest of the glyph row from the end, looking for the
28827 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28828 DISP_STRING, or whose position is between START_CHARPOS
28832 && !NILP (end
->object
)
28833 && !EQ (end
->object
, disp_string
)
28834 && !(BUFFERP (end
->object
)
28835 && (end
->charpos
>= start_charpos
28836 && end
->charpos
< end_charpos
));
28839 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28840 are present at buffer positions between START_CHARPOS and
28841 END_CHARPOS, or if they come from an overlay. */
28842 if (EQ (end
->object
, before_string
))
28844 pos
= string_buffer_position (before_string
, start_charpos
);
28845 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28848 else if (EQ (end
->object
, after_string
))
28850 pos
= string_buffer_position (after_string
, end_charpos
);
28851 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28854 x
+= end
->pixel_width
;
28856 /* If we exited the above loop because we arrived at the last
28857 glyph of the row, and its buffer position is still not in
28858 range, it means the last character in range is the preceding
28859 newline. Bump the end column and x values to get past the
28862 && BUFFERP (end
->object
)
28863 && (end
->charpos
< start_charpos
28864 || end
->charpos
>= end_charpos
))
28866 x
+= end
->pixel_width
;
28869 hlinfo
->mouse_face_end_x
= x
;
28870 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28873 hlinfo
->mouse_face_window
= window
;
28874 hlinfo
->mouse_face_face_id
28875 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28877 !hlinfo
->mouse_face_hidden
, -1);
28878 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28881 /* The following function is not used anymore (replaced with
28882 mouse_face_from_string_pos), but I leave it here for the time
28883 being, in case someone would. */
28885 #if false /* not used */
28887 /* Find the position of the glyph for position POS in OBJECT in
28888 window W's current matrix, and return in *X, *Y the pixel
28889 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28891 RIGHT_P means return the position of the right edge of the glyph.
28892 !RIGHT_P means return the left edge position.
28894 If no glyph for POS exists in the matrix, return the position of
28895 the glyph with the next smaller position that is in the matrix, if
28896 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28897 exists in the matrix, return the position of the glyph with the
28898 next larger position in OBJECT.
28900 Value is true if a glyph was found. */
28903 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28904 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28906 int yb
= window_text_bottom_y (w
);
28907 struct glyph_row
*r
;
28908 struct glyph
*best_glyph
= NULL
;
28909 struct glyph_row
*best_row
= NULL
;
28912 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28913 r
->enabled_p
&& r
->y
< yb
;
28916 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28917 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28920 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28921 if (EQ (g
->object
, object
))
28923 if (g
->charpos
== pos
)
28930 else if (best_glyph
== NULL
28931 || ((eabs (g
->charpos
- pos
)
28932 < eabs (best_glyph
->charpos
- pos
))
28935 : g
->charpos
> pos
)))
28949 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28953 *x
+= best_glyph
->pixel_width
;
28958 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28961 return best_glyph
!= NULL
;
28963 #endif /* not used */
28965 /* Find the positions of the first and the last glyphs in window W's
28966 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28967 (assumed to be a string), and return in HLINFO's mouse_face_*
28968 members the pixel and column/row coordinates of those glyphs. */
28971 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28972 Lisp_Object object
,
28973 ptrdiff_t startpos
, ptrdiff_t endpos
)
28975 int yb
= window_text_bottom_y (w
);
28976 struct glyph_row
*r
;
28977 struct glyph
*g
, *e
;
28979 bool found
= false;
28981 /* Find the glyph row with at least one position in the range
28982 [STARTPOS..ENDPOS), and the first glyph in that row whose
28983 position belongs to that range. */
28984 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28985 r
->enabled_p
&& r
->y
< yb
;
28988 if (!r
->reversed_p
)
28990 g
= r
->glyphs
[TEXT_AREA
];
28991 e
= g
+ r
->used
[TEXT_AREA
];
28992 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28993 if (EQ (g
->object
, object
)
28994 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28996 hlinfo
->mouse_face_beg_row
28997 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28998 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28999 hlinfo
->mouse_face_beg_x
= gx
;
29008 e
= r
->glyphs
[TEXT_AREA
];
29009 g
= e
+ r
->used
[TEXT_AREA
];
29010 for ( ; g
> e
; --g
)
29011 if (EQ ((g
-1)->object
, object
)
29012 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29014 hlinfo
->mouse_face_beg_row
29015 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29016 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29017 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29018 gx
+= g1
->pixel_width
;
29019 hlinfo
->mouse_face_beg_x
= gx
;
29031 /* Starting with the next row, look for the first row which does NOT
29032 include any glyphs whose positions are in the range. */
29033 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29035 g
= r
->glyphs
[TEXT_AREA
];
29036 e
= g
+ r
->used
[TEXT_AREA
];
29038 for ( ; g
< e
; ++g
)
29039 if (EQ (g
->object
, object
)
29040 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29049 /* The highlighted region ends on the previous row. */
29052 /* Set the end row. */
29053 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29055 /* Compute and set the end column and the end column's horizontal
29056 pixel coordinate. */
29057 if (!r
->reversed_p
)
29059 g
= r
->glyphs
[TEXT_AREA
];
29060 e
= g
+ r
->used
[TEXT_AREA
];
29061 for ( ; e
> g
; --e
)
29062 if (EQ ((e
-1)->object
, object
)
29063 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29065 hlinfo
->mouse_face_end_col
= e
- g
;
29067 for (gx
= r
->x
; g
< e
; ++g
)
29068 gx
+= g
->pixel_width
;
29069 hlinfo
->mouse_face_end_x
= gx
;
29073 e
= r
->glyphs
[TEXT_AREA
];
29074 g
= e
+ r
->used
[TEXT_AREA
];
29075 for (gx
= r
->x
; e
< g
; ++e
)
29077 if (EQ (e
->object
, object
)
29078 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29080 gx
+= e
->pixel_width
;
29082 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29083 hlinfo
->mouse_face_end_x
= gx
;
29087 #ifdef HAVE_WINDOW_SYSTEM
29089 /* See if position X, Y is within a hot-spot of an image. */
29092 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29094 if (!CONSP (hot_spot
))
29097 if (EQ (XCAR (hot_spot
), Qrect
))
29099 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29100 Lisp_Object rect
= XCDR (hot_spot
);
29104 if (!CONSP (XCAR (rect
)))
29106 if (!CONSP (XCDR (rect
)))
29108 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29110 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29112 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29114 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29118 else if (EQ (XCAR (hot_spot
), Qcircle
))
29120 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29121 Lisp_Object circ
= XCDR (hot_spot
);
29122 Lisp_Object lr
, lx0
, ly0
;
29124 && CONSP (XCAR (circ
))
29125 && (lr
= XCDR (circ
), NUMBERP (lr
))
29126 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29127 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29129 double r
= XFLOATINT (lr
);
29130 double dx
= XINT (lx0
) - x
;
29131 double dy
= XINT (ly0
) - y
;
29132 return (dx
* dx
+ dy
* dy
<= r
* r
);
29135 else if (EQ (XCAR (hot_spot
), Qpoly
))
29137 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29138 if (VECTORP (XCDR (hot_spot
)))
29140 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29141 Lisp_Object
*poly
= v
->contents
;
29142 ptrdiff_t n
= v
->header
.size
;
29144 bool inside
= false;
29145 Lisp_Object lx
, ly
;
29148 /* Need an even number of coordinates, and at least 3 edges. */
29149 if (n
< 6 || n
& 1)
29152 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29153 If count is odd, we are inside polygon. Pixels on edges
29154 may or may not be included depending on actual geometry of the
29156 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29157 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29159 x0
= XINT (lx
), y0
= XINT (ly
);
29160 for (i
= 0; i
< n
; i
+= 2)
29162 int x1
= x0
, y1
= y0
;
29163 if ((lx
= poly
[i
], !INTEGERP (lx
))
29164 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29166 x0
= XINT (lx
), y0
= XINT (ly
);
29168 /* Does this segment cross the X line? */
29176 if (y
> y0
&& y
> y1
)
29178 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29188 find_hot_spot (Lisp_Object map
, int x
, int y
)
29190 while (CONSP (map
))
29192 if (CONSP (XCAR (map
))
29193 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29201 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29203 doc
: /* Lookup in image map MAP coordinates X and Y.
29204 An image map is an alist where each element has the format (AREA ID PLIST).
29205 An AREA is specified as either a rectangle, a circle, or a polygon:
29206 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29207 pixel coordinates of the upper left and bottom right corners.
29208 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29209 and the radius of the circle; r may be a float or integer.
29210 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29211 vector describes one corner in the polygon.
29212 Returns the alist element for the first matching AREA in MAP. */)
29213 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29221 return find_hot_spot (map
,
29222 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29223 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29227 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29229 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29231 /* Do not change cursor shape while dragging mouse. */
29232 if (EQ (do_mouse_tracking
, Qdragging
))
29235 if (!NILP (pointer
))
29237 if (EQ (pointer
, Qarrow
))
29238 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29239 else if (EQ (pointer
, Qhand
))
29240 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29241 else if (EQ (pointer
, Qtext
))
29242 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29243 else if (EQ (pointer
, intern ("hdrag")))
29244 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29245 else if (EQ (pointer
, intern ("nhdrag")))
29246 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29247 #ifdef HAVE_X_WINDOWS
29248 else if (EQ (pointer
, intern ("vdrag")))
29249 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29251 else if (EQ (pointer
, intern ("hourglass")))
29252 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29253 else if (EQ (pointer
, Qmodeline
))
29254 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29256 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29259 if (cursor
!= No_Cursor
)
29260 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29263 #endif /* HAVE_WINDOW_SYSTEM */
29265 /* Take proper action when mouse has moved to the mode or header line
29266 or marginal area AREA of window W, x-position X and y-position Y.
29267 X is relative to the start of the text display area of W, so the
29268 width of bitmap areas and scroll bars must be subtracted to get a
29269 position relative to the start of the mode line. */
29272 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29273 enum window_part area
)
29275 struct window
*w
= XWINDOW (window
);
29276 struct frame
*f
= XFRAME (w
->frame
);
29277 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29278 #ifdef HAVE_WINDOW_SYSTEM
29279 Display_Info
*dpyinfo
;
29281 Cursor cursor
= No_Cursor
;
29282 Lisp_Object pointer
= Qnil
;
29283 int dx
, dy
, width
, height
;
29285 Lisp_Object string
, object
= Qnil
;
29286 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29288 Lisp_Object mouse_face
;
29289 int original_x_pixel
= x
;
29290 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29291 struct glyph_row
*row
IF_LINT (= 0);
29293 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29298 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29299 returns them in row/column units! */
29300 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29301 &object
, &dx
, &dy
, &width
, &height
);
29303 row
= (area
== ON_MODE_LINE
29304 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29305 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29307 /* Find the glyph under the mouse pointer. */
29308 if (row
->mode_line_p
&& row
->enabled_p
)
29310 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29311 end
= glyph
+ row
->used
[TEXT_AREA
];
29313 for (x0
= original_x_pixel
;
29314 glyph
< end
&& x0
>= glyph
->pixel_width
;
29316 x0
-= glyph
->pixel_width
;
29324 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29325 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29326 returns them in row/column units! */
29327 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29328 &object
, &dx
, &dy
, &width
, &height
);
29333 #ifdef HAVE_WINDOW_SYSTEM
29334 if (IMAGEP (object
))
29336 Lisp_Object image_map
, hotspot
;
29337 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29339 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29341 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29345 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29346 If so, we could look for mouse-enter, mouse-leave
29347 properties in PLIST (and do something...). */
29348 hotspot
= XCDR (hotspot
);
29349 if (CONSP (hotspot
)
29350 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29352 pointer
= Fplist_get (plist
, Qpointer
);
29353 if (NILP (pointer
))
29355 help
= Fplist_get (plist
, Qhelp_echo
);
29358 help_echo_string
= help
;
29359 XSETWINDOW (help_echo_window
, w
);
29360 help_echo_object
= w
->contents
;
29361 help_echo_pos
= charpos
;
29365 if (NILP (pointer
))
29366 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29368 #endif /* HAVE_WINDOW_SYSTEM */
29370 if (STRINGP (string
))
29371 pos
= make_number (charpos
);
29373 /* Set the help text and mouse pointer. If the mouse is on a part
29374 of the mode line without any text (e.g. past the right edge of
29375 the mode line text), use the default help text and pointer. */
29376 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29378 /* Arrange to display the help by setting the global variables
29379 help_echo_string, help_echo_object, and help_echo_pos. */
29382 if (STRINGP (string
))
29383 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29387 help_echo_string
= help
;
29388 XSETWINDOW (help_echo_window
, w
);
29389 help_echo_object
= string
;
29390 help_echo_pos
= charpos
;
29392 else if (area
== ON_MODE_LINE
)
29394 Lisp_Object default_help
29395 = buffer_local_value (Qmode_line_default_help_echo
,
29398 if (STRINGP (default_help
))
29400 help_echo_string
= default_help
;
29401 XSETWINDOW (help_echo_window
, w
);
29402 help_echo_object
= Qnil
;
29403 help_echo_pos
= -1;
29408 #ifdef HAVE_WINDOW_SYSTEM
29409 /* Change the mouse pointer according to what is under it. */
29410 if (FRAME_WINDOW_P (f
))
29412 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29414 || NILP (Vresize_mini_windows
));
29416 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29417 if (STRINGP (string
))
29419 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29421 if (NILP (pointer
))
29422 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29424 /* Change the mouse pointer according to what is under X/Y. */
29426 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29429 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29430 if (!KEYMAPP (map
))
29431 map
= Fget_text_property (pos
, Qkeymap
, string
);
29432 if (!KEYMAPP (map
) && draggable
)
29433 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29436 else if (draggable
)
29437 /* Default mode-line pointer. */
29438 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29443 /* Change the mouse face according to what is under X/Y. */
29444 bool mouse_face_shown
= false;
29445 if (STRINGP (string
))
29447 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29448 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29449 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29454 struct glyph
* tmp_glyph
;
29458 int total_pixel_width
;
29459 ptrdiff_t begpos
, endpos
, ignore
;
29463 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29464 Qmouse_face
, string
, Qnil
);
29470 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29472 endpos
= SCHARS (string
);
29476 /* Calculate the glyph position GPOS of GLYPH in the
29477 displayed string, relative to the beginning of the
29478 highlighted part of the string.
29480 Note: GPOS is different from CHARPOS. CHARPOS is the
29481 position of GLYPH in the internal string object. A mode
29482 line string format has structures which are converted to
29483 a flattened string by the Emacs Lisp interpreter. The
29484 internal string is an element of those structures. The
29485 displayed string is the flattened string. */
29486 tmp_glyph
= row_start_glyph
;
29487 while (tmp_glyph
< glyph
29488 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29489 && begpos
<= tmp_glyph
->charpos
29490 && tmp_glyph
->charpos
< endpos
)))
29492 gpos
= glyph
- tmp_glyph
;
29494 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29495 the highlighted part of the displayed string to which
29496 GLYPH belongs. Note: GSEQ_LENGTH is different from
29497 SCHARS (STRING), because the latter returns the length of
29498 the internal string. */
29499 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29501 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29502 && begpos
<= tmp_glyph
->charpos
29503 && tmp_glyph
->charpos
< endpos
));
29506 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29508 /* Calculate the total pixel width of all the glyphs between
29509 the beginning of the highlighted area and GLYPH. */
29510 total_pixel_width
= 0;
29511 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29512 total_pixel_width
+= tmp_glyph
->pixel_width
;
29514 /* Pre calculation of re-rendering position. Note: X is in
29515 column units here, after the call to mode_line_string or
29516 marginal_area_string. */
29518 vpos
= (area
== ON_MODE_LINE
29519 ? (w
->current_matrix
)->nrows
- 1
29522 /* If GLYPH's position is included in the region that is
29523 already drawn in mouse face, we have nothing to do. */
29524 if ( EQ (window
, hlinfo
->mouse_face_window
)
29525 && (!row
->reversed_p
29526 ? (hlinfo
->mouse_face_beg_col
<= hpos
29527 && hpos
< hlinfo
->mouse_face_end_col
)
29528 /* In R2L rows we swap BEG and END, see below. */
29529 : (hlinfo
->mouse_face_end_col
<= hpos
29530 && hpos
< hlinfo
->mouse_face_beg_col
))
29531 && hlinfo
->mouse_face_beg_row
== vpos
)
29534 if (clear_mouse_face (hlinfo
))
29535 cursor
= No_Cursor
;
29537 if (!row
->reversed_p
)
29539 hlinfo
->mouse_face_beg_col
= hpos
;
29540 hlinfo
->mouse_face_beg_x
= original_x_pixel
29541 - (total_pixel_width
+ dx
);
29542 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29543 hlinfo
->mouse_face_end_x
= 0;
29547 /* In R2L rows, show_mouse_face expects BEG and END
29548 coordinates to be swapped. */
29549 hlinfo
->mouse_face_end_col
= hpos
;
29550 hlinfo
->mouse_face_end_x
= original_x_pixel
29551 - (total_pixel_width
+ dx
);
29552 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29553 hlinfo
->mouse_face_beg_x
= 0;
29556 hlinfo
->mouse_face_beg_row
= vpos
;
29557 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29558 hlinfo
->mouse_face_past_end
= false;
29559 hlinfo
->mouse_face_window
= window
;
29561 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29566 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29567 mouse_face_shown
= true;
29569 if (NILP (pointer
))
29574 /* If mouse-face doesn't need to be shown, clear any existing
29576 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29577 clear_mouse_face (hlinfo
);
29579 #ifdef HAVE_WINDOW_SYSTEM
29580 if (FRAME_WINDOW_P (f
))
29581 define_frame_cursor1 (f
, cursor
, pointer
);
29587 Take proper action when the mouse has moved to position X, Y on
29588 frame F with regards to highlighting portions of display that have
29589 mouse-face properties. Also de-highlight portions of display where
29590 the mouse was before, set the mouse pointer shape as appropriate
29591 for the mouse coordinates, and activate help echo (tooltips).
29592 X and Y can be negative or out of range. */
29595 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29597 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29598 enum window_part part
= ON_NOTHING
;
29599 Lisp_Object window
;
29601 Cursor cursor
= No_Cursor
;
29602 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29605 /* When a menu is active, don't highlight because this looks odd. */
29606 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29607 if (popup_activated ())
29611 if (!f
->glyphs_initialized_p
29612 || f
->pointer_invisible
)
29615 hlinfo
->mouse_face_mouse_x
= x
;
29616 hlinfo
->mouse_face_mouse_y
= y
;
29617 hlinfo
->mouse_face_mouse_frame
= f
;
29619 if (hlinfo
->mouse_face_defer
)
29622 /* Which window is that in? */
29623 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29625 /* If displaying active text in another window, clear that. */
29626 if (! EQ (window
, hlinfo
->mouse_face_window
)
29627 /* Also clear if we move out of text area in same window. */
29628 || (!NILP (hlinfo
->mouse_face_window
)
29631 && part
!= ON_MODE_LINE
29632 && part
!= ON_HEADER_LINE
))
29633 clear_mouse_face (hlinfo
);
29635 /* Not on a window -> return. */
29636 if (!WINDOWP (window
))
29639 /* Reset help_echo_string. It will get recomputed below. */
29640 help_echo_string
= Qnil
;
29642 /* Convert to window-relative pixel coordinates. */
29643 w
= XWINDOW (window
);
29644 frame_to_window_pixel_xy (w
, &x
, &y
);
29646 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29647 /* Handle tool-bar window differently since it doesn't display a
29649 if (EQ (window
, f
->tool_bar_window
))
29651 note_tool_bar_highlight (f
, x
, y
);
29656 /* Mouse is on the mode, header line or margin? */
29657 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29658 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29660 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29662 #ifdef HAVE_WINDOW_SYSTEM
29663 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29665 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29666 /* Show non-text cursor (Bug#16647). */
29674 #ifdef HAVE_WINDOW_SYSTEM
29675 if (part
== ON_VERTICAL_BORDER
)
29677 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29678 help_echo_string
= build_string ("drag-mouse-1: resize");
29680 else if (part
== ON_RIGHT_DIVIDER
)
29682 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29683 help_echo_string
= build_string ("drag-mouse-1: resize");
29685 else if (part
== ON_BOTTOM_DIVIDER
)
29686 if (! WINDOW_BOTTOMMOST_P (w
)
29688 || NILP (Vresize_mini_windows
))
29690 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29691 help_echo_string
= build_string ("drag-mouse-1: resize");
29694 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29695 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29696 || part
== ON_VERTICAL_SCROLL_BAR
29697 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29698 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29700 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29703 /* Are we in a window whose display is up to date?
29704 And verify the buffer's text has not changed. */
29705 b
= XBUFFER (w
->contents
);
29706 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29708 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29710 struct glyph
*glyph
;
29711 Lisp_Object object
;
29712 Lisp_Object mouse_face
= Qnil
, position
;
29713 Lisp_Object
*overlay_vec
= NULL
;
29714 ptrdiff_t i
, noverlays
;
29715 struct buffer
*obuf
;
29716 ptrdiff_t obegv
, ozv
;
29719 /* Find the glyph under X/Y. */
29720 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29722 #ifdef HAVE_WINDOW_SYSTEM
29723 /* Look for :pointer property on image. */
29724 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29726 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29727 if (img
!= NULL
&& IMAGEP (img
->spec
))
29729 Lisp_Object image_map
, hotspot
;
29730 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29732 && (hotspot
= find_hot_spot (image_map
,
29733 glyph
->slice
.img
.x
+ dx
,
29734 glyph
->slice
.img
.y
+ dy
),
29736 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29740 /* Could check XCAR (hotspot) to see if we enter/leave
29742 If so, we could look for mouse-enter, mouse-leave
29743 properties in PLIST (and do something...). */
29744 hotspot
= XCDR (hotspot
);
29745 if (CONSP (hotspot
)
29746 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29748 pointer
= Fplist_get (plist
, Qpointer
);
29749 if (NILP (pointer
))
29751 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29752 if (!NILP (help_echo_string
))
29754 help_echo_window
= window
;
29755 help_echo_object
= glyph
->object
;
29756 help_echo_pos
= glyph
->charpos
;
29760 if (NILP (pointer
))
29761 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29764 #endif /* HAVE_WINDOW_SYSTEM */
29766 /* Clear mouse face if X/Y not over text. */
29768 || area
!= TEXT_AREA
29769 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29770 /* Glyph's OBJECT is nil for glyphs inserted by the
29771 display engine for its internal purposes, like truncation
29772 and continuation glyphs and blanks beyond the end of
29773 line's text on text terminals. If we are over such a
29774 glyph, we are not over any text. */
29775 || NILP (glyph
->object
)
29776 /* R2L rows have a stretch glyph at their front, which
29777 stands for no text, whereas L2R rows have no glyphs at
29778 all beyond the end of text. Treat such stretch glyphs
29779 like we do with NULL glyphs in L2R rows. */
29780 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29781 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29782 && glyph
->type
== STRETCH_GLYPH
29783 && glyph
->avoid_cursor_p
))
29785 if (clear_mouse_face (hlinfo
))
29786 cursor
= No_Cursor
;
29787 #ifdef HAVE_WINDOW_SYSTEM
29788 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29790 if (area
!= TEXT_AREA
)
29791 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29793 pointer
= Vvoid_text_area_pointer
;
29799 pos
= glyph
->charpos
;
29800 object
= glyph
->object
;
29801 if (!STRINGP (object
) && !BUFFERP (object
))
29804 /* If we get an out-of-range value, return now; avoid an error. */
29805 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29808 /* Make the window's buffer temporarily current for
29809 overlays_at and compute_char_face. */
29810 obuf
= current_buffer
;
29811 current_buffer
= b
;
29817 /* Is this char mouse-active or does it have help-echo? */
29818 position
= make_number (pos
);
29822 if (BUFFERP (object
))
29824 /* Put all the overlays we want in a vector in overlay_vec. */
29825 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29826 /* Sort overlays into increasing priority order. */
29827 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29832 if (NILP (Vmouse_highlight
))
29834 clear_mouse_face (hlinfo
);
29835 goto check_help_echo
;
29838 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29841 cursor
= No_Cursor
;
29843 /* Check mouse-face highlighting. */
29845 /* If there exists an overlay with mouse-face overlapping
29846 the one we are currently highlighting, we have to
29847 check if we enter the overlapping overlay, and then
29848 highlight only that. */
29849 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29850 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29852 /* Find the highest priority overlay with a mouse-face. */
29853 Lisp_Object overlay
= Qnil
;
29854 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29856 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29857 if (!NILP (mouse_face
))
29858 overlay
= overlay_vec
[i
];
29861 /* If we're highlighting the same overlay as before, there's
29862 no need to do that again. */
29863 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29864 goto check_help_echo
;
29865 hlinfo
->mouse_face_overlay
= overlay
;
29867 /* Clear the display of the old active region, if any. */
29868 if (clear_mouse_face (hlinfo
))
29869 cursor
= No_Cursor
;
29871 /* If no overlay applies, get a text property. */
29872 if (NILP (overlay
))
29873 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29875 /* Next, compute the bounds of the mouse highlighting and
29877 if (!NILP (mouse_face
) && STRINGP (object
))
29879 /* The mouse-highlighting comes from a display string
29880 with a mouse-face. */
29884 s
= Fprevious_single_property_change
29885 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29886 e
= Fnext_single_property_change
29887 (position
, Qmouse_face
, object
, Qnil
);
29889 s
= make_number (0);
29891 e
= make_number (SCHARS (object
));
29892 mouse_face_from_string_pos (w
, hlinfo
, object
,
29893 XINT (s
), XINT (e
));
29894 hlinfo
->mouse_face_past_end
= false;
29895 hlinfo
->mouse_face_window
= window
;
29896 hlinfo
->mouse_face_face_id
29897 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29898 glyph
->face_id
, true);
29899 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29900 cursor
= No_Cursor
;
29904 /* The mouse-highlighting, if any, comes from an overlay
29905 or text property in the buffer. */
29906 Lisp_Object buffer
IF_LINT (= Qnil
);
29907 Lisp_Object disp_string
IF_LINT (= Qnil
);
29909 if (STRINGP (object
))
29911 /* If we are on a display string with no mouse-face,
29912 check if the text under it has one. */
29913 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29914 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29915 pos
= string_buffer_position (object
, start
);
29918 mouse_face
= get_char_property_and_overlay
29919 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29920 buffer
= w
->contents
;
29921 disp_string
= object
;
29927 disp_string
= Qnil
;
29930 if (!NILP (mouse_face
))
29932 Lisp_Object before
, after
;
29933 Lisp_Object before_string
, after_string
;
29934 /* To correctly find the limits of mouse highlight
29935 in a bidi-reordered buffer, we must not use the
29936 optimization of limiting the search in
29937 previous-single-property-change and
29938 next-single-property-change, because
29939 rows_from_pos_range needs the real start and end
29940 positions to DTRT in this case. That's because
29941 the first row visible in a window does not
29942 necessarily display the character whose position
29943 is the smallest. */
29945 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29946 ? Fmarker_position (w
->start
)
29949 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29950 ? make_number (BUF_Z (XBUFFER (buffer
))
29951 - w
->window_end_pos
)
29954 if (NILP (overlay
))
29956 /* Handle the text property case. */
29957 before
= Fprevious_single_property_change
29958 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29959 after
= Fnext_single_property_change
29960 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29961 before_string
= after_string
= Qnil
;
29965 /* Handle the overlay case. */
29966 before
= Foverlay_start (overlay
);
29967 after
= Foverlay_end (overlay
);
29968 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29969 after_string
= Foverlay_get (overlay
, Qafter_string
);
29971 if (!STRINGP (before_string
)) before_string
= Qnil
;
29972 if (!STRINGP (after_string
)) after_string
= Qnil
;
29975 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29978 : XFASTINT (before
),
29980 ? BUF_Z (XBUFFER (buffer
))
29981 : XFASTINT (after
),
29982 before_string
, after_string
,
29984 cursor
= No_Cursor
;
29991 /* Look for a `help-echo' property. */
29992 if (NILP (help_echo_string
)) {
29993 Lisp_Object help
, overlay
;
29995 /* Check overlays first. */
29996 help
= overlay
= Qnil
;
29997 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29999 overlay
= overlay_vec
[i
];
30000 help
= Foverlay_get (overlay
, Qhelp_echo
);
30005 help_echo_string
= help
;
30006 help_echo_window
= window
;
30007 help_echo_object
= overlay
;
30008 help_echo_pos
= pos
;
30012 Lisp_Object obj
= glyph
->object
;
30013 ptrdiff_t charpos
= glyph
->charpos
;
30015 /* Try text properties. */
30018 && charpos
< SCHARS (obj
))
30020 help
= Fget_text_property (make_number (charpos
),
30024 /* If the string itself doesn't specify a help-echo,
30025 see if the buffer text ``under'' it does. */
30026 struct glyph_row
*r
30027 = MATRIX_ROW (w
->current_matrix
, vpos
);
30028 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30029 ptrdiff_t p
= string_buffer_position (obj
, start
);
30032 help
= Fget_char_property (make_number (p
),
30033 Qhelp_echo
, w
->contents
);
30042 else if (BUFFERP (obj
)
30045 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30050 help_echo_string
= help
;
30051 help_echo_window
= window
;
30052 help_echo_object
= obj
;
30053 help_echo_pos
= charpos
;
30058 #ifdef HAVE_WINDOW_SYSTEM
30059 /* Look for a `pointer' property. */
30060 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30062 /* Check overlays first. */
30063 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30064 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30066 if (NILP (pointer
))
30068 Lisp_Object obj
= glyph
->object
;
30069 ptrdiff_t charpos
= glyph
->charpos
;
30071 /* Try text properties. */
30074 && charpos
< SCHARS (obj
))
30076 pointer
= Fget_text_property (make_number (charpos
),
30078 if (NILP (pointer
))
30080 /* If the string itself doesn't specify a pointer,
30081 see if the buffer text ``under'' it does. */
30082 struct glyph_row
*r
30083 = MATRIX_ROW (w
->current_matrix
, vpos
);
30084 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30085 ptrdiff_t p
= string_buffer_position (obj
, start
);
30087 pointer
= Fget_char_property (make_number (p
),
30088 Qpointer
, w
->contents
);
30091 else if (BUFFERP (obj
)
30094 pointer
= Fget_text_property (make_number (charpos
),
30098 #endif /* HAVE_WINDOW_SYSTEM */
30102 current_buffer
= obuf
;
30108 #ifdef HAVE_WINDOW_SYSTEM
30109 if (FRAME_WINDOW_P (f
))
30110 define_frame_cursor1 (f
, cursor
, pointer
);
30112 /* This is here to prevent a compiler error, about "label at end of
30113 compound statement". */
30120 Clear any mouse-face on window W. This function is part of the
30121 redisplay interface, and is called from try_window_id and similar
30122 functions to ensure the mouse-highlight is off. */
30125 x_clear_window_mouse_face (struct window
*w
)
30127 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30128 Lisp_Object window
;
30131 XSETWINDOW (window
, w
);
30132 if (EQ (window
, hlinfo
->mouse_face_window
))
30133 clear_mouse_face (hlinfo
);
30139 Just discard the mouse face information for frame F, if any.
30140 This is used when the size of F is changed. */
30143 cancel_mouse_face (struct frame
*f
)
30145 Lisp_Object window
;
30146 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30148 window
= hlinfo
->mouse_face_window
;
30149 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30150 reset_mouse_highlight (hlinfo
);
30155 /***********************************************************************
30157 ***********************************************************************/
30159 #ifdef HAVE_WINDOW_SYSTEM
30161 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30162 which intersects rectangle R. R is in window-relative coordinates. */
30165 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30166 enum glyph_row_area area
)
30168 struct glyph
*first
= row
->glyphs
[area
];
30169 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30170 struct glyph
*last
;
30171 int first_x
, start_x
, x
;
30173 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30174 /* If row extends face to end of line write the whole line. */
30175 draw_glyphs (w
, 0, row
, area
,
30176 0, row
->used
[area
],
30177 DRAW_NORMAL_TEXT
, 0);
30180 /* Set START_X to the window-relative start position for drawing glyphs of
30181 AREA. The first glyph of the text area can be partially visible.
30182 The first glyphs of other areas cannot. */
30183 start_x
= window_box_left_offset (w
, area
);
30185 if (area
== TEXT_AREA
)
30188 /* Find the first glyph that must be redrawn. */
30190 && x
+ first
->pixel_width
< r
->x
)
30192 x
+= first
->pixel_width
;
30196 /* Find the last one. */
30199 /* Use a signed int intermediate value to avoid catastrophic
30200 failures due to comparison between signed and unsigned, when
30201 x is negative (can happen for wide images that are hscrolled). */
30202 int r_end
= r
->x
+ r
->width
;
30203 while (last
< end
&& x
< r_end
)
30205 x
+= last
->pixel_width
;
30211 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30212 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30213 DRAW_NORMAL_TEXT
, 0);
30218 /* Redraw the parts of the glyph row ROW on window W intersecting
30219 rectangle R. R is in window-relative coordinates. Value is
30220 true if mouse-face was overwritten. */
30223 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30225 eassert (row
->enabled_p
);
30227 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30228 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30229 0, row
->used
[TEXT_AREA
],
30230 DRAW_NORMAL_TEXT
, 0);
30233 if (row
->used
[LEFT_MARGIN_AREA
])
30234 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30235 if (row
->used
[TEXT_AREA
])
30236 expose_area (w
, row
, r
, TEXT_AREA
);
30237 if (row
->used
[RIGHT_MARGIN_AREA
])
30238 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30239 draw_row_fringe_bitmaps (w
, row
);
30242 return row
->mouse_face_p
;
30246 /* Redraw those parts of glyphs rows during expose event handling that
30247 overlap other rows. Redrawing of an exposed line writes over parts
30248 of lines overlapping that exposed line; this function fixes that.
30250 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30251 row in W's current matrix that is exposed and overlaps other rows.
30252 LAST_OVERLAPPING_ROW is the last such row. */
30255 expose_overlaps (struct window
*w
,
30256 struct glyph_row
*first_overlapping_row
,
30257 struct glyph_row
*last_overlapping_row
,
30260 struct glyph_row
*row
;
30262 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30263 if (row
->overlapping_p
)
30265 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30268 if (row
->used
[LEFT_MARGIN_AREA
])
30269 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30271 if (row
->used
[TEXT_AREA
])
30272 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30274 if (row
->used
[RIGHT_MARGIN_AREA
])
30275 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30281 /* Return true if W's cursor intersects rectangle R. */
30284 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30286 XRectangle cr
, result
;
30287 struct glyph
*cursor_glyph
;
30288 struct glyph_row
*row
;
30290 if (w
->phys_cursor
.vpos
>= 0
30291 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30292 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30294 && row
->cursor_in_fringe_p
)
30296 /* Cursor is in the fringe. */
30297 cr
.x
= window_box_right_offset (w
,
30298 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30299 ? RIGHT_MARGIN_AREA
30302 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30303 cr
.height
= row
->height
;
30304 return x_intersect_rectangles (&cr
, r
, &result
);
30307 cursor_glyph
= get_phys_cursor_glyph (w
);
30310 /* r is relative to W's box, but w->phys_cursor.x is relative
30311 to left edge of W's TEXT area. Adjust it. */
30312 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30313 cr
.y
= w
->phys_cursor
.y
;
30314 cr
.width
= cursor_glyph
->pixel_width
;
30315 cr
.height
= w
->phys_cursor_height
;
30316 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30317 I assume the effect is the same -- and this is portable. */
30318 return x_intersect_rectangles (&cr
, r
, &result
);
30320 /* If we don't understand the format, pretend we're not in the hot-spot. */
30326 Draw a vertical window border to the right of window W if W doesn't
30327 have vertical scroll bars. */
30330 x_draw_vertical_border (struct window
*w
)
30332 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30334 /* We could do better, if we knew what type of scroll-bar the adjacent
30335 windows (on either side) have... But we don't :-(
30336 However, I think this works ok. ++KFS 2003-04-25 */
30338 /* Redraw borders between horizontally adjacent windows. Don't
30339 do it for frames with vertical scroll bars because either the
30340 right scroll bar of a window, or the left scroll bar of its
30341 neighbor will suffice as a border. */
30342 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30345 /* Note: It is necessary to redraw both the left and the right
30346 borders, for when only this single window W is being
30348 if (!WINDOW_RIGHTMOST_P (w
)
30349 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30351 int x0
, x1
, y0
, y1
;
30353 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30356 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30359 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30362 if (!WINDOW_LEFTMOST_P (w
)
30363 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30365 int x0
, x1
, y0
, y1
;
30367 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30370 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30373 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30378 /* Draw window dividers for window W. */
30381 x_draw_right_divider (struct window
*w
)
30383 struct frame
*f
= WINDOW_XFRAME (w
);
30385 if (w
->mini
|| w
->pseudo_window_p
)
30387 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30389 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30390 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30391 int y0
= WINDOW_TOP_EDGE_Y (w
);
30392 /* The bottom divider prevails. */
30393 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30395 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30400 x_draw_bottom_divider (struct window
*w
)
30402 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30404 if (w
->mini
|| w
->pseudo_window_p
)
30406 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30408 int x0
= WINDOW_LEFT_EDGE_X (w
);
30409 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30410 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30411 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30413 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30417 /* Redraw the part of window W intersection rectangle FR. Pixel
30418 coordinates in FR are frame-relative. Call this function with
30419 input blocked. Value is true if the exposure overwrites
30423 expose_window (struct window
*w
, XRectangle
*fr
)
30425 struct frame
*f
= XFRAME (w
->frame
);
30427 bool mouse_face_overwritten_p
= false;
30429 /* If window is not yet fully initialized, do nothing. This can
30430 happen when toolkit scroll bars are used and a window is split.
30431 Reconfiguring the scroll bar will generate an expose for a newly
30433 if (w
->current_matrix
== NULL
)
30436 /* When we're currently updating the window, display and current
30437 matrix usually don't agree. Arrange for a thorough display
30439 if (w
->must_be_updated_p
)
30441 SET_FRAME_GARBAGED (f
);
30445 /* Frame-relative pixel rectangle of W. */
30446 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30447 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30448 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30449 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30451 if (x_intersect_rectangles (fr
, &wr
, &r
))
30453 int yb
= window_text_bottom_y (w
);
30454 struct glyph_row
*row
;
30455 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30457 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30458 r
.x
, r
.y
, r
.width
, r
.height
));
30460 /* Convert to window coordinates. */
30461 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30462 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30464 /* Turn off the cursor. */
30465 bool cursor_cleared_p
= (!w
->pseudo_window_p
30466 && phys_cursor_in_rect_p (w
, &r
));
30467 if (cursor_cleared_p
)
30468 x_clear_cursor (w
);
30470 /* If the row containing the cursor extends face to end of line,
30471 then expose_area might overwrite the cursor outside the
30472 rectangle and thus notice_overwritten_cursor might clear
30473 w->phys_cursor_on_p. We remember the original value and
30474 check later if it is changed. */
30475 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30477 /* Use a signed int intermediate value to avoid catastrophic
30478 failures due to comparison between signed and unsigned, when
30479 y0 or y1 is negative (can happen for tall images). */
30480 int r_bottom
= r
.y
+ r
.height
;
30482 /* Update lines intersecting rectangle R. */
30483 first_overlapping_row
= last_overlapping_row
= NULL
;
30484 for (row
= w
->current_matrix
->rows
;
30489 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30491 if ((y0
>= r
.y
&& y0
< r_bottom
)
30492 || (y1
> r
.y
&& y1
< r_bottom
)
30493 || (r
.y
>= y0
&& r
.y
< y1
)
30494 || (r_bottom
> y0
&& r_bottom
< y1
))
30496 /* A header line may be overlapping, but there is no need
30497 to fix overlapping areas for them. KFS 2005-02-12 */
30498 if (row
->overlapping_p
&& !row
->mode_line_p
)
30500 if (first_overlapping_row
== NULL
)
30501 first_overlapping_row
= row
;
30502 last_overlapping_row
= row
;
30506 if (expose_line (w
, row
, &r
))
30507 mouse_face_overwritten_p
= true;
30510 else if (row
->overlapping_p
)
30512 /* We must redraw a row overlapping the exposed area. */
30514 ? y0
+ row
->phys_height
> r
.y
30515 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30517 if (first_overlapping_row
== NULL
)
30518 first_overlapping_row
= row
;
30519 last_overlapping_row
= row
;
30527 /* Display the mode line if there is one. */
30528 if (WINDOW_WANTS_MODELINE_P (w
)
30529 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30531 && row
->y
< r_bottom
)
30533 if (expose_line (w
, row
, &r
))
30534 mouse_face_overwritten_p
= true;
30537 if (!w
->pseudo_window_p
)
30539 /* Fix the display of overlapping rows. */
30540 if (first_overlapping_row
)
30541 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30544 /* Draw border between windows. */
30545 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30546 x_draw_right_divider (w
);
30548 x_draw_vertical_border (w
);
30550 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30551 x_draw_bottom_divider (w
);
30553 /* Turn the cursor on again. */
30554 if (cursor_cleared_p
30555 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30556 update_window_cursor (w
, true);
30560 return mouse_face_overwritten_p
;
30565 /* Redraw (parts) of all windows in the window tree rooted at W that
30566 intersect R. R contains frame pixel coordinates. Value is
30567 true if the exposure overwrites mouse-face. */
30570 expose_window_tree (struct window
*w
, XRectangle
*r
)
30572 struct frame
*f
= XFRAME (w
->frame
);
30573 bool mouse_face_overwritten_p
= false;
30575 while (w
&& !FRAME_GARBAGED_P (f
))
30577 mouse_face_overwritten_p
30578 |= (WINDOWP (w
->contents
)
30579 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30580 : expose_window (w
, r
));
30582 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30585 return mouse_face_overwritten_p
;
30590 Redisplay an exposed area of frame F. X and Y are the upper-left
30591 corner of the exposed rectangle. W and H are width and height of
30592 the exposed area. All are pixel values. W or H zero means redraw
30593 the entire frame. */
30596 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30599 bool mouse_face_overwritten_p
= false;
30601 TRACE ((stderr
, "expose_frame "));
30603 /* No need to redraw if frame will be redrawn soon. */
30604 if (FRAME_GARBAGED_P (f
))
30606 TRACE ((stderr
, " garbaged\n"));
30610 /* If basic faces haven't been realized yet, there is no point in
30611 trying to redraw anything. This can happen when we get an expose
30612 event while Emacs is starting, e.g. by moving another window. */
30613 if (FRAME_FACE_CACHE (f
) == NULL
30614 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30616 TRACE ((stderr
, " no faces\n"));
30620 if (w
== 0 || h
== 0)
30623 r
.width
= FRAME_TEXT_WIDTH (f
);
30624 r
.height
= FRAME_TEXT_HEIGHT (f
);
30634 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30635 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30637 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30638 if (WINDOWP (f
->tool_bar_window
))
30639 mouse_face_overwritten_p
30640 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30643 #ifdef HAVE_X_WINDOWS
30645 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30646 if (WINDOWP (f
->menu_bar_window
))
30647 mouse_face_overwritten_p
30648 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30649 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30653 /* Some window managers support a focus-follows-mouse style with
30654 delayed raising of frames. Imagine a partially obscured frame,
30655 and moving the mouse into partially obscured mouse-face on that
30656 frame. The visible part of the mouse-face will be highlighted,
30657 then the WM raises the obscured frame. With at least one WM, KDE
30658 2.1, Emacs is not getting any event for the raising of the frame
30659 (even tried with SubstructureRedirectMask), only Expose events.
30660 These expose events will draw text normally, i.e. not
30661 highlighted. Which means we must redo the highlight here.
30662 Subsume it under ``we love X''. --gerd 2001-08-15 */
30663 /* Included in Windows version because Windows most likely does not
30664 do the right thing if any third party tool offers
30665 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30666 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30668 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30669 if (f
== hlinfo
->mouse_face_mouse_frame
)
30671 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30672 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30673 clear_mouse_face (hlinfo
);
30674 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30681 Determine the intersection of two rectangles R1 and R2. Return
30682 the intersection in *RESULT. Value is true if RESULT is not
30686 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30688 XRectangle
*left
, *right
;
30689 XRectangle
*upper
, *lower
;
30690 bool intersection_p
= false;
30692 /* Rearrange so that R1 is the left-most rectangle. */
30694 left
= r1
, right
= r2
;
30696 left
= r2
, right
= r1
;
30698 /* X0 of the intersection is right.x0, if this is inside R1,
30699 otherwise there is no intersection. */
30700 if (right
->x
<= left
->x
+ left
->width
)
30702 result
->x
= right
->x
;
30704 /* The right end of the intersection is the minimum of
30705 the right ends of left and right. */
30706 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30709 /* Same game for Y. */
30711 upper
= r1
, lower
= r2
;
30713 upper
= r2
, lower
= r1
;
30715 /* The upper end of the intersection is lower.y0, if this is inside
30716 of upper. Otherwise, there is no intersection. */
30717 if (lower
->y
<= upper
->y
+ upper
->height
)
30719 result
->y
= lower
->y
;
30721 /* The lower end of the intersection is the minimum of the lower
30722 ends of upper and lower. */
30723 result
->height
= (min (lower
->y
+ lower
->height
,
30724 upper
->y
+ upper
->height
)
30726 intersection_p
= true;
30730 return intersection_p
;
30733 #endif /* HAVE_WINDOW_SYSTEM */
30736 /***********************************************************************
30738 ***********************************************************************/
30741 syms_of_xdisp (void)
30743 Vwith_echo_area_save_vector
= Qnil
;
30744 staticpro (&Vwith_echo_area_save_vector
);
30746 Vmessage_stack
= Qnil
;
30747 staticpro (&Vmessage_stack
);
30749 /* Non-nil means don't actually do any redisplay. */
30750 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30752 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30754 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30755 doc
: /* Non-nil means calls to `message' are not displayed.
30756 They are still logged to the *Messages* buffer. */);
30757 inhibit_message
= 0;
30759 message_dolog_marker1
= Fmake_marker ();
30760 staticpro (&message_dolog_marker1
);
30761 message_dolog_marker2
= Fmake_marker ();
30762 staticpro (&message_dolog_marker2
);
30763 message_dolog_marker3
= Fmake_marker ();
30764 staticpro (&message_dolog_marker3
);
30767 defsubr (&Sdump_frame_glyph_matrix
);
30768 defsubr (&Sdump_glyph_matrix
);
30769 defsubr (&Sdump_glyph_row
);
30770 defsubr (&Sdump_tool_bar_row
);
30771 defsubr (&Strace_redisplay
);
30772 defsubr (&Strace_to_stderr
);
30774 #ifdef HAVE_WINDOW_SYSTEM
30775 defsubr (&Stool_bar_height
);
30776 defsubr (&Slookup_image_map
);
30778 defsubr (&Sline_pixel_height
);
30779 defsubr (&Sformat_mode_line
);
30780 defsubr (&Sinvisible_p
);
30781 defsubr (&Scurrent_bidi_paragraph_direction
);
30782 defsubr (&Swindow_text_pixel_size
);
30783 defsubr (&Smove_point_visually
);
30784 defsubr (&Sbidi_find_overridden_directionality
);
30786 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30787 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30788 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30789 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30790 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30791 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30792 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30793 DEFSYM (Qeval
, "eval");
30794 DEFSYM (QCdata
, ":data");
30796 /* Names of text properties relevant for redisplay. */
30797 DEFSYM (Qdisplay
, "display");
30798 DEFSYM (Qspace_width
, "space-width");
30799 DEFSYM (Qraise
, "raise");
30800 DEFSYM (Qslice
, "slice");
30801 DEFSYM (Qspace
, "space");
30802 DEFSYM (Qmargin
, "margin");
30803 DEFSYM (Qpointer
, "pointer");
30804 DEFSYM (Qleft_margin
, "left-margin");
30805 DEFSYM (Qright_margin
, "right-margin");
30806 DEFSYM (Qcenter
, "center");
30807 DEFSYM (Qline_height
, "line-height");
30808 DEFSYM (QCalign_to
, ":align-to");
30809 DEFSYM (QCrelative_width
, ":relative-width");
30810 DEFSYM (QCrelative_height
, ":relative-height");
30811 DEFSYM (QCeval
, ":eval");
30812 DEFSYM (QCpropertize
, ":propertize");
30813 DEFSYM (QCfile
, ":file");
30814 DEFSYM (Qfontified
, "fontified");
30815 DEFSYM (Qfontification_functions
, "fontification-functions");
30817 /* Name of the face used to highlight trailing whitespace. */
30818 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30820 /* Name and number of the face used to highlight escape glyphs. */
30821 DEFSYM (Qescape_glyph
, "escape-glyph");
30823 /* Name and number of the face used to highlight non-breaking spaces. */
30824 DEFSYM (Qnobreak_space
, "nobreak-space");
30826 /* The symbol 'image' which is the car of the lists used to represent
30827 images in Lisp. Also a tool bar style. */
30828 DEFSYM (Qimage
, "image");
30830 /* Tool bar styles. */
30831 DEFSYM (Qtext
, "text");
30832 DEFSYM (Qboth
, "both");
30833 DEFSYM (Qboth_horiz
, "both-horiz");
30834 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30836 /* The image map types. */
30837 DEFSYM (QCmap
, ":map");
30838 DEFSYM (QCpointer
, ":pointer");
30839 DEFSYM (Qrect
, "rect");
30840 DEFSYM (Qcircle
, "circle");
30841 DEFSYM (Qpoly
, "poly");
30843 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30845 DEFSYM (Qgrow_only
, "grow-only");
30846 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30847 DEFSYM (Qposition
, "position");
30848 DEFSYM (Qbuffer_position
, "buffer-position");
30849 DEFSYM (Qobject
, "object");
30851 /* Cursor shapes. */
30852 DEFSYM (Qbar
, "bar");
30853 DEFSYM (Qhbar
, "hbar");
30854 DEFSYM (Qbox
, "box");
30855 DEFSYM (Qhollow
, "hollow");
30857 /* Pointer shapes. */
30858 DEFSYM (Qhand
, "hand");
30859 DEFSYM (Qarrow
, "arrow");
30862 DEFSYM (Qdragging
, "dragging");
30864 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30866 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30867 staticpro (&list_of_error
);
30869 /* Values of those variables at last redisplay are stored as
30870 properties on 'overlay-arrow-position' symbol. However, if
30871 Voverlay_arrow_position is a marker, last-arrow-position is its
30872 numerical position. */
30873 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30874 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30876 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30877 properties on a symbol in overlay-arrow-variable-list. */
30878 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30879 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30881 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30882 staticpro (&echo_buffer
[0]);
30883 staticpro (&echo_buffer
[1]);
30885 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30886 staticpro (&echo_area_buffer
[0]);
30887 staticpro (&echo_area_buffer
[1]);
30889 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30890 staticpro (&Vmessages_buffer_name
);
30892 mode_line_proptrans_alist
= Qnil
;
30893 staticpro (&mode_line_proptrans_alist
);
30894 mode_line_string_list
= Qnil
;
30895 staticpro (&mode_line_string_list
);
30896 mode_line_string_face
= Qnil
;
30897 staticpro (&mode_line_string_face
);
30898 mode_line_string_face_prop
= Qnil
;
30899 staticpro (&mode_line_string_face_prop
);
30900 Vmode_line_unwind_vector
= Qnil
;
30901 staticpro (&Vmode_line_unwind_vector
);
30903 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30905 help_echo_string
= Qnil
;
30906 staticpro (&help_echo_string
);
30907 help_echo_object
= Qnil
;
30908 staticpro (&help_echo_object
);
30909 help_echo_window
= Qnil
;
30910 staticpro (&help_echo_window
);
30911 previous_help_echo_string
= Qnil
;
30912 staticpro (&previous_help_echo_string
);
30913 help_echo_pos
= -1;
30915 DEFSYM (Qright_to_left
, "right-to-left");
30916 DEFSYM (Qleft_to_right
, "left-to-right");
30917 defsubr (&Sbidi_resolved_levels
);
30919 #ifdef HAVE_WINDOW_SYSTEM
30920 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30921 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30922 For example, if a block cursor is over a tab, it will be drawn as
30923 wide as that tab on the display. */);
30924 x_stretch_cursor_p
= 0;
30927 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30928 doc
: /* Non-nil means highlight trailing whitespace.
30929 The face used for trailing whitespace is `trailing-whitespace'. */);
30930 Vshow_trailing_whitespace
= Qnil
;
30932 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30933 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30934 If the value is t, Emacs highlights non-ASCII chars which have the
30935 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30936 or `escape-glyph' face respectively.
30938 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30939 U+2011 (non-breaking hyphen) are affected.
30941 Any other non-nil value means to display these characters as a escape
30942 glyph followed by an ordinary space or hyphen.
30944 A value of nil means no special handling of these characters. */);
30945 Vnobreak_char_display
= Qt
;
30947 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30948 doc
: /* The pointer shape to show in void text areas.
30949 A value of nil means to show the text pointer. Other options are
30950 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30952 Vvoid_text_area_pointer
= Qarrow
;
30954 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30955 doc
: /* Non-nil means don't actually do any redisplay.
30956 This is used for internal purposes. */);
30957 Vinhibit_redisplay
= Qnil
;
30959 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30960 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30961 Vglobal_mode_string
= Qnil
;
30963 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30964 doc
: /* Marker for where to display an arrow on top of the buffer text.
30965 This must be the beginning of a line in order to work.
30966 See also `overlay-arrow-string'. */);
30967 Voverlay_arrow_position
= Qnil
;
30969 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30970 doc
: /* String to display as an arrow in non-window frames.
30971 See also `overlay-arrow-position'. */);
30972 Voverlay_arrow_string
= build_pure_c_string ("=>");
30974 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30975 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30976 The symbols on this list are examined during redisplay to determine
30977 where to display overlay arrows. */);
30978 Voverlay_arrow_variable_list
30979 = list1 (intern_c_string ("overlay-arrow-position"));
30981 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30982 doc
: /* The number of lines to try scrolling a window by when point moves out.
30983 If that fails to bring point back on frame, point is centered instead.
30984 If this is zero, point is always centered after it moves off frame.
30985 If you want scrolling to always be a line at a time, you should set
30986 `scroll-conservatively' to a large value rather than set this to 1. */);
30988 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30989 doc
: /* Scroll up to this many lines, to bring point back on screen.
30990 If point moves off-screen, redisplay will scroll by up to
30991 `scroll-conservatively' lines in order to bring point just barely
30992 onto the screen again. If that cannot be done, then redisplay
30993 recenters point as usual.
30995 If the value is greater than 100, redisplay will never recenter point,
30996 but will always scroll just enough text to bring point into view, even
30997 if you move far away.
30999 A value of zero means always recenter point if it moves off screen. */);
31000 scroll_conservatively
= 0;
31002 DEFVAR_INT ("scroll-margin", scroll_margin
,
31003 doc
: /* Number of lines of margin at the top and bottom of a window.
31004 Recenter the window whenever point gets within this many lines
31005 of the top or bottom of the window. */);
31008 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31009 doc
: /* Pixels per inch value for non-window system displays.
31010 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31011 Vdisplay_pixels_per_inch
= make_float (72.0);
31014 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31017 DEFVAR_LISP ("truncate-partial-width-windows",
31018 Vtruncate_partial_width_windows
,
31019 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31020 For an integer value, truncate lines in each window narrower than the
31021 full frame width, provided the window width is less than that integer;
31022 otherwise, respect the value of `truncate-lines'.
31024 For any other non-nil value, truncate lines in all windows that do
31025 not span the full frame width.
31027 A value of nil means to respect the value of `truncate-lines'.
31029 If `word-wrap' is enabled, you might want to reduce this. */);
31030 Vtruncate_partial_width_windows
= make_number (50);
31032 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31033 doc
: /* Maximum buffer size for which line number should be displayed.
31034 If the buffer is bigger than this, the line number does not appear
31035 in the mode line. A value of nil means no limit. */);
31036 Vline_number_display_limit
= Qnil
;
31038 DEFVAR_INT ("line-number-display-limit-width",
31039 line_number_display_limit_width
,
31040 doc
: /* Maximum line width (in characters) for line number display.
31041 If the average length of the lines near point is bigger than this, then the
31042 line number may be omitted from the mode line. */);
31043 line_number_display_limit_width
= 200;
31045 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31046 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31047 highlight_nonselected_windows
= false;
31049 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31050 doc
: /* Non-nil if more than one frame is visible on this display.
31051 Minibuffer-only frames don't count, but iconified frames do.
31052 This variable is not guaranteed to be accurate except while processing
31053 `frame-title-format' and `icon-title-format'. */);
31055 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31056 doc
: /* Template for displaying the title bar of visible frames.
31057 (Assuming the window manager supports this feature.)
31059 This variable has the same structure as `mode-line-format', except that
31060 the %c and %l constructs are ignored. It is used only on frames for
31061 which no explicit name has been set (see `modify-frame-parameters'). */);
31063 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31064 doc
: /* Template for displaying the title bar of an iconified frame.
31065 (Assuming the window manager supports this feature.)
31066 This variable has the same structure as `mode-line-format' (which see),
31067 and is used only on frames for which no explicit name has been set
31068 (see `modify-frame-parameters'). */);
31070 = Vframe_title_format
31071 = listn (CONSTYPE_PURE
, 3,
31072 intern_c_string ("multiple-frames"),
31073 build_pure_c_string ("%b"),
31074 listn (CONSTYPE_PURE
, 4,
31075 empty_unibyte_string
,
31076 intern_c_string ("invocation-name"),
31077 build_pure_c_string ("@"),
31078 intern_c_string ("system-name")));
31080 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31081 doc
: /* Maximum number of lines to keep in the message log buffer.
31082 If nil, disable message logging. If t, log messages but don't truncate
31083 the buffer when it becomes large. */);
31084 Vmessage_log_max
= make_number (1000);
31086 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31087 doc
: /* Functions called before redisplay, if window sizes have changed.
31088 The value should be a list of functions that take one argument.
31089 Just before redisplay, for each frame, if any of its windows have changed
31090 size since the last redisplay, or have been split or deleted,
31091 all the functions in the list are called, with the frame as argument. */);
31092 Vwindow_size_change_functions
= Qnil
;
31094 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31095 doc
: /* List of functions to call before redisplaying a window with scrolling.
31096 Each function is called with two arguments, the window and its new
31097 display-start position.
31098 These functions are called whenever the `window-start' marker is modified,
31099 either to point into another buffer (e.g. via `set-window-buffer') or another
31100 place in the same buffer.
31101 Note that the value of `window-end' is not valid when these functions are
31104 Warning: Do not use this feature to alter the way the window
31105 is scrolled. It is not designed for that, and such use probably won't
31107 Vwindow_scroll_functions
= Qnil
;
31109 DEFVAR_LISP ("window-text-change-functions",
31110 Vwindow_text_change_functions
,
31111 doc
: /* Functions to call in redisplay when text in the window might change. */);
31112 Vwindow_text_change_functions
= Qnil
;
31114 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31115 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31116 Each function is called with two arguments, the window and the end trigger value.
31117 See `set-window-redisplay-end-trigger'. */);
31118 Vredisplay_end_trigger_functions
= Qnil
;
31120 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31121 doc
: /* Non-nil means autoselect window with mouse pointer.
31122 If nil, do not autoselect windows.
31123 A positive number means delay autoselection by that many seconds: a
31124 window is autoselected only after the mouse has remained in that
31125 window for the duration of the delay.
31126 A negative number has a similar effect, but causes windows to be
31127 autoselected only after the mouse has stopped moving. (Because of
31128 the way Emacs compares mouse events, you will occasionally wait twice
31129 that time before the window gets selected.)
31130 Any other value means to autoselect window instantaneously when the
31131 mouse pointer enters it.
31133 Autoselection selects the minibuffer only if it is active, and never
31134 unselects the minibuffer if it is active.
31136 When customizing this variable make sure that the actual value of
31137 `focus-follows-mouse' matches the behavior of your window manager. */);
31138 Vmouse_autoselect_window
= Qnil
;
31140 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31141 doc
: /* Non-nil means automatically resize tool-bars.
31142 This dynamically changes the tool-bar's height to the minimum height
31143 that is needed to make all tool-bar items visible.
31144 If value is `grow-only', the tool-bar's height is only increased
31145 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31146 Vauto_resize_tool_bars
= Qt
;
31148 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31149 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31150 auto_raise_tool_bar_buttons_p
= true;
31152 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31153 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31154 make_cursor_line_fully_visible_p
= true;
31156 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31157 doc
: /* Border below tool-bar in pixels.
31158 If an integer, use it as the height of the border.
31159 If it is one of `internal-border-width' or `border-width', use the
31160 value of the corresponding frame parameter.
31161 Otherwise, no border is added below the tool-bar. */);
31162 Vtool_bar_border
= Qinternal_border_width
;
31164 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31165 doc
: /* Margin around tool-bar buttons in pixels.
31166 If an integer, use that for both horizontal and vertical margins.
31167 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31168 HORZ specifying the horizontal margin, and VERT specifying the
31169 vertical margin. */);
31170 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31172 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31173 doc
: /* Relief thickness of tool-bar buttons. */);
31174 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31176 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31177 doc
: /* Tool bar style to use.
31179 image - show images only
31180 text - show text only
31181 both - show both, text below image
31182 both-horiz - show text to the right of the image
31183 text-image-horiz - show text to the left of the image
31184 any other - use system default or image if no system default.
31186 This variable only affects the GTK+ toolkit version of Emacs. */);
31187 Vtool_bar_style
= Qnil
;
31189 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31190 doc
: /* Maximum number of characters a label can have to be shown.
31191 The tool bar style must also show labels for this to have any effect, see
31192 `tool-bar-style'. */);
31193 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31195 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31196 doc
: /* List of functions to call to fontify regions of text.
31197 Each function is called with one argument POS. Functions must
31198 fontify a region starting at POS in the current buffer, and give
31199 fontified regions the property `fontified'. */);
31200 Vfontification_functions
= Qnil
;
31201 Fmake_variable_buffer_local (Qfontification_functions
);
31203 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31204 unibyte_display_via_language_environment
,
31205 doc
: /* Non-nil means display unibyte text according to language environment.
31206 Specifically, this means that raw bytes in the range 160-255 decimal
31207 are displayed by converting them to the equivalent multibyte characters
31208 according to the current language environment. As a result, they are
31209 displayed according to the current fontset.
31211 Note that this variable affects only how these bytes are displayed,
31212 but does not change the fact they are interpreted as raw bytes. */);
31213 unibyte_display_via_language_environment
= false;
31215 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31216 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31217 If a float, it specifies a fraction of the mini-window frame's height.
31218 If an integer, it specifies a number of lines. */);
31219 Vmax_mini_window_height
= make_float (0.25);
31221 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31222 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31223 A value of nil means don't automatically resize mini-windows.
31224 A value of t means resize them to fit the text displayed in them.
31225 A value of `grow-only', the default, means let mini-windows grow only;
31226 they return to their normal size when the minibuffer is closed, or the
31227 echo area becomes empty. */);
31228 Vresize_mini_windows
= Qgrow_only
;
31230 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31231 doc
: /* Alist specifying how to blink the cursor off.
31232 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31233 `cursor-type' frame-parameter or variable equals ON-STATE,
31234 comparing using `equal', Emacs uses OFF-STATE to specify
31235 how to blink it off. ON-STATE and OFF-STATE are values for
31236 the `cursor-type' frame parameter.
31238 If a frame's ON-STATE has no entry in this list,
31239 the frame's other specifications determine how to blink the cursor off. */);
31240 Vblink_cursor_alist
= Qnil
;
31242 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31243 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31244 If non-nil, windows are automatically scrolled horizontally to make
31245 point visible. */);
31246 automatic_hscrolling_p
= true;
31247 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31249 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31250 doc
: /* How many columns away from the window edge point is allowed to get
31251 before automatic hscrolling will horizontally scroll the window. */);
31252 hscroll_margin
= 5;
31254 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31255 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31256 When point is less than `hscroll-margin' columns from the window
31257 edge, automatic hscrolling will scroll the window by the amount of columns
31258 determined by this variable. If its value is a positive integer, scroll that
31259 many columns. If it's a positive floating-point number, it specifies the
31260 fraction of the window's width to scroll. If it's nil or zero, point will be
31261 centered horizontally after the scroll. Any other value, including negative
31262 numbers, are treated as if the value were zero.
31264 Automatic hscrolling always moves point outside the scroll margin, so if
31265 point was more than scroll step columns inside the margin, the window will
31266 scroll more than the value given by the scroll step.
31268 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31269 and `scroll-right' overrides this variable's effect. */);
31270 Vhscroll_step
= make_number (0);
31272 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31273 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31274 Bind this around calls to `message' to let it take effect. */);
31275 message_truncate_lines
= false;
31277 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31278 doc
: /* Normal hook run to update the menu bar definitions.
31279 Redisplay runs this hook before it redisplays the menu bar.
31280 This is used to update menus such as Buffers, whose contents depend on
31282 Vmenu_bar_update_hook
= Qnil
;
31284 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31285 doc
: /* Frame for which we are updating a menu.
31286 The enable predicate for a menu binding should check this variable. */);
31287 Vmenu_updating_frame
= Qnil
;
31289 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31290 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31291 inhibit_menubar_update
= false;
31293 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31294 doc
: /* Prefix prepended to all continuation lines at display time.
31295 The value may be a string, an image, or a stretch-glyph; it is
31296 interpreted in the same way as the value of a `display' text property.
31298 This variable is overridden by any `wrap-prefix' text or overlay
31301 To add a prefix to non-continuation lines, use `line-prefix'. */);
31302 Vwrap_prefix
= Qnil
;
31303 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31304 Fmake_variable_buffer_local (Qwrap_prefix
);
31306 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31307 doc
: /* Prefix prepended to all non-continuation lines at display time.
31308 The value may be a string, an image, or a stretch-glyph; it is
31309 interpreted in the same way as the value of a `display' text property.
31311 This variable is overridden by any `line-prefix' text or overlay
31314 To add a prefix to continuation lines, use `wrap-prefix'. */);
31315 Vline_prefix
= Qnil
;
31316 DEFSYM (Qline_prefix
, "line-prefix");
31317 Fmake_variable_buffer_local (Qline_prefix
);
31319 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31320 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31321 inhibit_eval_during_redisplay
= false;
31323 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31324 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31325 inhibit_free_realized_faces
= false;
31327 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31328 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31329 Intended for use during debugging and for testing bidi display;
31330 see biditest.el in the test suite. */);
31331 inhibit_bidi_mirroring
= false;
31334 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31335 doc
: /* Inhibit try_window_id display optimization. */);
31336 inhibit_try_window_id
= false;
31338 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31339 doc
: /* Inhibit try_window_reusing display optimization. */);
31340 inhibit_try_window_reusing
= false;
31342 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31343 doc
: /* Inhibit try_cursor_movement display optimization. */);
31344 inhibit_try_cursor_movement
= false;
31345 #endif /* GLYPH_DEBUG */
31347 DEFVAR_INT ("overline-margin", overline_margin
,
31348 doc
: /* Space between overline and text, in pixels.
31349 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31350 margin to the character height. */);
31351 overline_margin
= 2;
31353 DEFVAR_INT ("underline-minimum-offset",
31354 underline_minimum_offset
,
31355 doc
: /* Minimum distance between baseline and underline.
31356 This can improve legibility of underlined text at small font sizes,
31357 particularly when using variable `x-use-underline-position-properties'
31358 with fonts that specify an UNDERLINE_POSITION relatively close to the
31359 baseline. The default value is 1. */);
31360 underline_minimum_offset
= 1;
31362 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31363 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31364 This feature only works when on a window system that can change
31365 cursor shapes. */);
31366 display_hourglass_p
= true;
31368 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31369 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31370 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31372 #ifdef HAVE_WINDOW_SYSTEM
31373 hourglass_atimer
= NULL
;
31374 hourglass_shown_p
= false;
31375 #endif /* HAVE_WINDOW_SYSTEM */
31377 /* Name of the face used to display glyphless characters. */
31378 DEFSYM (Qglyphless_char
, "glyphless-char");
31380 /* Method symbols for Vglyphless_char_display. */
31381 DEFSYM (Qhex_code
, "hex-code");
31382 DEFSYM (Qempty_box
, "empty-box");
31383 DEFSYM (Qthin_space
, "thin-space");
31384 DEFSYM (Qzero_width
, "zero-width");
31386 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31387 doc
: /* Function run just before redisplay.
31388 It is called with one argument, which is the set of windows that are to
31389 be redisplayed. This set can be nil (meaning, only the selected window),
31390 or t (meaning all windows). */);
31391 Vpre_redisplay_function
= intern ("ignore");
31393 /* Symbol for the purpose of Vglyphless_char_display. */
31394 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31395 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31397 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31398 doc
: /* Char-table defining glyphless characters.
31399 Each element, if non-nil, should be one of the following:
31400 an ASCII acronym string: display this string in a box
31401 `hex-code': display the hexadecimal code of a character in a box
31402 `empty-box': display as an empty box
31403 `thin-space': display as 1-pixel width space
31404 `zero-width': don't display
31405 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31406 display method for graphical terminals and text terminals respectively.
31407 GRAPHICAL and TEXT should each have one of the values listed above.
31409 The char-table has one extra slot to control the display of a character for
31410 which no font is found. This slot only takes effect on graphical terminals.
31411 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31412 `thin-space'. The default is `empty-box'.
31414 If a character has a non-nil entry in an active display table, the
31415 display table takes effect; in this case, Emacs does not consult
31416 `glyphless-char-display' at all. */);
31417 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31418 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31421 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31422 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31423 Vdebug_on_message
= Qnil
;
31425 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31427 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31429 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31431 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31435 /* Initialize this module when Emacs starts. */
31440 CHARPOS (this_line_start_pos
) = 0;
31442 if (!noninteractive
)
31444 struct window
*m
= XWINDOW (minibuf_window
);
31445 Lisp_Object frame
= m
->frame
;
31446 struct frame
*f
= XFRAME (frame
);
31447 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31448 struct window
*r
= XWINDOW (root
);
31451 echo_area_window
= minibuf_window
;
31453 r
->top_line
= FRAME_TOP_MARGIN (f
);
31454 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31455 r
->total_cols
= FRAME_COLS (f
);
31456 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31457 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31458 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31460 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31461 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31462 m
->total_cols
= FRAME_COLS (f
);
31463 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31464 m
->total_lines
= 1;
31465 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31467 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31468 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31469 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31471 /* The default ellipsis glyphs `...'. */
31472 for (i
= 0; i
< 3; ++i
)
31473 default_invis_vector
[i
] = make_number ('.');
31477 /* Allocate the buffer for frame titles.
31478 Also used for `format-mode-line'. */
31480 mode_line_noprop_buf
= xmalloc (size
);
31481 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31482 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31483 mode_line_target
= MODE_LINE_DISPLAY
;
31486 help_echo_showing_p
= false;
31489 #ifdef HAVE_WINDOW_SYSTEM
31491 /* Platform-independent portion of hourglass implementation. */
31493 /* Timer function of hourglass_atimer. */
31496 show_hourglass (struct atimer
*timer
)
31498 /* The timer implementation will cancel this timer automatically
31499 after this function has run. Set hourglass_atimer to null
31500 so that we know the timer doesn't have to be canceled. */
31501 hourglass_atimer
= NULL
;
31503 if (!hourglass_shown_p
)
31505 Lisp_Object tail
, frame
;
31509 FOR_EACH_FRAME (tail
, frame
)
31511 struct frame
*f
= XFRAME (frame
);
31513 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31514 && FRAME_RIF (f
)->show_hourglass
)
31515 FRAME_RIF (f
)->show_hourglass (f
);
31518 hourglass_shown_p
= true;
31523 /* Cancel a currently active hourglass timer, and start a new one. */
31526 start_hourglass (void)
31528 struct timespec delay
;
31530 cancel_hourglass ();
31532 if (INTEGERP (Vhourglass_delay
)
31533 && XINT (Vhourglass_delay
) > 0)
31534 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31535 TYPE_MAXIMUM (time_t)),
31537 else if (FLOATP (Vhourglass_delay
)
31538 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31539 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31541 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31543 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31544 show_hourglass
, NULL
);
31547 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31551 cancel_hourglass (void)
31553 if (hourglass_atimer
)
31555 cancel_atimer (hourglass_atimer
);
31556 hourglass_atimer
= NULL
;
31559 if (hourglass_shown_p
)
31561 Lisp_Object tail
, frame
;
31565 FOR_EACH_FRAME (tail
, frame
)
31567 struct frame
*f
= XFRAME (frame
);
31569 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31570 && FRAME_RIF (f
)->hide_hourglass
)
31571 FRAME_RIF (f
)->hide_hourglass (f
);
31573 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31574 else if (!FRAME_W32_P (f
))
31575 w32_arrow_cursor ();
31579 hourglass_shown_p
= false;
31584 #endif /* HAVE_WINDOW_SYSTEM */