1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2017 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 (at
11 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. */
296 #include "composite.h"
297 #include "keyboard.h"
301 #include "termchar.h"
302 #include "dispextern.h"
303 #include "character.h"
307 #include "commands.h"
310 #include "termhooks.h"
311 #include "termopts.h"
312 #include "intervals.h"
314 #include "region-cache.h"
317 #include "blockinput.h"
319 #ifdef HAVE_WINDOW_SYSTEM
321 #endif /* HAVE_WINDOW_SYSTEM */
323 #ifndef FRAME_X_OUTPUT
324 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
327 #define INFINITY 10000000
329 /* Holds the list (error). */
330 static Lisp_Object list_of_error
;
332 #ifdef HAVE_WINDOW_SYSTEM
334 /* Test if overflow newline into fringe. Called with iterator IT
335 at or past right window margin, and with IT->current_x set. */
337 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
338 (!NILP (Voverflow_newline_into_fringe) \
339 && FRAME_WINDOW_P ((IT)->f) \
340 && ((IT)->bidi_it.paragraph_dir == R2L \
341 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
342 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
343 && (IT)->current_x == (IT)->last_visible_x)
345 #else /* !HAVE_WINDOW_SYSTEM */
346 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
347 #endif /* HAVE_WINDOW_SYSTEM */
349 /* Test if the display element loaded in IT, or the underlying buffer
350 or string character, is a space or a TAB character. This is used
351 to determine where word wrapping can occur. */
353 #define IT_DISPLAYING_WHITESPACE(it) \
354 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
355 || ((STRINGP (it->string) \
356 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
357 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
359 && (it->s[IT_BYTEPOS (*it)] == ' ' \
360 || it->s[IT_BYTEPOS (*it)] == '\t')) \
361 || (IT_BYTEPOS (*it) < ZV_BYTE \
362 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
363 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
365 /* True means print newline to stdout before next mini-buffer message. */
367 bool noninteractive_need_newline
;
369 /* True means print newline to message log before next message. */
371 static bool message_log_need_newline
;
373 /* Three markers that message_dolog uses.
374 It could allocate them itself, but that causes trouble
375 in handling memory-full errors. */
376 static Lisp_Object message_dolog_marker1
;
377 static Lisp_Object message_dolog_marker2
;
378 static Lisp_Object message_dolog_marker3
;
380 /* The buffer position of the first character appearing entirely or
381 partially on the line of the selected window which contains the
382 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
383 redisplay optimization in redisplay_internal. */
385 static struct text_pos this_line_start_pos
;
387 /* Number of characters past the end of the line above, including the
388 terminating newline. */
390 static struct text_pos this_line_end_pos
;
392 /* The vertical positions and the height of this line. */
394 static int this_line_vpos
;
395 static int this_line_y
;
396 static int this_line_pixel_height
;
398 /* X position at which this display line starts. Usually zero;
399 negative if first character is partially visible. */
401 static int this_line_start_x
;
403 /* The smallest character position seen by move_it_* functions as they
404 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
405 hscrolled lines, see display_line. */
407 static struct text_pos this_line_min_pos
;
409 /* Buffer that this_line_.* variables are referring to. */
411 static struct buffer
*this_line_buffer
;
413 /* True if an overlay arrow has been displayed in this window. */
415 static bool overlay_arrow_seen
;
417 /* Vector containing glyphs for an ellipsis `...'. */
419 static Lisp_Object default_invis_vector
[3];
421 /* This is the window where the echo area message was displayed. It
422 is always a mini-buffer window, but it may not be the same window
423 currently active as a mini-buffer. */
425 Lisp_Object echo_area_window
;
427 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
428 pushes the current message and the value of
429 message_enable_multibyte on the stack, the function restore_message
430 pops the stack and displays MESSAGE again. */
432 static Lisp_Object Vmessage_stack
;
434 /* True means multibyte characters were enabled when the echo area
435 message was specified. */
437 static bool message_enable_multibyte
;
439 /* At each redisplay cycle, we should refresh everything there is to refresh.
440 To do that efficiently, we use many optimizations that try to make sure we
441 don't waste too much time updating things that haven't changed.
442 The coarsest such optimization is that, in the most common cases, we only
443 look at the selected-window.
445 To know whether other windows should be considered for redisplay, we use the
446 variable windows_or_buffers_changed: as long as it is 0, it means that we
447 have not noticed anything that should require updating anything else than
448 the selected-window. If it is set to REDISPLAY_SOME, it means that since
449 last redisplay, some changes have been made which could impact other
450 windows. To know which ones need redisplay, every buffer, window, and frame
451 has a `redisplay' bit, which (if true) means that this object needs to be
452 redisplayed. If windows_or_buffers_changed is 0, we know there's no point
453 looking for those `redisplay' bits (actually, there might be some such bits
454 set, but then only on objects which aren't displayed anyway).
456 OTOH if it's non-zero we wil have to loop through all windows and then check
457 the `redisplay' bit of the corresponding window, frame, and buffer, in order
458 to decide whether that window needs attention or not. Note that we can't
459 just look at the frame's redisplay bit to decide that the whole frame can be
460 skipped, since even if the frame's redisplay bit is unset, some of its
461 windows's redisplay bits may be set.
463 Mostly for historical reasons, windows_or_buffers_changed can also take
464 other non-zero values. In that case, the precise value doesn't matter (it
465 encodes the cause of the setting but is only used for debugging purposes),
466 and what it means is that we shouldn't pay attention to any `redisplay' bits
467 and we should simply try and redisplay every window out there. */
469 int windows_or_buffers_changed
;
471 /* Nonzero if we should redraw the mode lines on the next redisplay.
472 Similarly to `windows_or_buffers_changed', If it has value REDISPLAY_SOME,
473 then only redisplay the mode lines in those buffers/windows/frames where the
474 `redisplay' bit has been set.
475 For any other value, redisplay all mode lines (the number used is then only
476 used to track down the cause for this full-redisplay).
478 Since the frame title uses the same %-constructs as the mode line
479 (except %c and %l), if this variable is non-zero, we also consider
480 redisplaying the title of each frame, see x_consider_frame_title.
482 The `redisplay' bits are the same as those used for
483 windows_or_buffers_changed, and setting windows_or_buffers_changed also
484 causes recomputation of the mode lines of all those windows. IOW this
485 variable only has an effect if windows_or_buffers_changed is zero, in which
486 case we should only need to redisplay the mode-line of those objects with
487 a `redisplay' bit set but not the window's text content (tho we may still
488 need to refresh the text content of the selected-window). */
490 int update_mode_lines
;
492 /* True after display_mode_line if %l was used and it displayed a
495 static bool line_number_displayed
;
497 /* The name of the *Messages* buffer, a string. */
499 static Lisp_Object Vmessages_buffer_name
;
501 /* Current, index 0, and last displayed echo area message. Either
502 buffers from echo_buffers, or nil to indicate no message. */
504 Lisp_Object echo_area_buffer
[2];
506 /* The buffers referenced from echo_area_buffer. */
508 static Lisp_Object echo_buffer
[2];
510 /* A vector saved used in with_area_buffer to reduce consing. */
512 static Lisp_Object Vwith_echo_area_save_vector
;
514 /* True means display_echo_area should display the last echo area
515 message again. Set by redisplay_preserve_echo_area. */
517 static bool display_last_displayed_message_p
;
519 /* True if echo area is being used by print; false if being used by
522 static bool message_buf_print
;
524 /* Set to true in clear_message to make redisplay_internal aware
525 of an emptied echo area. */
527 static bool message_cleared_p
;
529 /* A scratch glyph row with contents used for generating truncation
530 glyphs. Also used in direct_output_for_insert. */
532 #define MAX_SCRATCH_GLYPHS 100
533 static struct glyph_row scratch_glyph_row
;
534 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
536 /* Ascent and height of the last line processed by move_it_to. */
538 static int last_height
;
540 /* True if there's a help-echo in the echo area. */
542 bool help_echo_showing_p
;
544 /* The maximum distance to look ahead for text properties. Values
545 that are too small let us call compute_char_face and similar
546 functions too often which is expensive. Values that are too large
547 let us call compute_char_face and alike too often because we
548 might not be interested in text properties that far away. */
550 #define TEXT_PROP_DISTANCE_LIMIT 100
552 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
553 iterator state and later restore it. This is needed because the
554 bidi iterator on bidi.c keeps a stacked cache of its states, which
555 is really a singleton. When we use scratch iterator objects to
556 move around the buffer, we can cause the bidi cache to be pushed or
557 popped, and therefore we need to restore the cache state when we
558 return to the original iterator. */
559 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
562 bidi_unshelve_cache (CACHE, true); \
564 CACHE = bidi_shelve_cache (); \
567 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
569 if (pITORIG != pITCOPY) \
570 *(pITORIG) = *(pITCOPY); \
571 bidi_unshelve_cache (CACHE, false); \
575 /* Functions to mark elements as needing redisplay. */
576 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
579 redisplay_other_windows (void)
581 if (!windows_or_buffers_changed
)
582 windows_or_buffers_changed
= REDISPLAY_SOME
;
586 wset_redisplay (struct window
*w
)
588 /* Beware: selected_window can be nil during early stages. */
589 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
590 redisplay_other_windows ();
595 fset_redisplay (struct frame
*f
)
597 redisplay_other_windows ();
602 bset_redisplay (struct buffer
*b
)
604 int count
= buffer_window_count (b
);
607 /* ... it's visible in other window than selected, */
608 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
609 redisplay_other_windows ();
610 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
611 so that if we later set windows_or_buffers_changed, this buffer will
613 b
->text
->redisplay
= true;
618 bset_update_mode_line (struct buffer
*b
)
620 if (!update_mode_lines
)
621 update_mode_lines
= REDISPLAY_SOME
;
622 b
->text
->redisplay
= true;
625 DEFUN ("set-buffer-redisplay", Fset_buffer_redisplay
,
626 Sset_buffer_redisplay
, 4, 4, 0,
627 doc
: /* Mark the current buffer for redisplay.
628 This function may be passed to `add-variable-watcher'. */)
629 (Lisp_Object symbol
, Lisp_Object newval
, Lisp_Object op
, Lisp_Object where
)
631 bset_update_mode_line (current_buffer
);
632 current_buffer
->prevent_redisplay_optimizations_p
= true;
638 /* True means print traces of redisplay if compiled with
639 GLYPH_DEBUG defined. */
641 bool trace_redisplay_p
;
643 #endif /* GLYPH_DEBUG */
645 #ifdef DEBUG_TRACE_MOVE
646 /* True means trace with TRACE_MOVE to stderr. */
647 static bool trace_move
;
649 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
651 #define TRACE_MOVE(x) (void) 0
654 /* Buffer being redisplayed -- for redisplay_window_error. */
656 static struct buffer
*displayed_buffer
;
658 /* Value returned from text property handlers (see below). */
663 HANDLED_RECOMPUTE_PROPS
,
664 HANDLED_OVERLAY_STRING_CONSUMED
,
668 /* A description of text properties that redisplay is interested
673 /* The symbol index of the name of the property. */
676 /* A unique index for the property. */
679 /* A handler function called to set up iterator IT from the property
680 at IT's current position. Value is used to steer handle_stop. */
681 enum prop_handled (*handler
) (struct it
*it
);
684 static enum prop_handled
handle_face_prop (struct it
*);
685 static enum prop_handled
handle_invisible_prop (struct it
*);
686 static enum prop_handled
handle_display_prop (struct it
*);
687 static enum prop_handled
handle_composition_prop (struct it
*);
688 static enum prop_handled
handle_overlay_change (struct it
*);
689 static enum prop_handled
handle_fontified_prop (struct it
*);
691 /* Properties handled by iterators. */
693 static struct props it_props
[] =
695 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
696 /* Handle `face' before `display' because some sub-properties of
697 `display' need to know the face. */
698 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
699 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
700 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
701 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
705 /* Value is the position described by X. If X is a marker, value is
706 the marker_position of X. Otherwise, value is X. */
708 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
710 /* Enumeration returned by some move_it_.* functions internally. */
714 /* Not used. Undefined value. */
717 /* Move ended at the requested buffer position or ZV. */
718 MOVE_POS_MATCH_OR_ZV
,
720 /* Move ended at the requested X pixel position. */
723 /* Move within a line ended at the end of a line that must be
727 /* Move within a line ended at the end of a line that would
728 be displayed truncated. */
731 /* Move within a line ended at a line end. */
735 /* This counter is used to clear the face cache every once in a while
736 in redisplay_internal. It is incremented for each redisplay.
737 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
740 #define CLEAR_FACE_CACHE_COUNT 500
741 static int clear_face_cache_count
;
743 /* Similarly for the image cache. */
745 #ifdef HAVE_WINDOW_SYSTEM
746 #define CLEAR_IMAGE_CACHE_COUNT 101
747 static int clear_image_cache_count
;
749 /* Null glyph slice */
750 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
753 /* True while redisplay_internal is in progress. */
757 /* If a string, XTread_socket generates an event to display that string.
758 (The display is done in read_char.) */
760 Lisp_Object help_echo_string
;
761 Lisp_Object help_echo_window
;
762 Lisp_Object help_echo_object
;
763 ptrdiff_t help_echo_pos
;
765 /* Temporary variable for XTread_socket. */
767 Lisp_Object previous_help_echo_string
;
769 /* Platform-independent portion of hourglass implementation. */
771 #ifdef HAVE_WINDOW_SYSTEM
773 /* True means an hourglass cursor is currently shown. */
774 static bool hourglass_shown_p
;
776 /* If non-null, an asynchronous timer that, when it expires, displays
777 an hourglass cursor on all frames. */
778 static struct atimer
*hourglass_atimer
;
780 #endif /* HAVE_WINDOW_SYSTEM */
782 /* Default number of seconds to wait before displaying an hourglass
784 #define DEFAULT_HOURGLASS_DELAY 1
786 #ifdef HAVE_WINDOW_SYSTEM
788 /* Default pixel width of `thin-space' display method. */
789 #define THIN_SPACE_WIDTH 1
791 #endif /* HAVE_WINDOW_SYSTEM */
793 /* Function prototypes. */
795 static void setup_for_ellipsis (struct it
*, int);
796 static void set_iterator_to_next (struct it
*, bool);
797 static void mark_window_display_accurate_1 (struct window
*, bool);
798 static bool row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
799 static bool cursor_row_p (struct glyph_row
*);
800 static int redisplay_mode_lines (Lisp_Object
, bool);
802 static void handle_line_prefix (struct it
*);
804 static void handle_stop_backwards (struct it
*, ptrdiff_t);
805 static void unwind_with_echo_area_buffer (Lisp_Object
);
806 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
807 static bool current_message_1 (ptrdiff_t, Lisp_Object
);
808 static bool truncate_message_1 (ptrdiff_t, Lisp_Object
);
809 static void set_message (Lisp_Object
);
810 static bool set_message_1 (ptrdiff_t, Lisp_Object
);
811 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object
);
812 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
813 static void unwind_redisplay (void);
814 static void extend_face_to_end_of_line (struct it
*);
815 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
816 static void push_it (struct it
*, struct text_pos
*);
817 static void iterate_out_of_display_property (struct it
*);
818 static void pop_it (struct it
*);
819 static void redisplay_internal (void);
820 static void echo_area_display (bool);
821 static void block_buffer_flips (void);
822 static void unblock_buffer_flips (void);
823 static void redisplay_windows (Lisp_Object
);
824 static void redisplay_window (Lisp_Object
, bool);
825 static Lisp_Object
redisplay_window_error (Lisp_Object
);
826 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
827 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
828 static bool set_cursor_from_row (struct window
*, struct glyph_row
*,
829 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
831 static bool cursor_row_fully_visible_p (struct window
*, bool, bool);
832 static bool update_menu_bar (struct frame
*, bool, bool);
833 static bool try_window_reusing_current_matrix (struct window
*);
834 static int try_window_id (struct window
*);
835 static bool display_line (struct it
*);
836 static int display_mode_lines (struct window
*);
837 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
838 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
,
840 static int store_mode_line_string (const char *, Lisp_Object
, bool, int, int,
842 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
843 static void display_menu_bar (struct window
*);
844 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
846 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
847 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
848 static void compute_line_metrics (struct it
*);
849 static void run_redisplay_end_trigger_hook (struct it
*);
850 static bool get_overlay_strings (struct it
*, ptrdiff_t);
851 static bool get_overlay_strings_1 (struct it
*, ptrdiff_t, bool);
852 static void next_overlay_string (struct it
*);
853 static void reseat (struct it
*, struct text_pos
, bool);
854 static void reseat_1 (struct it
*, struct text_pos
, bool);
855 static bool next_element_from_display_vector (struct it
*);
856 static bool next_element_from_string (struct it
*);
857 static bool next_element_from_c_string (struct it
*);
858 static bool next_element_from_buffer (struct it
*);
859 static bool next_element_from_composition (struct it
*);
860 static bool next_element_from_image (struct it
*);
861 static bool next_element_from_stretch (struct it
*);
862 static bool next_element_from_xwidget (struct it
*);
863 static void load_overlay_strings (struct it
*, ptrdiff_t);
864 static bool get_next_display_element (struct it
*);
865 static enum move_it_result
866 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
867 enum move_operation_enum
);
868 static void get_visually_first_element (struct it
*);
869 static void compute_stop_pos (struct it
*);
870 static int face_before_or_after_it_pos (struct it
*, bool);
871 static ptrdiff_t next_overlay_change (ptrdiff_t);
872 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
873 Lisp_Object
, struct text_pos
*, ptrdiff_t, bool);
874 static int handle_single_display_spec (struct it
*, Lisp_Object
,
875 Lisp_Object
, Lisp_Object
,
876 struct text_pos
*, ptrdiff_t, int, bool);
877 static int underlying_face_id (struct it
*);
879 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
880 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
882 #ifdef HAVE_WINDOW_SYSTEM
884 static void update_tool_bar (struct frame
*, bool);
885 static void x_draw_bottom_divider (struct window
*w
);
886 static void notice_overwritten_cursor (struct window
*,
889 static int normal_char_height (struct font
*, int);
890 static void normal_char_ascent_descent (struct font
*, int, int *, int *);
892 static void append_stretch_glyph (struct it
*, Lisp_Object
,
895 static Lisp_Object
get_it_property (struct it
*, Lisp_Object
);
896 static Lisp_Object
calc_line_height_property (struct it
*, Lisp_Object
,
897 struct font
*, int, bool);
899 #endif /* HAVE_WINDOW_SYSTEM */
901 static void produce_special_glyphs (struct it
*, enum display_element_type
);
902 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
903 static bool coords_in_mouse_face_p (struct window
*, int, int);
907 /***********************************************************************
908 Window display dimensions
909 ***********************************************************************/
911 /* Return the bottom boundary y-position for text lines in window W.
912 This is the first y position at which a line cannot start.
913 It is relative to the top of the window.
915 This is the height of W minus the height of a mode line, if any. */
918 window_text_bottom_y (struct window
*w
)
920 int height
= WINDOW_PIXEL_HEIGHT (w
);
922 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
924 if (WINDOW_WANTS_MODELINE_P (w
))
925 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
927 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
932 /* Return the pixel width of display area AREA of window W.
933 ANY_AREA means return the total width of W, not including
934 fringes to the left and right of the window. */
937 window_box_width (struct window
*w
, enum glyph_row_area area
)
939 int width
= w
->pixel_width
;
941 if (!w
->pseudo_window_p
)
943 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
944 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
946 if (area
== TEXT_AREA
)
947 width
-= (WINDOW_MARGINS_WIDTH (w
)
948 + WINDOW_FRINGES_WIDTH (w
));
949 else if (area
== LEFT_MARGIN_AREA
)
950 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
951 else if (area
== RIGHT_MARGIN_AREA
)
952 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
955 /* With wide margins, fringes, etc. we might end up with a negative
956 width, correct that here. */
957 return max (0, width
);
961 /* Return the pixel height of the display area of window W, not
962 including mode lines of W, if any. */
965 window_box_height (struct window
*w
)
967 struct frame
*f
= XFRAME (w
->frame
);
968 int height
= WINDOW_PIXEL_HEIGHT (w
);
970 eassert (height
>= 0);
972 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
973 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
975 /* Note: the code below that determines the mode-line/header-line
976 height is essentially the same as that contained in the macro
977 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
978 the appropriate glyph row has its `mode_line_p' flag set,
979 and if it doesn't, uses estimate_mode_line_height instead. */
981 if (WINDOW_WANTS_MODELINE_P (w
))
983 struct glyph_row
*ml_row
984 = (w
->current_matrix
&& w
->current_matrix
->rows
985 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
987 if (ml_row
&& ml_row
->mode_line_p
)
988 height
-= ml_row
->height
;
990 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
993 if (WINDOW_WANTS_HEADER_LINE_P (w
))
995 struct glyph_row
*hl_row
996 = (w
->current_matrix
&& w
->current_matrix
->rows
997 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
999 if (hl_row
&& hl_row
->mode_line_p
)
1000 height
-= hl_row
->height
;
1002 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1005 /* With a very small font and a mode-line that's taller than
1006 default, we might end up with a negative height. */
1007 return max (0, height
);
1010 /* Return the window-relative coordinate of the left edge of display
1011 area AREA of window W. ANY_AREA means return the left edge of the
1012 whole window, to the right of the left fringe of W. */
1015 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1019 if (w
->pseudo_window_p
)
1022 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1024 if (area
== TEXT_AREA
)
1025 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1026 + window_box_width (w
, LEFT_MARGIN_AREA
));
1027 else if (area
== RIGHT_MARGIN_AREA
)
1028 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1029 + window_box_width (w
, LEFT_MARGIN_AREA
)
1030 + window_box_width (w
, TEXT_AREA
)
1031 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1033 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1034 else if (area
== LEFT_MARGIN_AREA
1035 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1036 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1038 /* Don't return more than the window's pixel width. */
1039 return min (x
, w
->pixel_width
);
1043 /* Return the window-relative coordinate of the right edge of display
1044 area AREA of window W. ANY_AREA means return the right edge of the
1045 whole window, to the left of the right fringe of W. */
1048 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1050 /* Don't return more than the window's pixel width. */
1051 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1055 /* Return the frame-relative coordinate of the left edge of display
1056 area AREA of window W. ANY_AREA means return the left edge of the
1057 whole window, to the right of the left fringe of W. */
1060 window_box_left (struct window
*w
, enum glyph_row_area area
)
1062 struct frame
*f
= XFRAME (w
->frame
);
1065 if (w
->pseudo_window_p
)
1066 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1068 x
= (WINDOW_LEFT_EDGE_X (w
)
1069 + window_box_left_offset (w
, area
));
1075 /* Return the frame-relative coordinate of the right edge of display
1076 area AREA of window W. ANY_AREA means return the right edge of the
1077 whole window, to the left of the right fringe of W. */
1080 window_box_right (struct window
*w
, enum glyph_row_area area
)
1082 return window_box_left (w
, area
) + window_box_width (w
, area
);
1085 /* Get the bounding box of the display area AREA of window W, without
1086 mode lines, in frame-relative coordinates. ANY_AREA means the
1087 whole window, not including the left and right fringes of
1088 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1089 coordinates of the upper-left corner of the box. Return in
1090 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1093 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1094 int *box_y
, int *box_width
, int *box_height
)
1097 *box_width
= window_box_width (w
, area
);
1099 *box_height
= window_box_height (w
);
1101 *box_x
= window_box_left (w
, area
);
1104 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1105 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1106 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1110 #ifdef HAVE_WINDOW_SYSTEM
1112 /* Get the bounding box of the display area AREA of window W, without
1113 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1114 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1115 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1116 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1120 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1121 int *bottom_right_x
, int *bottom_right_y
)
1123 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1124 bottom_right_x
, bottom_right_y
);
1125 *bottom_right_x
+= *top_left_x
;
1126 *bottom_right_y
+= *top_left_y
;
1129 #endif /* HAVE_WINDOW_SYSTEM */
1131 /***********************************************************************
1133 ***********************************************************************/
1135 /* Return the bottom y-position of the line the iterator IT is in.
1136 This can modify IT's settings. */
1139 line_bottom_y (struct it
*it
)
1141 int line_height
= it
->max_ascent
+ it
->max_descent
;
1142 int line_top_y
= it
->current_y
;
1144 if (line_height
== 0)
1147 line_height
= last_height
;
1148 else if (IT_CHARPOS (*it
) < ZV
)
1150 move_it_by_lines (it
, 1);
1151 line_height
= (it
->max_ascent
|| it
->max_descent
1152 ? it
->max_ascent
+ it
->max_descent
1157 struct glyph_row
*row
= it
->glyph_row
;
1159 /* Use the default character height. */
1160 it
->glyph_row
= NULL
;
1161 it
->what
= IT_CHARACTER
;
1164 PRODUCE_GLYPHS (it
);
1165 line_height
= it
->ascent
+ it
->descent
;
1166 it
->glyph_row
= row
;
1170 return line_top_y
+ line_height
;
1173 DEFUN ("line-pixel-height", Fline_pixel_height
,
1174 Sline_pixel_height
, 0, 0, 0,
1175 doc
: /* Return height in pixels of text line in the selected window.
1177 Value is the height in pixels of the line at point. */)
1182 struct window
*w
= XWINDOW (selected_window
);
1183 struct buffer
*old_buffer
= NULL
;
1186 if (XBUFFER (w
->contents
) != current_buffer
)
1188 old_buffer
= current_buffer
;
1189 set_buffer_internal_1 (XBUFFER (w
->contents
));
1191 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1192 start_display (&it
, w
, pt
);
1193 it
.vpos
= it
.current_y
= 0;
1195 result
= make_number (line_bottom_y (&it
));
1197 set_buffer_internal_1 (old_buffer
);
1202 /* Return the default pixel height of text lines in window W. The
1203 value is the canonical height of the W frame's default font, plus
1204 any extra space required by the line-spacing variable or frame
1207 Implementation note: this ignores any line-spacing text properties
1208 put on the newline characters. This is because those properties
1209 only affect the _screen_ line ending in the newline (i.e., in a
1210 continued line, only the last screen line will be affected), which
1211 means only a small number of lines in a buffer can ever use this
1212 feature. Since this function is used to compute the default pixel
1213 equivalent of text lines in a window, we can safely ignore those
1214 few lines. For the same reasons, we ignore the line-height
1217 default_line_pixel_height (struct window
*w
)
1219 struct frame
*f
= WINDOW_XFRAME (w
);
1220 int height
= FRAME_LINE_HEIGHT (f
);
1222 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1224 struct buffer
*b
= XBUFFER (w
->contents
);
1225 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1228 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1231 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1232 height
+= XFASTINT (val
);
1233 else if (FLOATP (val
))
1235 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1242 height
+= f
->extra_line_spacing
;
1248 /* Subroutine of pos_visible_p below. Extracts a display string, if
1249 any, from the display spec given as its argument. */
1251 string_from_display_spec (Lisp_Object spec
)
1255 for (ptrdiff_t i
= 0; i
< ASIZE (spec
); i
++)
1256 if (STRINGP (AREF (spec
, i
)))
1257 return AREF (spec
, i
);
1261 for (; CONSP (spec
); spec
= XCDR (spec
))
1262 if (STRINGP (XCAR (spec
)))
1269 /* Limit insanely large values of W->hscroll on frame F to the largest
1270 value that will still prevent first_visible_x and last_visible_x of
1271 'struct it' from overflowing an int. */
1273 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1275 ptrdiff_t window_hscroll
= w
->hscroll
;
1276 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1277 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1279 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1280 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1282 return window_hscroll
;
1285 /* Return true if position CHARPOS is visible in window W.
1286 CHARPOS < 0 means return info about WINDOW_END position.
1287 If visible, set *X and *Y to pixel coordinates of top left corner.
1288 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1289 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1292 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1293 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1296 void *itdata
= bidi_shelve_cache ();
1297 struct text_pos top
;
1298 bool visible_p
= false;
1299 struct buffer
*old_buffer
= NULL
;
1302 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1305 if (XBUFFER (w
->contents
) != current_buffer
)
1307 old_buffer
= current_buffer
;
1308 set_buffer_internal_1 (XBUFFER (w
->contents
));
1311 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1312 /* Scrolling a minibuffer window via scroll bar when the echo area
1313 shows long text sometimes resets the minibuffer contents behind
1314 our backs. Also, someone might narrow-to-region and immediately
1315 call a scroll function. */
1316 if (CHARPOS (top
) > ZV
|| CHARPOS (top
) < BEGV
)
1317 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1319 /* If the top of the window is after CHARPOS, the latter is surely
1321 if (charpos
>= 0 && CHARPOS (top
) > charpos
)
1324 /* Compute exact mode line heights. */
1325 if (WINDOW_WANTS_MODELINE_P (w
))
1327 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1328 BVAR (current_buffer
, mode_line_format
));
1330 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1331 w
->header_line_height
1332 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1333 BVAR (current_buffer
, header_line_format
));
1335 start_display (&it
, w
, top
);
1336 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1337 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1340 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1341 && IT_CHARPOS (it
) >= charpos
)
1342 /* When scanning backwards under bidi iteration, move_it_to
1343 stops at or _before_ CHARPOS, because it stops at or to
1344 the _right_ of the character at CHARPOS. */
1345 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1346 && IT_CHARPOS (it
) <= charpos
)))
1348 /* We have reached CHARPOS, or passed it. How the call to
1349 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1350 or covered by a display property, move_it_to stops at the end
1351 of the invisible text, to the right of CHARPOS. (ii) If
1352 CHARPOS is in a display vector, move_it_to stops on its last
1354 int top_x
= it
.current_x
;
1355 int top_y
= it
.current_y
;
1356 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1359 void *save_it_data
= NULL
;
1361 /* Calling line_bottom_y may change it.method, it.position, etc. */
1362 SAVE_IT (save_it
, it
, save_it_data
);
1364 bottom_y
= line_bottom_y (&it
);
1365 if (top_y
< window_top_y
)
1366 visible_p
= bottom_y
> window_top_y
;
1367 else if (top_y
< it
.last_visible_y
)
1369 if (bottom_y
>= it
.last_visible_y
1370 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1371 && IT_CHARPOS (it
) < charpos
)
1373 /* When the last line of the window is scanned backwards
1374 under bidi iteration, we could be duped into thinking
1375 that we have passed CHARPOS, when in fact move_it_to
1376 simply stopped short of CHARPOS because it reached
1377 last_visible_y. To see if that's what happened, we call
1378 move_it_to again with a slightly larger vertical limit,
1379 and see if it actually moved vertically; if it did, we
1380 didn't really reach CHARPOS, which is beyond window end. */
1381 /* Why 10? because we don't know how many canonical lines
1382 will the height of the next line(s) be. So we guess. */
1383 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1385 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1386 MOVE_TO_POS
| MOVE_TO_Y
);
1387 if (it
.current_y
> top_y
)
1391 RESTORE_IT (&it
, &save_it
, save_it_data
);
1394 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1396 /* We stopped on the last glyph of a display vector.
1397 Try and recompute. Hack alert! */
1398 if (charpos
< 2 || top
.charpos
>= charpos
)
1399 top_x
= it
.glyph_row
->x
;
1402 struct it it2
, it2_prev
;
1403 /* The idea is to get to the previous buffer
1404 position, consume the character there, and use
1405 the pixel coordinates we get after that. But if
1406 the previous buffer position is also displayed
1407 from a display vector, we need to consume all of
1408 the glyphs from that display vector. */
1409 start_display (&it2
, w
, top
);
1410 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1411 /* If we didn't get to CHARPOS - 1, there's some
1412 replacing display property at that position, and
1413 we stopped after it. That is exactly the place
1414 whose coordinates we want. */
1415 if (IT_CHARPOS (it2
) != charpos
- 1)
1419 /* Iterate until we get out of the display
1420 vector that displays the character at
1423 get_next_display_element (&it2
);
1424 PRODUCE_GLYPHS (&it2
);
1426 set_iterator_to_next (&it2
, true);
1427 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1428 && IT_CHARPOS (it2
) < charpos
);
1430 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1431 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1432 top_x
= it
.glyph_row
->x
;
1435 top_x
= it2_prev
.current_x
;
1436 top_y
= it2_prev
.current_y
;
1440 else if (IT_CHARPOS (it
) != charpos
)
1442 Lisp_Object cpos
= make_number (charpos
);
1443 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1444 Lisp_Object string
= string_from_display_spec (spec
);
1445 struct text_pos tpos
;
1446 bool newline_in_string
1448 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1450 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1451 bool replacing_spec_p
1453 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1454 charpos
, FRAME_WINDOW_P (it
.f
)));
1455 /* The tricky code below is needed because there's a
1456 discrepancy between move_it_to and how we set cursor
1457 when PT is at the beginning of a portion of text
1458 covered by a display property or an overlay with a
1459 display property, or the display line ends in a
1460 newline from a display string. move_it_to will stop
1461 _after_ such display strings, whereas
1462 set_cursor_from_row conspires with cursor_row_p to
1463 place the cursor on the first glyph produced from the
1466 /* We have overshoot PT because it is covered by a
1467 display property that replaces the text it covers.
1468 If the string includes embedded newlines, we are also
1469 in the wrong display line. Backtrack to the correct
1470 line, where the display property begins. */
1471 if (replacing_spec_p
)
1473 Lisp_Object startpos
, endpos
;
1474 EMACS_INT start
, end
;
1477 /* Find the first and the last buffer positions
1478 covered by the display string. */
1480 Fnext_single_char_property_change (cpos
, Qdisplay
,
1483 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1485 start
= XFASTINT (startpos
);
1486 end
= XFASTINT (endpos
);
1487 /* Move to the last buffer position before the
1488 display property. */
1489 start_display (&it3
, w
, top
);
1490 if (start
> CHARPOS (top
))
1491 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1492 /* Move forward one more line if the position before
1493 the display string is a newline or if it is the
1494 rightmost character on a line that is
1495 continued or word-wrapped. */
1496 if (it3
.method
== GET_FROM_BUFFER
1498 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1499 move_it_by_lines (&it3
, 1);
1500 else if (move_it_in_display_line_to (&it3
, -1,
1504 == MOVE_LINE_CONTINUED
)
1506 move_it_by_lines (&it3
, 1);
1507 /* When we are under word-wrap, the #$@%!
1508 move_it_by_lines moves 2 lines, so we need to
1510 if (it3
.line_wrap
== WORD_WRAP
)
1511 move_it_by_lines (&it3
, -1);
1514 /* Record the vertical coordinate of the display
1515 line where we wound up. */
1516 top_y
= it3
.current_y
;
1519 /* When characters are reordered for display,
1520 the character displayed to the left of the
1521 display string could be _after_ the display
1522 property in the logical order. Use the
1523 smallest vertical position of these two. */
1524 start_display (&it3
, w
, top
);
1525 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1526 if (it3
.current_y
< top_y
)
1527 top_y
= it3
.current_y
;
1529 /* Move from the top of the window to the beginning
1530 of the display line where the display string
1532 start_display (&it3
, w
, top
);
1533 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1534 /* If it3_moved stays false after the 'while' loop
1535 below, that means we already were at a newline
1536 before the loop (e.g., the display string begins
1537 with a newline), so we don't need to (and cannot)
1538 inspect the glyphs of it3.glyph_row, because
1539 PRODUCE_GLYPHS will not produce anything for a
1540 newline, and thus it3.glyph_row stays at its
1541 stale content it got at top of the window. */
1542 bool it3_moved
= false;
1543 /* Finally, advance the iterator until we hit the
1544 first display element whose character position is
1545 CHARPOS, or until the first newline from the
1546 display string, which signals the end of the
1548 while (get_next_display_element (&it3
))
1550 PRODUCE_GLYPHS (&it3
);
1551 if (IT_CHARPOS (it3
) == charpos
1552 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1555 set_iterator_to_next (&it3
, false);
1557 top_x
= it3
.current_x
- it3
.pixel_width
;
1558 /* Normally, we would exit the above loop because we
1559 found the display element whose character
1560 position is CHARPOS. For the contingency that we
1561 didn't, and stopped at the first newline from the
1562 display string, move back over the glyphs
1563 produced from the string, until we find the
1564 rightmost glyph not from the string. */
1566 && newline_in_string
1567 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1569 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1570 + it3
.glyph_row
->used
[TEXT_AREA
];
1572 while (EQ ((g
- 1)->object
, string
))
1575 top_x
-= g
->pixel_width
;
1577 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1578 + it3
.glyph_row
->used
[TEXT_AREA
]);
1584 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1585 *rtop
= max (0, window_top_y
- top_y
);
1586 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1587 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1588 - max (top_y
, window_top_y
)));
1590 if (it
.bidi_it
.paragraph_dir
== R2L
)
1596 /* Either we were asked to provide info about WINDOW_END, or
1597 CHARPOS is in the partially visible glyph row at end of
1600 void *it2data
= NULL
;
1602 SAVE_IT (it2
, it
, it2data
);
1603 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1604 move_it_by_lines (&it
, 1);
1605 if (charpos
< IT_CHARPOS (it
)
1606 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1609 RESTORE_IT (&it2
, &it2
, it2data
);
1610 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1612 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1613 *rtop
= max (0, -it2
.current_y
);
1614 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1615 - it
.last_visible_y
));
1616 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1618 - max (it2
.current_y
,
1619 WINDOW_HEADER_LINE_HEIGHT (w
))));
1621 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1625 bidi_unshelve_cache (it2data
, true);
1627 bidi_unshelve_cache (itdata
, false);
1630 set_buffer_internal_1 (old_buffer
);
1636 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1637 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1638 /* For lines in an R2L paragraph, we need to mirror the X pixel
1639 coordinate wrt the text area. For the reasons, see the
1640 commentary in buffer_posn_from_coords and the explanation of
1641 the geometry used by the move_it_* functions at the end of
1642 the large commentary near the beginning of this file. */
1644 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1648 /* Debugging code. */
1650 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1651 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1653 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1660 /* Return the next character from STR. Return in *LEN the length of
1661 the character. This is like STRING_CHAR_AND_LENGTH but never
1662 returns an invalid character. If we find one, we return a `?', but
1663 with the length of the invalid character. */
1666 string_char_and_length (const unsigned char *str
, int *len
)
1670 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1671 if (!CHAR_VALID_P (c
))
1672 /* We may not change the length here because other places in Emacs
1673 don't use this function, i.e. they silently accept invalid
1682 /* Given a position POS containing a valid character and byte position
1683 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1685 static struct text_pos
1686 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1688 eassert (STRINGP (string
) && nchars
>= 0);
1690 if (STRING_MULTIBYTE (string
))
1692 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1697 string_char_and_length (p
, &len
);
1700 BYTEPOS (pos
) += len
;
1704 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1710 /* Value is the text position, i.e. character and byte position,
1711 for character position CHARPOS in STRING. */
1713 static struct text_pos
1714 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1716 struct text_pos pos
;
1717 eassert (STRINGP (string
));
1718 eassert (charpos
>= 0);
1719 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1724 /* Value is a text position, i.e. character and byte position, for
1725 character position CHARPOS in C string S. MULTIBYTE_P
1726 means recognize multibyte characters. */
1728 static struct text_pos
1729 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1731 struct text_pos pos
;
1733 eassert (s
!= NULL
);
1734 eassert (charpos
>= 0);
1740 SET_TEXT_POS (pos
, 0, 0);
1743 string_char_and_length ((const unsigned char *) s
, &len
);
1746 BYTEPOS (pos
) += len
;
1750 SET_TEXT_POS (pos
, charpos
, charpos
);
1756 /* Value is the number of characters in C string S. MULTIBYTE_P
1757 means recognize multibyte characters. */
1760 number_of_chars (const char *s
, bool multibyte_p
)
1766 ptrdiff_t rest
= strlen (s
);
1768 const unsigned char *p
= (const unsigned char *) s
;
1770 for (nchars
= 0; rest
> 0; ++nchars
)
1772 string_char_and_length (p
, &len
);
1773 rest
-= len
, p
+= len
;
1777 nchars
= strlen (s
);
1783 /* Compute byte position NEWPOS->bytepos corresponding to
1784 NEWPOS->charpos. POS is a known position in string STRING.
1785 NEWPOS->charpos must be >= POS.charpos. */
1788 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1790 eassert (STRINGP (string
));
1791 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1793 if (STRING_MULTIBYTE (string
))
1794 *newpos
= string_pos_nchars_ahead (pos
, string
,
1795 CHARPOS (*newpos
) - CHARPOS (pos
));
1797 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1801 Return an estimation of the pixel height of mode or header lines on
1802 frame F. FACE_ID specifies what line's height to estimate. */
1805 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1807 #ifdef HAVE_WINDOW_SYSTEM
1808 if (FRAME_WINDOW_P (f
))
1810 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1812 /* This function is called so early when Emacs starts that the face
1813 cache and mode line face are not yet initialized. */
1814 if (FRAME_FACE_CACHE (f
))
1816 struct face
*face
= FACE_FROM_ID_OR_NULL (f
, face_id
);
1820 height
= normal_char_height (face
->font
, -1);
1821 if (face
->box_line_width
> 0)
1822 height
+= 2 * face
->box_line_width
;
1833 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1834 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1835 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1836 not force the value into range. */
1839 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1840 NativeRectangle
*bounds
, bool noclip
)
1843 #ifdef HAVE_WINDOW_SYSTEM
1844 if (FRAME_WINDOW_P (f
))
1846 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1847 even for negative values. */
1849 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1851 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1853 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1854 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1857 STORE_NATIVE_RECT (*bounds
,
1858 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1859 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1860 FRAME_COLUMN_WIDTH (f
) - 1,
1861 FRAME_LINE_HEIGHT (f
) - 1);
1863 /* PXW: Should we clip pixels before converting to columns/lines? */
1868 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1869 pix_x
= FRAME_TOTAL_COLS (f
);
1873 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1874 pix_y
= FRAME_TOTAL_LINES (f
);
1884 /* Find the glyph under window-relative coordinates X/Y in window W.
1885 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1886 strings. Return in *HPOS and *VPOS the row and column number of
1887 the glyph found. Return in *AREA the glyph area containing X.
1888 Value is a pointer to the glyph found or null if X/Y is not on
1889 text, or we can't tell because W's current matrix is not up to
1892 static struct glyph
*
1893 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1894 int *dx
, int *dy
, int *area
)
1896 struct glyph
*glyph
, *end
;
1897 struct glyph_row
*row
= NULL
;
1900 /* Find row containing Y. Give up if some row is not enabled. */
1901 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1903 row
= MATRIX_ROW (w
->current_matrix
, i
);
1904 if (!row
->enabled_p
)
1906 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1913 /* Give up if Y is not in the window. */
1914 if (i
== w
->current_matrix
->nrows
)
1917 /* Get the glyph area containing X. */
1918 if (w
->pseudo_window_p
)
1925 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1927 *area
= LEFT_MARGIN_AREA
;
1928 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1930 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1933 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1937 *area
= RIGHT_MARGIN_AREA
;
1938 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1942 /* Find glyph containing X. */
1943 glyph
= row
->glyphs
[*area
];
1944 end
= glyph
+ row
->used
[*area
];
1946 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1948 x
-= glyph
->pixel_width
;
1958 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1961 *hpos
= glyph
- row
->glyphs
[*area
];
1965 /* Convert frame-relative x/y to coordinates relative to window W.
1966 Takes pseudo-windows into account. */
1969 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1971 if (w
->pseudo_window_p
)
1973 /* A pseudo-window is always full-width, and starts at the
1974 left edge of the frame, plus a frame border. */
1975 struct frame
*f
= XFRAME (w
->frame
);
1976 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1977 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1981 *x
-= WINDOW_LEFT_EDGE_X (w
);
1982 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1986 #ifdef HAVE_WINDOW_SYSTEM
1989 Return in RECTS[] at most N clipping rectangles for glyph string S.
1990 Return the number of stored rectangles. */
1993 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2000 if (s
->row
->full_width_p
)
2002 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2003 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2004 if (s
->row
->mode_line_p
)
2005 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2007 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2009 /* Unless displaying a mode or menu bar line, which are always
2010 fully visible, clip to the visible part of the row. */
2011 if (s
->w
->pseudo_window_p
)
2012 r
.height
= s
->row
->visible_height
;
2014 r
.height
= s
->height
;
2018 /* This is a text line that may be partially visible. */
2019 r
.x
= window_box_left (s
->w
, s
->area
);
2020 r
.width
= window_box_width (s
->w
, s
->area
);
2021 r
.height
= s
->row
->visible_height
;
2025 if (r
.x
< s
->clip_head
->x
)
2027 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2028 r
.width
-= s
->clip_head
->x
- r
.x
;
2031 r
.x
= s
->clip_head
->x
;
2034 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2036 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2037 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2042 /* If S draws overlapping rows, it's sufficient to use the top and
2043 bottom of the window for clipping because this glyph string
2044 intentionally draws over other lines. */
2045 if (s
->for_overlaps
)
2047 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2048 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2050 /* Alas, the above simple strategy does not work for the
2051 environments with anti-aliased text: if the same text is
2052 drawn onto the same place multiple times, it gets thicker.
2053 If the overlap we are processing is for the erased cursor, we
2054 take the intersection with the rectangle of the cursor. */
2055 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2057 XRectangle rc
, r_save
= r
;
2059 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2060 rc
.y
= s
->w
->phys_cursor
.y
;
2061 rc
.width
= s
->w
->phys_cursor_width
;
2062 rc
.height
= s
->w
->phys_cursor_height
;
2064 x_intersect_rectangles (&r_save
, &rc
, &r
);
2069 /* Don't use S->y for clipping because it doesn't take partially
2070 visible lines into account. For example, it can be negative for
2071 partially visible lines at the top of a window. */
2072 if (!s
->row
->full_width_p
2073 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2074 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2076 r
.y
= max (0, s
->row
->y
);
2079 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2081 /* If drawing the cursor, don't let glyph draw outside its
2082 advertised boundaries. Cleartype does this under some circumstances. */
2083 if (s
->hl
== DRAW_CURSOR
)
2085 struct glyph
*glyph
= s
->first_glyph
;
2090 if (r
.width
>= s
->x
- r
.x
)
2091 r
.width
-= s
->x
- r
.x
;
2092 else /* R2L hscrolled row with cursor outside text area */
2096 r
.width
= min (r
.width
, glyph
->pixel_width
);
2098 /* If r.y is below window bottom, ensure that we still see a cursor. */
2099 height
= min (glyph
->ascent
+ glyph
->descent
,
2100 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2101 max_y
= window_text_bottom_y (s
->w
) - height
;
2102 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2103 if (s
->ybase
- glyph
->ascent
> max_y
)
2110 /* Don't draw cursor glyph taller than our actual glyph. */
2111 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2112 if (height
< r
.height
)
2114 max_y
= r
.y
+ r
.height
;
2115 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2116 r
.height
= min (max_y
- r
.y
, height
);
2123 XRectangle r_save
= r
;
2125 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2129 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2130 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2132 #ifdef CONVERT_FROM_XRECT
2133 CONVERT_FROM_XRECT (r
, *rects
);
2141 /* If we are processing overlapping and allowed to return
2142 multiple clipping rectangles, we exclude the row of the glyph
2143 string from the clipping rectangle. This is to avoid drawing
2144 the same text on the environment with anti-aliasing. */
2145 #ifdef CONVERT_FROM_XRECT
2148 XRectangle
*rs
= rects
;
2150 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2152 if (s
->for_overlaps
& OVERLAPS_PRED
)
2155 if (r
.y
+ r
.height
> row_y
)
2158 rs
[i
].height
= row_y
- r
.y
;
2164 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2167 if (r
.y
< row_y
+ s
->row
->visible_height
)
2169 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2171 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2172 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2181 #ifdef CONVERT_FROM_XRECT
2182 for (i
= 0; i
< n
; i
++)
2183 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2190 Return in *NR the clipping rectangle for glyph string S. */
2193 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2195 get_glyph_string_clip_rects (s
, nr
, 1);
2200 Return the position and height of the phys cursor in window W.
2201 Set w->phys_cursor_width to width of phys cursor.
2205 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2206 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2208 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2209 int x
, y
, wd
, h
, h0
, y0
, ascent
;
2211 /* Compute the width of the rectangle to draw. If on a stretch
2212 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2213 rectangle as wide as the glyph, but use a canonical character
2215 wd
= glyph
->pixel_width
;
2217 x
= w
->phys_cursor
.x
;
2224 if (glyph
->type
== STRETCH_GLYPH
2225 && !x_stretch_cursor_p
)
2226 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2227 w
->phys_cursor_width
= wd
;
2229 /* Don't let the hollow cursor glyph descend below the glyph row's
2230 ascent value, lest the hollow cursor looks funny. */
2231 y
= w
->phys_cursor
.y
;
2232 ascent
= row
->ascent
;
2233 if (row
->ascent
< glyph
->ascent
)
2235 y
-= glyph
->ascent
- row
->ascent
;
2236 ascent
= glyph
->ascent
;
2239 /* If y is below window bottom, ensure that we still see a cursor. */
2240 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2242 h
= max (h0
, ascent
+ glyph
->descent
);
2243 h0
= min (h0
, ascent
+ glyph
->descent
);
2245 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2248 h
= max (h
- (y0
- y
) + 1, h0
);
2253 y0
= window_text_bottom_y (w
) - h0
;
2261 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2262 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2267 * Remember which glyph the mouse is over.
2271 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2275 struct glyph_row
*r
, *gr
, *end_row
;
2276 enum window_part part
;
2277 enum glyph_row_area area
;
2278 int x
, y
, width
, height
;
2280 /* Try to determine frame pixel position and size of the glyph under
2281 frame pixel coordinates X/Y on frame F. */
2283 if (window_resize_pixelwise
)
2288 else if (!f
->glyphs_initialized_p
2289 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2292 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2293 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2297 w
= XWINDOW (window
);
2298 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2299 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2301 x
= window_relative_x_coord (w
, part
, gx
);
2302 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2304 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2305 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2307 if (w
->pseudo_window_p
)
2310 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2316 case ON_LEFT_MARGIN
:
2317 area
= LEFT_MARGIN_AREA
;
2320 case ON_RIGHT_MARGIN
:
2321 area
= RIGHT_MARGIN_AREA
;
2324 case ON_HEADER_LINE
:
2326 gr
= (part
== ON_HEADER_LINE
2327 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2328 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2331 goto text_glyph_row_found
;
2338 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2339 if (r
->y
+ r
->height
> y
)
2345 text_glyph_row_found
:
2348 struct glyph
*g
= gr
->glyphs
[area
];
2349 struct glyph
*end
= g
+ gr
->used
[area
];
2351 height
= gr
->height
;
2352 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2353 if (gx
+ g
->pixel_width
> x
)
2358 if (g
->type
== IMAGE_GLYPH
)
2360 /* Don't remember when mouse is over image, as
2361 image may have hot-spots. */
2362 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2365 width
= g
->pixel_width
;
2369 /* Use nominal char spacing at end of line. */
2371 gx
+= (x
/ width
) * width
;
2374 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2376 gx
+= window_box_left_offset (w
, area
);
2377 /* Don't expand over the modeline to make sure the vertical
2378 drag cursor is shown early enough. */
2379 height
= min (height
,
2380 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2385 /* Use nominal line height at end of window. */
2386 gx
= (x
/ width
) * width
;
2388 gy
+= (y
/ height
) * height
;
2389 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2390 /* See comment above. */
2391 height
= min (height
,
2392 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2396 case ON_LEFT_FRINGE
:
2397 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2398 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2399 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2400 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2403 case ON_RIGHT_FRINGE
:
2404 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2405 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2406 : window_box_right_offset (w
, TEXT_AREA
));
2407 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2408 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2409 && !WINDOW_RIGHTMOST_P (w
))
2410 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2411 /* Make sure the vertical border can get her own glyph to the
2412 right of the one we build here. */
2413 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2415 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2417 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2421 case ON_VERTICAL_BORDER
:
2422 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2425 case ON_VERTICAL_SCROLL_BAR
:
2426 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2428 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2429 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2430 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2432 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2436 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2437 if (r
->y
+ r
->height
> y
)
2444 height
= gr
->height
;
2447 /* Use nominal line height at end of window. */
2449 gy
+= (y
/ height
) * height
;
2453 case ON_RIGHT_DIVIDER
:
2454 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2455 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2457 /* The bottom divider prevails. */
2458 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2461 case ON_BOTTOM_DIVIDER
:
2463 width
= WINDOW_PIXEL_WIDTH (w
);
2464 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2465 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2471 /* If there is no glyph under the mouse, then we divide the screen
2472 into a grid of the smallest glyph in the frame, and use that
2475 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2476 round down even for negative values. */
2482 gx
= (gx
/ width
) * width
;
2483 gy
= (gy
/ height
) * height
;
2489 gx
+= WINDOW_LEFT_EDGE_X (w
);
2490 gy
+= WINDOW_TOP_EDGE_Y (w
);
2493 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2495 /* Visible feedback for debugging. */
2496 #if false && defined HAVE_X_WINDOWS
2497 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_DRAWABLE (f
),
2498 f
->output_data
.x
->normal_gc
,
2499 gx
, gy
, width
, height
);
2504 #endif /* HAVE_WINDOW_SYSTEM */
2507 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2510 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2511 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2513 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2516 /***********************************************************************
2517 Lisp form evaluation
2518 ***********************************************************************/
2520 /* Error handler for safe_eval and safe_call. */
2523 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2525 add_to_log ("Error during redisplay: %S signaled %S",
2526 Flist (nargs
, args
), arg
);
2530 /* Call function FUNC with the rest of NARGS - 1 arguments
2531 following. Return the result, or nil if something went
2532 wrong. Prevent redisplay during the evaluation. */
2535 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2539 if (inhibit_eval_during_redisplay
)
2544 ptrdiff_t count
= SPECPDL_INDEX ();
2547 SAFE_ALLOCA_LISP (args
, nargs
);
2550 for (i
= 1; i
< nargs
; i
++)
2551 args
[i
] = va_arg (ap
, Lisp_Object
);
2553 specbind (Qinhibit_redisplay
, Qt
);
2555 specbind (Qinhibit_quit
, Qt
);
2556 /* Use Qt to ensure debugger does not run,
2557 so there is no possibility of wanting to redisplay. */
2558 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2561 val
= unbind_to (count
, val
);
2568 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2573 va_start (ap
, func
);
2574 retval
= safe__call (false, nargs
, func
, ap
);
2579 /* Call function FN with one argument ARG.
2580 Return the result, or nil if something went wrong. */
2583 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2585 return safe_call (2, fn
, arg
);
2589 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2595 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2601 safe_eval (Lisp_Object sexpr
)
2603 return safe__call1 (false, Qeval
, sexpr
);
2607 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2609 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2612 /* Call function FN with two arguments ARG1 and ARG2.
2613 Return the result, or nil if something went wrong. */
2616 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2618 return safe_call (3, fn
, arg1
, arg2
);
2623 /***********************************************************************
2625 ***********************************************************************/
2627 /* Define CHECK_IT to perform sanity checks on iterators.
2628 This is for debugging. It is too slow to do unconditionally. */
2631 CHECK_IT (struct it
*it
)
2634 if (it
->method
== GET_FROM_STRING
)
2636 eassert (STRINGP (it
->string
));
2637 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2641 eassert (IT_STRING_CHARPOS (*it
) < 0);
2642 if (it
->method
== GET_FROM_BUFFER
)
2644 /* Check that character and byte positions agree. */
2645 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2650 eassert (it
->current
.dpvec_index
>= 0);
2652 eassert (it
->current
.dpvec_index
< 0);
2657 /* Check that the window end of window W is what we expect it
2658 to be---the last row in the current matrix displaying text. */
2661 CHECK_WINDOW_END (struct window
*w
)
2663 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2664 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2666 struct glyph_row
*row
;
2667 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2669 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2670 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2675 /***********************************************************************
2676 Iterator initialization
2677 ***********************************************************************/
2679 /* Initialize IT for displaying current_buffer in window W, starting
2680 at character position CHARPOS. CHARPOS < 0 means that no buffer
2681 position is specified which is useful when the iterator is assigned
2682 a position later. BYTEPOS is the byte position corresponding to
2685 If ROW is not null, calls to produce_glyphs with IT as parameter
2686 will produce glyphs in that row.
2688 BASE_FACE_ID is the id of a base face to use. It must be one of
2689 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2690 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2691 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2693 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2694 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2695 will be initialized to use the corresponding mode line glyph row of
2696 the desired matrix of W. */
2699 init_iterator (struct it
*it
, struct window
*w
,
2700 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2701 struct glyph_row
*row
, enum face_id base_face_id
)
2703 enum face_id remapped_base_face_id
= base_face_id
;
2705 /* Some precondition checks. */
2706 eassert (w
!= NULL
&& it
!= NULL
);
2707 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2710 /* If face attributes have been changed since the last redisplay,
2711 free realized faces now because they depend on face definitions
2712 that might have changed. Don't free faces while there might be
2713 desired matrices pending which reference these faces. */
2714 if (!inhibit_free_realized_faces
)
2718 face_change
= false;
2719 free_all_realized_faces (Qnil
);
2721 else if (XFRAME (w
->frame
)->face_change
)
2723 XFRAME (w
->frame
)->face_change
= 0;
2724 free_all_realized_faces (w
->frame
);
2728 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2729 if (! NILP (Vface_remapping_alist
))
2730 remapped_base_face_id
2731 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2733 /* Use one of the mode line rows of W's desired matrix if
2737 if (base_face_id
== MODE_LINE_FACE_ID
2738 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2739 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2740 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2741 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2744 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2745 Other parts of redisplay rely on that. */
2746 memclear (it
, sizeof *it
);
2747 it
->current
.overlay_string_index
= -1;
2748 it
->current
.dpvec_index
= -1;
2749 it
->base_face_id
= remapped_base_face_id
;
2750 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2751 it
->paragraph_embedding
= L2R
;
2754 /* The window in which we iterate over current_buffer: */
2755 XSETWINDOW (it
->window
, w
);
2757 it
->f
= XFRAME (w
->frame
);
2761 /* Extra space between lines (on window systems only). */
2762 if (base_face_id
== DEFAULT_FACE_ID
2763 && FRAME_WINDOW_P (it
->f
))
2765 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2766 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2767 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2768 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2769 * FRAME_LINE_HEIGHT (it
->f
));
2770 else if (it
->f
->extra_line_spacing
> 0)
2771 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2774 /* If realized faces have been removed, e.g. because of face
2775 attribute changes of named faces, recompute them. When running
2776 in batch mode, the face cache of the initial frame is null. If
2777 we happen to get called, make a dummy face cache. */
2778 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2779 init_frame_faces (it
->f
);
2780 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2781 recompute_basic_faces (it
->f
);
2783 it
->override_ascent
= -1;
2785 /* Are control characters displayed as `^C'? */
2786 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2788 /* -1 means everything between a CR and the following line end
2789 is invisible. >0 means lines indented more than this value are
2791 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2793 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2795 : (!NILP (BVAR (current_buffer
, selective_display
))
2797 it
->selective_display_ellipsis_p
2798 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2800 /* Display table to use. */
2801 it
->dp
= window_display_table (w
);
2803 /* Are multibyte characters enabled in current_buffer? */
2804 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2806 /* Get the position at which the redisplay_end_trigger hook should
2807 be run, if it is to be run at all. */
2808 if (MARKERP (w
->redisplay_end_trigger
)
2809 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2810 it
->redisplay_end_trigger_charpos
2811 = marker_position (w
->redisplay_end_trigger
);
2812 else if (INTEGERP (w
->redisplay_end_trigger
))
2813 it
->redisplay_end_trigger_charpos
2814 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2817 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2819 /* Are lines in the display truncated? */
2821 it
->line_wrap
= TRUNCATE
;
2822 if (base_face_id
== DEFAULT_FACE_ID
2824 && (WINDOW_FULL_WIDTH_P (it
->w
)
2825 || NILP (Vtruncate_partial_width_windows
)
2826 || (INTEGERP (Vtruncate_partial_width_windows
)
2827 /* PXW: Shall we do something about this? */
2828 && (XINT (Vtruncate_partial_width_windows
)
2829 <= WINDOW_TOTAL_COLS (it
->w
))))
2830 && NILP (BVAR (current_buffer
, truncate_lines
)))
2831 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2832 ? WINDOW_WRAP
: WORD_WRAP
;
2834 /* Get dimensions of truncation and continuation glyphs. These are
2835 displayed as fringe bitmaps under X, but we need them for such
2836 frames when the fringes are turned off. But leave the dimensions
2837 zero for tooltip frames, as these glyphs look ugly there and also
2838 sabotage calculations of tooltip dimensions in x-show-tip. */
2839 #ifdef HAVE_WINDOW_SYSTEM
2840 if (!(FRAME_WINDOW_P (it
->f
)
2841 && FRAMEP (tip_frame
)
2842 && it
->f
== XFRAME (tip_frame
)))
2845 if (it
->line_wrap
== TRUNCATE
)
2847 /* We will need the truncation glyph. */
2848 eassert (it
->glyph_row
== NULL
);
2849 produce_special_glyphs (it
, IT_TRUNCATION
);
2850 it
->truncation_pixel_width
= it
->pixel_width
;
2854 /* We will need the continuation glyph. */
2855 eassert (it
->glyph_row
== NULL
);
2856 produce_special_glyphs (it
, IT_CONTINUATION
);
2857 it
->continuation_pixel_width
= it
->pixel_width
;
2861 /* Reset these values to zero because the produce_special_glyphs
2862 above has changed them. */
2863 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2864 it
->phys_ascent
= it
->phys_descent
= 0;
2866 /* Set this after getting the dimensions of truncation and
2867 continuation glyphs, so that we don't produce glyphs when calling
2868 produce_special_glyphs, above. */
2869 it
->glyph_row
= row
;
2870 it
->area
= TEXT_AREA
;
2872 /* Get the dimensions of the display area. The display area
2873 consists of the visible window area plus a horizontally scrolled
2874 part to the left of the window. All x-values are relative to the
2875 start of this total display area. */
2876 if (base_face_id
!= DEFAULT_FACE_ID
)
2878 /* Mode lines, menu bar in terminal frames. */
2879 it
->first_visible_x
= 0;
2880 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2885 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2886 it
->last_visible_x
= (it
->first_visible_x
2887 + window_box_width (w
, TEXT_AREA
));
2889 /* If we truncate lines, leave room for the truncation glyph(s) at
2890 the right margin. Otherwise, leave room for the continuation
2891 glyph(s). Done only if the window has no right fringe. */
2892 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2894 if (it
->line_wrap
== TRUNCATE
)
2895 it
->last_visible_x
-= it
->truncation_pixel_width
;
2897 it
->last_visible_x
-= it
->continuation_pixel_width
;
2900 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2901 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2904 /* Leave room for a border glyph. */
2905 if (!FRAME_WINDOW_P (it
->f
)
2906 && !WINDOW_RIGHTMOST_P (it
->w
))
2907 it
->last_visible_x
-= 1;
2909 it
->last_visible_y
= window_text_bottom_y (w
);
2911 /* For mode lines and alike, arrange for the first glyph having a
2912 left box line if the face specifies a box. */
2913 if (base_face_id
!= DEFAULT_FACE_ID
)
2917 it
->face_id
= remapped_base_face_id
;
2919 /* If we have a boxed mode line, make the first character appear
2920 with a left box line. */
2921 face
= FACE_FROM_ID_OR_NULL (it
->f
, remapped_base_face_id
);
2922 if (face
&& face
->box
!= FACE_NO_BOX
)
2923 it
->start_of_box_run_p
= true;
2926 /* If a buffer position was specified, set the iterator there,
2927 getting overlays and face properties from that position. */
2928 if (charpos
>= BUF_BEG (current_buffer
))
2930 it
->stop_charpos
= charpos
;
2931 it
->end_charpos
= ZV
;
2932 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2933 IT_CHARPOS (*it
) = charpos
;
2934 IT_BYTEPOS (*it
) = bytepos
;
2936 /* We will rely on `reseat' to set this up properly, via
2937 handle_face_prop. */
2938 it
->face_id
= it
->base_face_id
;
2940 it
->start
= it
->current
;
2941 /* Do we need to reorder bidirectional text? Not if this is a
2942 unibyte buffer: by definition, none of the single-byte
2943 characters are strong R2L, so no reordering is needed. And
2944 bidi.c doesn't support unibyte buffers anyway. Also, don't
2945 reorder while we are loading loadup.el, since the tables of
2946 character properties needed for reordering are not yet
2949 !redisplay__inhibit_bidi
2950 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2953 /* If we are to reorder bidirectional text, init the bidi
2957 /* Since we don't know at this point whether there will be
2958 any R2L lines in the window, we reserve space for
2959 truncation/continuation glyphs even if only the left
2960 fringe is absent. */
2961 if (base_face_id
== DEFAULT_FACE_ID
2962 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2963 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2965 if (it
->line_wrap
== TRUNCATE
)
2966 it
->last_visible_x
-= it
->truncation_pixel_width
;
2968 it
->last_visible_x
-= it
->continuation_pixel_width
;
2970 /* Note the paragraph direction that this buffer wants to
2972 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2974 it
->paragraph_embedding
= L2R
;
2975 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2977 it
->paragraph_embedding
= R2L
;
2979 it
->paragraph_embedding
= NEUTRAL_DIR
;
2980 bidi_unshelve_cache (NULL
, false);
2981 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2985 /* Compute faces etc. */
2986 reseat (it
, it
->current
.pos
, true);
2993 /* Initialize IT for the display of window W with window start POS. */
2996 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2998 struct glyph_row
*row
;
2999 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
3001 row
= w
->desired_matrix
->rows
+ first_vpos
;
3002 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3003 it
->first_vpos
= first_vpos
;
3005 /* Don't reseat to previous visible line start if current start
3006 position is in a string or image. */
3007 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3009 int first_y
= it
->current_y
;
3011 /* If window start is not at a line start, skip forward to POS to
3012 get the correct continuation lines width. */
3013 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3014 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3015 if (!start_at_line_beg_p
)
3019 reseat_at_previous_visible_line_start (it
);
3020 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3022 new_x
= it
->current_x
+ it
->pixel_width
;
3024 /* If lines are continued, this line may end in the middle
3025 of a multi-glyph character (e.g. a control character
3026 displayed as \003, or in the middle of an overlay
3027 string). In this case move_it_to above will not have
3028 taken us to the start of the continuation line but to the
3029 end of the continued line. */
3030 if (it
->current_x
> 0
3031 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3032 && (/* And glyph doesn't fit on the line. */
3033 new_x
> it
->last_visible_x
3034 /* Or it fits exactly and we're on a window
3036 || (new_x
== it
->last_visible_x
3037 && FRAME_WINDOW_P (it
->f
)
3038 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3039 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3040 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3042 if ((it
->current
.dpvec_index
>= 0
3043 || it
->current
.overlay_string_index
>= 0)
3044 /* If we are on a newline from a display vector or
3045 overlay string, then we are already at the end of
3046 a screen line; no need to go to the next line in
3047 that case, as this line is not really continued.
3048 (If we do go to the next line, C-e will not DTRT.) */
3051 set_iterator_to_next (it
, true);
3052 move_it_in_display_line_to (it
, -1, -1, 0);
3055 it
->continuation_lines_width
+= it
->current_x
;
3057 /* If the character at POS is displayed via a display
3058 vector, move_it_to above stops at the final glyph of
3059 IT->dpvec. To make the caller redisplay that character
3060 again (a.k.a. start at POS), we need to reset the
3061 dpvec_index to the beginning of IT->dpvec. */
3062 else if (it
->current
.dpvec_index
>= 0)
3063 it
->current
.dpvec_index
= 0;
3065 /* We're starting a new display line, not affected by the
3066 height of the continued line, so clear the appropriate
3067 fields in the iterator structure. */
3068 it
->max_ascent
= it
->max_descent
= 0;
3069 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3071 it
->current_y
= first_y
;
3073 it
->current_x
= it
->hpos
= 0;
3079 /* Return true if POS is a position in ellipses displayed for invisible
3080 text. W is the window we display, for text property lookup. */
3083 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3085 Lisp_Object prop
, window
;
3086 bool ellipses_p
= false;
3087 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3089 /* If POS specifies a position in a display vector, this might
3090 be for an ellipsis displayed for invisible text. We won't
3091 get the iterator set up for delivering that ellipsis unless
3092 we make sure that it gets aware of the invisible text. */
3093 if (pos
->dpvec_index
>= 0
3094 && pos
->overlay_string_index
< 0
3095 && CHARPOS (pos
->string_pos
) < 0
3097 && (XSETWINDOW (window
, w
),
3098 prop
= Fget_char_property (make_number (charpos
),
3099 Qinvisible
, window
),
3100 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3102 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3104 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3111 /* Initialize IT for stepping through current_buffer in window W,
3112 starting at position POS that includes overlay string and display
3113 vector/ control character translation position information. Value
3114 is false if there are overlay strings with newlines at POS. */
3117 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3119 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3121 bool overlay_strings_with_newlines
= false;
3123 /* If POS specifies a position in a display vector, this might
3124 be for an ellipsis displayed for invisible text. We won't
3125 get the iterator set up for delivering that ellipsis unless
3126 we make sure that it gets aware of the invisible text. */
3127 if (in_ellipses_for_invisible_text_p (pos
, w
))
3133 /* Keep in mind: the call to reseat in init_iterator skips invisible
3134 text, so we might end up at a position different from POS. This
3135 is only a problem when POS is a row start after a newline and an
3136 overlay starts there with an after-string, and the overlay has an
3137 invisible property. Since we don't skip invisible text in
3138 display_line and elsewhere immediately after consuming the
3139 newline before the row start, such a POS will not be in a string,
3140 but the call to init_iterator below will move us to the
3142 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3144 /* This only scans the current chunk -- it should scan all chunks.
3145 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3146 to 16 in 22.1 to make this a lesser problem. */
3147 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3149 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3150 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3152 while (s
< e
&& *s
!= '\n')
3157 overlay_strings_with_newlines
= true;
3162 /* If position is within an overlay string, set up IT to the right
3164 if (pos
->overlay_string_index
>= 0)
3168 /* If the first overlay string happens to have a `display'
3169 property for an image, the iterator will be set up for that
3170 image, and we have to undo that setup first before we can
3171 correct the overlay string index. */
3172 if (it
->method
== GET_FROM_IMAGE
)
3175 /* We already have the first chunk of overlay strings in
3176 IT->overlay_strings. Load more until the one for
3177 pos->overlay_string_index is in IT->overlay_strings. */
3178 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3180 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3181 it
->current
.overlay_string_index
= 0;
3184 load_overlay_strings (it
, 0);
3185 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3189 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3190 relative_index
= (it
->current
.overlay_string_index
3191 % OVERLAY_STRING_CHUNK_SIZE
);
3192 it
->string
= it
->overlay_strings
[relative_index
];
3193 eassert (STRINGP (it
->string
));
3194 it
->current
.string_pos
= pos
->string_pos
;
3195 it
->method
= GET_FROM_STRING
;
3196 it
->end_charpos
= SCHARS (it
->string
);
3197 /* Set up the bidi iterator for this overlay string. */
3200 it
->bidi_it
.string
.lstring
= it
->string
;
3201 it
->bidi_it
.string
.s
= NULL
;
3202 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3203 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3204 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3205 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3206 it
->bidi_it
.w
= it
->w
;
3207 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3208 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3210 /* Synchronize the state of the bidi iterator with
3211 pos->string_pos. For any string position other than
3212 zero, this will be done automagically when we resume
3213 iteration over the string and get_visually_first_element
3214 is called. But if string_pos is zero, and the string is
3215 to be reordered for display, we need to resync manually,
3216 since it could be that the iteration state recorded in
3217 pos ended at string_pos of 0 moving backwards in string. */
3218 if (CHARPOS (pos
->string_pos
) == 0)
3220 get_visually_first_element (it
);
3221 if (IT_STRING_CHARPOS (*it
) != 0)
3224 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3225 bidi_move_to_visually_next (&it
->bidi_it
);
3226 } while (it
->bidi_it
.charpos
!= 0);
3228 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3229 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3233 if (CHARPOS (pos
->string_pos
) >= 0)
3235 /* Recorded position is not in an overlay string, but in another
3236 string. This can only be a string from a `display' property.
3237 IT should already be filled with that string. */
3238 it
->current
.string_pos
= pos
->string_pos
;
3239 eassert (STRINGP (it
->string
));
3241 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3242 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3245 /* Restore position in display vector translations, control
3246 character translations or ellipses. */
3247 if (pos
->dpvec_index
>= 0)
3249 if (it
->dpvec
== NULL
)
3250 get_next_display_element (it
);
3251 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3252 it
->current
.dpvec_index
= pos
->dpvec_index
;
3256 return !overlay_strings_with_newlines
;
3260 /* Initialize IT for stepping through current_buffer in window W
3261 starting at ROW->start. */
3264 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3266 init_from_display_pos (it
, w
, &row
->start
);
3267 it
->start
= row
->start
;
3268 it
->continuation_lines_width
= row
->continuation_lines_width
;
3273 /* Initialize IT for stepping through current_buffer in window W
3274 starting in the line following ROW, i.e. starting at ROW->end.
3275 Value is false if there are overlay strings with newlines at ROW's
3279 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3281 bool success
= false;
3283 if (init_from_display_pos (it
, w
, &row
->end
))
3285 if (row
->continued_p
)
3286 it
->continuation_lines_width
3287 = row
->continuation_lines_width
+ row
->pixel_width
;
3298 /***********************************************************************
3300 ***********************************************************************/
3302 /* Called when IT reaches IT->stop_charpos. Handle text property and
3303 overlay changes. Set IT->stop_charpos to the next position where
3307 handle_stop (struct it
*it
)
3309 enum prop_handled handled
;
3310 bool handle_overlay_change_p
;
3314 it
->current
.dpvec_index
= -1;
3315 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3316 it
->ellipsis_p
= false;
3318 /* Use face of preceding text for ellipsis (if invisible) */
3319 if (it
->selective_display_ellipsis_p
)
3320 it
->saved_face_id
= it
->face_id
;
3322 /* Here's the description of the semantics of, and the logic behind,
3323 the various HANDLED_* statuses:
3325 HANDLED_NORMALLY means the handler did its job, and the loop
3326 should proceed to calling the next handler in order.
3328 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3329 change in the properties and overlays at current position, so the
3330 loop should be restarted, to re-invoke the handlers that were
3331 already called. This happens when fontification-functions were
3332 called by handle_fontified_prop, and actually fontified
3333 something. Another case where HANDLED_RECOMPUTE_PROPS is
3334 returned is when we discover overlay strings that need to be
3335 displayed right away. The loop below will continue for as long
3336 as the status is HANDLED_RECOMPUTE_PROPS.
3338 HANDLED_RETURN means return immediately to the caller, to
3339 continue iteration without calling any further handlers. This is
3340 used when we need to act on some property right away, for example
3341 when we need to display the ellipsis or a replacing display
3342 property, such as display string or image.
3344 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3345 consumed, and the handler switched to the next overlay string.
3346 This signals the loop below to refrain from looking for more
3347 overlays before all the overlay strings of the current overlay
3350 Some of the handlers called by the loop push the iterator state
3351 onto the stack (see 'push_it'), and arrange for the iteration to
3352 continue with another object, such as an image, a display string,
3353 or an overlay string. In most such cases, it->stop_charpos is
3354 set to the first character of the string, so that when the
3355 iteration resumes, this function will immediately be called
3356 again, to examine the properties at the beginning of the string.
3358 When a display or overlay string is exhausted, the iterator state
3359 is popped (see 'pop_it'), and iteration continues with the
3360 previous object. Again, in many such cases this function is
3361 called again to find the next position where properties might
3366 handled
= HANDLED_NORMALLY
;
3368 /* Call text property handlers. */
3369 for (p
= it_props
; p
->handler
; ++p
)
3371 handled
= p
->handler (it
);
3373 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3375 else if (handled
== HANDLED_RETURN
)
3377 /* We still want to show before and after strings from
3378 overlays even if the actual buffer text is replaced. */
3379 if (!handle_overlay_change_p
3381 /* Don't call get_overlay_strings_1 if we already
3382 have overlay strings loaded, because doing so
3383 will load them again and push the iterator state
3384 onto the stack one more time, which is not
3385 expected by the rest of the code that processes
3387 || (it
->current
.overlay_string_index
< 0
3388 && !get_overlay_strings_1 (it
, 0, false)))
3391 setup_for_ellipsis (it
, 0);
3392 /* When handling a display spec, we might load an
3393 empty string. In that case, discard it here. We
3394 used to discard it in handle_single_display_spec,
3395 but that causes get_overlay_strings_1, above, to
3396 ignore overlay strings that we must check. */
3397 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3401 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3405 it
->string_from_display_prop_p
= false;
3406 it
->from_disp_prop_p
= false;
3407 handle_overlay_change_p
= false;
3409 handled
= HANDLED_RECOMPUTE_PROPS
;
3412 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3413 handle_overlay_change_p
= false;
3416 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3418 /* Don't check for overlay strings below when set to deliver
3419 characters from a display vector. */
3420 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3421 handle_overlay_change_p
= false;
3423 /* Handle overlay changes.
3424 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3425 if it finds overlays. */
3426 if (handle_overlay_change_p
)
3427 handled
= handle_overlay_change (it
);
3432 setup_for_ellipsis (it
, 0);
3436 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3438 /* Determine where to stop next. */
3439 if (handled
== HANDLED_NORMALLY
)
3440 compute_stop_pos (it
);
3444 /* Compute IT->stop_charpos from text property and overlay change
3445 information for IT's current position. */
3448 compute_stop_pos (struct it
*it
)
3450 register INTERVAL iv
, next_iv
;
3451 Lisp_Object object
, limit
, position
;
3452 ptrdiff_t charpos
, bytepos
;
3454 if (STRINGP (it
->string
))
3456 /* Strings are usually short, so don't limit the search for
3458 it
->stop_charpos
= it
->end_charpos
;
3459 object
= it
->string
;
3461 charpos
= IT_STRING_CHARPOS (*it
);
3462 bytepos
= IT_STRING_BYTEPOS (*it
);
3468 /* If end_charpos is out of range for some reason, such as a
3469 misbehaving display function, rationalize it (Bug#5984). */
3470 if (it
->end_charpos
> ZV
)
3471 it
->end_charpos
= ZV
;
3472 it
->stop_charpos
= it
->end_charpos
;
3474 /* If next overlay change is in front of the current stop pos
3475 (which is IT->end_charpos), stop there. Note: value of
3476 next_overlay_change is point-max if no overlay change
3478 charpos
= IT_CHARPOS (*it
);
3479 bytepos
= IT_BYTEPOS (*it
);
3480 pos
= next_overlay_change (charpos
);
3481 if (pos
< it
->stop_charpos
)
3482 it
->stop_charpos
= pos
;
3484 /* Set up variables for computing the stop position from text
3485 property changes. */
3486 XSETBUFFER (object
, current_buffer
);
3487 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3490 /* Get the interval containing IT's position. Value is a null
3491 interval if there isn't such an interval. */
3492 position
= make_number (charpos
);
3493 iv
= validate_interval_range (object
, &position
, &position
, false);
3496 Lisp_Object values_here
[LAST_PROP_IDX
];
3499 /* Get properties here. */
3500 for (p
= it_props
; p
->handler
; ++p
)
3501 values_here
[p
->idx
] = textget (iv
->plist
,
3502 builtin_lisp_symbol (p
->name
));
3504 /* Look for an interval following iv that has different
3506 for (next_iv
= next_interval (iv
);
3509 || XFASTINT (limit
) > next_iv
->position
));
3510 next_iv
= next_interval (next_iv
))
3512 for (p
= it_props
; p
->handler
; ++p
)
3514 Lisp_Object new_value
= textget (next_iv
->plist
,
3515 builtin_lisp_symbol (p
->name
));
3516 if (!EQ (values_here
[p
->idx
], new_value
))
3526 if (INTEGERP (limit
)
3527 && next_iv
->position
>= XFASTINT (limit
))
3528 /* No text property change up to limit. */
3529 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3531 /* Text properties change in next_iv. */
3532 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3536 if (it
->cmp_it
.id
< 0)
3538 ptrdiff_t stoppos
= it
->end_charpos
;
3540 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3542 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3543 stoppos
, it
->string
);
3546 eassert (STRINGP (it
->string
)
3547 || (it
->stop_charpos
>= BEGV
3548 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3552 /* Return the position of the next overlay change after POS in
3553 current_buffer. Value is point-max if no overlay change
3554 follows. This is like `next-overlay-change' but doesn't use
3558 next_overlay_change (ptrdiff_t pos
)
3560 ptrdiff_t i
, noverlays
;
3562 Lisp_Object
*overlays
;
3565 /* Get all overlays at the given position. */
3566 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3568 /* If any of these overlays ends before endpos,
3569 use its ending point instead. */
3570 for (i
= 0; i
< noverlays
; ++i
)
3575 oend
= OVERLAY_END (overlays
[i
]);
3576 oendpos
= OVERLAY_POSITION (oend
);
3577 endpos
= min (endpos
, oendpos
);
3584 /* How many characters forward to search for a display property or
3585 display string. Searching too far forward makes the bidi display
3586 sluggish, especially in small windows. */
3587 #define MAX_DISP_SCAN 250
3589 /* Return the character position of a display string at or after
3590 position specified by POSITION. If no display string exists at or
3591 after POSITION, return ZV. A display string is either an overlay
3592 with `display' property whose value is a string, or a `display'
3593 text property whose value is a string. STRING is data about the
3594 string to iterate; if STRING->lstring is nil, we are iterating a
3595 buffer. FRAME_WINDOW_P is true when we are displaying a window
3596 on a GUI frame. DISP_PROP is set to zero if we searched
3597 MAX_DISP_SCAN characters forward without finding any display
3598 strings, non-zero otherwise. It is set to 2 if the display string
3599 uses any kind of `(space ...)' spec that will produce a stretch of
3600 white space in the text area. */
3602 compute_display_string_pos (struct text_pos
*position
,
3603 struct bidi_string_data
*string
,
3605 bool frame_window_p
, int *disp_prop
)
3607 /* OBJECT = nil means current buffer. */
3608 Lisp_Object object
, object1
;
3609 Lisp_Object pos
, spec
, limpos
;
3610 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3611 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3612 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3613 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3615 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3616 struct text_pos tpos
;
3619 if (string
&& STRINGP (string
->lstring
))
3620 object1
= object
= string
->lstring
;
3621 else if (w
&& !string_p
)
3623 XSETWINDOW (object
, w
);
3627 object1
= object
= Qnil
;
3632 /* We don't support display properties whose values are strings
3633 that have display string properties. */
3634 || string
->from_disp_str
3635 /* C strings cannot have display properties. */
3636 || (string
->s
&& !STRINGP (object
)))
3642 /* If the character at CHARPOS is where the display string begins,
3644 pos
= make_number (charpos
);
3645 if (STRINGP (object
))
3646 bufpos
= string
->bufpos
;
3650 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3652 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3655 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3663 /* Look forward for the first character with a `display' property
3664 that will replace the underlying text when displayed. */
3665 limpos
= make_number (lim
);
3667 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3668 CHARPOS (tpos
) = XFASTINT (pos
);
3669 if (CHARPOS (tpos
) >= lim
)
3674 if (STRINGP (object
))
3675 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3677 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3678 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3679 if (!STRINGP (object
))
3680 bufpos
= CHARPOS (tpos
);
3681 } while (NILP (spec
)
3682 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3683 bufpos
, frame_window_p
)));
3687 return CHARPOS (tpos
);
3690 /* Return the character position of the end of the display string that
3691 started at CHARPOS. If there's no display string at CHARPOS,
3692 return -1. A display string is either an overlay with `display'
3693 property whose value is a string or a `display' text property whose
3694 value is a string. */
3696 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3698 /* OBJECT = nil means current buffer. */
3699 Lisp_Object object
=
3700 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3701 Lisp_Object pos
= make_number (charpos
);
3703 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3705 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3708 /* It could happen that the display property or overlay was removed
3709 since we found it in compute_display_string_pos above. One way
3710 this can happen is if JIT font-lock was called (through
3711 handle_fontified_prop), and jit-lock-functions remove text
3712 properties or overlays from the portion of buffer that includes
3713 CHARPOS. Muse mode is known to do that, for example. In this
3714 case, we return -1 to the caller, to signal that no display
3715 string is actually present at CHARPOS. See bidi_fetch_char for
3716 how this is handled.
3718 An alternative would be to never look for display properties past
3719 it->stop_charpos. But neither compute_display_string_pos nor
3720 bidi_fetch_char that calls it know or care where the next
3722 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3725 /* Look forward for the first character where the `display' property
3727 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3729 return XFASTINT (pos
);
3734 /***********************************************************************
3736 ***********************************************************************/
3738 /* Handle changes in the `fontified' property of the current buffer by
3739 calling hook functions from Qfontification_functions to fontify
3742 static enum prop_handled
3743 handle_fontified_prop (struct it
*it
)
3745 Lisp_Object prop
, pos
;
3746 enum prop_handled handled
= HANDLED_NORMALLY
;
3748 if (!NILP (Vmemory_full
))
3751 /* Get the value of the `fontified' property at IT's current buffer
3752 position. (The `fontified' property doesn't have a special
3753 meaning in strings.) If the value is nil, call functions from
3754 Qfontification_functions. */
3755 if (!STRINGP (it
->string
)
3757 && !NILP (Vfontification_functions
)
3758 && !NILP (Vrun_hooks
)
3759 && (pos
= make_number (IT_CHARPOS (*it
)),
3760 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3761 /* Ignore the special cased nil value always present at EOB since
3762 no amount of fontifying will be able to change it. */
3763 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3765 ptrdiff_t count
= SPECPDL_INDEX ();
3767 struct buffer
*obuf
= current_buffer
;
3768 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3769 bool old_clip_changed
= current_buffer
->clip_changed
;
3771 val
= Vfontification_functions
;
3772 specbind (Qfontification_functions
, Qnil
);
3774 eassert (it
->end_charpos
== ZV
);
3776 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3777 safe_call1 (val
, pos
);
3780 Lisp_Object fns
, fn
;
3784 for (; CONSP (val
); val
= XCDR (val
))
3790 /* A value of t indicates this hook has a local
3791 binding; it means to run the global binding too.
3792 In a global value, t should not occur. If it
3793 does, we must ignore it to avoid an endless
3795 for (fns
= Fdefault_value (Qfontification_functions
);
3801 safe_call1 (fn
, pos
);
3805 safe_call1 (fn
, pos
);
3809 unbind_to (count
, Qnil
);
3811 /* Fontification functions routinely call `save-restriction'.
3812 Normally, this tags clip_changed, which can confuse redisplay
3813 (see discussion in Bug#6671). Since we don't perform any
3814 special handling of fontification changes in the case where
3815 `save-restriction' isn't called, there's no point doing so in
3816 this case either. So, if the buffer's restrictions are
3817 actually left unchanged, reset clip_changed. */
3818 if (obuf
== current_buffer
)
3820 if (begv
== BEGV
&& zv
== ZV
)
3821 current_buffer
->clip_changed
= old_clip_changed
;
3823 /* There isn't much we can reasonably do to protect against
3824 misbehaving fontification, but here's a fig leaf. */
3825 else if (BUFFER_LIVE_P (obuf
))
3826 set_buffer_internal_1 (obuf
);
3828 /* The fontification code may have added/removed text.
3829 It could do even a lot worse, but let's at least protect against
3830 the most obvious case where only the text past `pos' gets changed',
3831 as is/was done in grep.el where some escapes sequences are turned
3832 into face properties (bug#7876). */
3833 it
->end_charpos
= ZV
;
3835 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3836 something. This avoids an endless loop if they failed to
3837 fontify the text for which reason ever. */
3838 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3839 handled
= HANDLED_RECOMPUTE_PROPS
;
3847 /***********************************************************************
3849 ***********************************************************************/
3851 /* Set up iterator IT from face properties at its current position.
3852 Called from handle_stop. */
3854 static enum prop_handled
3855 handle_face_prop (struct it
*it
)
3858 ptrdiff_t next_stop
;
3860 if (!STRINGP (it
->string
))
3863 = face_at_buffer_position (it
->w
,
3867 + TEXT_PROP_DISTANCE_LIMIT
),
3868 false, it
->base_face_id
);
3870 /* Is this a start of a run of characters with box face?
3871 Caveat: this can be called for a freshly initialized
3872 iterator; face_id is -1 in this case. We know that the new
3873 face will not change until limit, i.e. if the new face has a
3874 box, all characters up to limit will have one. But, as
3875 usual, we don't know whether limit is really the end. */
3876 if (new_face_id
!= it
->face_id
)
3878 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3879 /* If it->face_id is -1, old_face below will be NULL, see
3880 the definition of FACE_FROM_ID_OR_NULL. This will happen
3881 if this is the initial call that gets the face. */
3882 struct face
*old_face
= FACE_FROM_ID_OR_NULL (it
->f
, it
->face_id
);
3884 /* If the value of face_id of the iterator is -1, we have to
3885 look in front of IT's position and see whether there is a
3886 face there that's different from new_face_id. */
3887 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3889 int prev_face_id
= face_before_it_pos (it
);
3891 old_face
= FACE_FROM_ID_OR_NULL (it
->f
, prev_face_id
);
3894 /* If the new face has a box, but the old face does not,
3895 this is the start of a run of characters with box face,
3896 i.e. this character has a shadow on the left side. */
3897 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3898 && (old_face
== NULL
|| !old_face
->box
));
3899 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3907 Lisp_Object from_overlay
3908 = (it
->current
.overlay_string_index
>= 0
3909 ? it
->string_overlays
[it
->current
.overlay_string_index
3910 % OVERLAY_STRING_CHUNK_SIZE
]
3913 /* See if we got to this string directly or indirectly from
3914 an overlay property. That includes the before-string or
3915 after-string of an overlay, strings in display properties
3916 provided by an overlay, their text properties, etc.
3918 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3919 if (! NILP (from_overlay
))
3920 for (i
= it
->sp
- 1; i
>= 0; i
--)
3922 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3924 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3925 % OVERLAY_STRING_CHUNK_SIZE
];
3926 else if (! NILP (it
->stack
[i
].from_overlay
))
3927 from_overlay
= it
->stack
[i
].from_overlay
;
3929 if (!NILP (from_overlay
))
3933 if (! NILP (from_overlay
))
3935 bufpos
= IT_CHARPOS (*it
);
3936 /* For a string from an overlay, the base face depends
3937 only on text properties and ignores overlays. */
3939 = face_for_overlay_string (it
->w
,
3943 + TEXT_PROP_DISTANCE_LIMIT
),
3951 /* For strings from a `display' property, use the face at
3952 IT's current buffer position as the base face to merge
3953 with, so that overlay strings appear in the same face as
3954 surrounding text, unless they specify their own faces.
3955 For strings from wrap-prefix and line-prefix properties,
3956 use the default face, possibly remapped via
3957 Vface_remapping_alist. */
3958 /* Note that the fact that we use the face at _buffer_
3959 position means that a 'display' property on an overlay
3960 string will not inherit the face of that overlay string,
3961 but will instead revert to the face of buffer text
3962 covered by the overlay. This is visible, e.g., when the
3963 overlay specifies a box face, but neither the buffer nor
3964 the display string do. This sounds like a design bug,
3965 but Emacs always did that since v21.1, so changing that
3966 might be a big deal. */
3967 base_face_id
= it
->string_from_prefix_prop_p
3968 ? (!NILP (Vface_remapping_alist
)
3969 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3971 : underlying_face_id (it
);
3974 new_face_id
= face_at_string_position (it
->w
,
3976 IT_STRING_CHARPOS (*it
),
3979 base_face_id
, false);
3981 /* Is this a start of a run of characters with box? Caveat:
3982 this can be called for a freshly allocated iterator; face_id
3983 is -1 is this case. We know that the new face will not
3984 change until the next check pos, i.e. if the new face has a
3985 box, all characters up to that position will have a
3986 box. But, as usual, we don't know whether that position
3987 is really the end. */
3988 if (new_face_id
!= it
->face_id
)
3990 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3991 struct face
*old_face
= FACE_FROM_ID_OR_NULL (it
->f
, it
->face_id
);
3993 /* If new face has a box but old face hasn't, this is the
3994 start of a run of characters with box, i.e. it has a
3995 shadow on the left side. */
3996 it
->start_of_box_run_p
3997 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3998 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4002 it
->face_id
= new_face_id
;
4003 return HANDLED_NORMALLY
;
4007 /* Return the ID of the face ``underlying'' IT's current position,
4008 which is in a string. If the iterator is associated with a
4009 buffer, return the face at IT's current buffer position.
4010 Otherwise, use the iterator's base_face_id. */
4013 underlying_face_id (struct it
*it
)
4015 int face_id
= it
->base_face_id
, i
;
4017 eassert (STRINGP (it
->string
));
4019 for (i
= it
->sp
- 1; i
>= 0; --i
)
4020 if (NILP (it
->stack
[i
].string
))
4021 face_id
= it
->stack
[i
].face_id
;
4027 /* Compute the face one character before or after the current position
4028 of IT, in the visual order. BEFORE_P means get the face
4029 in front (to the left in L2R paragraphs, to the right in R2L
4030 paragraphs) of IT's screen position. Value is the ID of the face. */
4033 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
4036 ptrdiff_t next_check_charpos
;
4038 void *it_copy_data
= NULL
;
4040 eassert (it
->s
== NULL
);
4042 if (STRINGP (it
->string
))
4044 ptrdiff_t bufpos
, charpos
;
4047 /* No face change past the end of the string (for the case
4048 we are padding with spaces). No face change before the
4050 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4051 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4056 /* Set charpos to the position before or after IT's current
4057 position, in the logical order, which in the non-bidi
4058 case is the same as the visual order. */
4060 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4061 else if (it
->what
== IT_COMPOSITION
)
4062 /* For composition, we must check the character after the
4064 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4066 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4072 /* With bidi iteration, the character before the current
4073 in the visual order cannot be found by simple
4074 iteration, because "reverse" reordering is not
4075 supported. Instead, we need to start from the string
4076 beginning and go all the way to the current string
4077 position, remembering the previous position. */
4078 /* Ignore face changes before the first visible
4079 character on this display line. */
4080 if (it
->current_x
<= it
->first_visible_x
)
4082 SAVE_IT (it_copy
, *it
, it_copy_data
);
4083 IT_STRING_CHARPOS (it_copy
) = 0;
4084 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4088 charpos
= IT_STRING_CHARPOS (it_copy
);
4089 if (charpos
>= SCHARS (it
->string
))
4091 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4093 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4095 RESTORE_IT (it
, it
, it_copy_data
);
4099 /* Set charpos to the string position of the character
4100 that comes after IT's current position in the visual
4102 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4106 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4108 charpos
= it_copy
.bidi_it
.charpos
;
4111 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4113 if (it
->current
.overlay_string_index
>= 0)
4114 bufpos
= IT_CHARPOS (*it
);
4118 base_face_id
= underlying_face_id (it
);
4120 /* Get the face for ASCII, or unibyte. */
4121 face_id
= face_at_string_position (it
->w
,
4125 &next_check_charpos
,
4126 base_face_id
, false);
4128 /* Correct the face for charsets different from ASCII. Do it
4129 for the multibyte case only. The face returned above is
4130 suitable for unibyte text if IT->string is unibyte. */
4131 if (STRING_MULTIBYTE (it
->string
))
4133 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4134 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4136 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4138 c
= string_char_and_length (p
, &len
);
4139 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4144 struct text_pos pos
;
4146 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4147 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4150 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4151 pos
= it
->current
.pos
;
4156 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4159 if (it
->what
== IT_COMPOSITION
)
4161 /* For composition, we must check the position after
4163 pos
.charpos
+= it
->cmp_it
.nchars
;
4164 pos
.bytepos
+= it
->len
;
4167 INC_TEXT_POS (pos
, it
->multibyte_p
);
4176 /* With bidi iteration, the character before the current
4177 in the visual order cannot be found by simple
4178 iteration, because "reverse" reordering is not
4179 supported. Instead, we need to use the move_it_*
4180 family of functions, and move to the previous
4181 character starting from the beginning of the visual
4183 /* Ignore face changes before the first visible
4184 character on this display line. */
4185 if (it
->current_x
<= it
->first_visible_x
)
4187 SAVE_IT (it_copy
, *it
, it_copy_data
);
4188 /* Implementation note: Since move_it_in_display_line
4189 works in the iterator geometry, and thinks the first
4190 character is always the leftmost, even in R2L lines,
4191 we don't need to distinguish between the R2L and L2R
4193 current_x
= it_copy
.current_x
;
4194 move_it_vertically_backward (&it_copy
, 0);
4195 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4196 pos
= it_copy
.current
.pos
;
4197 RESTORE_IT (it
, it
, it_copy_data
);
4201 /* Set charpos to the buffer position of the character
4202 that comes after IT's current position in the visual
4204 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4208 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4211 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4214 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4216 /* Determine face for CHARSET_ASCII, or unibyte. */
4217 face_id
= face_at_buffer_position (it
->w
,
4219 &next_check_charpos
,
4222 /* Correct the face for charsets different from ASCII. Do it
4223 for the multibyte case only. The face returned above is
4224 suitable for unibyte text if current_buffer is unibyte. */
4225 if (it
->multibyte_p
)
4227 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4228 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4229 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4238 /***********************************************************************
4240 ***********************************************************************/
4242 /* Set up iterator IT from invisible properties at its current
4243 position. Called from handle_stop. */
4245 static enum prop_handled
4246 handle_invisible_prop (struct it
*it
)
4248 enum prop_handled handled
= HANDLED_NORMALLY
;
4252 if (STRINGP (it
->string
))
4254 Lisp_Object end_charpos
, limit
;
4256 /* Get the value of the invisible text property at the
4257 current position. Value will be nil if there is no such
4259 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4260 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4261 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4263 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4265 /* Record whether we have to display an ellipsis for the
4267 bool display_ellipsis_p
= (invis
== 2);
4268 ptrdiff_t len
, endpos
;
4270 handled
= HANDLED_RECOMPUTE_PROPS
;
4272 /* Get the position at which the next visible text can be
4273 found in IT->string, if any. */
4274 endpos
= len
= SCHARS (it
->string
);
4275 XSETINT (limit
, len
);
4279 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4281 /* Since LIMIT is always an integer, so should be the
4282 value returned by Fnext_single_property_change. */
4283 eassert (INTEGERP (end_charpos
));
4284 if (INTEGERP (end_charpos
))
4286 endpos
= XFASTINT (end_charpos
);
4287 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4288 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4290 display_ellipsis_p
= true;
4292 else /* Should never happen; but if it does, exit the loop. */
4295 while (invis
!= 0 && endpos
< len
);
4297 if (display_ellipsis_p
)
4298 it
->ellipsis_p
= true;
4302 /* Text at END_CHARPOS is visible. Move IT there. */
4303 struct text_pos old
;
4306 old
= it
->current
.string_pos
;
4307 oldpos
= CHARPOS (old
);
4310 if (it
->bidi_it
.first_elt
4311 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4312 bidi_paragraph_init (it
->paragraph_embedding
,
4313 &it
->bidi_it
, true);
4314 /* Bidi-iterate out of the invisible text. */
4317 bidi_move_to_visually_next (&it
->bidi_it
);
4319 while (oldpos
<= it
->bidi_it
.charpos
4320 && it
->bidi_it
.charpos
< endpos
);
4322 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4323 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4324 if (IT_CHARPOS (*it
) >= endpos
)
4325 it
->prev_stop
= endpos
;
4329 IT_STRING_CHARPOS (*it
) = endpos
;
4330 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4335 /* The rest of the string is invisible. If this is an
4336 overlay string, proceed with the next overlay string
4337 or whatever comes and return a character from there. */
4338 if (it
->current
.overlay_string_index
>= 0
4339 && !display_ellipsis_p
)
4341 next_overlay_string (it
);
4342 /* Don't check for overlay strings when we just
4343 finished processing them. */
4344 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4348 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4349 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4356 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4357 Lisp_Object pos
, overlay
;
4359 /* First of all, is there invisible text at this position? */
4360 tem
= start_charpos
= IT_CHARPOS (*it
);
4361 pos
= make_number (tem
);
4362 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4364 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4366 /* If we are on invisible text, skip over it. */
4367 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4369 /* Record whether we have to display an ellipsis for the
4371 bool display_ellipsis_p
= invis
== 2;
4373 handled
= HANDLED_RECOMPUTE_PROPS
;
4375 /* Loop skipping over invisible text. The loop is left at
4376 ZV or with IT on the first char being visible again. */
4379 /* Try to skip some invisible text. Return value is the
4380 position reached which can be equal to where we start
4381 if there is nothing invisible there. This skips both
4382 over invisible text properties and overlays with
4383 invisible property. */
4384 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4386 /* If we skipped nothing at all we weren't at invisible
4387 text in the first place. If everything to the end of
4388 the buffer was skipped, end the loop. */
4389 if (newpos
== tem
|| newpos
>= ZV
)
4393 /* We skipped some characters but not necessarily
4394 all there are. Check if we ended up on visible
4395 text. Fget_char_property returns the property of
4396 the char before the given position, i.e. if we
4397 get invis = 0, this means that the char at
4398 newpos is visible. */
4399 pos
= make_number (newpos
);
4400 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4401 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4404 /* If we ended up on invisible text, proceed to
4405 skip starting with next_stop. */
4409 /* If there are adjacent invisible texts, don't lose the
4410 second one's ellipsis. */
4412 display_ellipsis_p
= true;
4416 /* The position newpos is now either ZV or on visible text. */
4419 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4421 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4423 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4425 /* If the invisible text ends on a newline or on a
4426 character after a newline, we can avoid the costly,
4427 character by character, bidi iteration to NEWPOS, and
4428 instead simply reseat the iterator there. That's
4429 because all bidi reordering information is tossed at
4430 the newline. This is a big win for modes that hide
4431 complete lines, like Outline, Org, etc. */
4432 if (on_newline
|| after_newline
)
4434 struct text_pos tpos
;
4435 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4437 SET_TEXT_POS (tpos
, newpos
, bpos
);
4438 reseat_1 (it
, tpos
, false);
4439 /* If we reseat on a newline/ZV, we need to prep the
4440 bidi iterator for advancing to the next character
4441 after the newline/EOB, keeping the current paragraph
4442 direction (so that PRODUCE_GLYPHS does TRT wrt
4443 prepending/appending glyphs to a glyph row). */
4446 it
->bidi_it
.first_elt
= false;
4447 it
->bidi_it
.paragraph_dir
= pdir
;
4448 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4449 it
->bidi_it
.nchars
= 1;
4450 it
->bidi_it
.ch_len
= 1;
4453 else /* Must use the slow method. */
4455 /* With bidi iteration, the region of invisible text
4456 could start and/or end in the middle of a
4457 non-base embedding level. Therefore, we need to
4458 skip invisible text using the bidi iterator,
4459 starting at IT's current position, until we find
4460 ourselves outside of the invisible text.
4461 Skipping invisible text _after_ bidi iteration
4462 avoids affecting the visual order of the
4463 displayed text when invisible properties are
4464 added or removed. */
4465 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4467 /* If we were `reseat'ed to a new paragraph,
4468 determine the paragraph base direction. We
4469 need to do it now because
4470 next_element_from_buffer may not have a
4471 chance to do it, if we are going to skip any
4472 text at the beginning, which resets the
4474 bidi_paragraph_init (it
->paragraph_embedding
,
4475 &it
->bidi_it
, true);
4479 bidi_move_to_visually_next (&it
->bidi_it
);
4481 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4482 && it
->bidi_it
.charpos
< newpos
);
4483 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4484 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4485 /* If we overstepped NEWPOS, record its position in
4486 the iterator, so that we skip invisible text if
4487 later the bidi iteration lands us in the
4488 invisible region again. */
4489 if (IT_CHARPOS (*it
) >= newpos
)
4490 it
->prev_stop
= newpos
;
4495 IT_CHARPOS (*it
) = newpos
;
4496 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4499 if (display_ellipsis_p
)
4501 /* Make sure that the glyphs of the ellipsis will get
4502 correct `charpos' values. If we would not update
4503 it->position here, the glyphs would belong to the
4504 last visible character _before_ the invisible
4505 text, which confuses `set_cursor_from_row'.
4507 We use the last invisible position instead of the
4508 first because this way the cursor is always drawn on
4509 the first "." of the ellipsis, whenever PT is inside
4510 the invisible text. Otherwise the cursor would be
4511 placed _after_ the ellipsis when the point is after the
4512 first invisible character. */
4513 if (!STRINGP (it
->object
))
4515 it
->position
.charpos
= newpos
- 1;
4516 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4520 /* If there are before-strings at the start of invisible
4521 text, and the text is invisible because of a text
4522 property, arrange to show before-strings because 20.x did
4523 it that way. (If the text is invisible because of an
4524 overlay property instead of a text property, this is
4525 already handled in the overlay code.) */
4527 && get_overlay_strings (it
, it
->stop_charpos
))
4529 handled
= HANDLED_RECOMPUTE_PROPS
;
4532 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4533 /* The call to get_overlay_strings above recomputes
4534 it->stop_charpos, but it only considers changes
4535 in properties and overlays beyond iterator's
4536 current position. This causes us to miss changes
4537 that happen exactly where the invisible property
4538 ended. So we play it safe here and force the
4539 iterator to check for potential stop positions
4540 immediately after the invisible text. Note that
4541 if get_overlay_strings returns true, it
4542 normally also pushed the iterator stack, so we
4543 need to update the stop position in the slot
4544 below the current one. */
4545 it
->stack
[it
->sp
- 1].stop_charpos
4546 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4549 else if (display_ellipsis_p
)
4551 it
->ellipsis_p
= true;
4552 /* Let the ellipsis display before
4553 considering any properties of the following char.
4554 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4555 handled
= HANDLED_RETURN
;
4564 /* Make iterator IT return `...' next.
4565 Replaces LEN characters from buffer. */
4568 setup_for_ellipsis (struct it
*it
, int len
)
4570 /* Use the display table definition for `...'. Invalid glyphs
4571 will be handled by the method returning elements from dpvec. */
4572 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4574 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4575 it
->dpvec
= v
->contents
;
4576 it
->dpend
= v
->contents
+ v
->header
.size
;
4580 /* Default `...'. */
4581 it
->dpvec
= default_invis_vector
;
4582 it
->dpend
= default_invis_vector
+ 3;
4585 it
->dpvec_char_len
= len
;
4586 it
->current
.dpvec_index
= 0;
4587 it
->dpvec_face_id
= -1;
4589 /* Use IT->saved_face_id for the ellipsis, so that it has the same
4590 face as the preceding text. IT->saved_face_id was set in
4591 handle_stop to the face of the preceding character, and will be
4592 different from IT->face_id only if the invisible text skipped in
4593 handle_invisible_prop has some non-default face on its first
4594 character. We thus ignore the face of the invisible text when we
4595 display the ellipsis. IT's face is restored in set_iterator_to_next. */
4596 if (it
->saved_face_id
>= 0)
4597 it
->face_id
= it
->saved_face_id
;
4599 /* If the ellipsis represents buffer text, it means we advanced in
4600 the buffer, so we should no longer ignore overlay strings. */
4601 if (it
->method
== GET_FROM_BUFFER
)
4602 it
->ignore_overlay_strings_at_pos_p
= false;
4604 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4605 it
->ellipsis_p
= true;
4610 /***********************************************************************
4612 ***********************************************************************/
4614 /* Set up iterator IT from `display' property at its current position.
4615 Called from handle_stop.
4616 We return HANDLED_RETURN if some part of the display property
4617 overrides the display of the buffer text itself.
4618 Otherwise we return HANDLED_NORMALLY. */
4620 static enum prop_handled
4621 handle_display_prop (struct it
*it
)
4623 Lisp_Object propval
, object
, overlay
;
4624 struct text_pos
*position
;
4626 /* Nonzero if some property replaces the display of the text itself. */
4627 int display_replaced
= 0;
4629 if (STRINGP (it
->string
))
4631 object
= it
->string
;
4632 position
= &it
->current
.string_pos
;
4633 bufpos
= CHARPOS (it
->current
.pos
);
4637 XSETWINDOW (object
, it
->w
);
4638 position
= &it
->current
.pos
;
4639 bufpos
= CHARPOS (*position
);
4642 /* Reset those iterator values set from display property values. */
4643 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4644 it
->space_width
= Qnil
;
4645 it
->font_height
= Qnil
;
4648 /* We don't support recursive `display' properties, i.e. string
4649 values that have a string `display' property, that have a string
4650 `display' property etc. */
4651 if (!it
->string_from_display_prop_p
)
4652 it
->area
= TEXT_AREA
;
4654 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4655 Qdisplay
, object
, &overlay
);
4657 return HANDLED_NORMALLY
;
4658 /* Now OVERLAY is the overlay that gave us this property, or nil
4659 if it was a text property. */
4661 if (!STRINGP (it
->string
))
4662 object
= it
->w
->contents
;
4664 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4666 FRAME_WINDOW_P (it
->f
));
4667 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4670 /* Subroutine of handle_display_prop. Returns non-zero if the display
4671 specification in SPEC is a replacing specification, i.e. it would
4672 replace the text covered by `display' property with something else,
4673 such as an image or a display string. If SPEC includes any kind or
4674 `(space ...) specification, the value is 2; this is used by
4675 compute_display_string_pos, which see.
4677 See handle_single_display_spec for documentation of arguments.
4678 FRAME_WINDOW_P is true if the window being redisplayed is on a
4679 GUI frame; this argument is used only if IT is NULL, see below.
4681 IT can be NULL, if this is called by the bidi reordering code
4682 through compute_display_string_pos, which see. In that case, this
4683 function only examines SPEC, but does not otherwise "handle" it, in
4684 the sense that it doesn't set up members of IT from the display
4687 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4688 Lisp_Object overlay
, struct text_pos
*position
,
4689 ptrdiff_t bufpos
, bool frame_window_p
)
4694 /* Simple specifications. */
4695 && !EQ (XCAR (spec
), Qimage
)
4696 #ifdef HAVE_XWIDGETS
4697 && !EQ (XCAR (spec
), Qxwidget
)
4699 && !EQ (XCAR (spec
), Qspace
)
4700 && !EQ (XCAR (spec
), Qwhen
)
4701 && !EQ (XCAR (spec
), Qslice
)
4702 && !EQ (XCAR (spec
), Qspace_width
)
4703 && !EQ (XCAR (spec
), Qheight
)
4704 && !EQ (XCAR (spec
), Qraise
)
4705 /* Marginal area specifications. */
4706 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4707 && !EQ (XCAR (spec
), Qleft_fringe
)
4708 && !EQ (XCAR (spec
), Qright_fringe
)
4709 && !NILP (XCAR (spec
)))
4711 for (; CONSP (spec
); spec
= XCDR (spec
))
4713 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4714 overlay
, position
, bufpos
,
4715 replacing
, frame_window_p
);
4719 /* If some text in a string is replaced, `position' no
4720 longer points to the position of `object'. */
4721 if (!it
|| STRINGP (object
))
4726 else if (VECTORP (spec
))
4729 for (i
= 0; i
< ASIZE (spec
); ++i
)
4731 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4732 overlay
, position
, bufpos
,
4733 replacing
, frame_window_p
);
4737 /* If some text in a string is replaced, `position' no
4738 longer points to the position of `object'. */
4739 if (!it
|| STRINGP (object
))
4745 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4746 bufpos
, 0, frame_window_p
);
4750 /* Value is the position of the end of the `display' property starting
4751 at START_POS in OBJECT. */
4753 static struct text_pos
4754 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4757 struct text_pos end_pos
;
4759 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4760 Qdisplay
, object
, Qnil
);
4761 CHARPOS (end_pos
) = XFASTINT (end
);
4762 if (STRINGP (object
))
4763 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4765 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4771 /* Set up IT from a single `display' property specification SPEC. OBJECT
4772 is the object in which the `display' property was found. *POSITION
4773 is the position in OBJECT at which the `display' property was found.
4774 BUFPOS is the buffer position of OBJECT (different from POSITION if
4775 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4776 previously saw a display specification which already replaced text
4777 display with something else, for example an image; we ignore such
4778 properties after the first one has been processed.
4780 OVERLAY is the overlay this `display' property came from,
4781 or nil if it was a text property.
4783 If SPEC is a `space' or `image' specification, and in some other
4784 cases too, set *POSITION to the position where the `display'
4787 If IT is NULL, only examine the property specification in SPEC, but
4788 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4789 is intended to be displayed in a window on a GUI frame.
4791 Value is non-zero if something was found which replaces the display
4792 of buffer or string text. */
4795 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4796 Lisp_Object overlay
, struct text_pos
*position
,
4797 ptrdiff_t bufpos
, int display_replaced
,
4798 bool frame_window_p
)
4801 Lisp_Object location
, value
;
4802 struct text_pos start_pos
= *position
;
4804 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4805 If the result is non-nil, use VALUE instead of SPEC. */
4807 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4816 if (!NILP (form
) && !EQ (form
, Qt
))
4818 ptrdiff_t count
= SPECPDL_INDEX ();
4820 /* Bind `object' to the object having the `display' property, a
4821 buffer or string. Bind `position' to the position in the
4822 object where the property was found, and `buffer-position'
4823 to the current position in the buffer. */
4826 XSETBUFFER (object
, current_buffer
);
4827 specbind (Qobject
, object
);
4828 specbind (Qposition
, make_number (CHARPOS (*position
)));
4829 specbind (Qbuffer_position
, make_number (bufpos
));
4830 form
= safe_eval (form
);
4831 unbind_to (count
, Qnil
);
4837 /* Handle `(height HEIGHT)' specifications. */
4839 && EQ (XCAR (spec
), Qheight
)
4840 && CONSP (XCDR (spec
)))
4844 if (!FRAME_WINDOW_P (it
->f
))
4847 it
->font_height
= XCAR (XCDR (spec
));
4848 if (!NILP (it
->font_height
))
4850 int new_height
= -1;
4852 if (CONSP (it
->font_height
)
4853 && (EQ (XCAR (it
->font_height
), Qplus
)
4854 || EQ (XCAR (it
->font_height
), Qminus
))
4855 && CONSP (XCDR (it
->font_height
))
4856 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4858 /* `(+ N)' or `(- N)' where N is an integer. */
4859 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4860 if (EQ (XCAR (it
->font_height
), Qplus
))
4862 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4864 else if (FUNCTIONP (it
->font_height
))
4866 /* Call function with current height as argument.
4867 Value is the new height. */
4868 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4870 height
= safe_call1 (it
->font_height
,
4871 face
->lface
[LFACE_HEIGHT_INDEX
]);
4872 if (NUMBERP (height
))
4873 new_height
= XFLOATINT (height
);
4875 else if (NUMBERP (it
->font_height
))
4877 /* Value is a multiple of the canonical char height. */
4880 f
= FACE_FROM_ID (it
->f
,
4881 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4882 new_height
= (XFLOATINT (it
->font_height
)
4883 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4887 /* Evaluate IT->font_height with `height' bound to the
4888 current specified height to get the new height. */
4889 ptrdiff_t count
= SPECPDL_INDEX ();
4890 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4892 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4893 value
= safe_eval (it
->font_height
);
4894 unbind_to (count
, Qnil
);
4896 if (NUMBERP (value
))
4897 new_height
= XFLOATINT (value
);
4901 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4908 /* Handle `(space-width WIDTH)'. */
4910 && EQ (XCAR (spec
), Qspace_width
)
4911 && CONSP (XCDR (spec
)))
4915 if (!FRAME_WINDOW_P (it
->f
))
4918 value
= XCAR (XCDR (spec
));
4919 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4920 it
->space_width
= value
;
4926 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4928 && EQ (XCAR (spec
), Qslice
))
4934 if (!FRAME_WINDOW_P (it
->f
))
4937 if (tem
= XCDR (spec
), CONSP (tem
))
4939 it
->slice
.x
= XCAR (tem
);
4940 if (tem
= XCDR (tem
), CONSP (tem
))
4942 it
->slice
.y
= XCAR (tem
);
4943 if (tem
= XCDR (tem
), CONSP (tem
))
4945 it
->slice
.width
= XCAR (tem
);
4946 if (tem
= XCDR (tem
), CONSP (tem
))
4947 it
->slice
.height
= XCAR (tem
);
4956 /* Handle `(raise FACTOR)'. */
4958 && EQ (XCAR (spec
), Qraise
)
4959 && CONSP (XCDR (spec
)))
4963 if (!FRAME_WINDOW_P (it
->f
))
4966 #ifdef HAVE_WINDOW_SYSTEM
4967 value
= XCAR (XCDR (spec
));
4968 if (NUMBERP (value
))
4970 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4971 it
->voffset
= - (XFLOATINT (value
)
4972 * (normal_char_height (face
->font
, -1)));
4974 #endif /* HAVE_WINDOW_SYSTEM */
4980 /* Don't handle the other kinds of display specifications
4981 inside a string that we got from a `display' property. */
4982 if (it
&& it
->string_from_display_prop_p
)
4985 /* Characters having this form of property are not displayed, so
4986 we have to find the end of the property. */
4989 start_pos
= *position
;
4990 *position
= display_prop_end (it
, object
, start_pos
);
4991 /* If the display property comes from an overlay, don't consider
4992 any potential stop_charpos values before the end of that
4993 overlay. Since display_prop_end will happily find another
4994 'display' property coming from some other overlay or text
4995 property on buffer positions before this overlay's end, we
4996 need to ignore them, or else we risk displaying this
4997 overlay's display string/image twice. */
4998 if (!NILP (overlay
))
5000 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5002 if (ovendpos
> CHARPOS (*position
))
5003 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
5008 /* Stop the scan at that end position--we assume that all
5009 text properties change there. */
5011 it
->stop_charpos
= position
->charpos
;
5013 /* Handle `(left-fringe BITMAP [FACE])'
5014 and `(right-fringe BITMAP [FACE])'. */
5016 && (EQ (XCAR (spec
), Qleft_fringe
)
5017 || EQ (XCAR (spec
), Qright_fringe
))
5018 && CONSP (XCDR (spec
)))
5022 if (!FRAME_WINDOW_P (it
->f
))
5023 /* If we return here, POSITION has been advanced
5024 across the text with this property. */
5026 /* Synchronize the bidi iterator with POSITION. This is
5027 needed because we are not going to push the iterator
5028 on behalf of this display property, so there will be
5029 no pop_it call to do this synchronization for us. */
5032 it
->position
= *position
;
5033 iterate_out_of_display_property (it
);
5034 *position
= it
->position
;
5039 else if (!frame_window_p
)
5042 #ifdef HAVE_WINDOW_SYSTEM
5043 value
= XCAR (XCDR (spec
));
5044 int fringe_bitmap
= SYMBOLP (value
) ? lookup_fringe_bitmap (value
) : 0;
5045 if (! fringe_bitmap
)
5046 /* If we return here, POSITION has been advanced
5047 across the text with this property. */
5049 if (it
&& it
->bidi_p
)
5051 it
->position
= *position
;
5052 iterate_out_of_display_property (it
);
5053 *position
= it
->position
;
5060 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5062 if (CONSP (XCDR (XCDR (spec
))))
5064 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5065 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5066 FRINGE_FACE_ID
, false);
5071 /* Save current settings of IT so that we can restore them
5072 when we are finished with the glyph property value. */
5073 push_it (it
, position
);
5075 it
->area
= TEXT_AREA
;
5076 it
->what
= IT_IMAGE
;
5077 it
->image_id
= -1; /* no image */
5078 it
->position
= start_pos
;
5079 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5080 it
->method
= GET_FROM_IMAGE
;
5081 it
->from_overlay
= Qnil
;
5082 it
->face_id
= face_id
;
5083 it
->from_disp_prop_p
= true;
5085 /* Say that we haven't consumed the characters with
5086 `display' property yet. The call to pop_it in
5087 set_iterator_to_next will clean this up. */
5088 *position
= start_pos
;
5090 if (EQ (XCAR (spec
), Qleft_fringe
))
5092 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5093 it
->left_user_fringe_face_id
= face_id
;
5097 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5098 it
->right_user_fringe_face_id
= face_id
;
5101 #endif /* HAVE_WINDOW_SYSTEM */
5105 /* Prepare to handle `((margin left-margin) ...)',
5106 `((margin right-margin) ...)' and `((margin nil) ...)'
5107 prefixes for display specifications. */
5108 location
= Qunbound
;
5109 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5113 value
= XCDR (spec
);
5115 value
= XCAR (value
);
5118 if (EQ (XCAR (tem
), Qmargin
)
5119 && (tem
= XCDR (tem
),
5120 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5122 || EQ (tem
, Qleft_margin
)
5123 || EQ (tem
, Qright_margin
))))
5127 if (EQ (location
, Qunbound
))
5133 /* After this point, VALUE is the property after any
5134 margin prefix has been stripped. It must be a string,
5135 an image specification, or `(space ...)'.
5137 LOCATION specifies where to display: `left-margin',
5138 `right-margin' or nil. */
5140 bool valid_p
= (STRINGP (value
)
5141 #ifdef HAVE_WINDOW_SYSTEM
5142 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5143 && valid_image_p (value
))
5144 #endif /* not HAVE_WINDOW_SYSTEM */
5145 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5146 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5147 && valid_xwidget_spec_p (value
)));
5149 if (valid_p
&& display_replaced
== 0)
5155 /* Callers need to know whether the display spec is any kind
5156 of `(space ...)' spec that is about to affect text-area
5158 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5163 /* Save current settings of IT so that we can restore them
5164 when we are finished with the glyph property value. */
5165 push_it (it
, position
);
5166 it
->from_overlay
= overlay
;
5167 it
->from_disp_prop_p
= true;
5169 if (NILP (location
))
5170 it
->area
= TEXT_AREA
;
5171 else if (EQ (location
, Qleft_margin
))
5172 it
->area
= LEFT_MARGIN_AREA
;
5174 it
->area
= RIGHT_MARGIN_AREA
;
5176 if (STRINGP (value
))
5179 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5180 it
->current
.overlay_string_index
= -1;
5181 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5182 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5183 it
->method
= GET_FROM_STRING
;
5184 it
->stop_charpos
= 0;
5186 it
->base_level_stop
= 0;
5187 it
->string_from_display_prop_p
= true;
5188 /* Say that we haven't consumed the characters with
5189 `display' property yet. The call to pop_it in
5190 set_iterator_to_next will clean this up. */
5191 if (BUFFERP (object
))
5192 *position
= start_pos
;
5194 /* Force paragraph direction to be that of the parent
5195 object. If the parent object's paragraph direction is
5196 not yet determined, default to L2R. */
5197 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5198 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5200 it
->paragraph_embedding
= L2R
;
5202 /* Set up the bidi iterator for this display string. */
5205 it
->bidi_it
.string
.lstring
= it
->string
;
5206 it
->bidi_it
.string
.s
= NULL
;
5207 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5208 it
->bidi_it
.string
.bufpos
= bufpos
;
5209 it
->bidi_it
.string
.from_disp_str
= true;
5210 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5211 it
->bidi_it
.w
= it
->w
;
5212 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5215 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5217 it
->method
= GET_FROM_STRETCH
;
5219 *position
= it
->position
= start_pos
;
5220 retval
= 1 + (it
->area
== TEXT_AREA
);
5222 else if (valid_xwidget_spec_p (value
))
5224 it
->what
= IT_XWIDGET
;
5225 it
->method
= GET_FROM_XWIDGET
;
5226 it
->position
= start_pos
;
5227 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5228 *position
= start_pos
;
5229 it
->xwidget
= lookup_xwidget (value
);
5231 #ifdef HAVE_WINDOW_SYSTEM
5234 it
->what
= IT_IMAGE
;
5235 it
->image_id
= lookup_image (it
->f
, value
);
5236 it
->position
= start_pos
;
5237 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5238 it
->method
= GET_FROM_IMAGE
;
5240 /* Say that we haven't consumed the characters with
5241 `display' property yet. The call to pop_it in
5242 set_iterator_to_next will clean this up. */
5243 *position
= start_pos
;
5245 #endif /* HAVE_WINDOW_SYSTEM */
5250 /* Invalid property or property not supported. Restore
5251 POSITION to what it was before. */
5252 *position
= start_pos
;
5256 /* Check if PROP is a display property value whose text should be
5257 treated as intangible. OVERLAY is the overlay from which PROP
5258 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5259 specify the buffer position covered by PROP. */
5262 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5263 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5265 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5266 struct text_pos position
;
5268 SET_TEXT_POS (position
, charpos
, bytepos
);
5269 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5270 &position
, charpos
, frame_window_p
)
5275 /* Return true if PROP is a display sub-property value containing STRING.
5277 Implementation note: this and the following function are really
5278 special cases of handle_display_spec and
5279 handle_single_display_spec, and should ideally use the same code.
5280 Until they do, these two pairs must be consistent and must be
5281 modified in sync. */
5284 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5286 if (EQ (string
, prop
))
5289 /* Skip over `when FORM'. */
5290 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5295 /* Actually, the condition following `when' should be eval'ed,
5296 like handle_single_display_spec does, and we should return
5297 false if it evaluates to nil. However, this function is
5298 called only when the buffer was already displayed and some
5299 glyph in the glyph matrix was found to come from a display
5300 string. Therefore, the condition was already evaluated, and
5301 the result was non-nil, otherwise the display string wouldn't
5302 have been displayed and we would have never been called for
5303 this property. Thus, we can skip the evaluation and assume
5304 its result is non-nil. */
5309 /* Skip over `margin LOCATION'. */
5310 if (EQ (XCAR (prop
), Qmargin
))
5321 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5325 /* Return true if STRING appears in the `display' property PROP. */
5328 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5331 && !EQ (XCAR (prop
), Qwhen
)
5332 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5334 /* A list of sub-properties. */
5335 while (CONSP (prop
))
5337 if (single_display_spec_string_p (XCAR (prop
), string
))
5342 else if (VECTORP (prop
))
5344 /* A vector of sub-properties. */
5346 for (i
= 0; i
< ASIZE (prop
); ++i
)
5347 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5351 return single_display_spec_string_p (prop
, string
);
5356 /* Look for STRING in overlays and text properties in the current
5357 buffer, between character positions FROM and TO (excluding TO).
5358 BACK_P means look back (in this case, TO is supposed to be
5360 Value is the first character position where STRING was found, or
5361 zero if it wasn't found before hitting TO.
5363 This function may only use code that doesn't eval because it is
5364 called asynchronously from note_mouse_highlight. */
5367 string_buffer_position_lim (Lisp_Object string
,
5368 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5370 Lisp_Object limit
, prop
, pos
;
5373 pos
= make_number (max (from
, BEGV
));
5375 if (!back_p
) /* looking forward */
5377 limit
= make_number (min (to
, ZV
));
5378 while (!found
&& !EQ (pos
, limit
))
5380 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5381 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5384 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5388 else /* looking back */
5390 limit
= make_number (max (to
, BEGV
));
5391 while (!found
&& !EQ (pos
, limit
))
5393 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5394 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5397 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5402 return found
? XINT (pos
) : 0;
5405 /* Determine which buffer position in current buffer STRING comes from.
5406 AROUND_CHARPOS is an approximate position where it could come from.
5407 Value is the buffer position or 0 if it couldn't be determined.
5409 This function is necessary because we don't record buffer positions
5410 in glyphs generated from strings (to keep struct glyph small).
5411 This function may only use code that doesn't eval because it is
5412 called asynchronously from note_mouse_highlight. */
5415 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5417 const int MAX_DISTANCE
= 1000;
5418 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5419 around_charpos
+ MAX_DISTANCE
,
5423 found
= string_buffer_position_lim (string
, around_charpos
,
5424 around_charpos
- MAX_DISTANCE
, true);
5430 /***********************************************************************
5431 `composition' property
5432 ***********************************************************************/
5434 /* Set up iterator IT from `composition' property at its current
5435 position. Called from handle_stop. */
5437 static enum prop_handled
5438 handle_composition_prop (struct it
*it
)
5440 Lisp_Object prop
, string
;
5441 ptrdiff_t pos
, pos_byte
, start
, end
;
5443 if (STRINGP (it
->string
))
5447 pos
= IT_STRING_CHARPOS (*it
);
5448 pos_byte
= IT_STRING_BYTEPOS (*it
);
5449 string
= it
->string
;
5450 s
= SDATA (string
) + pos_byte
;
5451 it
->c
= STRING_CHAR (s
);
5455 pos
= IT_CHARPOS (*it
);
5456 pos_byte
= IT_BYTEPOS (*it
);
5458 it
->c
= FETCH_CHAR (pos_byte
);
5461 /* If there's a valid composition and point is not inside of the
5462 composition (in the case that the composition is from the current
5463 buffer), draw a glyph composed from the composition components. */
5464 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5465 && composition_valid_p (start
, end
, prop
)
5466 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5469 /* As we can't handle this situation (perhaps font-lock added
5470 a new composition), we just return here hoping that next
5471 redisplay will detect this composition much earlier. */
5472 return HANDLED_NORMALLY
;
5475 if (STRINGP (it
->string
))
5476 pos_byte
= string_char_to_byte (it
->string
, start
);
5478 pos_byte
= CHAR_TO_BYTE (start
);
5480 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5483 if (it
->cmp_it
.id
>= 0)
5486 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5487 it
->cmp_it
.nglyphs
= -1;
5491 return HANDLED_NORMALLY
;
5496 /***********************************************************************
5498 ***********************************************************************/
5500 /* The following structure is used to record overlay strings for
5501 later sorting in load_overlay_strings. */
5503 struct overlay_entry
5505 Lisp_Object overlay
;
5508 bool after_string_p
;
5512 /* Set up iterator IT from overlay strings at its current position.
5513 Called from handle_stop. */
5515 static enum prop_handled
5516 handle_overlay_change (struct it
*it
)
5518 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5519 return HANDLED_RECOMPUTE_PROPS
;
5521 return HANDLED_NORMALLY
;
5525 /* Set up the next overlay string for delivery by IT, if there is an
5526 overlay string to deliver. Called by set_iterator_to_next when the
5527 end of the current overlay string is reached. If there are more
5528 overlay strings to display, IT->string and
5529 IT->current.overlay_string_index are set appropriately here.
5530 Otherwise IT->string is set to nil. */
5533 next_overlay_string (struct it
*it
)
5535 ++it
->current
.overlay_string_index
;
5536 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5538 /* No more overlay strings. Restore IT's settings to what
5539 they were before overlay strings were processed, and
5540 continue to deliver from current_buffer. */
5542 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5545 || (NILP (it
->string
)
5546 && it
->method
== GET_FROM_BUFFER
5547 && it
->stop_charpos
>= BEGV
5548 && it
->stop_charpos
<= it
->end_charpos
));
5549 it
->current
.overlay_string_index
= -1;
5550 it
->n_overlay_strings
= 0;
5551 /* If there's an empty display string on the stack, pop the
5552 stack, to resync the bidi iterator with IT's position. Such
5553 empty strings are pushed onto the stack in
5554 get_overlay_strings_1. */
5555 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5558 /* Since we've exhausted overlay strings at this buffer
5559 position, set the flag to ignore overlays until we move to
5560 another position. The flag is reset in
5561 next_element_from_buffer. */
5562 it
->ignore_overlay_strings_at_pos_p
= true;
5564 /* If we're at the end of the buffer, record that we have
5565 processed the overlay strings there already, so that
5566 next_element_from_buffer doesn't try it again. */
5567 if (NILP (it
->string
)
5568 && IT_CHARPOS (*it
) >= it
->end_charpos
5569 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5570 it
->overlay_strings_at_end_processed_p
= true;
5571 /* Note: we reset overlay_strings_charpos only here, to make
5572 sure the just-processed overlays were indeed at EOB.
5573 Otherwise, overlays on text with invisible text property,
5574 which are processed with IT's position past the invisible
5575 text, might fool us into thinking the overlays at EOB were
5576 already processed (linum-mode can cause this, for
5578 it
->overlay_strings_charpos
= -1;
5582 /* There are more overlay strings to process. If
5583 IT->current.overlay_string_index has advanced to a position
5584 where we must load IT->overlay_strings with more strings, do
5585 it. We must load at the IT->overlay_strings_charpos where
5586 IT->n_overlay_strings was originally computed; when invisible
5587 text is present, this might not be IT_CHARPOS (Bug#7016). */
5588 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5590 if (it
->current
.overlay_string_index
&& i
== 0)
5591 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5593 /* Initialize IT to deliver display elements from the overlay
5595 it
->string
= it
->overlay_strings
[i
];
5596 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5597 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5598 it
->method
= GET_FROM_STRING
;
5599 it
->stop_charpos
= 0;
5600 it
->end_charpos
= SCHARS (it
->string
);
5601 if (it
->cmp_it
.stop_pos
>= 0)
5602 it
->cmp_it
.stop_pos
= 0;
5604 it
->base_level_stop
= 0;
5606 /* Set up the bidi iterator for this overlay string. */
5609 it
->bidi_it
.string
.lstring
= it
->string
;
5610 it
->bidi_it
.string
.s
= NULL
;
5611 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5612 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5613 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5614 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5615 it
->bidi_it
.w
= it
->w
;
5616 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5624 /* Compare two overlay_entry structures E1 and E2. Used as a
5625 comparison function for qsort in load_overlay_strings. Overlay
5626 strings for the same position are sorted so that
5628 1. All after-strings come in front of before-strings, except
5629 when they come from the same overlay.
5631 2. Within after-strings, strings are sorted so that overlay strings
5632 from overlays with higher priorities come first.
5634 2. Within before-strings, strings are sorted so that overlay
5635 strings from overlays with higher priorities come last.
5637 Value is analogous to strcmp. */
5641 compare_overlay_entries (const void *e1
, const void *e2
)
5643 struct overlay_entry
const *entry1
= e1
;
5644 struct overlay_entry
const *entry2
= e2
;
5647 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5649 /* Let after-strings appear in front of before-strings if
5650 they come from different overlays. */
5651 if (EQ (entry1
->overlay
, entry2
->overlay
))
5652 result
= entry1
->after_string_p
? 1 : -1;
5654 result
= entry1
->after_string_p
? -1 : 1;
5656 else if (entry1
->priority
!= entry2
->priority
)
5658 if (entry1
->after_string_p
)
5659 /* After-strings sorted in order of decreasing priority. */
5660 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5662 /* Before-strings sorted in order of increasing priority. */
5663 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5672 /* Load the vector IT->overlay_strings with overlay strings from IT's
5673 current buffer position, or from CHARPOS if that is > 0. Set
5674 IT->n_overlays to the total number of overlay strings found.
5676 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5677 a time. On entry into load_overlay_strings,
5678 IT->current.overlay_string_index gives the number of overlay
5679 strings that have already been loaded by previous calls to this
5682 IT->add_overlay_start contains an additional overlay start
5683 position to consider for taking overlay strings from, if non-zero.
5684 This position comes into play when the overlay has an `invisible'
5685 property, and both before and after-strings. When we've skipped to
5686 the end of the overlay, because of its `invisible' property, we
5687 nevertheless want its before-string to appear.
5688 IT->add_overlay_start will contain the overlay start position
5691 Overlay strings are sorted so that after-string strings come in
5692 front of before-string strings. Within before and after-strings,
5693 strings are sorted by overlay priority. See also function
5694 compare_overlay_entries. */
5697 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5699 Lisp_Object overlay
, window
, str
, invisible
;
5700 struct Lisp_Overlay
*ov
;
5701 ptrdiff_t start
, end
;
5702 ptrdiff_t n
= 0, i
, j
;
5704 struct overlay_entry entriesbuf
[20];
5705 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5706 struct overlay_entry
*entries
= entriesbuf
;
5710 charpos
= IT_CHARPOS (*it
);
5712 /* Append the overlay string STRING of overlay OVERLAY to vector
5713 `entries' which has size `size' and currently contains `n'
5714 elements. AFTER_P means STRING is an after-string of
5716 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5719 Lisp_Object priority; \
5723 struct overlay_entry *old = entries; \
5724 SAFE_NALLOCA (entries, 2, size); \
5725 memcpy (entries, old, size * sizeof *entries); \
5729 entries[n].string = (STRING); \
5730 entries[n].overlay = (OVERLAY); \
5731 priority = Foverlay_get ((OVERLAY), Qpriority); \
5732 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5733 entries[n].after_string_p = (AFTER_P); \
5738 /* Process overlay before the overlay center. */
5739 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5741 XSETMISC (overlay
, ov
);
5742 eassert (OVERLAYP (overlay
));
5743 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5744 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5749 /* Skip this overlay if it doesn't start or end at IT's current
5751 if (end
!= charpos
&& start
!= charpos
)
5754 /* Skip this overlay if it doesn't apply to IT->w. */
5755 window
= Foverlay_get (overlay
, Qwindow
);
5756 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5759 /* If the text ``under'' the overlay is invisible, both before-
5760 and after-strings from this overlay are visible; start and
5761 end position are indistinguishable. */
5762 invisible
= Foverlay_get (overlay
, Qinvisible
);
5763 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5765 /* If overlay has a non-empty before-string, record it. */
5766 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5767 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5769 RECORD_OVERLAY_STRING (overlay
, str
, false);
5771 /* If overlay has a non-empty after-string, record it. */
5772 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5773 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5775 RECORD_OVERLAY_STRING (overlay
, str
, true);
5778 /* Process overlays after the overlay center. */
5779 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5781 XSETMISC (overlay
, ov
);
5782 eassert (OVERLAYP (overlay
));
5783 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5784 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5786 if (start
> charpos
)
5789 /* Skip this overlay if it doesn't start or end at IT's current
5791 if (end
!= charpos
&& start
!= charpos
)
5794 /* Skip this overlay if it doesn't apply to IT->w. */
5795 window
= Foverlay_get (overlay
, Qwindow
);
5796 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5799 /* If the text ``under'' the overlay is invisible, it has a zero
5800 dimension, and both before- and after-strings apply. */
5801 invisible
= Foverlay_get (overlay
, Qinvisible
);
5802 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5804 /* If overlay has a non-empty before-string, record it. */
5805 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5806 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5808 RECORD_OVERLAY_STRING (overlay
, str
, false);
5810 /* If overlay has a non-empty after-string, record it. */
5811 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5812 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5814 RECORD_OVERLAY_STRING (overlay
, str
, true);
5817 #undef RECORD_OVERLAY_STRING
5821 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5823 /* Record number of overlay strings, and where we computed it. */
5824 it
->n_overlay_strings
= n
;
5825 it
->overlay_strings_charpos
= charpos
;
5827 /* IT->current.overlay_string_index is the number of overlay strings
5828 that have already been consumed by IT. Copy some of the
5829 remaining overlay strings to IT->overlay_strings. */
5831 j
= it
->current
.overlay_string_index
;
5832 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5834 it
->overlay_strings
[i
] = entries
[j
].string
;
5835 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5843 /* Get the first chunk of overlay strings at IT's current buffer
5844 position, or at CHARPOS if that is > 0. Value is true if at
5845 least one overlay string was found. */
5848 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5850 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5851 process. This fills IT->overlay_strings with strings, and sets
5852 IT->n_overlay_strings to the total number of strings to process.
5853 IT->pos.overlay_string_index has to be set temporarily to zero
5854 because load_overlay_strings needs this; it must be set to -1
5855 when no overlay strings are found because a zero value would
5856 indicate a position in the first overlay string. */
5857 it
->current
.overlay_string_index
= 0;
5858 load_overlay_strings (it
, charpos
);
5860 /* If we found overlay strings, set up IT to deliver display
5861 elements from the first one. Otherwise set up IT to deliver
5862 from current_buffer. */
5863 if (it
->n_overlay_strings
)
5865 /* Make sure we know settings in current_buffer, so that we can
5866 restore meaningful values when we're done with the overlay
5869 compute_stop_pos (it
);
5870 eassert (it
->face_id
>= 0);
5872 /* Save IT's settings. They are restored after all overlay
5873 strings have been processed. */
5874 eassert (!compute_stop_p
|| it
->sp
== 0);
5876 /* When called from handle_stop, there might be an empty display
5877 string loaded. In that case, don't bother saving it. But
5878 don't use this optimization with the bidi iterator, since we
5879 need the corresponding pop_it call to resync the bidi
5880 iterator's position with IT's position, after we are done
5881 with the overlay strings. (The corresponding call to pop_it
5882 in case of an empty display string is in
5883 next_overlay_string.) */
5885 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5888 /* Set up IT to deliver display elements from the first overlay
5890 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5891 it
->string
= it
->overlay_strings
[0];
5892 it
->from_overlay
= Qnil
;
5893 it
->stop_charpos
= 0;
5894 eassert (STRINGP (it
->string
));
5895 it
->end_charpos
= SCHARS (it
->string
);
5897 it
->base_level_stop
= 0;
5898 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5899 it
->method
= GET_FROM_STRING
;
5900 it
->from_disp_prop_p
= 0;
5902 /* Force paragraph direction to be that of the parent
5904 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5905 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5907 it
->paragraph_embedding
= L2R
;
5909 /* Set up the bidi iterator for this overlay string. */
5912 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5914 it
->bidi_it
.string
.lstring
= it
->string
;
5915 it
->bidi_it
.string
.s
= NULL
;
5916 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5917 it
->bidi_it
.string
.bufpos
= pos
;
5918 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5919 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5920 it
->bidi_it
.w
= it
->w
;
5921 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5926 it
->current
.overlay_string_index
= -1;
5931 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5934 it
->method
= GET_FROM_BUFFER
;
5936 get_overlay_strings_1 (it
, charpos
, true);
5940 /* Value is true if we found at least one overlay string. */
5941 return STRINGP (it
->string
);
5946 /***********************************************************************
5947 Saving and restoring state
5948 ***********************************************************************/
5950 /* Save current settings of IT on IT->stack. Called, for example,
5951 before setting up IT for an overlay string, to be able to restore
5952 IT's settings to what they were after the overlay string has been
5953 processed. If POSITION is non-NULL, it is the position to save on
5954 the stack instead of IT->position. */
5957 push_it (struct it
*it
, struct text_pos
*position
)
5959 struct iterator_stack_entry
*p
;
5961 eassert (it
->sp
< IT_STACK_SIZE
);
5962 p
= it
->stack
+ it
->sp
;
5964 p
->stop_charpos
= it
->stop_charpos
;
5965 p
->prev_stop
= it
->prev_stop
;
5966 p
->base_level_stop
= it
->base_level_stop
;
5967 p
->cmp_it
= it
->cmp_it
;
5968 eassert (it
->face_id
>= 0);
5969 p
->face_id
= it
->face_id
;
5970 p
->string
= it
->string
;
5971 p
->method
= it
->method
;
5972 p
->from_overlay
= it
->from_overlay
;
5975 case GET_FROM_IMAGE
:
5976 p
->u
.image
.object
= it
->object
;
5977 p
->u
.image
.image_id
= it
->image_id
;
5978 p
->u
.image
.slice
= it
->slice
;
5980 case GET_FROM_STRETCH
:
5981 p
->u
.stretch
.object
= it
->object
;
5983 case GET_FROM_XWIDGET
:
5984 p
->u
.xwidget
.object
= it
->object
;
5986 case GET_FROM_BUFFER
:
5987 case GET_FROM_DISPLAY_VECTOR
:
5988 case GET_FROM_STRING
:
5989 case GET_FROM_C_STRING
:
5994 p
->position
= position
? *position
: it
->position
;
5995 p
->current
= it
->current
;
5996 p
->end_charpos
= it
->end_charpos
;
5997 p
->string_nchars
= it
->string_nchars
;
5999 p
->multibyte_p
= it
->multibyte_p
;
6000 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6001 p
->space_width
= it
->space_width
;
6002 p
->font_height
= it
->font_height
;
6003 p
->voffset
= it
->voffset
;
6004 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6005 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6006 p
->display_ellipsis_p
= false;
6007 p
->line_wrap
= it
->line_wrap
;
6008 p
->bidi_p
= it
->bidi_p
;
6009 p
->paragraph_embedding
= it
->paragraph_embedding
;
6010 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6013 /* Save the state of the bidi iterator as well. */
6015 bidi_push_it (&it
->bidi_it
);
6019 iterate_out_of_display_property (struct it
*it
)
6021 bool buffer_p
= !STRINGP (it
->string
);
6022 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6023 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6025 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6027 /* Maybe initialize paragraph direction. If we are at the beginning
6028 of a new paragraph, next_element_from_buffer may not have a
6029 chance to do that. */
6030 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6031 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
6032 /* prev_stop can be zero, so check against BEGV as well. */
6033 while (it
->bidi_it
.charpos
>= bob
6034 && it
->prev_stop
<= it
->bidi_it
.charpos
6035 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6036 && it
->bidi_it
.charpos
< eob
)
6037 bidi_move_to_visually_next (&it
->bidi_it
);
6038 /* Record the stop_pos we just crossed, for when we cross it
6040 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6041 it
->prev_stop
= CHARPOS (it
->position
);
6042 /* If we ended up not where pop_it put us, resync IT's
6043 positional members with the bidi iterator. */
6044 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6045 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6047 it
->current
.pos
= it
->position
;
6049 it
->current
.string_pos
= it
->position
;
6052 /* Restore IT's settings from IT->stack. Called, for example, when no
6053 more overlay strings must be processed, and we return to delivering
6054 display elements from a buffer, or when the end of a string from a
6055 `display' property is reached and we return to delivering display
6056 elements from an overlay string, or from a buffer. */
6059 pop_it (struct it
*it
)
6061 struct iterator_stack_entry
*p
;
6062 bool from_display_prop
= it
->from_disp_prop_p
;
6063 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
6065 eassert (it
->sp
> 0);
6067 p
= it
->stack
+ it
->sp
;
6068 it
->stop_charpos
= p
->stop_charpos
;
6069 it
->prev_stop
= p
->prev_stop
;
6070 it
->base_level_stop
= p
->base_level_stop
;
6071 it
->cmp_it
= p
->cmp_it
;
6072 it
->face_id
= p
->face_id
;
6073 it
->current
= p
->current
;
6074 it
->position
= p
->position
;
6075 it
->string
= p
->string
;
6076 it
->from_overlay
= p
->from_overlay
;
6077 if (NILP (it
->string
))
6078 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6079 it
->method
= p
->method
;
6082 case GET_FROM_IMAGE
:
6083 it
->image_id
= p
->u
.image
.image_id
;
6084 it
->object
= p
->u
.image
.object
;
6085 it
->slice
= p
->u
.image
.slice
;
6087 case GET_FROM_XWIDGET
:
6088 it
->object
= p
->u
.xwidget
.object
;
6090 case GET_FROM_STRETCH
:
6091 it
->object
= p
->u
.stretch
.object
;
6093 case GET_FROM_BUFFER
:
6094 it
->object
= it
->w
->contents
;
6096 case GET_FROM_STRING
:
6098 struct face
*face
= FACE_FROM_ID_OR_NULL (it
->f
, it
->face_id
);
6100 /* Restore the face_box_p flag, since it could have been
6101 overwritten by the face of the object that we just finished
6104 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6105 it
->object
= it
->string
;
6108 case GET_FROM_DISPLAY_VECTOR
:
6110 it
->method
= GET_FROM_C_STRING
;
6111 else if (STRINGP (it
->string
))
6112 it
->method
= GET_FROM_STRING
;
6115 it
->method
= GET_FROM_BUFFER
;
6116 it
->object
= it
->w
->contents
;
6119 case GET_FROM_C_STRING
:
6124 it
->end_charpos
= p
->end_charpos
;
6125 it
->string_nchars
= p
->string_nchars
;
6127 it
->multibyte_p
= p
->multibyte_p
;
6128 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6129 it
->space_width
= p
->space_width
;
6130 it
->font_height
= p
->font_height
;
6131 it
->voffset
= p
->voffset
;
6132 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6133 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6134 it
->line_wrap
= p
->line_wrap
;
6135 it
->bidi_p
= p
->bidi_p
;
6136 it
->paragraph_embedding
= p
->paragraph_embedding
;
6137 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6140 bidi_pop_it (&it
->bidi_it
);
6141 /* Bidi-iterate until we get out of the portion of text, if any,
6142 covered by a `display' text property or by an overlay with
6143 `display' property. (We cannot just jump there, because the
6144 internal coherency of the bidi iterator state can not be
6145 preserved across such jumps.) We also must determine the
6146 paragraph base direction if the overlay we just processed is
6147 at the beginning of a new paragraph. */
6148 if (from_display_prop
6149 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6150 iterate_out_of_display_property (it
);
6152 eassert ((BUFFERP (it
->object
)
6153 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6154 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6155 || (STRINGP (it
->object
)
6156 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6157 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6158 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6160 /* If we move the iterator over text covered by a display property
6161 to a new buffer position, any info about previously seen overlays
6162 is no longer valid. */
6163 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6164 it
->ignore_overlay_strings_at_pos_p
= false;
6169 /***********************************************************************
6171 ***********************************************************************/
6173 /* Set IT's current position to the previous line start. */
6176 back_to_previous_line_start (struct it
*it
)
6178 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6181 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6185 /* Move IT to the next line start.
6187 Value is true if a newline was found. Set *SKIPPED_P to true if
6188 we skipped over part of the text (as opposed to moving the iterator
6189 continuously over the text). Otherwise, don't change the value
6192 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6193 iterator on the newline, if it was found.
6195 Newlines may come from buffer text, overlay strings, or strings
6196 displayed via the `display' property. That's the reason we can't
6197 simply use find_newline_no_quit.
6199 Note that this function may not skip over invisible text that is so
6200 because of text properties and immediately follows a newline. If
6201 it would, function reseat_at_next_visible_line_start, when called
6202 from set_iterator_to_next, would effectively make invisible
6203 characters following a newline part of the wrong glyph row, which
6204 leads to wrong cursor motion. */
6207 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6208 struct bidi_it
*bidi_it_prev
)
6210 ptrdiff_t old_selective
;
6211 bool newline_found_p
= false;
6213 const int MAX_NEWLINE_DISTANCE
= 500;
6215 /* If already on a newline, just consume it to avoid unintended
6216 skipping over invisible text below. */
6217 if (it
->what
== IT_CHARACTER
6219 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6221 if (it
->bidi_p
&& bidi_it_prev
)
6222 *bidi_it_prev
= it
->bidi_it
;
6223 set_iterator_to_next (it
, false);
6228 /* Don't handle selective display in the following. It's (a)
6229 unnecessary because it's done by the caller, and (b) leads to an
6230 infinite recursion because next_element_from_ellipsis indirectly
6231 calls this function. */
6232 old_selective
= it
->selective
;
6235 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6236 from buffer text. */
6238 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6239 n
+= !STRINGP (it
->string
))
6241 if (!get_next_display_element (it
))
6243 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6244 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6245 *bidi_it_prev
= it
->bidi_it
;
6246 set_iterator_to_next (it
, false);
6249 /* If we didn't find a newline near enough, see if we can use a
6251 if (!newline_found_p
)
6253 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6254 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6258 eassert (!STRINGP (it
->string
));
6260 /* If there isn't any `display' property in sight, and no
6261 overlays, we can just use the position of the newline in
6263 if (it
->stop_charpos
>= limit
6264 || ((pos
= Fnext_single_property_change (make_number (start
),
6266 make_number (limit
)),
6268 && next_overlay_change (start
) == ZV
))
6272 IT_CHARPOS (*it
) = limit
;
6273 IT_BYTEPOS (*it
) = bytepos
;
6277 struct bidi_it bprev
;
6279 /* Help bidi.c avoid expensive searches for display
6280 properties and overlays, by telling it that there are
6281 none up to `limit'. */
6282 if (it
->bidi_it
.disp_pos
< limit
)
6284 it
->bidi_it
.disp_pos
= limit
;
6285 it
->bidi_it
.disp_prop
= 0;
6288 bprev
= it
->bidi_it
;
6289 bidi_move_to_visually_next (&it
->bidi_it
);
6290 } while (it
->bidi_it
.charpos
!= limit
);
6291 IT_CHARPOS (*it
) = limit
;
6292 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6294 *bidi_it_prev
= bprev
;
6296 *skipped_p
= newline_found_p
= true;
6300 while (!newline_found_p
)
6302 if (!get_next_display_element (it
))
6304 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6305 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6306 *bidi_it_prev
= it
->bidi_it
;
6307 set_iterator_to_next (it
, false);
6312 it
->selective
= old_selective
;
6313 return newline_found_p
;
6317 /* Set IT's current position to the previous visible line start. Skip
6318 invisible text that is so either due to text properties or due to
6319 selective display. Caution: this does not change IT->current_x and
6323 back_to_previous_visible_line_start (struct it
*it
)
6325 while (IT_CHARPOS (*it
) > BEGV
)
6327 back_to_previous_line_start (it
);
6329 if (IT_CHARPOS (*it
) <= BEGV
)
6332 /* If selective > 0, then lines indented more than its value are
6334 if (it
->selective
> 0
6335 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6339 /* Check the newline before point for invisibility. */
6342 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6343 Qinvisible
, it
->window
);
6344 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6348 if (IT_CHARPOS (*it
) <= BEGV
)
6353 void *it2data
= NULL
;
6356 Lisp_Object val
, overlay
;
6358 SAVE_IT (it2
, *it
, it2data
);
6360 /* If newline is part of a composition, continue from start of composition */
6361 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6362 && beg
< IT_CHARPOS (*it
))
6365 /* If newline is replaced by a display property, find start of overlay
6366 or interval and continue search from that point. */
6367 pos
= --IT_CHARPOS (it2
);
6370 bidi_unshelve_cache (NULL
, false);
6371 it2
.string_from_display_prop_p
= false;
6372 it2
.from_disp_prop_p
= false;
6373 if (handle_display_prop (&it2
) == HANDLED_RETURN
6374 && !NILP (val
= get_char_property_and_overlay
6375 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6376 && (OVERLAYP (overlay
)
6377 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6378 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6380 RESTORE_IT (it
, it
, it2data
);
6384 /* Newline is not replaced by anything -- so we are done. */
6385 RESTORE_IT (it
, it
, it2data
);
6391 IT_CHARPOS (*it
) = beg
;
6392 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6396 it
->continuation_lines_width
= 0;
6398 eassert (IT_CHARPOS (*it
) >= BEGV
);
6399 eassert (IT_CHARPOS (*it
) == BEGV
6400 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6405 /* Reseat iterator IT at the previous visible line start. Skip
6406 invisible text that is so either due to text properties or due to
6407 selective display. At the end, update IT's overlay information,
6408 face information etc. */
6411 reseat_at_previous_visible_line_start (struct it
*it
)
6413 back_to_previous_visible_line_start (it
);
6414 reseat (it
, it
->current
.pos
, true);
6419 /* Reseat iterator IT on the next visible line start in the current
6420 buffer. ON_NEWLINE_P means position IT on the newline
6421 preceding the line start. Skip over invisible text that is so
6422 because of selective display. Compute faces, overlays etc at the
6423 new position. Note that this function does not skip over text that
6424 is invisible because of text properties. */
6427 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6429 bool skipped_p
= false;
6430 struct bidi_it bidi_it_prev
;
6431 bool newline_found_p
6432 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6434 /* Skip over lines that are invisible because they are indented
6435 more than the value of IT->selective. */
6436 if (it
->selective
> 0)
6437 while (IT_CHARPOS (*it
) < ZV
6438 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6441 eassert (IT_BYTEPOS (*it
) == BEGV
6442 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6444 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6447 /* Position on the newline if that's what's requested. */
6448 if (on_newline_p
&& newline_found_p
)
6450 if (STRINGP (it
->string
))
6452 if (IT_STRING_CHARPOS (*it
) > 0)
6456 --IT_STRING_CHARPOS (*it
);
6457 --IT_STRING_BYTEPOS (*it
);
6461 /* We need to restore the bidi iterator to the state
6462 it had on the newline, and resync the IT's
6463 position with that. */
6464 it
->bidi_it
= bidi_it_prev
;
6465 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6466 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6470 else if (IT_CHARPOS (*it
) > BEGV
)
6479 /* We need to restore the bidi iterator to the state it
6480 had on the newline and resync IT with that. */
6481 it
->bidi_it
= bidi_it_prev
;
6482 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6483 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6485 reseat (it
, it
->current
.pos
, false);
6489 reseat (it
, it
->current
.pos
, false);
6496 /***********************************************************************
6497 Changing an iterator's position
6498 ***********************************************************************/
6500 /* Change IT's current position to POS in current_buffer.
6501 If FORCE_P, always check for text properties at the new position.
6502 Otherwise, text properties are only looked up if POS >=
6503 IT->check_charpos of a property. */
6506 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6508 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6510 reseat_1 (it
, pos
, false);
6512 /* Determine where to check text properties. Avoid doing it
6513 where possible because text property lookup is very expensive. */
6515 || CHARPOS (pos
) > it
->stop_charpos
6516 || CHARPOS (pos
) < original_pos
)
6520 /* For bidi iteration, we need to prime prev_stop and
6521 base_level_stop with our best estimations. */
6522 /* Implementation note: Of course, POS is not necessarily a
6523 stop position, so assigning prev_pos to it is a lie; we
6524 should have called compute_stop_backwards. However, if
6525 the current buffer does not include any R2L characters,
6526 that call would be a waste of cycles, because the
6527 iterator will never move back, and thus never cross this
6528 "fake" stop position. So we delay that backward search
6529 until the time we really need it, in next_element_from_buffer. */
6530 if (CHARPOS (pos
) != it
->prev_stop
)
6531 it
->prev_stop
= CHARPOS (pos
);
6532 if (CHARPOS (pos
) < it
->base_level_stop
)
6533 it
->base_level_stop
= 0; /* meaning it's unknown */
6539 it
->prev_stop
= it
->base_level_stop
= 0;
6548 /* Change IT's buffer position to POS. SET_STOP_P means set
6549 IT->stop_pos to POS, also. */
6552 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6554 /* Don't call this function when scanning a C string. */
6555 eassert (it
->s
== NULL
);
6557 /* POS must be a reasonable value. */
6558 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6560 it
->current
.pos
= it
->position
= pos
;
6561 it
->end_charpos
= ZV
;
6563 it
->current
.dpvec_index
= -1;
6564 it
->current
.overlay_string_index
= -1;
6565 IT_STRING_CHARPOS (*it
) = -1;
6566 IT_STRING_BYTEPOS (*it
) = -1;
6568 it
->method
= GET_FROM_BUFFER
;
6569 it
->object
= it
->w
->contents
;
6570 it
->area
= TEXT_AREA
;
6571 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6573 it
->string_from_display_prop_p
= false;
6574 it
->string_from_prefix_prop_p
= false;
6576 it
->from_disp_prop_p
= false;
6577 it
->face_before_selective_p
= false;
6580 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6582 bidi_unshelve_cache (NULL
, false);
6583 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6584 it
->bidi_it
.string
.s
= NULL
;
6585 it
->bidi_it
.string
.lstring
= Qnil
;
6586 it
->bidi_it
.string
.bufpos
= 0;
6587 it
->bidi_it
.string
.from_disp_str
= false;
6588 it
->bidi_it
.string
.unibyte
= false;
6589 it
->bidi_it
.w
= it
->w
;
6594 it
->stop_charpos
= CHARPOS (pos
);
6595 it
->base_level_stop
= CHARPOS (pos
);
6597 /* This make the information stored in it->cmp_it invalidate. */
6602 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6603 If S is non-null, it is a C string to iterate over. Otherwise,
6604 STRING gives a Lisp string to iterate over.
6606 If PRECISION > 0, don't return more then PRECISION number of
6607 characters from the string.
6609 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6610 characters have been returned. FIELD_WIDTH < 0 means an infinite
6613 MULTIBYTE = 0 means disable processing of multibyte characters,
6614 MULTIBYTE > 0 means enable it,
6615 MULTIBYTE < 0 means use IT->multibyte_p.
6617 IT must be initialized via a prior call to init_iterator before
6618 calling this function. */
6621 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6622 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6625 /* No text property checks performed by default, but see below. */
6626 it
->stop_charpos
= -1;
6628 /* Set iterator position and end position. */
6629 memset (&it
->current
, 0, sizeof it
->current
);
6630 it
->current
.overlay_string_index
= -1;
6631 it
->current
.dpvec_index
= -1;
6632 eassert (charpos
>= 0);
6634 /* If STRING is specified, use its multibyteness, otherwise use the
6635 setting of MULTIBYTE, if specified. */
6637 it
->multibyte_p
= multibyte
> 0;
6639 /* Bidirectional reordering of strings is controlled by the default
6640 value of bidi-display-reordering. Don't try to reorder while
6641 loading loadup.el, as the necessary character property tables are
6642 not yet available. */
6644 !redisplay__inhibit_bidi
6645 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6649 eassert (STRINGP (string
));
6650 it
->string
= string
;
6652 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6653 it
->method
= GET_FROM_STRING
;
6654 it
->current
.string_pos
= string_pos (charpos
, string
);
6658 it
->bidi_it
.string
.lstring
= string
;
6659 it
->bidi_it
.string
.s
= NULL
;
6660 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6661 it
->bidi_it
.string
.bufpos
= 0;
6662 it
->bidi_it
.string
.from_disp_str
= false;
6663 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6664 it
->bidi_it
.w
= it
->w
;
6665 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6666 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6671 it
->s
= (const unsigned char *) s
;
6674 /* Note that we use IT->current.pos, not it->current.string_pos,
6675 for displaying C strings. */
6676 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6677 if (it
->multibyte_p
)
6679 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6680 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6684 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6685 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6690 it
->bidi_it
.string
.lstring
= Qnil
;
6691 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6692 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6693 it
->bidi_it
.string
.bufpos
= 0;
6694 it
->bidi_it
.string
.from_disp_str
= false;
6695 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6696 it
->bidi_it
.w
= it
->w
;
6697 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6700 it
->method
= GET_FROM_C_STRING
;
6703 /* PRECISION > 0 means don't return more than PRECISION characters
6705 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6707 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6709 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6712 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6713 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6714 FIELD_WIDTH < 0 means infinite field width. This is useful for
6715 padding with `-' at the end of a mode line. */
6716 if (field_width
< 0)
6717 field_width
= INFINITY
;
6718 /* Implementation note: We deliberately don't enlarge
6719 it->bidi_it.string.schars here to fit it->end_charpos, because
6720 the bidi iterator cannot produce characters out of thin air. */
6721 if (field_width
> it
->end_charpos
- charpos
)
6722 it
->end_charpos
= charpos
+ field_width
;
6724 /* Use the standard display table for displaying strings. */
6725 if (DISP_TABLE_P (Vstandard_display_table
))
6726 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6728 it
->stop_charpos
= charpos
;
6729 it
->prev_stop
= charpos
;
6730 it
->base_level_stop
= 0;
6733 it
->bidi_it
.first_elt
= true;
6734 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6735 it
->bidi_it
.disp_pos
= -1;
6737 if (s
== NULL
&& it
->multibyte_p
)
6739 ptrdiff_t endpos
= SCHARS (it
->string
);
6740 if (endpos
> it
->end_charpos
)
6741 endpos
= it
->end_charpos
;
6742 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6750 /***********************************************************************
6752 ***********************************************************************/
6754 /* Map enum it_method value to corresponding next_element_from_* function. */
6756 typedef bool (*next_element_function
) (struct it
*);
6758 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6760 next_element_from_buffer
,
6761 next_element_from_display_vector
,
6762 next_element_from_string
,
6763 next_element_from_c_string
,
6764 next_element_from_image
,
6765 next_element_from_stretch
,
6766 next_element_from_xwidget
,
6769 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6772 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6773 (possibly with the following characters). */
6775 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6776 ((IT)->cmp_it.id >= 0 \
6777 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6778 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6779 END_CHARPOS, (IT)->w, \
6780 FACE_FROM_ID_OR_NULL ((IT)->f, \
6785 /* Lookup the char-table Vglyphless_char_display for character C (-1
6786 if we want information for no-font case), and return the display
6787 method symbol. By side-effect, update it->what and
6788 it->glyphless_method. This function is called from
6789 get_next_display_element for each character element, and from
6790 x_produce_glyphs when no suitable font was found. */
6793 lookup_glyphless_char_display (int c
, struct it
*it
)
6795 Lisp_Object glyphless_method
= Qnil
;
6797 if (CHAR_TABLE_P (Vglyphless_char_display
)
6798 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6802 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6803 if (CONSP (glyphless_method
))
6804 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6805 ? XCAR (glyphless_method
)
6806 : XCDR (glyphless_method
);
6809 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6813 if (NILP (glyphless_method
))
6816 /* The default is to display the character by a proper font. */
6818 /* The default for the no-font case is to display an empty box. */
6819 glyphless_method
= Qempty_box
;
6821 if (EQ (glyphless_method
, Qzero_width
))
6824 return glyphless_method
;
6825 /* This method can't be used for the no-font case. */
6826 glyphless_method
= Qempty_box
;
6828 if (EQ (glyphless_method
, Qthin_space
))
6829 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6830 else if (EQ (glyphless_method
, Qempty_box
))
6831 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6832 else if (EQ (glyphless_method
, Qhex_code
))
6833 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6834 else if (STRINGP (glyphless_method
))
6835 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6838 /* Invalid value. We use the default method. */
6839 glyphless_method
= Qnil
;
6842 it
->what
= IT_GLYPHLESS
;
6843 return glyphless_method
;
6846 /* Merge escape glyph face and cache the result. */
6848 static struct frame
*last_escape_glyph_frame
= NULL
;
6849 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6850 static int last_escape_glyph_merged_face_id
= 0;
6853 merge_escape_glyph_face (struct it
*it
)
6857 if (it
->f
== last_escape_glyph_frame
6858 && it
->face_id
== last_escape_glyph_face_id
)
6859 face_id
= last_escape_glyph_merged_face_id
;
6862 /* Merge the `escape-glyph' face into the current face. */
6863 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6864 last_escape_glyph_frame
= it
->f
;
6865 last_escape_glyph_face_id
= it
->face_id
;
6866 last_escape_glyph_merged_face_id
= face_id
;
6871 /* Likewise for glyphless glyph face. */
6873 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6874 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6875 static int last_glyphless_glyph_merged_face_id
= 0;
6878 merge_glyphless_glyph_face (struct it
*it
)
6882 if (it
->f
== last_glyphless_glyph_frame
6883 && it
->face_id
== last_glyphless_glyph_face_id
)
6884 face_id
= last_glyphless_glyph_merged_face_id
;
6887 /* Merge the `glyphless-char' face into the current face. */
6888 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6889 last_glyphless_glyph_frame
= it
->f
;
6890 last_glyphless_glyph_face_id
= it
->face_id
;
6891 last_glyphless_glyph_merged_face_id
= face_id
;
6896 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6897 be called before redisplaying windows, and when the frame's face
6900 forget_escape_and_glyphless_faces (void)
6902 last_escape_glyph_frame
= NULL
;
6903 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6904 last_glyphless_glyph_frame
= NULL
;
6905 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6908 /* Load IT's display element fields with information about the next
6909 display element from the current position of IT. Value is false if
6910 end of buffer (or C string) is reached. */
6913 get_next_display_element (struct it
*it
)
6915 /* True means that we found a display element. False means that
6916 we hit the end of what we iterate over. Performance note: the
6917 function pointer `method' used here turns out to be faster than
6918 using a sequence of if-statements. */
6922 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6924 if (it
->what
== IT_CHARACTER
)
6926 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6927 and only if (a) the resolved directionality of that character
6929 /* FIXME: Do we need an exception for characters from display
6931 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6932 && !inhibit_bidi_mirroring
)
6933 it
->c
= bidi_mirror_char (it
->c
);
6934 /* Map via display table or translate control characters.
6935 IT->c, IT->len etc. have been set to the next character by
6936 the function call above. If we have a display table, and it
6937 contains an entry for IT->c, translate it. Don't do this if
6938 IT->c itself comes from a display table, otherwise we could
6939 end up in an infinite recursion. (An alternative could be to
6940 count the recursion depth of this function and signal an
6941 error when a certain maximum depth is reached.) Is it worth
6943 if (success_p
&& it
->dpvec
== NULL
)
6946 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6947 bool nonascii_space_p
= false;
6948 bool nonascii_hyphen_p
= false;
6949 int c
= it
->c
; /* This is the character to display. */
6951 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6953 eassert (SINGLE_BYTE_CHAR_P (c
));
6954 if (unibyte_display_via_language_environment
)
6956 c
= DECODE_CHAR (unibyte
, c
);
6958 c
= BYTE8_TO_CHAR (it
->c
);
6961 c
= BYTE8_TO_CHAR (it
->c
);
6965 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6968 struct Lisp_Vector
*v
= XVECTOR (dv
);
6970 /* Return the first character from the display table
6971 entry, if not empty. If empty, don't display the
6972 current character. */
6975 it
->dpvec_char_len
= it
->len
;
6976 it
->dpvec
= v
->contents
;
6977 it
->dpend
= v
->contents
+ v
->header
.size
;
6978 it
->current
.dpvec_index
= 0;
6979 it
->dpvec_face_id
= -1;
6980 it
->saved_face_id
= it
->face_id
;
6981 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6982 it
->ellipsis_p
= false;
6986 set_iterator_to_next (it
, false);
6991 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6993 if (it
->what
== IT_GLYPHLESS
)
6995 /* Don't display this character. */
6996 set_iterator_to_next (it
, false);
7000 /* If `nobreak-char-display' is non-nil, we display
7001 non-ASCII spaces and hyphens specially. */
7002 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7004 if (c
== NO_BREAK_SPACE
)
7005 nonascii_space_p
= true;
7006 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
7007 || c
== NON_BREAKING_HYPHEN
)
7008 nonascii_hyphen_p
= true;
7011 /* Translate control characters into `\003' or `^C' form.
7012 Control characters coming from a display table entry are
7013 currently not translated because we use IT->dpvec to hold
7014 the translation. This could easily be changed but I
7015 don't believe that it is worth doing.
7017 The characters handled by `nobreak-char-display' must be
7020 Non-printable characters and raw-byte characters are also
7021 translated to octal form. */
7022 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7023 ? (it
->area
!= TEXT_AREA
7024 /* In mode line, treat \n, \t like other crl chars. */
7027 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7028 || (c
!= '\n' && c
!= '\t'))
7030 || nonascii_hyphen_p
7032 || ! CHAR_PRINTABLE_P (c
))))
7034 /* C is a control character, non-ASCII space/hyphen,
7035 raw-byte, or a non-printable character which must be
7036 displayed either as '\003' or as `^C' where the '\\'
7037 and '^' can be defined in the display table. Fill
7038 IT->ctl_chars with glyphs for what we have to
7039 display. Then, set IT->dpvec to these glyphs. */
7046 /* Handle control characters with ^. */
7048 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7052 g
= '^'; /* default glyph for Control */
7053 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7055 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7057 g
= GLYPH_CODE_CHAR (gc
);
7058 lface_id
= GLYPH_CODE_FACE (gc
);
7062 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7063 : merge_escape_glyph_face (it
));
7065 XSETINT (it
->ctl_chars
[0], g
);
7066 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7068 goto display_control
;
7071 /* Handle non-ascii space in the mode where it only gets
7074 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7076 /* Merge `nobreak-space' into the current face. */
7077 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7079 XSETINT (it
->ctl_chars
[0], ' ');
7081 goto display_control
;
7084 /* Handle non-ascii hyphens in the mode where it only
7085 gets highlighting. */
7087 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7089 /* Merge `nobreak-space' into the current face. */
7090 face_id
= merge_faces (it
->f
, Qnobreak_hyphen
, 0,
7092 XSETINT (it
->ctl_chars
[0], '-');
7094 goto display_control
;
7097 /* Handle sequences that start with the "escape glyph". */
7099 /* the default escape glyph is \. */
7100 escape_glyph
= '\\';
7103 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7105 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7106 lface_id
= GLYPH_CODE_FACE (gc
);
7110 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7111 : merge_escape_glyph_face (it
));
7113 /* Draw non-ASCII space/hyphen with escape glyph: */
7115 if (nonascii_space_p
|| nonascii_hyphen_p
)
7117 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7118 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7120 goto display_control
;
7127 if (CHAR_BYTE8_P (c
))
7128 /* Display \200 instead of \17777600. */
7129 c
= CHAR_TO_BYTE8 (c
);
7130 len
= sprintf (str
, "%03o", c
+ 0u);
7132 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7133 for (i
= 0; i
< len
; i
++)
7134 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7139 /* Set up IT->dpvec and return first character from it. */
7140 it
->dpvec_char_len
= it
->len
;
7141 it
->dpvec
= it
->ctl_chars
;
7142 it
->dpend
= it
->dpvec
+ ctl_len
;
7143 it
->current
.dpvec_index
= 0;
7144 it
->dpvec_face_id
= face_id
;
7145 it
->saved_face_id
= it
->face_id
;
7146 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7147 it
->ellipsis_p
= false;
7150 it
->char_to_display
= c
;
7154 it
->char_to_display
= it
->c
;
7158 #ifdef HAVE_WINDOW_SYSTEM
7159 /* Adjust face id for a multibyte character. There are no multibyte
7160 character in unibyte text. */
7161 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7164 && FRAME_WINDOW_P (it
->f
))
7166 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7168 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7170 /* Automatic composition with glyph-string. */
7171 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7173 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7177 ptrdiff_t pos
= (it
->s
? -1
7178 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7179 : IT_CHARPOS (*it
));
7182 if (it
->what
== IT_CHARACTER
)
7183 c
= it
->char_to_display
;
7186 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7190 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7191 /* TAB in a composition means display glyphs with
7192 padding space on the left or right. */
7193 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7196 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7199 #endif /* HAVE_WINDOW_SYSTEM */
7202 /* Is this character the last one of a run of characters with
7203 box? If yes, set IT->end_of_box_run_p to true. */
7207 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7209 int face_id
= underlying_face_id (it
);
7210 struct face
*face
= FACE_FROM_ID_OR_NULL (it
->f
, face_id
);
7214 if (face
->box
== FACE_NO_BOX
)
7216 /* If the box comes from face properties in a
7217 display string, check faces in that string. */
7218 int string_face_id
= face_after_it_pos (it
);
7219 it
->end_of_box_run_p
7220 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7223 /* Otherwise, the box comes from the underlying face.
7224 If this is the last string character displayed, check
7225 the next buffer location. */
7226 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7227 /* n_overlay_strings is unreliable unless
7228 overlay_string_index is non-negative. */
7229 && ((it
->current
.overlay_string_index
>= 0
7230 && (it
->current
.overlay_string_index
7231 == it
->n_overlay_strings
- 1))
7232 /* A string from display property. */
7233 || it
->from_disp_prop_p
))
7237 bool text_from_string
= false;
7238 /* Normally, the next buffer location is stored in
7239 IT->current.pos... */
7240 struct text_pos pos
= it
->current
.pos
;
7242 /* ...but for a string from a display property, the
7243 next buffer position is stored in the 'position'
7244 member of the iteration stack slot below the
7245 current one, see handle_single_display_spec. By
7246 contrast, it->current.pos was not yet updated to
7247 point to that buffer position; that will happen
7248 in pop_it, after we finish displaying the current
7249 string. Note that we already checked above that
7250 it->sp is positive, so subtracting one from it is
7252 if (it
->from_disp_prop_p
)
7254 int stackp
= it
->sp
- 1;
7256 /* Find the stack level with data from buffer. */
7258 && STRINGP ((it
->stack
+ stackp
)->string
))
7262 /* If no stack slot was found for iterating
7263 a buffer, we are displaying text from a
7264 string, most probably the mode line or
7265 the header line, and that string has a
7266 display string on some of its
7268 text_from_string
= true;
7269 pos
= it
->stack
[it
->sp
- 1].position
;
7272 pos
= (it
->stack
+ stackp
)->position
;
7275 INC_TEXT_POS (pos
, it
->multibyte_p
);
7277 if (text_from_string
)
7279 Lisp_Object base_string
= it
->stack
[it
->sp
- 1].string
;
7281 if (CHARPOS (pos
) >= SCHARS (base_string
) - 1)
7282 it
->end_of_box_run_p
= true;
7286 = face_at_string_position (it
->w
, base_string
,
7288 &ignore
, face_id
, false);
7289 it
->end_of_box_run_p
7290 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7294 else if (CHARPOS (pos
) >= ZV
)
7295 it
->end_of_box_run_p
= true;
7299 face_at_buffer_position (it
->w
, CHARPOS (pos
), &ignore
,
7301 + TEXT_PROP_DISTANCE_LIMIT
,
7303 it
->end_of_box_run_p
7304 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7310 /* next_element_from_display_vector sets this flag according to
7311 faces of the display vector glyphs, see there. */
7312 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7314 int face_id
= face_after_it_pos (it
);
7315 it
->end_of_box_run_p
7316 = (face_id
!= it
->face_id
7317 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7320 /* If we reached the end of the object we've been iterating (e.g., a
7321 display string or an overlay string), and there's something on
7322 IT->stack, proceed with what's on the stack. It doesn't make
7323 sense to return false if there's unprocessed stuff on the stack,
7324 because otherwise that stuff will never be displayed. */
7325 if (!success_p
&& it
->sp
> 0)
7327 set_iterator_to_next (it
, false);
7328 success_p
= get_next_display_element (it
);
7331 /* Value is false if end of buffer or string reached. */
7336 /* Move IT to the next display element.
7338 RESEAT_P means if called on a newline in buffer text,
7339 skip to the next visible line start.
7341 Functions get_next_display_element and set_iterator_to_next are
7342 separate because I find this arrangement easier to handle than a
7343 get_next_display_element function that also increments IT's
7344 position. The way it is we can first look at an iterator's current
7345 display element, decide whether it fits on a line, and if it does,
7346 increment the iterator position. The other way around we probably
7347 would either need a flag indicating whether the iterator has to be
7348 incremented the next time, or we would have to implement a
7349 decrement position function which would not be easy to write. */
7352 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7354 /* Reset flags indicating start and end of a sequence of characters
7355 with box. Reset them at the start of this function because
7356 moving the iterator to a new position might set them. */
7357 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7361 case GET_FROM_BUFFER
:
7362 /* The current display element of IT is a character from
7363 current_buffer. Advance in the buffer, and maybe skip over
7364 invisible lines that are so because of selective display. */
7365 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7366 reseat_at_next_visible_line_start (it
, false);
7367 else if (it
->cmp_it
.id
>= 0)
7369 /* We are currently getting glyphs from a composition. */
7372 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7373 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7379 /* Update IT's char/byte positions to point to the first
7380 character of the next grapheme cluster, or to the
7381 character visually after the current composition. */
7382 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7383 bidi_move_to_visually_next (&it
->bidi_it
);
7384 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7385 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7388 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7389 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7391 /* Composition created while scanning forward. Proceed
7392 to the next grapheme cluster. */
7393 it
->cmp_it
.from
= it
->cmp_it
.to
;
7395 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7396 && it
->cmp_it
.from
> 0)
7398 /* Composition created while scanning backward. Proceed
7399 to the previous grapheme cluster. */
7400 it
->cmp_it
.to
= it
->cmp_it
.from
;
7404 /* No more grapheme clusters in this composition.
7405 Find the next stop position. */
7406 ptrdiff_t stop
= it
->end_charpos
;
7408 if (it
->bidi_it
.scan_dir
< 0)
7409 /* Now we are scanning backward and don't know
7412 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7413 IT_BYTEPOS (*it
), stop
, Qnil
);
7418 eassert (it
->len
!= 0);
7422 IT_BYTEPOS (*it
) += it
->len
;
7423 IT_CHARPOS (*it
) += 1;
7427 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7428 /* If this is a new paragraph, determine its base
7429 direction (a.k.a. its base embedding level). */
7430 if (it
->bidi_it
.new_paragraph
)
7431 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7433 bidi_move_to_visually_next (&it
->bidi_it
);
7434 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7435 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7436 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7438 /* As the scan direction was changed, we must
7439 re-compute the stop position for composition. */
7440 ptrdiff_t stop
= it
->end_charpos
;
7441 if (it
->bidi_it
.scan_dir
< 0)
7443 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7444 IT_BYTEPOS (*it
), stop
, Qnil
);
7447 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7451 case GET_FROM_C_STRING
:
7452 /* Current display element of IT is from a C string. */
7454 /* If the string position is beyond string's end, it means
7455 next_element_from_c_string is padding the string with
7456 blanks, in which case we bypass the bidi iterator,
7457 because it cannot deal with such virtual characters. */
7458 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7460 IT_BYTEPOS (*it
) += it
->len
;
7461 IT_CHARPOS (*it
) += 1;
7465 bidi_move_to_visually_next (&it
->bidi_it
);
7466 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7467 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7471 case GET_FROM_DISPLAY_VECTOR
:
7472 /* Current display element of IT is from a display table entry.
7473 Advance in the display table definition. Reset it to null if
7474 end reached, and continue with characters from buffers/
7476 ++it
->current
.dpvec_index
;
7478 /* Restore face of the iterator to what they were before the
7479 display vector entry (these entries may contain faces). */
7480 it
->face_id
= it
->saved_face_id
;
7482 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7484 bool recheck_faces
= it
->ellipsis_p
;
7487 it
->method
= GET_FROM_C_STRING
;
7488 else if (STRINGP (it
->string
))
7489 it
->method
= GET_FROM_STRING
;
7492 it
->method
= GET_FROM_BUFFER
;
7493 it
->object
= it
->w
->contents
;
7497 it
->current
.dpvec_index
= -1;
7499 /* Skip over characters which were displayed via IT->dpvec. */
7500 if (it
->dpvec_char_len
< 0)
7501 reseat_at_next_visible_line_start (it
, true);
7502 else if (it
->dpvec_char_len
> 0)
7504 it
->len
= it
->dpvec_char_len
;
7505 set_iterator_to_next (it
, reseat_p
);
7508 /* Maybe recheck faces after display vector. */
7511 if (it
->method
== GET_FROM_STRING
)
7512 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7514 it
->stop_charpos
= IT_CHARPOS (*it
);
7519 case GET_FROM_STRING
:
7520 /* Current display element is a character from a Lisp string. */
7521 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7522 /* Don't advance past string end. These conditions are true
7523 when set_iterator_to_next is called at the end of
7524 get_next_display_element, in which case the Lisp string is
7525 already exhausted, and all we want is pop the iterator
7527 if (it
->current
.overlay_string_index
>= 0)
7529 /* This is an overlay string, so there's no padding with
7530 spaces, and the number of characters in the string is
7531 where the string ends. */
7532 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7533 goto consider_string_end
;
7537 /* Not an overlay string. There could be padding, so test
7538 against it->end_charpos. */
7539 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7540 goto consider_string_end
;
7542 if (it
->cmp_it
.id
>= 0)
7544 /* We are delivering display elements from a composition.
7545 Update the string position past the grapheme cluster
7546 we've just processed. */
7549 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7550 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7556 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7557 bidi_move_to_visually_next (&it
->bidi_it
);
7558 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7559 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7562 /* Did we exhaust all the grapheme clusters of this
7564 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7565 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7567 /* Not all the grapheme clusters were processed yet;
7568 advance to the next cluster. */
7569 it
->cmp_it
.from
= it
->cmp_it
.to
;
7571 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7572 && it
->cmp_it
.from
> 0)
7574 /* Likewise: advance to the next cluster, but going in
7575 the reverse direction. */
7576 it
->cmp_it
.to
= it
->cmp_it
.from
;
7580 /* This composition was fully processed; find the next
7581 candidate place for checking for composed
7583 /* Always limit string searches to the string length;
7584 any padding spaces are not part of the string, and
7585 there cannot be any compositions in that padding. */
7586 ptrdiff_t stop
= SCHARS (it
->string
);
7588 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7590 else if (it
->end_charpos
< stop
)
7592 /* Cf. PRECISION in reseat_to_string: we might be
7593 limited in how many of the string characters we
7595 stop
= it
->end_charpos
;
7597 composition_compute_stop_pos (&it
->cmp_it
,
7598 IT_STRING_CHARPOS (*it
),
7599 IT_STRING_BYTEPOS (*it
), stop
,
7606 /* If the string position is beyond string's end, it
7607 means next_element_from_string is padding the string
7608 with blanks, in which case we bypass the bidi
7609 iterator, because it cannot deal with such virtual
7611 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7613 IT_STRING_BYTEPOS (*it
) += it
->len
;
7614 IT_STRING_CHARPOS (*it
) += 1;
7618 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7620 bidi_move_to_visually_next (&it
->bidi_it
);
7621 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7622 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7623 /* If the scan direction changes, we may need to update
7624 the place where to check for composed characters. */
7625 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7627 ptrdiff_t stop
= SCHARS (it
->string
);
7629 if (it
->bidi_it
.scan_dir
< 0)
7631 else if (it
->end_charpos
< stop
)
7632 stop
= it
->end_charpos
;
7634 composition_compute_stop_pos (&it
->cmp_it
,
7635 IT_STRING_CHARPOS (*it
),
7636 IT_STRING_BYTEPOS (*it
), stop
,
7642 consider_string_end
:
7644 if (it
->current
.overlay_string_index
>= 0)
7646 /* IT->string is an overlay string. Advance to the
7647 next, if there is one. */
7648 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7650 it
->ellipsis_p
= false;
7651 next_overlay_string (it
);
7653 setup_for_ellipsis (it
, 0);
7658 /* IT->string is not an overlay string. If we reached
7659 its end, and there is something on IT->stack, proceed
7660 with what is on the stack. This can be either another
7661 string, this time an overlay string, or a buffer. */
7662 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7666 if (it
->method
== GET_FROM_STRING
)
7667 goto consider_string_end
;
7672 case GET_FROM_IMAGE
:
7673 case GET_FROM_STRETCH
:
7674 case GET_FROM_XWIDGET
:
7676 /* The position etc with which we have to proceed are on
7677 the stack. The position may be at the end of a string,
7678 if the `display' property takes up the whole string. */
7679 eassert (it
->sp
> 0);
7681 if (it
->method
== GET_FROM_STRING
)
7682 goto consider_string_end
;
7686 /* There are no other methods defined, so this should be a bug. */
7690 eassert (it
->method
!= GET_FROM_STRING
7691 || (STRINGP (it
->string
)
7692 && IT_STRING_CHARPOS (*it
) >= 0));
7695 /* Load IT's display element fields with information about the next
7696 display element which comes from a display table entry or from the
7697 result of translating a control character to one of the forms `^C'
7700 IT->dpvec holds the glyphs to return as characters.
7701 IT->saved_face_id holds the face id before the display vector--it
7702 is restored into IT->face_id in set_iterator_to_next. */
7705 next_element_from_display_vector (struct it
*it
)
7708 int prev_face_id
= it
->face_id
;
7712 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7714 it
->face_id
= it
->saved_face_id
;
7716 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7717 That seemed totally bogus - so I changed it... */
7718 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7720 if (GLYPH_CODE_P (gc
))
7722 struct face
*this_face
, *prev_face
, *next_face
;
7724 it
->c
= GLYPH_CODE_CHAR (gc
);
7725 it
->len
= CHAR_BYTES (it
->c
);
7727 /* The entry may contain a face id to use. Such a face id is
7728 the id of a Lisp face, not a realized face. A face id of
7729 zero means no face is specified. */
7730 if (it
->dpvec_face_id
>= 0)
7731 it
->face_id
= it
->dpvec_face_id
;
7734 int lface_id
= GLYPH_CODE_FACE (gc
);
7736 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7740 /* Glyphs in the display vector could have the box face, so we
7741 need to set the related flags in the iterator, as
7743 this_face
= FACE_FROM_ID_OR_NULL (it
->f
, it
->face_id
);
7744 prev_face
= FACE_FROM_ID_OR_NULL (it
->f
, prev_face_id
);
7746 /* Is this character the first character of a box-face run? */
7747 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7749 || prev_face
->box
== FACE_NO_BOX
));
7751 /* For the last character of the box-face run, we need to look
7752 either at the next glyph from the display vector, or at the
7753 face we saw before the display vector. */
7754 next_face_id
= it
->saved_face_id
;
7755 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7757 if (it
->dpvec_face_id
>= 0)
7758 next_face_id
= it
->dpvec_face_id
;
7762 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7765 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7769 next_face
= FACE_FROM_ID_OR_NULL (it
->f
, next_face_id
);
7770 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7772 || next_face
->box
== FACE_NO_BOX
));
7773 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7776 /* Display table entry is invalid. Return a space. */
7777 it
->c
= ' ', it
->len
= 1;
7779 /* Don't change position and object of the iterator here. They are
7780 still the values of the character that had this display table
7781 entry or was translated, and that's what we want. */
7782 it
->what
= IT_CHARACTER
;
7786 /* Get the first element of string/buffer in the visual order, after
7787 being reseated to a new position in a string or a buffer. */
7789 get_visually_first_element (struct it
*it
)
7791 bool string_p
= STRINGP (it
->string
) || it
->s
;
7792 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7793 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7795 if (STRINGP (it
->string
))
7797 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7798 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7802 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7803 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7806 if (it
->bidi_it
.charpos
== eob
)
7808 /* Nothing to do, but reset the FIRST_ELT flag, like
7809 bidi_paragraph_init does, because we are not going to
7811 it
->bidi_it
.first_elt
= false;
7813 else if (it
->bidi_it
.charpos
== bob
7815 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7816 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7818 /* If we are at the beginning of a line/string, we can produce
7819 the next element right away. */
7820 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7821 bidi_move_to_visually_next (&it
->bidi_it
);
7825 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7827 /* We need to prime the bidi iterator starting at the line's or
7828 string's beginning, before we will be able to produce the
7831 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7833 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7834 IT_BYTEPOS (*it
), -1,
7835 &it
->bidi_it
.bytepos
);
7836 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7839 /* Now return to buffer/string position where we were asked
7840 to get the next display element, and produce that. */
7841 bidi_move_to_visually_next (&it
->bidi_it
);
7843 while (it
->bidi_it
.bytepos
!= orig_bytepos
7844 && it
->bidi_it
.charpos
< eob
);
7847 /* Adjust IT's position information to where we ended up. */
7848 if (STRINGP (it
->string
))
7850 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7851 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7855 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7856 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7859 if (STRINGP (it
->string
) || !it
->s
)
7861 ptrdiff_t stop
, charpos
, bytepos
;
7863 if (STRINGP (it
->string
))
7866 stop
= SCHARS (it
->string
);
7867 if (stop
> it
->end_charpos
)
7868 stop
= it
->end_charpos
;
7869 charpos
= IT_STRING_CHARPOS (*it
);
7870 bytepos
= IT_STRING_BYTEPOS (*it
);
7874 stop
= it
->end_charpos
;
7875 charpos
= IT_CHARPOS (*it
);
7876 bytepos
= IT_BYTEPOS (*it
);
7878 if (it
->bidi_it
.scan_dir
< 0)
7880 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7885 /* Load IT with the next display element from Lisp string IT->string.
7886 IT->current.string_pos is the current position within the string.
7887 If IT->current.overlay_string_index >= 0, the Lisp string is an
7891 next_element_from_string (struct it
*it
)
7893 struct text_pos position
;
7895 eassert (STRINGP (it
->string
));
7896 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7897 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7898 position
= it
->current
.string_pos
;
7900 /* With bidi reordering, the character to display might not be the
7901 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7902 that we were reseat()ed to a new string, whose paragraph
7903 direction is not known. */
7904 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7906 get_visually_first_element (it
);
7907 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7910 /* Time to check for invisible text? */
7911 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7913 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7916 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7917 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7919 /* With bidi non-linear iteration, we could find
7920 ourselves far beyond the last computed stop_charpos,
7921 with several other stop positions in between that we
7922 missed. Scan them all now, in buffer's logical
7923 order, until we find and handle the last stop_charpos
7924 that precedes our current position. */
7925 handle_stop_backwards (it
, it
->stop_charpos
);
7926 return GET_NEXT_DISPLAY_ELEMENT (it
);
7932 /* Take note of the stop position we just moved
7933 across, for when we will move back across it. */
7934 it
->prev_stop
= it
->stop_charpos
;
7935 /* If we are at base paragraph embedding level, take
7936 note of the last stop position seen at this
7938 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7939 it
->base_level_stop
= it
->stop_charpos
;
7943 /* Since a handler may have changed IT->method, we must
7945 return GET_NEXT_DISPLAY_ELEMENT (it
);
7949 /* If we are before prev_stop, we may have overstepped
7950 on our way backwards a stop_pos, and if so, we need
7951 to handle that stop_pos. */
7952 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7953 /* We can sometimes back up for reasons that have nothing
7954 to do with bidi reordering. E.g., compositions. The
7955 code below is only needed when we are above the base
7956 embedding level, so test for that explicitly. */
7957 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7959 /* If we lost track of base_level_stop, we have no better
7960 place for handle_stop_backwards to start from than string
7961 beginning. This happens, e.g., when we were reseated to
7962 the previous screenful of text by vertical-motion. */
7963 if (it
->base_level_stop
<= 0
7964 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7965 it
->base_level_stop
= 0;
7966 handle_stop_backwards (it
, it
->base_level_stop
);
7967 return GET_NEXT_DISPLAY_ELEMENT (it
);
7971 if (it
->current
.overlay_string_index
>= 0)
7973 /* Get the next character from an overlay string. In overlay
7974 strings, there is no field width or padding with spaces to
7976 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7981 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7982 IT_STRING_BYTEPOS (*it
),
7983 it
->bidi_it
.scan_dir
< 0
7985 : SCHARS (it
->string
))
7986 && next_element_from_composition (it
))
7990 else if (STRING_MULTIBYTE (it
->string
))
7992 const unsigned char *s
= (SDATA (it
->string
)
7993 + IT_STRING_BYTEPOS (*it
));
7994 it
->c
= string_char_and_length (s
, &it
->len
);
7998 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8004 /* Get the next character from a Lisp string that is not an
8005 overlay string. Such strings come from the mode line, for
8006 example. We may have to pad with spaces, or truncate the
8007 string. See also next_element_from_c_string. */
8008 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
8013 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
8015 /* Pad with spaces. */
8016 it
->c
= ' ', it
->len
= 1;
8017 CHARPOS (position
) = BYTEPOS (position
) = -1;
8019 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
8020 IT_STRING_BYTEPOS (*it
),
8021 it
->bidi_it
.scan_dir
< 0
8023 : it
->string_nchars
)
8024 && next_element_from_composition (it
))
8028 else if (STRING_MULTIBYTE (it
->string
))
8030 const unsigned char *s
= (SDATA (it
->string
)
8031 + IT_STRING_BYTEPOS (*it
));
8032 it
->c
= string_char_and_length (s
, &it
->len
);
8036 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8041 /* Record what we have and where it came from. */
8042 it
->what
= IT_CHARACTER
;
8043 it
->object
= it
->string
;
8044 it
->position
= position
;
8049 /* Load IT with next display element from C string IT->s.
8050 IT->string_nchars is the maximum number of characters to return
8051 from the string. IT->end_charpos may be greater than
8052 IT->string_nchars when this function is called, in which case we
8053 may have to return padding spaces. Value is false if end of string
8054 reached, including padding spaces. */
8057 next_element_from_c_string (struct it
*it
)
8059 bool success_p
= true;
8062 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8063 it
->what
= IT_CHARACTER
;
8064 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8065 it
->object
= make_number (0);
8067 /* With bidi reordering, the character to display might not be the
8068 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8069 we were reseated to a new string, whose paragraph direction is
8071 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8072 get_visually_first_element (it
);
8074 /* IT's position can be greater than IT->string_nchars in case a
8075 field width or precision has been specified when the iterator was
8077 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8079 /* End of the game. */
8083 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8085 /* Pad with spaces. */
8086 it
->c
= ' ', it
->len
= 1;
8087 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8089 else if (it
->multibyte_p
)
8090 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8092 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8098 /* Set up IT to return characters from an ellipsis, if appropriate.
8099 The definition of the ellipsis glyphs may come from a display table
8100 entry. This function fills IT with the first glyph from the
8101 ellipsis if an ellipsis is to be displayed. */
8104 next_element_from_ellipsis (struct it
*it
)
8106 if (it
->selective_display_ellipsis_p
)
8107 setup_for_ellipsis (it
, it
->len
);
8110 /* The face at the current position may be different from the
8111 face we find after the invisible text. Remember what it
8112 was in IT->saved_face_id, and signal that it's there by
8113 setting face_before_selective_p. */
8114 it
->saved_face_id
= it
->face_id
;
8115 it
->method
= GET_FROM_BUFFER
;
8116 it
->object
= it
->w
->contents
;
8117 reseat_at_next_visible_line_start (it
, true);
8118 it
->face_before_selective_p
= true;
8121 return GET_NEXT_DISPLAY_ELEMENT (it
);
8125 /* Deliver an image display element. The iterator IT is already
8126 filled with image information (done in handle_display_prop). Value
8131 next_element_from_image (struct it
*it
)
8133 it
->what
= IT_IMAGE
;
8138 next_element_from_xwidget (struct it
*it
)
8140 it
->what
= IT_XWIDGET
;
8145 /* Fill iterator IT with next display element from a stretch glyph
8146 property. IT->object is the value of the text property. Value is
8150 next_element_from_stretch (struct it
*it
)
8152 it
->what
= IT_STRETCH
;
8156 /* Scan backwards from IT's current position until we find a stop
8157 position, or until BEGV. This is called when we find ourself
8158 before both the last known prev_stop and base_level_stop while
8159 reordering bidirectional text. */
8162 compute_stop_pos_backwards (struct it
*it
)
8164 const int SCAN_BACK_LIMIT
= 1000;
8165 struct text_pos pos
;
8166 struct display_pos save_current
= it
->current
;
8167 struct text_pos save_position
= it
->position
;
8168 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8169 ptrdiff_t where_we_are
= charpos
;
8170 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8171 ptrdiff_t save_end_pos
= it
->end_charpos
;
8173 eassert (NILP (it
->string
) && !it
->s
);
8174 eassert (it
->bidi_p
);
8178 it
->end_charpos
= min (charpos
+ 1, ZV
);
8179 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8180 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8181 reseat_1 (it
, pos
, false);
8182 compute_stop_pos (it
);
8183 /* We must advance forward, right? */
8184 if (it
->stop_charpos
<= charpos
)
8187 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8189 if (it
->stop_charpos
<= where_we_are
)
8190 it
->prev_stop
= it
->stop_charpos
;
8192 it
->prev_stop
= BEGV
;
8194 it
->current
= save_current
;
8195 it
->position
= save_position
;
8196 it
->stop_charpos
= save_stop_pos
;
8197 it
->end_charpos
= save_end_pos
;
8200 /* Scan forward from CHARPOS in the current buffer/string, until we
8201 find a stop position > current IT's position. Then handle the stop
8202 position before that. This is called when we bump into a stop
8203 position while reordering bidirectional text. CHARPOS should be
8204 the last previously processed stop_pos (or BEGV/0, if none were
8205 processed yet) whose position is less that IT's current
8209 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8211 bool bufp
= !STRINGP (it
->string
);
8212 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8213 struct display_pos save_current
= it
->current
;
8214 struct text_pos save_position
= it
->position
;
8215 struct text_pos pos1
;
8216 ptrdiff_t next_stop
;
8218 /* Scan in strict logical order. */
8219 eassert (it
->bidi_p
);
8223 it
->prev_stop
= charpos
;
8226 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8227 reseat_1 (it
, pos1
, false);
8230 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8231 compute_stop_pos (it
);
8232 /* We must advance forward, right? */
8233 if (it
->stop_charpos
<= it
->prev_stop
)
8235 charpos
= it
->stop_charpos
;
8237 while (charpos
<= where_we_are
);
8240 it
->current
= save_current
;
8241 it
->position
= save_position
;
8242 next_stop
= it
->stop_charpos
;
8243 it
->stop_charpos
= it
->prev_stop
;
8245 it
->stop_charpos
= next_stop
;
8248 /* Load IT with the next display element from current_buffer. Value
8249 is false if end of buffer reached. IT->stop_charpos is the next
8250 position at which to stop and check for text properties or buffer
8254 next_element_from_buffer (struct it
*it
)
8256 bool success_p
= true;
8258 eassert (IT_CHARPOS (*it
) >= BEGV
);
8259 eassert (NILP (it
->string
) && !it
->s
);
8260 eassert (!it
->bidi_p
8261 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8262 && it
->bidi_it
.string
.s
== NULL
));
8264 /* With bidi reordering, the character to display might not be the
8265 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8266 we were reseat()ed to a new buffer position, which is potentially
8267 a different paragraph. */
8268 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8270 get_visually_first_element (it
);
8271 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8274 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8276 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8278 bool overlay_strings_follow_p
;
8280 /* End of the game, except when overlay strings follow that
8281 haven't been returned yet. */
8282 if (it
->overlay_strings_at_end_processed_p
)
8283 overlay_strings_follow_p
= false;
8286 it
->overlay_strings_at_end_processed_p
= true;
8287 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8290 if (overlay_strings_follow_p
)
8291 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8295 it
->position
= it
->current
.pos
;
8299 else if (!(!it
->bidi_p
8300 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8301 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8303 /* With bidi non-linear iteration, we could find ourselves
8304 far beyond the last computed stop_charpos, with several
8305 other stop positions in between that we missed. Scan
8306 them all now, in buffer's logical order, until we find
8307 and handle the last stop_charpos that precedes our
8308 current position. */
8309 handle_stop_backwards (it
, it
->stop_charpos
);
8310 it
->ignore_overlay_strings_at_pos_p
= false;
8311 return GET_NEXT_DISPLAY_ELEMENT (it
);
8317 /* Take note of the stop position we just moved across,
8318 for when we will move back across it. */
8319 it
->prev_stop
= it
->stop_charpos
;
8320 /* If we are at base paragraph embedding level, take
8321 note of the last stop position seen at this
8323 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8324 it
->base_level_stop
= it
->stop_charpos
;
8327 it
->ignore_overlay_strings_at_pos_p
= false;
8328 return GET_NEXT_DISPLAY_ELEMENT (it
);
8332 /* If we are before prev_stop, we may have overstepped on
8333 our way backwards a stop_pos, and if so, we need to
8334 handle that stop_pos. */
8335 && IT_CHARPOS (*it
) < it
->prev_stop
8336 /* We can sometimes back up for reasons that have nothing
8337 to do with bidi reordering. E.g., compositions. The
8338 code below is only needed when we are above the base
8339 embedding level, so test for that explicitly. */
8340 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8342 if (it
->base_level_stop
<= 0
8343 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8345 /* If we lost track of base_level_stop, we need to find
8346 prev_stop by looking backwards. This happens, e.g., when
8347 we were reseated to the previous screenful of text by
8349 it
->base_level_stop
= BEGV
;
8350 compute_stop_pos_backwards (it
);
8351 handle_stop_backwards (it
, it
->prev_stop
);
8354 handle_stop_backwards (it
, it
->base_level_stop
);
8355 it
->ignore_overlay_strings_at_pos_p
= false;
8356 return GET_NEXT_DISPLAY_ELEMENT (it
);
8360 /* No face changes, overlays etc. in sight, so just return a
8361 character from current_buffer. */
8365 /* We moved to the next buffer position, so any info about
8366 previously seen overlays is no longer valid. */
8367 it
->ignore_overlay_strings_at_pos_p
= false;
8369 /* Maybe run the redisplay end trigger hook. Performance note:
8370 This doesn't seem to cost measurable time. */
8371 if (it
->redisplay_end_trigger_charpos
8373 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8374 run_redisplay_end_trigger_hook (it
);
8376 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8377 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8379 && next_element_from_composition (it
))
8384 /* Get the next character, maybe multibyte. */
8385 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8386 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8387 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8389 it
->c
= *p
, it
->len
= 1;
8391 /* Record what we have and where it came from. */
8392 it
->what
= IT_CHARACTER
;
8393 it
->object
= it
->w
->contents
;
8394 it
->position
= it
->current
.pos
;
8396 /* Normally we return the character found above, except when we
8397 really want to return an ellipsis for selective display. */
8402 /* A value of selective > 0 means hide lines indented more
8403 than that number of columns. */
8404 if (it
->selective
> 0
8405 && IT_CHARPOS (*it
) + 1 < ZV
8406 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8407 IT_BYTEPOS (*it
) + 1,
8410 success_p
= next_element_from_ellipsis (it
);
8411 it
->dpvec_char_len
= -1;
8414 else if (it
->c
== '\r' && it
->selective
== -1)
8416 /* A value of selective == -1 means that everything from the
8417 CR to the end of the line is invisible, with maybe an
8418 ellipsis displayed for it. */
8419 success_p
= next_element_from_ellipsis (it
);
8420 it
->dpvec_char_len
= -1;
8425 /* Value is false if end of buffer reached. */
8426 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8431 /* Run the redisplay end trigger hook for IT. */
8434 run_redisplay_end_trigger_hook (struct it
*it
)
8436 /* IT->glyph_row should be non-null, i.e. we should be actually
8437 displaying something, or otherwise we should not run the hook. */
8438 eassert (it
->glyph_row
);
8440 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8441 it
->redisplay_end_trigger_charpos
= 0;
8443 /* Since we are *trying* to run these functions, don't try to run
8444 them again, even if they get an error. */
8445 wset_redisplay_end_trigger (it
->w
, Qnil
);
8446 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8447 make_number (charpos
));
8449 /* Notice if it changed the face of the character we are on. */
8450 handle_face_prop (it
);
8454 /* Deliver a composition display element. Unlike the other
8455 next_element_from_XXX, this function is not registered in the array
8456 get_next_element[]. It is called from next_element_from_buffer and
8457 next_element_from_string when necessary. */
8460 next_element_from_composition (struct it
*it
)
8462 it
->what
= IT_COMPOSITION
;
8463 it
->len
= it
->cmp_it
.nbytes
;
8464 if (STRINGP (it
->string
))
8468 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8469 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8472 it
->position
= it
->current
.string_pos
;
8473 it
->object
= it
->string
;
8474 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8475 IT_STRING_BYTEPOS (*it
), it
->string
);
8481 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8482 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8485 if (it
->bidi_it
.new_paragraph
)
8486 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8488 /* Resync the bidi iterator with IT's new position.
8489 FIXME: this doesn't support bidirectional text. */
8490 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8491 bidi_move_to_visually_next (&it
->bidi_it
);
8495 it
->position
= it
->current
.pos
;
8496 it
->object
= it
->w
->contents
;
8497 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8498 IT_BYTEPOS (*it
), Qnil
);
8505 /***********************************************************************
8506 Moving an iterator without producing glyphs
8507 ***********************************************************************/
8509 /* Check if iterator is at a position corresponding to a valid buffer
8510 position after some move_it_ call. */
8512 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8513 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8516 /* Move iterator IT to a specified buffer or X position within one
8517 line on the display without producing glyphs.
8519 OP should be a bit mask including some or all of these bits:
8520 MOVE_TO_X: Stop upon reaching x-position TO_X.
8521 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8522 Regardless of OP's value, stop upon reaching the end of the display line.
8524 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8525 This means, in particular, that TO_X includes window's horizontal
8528 The return value has several possible values that
8529 say what condition caused the scan to stop:
8531 MOVE_POS_MATCH_OR_ZV
8532 - when TO_POS or ZV was reached.
8535 -when TO_X was reached before TO_POS or ZV were reached.
8538 - when we reached the end of the display area and the line must
8542 - when we reached the end of the display area and the line is
8546 - when we stopped at a line end, i.e. a newline or a CR and selective
8549 static enum move_it_result
8550 move_it_in_display_line_to (struct it
*it
,
8551 ptrdiff_t to_charpos
, int to_x
,
8552 enum move_operation_enum op
)
8554 enum move_it_result result
= MOVE_UNDEFINED
;
8555 struct glyph_row
*saved_glyph_row
;
8556 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8557 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8558 void *ppos_data
= NULL
;
8559 bool may_wrap
= false;
8560 enum it_method prev_method
= it
->method
;
8561 ptrdiff_t closest_pos UNINIT
;
8562 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
8563 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8565 /* Don't produce glyphs in produce_glyphs. */
8566 saved_glyph_row
= it
->glyph_row
;
8567 it
->glyph_row
= NULL
;
8569 /* Use wrap_it to save a copy of IT wherever a word wrap could
8570 occur. Use atpos_it to save a copy of IT at the desired buffer
8571 position, if found, so that we can scan ahead and check if the
8572 word later overshoots the window edge. Use atx_it similarly, for
8578 /* Use ppos_it under bidi reordering to save a copy of IT for the
8579 initial position. We restore that position in IT when we have
8580 scanned the entire display line without finding a match for
8581 TO_CHARPOS and all the character positions are greater than
8582 TO_CHARPOS. We then restart the scan from the initial position,
8583 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8584 the closest to TO_CHARPOS. */
8587 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8589 SAVE_IT (ppos_it
, *it
, ppos_data
);
8590 closest_pos
= IT_CHARPOS (*it
);
8596 #define BUFFER_POS_REACHED_P() \
8597 ((op & MOVE_TO_POS) != 0 \
8598 && BUFFERP (it->object) \
8599 && (IT_CHARPOS (*it) == to_charpos \
8601 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8602 && IT_CHARPOS (*it) > to_charpos) \
8603 || (it->what == IT_COMPOSITION \
8604 && ((IT_CHARPOS (*it) > to_charpos \
8605 && to_charpos >= it->cmp_it.charpos) \
8606 || (IT_CHARPOS (*it) < to_charpos \
8607 && to_charpos <= it->cmp_it.charpos)))) \
8608 && (it->method == GET_FROM_BUFFER \
8609 || (it->method == GET_FROM_DISPLAY_VECTOR \
8610 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8612 /* If there's a line-/wrap-prefix, handle it. */
8613 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
)
8614 handle_line_prefix (it
);
8616 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8617 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8621 int x
, i
, ascent
= 0, descent
= 0;
8623 /* Utility macro to reset an iterator with x, ascent, and descent. */
8624 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8625 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8626 (IT)->max_descent = descent)
8628 /* Stop if we move beyond TO_CHARPOS (after an image or a
8629 display string or stretch glyph). */
8630 if ((op
& MOVE_TO_POS
) != 0
8631 && BUFFERP (it
->object
)
8632 && it
->method
== GET_FROM_BUFFER
8634 /* When the iterator is at base embedding level, we
8635 are guaranteed that characters are delivered for
8636 display in strictly increasing order of their
8637 buffer positions. */
8638 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8639 && IT_CHARPOS (*it
) > to_charpos
)
8641 && (prev_method
== GET_FROM_IMAGE
8642 || prev_method
== GET_FROM_STRETCH
8643 || prev_method
== GET_FROM_STRING
)
8644 /* Passed TO_CHARPOS from left to right. */
8645 && ((prev_pos
< to_charpos
8646 && IT_CHARPOS (*it
) > to_charpos
)
8647 /* Passed TO_CHARPOS from right to left. */
8648 || (prev_pos
> to_charpos
8649 && IT_CHARPOS (*it
) < to_charpos
)))))
8651 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8653 result
= MOVE_POS_MATCH_OR_ZV
;
8656 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8657 /* If wrap_it is valid, the current position might be in a
8658 word that is wrapped. So, save the iterator in
8659 atpos_it and continue to see if wrapping happens. */
8660 SAVE_IT (atpos_it
, *it
, atpos_data
);
8663 /* Stop when ZV reached.
8664 We used to stop here when TO_CHARPOS reached as well, but that is
8665 too soon if this glyph does not fit on this line. So we handle it
8666 explicitly below. */
8667 if (!get_next_display_element (it
))
8669 result
= MOVE_POS_MATCH_OR_ZV
;
8673 if (it
->line_wrap
== TRUNCATE
)
8675 if (BUFFER_POS_REACHED_P ())
8677 result
= MOVE_POS_MATCH_OR_ZV
;
8683 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8685 if (IT_DISPLAYING_WHITESPACE (it
))
8689 /* We have reached a glyph that follows one or more
8690 whitespace characters. If the position is
8691 already found, we are done. */
8692 if (atpos_it
.sp
>= 0)
8694 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8695 result
= MOVE_POS_MATCH_OR_ZV
;
8700 RESTORE_IT (it
, &atx_it
, atx_data
);
8701 result
= MOVE_X_REACHED
;
8704 /* Otherwise, we can wrap here. */
8705 SAVE_IT (wrap_it
, *it
, wrap_data
);
8711 /* Remember the line height for the current line, in case
8712 the next element doesn't fit on the line. */
8713 ascent
= it
->max_ascent
;
8714 descent
= it
->max_descent
;
8716 /* The call to produce_glyphs will get the metrics of the
8717 display element IT is loaded with. Record the x-position
8718 before this display element, in case it doesn't fit on the
8722 PRODUCE_GLYPHS (it
);
8724 if (it
->area
!= TEXT_AREA
)
8726 prev_method
= it
->method
;
8727 if (it
->method
== GET_FROM_BUFFER
)
8728 prev_pos
= IT_CHARPOS (*it
);
8729 set_iterator_to_next (it
, true);
8730 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8731 SET_TEXT_POS (this_line_min_pos
,
8732 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8734 && (op
& MOVE_TO_POS
)
8735 && IT_CHARPOS (*it
) > to_charpos
8736 && IT_CHARPOS (*it
) < closest_pos
)
8737 closest_pos
= IT_CHARPOS (*it
);
8741 /* The number of glyphs we get back in IT->nglyphs will normally
8742 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8743 character on a terminal frame, or (iii) a line end. For the
8744 second case, IT->nglyphs - 1 padding glyphs will be present.
8745 (On X frames, there is only one glyph produced for a
8746 composite character.)
8748 The behavior implemented below means, for continuation lines,
8749 that as many spaces of a TAB as fit on the current line are
8750 displayed there. For terminal frames, as many glyphs of a
8751 multi-glyph character are displayed in the current line, too.
8752 This is what the old redisplay code did, and we keep it that
8753 way. Under X, the whole shape of a complex character must
8754 fit on the line or it will be completely displayed in the
8757 Note that both for tabs and padding glyphs, all glyphs have
8761 /* More than one glyph or glyph doesn't fit on line. All
8762 glyphs have the same width. */
8763 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8765 int x_before_this_char
= x
;
8766 int hpos_before_this_char
= it
->hpos
;
8768 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8770 new_x
= x
+ single_glyph_width
;
8772 /* We want to leave anything reaching TO_X to the caller. */
8773 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8775 if (BUFFER_POS_REACHED_P ())
8777 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8778 goto buffer_pos_reached
;
8779 if (atpos_it
.sp
< 0)
8781 SAVE_IT (atpos_it
, *it
, atpos_data
);
8782 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8787 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8790 result
= MOVE_X_REACHED
;
8795 SAVE_IT (atx_it
, *it
, atx_data
);
8796 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8801 if (/* Lines are continued. */
8802 it
->line_wrap
!= TRUNCATE
8803 && (/* And glyph doesn't fit on the line. */
8804 new_x
> it
->last_visible_x
8805 /* Or it fits exactly and we're on a window
8807 || (new_x
== it
->last_visible_x
8808 && FRAME_WINDOW_P (it
->f
)
8809 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8810 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8811 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8813 bool moved_forward
= false;
8815 if (/* IT->hpos == 0 means the very first glyph
8816 doesn't fit on the line, e.g. a wide image. */
8818 || (new_x
== it
->last_visible_x
8819 && FRAME_WINDOW_P (it
->f
)))
8822 it
->current_x
= new_x
;
8824 /* The character's last glyph just barely fits
8826 if (i
== it
->nglyphs
- 1)
8828 /* If this is the destination position,
8829 return a position *before* it in this row,
8830 now that we know it fits in this row. */
8831 if (BUFFER_POS_REACHED_P ())
8833 bool can_wrap
= true;
8835 /* If we are at a whitespace character
8836 that barely fits on this screen line,
8837 but the next character is also
8838 whitespace, we cannot wrap here. */
8839 if (it
->line_wrap
== WORD_WRAP
8842 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8845 void *tem_data
= NULL
;
8847 SAVE_IT (tem_it
, *it
, tem_data
);
8848 set_iterator_to_next (it
, true);
8849 if (get_next_display_element (it
)
8850 && IT_DISPLAYING_WHITESPACE (it
))
8852 RESTORE_IT (it
, &tem_it
, tem_data
);
8854 if (it
->line_wrap
!= WORD_WRAP
8856 /* If we've just found whitespace
8857 where we can wrap, effectively
8858 ignore the previous wrap point --
8859 it is no longer relevant, but we
8860 won't have an opportunity to
8861 update it, since we've reached
8862 the edge of this screen line. */
8863 || (may_wrap
&& can_wrap
8864 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8866 it
->hpos
= hpos_before_this_char
;
8867 it
->current_x
= x_before_this_char
;
8868 result
= MOVE_POS_MATCH_OR_ZV
;
8871 if (it
->line_wrap
== WORD_WRAP
8874 SAVE_IT (atpos_it
, *it
, atpos_data
);
8875 atpos_it
.current_x
= x_before_this_char
;
8876 atpos_it
.hpos
= hpos_before_this_char
;
8880 prev_method
= it
->method
;
8881 if (it
->method
== GET_FROM_BUFFER
)
8882 prev_pos
= IT_CHARPOS (*it
);
8883 set_iterator_to_next (it
, true);
8884 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8885 SET_TEXT_POS (this_line_min_pos
,
8886 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8887 /* On graphical terminals, newlines may
8888 "overflow" into the fringe if
8889 overflow-newline-into-fringe is non-nil.
8890 On text terminals, and on graphical
8891 terminals with no right margin, newlines
8892 may overflow into the last glyph on the
8894 if (!FRAME_WINDOW_P (it
->f
)
8896 && it
->bidi_it
.paragraph_dir
== R2L
)
8897 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8898 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8899 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8901 if (!get_next_display_element (it
))
8903 result
= MOVE_POS_MATCH_OR_ZV
;
8906 moved_forward
= true;
8907 if (BUFFER_POS_REACHED_P ())
8909 if (ITERATOR_AT_END_OF_LINE_P (it
))
8910 result
= MOVE_POS_MATCH_OR_ZV
;
8912 result
= MOVE_LINE_CONTINUED
;
8915 if (ITERATOR_AT_END_OF_LINE_P (it
)
8916 && (it
->line_wrap
!= WORD_WRAP
8918 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8920 result
= MOVE_NEWLINE_OR_CR
;
8927 IT_RESET_X_ASCENT_DESCENT (it
);
8929 /* If the screen line ends with whitespace, and we
8930 are under word-wrap, don't use wrap_it: it is no
8931 longer relevant, but we won't have an opportunity
8932 to update it, since we are done with this screen
8934 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
8935 /* If the character after the one which set the
8936 may_wrap flag is also whitespace, we can't
8937 wrap here, since the screen line cannot be
8938 wrapped in the middle of whitespace.
8939 Therefore, wrap_it _is_ relevant in that
8941 && !(moved_forward
&& IT_DISPLAYING_WHITESPACE (it
)))
8943 /* If we've found TO_X, go back there, as we now
8944 know the last word fits on this screen line. */
8945 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8948 RESTORE_IT (it
, &atx_it
, atx_data
);
8951 result
= MOVE_X_REACHED
;
8955 else if (wrap_it
.sp
>= 0)
8957 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8962 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8964 result
= MOVE_LINE_CONTINUED
;
8968 if (BUFFER_POS_REACHED_P ())
8970 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8971 goto buffer_pos_reached
;
8972 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8974 SAVE_IT (atpos_it
, *it
, atpos_data
);
8975 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8979 if (new_x
> it
->first_visible_x
)
8981 /* Glyph is visible. Increment number of glyphs that
8982 would be displayed. */
8987 if (result
!= MOVE_UNDEFINED
)
8990 else if (BUFFER_POS_REACHED_P ())
8993 IT_RESET_X_ASCENT_DESCENT (it
);
8994 result
= MOVE_POS_MATCH_OR_ZV
;
8997 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8999 /* Stop when TO_X specified and reached. This check is
9000 necessary here because of lines consisting of a line end,
9001 only. The line end will not produce any glyphs and we
9002 would never get MOVE_X_REACHED. */
9003 eassert (it
->nglyphs
== 0);
9004 result
= MOVE_X_REACHED
;
9008 /* Is this a line end? If yes, we're done. */
9009 if (ITERATOR_AT_END_OF_LINE_P (it
))
9011 /* If we are past TO_CHARPOS, but never saw any character
9012 positions smaller than TO_CHARPOS, return
9013 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
9015 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
9017 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
9019 if (closest_pos
< ZV
)
9021 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9022 /* Don't recurse if closest_pos is equal to
9023 to_charpos, since we have just tried that. */
9024 if (closest_pos
!= to_charpos
)
9025 move_it_in_display_line_to (it
, closest_pos
, -1,
9027 result
= MOVE_POS_MATCH_OR_ZV
;
9030 goto buffer_pos_reached
;
9032 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
9033 && IT_CHARPOS (*it
) > to_charpos
)
9034 goto buffer_pos_reached
;
9036 result
= MOVE_NEWLINE_OR_CR
;
9039 result
= MOVE_NEWLINE_OR_CR
;
9040 /* If we've processed the newline, make sure this flag is
9041 reset, as it must only be set when the newline itself is
9043 if (result
== MOVE_NEWLINE_OR_CR
)
9044 it
->constrain_row_ascent_descent_p
= false;
9048 prev_method
= it
->method
;
9049 if (it
->method
== GET_FROM_BUFFER
)
9050 prev_pos
= IT_CHARPOS (*it
);
9051 /* The current display element has been consumed. Advance
9053 set_iterator_to_next (it
, true);
9054 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
9055 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
9056 if (IT_CHARPOS (*it
) < to_charpos
)
9057 saw_smaller_pos
= true;
9059 && (op
& MOVE_TO_POS
)
9060 && IT_CHARPOS (*it
) >= to_charpos
9061 && IT_CHARPOS (*it
) < closest_pos
)
9062 closest_pos
= IT_CHARPOS (*it
);
9064 /* Stop if lines are truncated and IT's current x-position is
9065 past the right edge of the window now. */
9066 if (it
->line_wrap
== TRUNCATE
9067 && it
->current_x
>= it
->last_visible_x
)
9069 if (!FRAME_WINDOW_P (it
->f
)
9070 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
9071 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
9072 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
9073 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
9075 bool at_eob_p
= false;
9077 if ((at_eob_p
= !get_next_display_element (it
))
9078 || BUFFER_POS_REACHED_P ()
9079 /* If we are past TO_CHARPOS, but never saw any
9080 character positions smaller than TO_CHARPOS,
9081 return MOVE_POS_MATCH_OR_ZV, like the
9082 unidirectional display did. */
9083 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9085 && IT_CHARPOS (*it
) > to_charpos
))
9088 && !BUFFER_POS_REACHED_P ()
9089 && !at_eob_p
&& closest_pos
< ZV
)
9091 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9092 if (closest_pos
!= to_charpos
)
9093 move_it_in_display_line_to (it
, closest_pos
, -1,
9096 result
= MOVE_POS_MATCH_OR_ZV
;
9099 if (ITERATOR_AT_END_OF_LINE_P (it
))
9101 result
= MOVE_NEWLINE_OR_CR
;
9105 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9107 && IT_CHARPOS (*it
) > to_charpos
)
9109 if (closest_pos
< ZV
)
9111 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9112 if (closest_pos
!= to_charpos
)
9113 move_it_in_display_line_to (it
, closest_pos
, -1,
9116 result
= MOVE_POS_MATCH_OR_ZV
;
9119 result
= MOVE_LINE_TRUNCATED
;
9122 #undef IT_RESET_X_ASCENT_DESCENT
9125 #undef BUFFER_POS_REACHED_P
9127 /* If we scanned beyond TO_POS, restore the saved iterator either to
9128 the wrap point (if found), or to atpos/atx location. We decide which
9129 data to use to restore the saved iterator state by their X coordinates,
9130 since buffer positions might increase non-monotonically with screen
9131 coordinates due to bidi reordering. */
9132 if (result
== MOVE_LINE_CONTINUED
9133 && it
->line_wrap
== WORD_WRAP
9135 && ((atpos_it
.sp
>= 0 && wrap_it
.current_x
< atpos_it
.current_x
)
9136 || (atx_it
.sp
>= 0 && wrap_it
.current_x
< atx_it
.current_x
)))
9137 RESTORE_IT (it
, &wrap_it
, wrap_data
);
9138 else if (atpos_it
.sp
>= 0)
9139 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9140 else if (atx_it
.sp
>= 0)
9141 RESTORE_IT (it
, &atx_it
, atx_data
);
9146 bidi_unshelve_cache (atpos_data
, true);
9148 bidi_unshelve_cache (atx_data
, true);
9150 bidi_unshelve_cache (wrap_data
, true);
9152 bidi_unshelve_cache (ppos_data
, true);
9154 /* Restore the iterator settings altered at the beginning of this
9156 it
->glyph_row
= saved_glyph_row
;
9160 /* For external use. */
9162 move_it_in_display_line (struct it
*it
,
9163 ptrdiff_t to_charpos
, int to_x
,
9164 enum move_operation_enum op
)
9166 if (it
->line_wrap
== WORD_WRAP
9167 && (op
& MOVE_TO_X
))
9170 void *save_data
= NULL
;
9173 SAVE_IT (save_it
, *it
, save_data
);
9174 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9175 /* When word-wrap is on, TO_X may lie past the end
9176 of a wrapped line. Then it->current is the
9177 character on the next line, so backtrack to the
9178 space before the wrap point. */
9179 if (skip
== MOVE_LINE_CONTINUED
)
9181 int prev_x
= max (it
->current_x
- 1, 0);
9182 RESTORE_IT (it
, &save_it
, save_data
);
9183 move_it_in_display_line_to
9184 (it
, -1, prev_x
, MOVE_TO_X
);
9187 bidi_unshelve_cache (save_data
, true);
9190 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9194 /* Move IT forward until it satisfies one or more of the criteria in
9195 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9197 OP is a bit-mask that specifies where to stop, and in particular,
9198 which of those four position arguments makes a difference. See the
9199 description of enum move_operation_enum.
9201 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9202 screen line, this function will set IT to the next position that is
9203 displayed to the right of TO_CHARPOS on the screen.
9205 Return the maximum pixel length of any line scanned but never more
9206 than it.last_visible_x. */
9209 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9211 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9212 int line_height
, line_start_x
= 0, reached
= 0;
9213 int max_current_x
= 0;
9214 void *backup_data
= NULL
;
9218 if (op
& MOVE_TO_VPOS
)
9220 /* If no TO_CHARPOS and no TO_X specified, stop at the
9221 start of the line TO_VPOS. */
9222 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9224 if (it
->vpos
== to_vpos
)
9230 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9234 /* TO_VPOS >= 0 means stop at TO_X in the line at
9235 TO_VPOS, or at TO_POS, whichever comes first. */
9236 if (it
->vpos
== to_vpos
)
9242 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9244 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9249 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9251 /* We have reached TO_X but not in the line we want. */
9252 skip
= move_it_in_display_line_to (it
, to_charpos
,
9254 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9262 else if (op
& MOVE_TO_Y
)
9264 struct it it_backup
;
9266 if (it
->line_wrap
== WORD_WRAP
)
9267 SAVE_IT (it_backup
, *it
, backup_data
);
9269 /* TO_Y specified means stop at TO_X in the line containing
9270 TO_Y---or at TO_CHARPOS if this is reached first. The
9271 problem is that we can't really tell whether the line
9272 contains TO_Y before we have completely scanned it, and
9273 this may skip past TO_X. What we do is to first scan to
9276 If TO_X is not specified, use a TO_X of zero. The reason
9277 is to make the outcome of this function more predictable.
9278 If we didn't use TO_X == 0, we would stop at the end of
9279 the line which is probably not what a caller would expect
9281 skip
= move_it_in_display_line_to
9282 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9283 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9285 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9286 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9288 else if (skip
== MOVE_X_REACHED
)
9290 /* If TO_X was reached, we want to know whether TO_Y is
9291 in the line. We know this is the case if the already
9292 scanned glyphs make the line tall enough. Otherwise,
9293 we must check by scanning the rest of the line. */
9294 line_height
= it
->max_ascent
+ it
->max_descent
;
9295 if (to_y
>= it
->current_y
9296 && to_y
< it
->current_y
+ line_height
)
9301 SAVE_IT (it_backup
, *it
, backup_data
);
9302 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9303 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9305 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9306 line_height
= it
->max_ascent
+ it
->max_descent
;
9307 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9309 if (to_y
>= it
->current_y
9310 && to_y
< it
->current_y
+ line_height
)
9312 /* If TO_Y is in this line and TO_X was reached
9313 above, we scanned too far. We have to restore
9314 IT's settings to the ones before skipping. But
9315 keep the more accurate values of max_ascent and
9316 max_descent we've found while skipping the rest
9317 of the line, for the sake of callers, such as
9318 pos_visible_p, that need to know the line
9320 int max_ascent
= it
->max_ascent
;
9321 int max_descent
= it
->max_descent
;
9323 RESTORE_IT (it
, &it_backup
, backup_data
);
9324 it
->max_ascent
= max_ascent
;
9325 it
->max_descent
= max_descent
;
9331 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9337 /* Check whether TO_Y is in this line. */
9338 line_height
= it
->max_ascent
+ it
->max_descent
;
9339 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9341 if (to_y
>= it
->current_y
9342 && to_y
< it
->current_y
+ line_height
)
9344 if (to_y
> it
->current_y
)
9345 max_current_x
= max (it
->current_x
, max_current_x
);
9347 /* When word-wrap is on, TO_X may lie past the end
9348 of a wrapped line. Then it->current is the
9349 character on the next line, so backtrack to the
9350 space before the wrap point. */
9351 if (skip
== MOVE_LINE_CONTINUED
9352 && it
->line_wrap
== WORD_WRAP
)
9354 int prev_x
= max (it
->current_x
- 1, 0);
9355 RESTORE_IT (it
, &it_backup
, backup_data
);
9356 skip
= move_it_in_display_line_to
9357 (it
, -1, prev_x
, MOVE_TO_X
);
9366 max_current_x
= max (it
->current_x
, max_current_x
);
9370 else if (BUFFERP (it
->object
)
9371 && (it
->method
== GET_FROM_BUFFER
9372 || it
->method
== GET_FROM_STRETCH
)
9373 && IT_CHARPOS (*it
) >= to_charpos
9374 /* Under bidi iteration, a call to set_iterator_to_next
9375 can scan far beyond to_charpos if the initial
9376 portion of the next line needs to be reordered. In
9377 that case, give move_it_in_display_line_to another
9380 && it
->bidi_it
.scan_dir
== -1))
9381 skip
= MOVE_POS_MATCH_OR_ZV
;
9383 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9387 case MOVE_POS_MATCH_OR_ZV
:
9388 max_current_x
= max (it
->current_x
, max_current_x
);
9392 case MOVE_NEWLINE_OR_CR
:
9393 max_current_x
= max (it
->current_x
, max_current_x
);
9394 set_iterator_to_next (it
, true);
9395 it
->continuation_lines_width
= 0;
9398 case MOVE_LINE_TRUNCATED
:
9399 max_current_x
= it
->last_visible_x
;
9400 it
->continuation_lines_width
= 0;
9401 reseat_at_next_visible_line_start (it
, false);
9402 if ((op
& MOVE_TO_POS
) != 0
9403 && IT_CHARPOS (*it
) > to_charpos
)
9410 case MOVE_LINE_CONTINUED
:
9411 max_current_x
= it
->last_visible_x
;
9412 /* For continued lines ending in a tab, some of the glyphs
9413 associated with the tab are displayed on the current
9414 line. Since it->current_x does not include these glyphs,
9415 we use it->last_visible_x instead. */
9418 it
->continuation_lines_width
+= it
->last_visible_x
;
9419 /* When moving by vpos, ensure that the iterator really
9420 advances to the next line (bug#847, bug#969). Fixme:
9421 do we need to do this in other circumstances? */
9422 if (it
->current_x
!= it
->last_visible_x
9423 && (op
& MOVE_TO_VPOS
)
9424 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9426 line_start_x
= it
->current_x
+ it
->pixel_width
9427 - it
->last_visible_x
;
9428 if (FRAME_WINDOW_P (it
->f
))
9430 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9431 struct font
*face_font
= face
->font
;
9433 /* When display_line produces a continued line
9434 that ends in a TAB, it skips a tab stop that
9435 is closer than the font's space character
9436 width (see x_produce_glyphs where it produces
9437 the stretch glyph which represents a TAB).
9438 We need to reproduce the same logic here. */
9439 eassert (face_font
);
9442 if (line_start_x
< face_font
->space_width
)
9444 += it
->tab_width
* face_font
->space_width
;
9447 set_iterator_to_next (it
, false);
9451 it
->continuation_lines_width
+= it
->current_x
;
9458 /* Reset/increment for the next run. */
9459 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9460 it
->current_x
= line_start_x
;
9463 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9465 last_height
= it
->max_ascent
+ it
->max_descent
;
9466 it
->max_ascent
= it
->max_descent
= 0;
9471 /* On text terminals, we may stop at the end of a line in the middle
9472 of a multi-character glyph. If the glyph itself is continued,
9473 i.e. it is actually displayed on the next line, don't treat this
9474 stopping point as valid; move to the next line instead (unless
9475 that brings us offscreen). */
9476 if (!FRAME_WINDOW_P (it
->f
)
9478 && IT_CHARPOS (*it
) == to_charpos
9479 && it
->what
== IT_CHARACTER
9481 && it
->line_wrap
== WINDOW_WRAP
9482 && it
->current_x
== it
->last_visible_x
- 1
9485 && it
->w
->window_end_valid
9486 && it
->vpos
< it
->w
->window_end_vpos
)
9488 it
->continuation_lines_width
+= it
->current_x
;
9489 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9490 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9492 last_height
= it
->max_ascent
+ it
->max_descent
;
9496 bidi_unshelve_cache (backup_data
, true);
9498 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9500 return max_current_x
;
9504 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9506 If DY > 0, move IT backward at least that many pixels. DY = 0
9507 means move IT backward to the preceding line start or BEGV. This
9508 function may move over more than DY pixels if IT->current_y - DY
9509 ends up in the middle of a line; in this case IT->current_y will be
9510 set to the top of the line moved to. */
9513 move_it_vertically_backward (struct it
*it
, int dy
)
9517 void *it2data
= NULL
, *it3data
= NULL
;
9518 ptrdiff_t start_pos
;
9520 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9521 ptrdiff_t pos_limit
;
9526 start_pos
= IT_CHARPOS (*it
);
9528 /* Estimate how many newlines we must move back. */
9529 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9530 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9533 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9535 /* Set the iterator's position that many lines back. But don't go
9536 back more than NLINES full screen lines -- this wins a day with
9537 buffers which have very long lines. */
9538 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9539 back_to_previous_visible_line_start (it
);
9541 /* Reseat the iterator here. When moving backward, we don't want
9542 reseat to skip forward over invisible text, set up the iterator
9543 to deliver from overlay strings at the new position etc. So,
9544 use reseat_1 here. */
9545 reseat_1 (it
, it
->current
.pos
, true);
9547 /* We are now surely at a line start. */
9548 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9549 reordering is in effect. */
9550 it
->continuation_lines_width
= 0;
9552 /* Move forward and see what y-distance we moved. First move to the
9553 start of the next line so that we get its height. We need this
9554 height to be able to tell whether we reached the specified
9556 SAVE_IT (it2
, *it
, it2data
);
9557 it2
.max_ascent
= it2
.max_descent
= 0;
9560 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9561 MOVE_TO_POS
| MOVE_TO_VPOS
);
9563 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9564 /* If we are in a display string which starts at START_POS,
9565 and that display string includes a newline, and we are
9566 right after that newline (i.e. at the beginning of a
9567 display line), exit the loop, because otherwise we will
9568 infloop, since move_it_to will see that it is already at
9569 START_POS and will not move. */
9570 || (it2
.method
== GET_FROM_STRING
9571 && IT_CHARPOS (it2
) == start_pos
9572 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9573 eassert (IT_CHARPOS (*it
) >= BEGV
);
9574 SAVE_IT (it3
, it2
, it3data
);
9576 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9577 eassert (IT_CHARPOS (*it
) >= BEGV
);
9578 /* H is the actual vertical distance from the position in *IT
9579 and the starting position. */
9580 h
= it2
.current_y
- it
->current_y
;
9581 /* NLINES is the distance in number of lines. */
9582 nlines
= it2
.vpos
- it
->vpos
;
9584 /* Correct IT's y and vpos position
9585 so that they are relative to the starting point. */
9591 /* DY == 0 means move to the start of the screen line. The
9592 value of nlines is > 0 if continuation lines were involved,
9593 or if the original IT position was at start of a line. */
9594 RESTORE_IT (it
, it
, it2data
);
9596 move_it_by_lines (it
, nlines
);
9597 /* The above code moves us to some position NLINES down,
9598 usually to its first glyph (leftmost in an L2R line), but
9599 that's not necessarily the start of the line, under bidi
9600 reordering. We want to get to the character position
9601 that is immediately after the newline of the previous
9604 && !it
->continuation_lines_width
9605 && !STRINGP (it
->string
)
9606 && IT_CHARPOS (*it
) > BEGV
9607 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9609 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9612 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9613 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9615 bidi_unshelve_cache (it3data
, true);
9619 /* The y-position we try to reach, relative to *IT.
9620 Note that H has been subtracted in front of the if-statement. */
9621 int target_y
= it
->current_y
+ h
- dy
;
9622 int y0
= it3
.current_y
;
9626 RESTORE_IT (&it3
, &it3
, it3data
);
9627 y1
= line_bottom_y (&it3
);
9628 line_height
= y1
- y0
;
9629 RESTORE_IT (it
, it
, it2data
);
9630 /* If we did not reach target_y, try to move further backward if
9631 we can. If we moved too far backward, try to move forward. */
9632 if (target_y
< it
->current_y
9633 /* This is heuristic. In a window that's 3 lines high, with
9634 a line height of 13 pixels each, recentering with point
9635 on the bottom line will try to move -39/2 = 19 pixels
9636 backward. Try to avoid moving into the first line. */
9637 && (it
->current_y
- target_y
9638 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9639 && IT_CHARPOS (*it
) > BEGV
)
9641 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9642 target_y
- it
->current_y
));
9643 dy
= it
->current_y
- target_y
;
9644 goto move_further_back
;
9646 else if (target_y
>= it
->current_y
+ line_height
9647 && IT_CHARPOS (*it
) < ZV
)
9649 /* Should move forward by at least one line, maybe more.
9651 Note: Calling move_it_by_lines can be expensive on
9652 terminal frames, where compute_motion is used (via
9653 vmotion) to do the job, when there are very long lines
9654 and truncate-lines is nil. That's the reason for
9655 treating terminal frames specially here. */
9657 if (!FRAME_WINDOW_P (it
->f
))
9658 move_it_vertically (it
, target_y
- it
->current_y
);
9663 move_it_by_lines (it
, 1);
9665 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9672 /* Move IT by a specified amount of pixel lines DY. DY negative means
9673 move backwards. DY = 0 means move to start of screen line. At the
9674 end, IT will be on the start of a screen line. */
9677 move_it_vertically (struct it
*it
, int dy
)
9680 move_it_vertically_backward (it
, -dy
);
9683 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9684 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9685 MOVE_TO_POS
| MOVE_TO_Y
);
9686 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9688 /* If buffer ends in ZV without a newline, move to the start of
9689 the line to satisfy the post-condition. */
9690 if (IT_CHARPOS (*it
) == ZV
9692 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9693 move_it_by_lines (it
, 0);
9698 /* Move iterator IT past the end of the text line it is in. */
9701 move_it_past_eol (struct it
*it
)
9703 enum move_it_result rc
;
9705 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9706 if (rc
== MOVE_NEWLINE_OR_CR
)
9707 set_iterator_to_next (it
, false);
9711 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9712 negative means move up. DVPOS == 0 means move to the start of the
9715 Optimization idea: If we would know that IT->f doesn't use
9716 a face with proportional font, we could be faster for
9717 truncate-lines nil. */
9720 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9723 /* The commented-out optimization uses vmotion on terminals. This
9724 gives bad results, because elements like it->what, on which
9725 callers such as pos_visible_p rely, aren't updated. */
9726 /* struct position pos;
9727 if (!FRAME_WINDOW_P (it->f))
9729 struct text_pos textpos;
9731 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9732 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9733 reseat (it, textpos, true);
9734 it->vpos += pos.vpos;
9735 it->current_y += pos.vpos;
9741 /* DVPOS == 0 means move to the start of the screen line. */
9742 move_it_vertically_backward (it
, 0);
9743 /* Let next call to line_bottom_y calculate real line height. */
9748 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9749 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9751 /* Only move to the next buffer position if we ended up in a
9752 string from display property, not in an overlay string
9753 (before-string or after-string). That is because the
9754 latter don't conceal the underlying buffer position, so
9755 we can ask to move the iterator to the exact position we
9756 are interested in. Note that, even if we are already at
9757 IT_CHARPOS (*it), the call below is not a no-op, as it
9758 will detect that we are at the end of the string, pop the
9759 iterator, and compute it->current_x and it->hpos
9761 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9762 -1, -1, -1, MOVE_TO_POS
);
9768 void *it2data
= NULL
;
9769 ptrdiff_t start_charpos
, i
;
9771 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9772 bool hit_pos_limit
= false;
9773 ptrdiff_t pos_limit
;
9775 /* Start at the beginning of the screen line containing IT's
9776 position. This may actually move vertically backwards,
9777 in case of overlays, so adjust dvpos accordingly. */
9779 move_it_vertically_backward (it
, 0);
9782 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9783 screen lines, and reseat the iterator there. */
9784 start_charpos
= IT_CHARPOS (*it
);
9785 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9788 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9790 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9791 back_to_previous_visible_line_start (it
);
9792 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9793 hit_pos_limit
= true;
9794 reseat (it
, it
->current
.pos
, true);
9796 /* Move further back if we end up in a string or an image. */
9797 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9799 /* First try to move to start of display line. */
9801 move_it_vertically_backward (it
, 0);
9803 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9805 /* If start of line is still in string or image,
9806 move further back. */
9807 back_to_previous_visible_line_start (it
);
9808 reseat (it
, it
->current
.pos
, true);
9812 it
->current_x
= it
->hpos
= 0;
9814 /* Above call may have moved too far if continuation lines
9815 are involved. Scan forward and see if it did. */
9816 SAVE_IT (it2
, *it
, it2data
);
9817 it2
.vpos
= it2
.current_y
= 0;
9818 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9819 it
->vpos
-= it2
.vpos
;
9820 it
->current_y
-= it2
.current_y
;
9821 it
->current_x
= it
->hpos
= 0;
9823 /* If we moved too far back, move IT some lines forward. */
9824 if (it2
.vpos
> -dvpos
)
9826 int delta
= it2
.vpos
+ dvpos
;
9828 RESTORE_IT (&it2
, &it2
, it2data
);
9829 SAVE_IT (it2
, *it
, it2data
);
9830 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9831 /* Move back again if we got too far ahead. */
9832 if (IT_CHARPOS (*it
) >= start_charpos
)
9833 RESTORE_IT (it
, &it2
, it2data
);
9835 bidi_unshelve_cache (it2data
, true);
9837 else if (hit_pos_limit
&& pos_limit
> BEGV
9838 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9840 /* If we hit the limit, but still didn't make it far enough
9841 back, that means there's a display string with a newline
9842 covering a large chunk of text, and that caused
9843 back_to_previous_visible_line_start try to go too far.
9844 Punish those who commit such atrocities by going back
9845 until we've reached DVPOS, after lifting the limit, which
9846 could make it slow for very long lines. "If it hurts,
9849 RESTORE_IT (it
, it
, it2data
);
9850 for (i
= -dvpos
; i
> 0; --i
)
9852 back_to_previous_visible_line_start (it
);
9855 reseat_1 (it
, it
->current
.pos
, true);
9858 RESTORE_IT (it
, it
, it2data
);
9863 partial_line_height (struct it
*it_origin
)
9866 void *it_data
= NULL
;
9868 SAVE_IT (it
, *it_origin
, it_data
);
9869 move_it_to (&it
, ZV
, -1, it
.last_visible_y
, -1,
9870 MOVE_TO_POS
| MOVE_TO_Y
);
9871 if (it
.what
== IT_EOB
)
9873 int vis_height
= it
.last_visible_y
- it
.current_y
;
9874 int height
= it
.ascent
+ it
.descent
;
9875 partial_height
= (vis_height
< height
) ? vis_height
: 0;
9879 int last_line_y
= it
.current_y
;
9880 move_it_by_lines (&it
, 1);
9881 partial_height
= (it
.current_y
> it
.last_visible_y
)
9882 ? it
.last_visible_y
- last_line_y
: 0;
9884 RESTORE_IT (&it
, &it
, it_data
);
9885 return partial_height
;
9888 /* Return true if IT points into the middle of a display vector. */
9891 in_display_vector_p (struct it
*it
)
9893 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9894 && it
->current
.dpvec_index
> 0
9895 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9898 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9899 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9900 WINDOW must be a live window and defaults to the selected one. The
9901 return value is a cons of the maximum pixel-width of any text line and
9902 the maximum pixel-height of all text lines.
9904 The optional argument FROM, if non-nil, specifies the first text
9905 position and defaults to the minimum accessible position of the buffer.
9906 If FROM is t, use the minimum accessible position that starts a
9907 non-empty line. TO, if non-nil, specifies the last text position and
9908 defaults to the maximum accessible position of the buffer. If TO is t,
9909 use the maximum accessible position that ends a non-empty line.
9911 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9912 width that can be returned. X-LIMIT nil or omitted, means to use the
9913 pixel-width of WINDOW's body; use this if you want to know how high
9914 WINDOW should be become in order to fit all of its buffer's text with
9915 the width of WINDOW unaltered. Use the maximum width WINDOW may assume
9916 if you intend to change WINDOW's width. In any case, text whose
9917 x-coordinate is beyond X-LIMIT is ignored. Since calculating the width
9918 of long lines can take some time, it's always a good idea to make this
9919 argument as small as possible; in particular, if the buffer contains
9920 long lines that shall be truncated anyway.
9922 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9923 height (excluding the height of the mode- or header-line, if any) that
9924 can be returned. Text lines whose y-coordinate is beyond Y-LIMIT are
9925 ignored. Since calculating the text height of a large buffer can take
9926 some time, it makes sense to specify this argument if the size of the
9927 buffer is large or unknown.
9929 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9930 include the height of the mode- or header-line of WINDOW in the return
9931 value. If it is either the symbol `mode-line' or `header-line', include
9932 only the height of that line, if present, in the return value. If t,
9933 include the height of both, if present, in the return value. */)
9934 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9935 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9937 struct window
*w
= decode_live_window (window
);
9938 Lisp_Object buffer
= w
->contents
;
9941 struct buffer
*old_b
= NULL
;
9942 ptrdiff_t start
, end
, pos
;
9943 struct text_pos startp
;
9944 void *itdata
= NULL
;
9945 int c
, max_x
= 0, max_y
= 0, x
= 0, y
= 0;
9947 CHECK_BUFFER (buffer
);
9948 b
= XBUFFER (buffer
);
9950 if (b
!= current_buffer
)
9952 old_b
= current_buffer
;
9953 set_buffer_internal (b
);
9958 else if (EQ (from
, Qt
))
9961 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9962 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9964 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9969 CHECK_NUMBER_COERCE_MARKER (from
);
9970 start
= min (max (XINT (from
), BEGV
), ZV
);
9975 else if (EQ (to
, Qt
))
9978 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9979 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9981 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9986 CHECK_NUMBER_COERCE_MARKER (to
);
9987 end
= max (start
, min (XINT (to
), ZV
));
9990 if (!NILP (x_limit
) && RANGED_INTEGERP (0, x_limit
, INT_MAX
))
9991 max_x
= XINT (x_limit
);
9995 else if (RANGED_INTEGERP (0, y_limit
, INT_MAX
))
9996 max_y
= XINT (y_limit
);
9998 itdata
= bidi_shelve_cache ();
9999 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
10000 start_display (&it
, w
, startp
);
10002 if (NILP (x_limit
))
10003 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
10006 it
.last_visible_x
= max_x
;
10007 /* Actually, we never want move_it_to stop at to_x. But to make
10008 sure that move_it_in_display_line_to always moves far enough,
10009 we set it to INT_MAX and specify MOVE_TO_X. */
10010 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
10011 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
10012 /* Don't return more than X-LIMIT. */
10017 /* Subtract height of header-line which was counted automatically by
10019 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
10020 - WINDOW_HEADER_LINE_HEIGHT (w
);
10021 /* Don't return more than Y-LIMIT. */
10025 if (EQ (mode_and_header_line
, Qheader_line
)
10026 || EQ (mode_and_header_line
, Qt
))
10027 /* Re-add height of header-line as requested. */
10028 y
= y
+ WINDOW_HEADER_LINE_HEIGHT (w
);
10030 if (EQ (mode_and_header_line
, Qmode_line
)
10031 || EQ (mode_and_header_line
, Qt
))
10032 /* Add height of mode-line as requested. */
10033 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
10035 bidi_unshelve_cache (itdata
, false);
10038 set_buffer_internal (old_b
);
10040 return Fcons (make_number (x
), make_number (y
));
10043 /***********************************************************************
10045 ***********************************************************************/
10047 /* Return the number of arguments the format string FORMAT needs. */
10050 format_nargs (char const *format
)
10052 ptrdiff_t nargs
= 0;
10053 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
10061 /* Add a message with format string FORMAT and formatted arguments
10065 add_to_log (const char *format
, ...)
10068 va_start (ap
, format
);
10069 vadd_to_log (format
, ap
);
10074 vadd_to_log (char const *format
, va_list ap
)
10076 ptrdiff_t form_nargs
= format_nargs (format
);
10077 ptrdiff_t nargs
= 1 + form_nargs
;
10078 Lisp_Object args
[10];
10079 eassert (nargs
<= ARRAYELTS (args
));
10080 AUTO_STRING (args0
, format
);
10082 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
10083 args
[i
] = va_arg (ap
, Lisp_Object
);
10084 Lisp_Object msg
= Qnil
;
10085 msg
= Fformat_message (nargs
, args
);
10087 ptrdiff_t len
= SBYTES (msg
) + 1;
10089 char *buffer
= SAFE_ALLOCA (len
);
10090 memcpy (buffer
, SDATA (msg
), len
);
10092 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
10097 /* Output a newline in the *Messages* buffer if "needs" one. */
10100 message_log_maybe_newline (void)
10102 if (message_log_need_newline
)
10103 message_dolog ("", 0, true, false);
10107 /* Add a string M of length NBYTES to the message log, optionally
10108 terminated with a newline when NLFLAG is true. MULTIBYTE, if
10109 true, means interpret the contents of M as multibyte. This
10110 function calls low-level routines in order to bypass text property
10111 hooks, etc. which might not be safe to run.
10113 This may GC (insert may run before/after change hooks),
10114 so the buffer M must NOT point to a Lisp string. */
10117 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
10119 const unsigned char *msg
= (const unsigned char *) m
;
10121 if (!NILP (Vmemory_full
))
10124 if (!NILP (Vmessage_log_max
))
10126 struct buffer
*oldbuf
;
10127 Lisp_Object oldpoint
, oldbegv
, oldzv
;
10128 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
10129 ptrdiff_t point_at_end
= 0;
10130 ptrdiff_t zv_at_end
= 0;
10131 Lisp_Object old_deactivate_mark
;
10133 old_deactivate_mark
= Vdeactivate_mark
;
10134 oldbuf
= current_buffer
;
10136 /* Ensure the Messages buffer exists, and switch to it.
10137 If we created it, set the major-mode. */
10138 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
10139 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
10141 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
10142 call0 (intern ("messages-buffer-mode"));
10144 bset_undo_list (current_buffer
, Qt
);
10145 bset_cache_long_scans (current_buffer
, Qnil
);
10147 oldpoint
= message_dolog_marker1
;
10148 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10149 oldbegv
= message_dolog_marker2
;
10150 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10151 oldzv
= message_dolog_marker3
;
10152 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10160 BEGV_BYTE
= BEG_BYTE
;
10163 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10165 /* Insert the string--maybe converting multibyte to single byte
10166 or vice versa, so that all the text fits the buffer. */
10168 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10174 /* Convert a multibyte string to single-byte
10175 for the *Message* buffer. */
10176 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10178 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10179 work
[0] = CHAR_TO_BYTE8 (c
);
10180 insert_1_both (work
, 1, 1, true, false, false);
10183 else if (! multibyte
10184 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10188 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10189 /* Convert a single-byte string to multibyte
10190 for the *Message* buffer. */
10191 for (i
= 0; i
< nbytes
; i
++)
10194 MAKE_CHAR_MULTIBYTE (c
);
10195 char_bytes
= CHAR_STRING (c
, str
);
10196 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10200 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10201 true, false, false);
10205 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10208 insert_1_both ("\n", 1, 1, true, false, false);
10210 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10212 this_bol_byte
= PT_BYTE
;
10214 /* See if this line duplicates the previous one.
10215 If so, combine duplicates. */
10216 if (this_bol
> BEG
)
10218 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10220 prev_bol_byte
= PT_BYTE
;
10222 dups
= message_log_check_duplicate (prev_bol_byte
,
10226 del_range_both (prev_bol
, prev_bol_byte
,
10227 this_bol
, this_bol_byte
, false);
10230 char dupstr
[sizeof " [ times]"
10231 + INT_STRLEN_BOUND (printmax_t
)];
10233 /* If you change this format, don't forget to also
10234 change message_log_check_duplicate. */
10235 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10236 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10237 insert_1_both (dupstr
, duplen
, duplen
,
10238 true, false, true);
10243 /* If we have more than the desired maximum number of lines
10244 in the *Messages* buffer now, delete the oldest ones.
10245 This is safe because we don't have undo in this buffer. */
10247 if (NATNUMP (Vmessage_log_max
))
10249 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10250 -XFASTINT (Vmessage_log_max
) - 1, false);
10251 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10254 BEGV
= marker_position (oldbegv
);
10255 BEGV_BYTE
= marker_byte_position (oldbegv
);
10264 ZV
= marker_position (oldzv
);
10265 ZV_BYTE
= marker_byte_position (oldzv
);
10269 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10271 /* We can't do Fgoto_char (oldpoint) because it will run some
10273 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10274 marker_byte_position (oldpoint
));
10276 unchain_marker (XMARKER (oldpoint
));
10277 unchain_marker (XMARKER (oldbegv
));
10278 unchain_marker (XMARKER (oldzv
));
10280 /* We called insert_1_both above with its 5th argument (PREPARE)
10281 false, which prevents insert_1_both from calling
10282 prepare_to_modify_buffer, which in turns prevents us from
10283 incrementing windows_or_buffers_changed even if *Messages* is
10284 shown in some window. So we must manually set
10285 windows_or_buffers_changed here to make up for that. */
10286 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10287 bset_redisplay (current_buffer
);
10289 set_buffer_internal (oldbuf
);
10291 message_log_need_newline
= !nlflag
;
10292 Vdeactivate_mark
= old_deactivate_mark
;
10297 /* We are at the end of the buffer after just having inserted a newline.
10298 (Note: We depend on the fact we won't be crossing the gap.)
10299 Check to see if the most recent message looks a lot like the previous one.
10300 Return 0 if different, 1 if the new one should just replace it, or a
10301 value N > 1 if we should also append " [N times]". */
10304 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10307 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10308 bool seen_dots
= false;
10309 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10310 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10312 for (i
= 0; i
< len
; i
++)
10314 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10316 if (p1
[i
] != p2
[i
])
10322 if (*p1
++ == ' ' && *p1
++ == '[')
10325 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10326 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10333 /* Display an echo area message M with a specified length of NBYTES
10334 bytes. The string may include null characters. If M is not a
10335 string, clear out any existing message, and let the mini-buffer
10338 This function cancels echoing. */
10341 message3 (Lisp_Object m
)
10343 clear_message (true, true);
10346 /* First flush out any partial line written with print. */
10347 message_log_maybe_newline ();
10350 ptrdiff_t nbytes
= SBYTES (m
);
10351 bool multibyte
= STRING_MULTIBYTE (m
);
10354 SAFE_ALLOCA_STRING (buffer
, m
);
10355 message_dolog (buffer
, nbytes
, true, multibyte
);
10358 if (! inhibit_message
)
10359 message3_nolog (m
);
10362 /* Log the message M to stderr. Log an empty line if M is not a string. */
10365 message_to_stderr (Lisp_Object m
)
10367 if (noninteractive_need_newline
)
10369 noninteractive_need_newline
= false;
10370 fputc ('\n', stderr
);
10374 Lisp_Object coding_system
= Vlocale_coding_system
;
10377 if (!NILP (Vcoding_system_for_write
))
10378 coding_system
= Vcoding_system_for_write
;
10379 if (!NILP (coding_system
))
10380 s
= code_convert_string_norecord (m
, coding_system
, true);
10384 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10386 if (!cursor_in_echo_area
)
10387 fputc ('\n', stderr
);
10391 /* The non-logging version of message3.
10392 This does not cancel echoing, because it is used for echoing.
10393 Perhaps we need to make a separate function for echoing
10394 and make this cancel echoing. */
10397 message3_nolog (Lisp_Object m
)
10399 struct frame
*sf
= SELECTED_FRAME ();
10401 if (FRAME_INITIAL_P (sf
))
10402 message_to_stderr (m
);
10403 /* Error messages get reported properly by cmd_error, so this must be just an
10404 informative message; if the frame hasn't really been initialized yet, just
10406 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10408 /* Get the frame containing the mini-buffer
10409 that the selected frame is using. */
10410 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10411 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10412 struct frame
*f
= XFRAME (frame
);
10414 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10415 Fmake_frame_visible (frame
);
10417 if (STRINGP (m
) && SCHARS (m
) > 0)
10420 if (minibuffer_auto_raise
)
10421 Fraise_frame (frame
);
10422 /* Assume we are not echoing.
10423 (If we are, echo_now will override this.) */
10424 echo_message_buffer
= Qnil
;
10427 clear_message (true, true);
10429 do_pending_window_change (false);
10430 echo_area_display (true);
10431 do_pending_window_change (false);
10432 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10433 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10438 /* Display a null-terminated echo area message M. If M is 0, clear
10439 out any existing message, and let the mini-buffer text show through.
10441 The buffer M must continue to exist until after the echo area gets
10442 cleared or some other message gets displayed there. Do not pass
10443 text that is stored in a Lisp string. Do not pass text in a buffer
10444 that was alloca'd. */
10447 message1 (const char *m
)
10449 message3 (m
? build_unibyte_string (m
) : Qnil
);
10453 /* The non-logging counterpart of message1. */
10456 message1_nolog (const char *m
)
10458 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10461 /* Display a message M which contains a single %s
10462 which gets replaced with STRING. */
10465 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10467 CHECK_STRING (string
);
10470 if (noninteractive
)
10471 need_message
= !!m
;
10472 else if (!INTERACTIVE
)
10473 need_message
= false;
10476 /* The frame whose minibuffer we're going to display the message on.
10477 It may be larger than the selected frame, so we need
10478 to use its buffer, not the selected frame's buffer. */
10479 Lisp_Object mini_window
;
10480 struct frame
*f
, *sf
= SELECTED_FRAME ();
10482 /* Get the frame containing the minibuffer
10483 that the selected frame is using. */
10484 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10485 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10487 /* Error messages get reported properly by cmd_error, so this must be
10488 just an informative message; if the frame hasn't really been
10489 initialized yet, just toss it. */
10490 need_message
= f
->glyphs_initialized_p
;
10495 AUTO_STRING (fmt
, m
);
10496 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10498 if (noninteractive
)
10499 message_to_stderr (msg
);
10505 message3_nolog (msg
);
10507 /* Print should start at the beginning of the message
10508 buffer next time. */
10509 message_buf_print
= false;
10515 /* Dump an informative message to the minibuf. If M is 0, clear out
10516 any existing message, and let the mini-buffer text show through.
10518 The message must be safe ASCII and the format must not contain ` or
10519 '. If your message and format do not fit into this category,
10520 convert your arguments to Lisp objects and use Fmessage instead. */
10522 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10523 vmessage (const char *m
, va_list ap
)
10525 if (noninteractive
)
10529 if (noninteractive_need_newline
)
10530 putc ('\n', stderr
);
10531 noninteractive_need_newline
= false;
10532 vfprintf (stderr
, m
, ap
);
10533 if (!cursor_in_echo_area
)
10534 fprintf (stderr
, "\n");
10538 else if (INTERACTIVE
)
10540 /* The frame whose mini-buffer we're going to display the message
10541 on. It may be larger than the selected frame, so we need to
10542 use its buffer, not the selected frame's buffer. */
10543 Lisp_Object mini_window
;
10544 struct frame
*f
, *sf
= SELECTED_FRAME ();
10546 /* Get the frame containing the mini-buffer
10547 that the selected frame is using. */
10548 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10549 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10551 /* Error messages get reported properly by cmd_error, so this must be
10552 just an informative message; if the frame hasn't really been
10553 initialized yet, just toss it. */
10554 if (f
->glyphs_initialized_p
)
10559 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10561 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10563 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10565 message3 (make_string (message_buf
, len
));
10571 /* Print should start at the beginning of the message
10572 buffer next time. */
10573 message_buf_print
= false;
10579 message (const char *m
, ...)
10588 /* Display the current message in the current mini-buffer. This is
10589 only called from error handlers in process.c, and is not time
10593 update_echo_area (void)
10595 if (!NILP (echo_area_buffer
[0]))
10597 Lisp_Object string
;
10598 string
= Fcurrent_message ();
10604 /* Make sure echo area buffers in `echo_buffers' are live.
10605 If they aren't, make new ones. */
10608 ensure_echo_area_buffers (void)
10610 for (int i
= 0; i
< 2; i
++)
10611 if (!BUFFERP (echo_buffer
[i
])
10612 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10614 Lisp_Object old_buffer
= echo_buffer
[i
];
10615 static char const name_fmt
[] = " *Echo Area %d*";
10616 char name
[sizeof name_fmt
+ INT_STRLEN_BOUND (int)];
10617 AUTO_STRING_WITH_LEN (lname
, name
, sprintf (name
, name_fmt
, i
));
10618 echo_buffer
[i
] = Fget_buffer_create (lname
);
10619 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10620 /* to force word wrap in echo area -
10621 it was decided to postpone this*/
10622 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10624 for (int j
= 0; j
< 2; j
++)
10625 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10626 echo_area_buffer
[j
] = echo_buffer
[i
];
10631 /* Call FN with args A1..A2 with either the current or last displayed
10632 echo_area_buffer as current buffer.
10634 WHICH zero means use the current message buffer
10635 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10636 from echo_buffer[] and clear it.
10638 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10639 suitable buffer from echo_buffer[] and clear it.
10641 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10642 that the current message becomes the last displayed one, choose a
10643 suitable buffer for echo_area_buffer[0], and clear it.
10645 Value is what FN returns. */
10648 with_echo_area_buffer (struct window
*w
, int which
,
10649 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10650 ptrdiff_t a1
, Lisp_Object a2
)
10652 Lisp_Object buffer
;
10653 bool this_one
, the_other
, clear_buffer_p
, rc
;
10654 ptrdiff_t count
= SPECPDL_INDEX ();
10656 /* If buffers aren't live, make new ones. */
10657 ensure_echo_area_buffers ();
10659 clear_buffer_p
= false;
10662 this_one
= false, the_other
= true;
10663 else if (which
> 0)
10664 this_one
= true, the_other
= false;
10667 this_one
= false, the_other
= true;
10668 clear_buffer_p
= true;
10670 /* We need a fresh one in case the current echo buffer equals
10671 the one containing the last displayed echo area message. */
10672 if (!NILP (echo_area_buffer
[this_one
])
10673 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10674 echo_area_buffer
[this_one
] = Qnil
;
10677 /* Choose a suitable buffer from echo_buffer[] if we don't
10679 if (NILP (echo_area_buffer
[this_one
]))
10681 echo_area_buffer
[this_one
]
10682 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10683 ? echo_buffer
[the_other
]
10684 : echo_buffer
[this_one
]);
10685 clear_buffer_p
= true;
10688 buffer
= echo_area_buffer
[this_one
];
10690 /* Don't get confused by reusing the buffer used for echoing
10691 for a different purpose. */
10692 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10695 record_unwind_protect (unwind_with_echo_area_buffer
,
10696 with_echo_area_buffer_unwind_data (w
));
10698 /* Make the echo area buffer current. Note that for display
10699 purposes, it is not necessary that the displayed window's buffer
10700 == current_buffer, except for text property lookup. So, let's
10701 only set that buffer temporarily here without doing a full
10702 Fset_window_buffer. We must also change w->pointm, though,
10703 because otherwise an assertions in unshow_buffer fails, and Emacs
10705 set_buffer_internal_1 (XBUFFER (buffer
));
10708 wset_buffer (w
, buffer
);
10709 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10710 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10713 bset_undo_list (current_buffer
, Qt
);
10714 bset_read_only (current_buffer
, Qnil
);
10715 specbind (Qinhibit_read_only
, Qt
);
10716 specbind (Qinhibit_modification_hooks
, Qt
);
10718 if (clear_buffer_p
&& Z
> BEG
)
10719 del_range (BEG
, Z
);
10721 eassert (BEGV
>= BEG
);
10722 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10726 eassert (BEGV
>= BEG
);
10727 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10729 unbind_to (count
, Qnil
);
10734 /* Save state that should be preserved around the call to the function
10735 FN called in with_echo_area_buffer. */
10738 with_echo_area_buffer_unwind_data (struct window
*w
)
10741 Lisp_Object vector
, tmp
;
10743 /* Reduce consing by keeping one vector in
10744 Vwith_echo_area_save_vector. */
10745 vector
= Vwith_echo_area_save_vector
;
10746 Vwith_echo_area_save_vector
= Qnil
;
10749 vector
= Fmake_vector (make_number (11), Qnil
);
10751 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10752 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10753 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10757 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10758 ASET (vector
, i
, w
->contents
); ++i
;
10759 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10760 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10761 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10762 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10763 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10764 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10769 for (; i
< end
; ++i
)
10770 ASET (vector
, i
, Qnil
);
10773 eassert (i
== ASIZE (vector
));
10778 /* Restore global state from VECTOR which was created by
10779 with_echo_area_buffer_unwind_data. */
10782 unwind_with_echo_area_buffer (Lisp_Object vector
)
10784 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10785 Vdeactivate_mark
= AREF (vector
, 1);
10786 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10788 if (WINDOWP (AREF (vector
, 3)))
10791 Lisp_Object buffer
;
10793 w
= XWINDOW (AREF (vector
, 3));
10794 buffer
= AREF (vector
, 4);
10796 wset_buffer (w
, buffer
);
10797 set_marker_both (w
->pointm
, buffer
,
10798 XFASTINT (AREF (vector
, 5)),
10799 XFASTINT (AREF (vector
, 6)));
10800 set_marker_both (w
->old_pointm
, buffer
,
10801 XFASTINT (AREF (vector
, 7)),
10802 XFASTINT (AREF (vector
, 8)));
10803 set_marker_both (w
->start
, buffer
,
10804 XFASTINT (AREF (vector
, 9)),
10805 XFASTINT (AREF (vector
, 10)));
10808 Vwith_echo_area_save_vector
= vector
;
10812 /* Set up the echo area for use by print functions. MULTIBYTE_P
10813 means we will print multibyte. */
10816 setup_echo_area_for_printing (bool multibyte_p
)
10818 /* If we can't find an echo area any more, exit. */
10819 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10820 Fkill_emacs (Qnil
);
10822 ensure_echo_area_buffers ();
10824 if (!message_buf_print
)
10826 /* A message has been output since the last time we printed.
10827 Choose a fresh echo area buffer. */
10828 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10829 echo_area_buffer
[0] = echo_buffer
[1];
10831 echo_area_buffer
[0] = echo_buffer
[0];
10833 /* Switch to that buffer and clear it. */
10834 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10835 bset_truncate_lines (current_buffer
, Qnil
);
10839 ptrdiff_t count
= SPECPDL_INDEX ();
10840 specbind (Qinhibit_read_only
, Qt
);
10841 /* Note that undo recording is always disabled. */
10842 del_range (BEG
, Z
);
10843 unbind_to (count
, Qnil
);
10845 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10847 /* Set up the buffer for the multibyteness we need. */
10849 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10850 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10852 /* Raise the frame containing the echo area. */
10853 if (minibuffer_auto_raise
)
10855 struct frame
*sf
= SELECTED_FRAME ();
10856 Lisp_Object mini_window
;
10857 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10858 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10861 message_log_maybe_newline ();
10862 message_buf_print
= true;
10866 if (NILP (echo_area_buffer
[0]))
10868 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10869 echo_area_buffer
[0] = echo_buffer
[1];
10871 echo_area_buffer
[0] = echo_buffer
[0];
10874 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10876 /* Someone switched buffers between print requests. */
10877 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10878 bset_truncate_lines (current_buffer
, Qnil
);
10884 /* Display an echo area message in window W. Value is true if W's
10885 height is changed. If display_last_displayed_message_p,
10886 display the message that was last displayed, otherwise
10887 display the current message. */
10890 display_echo_area (struct window
*w
)
10892 bool no_message_p
, window_height_changed_p
;
10894 /* Temporarily disable garbage collections while displaying the echo
10895 area. This is done because a GC can print a message itself.
10896 That message would modify the echo area buffer's contents while a
10897 redisplay of the buffer is going on, and seriously confuse
10899 ptrdiff_t count
= inhibit_garbage_collection ();
10901 /* If there is no message, we must call display_echo_area_1
10902 nevertheless because it resizes the window. But we will have to
10903 reset the echo_area_buffer in question to nil at the end because
10904 with_echo_area_buffer will sets it to an empty buffer. */
10905 bool i
= display_last_displayed_message_p
;
10906 /* According to the C99, C11 and C++11 standards, the integral value
10907 of a "bool" is always 0 or 1, so this array access is safe here,
10909 no_message_p
= NILP (echo_area_buffer
[i
]);
10911 window_height_changed_p
10912 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10913 display_echo_area_1
,
10914 (intptr_t) w
, Qnil
);
10917 echo_area_buffer
[i
] = Qnil
;
10919 unbind_to (count
, Qnil
);
10920 return window_height_changed_p
;
10924 /* Helper for display_echo_area. Display the current buffer which
10925 contains the current echo area message in window W, a mini-window,
10926 a pointer to which is passed in A1. A2..A4 are currently not used.
10927 Change the height of W so that all of the message is displayed.
10928 Value is true if height of W was changed. */
10931 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10934 struct window
*w
= (struct window
*) i1
;
10935 Lisp_Object window
;
10936 struct text_pos start
;
10938 /* We are about to enter redisplay without going through
10939 redisplay_internal, so we need to forget these faces by hand
10941 forget_escape_and_glyphless_faces ();
10943 /* Do this before displaying, so that we have a large enough glyph
10944 matrix for the display. If we can't get enough space for the
10945 whole text, display the last N lines. That works by setting w->start. */
10946 bool window_height_changed_p
= resize_mini_window (w
, false);
10948 /* Use the starting position chosen by resize_mini_window. */
10949 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10952 clear_glyph_matrix (w
->desired_matrix
);
10953 XSETWINDOW (window
, w
);
10954 try_window (window
, start
, 0);
10956 return window_height_changed_p
;
10960 /* Resize the echo area window to exactly the size needed for the
10961 currently displayed message, if there is one. If a mini-buffer
10962 is active, don't shrink it. */
10965 resize_echo_area_exactly (void)
10967 if (BUFFERP (echo_area_buffer
[0])
10968 && WINDOWP (echo_area_window
))
10970 struct window
*w
= XWINDOW (echo_area_window
);
10971 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10972 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10973 (intptr_t) w
, resize_exactly
);
10976 windows_or_buffers_changed
= 42;
10977 update_mode_lines
= 30;
10978 redisplay_internal ();
10984 /* Callback function for with_echo_area_buffer, when used from
10985 resize_echo_area_exactly. A1 contains a pointer to the window to
10986 resize, EXACTLY non-nil means resize the mini-window exactly to the
10987 size of the text displayed. A3 and A4 are not used. Value is what
10988 resize_mini_window returns. */
10991 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10994 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10998 /* Resize mini-window W to fit the size of its contents. EXACT_P
10999 means size the window exactly to the size needed. Otherwise, it's
11000 only enlarged until W's buffer is empty.
11002 Set W->start to the right place to begin display. If the whole
11003 contents fit, start at the beginning. Otherwise, start so as
11004 to make the end of the contents appear. This is particularly
11005 important for y-or-n-p, but seems desirable generally.
11007 Value is true if the window height has been changed. */
11010 resize_mini_window (struct window
*w
, bool exact_p
)
11012 struct frame
*f
= XFRAME (w
->frame
);
11013 bool window_height_changed_p
= false;
11015 eassert (MINI_WINDOW_P (w
));
11017 /* By default, start display at the beginning. */
11018 set_marker_both (w
->start
, w
->contents
,
11019 BUF_BEGV (XBUFFER (w
->contents
)),
11020 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
11022 /* Don't resize windows while redisplaying a window; it would
11023 confuse redisplay functions when the size of the window they are
11024 displaying changes from under them. Such a resizing can happen,
11025 for instance, when which-func prints a long message while
11026 we are running fontification-functions. We're running these
11027 functions with safe_call which binds inhibit-redisplay to t. */
11028 if (!NILP (Vinhibit_redisplay
))
11031 /* Nil means don't try to resize. */
11032 if (NILP (Vresize_mini_windows
)
11033 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
11036 if (!FRAME_MINIBUF_ONLY_P (f
))
11039 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
11040 + WINDOW_PIXEL_HEIGHT (w
));
11041 int unit
= FRAME_LINE_HEIGHT (f
);
11042 int height
, max_height
;
11043 struct text_pos start
;
11044 struct buffer
*old_current_buffer
= NULL
;
11046 if (current_buffer
!= XBUFFER (w
->contents
))
11048 old_current_buffer
= current_buffer
;
11049 set_buffer_internal (XBUFFER (w
->contents
));
11052 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
11054 /* Compute the max. number of lines specified by the user. */
11055 if (FLOATP (Vmax_mini_window_height
))
11056 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
11057 else if (INTEGERP (Vmax_mini_window_height
))
11058 max_height
= XINT (Vmax_mini_window_height
) * unit
;
11060 max_height
= total_height
/ 4;
11062 /* Correct that max. height if it's bogus. */
11063 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
11065 /* Find out the height of the text in the window. */
11066 if (it
.line_wrap
== TRUNCATE
)
11071 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
11072 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
11073 height
= it
.current_y
+ last_height
;
11075 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
11076 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
11079 /* Compute a suitable window start. */
11080 if (height
> max_height
)
11082 height
= (max_height
/ unit
) * unit
;
11083 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
11084 move_it_vertically_backward (&it
, height
- unit
);
11085 start
= it
.current
.pos
;
11088 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
11089 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
11091 if (EQ (Vresize_mini_windows
, Qgrow_only
))
11093 /* Let it grow only, until we display an empty message, in which
11094 case the window shrinks again. */
11095 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11097 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11099 FRAME_WINDOWS_FROZEN (f
) = true;
11100 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11101 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11103 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
11104 && (exact_p
|| BEGV
== ZV
))
11106 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11108 FRAME_WINDOWS_FROZEN (f
) = false;
11109 shrink_mini_window (w
, true);
11110 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11115 /* Always resize to exact size needed. */
11116 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11118 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11120 FRAME_WINDOWS_FROZEN (f
) = true;
11121 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11122 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11124 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
11126 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11128 FRAME_WINDOWS_FROZEN (f
) = false;
11129 shrink_mini_window (w
, true);
11133 FRAME_WINDOWS_FROZEN (f
) = true;
11134 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11137 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11141 if (old_current_buffer
)
11142 set_buffer_internal (old_current_buffer
);
11145 return window_height_changed_p
;
11149 /* Value is the current message, a string, or nil if there is no
11150 current message. */
11153 current_message (void)
11157 if (!BUFFERP (echo_area_buffer
[0]))
11161 with_echo_area_buffer (0, 0, current_message_1
,
11162 (intptr_t) &msg
, Qnil
);
11164 echo_area_buffer
[0] = Qnil
;
11172 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11175 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11178 *msg
= make_buffer_string (BEG
, Z
, true);
11185 /* Push the current message on Vmessage_stack for later restoration
11186 by restore_message. Value is true if the current message isn't
11187 empty. This is a relatively infrequent operation, so it's not
11188 worth optimizing. */
11191 push_message (void)
11193 Lisp_Object msg
= current_message ();
11194 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11195 return STRINGP (msg
);
11199 /* Restore message display from the top of Vmessage_stack. */
11202 restore_message (void)
11204 eassert (CONSP (Vmessage_stack
));
11205 message3_nolog (XCAR (Vmessage_stack
));
11209 /* Handler for unwind-protect calling pop_message. */
11212 pop_message_unwind (void)
11214 /* Pop the top-most entry off Vmessage_stack. */
11215 eassert (CONSP (Vmessage_stack
));
11216 Vmessage_stack
= XCDR (Vmessage_stack
);
11220 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11221 exits. If the stack is not empty, we have a missing pop_message
11225 check_message_stack (void)
11227 if (!NILP (Vmessage_stack
))
11232 /* Truncate to NCHARS what will be displayed in the echo area the next
11233 time we display it---but don't redisplay it now. */
11236 truncate_echo_area (ptrdiff_t nchars
)
11239 echo_area_buffer
[0] = Qnil
;
11240 else if (!noninteractive
11242 && !NILP (echo_area_buffer
[0]))
11244 struct frame
*sf
= SELECTED_FRAME ();
11245 /* Error messages get reported properly by cmd_error, so this must be
11246 just an informative message; if the frame hasn't really been
11247 initialized yet, just toss it. */
11248 if (sf
->glyphs_initialized_p
)
11249 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11254 /* Helper function for truncate_echo_area. Truncate the current
11255 message to at most NCHARS characters. */
11258 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11260 if (BEG
+ nchars
< Z
)
11261 del_range (BEG
+ nchars
, Z
);
11263 echo_area_buffer
[0] = Qnil
;
11267 /* Set the current message to STRING. */
11270 set_message (Lisp_Object string
)
11272 eassert (STRINGP (string
));
11274 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11276 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11277 message_buf_print
= false;
11278 help_echo_showing_p
= false;
11280 if (STRINGP (Vdebug_on_message
)
11281 && STRINGP (string
)
11282 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11283 call_debugger (list2 (Qerror
, string
));
11287 /* Helper function for set_message. First argument is ignored and second
11288 argument has the same meaning as for set_message.
11289 This function is called with the echo area buffer being current. */
11292 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11294 eassert (STRINGP (string
));
11296 /* Change multibyteness of the echo buffer appropriately. */
11297 if (message_enable_multibyte
11298 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11299 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11301 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11302 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11303 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11305 /* Insert new message at BEG. */
11306 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11308 /* This function takes care of single/multibyte conversion.
11309 We just have to ensure that the echo area buffer has the right
11310 setting of enable_multibyte_characters. */
11311 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11317 /* Clear messages. CURRENT_P means clear the current message.
11318 LAST_DISPLAYED_P means clear the message last displayed. */
11321 clear_message (bool current_p
, bool last_displayed_p
)
11325 echo_area_buffer
[0] = Qnil
;
11326 message_cleared_p
= true;
11329 if (last_displayed_p
)
11330 echo_area_buffer
[1] = Qnil
;
11332 message_buf_print
= false;
11335 /* Clear garbaged frames.
11337 This function is used where the old redisplay called
11338 redraw_garbaged_frames which in turn called redraw_frame which in
11339 turn called clear_frame. The call to clear_frame was a source of
11340 flickering. I believe a clear_frame is not necessary. It should
11341 suffice in the new redisplay to invalidate all current matrices,
11342 and ensure a complete redisplay of all windows. */
11345 clear_garbaged_frames (void)
11347 if (frame_garbaged
)
11349 Lisp_Object tail
, frame
;
11350 struct frame
*sf
= SELECTED_FRAME ();
11352 FOR_EACH_FRAME (tail
, frame
)
11354 struct frame
*f
= XFRAME (frame
);
11356 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11359 /* It makes no sense to redraw a non-selected TTY
11360 frame, since that will actually clear the
11361 selected frame, and might leave the selected
11362 frame with corrupted display, if it happens not
11363 to be marked garbaged. */
11364 && !(f
!= sf
&& (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))))
11367 clear_current_matrices (f
);
11368 fset_redisplay (f
);
11369 f
->garbaged
= false;
11370 f
->resized_p
= false;
11374 frame_garbaged
= false;
11379 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11383 echo_area_display (bool update_frame_p
)
11385 Lisp_Object mini_window
;
11388 bool window_height_changed_p
= false;
11389 struct frame
*sf
= SELECTED_FRAME ();
11391 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11392 w
= XWINDOW (mini_window
);
11393 f
= XFRAME (WINDOW_FRAME (w
));
11395 /* Don't display if frame is invisible or not yet initialized. */
11396 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11399 #ifdef HAVE_WINDOW_SYSTEM
11400 /* When Emacs starts, selected_frame may be the initial terminal
11401 frame. If we let this through, a message would be displayed on
11403 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11405 #endif /* HAVE_WINDOW_SYSTEM */
11407 /* Redraw garbaged frames. */
11408 clear_garbaged_frames ();
11410 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11412 echo_area_window
= mini_window
;
11413 window_height_changed_p
= display_echo_area (w
);
11414 w
->must_be_updated_p
= true;
11416 /* Update the display, unless called from redisplay_internal.
11417 Also don't update the screen during redisplay itself. The
11418 update will happen at the end of redisplay, and an update
11419 here could cause confusion. */
11420 if (update_frame_p
&& !redisplaying_p
)
11424 /* If the display update has been interrupted by pending
11425 input, update mode lines in the frame. Due to the
11426 pending input, it might have been that redisplay hasn't
11427 been called, so that mode lines above the echo area are
11428 garbaged. This looks odd, so we prevent it here. */
11429 if (!display_completed
)
11430 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11432 if (window_height_changed_p
11433 /* Don't do this if Emacs is shutting down. Redisplay
11434 needs to run hooks. */
11435 && !NILP (Vrun_hooks
))
11437 /* Must update other windows. Likewise as in other
11438 cases, don't let this update be interrupted by
11440 ptrdiff_t count
= SPECPDL_INDEX ();
11441 specbind (Qredisplay_dont_pause
, Qt
);
11442 fset_redisplay (f
);
11443 redisplay_internal ();
11444 unbind_to (count
, Qnil
);
11446 else if (FRAME_WINDOW_P (f
) && n
== 0)
11448 /* Window configuration is the same as before.
11449 Can do with a display update of the echo area,
11450 unless we displayed some mode lines. */
11451 update_single_window (w
);
11455 update_frame (f
, true, true);
11457 /* If cursor is in the echo area, make sure that the next
11458 redisplay displays the minibuffer, so that the cursor will
11459 be replaced with what the minibuffer wants. */
11460 if (cursor_in_echo_area
)
11461 wset_redisplay (XWINDOW (mini_window
));
11464 else if (!EQ (mini_window
, selected_window
))
11465 wset_redisplay (XWINDOW (mini_window
));
11467 /* Last displayed message is now the current message. */
11468 echo_area_buffer
[1] = echo_area_buffer
[0];
11469 /* Inform read_char that we're not echoing. */
11470 echo_message_buffer
= Qnil
;
11472 /* Prevent redisplay optimization in redisplay_internal by resetting
11473 this_line_start_pos. This is done because the mini-buffer now
11474 displays the message instead of its buffer text. */
11475 if (EQ (mini_window
, selected_window
))
11476 CHARPOS (this_line_start_pos
) = 0;
11478 if (window_height_changed_p
)
11480 fset_redisplay (f
);
11482 /* If window configuration was changed, frames may have been
11483 marked garbaged. Clear them or we will experience
11484 surprises wrt scrolling.
11485 FIXME: How/why/when? */
11486 clear_garbaged_frames ();
11490 /* True if W's buffer was changed but not saved. */
11493 window_buffer_changed (struct window
*w
)
11495 struct buffer
*b
= XBUFFER (w
->contents
);
11497 eassert (BUFFER_LIVE_P (b
));
11499 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11502 /* True if W has %c in its mode line and mode line should be updated. */
11505 mode_line_update_needed (struct window
*w
)
11507 return (w
->column_number_displayed
!= -1
11508 && !(PT
== w
->last_point
&& !window_outdated (w
))
11509 && (w
->column_number_displayed
!= current_column ()));
11512 /* True if window start of W is frozen and may not be changed during
11516 window_frozen_p (struct window
*w
)
11518 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11520 Lisp_Object window
;
11522 XSETWINDOW (window
, w
);
11523 if (MINI_WINDOW_P (w
))
11525 else if (EQ (window
, selected_window
))
11527 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11528 && EQ (window
, Vminibuf_scroll_window
))
11529 /* This special window can't be frozen too. */
11537 /***********************************************************************
11538 Mode Lines and Frame Titles
11539 ***********************************************************************/
11541 /* A buffer for constructing non-propertized mode-line strings and
11542 frame titles in it; allocated from the heap in init_xdisp and
11543 resized as needed in store_mode_line_noprop_char. */
11545 static char *mode_line_noprop_buf
;
11547 /* The buffer's end, and a current output position in it. */
11549 static char *mode_line_noprop_buf_end
;
11550 static char *mode_line_noprop_ptr
;
11552 #define MODE_LINE_NOPROP_LEN(start) \
11553 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11556 MODE_LINE_DISPLAY
= 0,
11560 } mode_line_target
;
11562 /* Alist that caches the results of :propertize.
11563 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11564 static Lisp_Object mode_line_proptrans_alist
;
11566 /* List of strings making up the mode-line. */
11567 static Lisp_Object mode_line_string_list
;
11569 /* Base face property when building propertized mode line string. */
11570 static Lisp_Object mode_line_string_face
;
11571 static Lisp_Object mode_line_string_face_prop
;
11574 /* Unwind data for mode line strings */
11576 static Lisp_Object Vmode_line_unwind_vector
;
11579 format_mode_line_unwind_data (struct frame
*target_frame
,
11580 struct buffer
*obuf
,
11582 bool save_proptrans
)
11584 Lisp_Object vector
, tmp
;
11586 /* Reduce consing by keeping one vector in
11587 Vwith_echo_area_save_vector. */
11588 vector
= Vmode_line_unwind_vector
;
11589 Vmode_line_unwind_vector
= Qnil
;
11592 vector
= Fmake_vector (make_number (10), Qnil
);
11594 ASET (vector
, 0, make_number (mode_line_target
));
11595 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11596 ASET (vector
, 2, mode_line_string_list
);
11597 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11598 ASET (vector
, 4, mode_line_string_face
);
11599 ASET (vector
, 5, mode_line_string_face_prop
);
11602 XSETBUFFER (tmp
, obuf
);
11605 ASET (vector
, 6, tmp
);
11606 ASET (vector
, 7, owin
);
11609 /* Similarly to `with-selected-window', if the operation selects
11610 a window on another frame, we must restore that frame's
11611 selected window, and (for a tty) the top-frame. */
11612 ASET (vector
, 8, target_frame
->selected_window
);
11613 if (FRAME_TERMCAP_P (target_frame
))
11614 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11621 unwind_format_mode_line (Lisp_Object vector
)
11623 Lisp_Object old_window
= AREF (vector
, 7);
11624 Lisp_Object target_frame_window
= AREF (vector
, 8);
11625 Lisp_Object old_top_frame
= AREF (vector
, 9);
11627 mode_line_target
= XINT (AREF (vector
, 0));
11628 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11629 mode_line_string_list
= AREF (vector
, 2);
11630 if (! EQ (AREF (vector
, 3), Qt
))
11631 mode_line_proptrans_alist
= AREF (vector
, 3);
11632 mode_line_string_face
= AREF (vector
, 4);
11633 mode_line_string_face_prop
= AREF (vector
, 5);
11635 /* Select window before buffer, since it may change the buffer. */
11636 if (!NILP (old_window
))
11638 /* If the operation that we are unwinding had selected a window
11639 on a different frame, reset its frame-selected-window. For a
11640 text terminal, reset its top-frame if necessary. */
11641 if (!NILP (target_frame_window
))
11644 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11646 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11647 Fselect_window (target_frame_window
, Qt
);
11649 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11650 Fselect_frame (old_top_frame
, Qt
);
11653 Fselect_window (old_window
, Qt
);
11656 if (!NILP (AREF (vector
, 6)))
11658 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11659 ASET (vector
, 6, Qnil
);
11662 Vmode_line_unwind_vector
= vector
;
11666 /* Store a single character C for the frame title in mode_line_noprop_buf.
11667 Re-allocate mode_line_noprop_buf if necessary. */
11670 store_mode_line_noprop_char (char c
)
11672 /* If output position has reached the end of the allocated buffer,
11673 increase the buffer's size. */
11674 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11676 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11677 ptrdiff_t size
= len
;
11678 mode_line_noprop_buf
=
11679 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11680 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11681 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11684 *mode_line_noprop_ptr
++ = c
;
11688 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11689 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11690 characters that yield more columns than PRECISION; PRECISION <= 0
11691 means copy the whole string. Pad with spaces until FIELD_WIDTH
11692 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11693 pad. Called from display_mode_element when it is used to build a
11697 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11699 const unsigned char *str
= (const unsigned char *) string
;
11701 ptrdiff_t dummy
, nbytes
;
11703 /* Copy at most PRECISION chars from STR. */
11704 nbytes
= strlen (string
);
11705 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11707 store_mode_line_noprop_char (*str
++);
11709 /* Fill up with spaces until FIELD_WIDTH reached. */
11710 while (field_width
> 0
11711 && n
< field_width
)
11713 store_mode_line_noprop_char (' ');
11720 /***********************************************************************
11722 ***********************************************************************/
11724 #ifdef HAVE_WINDOW_SYSTEM
11726 /* Set the title of FRAME, if it has changed. The title format is
11727 Vicon_title_format if FRAME is iconified, otherwise it is
11728 frame_title_format. */
11731 x_consider_frame_title (Lisp_Object frame
)
11733 struct frame
*f
= XFRAME (frame
);
11735 if ((FRAME_WINDOW_P (f
)
11736 || FRAME_MINIBUF_ONLY_P (f
)
11737 || f
->explicit_name
)
11738 && NILP (Fframe_parameter (frame
, Qtooltip
)))
11740 /* Do we have more than one visible frame on this X display? */
11741 Lisp_Object tail
, other_frame
, fmt
;
11742 ptrdiff_t title_start
;
11746 ptrdiff_t count
= SPECPDL_INDEX ();
11748 FOR_EACH_FRAME (tail
, other_frame
)
11750 struct frame
*tf
= XFRAME (other_frame
);
11753 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11754 && !FRAME_MINIBUF_ONLY_P (tf
)
11755 && !EQ (other_frame
, tip_frame
)
11756 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11760 /* Set global variable indicating that multiple frames exist. */
11761 multiple_frames
= CONSP (tail
);
11763 /* Switch to the buffer of selected window of the frame. Set up
11764 mode_line_target so that display_mode_element will output into
11765 mode_line_noprop_buf; then display the title. */
11766 record_unwind_protect (unwind_format_mode_line
,
11767 format_mode_line_unwind_data
11768 (f
, current_buffer
, selected_window
, false));
11769 /* select-frame calls resize_mini_window, which could resize the
11770 mini-window and by that undo the effect of this redisplay
11771 cycle wrt minibuffer and echo-area display. Binding
11772 inhibit-redisplay to t makes the call to resize_mini_window a
11773 no-op, thus avoiding the adverse side effects. */
11774 specbind (Qinhibit_redisplay
, Qt
);
11776 Fselect_window (f
->selected_window
, Qt
);
11777 set_buffer_internal_1
11778 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11779 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11781 mode_line_target
= MODE_LINE_TITLE
;
11782 title_start
= MODE_LINE_NOPROP_LEN (0);
11783 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11784 NULL
, DEFAULT_FACE_ID
);
11785 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11786 len
= MODE_LINE_NOPROP_LEN (title_start
);
11787 title
= mode_line_noprop_buf
+ title_start
;
11788 unbind_to (count
, Qnil
);
11790 /* Set the title only if it's changed. This avoids consing in
11791 the common case where it hasn't. (If it turns out that we've
11792 already wasted too much time by walking through the list with
11793 display_mode_element, then we might need to optimize at a
11794 higher level than this.) */
11795 if (! STRINGP (f
->name
)
11796 || SBYTES (f
->name
) != len
11797 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11798 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11802 #endif /* not HAVE_WINDOW_SYSTEM */
11805 /***********************************************************************
11807 ***********************************************************************/
11809 /* True if we will not redisplay all visible windows. */
11810 #define REDISPLAY_SOME_P() \
11811 ((windows_or_buffers_changed == 0 \
11812 || windows_or_buffers_changed == REDISPLAY_SOME) \
11813 && (update_mode_lines == 0 \
11814 || update_mode_lines == REDISPLAY_SOME))
11816 /* Prepare for redisplay by updating menu-bar item lists when
11817 appropriate. This can call eval. */
11820 prepare_menu_bars (void)
11822 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11823 bool some_windows
= REDISPLAY_SOME_P ();
11824 Lisp_Object tooltip_frame
;
11826 #ifdef HAVE_WINDOW_SYSTEM
11827 tooltip_frame
= tip_frame
;
11829 tooltip_frame
= Qnil
;
11832 if (FUNCTIONP (Vpre_redisplay_function
))
11834 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11835 if (all_windows
&& some_windows
)
11837 Lisp_Object ws
= window_list ();
11838 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11840 Lisp_Object
this = XCAR (ws
);
11841 struct window
*w
= XWINDOW (this);
11843 || XFRAME (w
->frame
)->redisplay
11844 || XBUFFER (w
->contents
)->text
->redisplay
)
11846 windows
= Fcons (this, windows
);
11850 safe__call1 (true, Vpre_redisplay_function
, windows
);
11853 /* Update all frame titles based on their buffer names, etc. We do
11854 this before the menu bars so that the buffer-menu will show the
11855 up-to-date frame titles. */
11856 #ifdef HAVE_WINDOW_SYSTEM
11859 Lisp_Object tail
, frame
;
11861 FOR_EACH_FRAME (tail
, frame
)
11863 struct frame
*f
= XFRAME (frame
);
11864 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11868 && !XBUFFER (w
->contents
)->text
->redisplay
)
11871 if (!EQ (frame
, tooltip_frame
)
11872 && (FRAME_ICONIFIED_P (f
)
11873 || FRAME_VISIBLE_P (f
) == 1
11874 /* Exclude TTY frames that are obscured because they
11875 are not the top frame on their console. This is
11876 because x_consider_frame_title actually switches
11877 to the frame, which for TTY frames means it is
11878 marked as garbaged, and will be completely
11879 redrawn on the next redisplay cycle. This causes
11880 TTY frames to be completely redrawn, when there
11881 are more than one of them, even though nothing
11882 should be changed on display. */
11883 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11884 x_consider_frame_title (frame
);
11887 #endif /* HAVE_WINDOW_SYSTEM */
11889 /* Update the menu bar item lists, if appropriate. This has to be
11890 done before any actual redisplay or generation of display lines. */
11894 Lisp_Object tail
, frame
;
11895 ptrdiff_t count
= SPECPDL_INDEX ();
11896 /* True means that update_menu_bar has run its hooks
11897 so any further calls to update_menu_bar shouldn't do so again. */
11898 bool menu_bar_hooks_run
= false;
11900 record_unwind_save_match_data ();
11902 FOR_EACH_FRAME (tail
, frame
)
11904 struct frame
*f
= XFRAME (frame
);
11905 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11907 /* Ignore tooltip frame. */
11908 if (EQ (frame
, tooltip_frame
))
11914 && !XBUFFER (w
->contents
)->text
->redisplay
)
11917 run_window_size_change_functions (frame
);
11918 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11919 #ifdef HAVE_WINDOW_SYSTEM
11920 update_tool_bar (f
, false);
11924 unbind_to (count
, Qnil
);
11928 struct frame
*sf
= SELECTED_FRAME ();
11929 update_menu_bar (sf
, true, false);
11930 #ifdef HAVE_WINDOW_SYSTEM
11931 update_tool_bar (sf
, true);
11937 /* Update the menu bar item list for frame F. This has to be done
11938 before we start to fill in any display lines, because it can call
11941 If SAVE_MATCH_DATA, we must save and restore it here.
11943 If HOOKS_RUN, a previous call to update_menu_bar
11944 already ran the menu bar hooks for this redisplay, so there
11945 is no need to run them again. The return value is the
11946 updated value of this flag, to pass to the next call. */
11949 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11951 Lisp_Object window
;
11954 /* If called recursively during a menu update, do nothing. This can
11955 happen when, for instance, an activate-menubar-hook causes a
11957 if (inhibit_menubar_update
)
11960 window
= FRAME_SELECTED_WINDOW (f
);
11961 w
= XWINDOW (window
);
11963 if (FRAME_WINDOW_P (f
)
11965 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11966 || defined (HAVE_NS) || defined (USE_GTK)
11967 FRAME_EXTERNAL_MENU_BAR (f
)
11969 FRAME_MENU_BAR_LINES (f
) > 0
11971 : FRAME_MENU_BAR_LINES (f
) > 0)
11973 /* If the user has switched buffers or windows, we need to
11974 recompute to reflect the new bindings. But we'll
11975 recompute when update_mode_lines is set too; that means
11976 that people can use force-mode-line-update to request
11977 that the menu bar be recomputed. The adverse effect on
11978 the rest of the redisplay algorithm is about the same as
11979 windows_or_buffers_changed anyway. */
11980 if (windows_or_buffers_changed
11981 /* This used to test w->update_mode_line, but we believe
11982 there is no need to recompute the menu in that case. */
11983 || update_mode_lines
11984 || window_buffer_changed (w
))
11986 struct buffer
*prev
= current_buffer
;
11987 ptrdiff_t count
= SPECPDL_INDEX ();
11989 specbind (Qinhibit_menubar_update
, Qt
);
11991 set_buffer_internal_1 (XBUFFER (w
->contents
));
11992 if (save_match_data
)
11993 record_unwind_save_match_data ();
11994 if (NILP (Voverriding_local_map_menu_flag
))
11996 specbind (Qoverriding_terminal_local_map
, Qnil
);
11997 specbind (Qoverriding_local_map
, Qnil
);
12002 /* Run the Lucid hook. */
12003 safe_run_hooks (Qactivate_menubar_hook
);
12005 /* If it has changed current-menubar from previous value,
12006 really recompute the menu-bar from the value. */
12007 if (! NILP (Vlucid_menu_bar_dirty_flag
))
12008 call0 (Qrecompute_lucid_menubar
);
12010 safe_run_hooks (Qmenu_bar_update_hook
);
12015 XSETFRAME (Vmenu_updating_frame
, f
);
12016 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
12018 /* Redisplay the menu bar in case we changed it. */
12019 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
12020 || defined (HAVE_NS) || defined (USE_GTK)
12021 if (FRAME_WINDOW_P (f
))
12023 #if defined (HAVE_NS)
12024 /* All frames on Mac OS share the same menubar. So only
12025 the selected frame should be allowed to set it. */
12026 if (f
== SELECTED_FRAME ())
12028 set_frame_menubar (f
, false, false);
12031 /* On a terminal screen, the menu bar is an ordinary screen
12032 line, and this makes it get updated. */
12033 w
->update_mode_line
= true;
12034 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
12035 /* In the non-toolkit version, the menu bar is an ordinary screen
12036 line, and this makes it get updated. */
12037 w
->update_mode_line
= true;
12038 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
12040 unbind_to (count
, Qnil
);
12041 set_buffer_internal_1 (prev
);
12048 /***********************************************************************
12050 ***********************************************************************/
12052 #ifdef HAVE_WINDOW_SYSTEM
12054 /* Select `frame' temporarily without running all the code in
12056 FIXME: Maybe do_switch_frame should be trimmed down similarly
12057 when `norecord' is set. */
12059 fast_set_selected_frame (Lisp_Object frame
)
12061 if (!EQ (selected_frame
, frame
))
12063 selected_frame
= frame
;
12064 selected_window
= XFRAME (frame
)->selected_window
;
12068 /* Update the tool-bar item list for frame F. This has to be done
12069 before we start to fill in any display lines. Called from
12070 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
12071 and restore it here. */
12074 update_tool_bar (struct frame
*f
, bool save_match_data
)
12076 #if defined (USE_GTK) || defined (HAVE_NS)
12077 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
12079 bool do_update
= (WINDOWP (f
->tool_bar_window
)
12080 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
12085 Lisp_Object window
;
12088 window
= FRAME_SELECTED_WINDOW (f
);
12089 w
= XWINDOW (window
);
12091 /* If the user has switched buffers or windows, we need to
12092 recompute to reflect the new bindings. But we'll
12093 recompute when update_mode_lines is set too; that means
12094 that people can use force-mode-line-update to request
12095 that the menu bar be recomputed. The adverse effect on
12096 the rest of the redisplay algorithm is about the same as
12097 windows_or_buffers_changed anyway. */
12098 if (windows_or_buffers_changed
12099 || w
->update_mode_line
12100 || update_mode_lines
12101 || window_buffer_changed (w
))
12103 struct buffer
*prev
= current_buffer
;
12104 ptrdiff_t count
= SPECPDL_INDEX ();
12105 Lisp_Object frame
, new_tool_bar
;
12106 int new_n_tool_bar
;
12108 /* Set current_buffer to the buffer of the selected
12109 window of the frame, so that we get the right local
12111 set_buffer_internal_1 (XBUFFER (w
->contents
));
12113 /* Save match data, if we must. */
12114 if (save_match_data
)
12115 record_unwind_save_match_data ();
12117 /* Make sure that we don't accidentally use bogus keymaps. */
12118 if (NILP (Voverriding_local_map_menu_flag
))
12120 specbind (Qoverriding_terminal_local_map
, Qnil
);
12121 specbind (Qoverriding_local_map
, Qnil
);
12124 /* We must temporarily set the selected frame to this frame
12125 before calling tool_bar_items, because the calculation of
12126 the tool-bar keymap uses the selected frame (see
12127 `tool-bar-make-keymap' in tool-bar.el). */
12128 eassert (EQ (selected_window
,
12129 /* Since we only explicitly preserve selected_frame,
12130 check that selected_window would be redundant. */
12131 XFRAME (selected_frame
)->selected_window
));
12132 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12133 XSETFRAME (frame
, f
);
12134 fast_set_selected_frame (frame
);
12136 /* Build desired tool-bar items from keymaps. */
12138 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12141 /* Redisplay the tool-bar if we changed it. */
12142 if (new_n_tool_bar
!= f
->n_tool_bar_items
12143 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12145 /* Redisplay that happens asynchronously due to an expose event
12146 may access f->tool_bar_items. Make sure we update both
12147 variables within BLOCK_INPUT so no such event interrupts. */
12149 fset_tool_bar_items (f
, new_tool_bar
);
12150 f
->n_tool_bar_items
= new_n_tool_bar
;
12151 w
->update_mode_line
= true;
12155 unbind_to (count
, Qnil
);
12156 set_buffer_internal_1 (prev
);
12161 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12163 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12164 F's desired tool-bar contents. F->tool_bar_items must have
12165 been set up previously by calling prepare_menu_bars. */
12168 build_desired_tool_bar_string (struct frame
*f
)
12170 int i
, size
, size_needed
;
12171 Lisp_Object image
, plist
;
12173 image
= plist
= Qnil
;
12175 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12176 Otherwise, make a new string. */
12178 /* The size of the string we might be able to reuse. */
12179 size
= (STRINGP (f
->desired_tool_bar_string
)
12180 ? SCHARS (f
->desired_tool_bar_string
)
12183 /* We need one space in the string for each image. */
12184 size_needed
= f
->n_tool_bar_items
;
12186 /* Reuse f->desired_tool_bar_string, if possible. */
12187 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12188 fset_desired_tool_bar_string
12189 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12192 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12193 Fremove_text_properties (make_number (0), make_number (size
),
12194 props
, f
->desired_tool_bar_string
);
12197 /* Put a `display' property on the string for the images to display,
12198 put a `menu_item' property on tool-bar items with a value that
12199 is the index of the item in F's tool-bar item vector. */
12200 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12202 #define PROP(IDX) \
12203 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12205 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12206 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12207 int hmargin
, vmargin
, relief
, idx
, end
;
12209 /* If image is a vector, choose the image according to the
12211 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12212 if (VECTORP (image
))
12216 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12217 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12220 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12221 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12223 eassert (ASIZE (image
) >= idx
);
12224 image
= AREF (image
, idx
);
12229 /* Ignore invalid image specifications. */
12230 if (!valid_image_p (image
))
12233 /* Display the tool-bar button pressed, or depressed. */
12234 plist
= Fcopy_sequence (XCDR (image
));
12236 /* Compute margin and relief to draw. */
12237 relief
= (tool_bar_button_relief
>= 0
12238 ? tool_bar_button_relief
12239 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12240 hmargin
= vmargin
= relief
;
12242 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12243 INT_MAX
- max (hmargin
, vmargin
)))
12245 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12246 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12248 else if (CONSP (Vtool_bar_button_margin
))
12250 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12251 INT_MAX
- hmargin
))
12252 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12254 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12255 INT_MAX
- vmargin
))
12256 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12259 if (auto_raise_tool_bar_buttons_p
)
12261 /* Add a `:relief' property to the image spec if the item is
12265 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12272 /* If image is selected, display it pressed, i.e. with a
12273 negative relief. If it's not selected, display it with a
12275 plist
= Fplist_put (plist
, QCrelief
,
12277 ? make_number (-relief
)
12278 : make_number (relief
)));
12283 /* Put a margin around the image. */
12284 if (hmargin
|| vmargin
)
12286 if (hmargin
== vmargin
)
12287 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12289 plist
= Fplist_put (plist
, QCmargin
,
12290 Fcons (make_number (hmargin
),
12291 make_number (vmargin
)));
12294 /* If button is not enabled, and we don't have special images
12295 for the disabled state, make the image appear disabled by
12296 applying an appropriate algorithm to it. */
12297 if (!enabled_p
&& idx
< 0)
12298 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12300 /* Put a `display' text property on the string for the image to
12301 display. Put a `menu-item' property on the string that gives
12302 the start of this item's properties in the tool-bar items
12304 image
= Fcons (Qimage
, plist
);
12305 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12306 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12308 /* Let the last image hide all remaining spaces in the tool bar
12309 string. The string can be longer than needed when we reuse a
12310 previous string. */
12311 if (i
+ 1 == f
->n_tool_bar_items
)
12312 end
= SCHARS (f
->desired_tool_bar_string
);
12315 Fadd_text_properties (make_number (i
), make_number (end
),
12316 props
, f
->desired_tool_bar_string
);
12322 /* Display one line of the tool-bar of frame IT->f.
12324 HEIGHT specifies the desired height of the tool-bar line.
12325 If the actual height of the glyph row is less than HEIGHT, the
12326 row's height is increased to HEIGHT, and the icons are centered
12327 vertically in the new height.
12329 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12330 count a final empty row in case the tool-bar width exactly matches
12335 display_tool_bar_line (struct it
*it
, int height
)
12337 struct glyph_row
*row
= it
->glyph_row
;
12338 int max_x
= it
->last_visible_x
;
12339 struct glyph
*last
;
12341 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12342 clear_glyph_row (row
);
12343 row
->enabled_p
= true;
12344 row
->y
= it
->current_y
;
12346 /* Note that this isn't made use of if the face hasn't a box,
12347 so there's no need to check the face here. */
12348 it
->start_of_box_run_p
= true;
12350 while (it
->current_x
< max_x
)
12352 int x
, n_glyphs_before
, i
, nglyphs
;
12353 struct it it_before
;
12355 /* Get the next display element. */
12356 if (!get_next_display_element (it
))
12358 /* Don't count empty row if we are counting needed tool-bar lines. */
12359 if (height
< 0 && !it
->hpos
)
12364 /* Produce glyphs. */
12365 n_glyphs_before
= row
->used
[TEXT_AREA
];
12368 PRODUCE_GLYPHS (it
);
12370 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12372 x
= it_before
.current_x
;
12373 while (i
< nglyphs
)
12375 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12377 if (x
+ glyph
->pixel_width
> max_x
)
12379 /* Glyph doesn't fit on line. Backtrack. */
12380 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12382 /* If this is the only glyph on this line, it will never fit on the
12383 tool-bar, so skip it. But ensure there is at least one glyph,
12384 so we don't accidentally disable the tool-bar. */
12385 if (n_glyphs_before
== 0
12386 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12392 x
+= glyph
->pixel_width
;
12396 /* Stop at line end. */
12397 if (ITERATOR_AT_END_OF_LINE_P (it
))
12400 set_iterator_to_next (it
, true);
12405 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12407 /* Use default face for the border below the tool bar.
12409 FIXME: When auto-resize-tool-bars is grow-only, there is
12410 no additional border below the possibly empty tool-bar lines.
12411 So to make the extra empty lines look "normal", we have to
12412 use the tool-bar face for the border too. */
12413 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12414 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12415 it
->face_id
= DEFAULT_FACE_ID
;
12417 extend_face_to_end_of_line (it
);
12418 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12419 last
->right_box_line_p
= true;
12420 if (last
== row
->glyphs
[TEXT_AREA
])
12421 last
->left_box_line_p
= true;
12423 /* Make line the desired height and center it vertically. */
12424 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12426 /* Don't add more than one line height. */
12427 height
%= FRAME_LINE_HEIGHT (it
->f
);
12428 it
->max_ascent
+= height
/ 2;
12429 it
->max_descent
+= (height
+ 1) / 2;
12432 compute_line_metrics (it
);
12434 /* If line is empty, make it occupy the rest of the tool-bar. */
12435 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12437 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12438 row
->visible_height
= row
->height
;
12439 row
->ascent
= row
->phys_ascent
= 0;
12440 row
->extra_line_spacing
= 0;
12443 row
->full_width_p
= true;
12444 row
->continued_p
= false;
12445 row
->truncated_on_left_p
= false;
12446 row
->truncated_on_right_p
= false;
12448 it
->current_x
= it
->hpos
= 0;
12449 it
->current_y
+= row
->height
;
12455 /* Value is the number of pixels needed to make all tool-bar items of
12456 frame F visible. The actual number of glyph rows needed is
12457 returned in *N_ROWS if non-NULL. */
12459 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12461 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12463 /* tool_bar_height is called from redisplay_tool_bar after building
12464 the desired matrix, so use (unused) mode-line row as temporary row to
12465 avoid destroying the first tool-bar row. */
12466 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12468 /* Initialize an iterator for iteration over
12469 F->desired_tool_bar_string in the tool-bar window of frame F. */
12470 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12471 temp_row
->reversed_p
= false;
12472 it
.first_visible_x
= 0;
12473 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12474 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12475 it
.paragraph_embedding
= L2R
;
12477 while (!ITERATOR_AT_END_P (&it
))
12479 clear_glyph_row (temp_row
);
12480 it
.glyph_row
= temp_row
;
12481 display_tool_bar_line (&it
, -1);
12483 clear_glyph_row (temp_row
);
12485 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12487 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12490 return it
.current_y
;
12492 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12495 #endif /* !USE_GTK && !HAVE_NS */
12497 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12499 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12500 If FRAME is nil or omitted, use the selected frame. Optional argument
12501 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12502 (Lisp_Object frame
, Lisp_Object pixelwise
)
12506 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12507 struct frame
*f
= decode_any_frame (frame
);
12509 if (WINDOWP (f
->tool_bar_window
)
12510 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12512 update_tool_bar (f
, true);
12513 if (f
->n_tool_bar_items
)
12515 build_desired_tool_bar_string (f
);
12516 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12521 return make_number (height
);
12525 /* Display the tool-bar of frame F. Value is true if tool-bar's
12526 height should be changed. */
12528 redisplay_tool_bar (struct frame
*f
)
12530 f
->tool_bar_redisplayed
= true;
12531 #if defined (USE_GTK) || defined (HAVE_NS)
12533 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12534 update_frame_tool_bar (f
);
12537 #else /* !USE_GTK && !HAVE_NS */
12541 struct glyph_row
*row
;
12543 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12544 do anything. This means you must start with tool-bar-lines
12545 non-zero to get the auto-sizing effect. Or in other words, you
12546 can turn off tool-bars by specifying tool-bar-lines zero. */
12547 if (!WINDOWP (f
->tool_bar_window
)
12548 || (w
= XWINDOW (f
->tool_bar_window
),
12549 WINDOW_TOTAL_LINES (w
) == 0))
12552 /* Set up an iterator for the tool-bar window. */
12553 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12554 it
.first_visible_x
= 0;
12555 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12556 row
= it
.glyph_row
;
12557 row
->reversed_p
= false;
12559 /* Build a string that represents the contents of the tool-bar. */
12560 build_desired_tool_bar_string (f
);
12561 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12562 /* FIXME: This should be controlled by a user option. But it
12563 doesn't make sense to have an R2L tool bar if the menu bar cannot
12564 be drawn also R2L, and making the menu bar R2L is tricky due
12565 toolkit-specific code that implements it. If an R2L tool bar is
12566 ever supported, display_tool_bar_line should also be augmented to
12567 call unproduce_glyphs like display_line and display_string
12569 it
.paragraph_embedding
= L2R
;
12571 if (f
->n_tool_bar_rows
== 0)
12573 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12575 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12577 x_change_tool_bar_height (f
, new_height
);
12578 frame_default_tool_bar_height
= new_height
;
12579 /* Always do that now. */
12580 clear_glyph_matrix (w
->desired_matrix
);
12581 f
->fonts_changed
= true;
12586 /* Display as many lines as needed to display all tool-bar items. */
12588 if (f
->n_tool_bar_rows
> 0)
12590 int border
, rows
, height
, extra
;
12592 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12593 border
= XINT (Vtool_bar_border
);
12594 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12595 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12596 else if (EQ (Vtool_bar_border
, Qborder_width
))
12597 border
= f
->border_width
;
12603 rows
= f
->n_tool_bar_rows
;
12604 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12605 extra
= it
.last_visible_y
- border
- height
* rows
;
12607 while (it
.current_y
< it
.last_visible_y
)
12610 if (extra
> 0 && rows
-- > 0)
12612 h
= (extra
+ rows
- 1) / rows
;
12615 display_tool_bar_line (&it
, height
+ h
);
12620 while (it
.current_y
< it
.last_visible_y
)
12621 display_tool_bar_line (&it
, 0);
12624 /* It doesn't make much sense to try scrolling in the tool-bar
12625 window, so don't do it. */
12626 w
->desired_matrix
->no_scrolling_p
= true;
12627 w
->must_be_updated_p
= true;
12629 if (!NILP (Vauto_resize_tool_bars
))
12631 bool change_height_p
= true;
12633 /* If we couldn't display everything, change the tool-bar's
12634 height if there is room for more. */
12635 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12636 change_height_p
= true;
12638 /* We subtract 1 because display_tool_bar_line advances the
12639 glyph_row pointer before returning to its caller. We want to
12640 examine the last glyph row produced by
12641 display_tool_bar_line. */
12642 row
= it
.glyph_row
- 1;
12644 /* If there are blank lines at the end, except for a partially
12645 visible blank line at the end that is smaller than
12646 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12647 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12648 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12649 change_height_p
= true;
12651 /* If row displays tool-bar items, but is partially visible,
12652 change the tool-bar's height. */
12653 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12654 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12655 change_height_p
= true;
12657 /* Resize windows as needed by changing the `tool-bar-lines'
12658 frame parameter. */
12659 if (change_height_p
)
12662 int new_height
= tool_bar_height (f
, &nrows
, true);
12664 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12665 && !f
->minimize_tool_bar_window_p
)
12666 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12667 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12668 f
->minimize_tool_bar_window_p
= false;
12670 if (change_height_p
)
12672 x_change_tool_bar_height (f
, new_height
);
12673 frame_default_tool_bar_height
= new_height
;
12674 clear_glyph_matrix (w
->desired_matrix
);
12675 f
->n_tool_bar_rows
= nrows
;
12676 f
->fonts_changed
= true;
12683 f
->minimize_tool_bar_window_p
= false;
12686 #endif /* USE_GTK || HAVE_NS */
12689 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12691 /* Get information about the tool-bar item which is displayed in GLYPH
12692 on frame F. Return in *PROP_IDX the index where tool-bar item
12693 properties start in F->tool_bar_items. Value is false if
12694 GLYPH doesn't display a tool-bar item. */
12697 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12702 /* This function can be called asynchronously, which means we must
12703 exclude any possibility that Fget_text_property signals an
12705 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12706 charpos
= max (0, charpos
);
12708 /* Get the text property `menu-item' at pos. The value of that
12709 property is the start index of this item's properties in
12710 F->tool_bar_items. */
12711 prop
= Fget_text_property (make_number (charpos
),
12712 Qmenu_item
, f
->current_tool_bar_string
);
12713 if (! INTEGERP (prop
))
12715 *prop_idx
= XINT (prop
);
12720 /* Get information about the tool-bar item at position X/Y on frame F.
12721 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12722 the current matrix of the tool-bar window of F, or NULL if not
12723 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12724 item in F->tool_bar_items. Value is
12726 -1 if X/Y is not on a tool-bar item
12727 0 if X/Y is on the same item that was highlighted before.
12731 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12732 int *hpos
, int *vpos
, int *prop_idx
)
12734 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12735 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12738 /* Find the glyph under X/Y. */
12739 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12740 if (*glyph
== NULL
)
12743 /* Get the start of this tool-bar item's properties in
12744 f->tool_bar_items. */
12745 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12748 /* Is mouse on the highlighted item? */
12749 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12750 && *vpos
>= hlinfo
->mouse_face_beg_row
12751 && *vpos
<= hlinfo
->mouse_face_end_row
12752 && (*vpos
> hlinfo
->mouse_face_beg_row
12753 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12754 && (*vpos
< hlinfo
->mouse_face_end_row
12755 || *hpos
< hlinfo
->mouse_face_end_col
12756 || hlinfo
->mouse_face_past_end
))
12764 Handle mouse button event on the tool-bar of frame F, at
12765 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12766 false for button release. MODIFIERS is event modifiers for button
12770 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12773 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12774 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12775 int hpos
, vpos
, prop_idx
;
12776 struct glyph
*glyph
;
12777 Lisp_Object enabled_p
;
12780 /* If not on the highlighted tool-bar item, and mouse-highlight is
12781 non-nil, return. This is so we generate the tool-bar button
12782 click only when the mouse button is released on the same item as
12783 where it was pressed. However, when mouse-highlight is disabled,
12784 generate the click when the button is released regardless of the
12785 highlight, since tool-bar items are not highlighted in that
12787 frame_to_window_pixel_xy (w
, &x
, &y
);
12788 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12790 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12793 /* When mouse-highlight is off, generate the click for the item
12794 where the button was pressed, disregarding where it was
12796 if (NILP (Vmouse_highlight
) && !down_p
)
12797 prop_idx
= f
->last_tool_bar_item
;
12799 /* If item is disabled, do nothing. */
12800 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12801 if (NILP (enabled_p
))
12806 /* Show item in pressed state. */
12807 if (!NILP (Vmouse_highlight
))
12808 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12809 f
->last_tool_bar_item
= prop_idx
;
12813 Lisp_Object key
, frame
;
12814 struct input_event event
;
12815 EVENT_INIT (event
);
12817 /* Show item in released state. */
12818 if (!NILP (Vmouse_highlight
))
12819 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12821 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12823 XSETFRAME (frame
, f
);
12824 event
.kind
= TOOL_BAR_EVENT
;
12825 event
.frame_or_window
= frame
;
12827 kbd_buffer_store_event (&event
);
12829 event
.kind
= TOOL_BAR_EVENT
;
12830 event
.frame_or_window
= frame
;
12832 event
.modifiers
= modifiers
;
12833 kbd_buffer_store_event (&event
);
12834 f
->last_tool_bar_item
= -1;
12839 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12840 tool-bar window-relative coordinates X/Y. Called from
12841 note_mouse_highlight. */
12844 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12846 Lisp_Object window
= f
->tool_bar_window
;
12847 struct window
*w
= XWINDOW (window
);
12848 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12849 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12851 struct glyph
*glyph
;
12852 struct glyph_row
*row
;
12854 Lisp_Object enabled_p
;
12856 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12860 /* Function note_mouse_highlight is called with negative X/Y
12861 values when mouse moves outside of the frame. */
12862 if (x
<= 0 || y
<= 0)
12864 clear_mouse_face (hlinfo
);
12868 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12871 /* Not on tool-bar item. */
12872 clear_mouse_face (hlinfo
);
12876 /* On same tool-bar item as before. */
12877 goto set_help_echo
;
12879 clear_mouse_face (hlinfo
);
12881 /* Mouse is down, but on different tool-bar item? */
12882 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12883 && f
== dpyinfo
->last_mouse_frame
);
12885 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12888 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12890 /* If tool-bar item is not enabled, don't highlight it. */
12891 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12892 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12894 /* Compute the x-position of the glyph. In front and past the
12895 image is a space. We include this in the highlighted area. */
12896 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12897 for (i
= x
= 0; i
< hpos
; ++i
)
12898 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12900 /* Record this as the current active region. */
12901 hlinfo
->mouse_face_beg_col
= hpos
;
12902 hlinfo
->mouse_face_beg_row
= vpos
;
12903 hlinfo
->mouse_face_beg_x
= x
;
12904 hlinfo
->mouse_face_past_end
= false;
12906 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12907 hlinfo
->mouse_face_end_row
= vpos
;
12908 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12909 hlinfo
->mouse_face_window
= window
;
12910 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12912 /* Display it as active. */
12913 show_mouse_face (hlinfo
, draw
);
12918 /* Set help_echo_string to a help string to display for this tool-bar item.
12919 XTread_socket does the rest. */
12920 help_echo_object
= help_echo_window
= Qnil
;
12921 help_echo_pos
= -1;
12922 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12923 if (NILP (help_echo_string
))
12924 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12927 #endif /* !USE_GTK && !HAVE_NS */
12929 #endif /* HAVE_WINDOW_SYSTEM */
12933 /************************************************************************
12934 Horizontal scrolling
12935 ************************************************************************/
12937 /* For all leaf windows in the window tree rooted at WINDOW, set their
12938 hscroll value so that PT is (i) visible in the window, and (ii) so
12939 that it is not within a certain margin at the window's left and
12940 right border. Value is true if any window's hscroll has been
12944 hscroll_window_tree (Lisp_Object window
)
12946 bool hscrolled_p
= false;
12947 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12948 int hscroll_step_abs
= 0;
12949 double hscroll_step_rel
= 0;
12951 if (hscroll_relative_p
)
12953 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12954 if (hscroll_step_rel
< 0)
12956 hscroll_relative_p
= false;
12957 hscroll_step_abs
= 0;
12960 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12962 hscroll_step_abs
= XINT (Vhscroll_step
);
12963 if (hscroll_step_abs
< 0)
12964 hscroll_step_abs
= 0;
12967 hscroll_step_abs
= 0;
12969 while (WINDOWP (window
))
12971 struct window
*w
= XWINDOW (window
);
12973 if (WINDOWP (w
->contents
))
12974 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12975 else if (w
->cursor
.vpos
>= 0)
12978 int text_area_width
;
12979 struct glyph_row
*cursor_row
;
12980 struct glyph_row
*bottom_row
;
12982 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12983 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12984 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12986 cursor_row
= bottom_row
- 1;
12988 if (!cursor_row
->enabled_p
)
12990 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12991 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12992 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12994 cursor_row
= bottom_row
- 1;
12996 bool row_r2l_p
= cursor_row
->reversed_p
;
12998 text_area_width
= window_box_width (w
, TEXT_AREA
);
13000 /* Scroll when cursor is inside this scroll margin. */
13001 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
13003 /* If the position of this window's point has explicitly
13004 changed, no more suspend auto hscrolling. */
13005 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
13006 w
->suspend_auto_hscroll
= false;
13008 /* Remember window point. */
13009 Fset_marker (w
->old_pointm
,
13010 ((w
== XWINDOW (selected_window
))
13011 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
13012 : Fmarker_position (w
->pointm
)),
13015 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
13016 && !w
->suspend_auto_hscroll
13017 /* In some pathological cases, like restoring a window
13018 configuration into a frame that is much smaller than
13019 the one from which the configuration was saved, we
13020 get glyph rows whose start and end have zero buffer
13021 positions, which we cannot handle below. Just skip
13023 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
13024 /* For left-to-right rows, hscroll when cursor is either
13025 (i) inside the right hscroll margin, or (ii) if it is
13026 inside the left margin and the window is already
13029 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
13030 || (cursor_row
->enabled_p
13031 && cursor_row
->truncated_on_right_p
13032 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
13033 /* For right-to-left rows, the logic is similar,
13034 except that rules for scrolling to left and right
13035 are reversed. E.g., if cursor.x <= h_margin, we
13036 need to hscroll "to the right" unconditionally,
13037 and that will scroll the screen to the left so as
13038 to reveal the next portion of the row. */
13040 && ((cursor_row
->enabled_p
13041 /* FIXME: It is confusing to set the
13042 truncated_on_right_p flag when R2L rows
13043 are actually truncated on the left. */
13044 && cursor_row
->truncated_on_right_p
13045 && w
->cursor
.x
<= h_margin
)
13047 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
13051 struct buffer
*saved_current_buffer
;
13055 /* Find point in a display of infinite width. */
13056 saved_current_buffer
= current_buffer
;
13057 current_buffer
= XBUFFER (w
->contents
);
13059 if (w
== XWINDOW (selected_window
))
13062 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
13064 /* Move iterator to pt starting at cursor_row->start in
13065 a line with infinite width. */
13066 init_to_row_start (&it
, w
, cursor_row
);
13067 it
.last_visible_x
= INFINITY
;
13068 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
13069 /* If the line ends in an overlay string with a newline,
13070 we might infloop, because displaying the window will
13071 want to put the cursor after the overlay, i.e. at X
13072 coordinate of zero on the next screen line. So we
13073 use the buffer position prior to the overlay string
13075 if (it
.method
== GET_FROM_STRING
&& pt
> 1)
13077 init_to_row_start (&it
, w
, cursor_row
);
13078 move_it_in_display_line_to (&it
, pt
- 1, -1, MOVE_TO_POS
);
13080 current_buffer
= saved_current_buffer
;
13082 /* Position cursor in window. */
13083 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
13084 hscroll
= max (0, (it
.current_x
13085 - (ITERATOR_AT_END_OF_LINE_P (&it
)
13086 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
13087 : (text_area_width
/ 2))))
13088 / FRAME_COLUMN_WIDTH (it
.f
);
13089 else if ((!row_r2l_p
13090 && w
->cursor
.x
>= text_area_width
- h_margin
)
13091 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
13093 if (hscroll_relative_p
)
13094 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
13097 wanted_x
= text_area_width
13098 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13101 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13105 if (hscroll_relative_p
)
13106 wanted_x
= text_area_width
* hscroll_step_rel
13109 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13112 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13114 hscroll
= max (hscroll
, w
->min_hscroll
);
13116 /* Don't prevent redisplay optimizations if hscroll
13117 hasn't changed, as it will unnecessarily slow down
13119 if (w
->hscroll
!= hscroll
)
13121 struct buffer
*b
= XBUFFER (w
->contents
);
13122 b
->prevent_redisplay_optimizations_p
= true;
13123 w
->hscroll
= hscroll
;
13124 hscrolled_p
= true;
13132 /* Value is true if hscroll of any leaf window has been changed. */
13133 return hscrolled_p
;
13137 /* Set hscroll so that cursor is visible and not inside horizontal
13138 scroll margins for all windows in the tree rooted at WINDOW. See
13139 also hscroll_window_tree above. Value is true if any window's
13140 hscroll has been changed. If it has, desired matrices on the frame
13141 of WINDOW are cleared. */
13144 hscroll_windows (Lisp_Object window
)
13146 bool hscrolled_p
= hscroll_window_tree (window
);
13148 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13149 return hscrolled_p
;
13154 /************************************************************************
13156 ************************************************************************/
13158 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
13159 This is sometimes handy to have in a debugger session. */
13163 /* First and last unchanged row for try_window_id. */
13165 static int debug_first_unchanged_at_end_vpos
;
13166 static int debug_last_unchanged_at_beg_vpos
;
13168 /* Delta vpos and y. */
13170 static int debug_dvpos
, debug_dy
;
13172 /* Delta in characters and bytes for try_window_id. */
13174 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13176 /* Values of window_end_pos and window_end_vpos at the end of
13179 static ptrdiff_t debug_end_vpos
;
13181 /* Append a string to W->desired_matrix->method. FMT is a printf
13182 format string. If trace_redisplay_p is true also printf the
13183 resulting string to stderr. */
13185 static void debug_method_add (struct window
*, char const *, ...)
13186 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13189 debug_method_add (struct window
*w
, char const *fmt
, ...)
13192 char *method
= w
->desired_matrix
->method
;
13193 int len
= strlen (method
);
13194 int size
= sizeof w
->desired_matrix
->method
;
13195 int remaining
= size
- len
- 1;
13198 if (len
&& remaining
)
13201 --remaining
, ++len
;
13204 va_start (ap
, fmt
);
13205 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13208 if (trace_redisplay_p
)
13209 fprintf (stderr
, "%p (%s): %s\n",
13211 ((BUFFERP (w
->contents
)
13212 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13213 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13218 #endif /* GLYPH_DEBUG */
13221 /* Value is true if all changes in window W, which displays
13222 current_buffer, are in the text between START and END. START is a
13223 buffer position, END is given as a distance from Z. Used in
13224 redisplay_internal for display optimization. */
13227 text_outside_line_unchanged_p (struct window
*w
,
13228 ptrdiff_t start
, ptrdiff_t end
)
13230 bool unchanged_p
= true;
13232 /* If text or overlays have changed, see where. */
13233 if (window_outdated (w
))
13235 /* Gap in the line? */
13236 if (GPT
< start
|| Z
- GPT
< end
)
13237 unchanged_p
= false;
13239 /* Changes start in front of the line, or end after it? */
13241 && (BEG_UNCHANGED
< start
- 1
13242 || END_UNCHANGED
< end
))
13243 unchanged_p
= false;
13245 /* If selective display, can't optimize if changes start at the
13246 beginning of the line. */
13248 && INTEGERP (BVAR (current_buffer
, selective_display
))
13249 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13250 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13251 unchanged_p
= false;
13253 /* If there are overlays at the start or end of the line, these
13254 may have overlay strings with newlines in them. A change at
13255 START, for instance, may actually concern the display of such
13256 overlay strings as well, and they are displayed on different
13257 lines. So, quickly rule out this case. (For the future, it
13258 might be desirable to implement something more telling than
13259 just BEG/END_UNCHANGED.) */
13262 if (BEG
+ BEG_UNCHANGED
== start
13263 && overlay_touches_p (start
))
13264 unchanged_p
= false;
13265 if (END_UNCHANGED
== end
13266 && overlay_touches_p (Z
- end
))
13267 unchanged_p
= false;
13270 /* Under bidi reordering, adding or deleting a character in the
13271 beginning of a paragraph, before the first strong directional
13272 character, can change the base direction of the paragraph (unless
13273 the buffer specifies a fixed paragraph direction), which will
13274 require redisplaying the whole paragraph. It might be worthwhile
13275 to find the paragraph limits and widen the range of redisplayed
13276 lines to that, but for now just give up this optimization. */
13277 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13278 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13279 unchanged_p
= false;
13282 return unchanged_p
;
13286 /* Do a frame update, taking possible shortcuts into account. This is
13287 the main external entry point for redisplay.
13289 If the last redisplay displayed an echo area message and that message
13290 is no longer requested, we clear the echo area or bring back the
13291 mini-buffer if that is in use. */
13296 redisplay_internal ();
13301 overlay_arrow_string_or_property (Lisp_Object var
)
13305 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13308 return Voverlay_arrow_string
;
13311 /* Return true if there are any overlay-arrows in current_buffer. */
13313 overlay_arrow_in_current_buffer_p (void)
13317 for (vlist
= Voverlay_arrow_variable_list
;
13319 vlist
= XCDR (vlist
))
13321 Lisp_Object var
= XCAR (vlist
);
13324 if (!SYMBOLP (var
))
13326 val
= find_symbol_value (var
);
13328 && current_buffer
== XMARKER (val
)->buffer
)
13335 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13339 overlay_arrows_changed_p (void)
13343 for (vlist
= Voverlay_arrow_variable_list
;
13345 vlist
= XCDR (vlist
))
13347 Lisp_Object var
= XCAR (vlist
);
13348 Lisp_Object val
, pstr
;
13350 if (!SYMBOLP (var
))
13352 val
= find_symbol_value (var
);
13353 if (!MARKERP (val
))
13355 if (! EQ (COERCE_MARKER (val
),
13356 Fget (var
, Qlast_arrow_position
))
13357 || ! (pstr
= overlay_arrow_string_or_property (var
),
13358 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13364 /* Mark overlay arrows to be updated on next redisplay. */
13367 update_overlay_arrows (int up_to_date
)
13371 for (vlist
= Voverlay_arrow_variable_list
;
13373 vlist
= XCDR (vlist
))
13375 Lisp_Object var
= XCAR (vlist
);
13377 if (!SYMBOLP (var
))
13380 if (up_to_date
> 0)
13382 Lisp_Object val
= find_symbol_value (var
);
13383 Fput (var
, Qlast_arrow_position
,
13384 COERCE_MARKER (val
));
13385 Fput (var
, Qlast_arrow_string
,
13386 overlay_arrow_string_or_property (var
));
13388 else if (up_to_date
< 0
13389 || !NILP (Fget (var
, Qlast_arrow_position
)))
13391 Fput (var
, Qlast_arrow_position
, Qt
);
13392 Fput (var
, Qlast_arrow_string
, Qt
);
13398 /* Return overlay arrow string to display at row.
13399 Return integer (bitmap number) for arrow bitmap in left fringe.
13400 Return nil if no overlay arrow. */
13403 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13407 for (vlist
= Voverlay_arrow_variable_list
;
13409 vlist
= XCDR (vlist
))
13411 Lisp_Object var
= XCAR (vlist
);
13414 if (!SYMBOLP (var
))
13417 val
= find_symbol_value (var
);
13420 && current_buffer
== XMARKER (val
)->buffer
13421 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13423 if (FRAME_WINDOW_P (it
->f
)
13424 /* FIXME: if ROW->reversed_p is set, this should test
13425 the right fringe, not the left one. */
13426 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13428 #ifdef HAVE_WINDOW_SYSTEM
13429 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13431 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13432 if (fringe_bitmap
!= 0)
13433 return make_number (fringe_bitmap
);
13436 return make_number (-1); /* Use default arrow bitmap. */
13438 return overlay_arrow_string_or_property (var
);
13445 /* Return true if point moved out of or into a composition. Otherwise
13446 return false. PREV_BUF and PREV_PT are the last point buffer and
13447 position. BUF and PT are the current point buffer and position. */
13450 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13451 struct buffer
*buf
, ptrdiff_t pt
)
13453 ptrdiff_t start
, end
;
13455 Lisp_Object buffer
;
13457 XSETBUFFER (buffer
, buf
);
13458 /* Check a composition at the last point if point moved within the
13460 if (prev_buf
== buf
)
13463 /* Point didn't move. */
13466 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13467 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13468 && composition_valid_p (start
, end
, prop
)
13469 && start
< prev_pt
&& end
> prev_pt
)
13470 /* The last point was within the composition. Return true iff
13471 point moved out of the composition. */
13472 return (pt
<= start
|| pt
>= end
);
13475 /* Check a composition at the current point. */
13476 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13477 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13478 && composition_valid_p (start
, end
, prop
)
13479 && start
< pt
&& end
> pt
);
13482 /* Reconsider the clip changes of buffer which is displayed in W. */
13485 reconsider_clip_changes (struct window
*w
)
13487 struct buffer
*b
= XBUFFER (w
->contents
);
13489 if (b
->clip_changed
13490 && w
->window_end_valid
13491 && w
->current_matrix
->buffer
== b
13492 && w
->current_matrix
->zv
== BUF_ZV (b
)
13493 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13494 b
->clip_changed
= false;
13496 /* If display wasn't paused, and W is not a tool bar window, see if
13497 point has been moved into or out of a composition. In that case,
13498 set b->clip_changed to force updating the screen. If
13499 b->clip_changed has already been set, skip this check. */
13500 if (!b
->clip_changed
&& w
->window_end_valid
)
13502 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13503 ? PT
: marker_position (w
->pointm
));
13505 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13506 && check_point_in_composition (w
->current_matrix
->buffer
,
13507 w
->last_point
, b
, pt
))
13508 b
->clip_changed
= true;
13513 propagate_buffer_redisplay (void)
13514 { /* Resetting b->text->redisplay is problematic!
13515 We can't just reset it in the case that some window that displays
13516 it has not been redisplayed; and such a window can stay
13517 unredisplayed for a long time if it's currently invisible.
13518 But we do want to reset it at the end of redisplay otherwise
13519 its displayed windows will keep being redisplayed over and over
13521 So we copy all b->text->redisplay flags up to their windows here,
13522 such that mark_window_display_accurate can safely reset
13523 b->text->redisplay. */
13524 Lisp_Object ws
= window_list ();
13525 for (; CONSP (ws
); ws
= XCDR (ws
))
13527 struct window
*thisw
= XWINDOW (XCAR (ws
));
13528 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13529 if (thisb
->text
->redisplay
)
13530 thisw
->redisplay
= true;
13534 #define STOP_POLLING \
13535 do { if (! polling_stopped_here) stop_polling (); \
13536 polling_stopped_here = true; } while (false)
13538 #define RESUME_POLLING \
13539 do { if (polling_stopped_here) start_polling (); \
13540 polling_stopped_here = false; } while (false)
13543 /* Perhaps in the future avoid recentering windows if it
13544 is not necessary; currently that causes some problems. */
13547 redisplay_internal (void)
13549 struct window
*w
= XWINDOW (selected_window
);
13553 bool must_finish
= false, match_p
;
13554 struct text_pos tlbufpos
, tlendpos
;
13555 int number_of_visible_frames
;
13558 bool polling_stopped_here
= false;
13559 Lisp_Object tail
, frame
;
13561 /* Set a limit to the number of retries we perform due to horizontal
13562 scrolling, this avoids getting stuck in an uninterruptible
13563 infinite loop (Bug #24633). */
13564 enum { MAX_HSCROLL_RETRIES
= 16 };
13565 int hscroll_retries
= 0;
13567 /* True means redisplay has to consider all windows on all
13568 frames. False, only selected_window is considered. */
13569 bool consider_all_windows_p
;
13571 /* True means redisplay has to redisplay the miniwindow. */
13572 bool update_miniwindow_p
= false;
13574 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13576 /* No redisplay if running in batch mode or frame is not yet fully
13577 initialized, or redisplay is explicitly turned off by setting
13578 Vinhibit_redisplay. */
13579 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13580 || !NILP (Vinhibit_redisplay
))
13583 /* Don't examine these until after testing Vinhibit_redisplay.
13584 When Emacs is shutting down, perhaps because its connection to
13585 X has dropped, we should not look at them at all. */
13586 fr
= XFRAME (w
->frame
);
13587 sf
= SELECTED_FRAME ();
13589 if (!fr
->glyphs_initialized_p
)
13592 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13593 if (popup_activated ())
13597 /* I don't think this happens but let's be paranoid. */
13598 if (redisplaying_p
)
13601 /* Record a function that clears redisplaying_p
13602 when we leave this function. */
13603 count
= SPECPDL_INDEX ();
13604 record_unwind_protect_void (unwind_redisplay
);
13605 redisplaying_p
= true;
13606 block_buffer_flips ();
13607 specbind (Qinhibit_free_realized_faces
, Qnil
);
13609 /* Record this function, so it appears on the profiler's backtraces. */
13610 record_in_backtrace (Qredisplay_internal_xC_functionx
, 0, 0);
13612 FOR_EACH_FRAME (tail
, frame
)
13613 XFRAME (frame
)->already_hscrolled_p
= false;
13616 /* Remember the currently selected window. */
13620 forget_escape_and_glyphless_faces ();
13622 inhibit_free_realized_faces
= false;
13624 /* If face_change, init_iterator will free all realized faces, which
13625 includes the faces referenced from current matrices. So, we
13626 can't reuse current matrices in this case. */
13628 windows_or_buffers_changed
= 47;
13630 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13631 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13633 /* Since frames on a single ASCII terminal share the same
13634 display area, displaying a different frame means redisplay
13635 the whole thing. */
13636 SET_FRAME_GARBAGED (sf
);
13638 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13640 FRAME_TTY (sf
)->previous_frame
= sf
;
13643 /* Set the visible flags for all frames. Do this before checking for
13644 resized or garbaged frames; they want to know if their frames are
13645 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13646 number_of_visible_frames
= 0;
13648 FOR_EACH_FRAME (tail
, frame
)
13650 struct frame
*f
= XFRAME (frame
);
13652 if (FRAME_VISIBLE_P (f
))
13654 ++number_of_visible_frames
;
13655 /* Adjust matrices for visible frames only. */
13656 if (f
->fonts_changed
)
13658 adjust_frame_glyphs (f
);
13659 /* Disable all redisplay optimizations for this frame.
13660 This is because adjust_frame_glyphs resets the
13661 enabled_p flag for all glyph rows of all windows, so
13662 many optimizations will fail anyway, and some might
13663 fail to test that flag and do bogus things as
13665 SET_FRAME_GARBAGED (f
);
13666 f
->fonts_changed
= false;
13668 /* If cursor type has been changed on the frame
13669 other than selected, consider all frames. */
13670 if (f
!= sf
&& f
->cursor_type_changed
)
13671 fset_redisplay (f
);
13673 clear_desired_matrices (f
);
13676 /* Notice any pending interrupt request to change frame size. */
13677 do_pending_window_change (true);
13679 /* do_pending_window_change could change the selected_window due to
13680 frame resizing which makes the selected window too small. */
13681 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13684 /* Clear frames marked as garbaged. */
13685 clear_garbaged_frames ();
13687 /* Build menubar and tool-bar items. */
13688 if (NILP (Vmemory_full
))
13689 prepare_menu_bars ();
13691 reconsider_clip_changes (w
);
13693 /* In most cases selected window displays current buffer. */
13694 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13697 /* Detect case that we need to write or remove a star in the mode line. */
13698 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13699 w
->update_mode_line
= true;
13701 if (mode_line_update_needed (w
))
13702 w
->update_mode_line
= true;
13704 /* If reconsider_clip_changes above decided that the narrowing
13705 in the current buffer changed, make sure all other windows
13706 showing that buffer will be redisplayed. */
13707 if (current_buffer
->clip_changed
)
13708 bset_update_mode_line (current_buffer
);
13711 /* Normally the message* functions will have already displayed and
13712 updated the echo area, but the frame may have been trashed, or
13713 the update may have been preempted, so display the echo area
13714 again here. Checking message_cleared_p captures the case that
13715 the echo area should be cleared. */
13716 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13717 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13718 || (message_cleared_p
13719 && minibuf_level
== 0
13720 /* If the mini-window is currently selected, this means the
13721 echo-area doesn't show through. */
13722 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13724 echo_area_display (false);
13726 /* If echo_area_display resizes the mini-window, the redisplay and
13727 window_sizes_changed flags of the selected frame are set, but
13728 it's too late for the hooks in window-size-change-functions,
13729 which have been examined already in prepare_menu_bars. So in
13730 that case we call the hooks here only for the selected frame. */
13733 ptrdiff_t count1
= SPECPDL_INDEX ();
13735 record_unwind_save_match_data ();
13736 run_window_size_change_functions (selected_frame
);
13737 unbind_to (count1
, Qnil
);
13740 if (message_cleared_p
)
13741 update_miniwindow_p
= true;
13743 must_finish
= true;
13745 /* If we don't display the current message, don't clear the
13746 message_cleared_p flag, because, if we did, we wouldn't clear
13747 the echo area in the next redisplay which doesn't preserve
13749 if (!display_last_displayed_message_p
)
13750 message_cleared_p
= false;
13752 else if (EQ (selected_window
, minibuf_window
)
13753 && (current_buffer
->clip_changed
|| window_outdated (w
))
13754 && resize_mini_window (w
, false))
13758 ptrdiff_t count1
= SPECPDL_INDEX ();
13760 record_unwind_save_match_data ();
13761 run_window_size_change_functions (selected_frame
);
13762 unbind_to (count1
, Qnil
);
13765 /* Resized active mini-window to fit the size of what it is
13766 showing if its contents might have changed. */
13767 must_finish
= true;
13769 /* If window configuration was changed, frames may have been
13770 marked garbaged. Clear them or we will experience
13771 surprises wrt scrolling. */
13772 clear_garbaged_frames ();
13775 if (windows_or_buffers_changed
&& !update_mode_lines
)
13776 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13777 only the windows's contents needs to be refreshed, or whether the
13778 mode-lines also need a refresh. */
13779 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13780 ? REDISPLAY_SOME
: 32);
13782 /* If specs for an arrow have changed, do thorough redisplay
13783 to ensure we remove any arrow that should no longer exist. */
13784 if (overlay_arrows_changed_p ())
13785 /* Apparently, this is the only case where we update other windows,
13786 without updating other mode-lines. */
13787 windows_or_buffers_changed
= 49;
13789 consider_all_windows_p
= (update_mode_lines
13790 || windows_or_buffers_changed
);
13792 #define AINC(a,i) \
13794 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13795 if (INTEGERP (entry)) \
13796 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13799 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13800 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13802 /* Optimize the case that only the line containing the cursor in the
13803 selected window has changed. Variables starting with this_ are
13804 set in display_line and record information about the line
13805 containing the cursor. */
13806 tlbufpos
= this_line_start_pos
;
13807 tlendpos
= this_line_end_pos
;
13808 if (!consider_all_windows_p
13809 && CHARPOS (tlbufpos
) > 0
13810 && !w
->update_mode_line
13811 && !current_buffer
->clip_changed
13812 && !current_buffer
->prevent_redisplay_optimizations_p
13813 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13814 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13815 && !XFRAME (w
->frame
)->cursor_type_changed
13816 && !XFRAME (w
->frame
)->face_change
13817 /* Make sure recorded data applies to current buffer, etc. */
13818 && this_line_buffer
== current_buffer
13821 && !w
->optional_new_start
13822 /* Point must be on the line that we have info recorded about. */
13823 && PT
>= CHARPOS (tlbufpos
)
13824 && PT
<= Z
- CHARPOS (tlendpos
)
13825 /* All text outside that line, including its final newline,
13826 must be unchanged. */
13827 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13828 CHARPOS (tlendpos
)))
13830 if (CHARPOS (tlbufpos
) > BEGV
13831 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13832 && (CHARPOS (tlbufpos
) == ZV
13833 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13834 /* Former continuation line has disappeared by becoming empty. */
13836 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13838 /* We have to handle the case of continuation around a
13839 wide-column character (see the comment in indent.c around
13842 For instance, in the following case:
13844 -------- Insert --------
13845 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13846 J_I_ ==> J_I_ `^^' are cursors.
13850 As we have to redraw the line above, we cannot use this
13854 int line_height_before
= this_line_pixel_height
;
13856 /* Note that start_display will handle the case that the
13857 line starting at tlbufpos is a continuation line. */
13858 start_display (&it
, w
, tlbufpos
);
13860 /* Implementation note: It this still necessary? */
13861 if (it
.current_x
!= this_line_start_x
)
13864 TRACE ((stderr
, "trying display optimization 1\n"));
13865 w
->cursor
.vpos
= -1;
13866 overlay_arrow_seen
= false;
13867 it
.vpos
= this_line_vpos
;
13868 it
.current_y
= this_line_y
;
13869 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13870 display_line (&it
);
13872 /* If line contains point, is not continued,
13873 and ends at same distance from eob as before, we win. */
13874 if (w
->cursor
.vpos
>= 0
13875 /* Line is not continued, otherwise this_line_start_pos
13876 would have been set to 0 in display_line. */
13877 && CHARPOS (this_line_start_pos
)
13878 /* Line ends as before. */
13879 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13880 /* Line has same height as before. Otherwise other lines
13881 would have to be shifted up or down. */
13882 && this_line_pixel_height
== line_height_before
)
13884 /* If this is not the window's last line, we must adjust
13885 the charstarts of the lines below. */
13886 if (it
.current_y
< it
.last_visible_y
)
13888 struct glyph_row
*row
13889 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13890 ptrdiff_t delta
, delta_bytes
;
13892 /* We used to distinguish between two cases here,
13893 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13894 when the line ends in a newline or the end of the
13895 buffer's accessible portion. But both cases did
13896 the same, so they were collapsed. */
13898 - CHARPOS (tlendpos
)
13899 - MATRIX_ROW_START_CHARPOS (row
));
13900 delta_bytes
= (Z_BYTE
13901 - BYTEPOS (tlendpos
)
13902 - MATRIX_ROW_START_BYTEPOS (row
));
13904 increment_matrix_positions (w
->current_matrix
,
13905 this_line_vpos
+ 1,
13906 w
->current_matrix
->nrows
,
13907 delta
, delta_bytes
);
13910 /* If this row displays text now but previously didn't,
13911 or vice versa, w->window_end_vpos may have to be
13913 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13915 if (w
->window_end_vpos
< this_line_vpos
)
13916 w
->window_end_vpos
= this_line_vpos
;
13918 else if (w
->window_end_vpos
== this_line_vpos
13919 && this_line_vpos
> 0)
13920 w
->window_end_vpos
= this_line_vpos
- 1;
13921 w
->window_end_valid
= false;
13923 /* Update hint: No need to try to scroll in update_window. */
13924 w
->desired_matrix
->no_scrolling_p
= true;
13927 *w
->desired_matrix
->method
= 0;
13928 debug_method_add (w
, "optimization 1");
13930 #ifdef HAVE_WINDOW_SYSTEM
13931 update_window_fringes (w
, false);
13938 else if (/* Cursor position hasn't changed. */
13939 PT
== w
->last_point
13940 /* Make sure the cursor was last displayed
13941 in this window. Otherwise we have to reposition it. */
13943 /* PXW: Must be converted to pixels, probably. */
13944 && 0 <= w
->cursor
.vpos
13945 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13949 do_pending_window_change (true);
13950 /* If selected_window changed, redisplay again. */
13951 if (WINDOWP (selected_window
)
13952 && (w
= XWINDOW (selected_window
)) != sw
)
13955 /* We used to always goto end_of_redisplay here, but this
13956 isn't enough if we have a blinking cursor. */
13957 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13958 goto end_of_redisplay
;
13962 /* If highlighting the region, or if the cursor is in the echo area,
13963 then we can't just move the cursor. */
13964 else if (NILP (Vshow_trailing_whitespace
)
13965 && !cursor_in_echo_area
)
13968 struct glyph_row
*row
;
13970 /* Skip from tlbufpos to PT and see where it is. Note that
13971 PT may be in invisible text. If so, we will end at the
13972 next visible position. */
13973 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13974 NULL
, DEFAULT_FACE_ID
);
13975 it
.current_x
= this_line_start_x
;
13976 it
.current_y
= this_line_y
;
13977 it
.vpos
= this_line_vpos
;
13979 /* The call to move_it_to stops in front of PT, but
13980 moves over before-strings. */
13981 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13983 if (it
.vpos
== this_line_vpos
13984 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13987 eassert (this_line_vpos
== it
.vpos
);
13988 eassert (this_line_y
== it
.current_y
);
13989 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13990 if (cursor_row_fully_visible_p (w
, false, true))
13993 *w
->desired_matrix
->method
= 0;
13994 debug_method_add (w
, "optimization 3");
14006 /* Text changed drastically or point moved off of line. */
14007 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
14010 CHARPOS (this_line_start_pos
) = 0;
14011 ++clear_face_cache_count
;
14012 #ifdef HAVE_WINDOW_SYSTEM
14013 ++clear_image_cache_count
;
14016 /* Build desired matrices, and update the display. If
14017 consider_all_windows_p, do it for all windows on all frames that
14018 require redisplay, as specified by their 'redisplay' flag.
14019 Otherwise do it for selected_window, only. */
14021 if (consider_all_windows_p
)
14023 FOR_EACH_FRAME (tail
, frame
)
14024 XFRAME (frame
)->updated_p
= false;
14026 propagate_buffer_redisplay ();
14028 FOR_EACH_FRAME (tail
, frame
)
14030 struct frame
*f
= XFRAME (frame
);
14032 /* We don't have to do anything for unselected terminal
14034 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
14035 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
14039 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
14042 /* Only GC scrollbars when we redisplay the whole frame. */
14043 = f
->redisplay
|| !REDISPLAY_SOME_P ();
14044 bool f_redisplay_flag
= f
->redisplay
;
14045 /* Mark all the scroll bars to be removed; we'll redeem
14046 the ones we want when we redisplay their windows. */
14047 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
14048 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
14050 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
14051 redisplay_windows (FRAME_ROOT_WINDOW (f
));
14052 /* Remember that the invisible frames need to be redisplayed next
14053 time they're visible. */
14054 else if (!REDISPLAY_SOME_P ())
14055 f
->redisplay
= true;
14057 /* The X error handler may have deleted that frame. */
14058 if (!FRAME_LIVE_P (f
))
14061 /* Any scroll bars which redisplay_windows should have
14062 nuked should now go away. */
14063 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
14064 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
14066 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
14068 /* If fonts changed on visible frame, display again. */
14069 if (f
->fonts_changed
)
14071 adjust_frame_glyphs (f
);
14072 /* Disable all redisplay optimizations for this
14073 frame. For the reasons, see the comment near
14074 the previous call to adjust_frame_glyphs above. */
14075 SET_FRAME_GARBAGED (f
);
14076 f
->fonts_changed
= false;
14080 /* See if we have to hscroll. */
14081 if (!f
->already_hscrolled_p
)
14083 f
->already_hscrolled_p
= true;
14084 if (hscroll_retries
<= MAX_HSCROLL_RETRIES
14085 && hscroll_windows (f
->root_window
))
14092 /* If the frame's redisplay flag was not set before
14093 we went about redisplaying its windows, but it is
14094 set now, that means we employed some redisplay
14095 optimizations inside redisplay_windows, and
14096 bypassed producing some screen lines. But if
14097 f->redisplay is now set, it might mean the old
14098 faces are no longer valid (e.g., if redisplaying
14099 some window called some Lisp which defined a new
14100 face or redefined an existing face), so trying to
14101 use them in update_frame will segfault.
14102 Therefore, we must redisplay this frame. */
14103 if (!f_redisplay_flag
&& f
->redisplay
)
14106 /* In some case (e.g., window resize), we notice
14107 only during window updating that the window
14108 content changed unpredictably (e.g., a GTK
14109 scrollbar moved) and that our previous estimation
14110 of the frame content was garbage. We have to
14111 start over. These cases should be rare, so going
14112 all the way back to the top of redisplay should
14115 Why FRAME_WINDOW_P? See
14116 https://lists.gnu.org/archive/html/emacs-devel/2016-10/msg00957.html
14119 if (FRAME_GARBAGED_P (f
) && FRAME_WINDOW_P (f
))
14122 /* Prevent various kinds of signals during display
14123 update. stdio is not robust about handling
14124 signals, which can cause an apparent I/O error. */
14125 if (interrupt_input
)
14126 unrequest_sigio ();
14129 pending
|= update_frame (f
, false, false);
14130 f
->cursor_type_changed
= false;
14131 f
->updated_p
= true;
14136 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
14140 /* Do the mark_window_display_accurate after all windows have
14141 been redisplayed because this call resets flags in buffers
14142 which are needed for proper redisplay. */
14143 FOR_EACH_FRAME (tail
, frame
)
14145 struct frame
*f
= XFRAME (frame
);
14148 f
->redisplay
= false;
14149 f
->garbaged
= false;
14150 mark_window_display_accurate (f
->root_window
, true);
14151 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
14152 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
14157 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14159 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
14160 /* Use list_of_error, not Qerror, so that
14161 we catch only errors and don't run the debugger. */
14162 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14164 redisplay_window_error
);
14165 if (update_miniwindow_p
)
14166 internal_condition_case_1 (redisplay_window_1
,
14167 FRAME_MINIBUF_WINDOW (sf
), list_of_error
,
14168 redisplay_window_error
);
14170 /* Compare desired and current matrices, perform output. */
14173 /* If fonts changed, display again. Likewise if redisplay_window_1
14174 above caused some change (e.g., a change in faces) that requires
14175 considering the entire frame again. */
14176 if (sf
->fonts_changed
|| sf
->redisplay
)
14180 /* Set this to force a more thorough redisplay.
14181 Otherwise, we might immediately loop back to the
14182 above "else-if" clause (since all the conditions that
14183 led here might still be true), and we will then
14184 infloop, because the selected-frame's redisplay flag
14185 is not (and cannot be) reset. */
14186 windows_or_buffers_changed
= 50;
14191 /* Prevent freeing of realized faces, since desired matrices are
14192 pending that reference the faces we computed and cached. */
14193 inhibit_free_realized_faces
= true;
14195 /* Prevent various kinds of signals during display update.
14196 stdio is not robust about handling signals,
14197 which can cause an apparent I/O error. */
14198 if (interrupt_input
)
14199 unrequest_sigio ();
14202 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14204 if (hscroll_retries
<= MAX_HSCROLL_RETRIES
14205 && hscroll_windows (selected_window
))
14211 XWINDOW (selected_window
)->must_be_updated_p
= true;
14212 pending
= update_frame (sf
, false, false);
14213 sf
->cursor_type_changed
= false;
14216 /* We may have called echo_area_display at the top of this
14217 function. If the echo area is on another frame, that may
14218 have put text on a frame other than the selected one, so the
14219 above call to update_frame would not have caught it. Catch
14221 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14222 struct frame
*mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14224 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14226 XWINDOW (mini_window
)->must_be_updated_p
= true;
14227 pending
|= update_frame (mini_frame
, false, false);
14228 mini_frame
->cursor_type_changed
= false;
14229 if (!pending
&& hscroll_retries
<= MAX_HSCROLL_RETRIES
14230 && hscroll_windows (mini_window
))
14238 /* If display was paused because of pending input, make sure we do a
14239 thorough update the next time. */
14242 /* Prevent the optimization at the beginning of
14243 redisplay_internal that tries a single-line update of the
14244 line containing the cursor in the selected window. */
14245 CHARPOS (this_line_start_pos
) = 0;
14247 /* Let the overlay arrow be updated the next time. */
14248 update_overlay_arrows (0);
14250 /* If we pause after scrolling, some rows in the current
14251 matrices of some windows are not valid. */
14252 if (!WINDOW_FULL_WIDTH_P (w
)
14253 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14254 update_mode_lines
= 36;
14258 if (!consider_all_windows_p
)
14260 /* This has already been done above if
14261 consider_all_windows_p is set. */
14262 if (XBUFFER (w
->contents
)->text
->redisplay
14263 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14264 /* This can happen if b->text->redisplay was set during
14266 propagate_buffer_redisplay ();
14267 mark_window_display_accurate_1 (w
, true);
14269 /* Say overlay arrows are up to date. */
14270 update_overlay_arrows (1);
14272 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14273 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14276 update_mode_lines
= 0;
14277 windows_or_buffers_changed
= 0;
14280 /* Start SIGIO interrupts coming again. Having them off during the
14281 code above makes it less likely one will discard output, but not
14282 impossible, since there might be stuff in the system buffer here.
14283 But it is much hairier to try to do anything about that. */
14284 if (interrupt_input
)
14288 /* If a frame has become visible which was not before, redisplay
14289 again, so that we display it. Expose events for such a frame
14290 (which it gets when becoming visible) don't call the parts of
14291 redisplay constructing glyphs, so simply exposing a frame won't
14292 display anything in this case. So, we have to display these
14293 frames here explicitly. */
14298 FOR_EACH_FRAME (tail
, frame
)
14300 if (XFRAME (frame
)->visible
)
14304 if (new_count
!= number_of_visible_frames
)
14305 windows_or_buffers_changed
= 52;
14308 /* Change frame size now if a change is pending. */
14309 do_pending_window_change (true);
14311 /* If we just did a pending size change, or have additional
14312 visible frames, or selected_window changed, redisplay again. */
14313 if ((windows_or_buffers_changed
&& !pending
)
14314 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14317 /* Clear the face and image caches.
14319 We used to do this only if consider_all_windows_p. But the cache
14320 needs to be cleared if a timer creates images in the current
14321 buffer (e.g. the test case in Bug#6230). */
14323 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14325 clear_face_cache (false);
14326 clear_face_cache_count
= 0;
14329 #ifdef HAVE_WINDOW_SYSTEM
14330 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14332 clear_image_caches (Qnil
);
14333 clear_image_cache_count
= 0;
14335 #endif /* HAVE_WINDOW_SYSTEM */
14339 ns_set_doc_edited ();
14341 if (interrupt_input
&& interrupts_deferred
)
14344 unbind_to (count
, Qnil
);
14349 unwind_redisplay_preserve_echo_area (void)
14351 unblock_buffer_flips ();
14354 /* Redisplay, but leave alone any recent echo area message unless
14355 another message has been requested in its place.
14357 This is useful in situations where you need to redisplay but no
14358 user action has occurred, making it inappropriate for the message
14359 area to be cleared. See tracking_off and
14360 wait_reading_process_output for examples of these situations.
14362 FROM_WHERE is an integer saying from where this function was
14363 called. This is useful for debugging. */
14366 redisplay_preserve_echo_area (int from_where
)
14368 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14371 ptrdiff_t count
= SPECPDL_INDEX ();
14372 record_unwind_protect_void (unwind_redisplay_preserve_echo_area
);
14373 block_buffer_flips ();
14376 if (!NILP (echo_area_buffer
[1]))
14378 /* We have a previously displayed message, but no current
14379 message. Redisplay the previous message. */
14380 display_last_displayed_message_p
= true;
14381 redisplay_internal ();
14382 display_last_displayed_message_p
= false;
14385 redisplay_internal ();
14387 flush_frame (SELECTED_FRAME ());
14388 unbind_to (count
, Qnil
);
14392 /* Function registered with record_unwind_protect in redisplay_internal. */
14395 unwind_redisplay (void)
14397 redisplaying_p
= false;
14398 unblock_buffer_flips ();
14402 /* Mark the display of leaf window W as accurate or inaccurate.
14403 If ACCURATE_P, mark display of W as accurate.
14404 If !ACCURATE_P, arrange for W to be redisplayed the next
14405 time redisplay_internal is called. */
14408 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14410 struct buffer
*b
= XBUFFER (w
->contents
);
14412 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14413 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14414 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14418 b
->clip_changed
= false;
14419 b
->prevent_redisplay_optimizations_p
= false;
14420 eassert (buffer_window_count (b
) > 0);
14421 /* Resetting b->text->redisplay is problematic!
14422 In order to make it safer to do it here, redisplay_internal must
14423 have copied all b->text->redisplay to their respective windows. */
14424 b
->text
->redisplay
= false;
14426 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14427 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14428 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14429 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14431 w
->current_matrix
->buffer
= b
;
14432 w
->current_matrix
->begv
= BUF_BEGV (b
);
14433 w
->current_matrix
->zv
= BUF_ZV (b
);
14435 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14436 w
->last_cursor_off_p
= w
->cursor_off_p
;
14438 if (w
== XWINDOW (selected_window
))
14439 w
->last_point
= BUF_PT (b
);
14441 w
->last_point
= marker_position (w
->pointm
);
14443 w
->window_end_valid
= true;
14444 w
->update_mode_line
= false;
14447 w
->redisplay
= !accurate_p
;
14451 /* Mark the display of windows in the window tree rooted at WINDOW as
14452 accurate or inaccurate. If ACCURATE_P, mark display of
14453 windows as accurate. If !ACCURATE_P, arrange for windows to
14454 be redisplayed the next time redisplay_internal is called. */
14457 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14461 for (; !NILP (window
); window
= w
->next
)
14463 w
= XWINDOW (window
);
14464 if (WINDOWP (w
->contents
))
14465 mark_window_display_accurate (w
->contents
, accurate_p
);
14467 mark_window_display_accurate_1 (w
, accurate_p
);
14471 update_overlay_arrows (1);
14473 /* Force a thorough redisplay the next time by setting
14474 last_arrow_position and last_arrow_string to t, which is
14475 unequal to any useful value of Voverlay_arrow_... */
14476 update_overlay_arrows (-1);
14480 /* Return value in display table DP (Lisp_Char_Table *) for character
14481 C. Since a display table doesn't have any parent, we don't have to
14482 follow parent. Do not call this function directly but use the
14483 macro DISP_CHAR_VECTOR. */
14486 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14490 if (ASCII_CHAR_P (c
))
14493 if (SUB_CHAR_TABLE_P (val
))
14494 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14500 XSETCHAR_TABLE (table
, dp
);
14501 val
= char_table_ref (table
, c
);
14508 static int buffer_flip_blocked_depth
;
14511 block_buffer_flips (void)
14513 eassert (buffer_flip_blocked_depth
>= 0);
14514 buffer_flip_blocked_depth
++;
14518 unblock_buffer_flips (void)
14520 eassert (buffer_flip_blocked_depth
> 0);
14521 if (--buffer_flip_blocked_depth
== 0)
14523 Lisp_Object tail
, frame
;
14525 FOR_EACH_FRAME (tail
, frame
)
14527 struct frame
*f
= XFRAME (frame
);
14528 if (FRAME_TERMINAL (f
)->buffer_flipping_unblocked_hook
)
14529 (*FRAME_TERMINAL (f
)->buffer_flipping_unblocked_hook
) (f
);
14536 buffer_flipping_blocked_p (void)
14538 return buffer_flip_blocked_depth
> 0;
14542 /***********************************************************************
14544 ***********************************************************************/
14546 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14549 redisplay_windows (Lisp_Object window
)
14551 while (!NILP (window
))
14553 struct window
*w
= XWINDOW (window
);
14555 if (WINDOWP (w
->contents
))
14556 redisplay_windows (w
->contents
);
14557 else if (BUFFERP (w
->contents
))
14559 displayed_buffer
= XBUFFER (w
->contents
);
14560 /* Use list_of_error, not Qerror, so that
14561 we catch only errors and don't run the debugger. */
14562 internal_condition_case_1 (redisplay_window_0
, window
,
14564 redisplay_window_error
);
14572 redisplay_window_error (Lisp_Object ignore
)
14574 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14579 redisplay_window_0 (Lisp_Object window
)
14581 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14582 redisplay_window (window
, false);
14587 redisplay_window_1 (Lisp_Object window
)
14589 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14590 redisplay_window (window
, true);
14595 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14596 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14597 which positions recorded in ROW differ from current buffer
14600 Return true iff cursor is on this row. */
14603 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14604 struct glyph_matrix
*matrix
,
14605 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14608 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14609 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14610 struct glyph
*cursor
= NULL
;
14611 /* The last known character position in row. */
14612 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14614 ptrdiff_t pt_old
= PT
- delta
;
14615 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14616 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14617 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14618 /* A glyph beyond the edge of TEXT_AREA which we should never
14620 struct glyph
*glyphs_end
= end
;
14621 /* True means we've found a match for cursor position, but that
14622 glyph has the avoid_cursor_p flag set. */
14623 bool match_with_avoid_cursor
= false;
14624 /* True means we've seen at least one glyph that came from a
14626 bool string_seen
= false;
14627 /* Largest and smallest buffer positions seen so far during scan of
14629 ptrdiff_t bpos_max
= pos_before
;
14630 ptrdiff_t bpos_min
= pos_after
;
14631 /* Last buffer position covered by an overlay string with an integer
14632 `cursor' property. */
14633 ptrdiff_t bpos_covered
= 0;
14634 /* True means the display string on which to display the cursor
14635 comes from a text property, not from an overlay. */
14636 bool string_from_text_prop
= false;
14638 /* Don't even try doing anything if called for a mode-line or
14639 header-line row, since the rest of the code isn't prepared to
14640 deal with such calamities. */
14641 eassert (!row
->mode_line_p
);
14642 if (row
->mode_line_p
)
14645 /* Skip over glyphs not having an object at the start and the end of
14646 the row. These are special glyphs like truncation marks on
14647 terminal frames. */
14648 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14650 if (!row
->reversed_p
)
14653 && NILP (glyph
->object
)
14654 && glyph
->charpos
< 0)
14656 x
+= glyph
->pixel_width
;
14660 && NILP ((end
- 1)->object
)
14661 /* CHARPOS is zero for blanks and stretch glyphs
14662 inserted by extend_face_to_end_of_line. */
14663 && (end
- 1)->charpos
<= 0)
14665 glyph_before
= glyph
- 1;
14672 /* If the glyph row is reversed, we need to process it from back
14673 to front, so swap the edge pointers. */
14674 glyphs_end
= end
= glyph
- 1;
14675 glyph
+= row
->used
[TEXT_AREA
] - 1;
14677 while (glyph
> end
+ 1
14678 && NILP (glyph
->object
)
14679 && glyph
->charpos
< 0)
14682 x
-= glyph
->pixel_width
;
14684 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14686 /* By default, in reversed rows we put the cursor on the
14687 rightmost (first in the reading order) glyph. */
14688 for (g
= end
+ 1; g
< glyph
; g
++)
14689 x
+= g
->pixel_width
;
14691 && NILP ((end
+ 1)->object
)
14692 && (end
+ 1)->charpos
<= 0)
14694 glyph_before
= glyph
+ 1;
14698 else if (row
->reversed_p
)
14700 /* In R2L rows that don't display text, put the cursor on the
14701 rightmost glyph. Case in point: an empty last line that is
14702 part of an R2L paragraph. */
14704 /* Avoid placing the cursor on the last glyph of the row, where
14705 on terminal frames we hold the vertical border between
14706 adjacent windows. */
14707 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14708 && !WINDOW_RIGHTMOST_P (w
)
14709 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14711 x
= -1; /* will be computed below, at label compute_x */
14714 /* Step 1: Try to find the glyph whose character position
14715 corresponds to point. If that's not possible, find 2 glyphs
14716 whose character positions are the closest to point, one before
14717 point, the other after it. */
14718 if (!row
->reversed_p
)
14719 while (/* not marched to end of glyph row */
14721 /* glyph was not inserted by redisplay for internal purposes */
14722 && !NILP (glyph
->object
))
14724 if (BUFFERP (glyph
->object
))
14726 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14728 if (glyph
->charpos
> bpos_max
)
14729 bpos_max
= glyph
->charpos
;
14730 if (glyph
->charpos
< bpos_min
)
14731 bpos_min
= glyph
->charpos
;
14732 if (!glyph
->avoid_cursor_p
)
14734 /* If we hit point, we've found the glyph on which to
14735 display the cursor. */
14738 match_with_avoid_cursor
= false;
14741 /* See if we've found a better approximation to
14742 POS_BEFORE or to POS_AFTER. */
14743 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14745 pos_before
= glyph
->charpos
;
14746 glyph_before
= glyph
;
14748 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14750 pos_after
= glyph
->charpos
;
14751 glyph_after
= glyph
;
14754 else if (dpos
== 0)
14755 match_with_avoid_cursor
= true;
14757 else if (STRINGP (glyph
->object
))
14759 Lisp_Object chprop
;
14760 ptrdiff_t glyph_pos
= glyph
->charpos
;
14762 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14764 if (!NILP (chprop
))
14766 /* If the string came from a `display' text property,
14767 look up the buffer position of that property and
14768 use that position to update bpos_max, as if we
14769 actually saw such a position in one of the row's
14770 glyphs. This helps with supporting integer values
14771 of `cursor' property on the display string in
14772 situations where most or all of the row's buffer
14773 text is completely covered by display properties,
14774 so that no glyph with valid buffer positions is
14775 ever seen in the row. */
14776 ptrdiff_t prop_pos
=
14777 string_buffer_position_lim (glyph
->object
, pos_before
,
14780 if (prop_pos
>= pos_before
)
14781 bpos_max
= prop_pos
;
14783 if (INTEGERP (chprop
))
14785 bpos_covered
= bpos_max
+ XINT (chprop
);
14786 /* If the `cursor' property covers buffer positions up
14787 to and including point, we should display cursor on
14788 this glyph. Note that, if a `cursor' property on one
14789 of the string's characters has an integer value, we
14790 will break out of the loop below _before_ we get to
14791 the position match above. IOW, integer values of
14792 the `cursor' property override the "exact match for
14793 point" strategy of positioning the cursor. */
14794 /* Implementation note: bpos_max == pt_old when, e.g.,
14795 we are in an empty line, where bpos_max is set to
14796 MATRIX_ROW_START_CHARPOS, see above. */
14797 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14804 string_seen
= true;
14806 x
+= glyph
->pixel_width
;
14809 else if (glyph
> end
) /* row is reversed */
14810 while (!NILP (glyph
->object
))
14812 if (BUFFERP (glyph
->object
))
14814 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14816 if (glyph
->charpos
> bpos_max
)
14817 bpos_max
= glyph
->charpos
;
14818 if (glyph
->charpos
< bpos_min
)
14819 bpos_min
= glyph
->charpos
;
14820 if (!glyph
->avoid_cursor_p
)
14824 match_with_avoid_cursor
= false;
14827 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14829 pos_before
= glyph
->charpos
;
14830 glyph_before
= glyph
;
14832 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14834 pos_after
= glyph
->charpos
;
14835 glyph_after
= glyph
;
14838 else if (dpos
== 0)
14839 match_with_avoid_cursor
= true;
14841 else if (STRINGP (glyph
->object
))
14843 Lisp_Object chprop
;
14844 ptrdiff_t glyph_pos
= glyph
->charpos
;
14846 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14848 if (!NILP (chprop
))
14850 ptrdiff_t prop_pos
=
14851 string_buffer_position_lim (glyph
->object
, pos_before
,
14854 if (prop_pos
>= pos_before
)
14855 bpos_max
= prop_pos
;
14857 if (INTEGERP (chprop
))
14859 bpos_covered
= bpos_max
+ XINT (chprop
);
14860 /* If the `cursor' property covers buffer positions up
14861 to and including point, we should display cursor on
14863 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14869 string_seen
= true;
14872 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14874 x
--; /* can't use any pixel_width */
14877 x
-= glyph
->pixel_width
;
14880 /* Step 2: If we didn't find an exact match for point, we need to
14881 look for a proper place to put the cursor among glyphs between
14882 GLYPH_BEFORE and GLYPH_AFTER. */
14883 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14884 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14885 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14887 /* An empty line has a single glyph whose OBJECT is nil and
14888 whose CHARPOS is the position of a newline on that line.
14889 Note that on a TTY, there are more glyphs after that, which
14890 were produced by extend_face_to_end_of_line, but their
14891 CHARPOS is zero or negative. */
14892 bool empty_line_p
=
14893 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14894 && NILP (glyph
->object
) && glyph
->charpos
> 0
14895 /* On a TTY, continued and truncated rows also have a glyph at
14896 their end whose OBJECT is nil and whose CHARPOS is
14897 positive (the continuation and truncation glyphs), but such
14898 rows are obviously not "empty". */
14899 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14901 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14903 ptrdiff_t ellipsis_pos
;
14905 /* Scan back over the ellipsis glyphs. */
14906 if (!row
->reversed_p
)
14908 ellipsis_pos
= (glyph
- 1)->charpos
;
14909 while (glyph
> row
->glyphs
[TEXT_AREA
]
14910 && (glyph
- 1)->charpos
== ellipsis_pos
)
14911 glyph
--, x
-= glyph
->pixel_width
;
14912 /* That loop always goes one position too far, including
14913 the glyph before the ellipsis. So scan forward over
14915 x
+= glyph
->pixel_width
;
14918 else /* row is reversed */
14920 ellipsis_pos
= (glyph
+ 1)->charpos
;
14921 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14922 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14923 glyph
++, x
+= glyph
->pixel_width
;
14924 x
-= glyph
->pixel_width
;
14928 else if (match_with_avoid_cursor
)
14930 cursor
= glyph_after
;
14933 else if (string_seen
)
14935 int incr
= row
->reversed_p
? -1 : +1;
14937 /* Need to find the glyph that came out of a string which is
14938 present at point. That glyph is somewhere between
14939 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14940 positioned between POS_BEFORE and POS_AFTER in the
14942 struct glyph
*start
, *stop
;
14943 ptrdiff_t pos
= pos_before
;
14947 /* If the row ends in a newline from a display string,
14948 reordering could have moved the glyphs belonging to the
14949 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14950 in this case we extend the search to the last glyph in
14951 the row that was not inserted by redisplay. */
14952 if (row
->ends_in_newline_from_string_p
)
14955 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14958 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14959 correspond to POS_BEFORE and POS_AFTER, respectively. We
14960 need START and STOP in the order that corresponds to the
14961 row's direction as given by its reversed_p flag. If the
14962 directionality of characters between POS_BEFORE and
14963 POS_AFTER is the opposite of the row's base direction,
14964 these characters will have been reordered for display,
14965 and we need to reverse START and STOP. */
14966 if (!row
->reversed_p
)
14968 start
= min (glyph_before
, glyph_after
);
14969 stop
= max (glyph_before
, glyph_after
);
14973 start
= max (glyph_before
, glyph_after
);
14974 stop
= min (glyph_before
, glyph_after
);
14976 for (glyph
= start
+ incr
;
14977 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14980 /* Any glyphs that come from the buffer are here because
14981 of bidi reordering. Skip them, and only pay
14982 attention to glyphs that came from some string. */
14983 if (STRINGP (glyph
->object
))
14987 /* If the display property covers the newline, we
14988 need to search for it one position farther. */
14989 ptrdiff_t lim
= pos_after
14990 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14992 string_from_text_prop
= false;
14993 str
= glyph
->object
;
14994 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14995 if (tem
== 0 /* from overlay */
14998 /* If the string from which this glyph came is
14999 found in the buffer at point, or at position
15000 that is closer to point than pos_after, then
15001 we've found the glyph we've been looking for.
15002 If it comes from an overlay (tem == 0), and
15003 it has the `cursor' property on one of its
15004 glyphs, record that glyph as a candidate for
15005 displaying the cursor. (As in the
15006 unidirectional version, we will display the
15007 cursor on the last candidate we find.) */
15010 || (tem
- pt_old
> 0 && tem
< pos_after
))
15012 /* The glyphs from this string could have
15013 been reordered. Find the one with the
15014 smallest string position. Or there could
15015 be a character in the string with the
15016 `cursor' property, which means display
15017 cursor on that character's glyph. */
15018 ptrdiff_t strpos
= glyph
->charpos
;
15023 string_from_text_prop
= true;
15026 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
15027 && EQ (glyph
->object
, str
);
15031 ptrdiff_t gpos
= glyph
->charpos
;
15033 cprop
= Fget_char_property (make_number (gpos
),
15041 if (tem
&& glyph
->charpos
< strpos
)
15043 strpos
= glyph
->charpos
;
15049 || (tem
- pt_old
> 0 && tem
< pos_after
))
15053 pos
= tem
+ 1; /* don't find previous instances */
15055 /* This string is not what we want; skip all of the
15056 glyphs that came from it. */
15057 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
15058 && EQ (glyph
->object
, str
))
15065 /* If we reached the end of the line, and END was from a string,
15066 the cursor is not on this line. */
15068 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
15069 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
15070 && STRINGP (end
->object
)
15071 && row
->continued_p
)
15074 /* A truncated row may not include PT among its character positions.
15075 Setting the cursor inside the scroll margin will trigger
15076 recalculation of hscroll in hscroll_window_tree. But if a
15077 display string covers point, defer to the string-handling
15078 code below to figure this out. */
15079 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
15081 cursor
= glyph_before
;
15084 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
15085 /* Zero-width characters produce no glyphs. */
15087 && (row
->reversed_p
15088 ? glyph_after
> glyphs_end
15089 : glyph_after
< glyphs_end
)))
15091 cursor
= glyph_after
;
15097 if (cursor
!= NULL
)
15099 else if (glyph
== glyphs_end
15100 && pos_before
== pos_after
15101 && STRINGP ((row
->reversed_p
15102 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
15103 : row
->glyphs
[TEXT_AREA
])->object
))
15105 /* If all the glyphs of this row came from strings, put the
15106 cursor on the first glyph of the row. This avoids having the
15107 cursor outside of the text area in this very rare and hard
15111 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
15112 : row
->glyphs
[TEXT_AREA
];
15118 /* Need to compute x that corresponds to GLYPH. */
15119 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
15121 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
15123 x
+= g
->pixel_width
;
15127 /* ROW could be part of a continued line, which, under bidi
15128 reordering, might have other rows whose start and end charpos
15129 occlude point. Only set w->cursor if we found a better
15130 approximation to the cursor position than we have from previously
15131 examined candidate rows belonging to the same continued line. */
15132 if (/* We already have a candidate row. */
15133 w
->cursor
.vpos
>= 0
15134 /* That candidate is not the row we are processing. */
15135 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
15136 /* Make sure cursor.vpos specifies a row whose start and end
15137 charpos occlude point, and it is valid candidate for being a
15138 cursor-row. This is because some callers of this function
15139 leave cursor.vpos at the row where the cursor was displayed
15140 during the last redisplay cycle. */
15141 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
15142 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15143 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
15146 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
15148 /* Don't consider glyphs that are outside TEXT_AREA. */
15149 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
15151 /* Keep the candidate whose buffer position is the closest to
15152 point or has the `cursor' property. */
15153 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
15154 w
->cursor
.hpos
>= 0
15155 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
15156 && ((BUFFERP (g1
->object
)
15157 && (g1
->charpos
== pt_old
/* An exact match always wins. */
15158 || (BUFFERP (glyph
->object
)
15159 && eabs (g1
->charpos
- pt_old
)
15160 < eabs (glyph
->charpos
- pt_old
))))
15161 /* Previous candidate is a glyph from a string that has
15162 a non-nil `cursor' property. */
15163 || (STRINGP (g1
->object
)
15164 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
15165 Qcursor
, g1
->object
))
15166 /* Previous candidate is from the same display
15167 string as this one, and the display string
15168 came from a text property. */
15169 || (EQ (g1
->object
, glyph
->object
)
15170 && string_from_text_prop
)
15171 /* this candidate is from newline and its
15172 position is not an exact match */
15173 || (NILP (glyph
->object
)
15174 && glyph
->charpos
!= pt_old
)))))
15176 /* If this candidate gives an exact match, use that. */
15177 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
15178 /* If this candidate is a glyph created for the
15179 terminating newline of a line, and point is on that
15180 newline, it wins because it's an exact match. */
15181 || (!row
->continued_p
15182 && NILP (glyph
->object
)
15183 && glyph
->charpos
== 0
15184 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
15185 /* Otherwise, keep the candidate that comes from a row
15186 spanning less buffer positions. This may win when one or
15187 both candidate positions are on glyphs that came from
15188 display strings, for which we cannot compare buffer
15190 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15191 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
15192 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
15195 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
15197 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
15198 w
->cursor
.y
= row
->y
+ dy
;
15200 if (w
== XWINDOW (selected_window
))
15202 if (!row
->continued_p
15203 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15206 this_line_buffer
= XBUFFER (w
->contents
);
15208 CHARPOS (this_line_start_pos
)
15209 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
15210 BYTEPOS (this_line_start_pos
)
15211 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
15213 CHARPOS (this_line_end_pos
)
15214 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
15215 BYTEPOS (this_line_end_pos
)
15216 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
15218 this_line_y
= w
->cursor
.y
;
15219 this_line_pixel_height
= row
->height
;
15220 this_line_vpos
= w
->cursor
.vpos
;
15221 this_line_start_x
= row
->x
;
15224 CHARPOS (this_line_start_pos
) = 0;
15231 /* Run window scroll functions, if any, for WINDOW with new window
15232 start STARTP. Sets the window start of WINDOW to that position.
15234 We assume that the window's buffer is really current. */
15236 static struct text_pos
15237 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15239 struct window
*w
= XWINDOW (window
);
15240 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15242 eassert (current_buffer
== XBUFFER (w
->contents
));
15244 if (!NILP (Vwindow_scroll_functions
))
15246 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15247 make_number (CHARPOS (startp
)));
15248 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15249 /* In case the hook functions switch buffers. */
15250 set_buffer_internal (XBUFFER (w
->contents
));
15257 /* Make sure the line containing the cursor is fully visible.
15258 A value of true means there is nothing to be done.
15259 (Either the line is fully visible, or it cannot be made so,
15260 or we cannot tell.)
15262 If FORCE_P, return false even if partial visible cursor row
15263 is higher than window.
15265 If CURRENT_MATRIX_P, use the information from the
15266 window's current glyph matrix; otherwise use the desired glyph
15269 A value of false means the caller should do scrolling
15270 as if point had gone off the screen. */
15273 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
15274 bool current_matrix_p
)
15276 struct glyph_matrix
*matrix
;
15277 struct glyph_row
*row
;
15280 if (!make_cursor_line_fully_visible_p
)
15283 /* It's not always possible to find the cursor, e.g, when a window
15284 is full of overlay strings. Don't do anything in that case. */
15285 if (w
->cursor
.vpos
< 0)
15288 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15289 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15291 /* If the cursor row is not partially visible, there's nothing to do. */
15292 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15295 /* If the row the cursor is in is taller than the window's height,
15296 it's not clear what to do, so do nothing. */
15297 window_height
= window_box_height (w
);
15298 if (row
->height
>= window_height
)
15300 if (!force_p
|| MINI_WINDOW_P (w
)
15301 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15308 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15309 means only WINDOW is redisplayed in redisplay_internal.
15310 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15311 in redisplay_window to bring a partially visible line into view in
15312 the case that only the cursor has moved.
15314 LAST_LINE_MISFIT should be true if we're scrolling because the
15315 last screen line's vertical height extends past the end of the screen.
15319 1 if scrolling succeeded
15321 0 if scrolling didn't find point.
15323 -1 if new fonts have been loaded so that we must interrupt
15324 redisplay, adjust glyph matrices, and try again. */
15330 SCROLLING_NEED_LARGER_MATRICES
15333 /* If scroll-conservatively is more than this, never recenter.
15335 If you change this, don't forget to update the doc string of
15336 `scroll-conservatively' and the Emacs manual. */
15337 #define SCROLL_LIMIT 100
15340 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15341 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15342 bool temp_scroll_step
, bool last_line_misfit
)
15344 struct window
*w
= XWINDOW (window
);
15345 struct text_pos pos
, startp
;
15347 int this_scroll_margin
, scroll_max
, rc
, height
;
15348 int dy
= 0, amount_to_scroll
= 0;
15349 bool scroll_down_p
= false;
15350 int extra_scroll_margin_lines
= last_line_misfit
;
15351 Lisp_Object aggressive
;
15352 /* We will never try scrolling more than this number of lines. */
15353 int scroll_limit
= SCROLL_LIMIT
;
15354 int frame_line_height
= default_line_pixel_height (w
);
15357 debug_method_add (w
, "try_scrolling");
15360 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15362 this_scroll_margin
= window_scroll_margin (w
, MARGIN_IN_PIXELS
);
15364 /* Force arg_scroll_conservatively to have a reasonable value, to
15365 avoid scrolling too far away with slow move_it_* functions. Note
15366 that the user can supply scroll-conservatively equal to
15367 `most-positive-fixnum', which can be larger than INT_MAX. */
15368 if (arg_scroll_conservatively
> scroll_limit
)
15370 arg_scroll_conservatively
= scroll_limit
+ 1;
15371 scroll_max
= scroll_limit
* frame_line_height
;
15373 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15374 /* Compute how much we should try to scroll maximally to bring
15375 point into view. */
15376 scroll_max
= (max (scroll_step
,
15377 max (arg_scroll_conservatively
, temp_scroll_step
))
15378 * frame_line_height
);
15379 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15380 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15381 /* We're trying to scroll because of aggressive scrolling but no
15382 scroll_step is set. Choose an arbitrary one. */
15383 scroll_max
= 10 * frame_line_height
;
15389 /* Decide whether to scroll down. */
15390 if (PT
> CHARPOS (startp
))
15392 int scroll_margin_y
;
15394 /* Compute the pixel ypos of the scroll margin, then move IT to
15395 either that ypos or PT, whichever comes first. */
15396 start_display (&it
, w
, startp
);
15397 scroll_margin_y
= it
.last_visible_y
- partial_line_height (&it
)
15398 - this_scroll_margin
15399 - frame_line_height
* extra_scroll_margin_lines
;
15400 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15401 (MOVE_TO_POS
| MOVE_TO_Y
));
15403 if (PT
> CHARPOS (it
.current
.pos
))
15405 int y0
= line_bottom_y (&it
);
15406 /* Compute how many pixels below window bottom to stop searching
15407 for PT. This avoids costly search for PT that is far away if
15408 the user limited scrolling by a small number of lines, but
15409 always finds PT if scroll_conservatively is set to a large
15410 number, such as most-positive-fixnum. */
15411 int slack
= max (scroll_max
, 10 * frame_line_height
);
15412 int y_to_move
= it
.last_visible_y
+ slack
;
15414 /* Compute the distance from the scroll margin to PT or to
15415 the scroll limit, whichever comes first. This should
15416 include the height of the cursor line, to make that line
15418 move_it_to (&it
, PT
, -1, y_to_move
,
15419 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15420 dy
= line_bottom_y (&it
) - y0
;
15422 if (dy
> scroll_max
)
15423 return SCROLLING_FAILED
;
15426 scroll_down_p
= true;
15428 else if (PT
== IT_CHARPOS (it
)
15429 && IT_CHARPOS (it
) < ZV
15430 && it
.method
== GET_FROM_STRING
15431 && arg_scroll_conservatively
> scroll_limit
15432 && it
.current_x
== 0)
15434 enum move_it_result skip
;
15435 int y1
= it
.current_y
;
15438 /* A before-string that includes newlines and is displayed
15439 on the last visible screen line could fail us under
15440 scroll-conservatively > 100, because we will be unable to
15441 position the cursor on that last visible line. Try to
15442 recover by finding the first screen line that has some
15443 glyphs coming from the buffer text. */
15445 skip
= move_it_in_display_line_to (&it
, ZV
, -1, MOVE_TO_POS
);
15446 if (skip
!= MOVE_NEWLINE_OR_CR
15447 || IT_CHARPOS (it
) != PT
15448 || it
.method
== GET_FROM_BUFFER
)
15451 move_it_to (&it
, -1, -1, -1, vpos
+ 1, MOVE_TO_VPOS
);
15452 } while (it
.vpos
> vpos
);
15454 dy
= it
.current_y
- y1
;
15456 if (dy
> scroll_max
)
15457 return SCROLLING_FAILED
;
15460 scroll_down_p
= true;
15466 /* Point is in or below the bottom scroll margin, so move the
15467 window start down. If scrolling conservatively, move it just
15468 enough down to make point visible. If scroll_step is set,
15469 move it down by scroll_step. */
15470 if (arg_scroll_conservatively
)
15472 = min (max (dy
, frame_line_height
),
15473 frame_line_height
* arg_scroll_conservatively
);
15474 else if (scroll_step
|| temp_scroll_step
)
15475 amount_to_scroll
= scroll_max
;
15478 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15479 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15480 if (NUMBERP (aggressive
))
15482 double float_amount
= XFLOATINT (aggressive
) * height
;
15483 int aggressive_scroll
= float_amount
;
15484 if (aggressive_scroll
== 0 && float_amount
> 0)
15485 aggressive_scroll
= 1;
15486 /* Don't let point enter the scroll margin near top of
15487 the window. This could happen if the value of
15488 scroll_up_aggressively is too large and there are
15489 non-zero margins, because scroll_up_aggressively
15490 means put point that fraction of window height
15491 _from_the_bottom_margin_. */
15492 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15493 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15494 amount_to_scroll
= dy
+ aggressive_scroll
;
15498 if (amount_to_scroll
<= 0)
15499 return SCROLLING_FAILED
;
15501 start_display (&it
, w
, startp
);
15502 if (arg_scroll_conservatively
<= scroll_limit
)
15503 move_it_vertically (&it
, amount_to_scroll
);
15506 /* Extra precision for users who set scroll-conservatively
15507 to a large number: make sure the amount we scroll
15508 the window start is never less than amount_to_scroll,
15509 which was computed as distance from window bottom to
15510 point. This matters when lines at window top and lines
15511 below window bottom have different height. */
15513 void *it1data
= NULL
;
15514 /* We use a temporary it1 because line_bottom_y can modify
15515 its argument, if it moves one line down; see there. */
15518 SAVE_IT (it1
, it
, it1data
);
15519 start_y
= line_bottom_y (&it1
);
15521 RESTORE_IT (&it
, &it
, it1data
);
15522 move_it_by_lines (&it
, 1);
15523 SAVE_IT (it1
, it
, it1data
);
15524 } while (IT_CHARPOS (it
) < ZV
15525 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15526 bidi_unshelve_cache (it1data
, true);
15529 /* If STARTP is unchanged, move it down another screen line. */
15530 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15531 move_it_by_lines (&it
, 1);
15532 startp
= it
.current
.pos
;
15536 struct text_pos scroll_margin_pos
= startp
;
15539 /* See if point is inside the scroll margin at the top of the
15541 if (this_scroll_margin
)
15545 start_display (&it
, w
, startp
);
15546 y_start
= it
.current_y
;
15547 move_it_vertically (&it
, this_scroll_margin
);
15548 scroll_margin_pos
= it
.current
.pos
;
15549 /* If we didn't move enough before hitting ZV, request
15550 additional amount of scroll, to move point out of the
15552 if (IT_CHARPOS (it
) == ZV
15553 && it
.current_y
- y_start
< this_scroll_margin
)
15554 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15557 if (PT
< CHARPOS (scroll_margin_pos
))
15559 /* Point is in the scroll margin at the top of the window or
15560 above what is displayed in the window. */
15563 /* Compute the vertical distance from PT to the scroll
15564 margin position. Move as far as scroll_max allows, or
15565 one screenful, or 10 screen lines, whichever is largest.
15566 Give up if distance is greater than scroll_max or if we
15567 didn't reach the scroll margin position. */
15568 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15569 start_display (&it
, w
, pos
);
15571 y_to_move
= max (it
.last_visible_y
,
15572 max (scroll_max
, 10 * frame_line_height
));
15573 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15575 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15576 dy
= it
.current_y
- y0
;
15577 if (dy
> scroll_max
15578 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15579 return SCROLLING_FAILED
;
15581 /* Additional scroll for when ZV was too close to point. */
15584 /* Compute new window start. */
15585 start_display (&it
, w
, startp
);
15587 if (arg_scroll_conservatively
)
15588 amount_to_scroll
= max (dy
, frame_line_height
15589 * max (scroll_step
, temp_scroll_step
));
15590 else if (scroll_step
|| temp_scroll_step
)
15591 amount_to_scroll
= scroll_max
;
15594 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15595 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15596 if (NUMBERP (aggressive
))
15598 double float_amount
= XFLOATINT (aggressive
) * height
;
15599 int aggressive_scroll
= float_amount
;
15600 if (aggressive_scroll
== 0 && float_amount
> 0)
15601 aggressive_scroll
= 1;
15602 /* Don't let point enter the scroll margin near
15603 bottom of the window, if the value of
15604 scroll_down_aggressively happens to be too
15606 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15607 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15608 amount_to_scroll
= dy
+ aggressive_scroll
;
15612 if (amount_to_scroll
<= 0)
15613 return SCROLLING_FAILED
;
15615 move_it_vertically_backward (&it
, amount_to_scroll
);
15616 startp
= it
.current
.pos
;
15620 /* Run window scroll functions. */
15621 startp
= run_window_scroll_functions (window
, startp
);
15623 /* Display the window. Give up if new fonts are loaded, or if point
15625 if (!try_window (window
, startp
, 0))
15626 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15627 else if (w
->cursor
.vpos
< 0)
15629 clear_glyph_matrix (w
->desired_matrix
);
15630 rc
= SCROLLING_FAILED
;
15634 /* Maybe forget recorded base line for line number display. */
15635 if (!just_this_one_p
15636 || current_buffer
->clip_changed
15637 || BEG_UNCHANGED
< CHARPOS (startp
))
15638 w
->base_line_number
= 0;
15640 /* If cursor ends up on a partially visible line,
15641 treat that as being off the bottom of the screen. */
15642 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15644 /* It's possible that the cursor is on the first line of the
15645 buffer, which is partially obscured due to a vscroll
15646 (Bug#7537). In that case, avoid looping forever. */
15647 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15649 clear_glyph_matrix (w
->desired_matrix
);
15650 ++extra_scroll_margin_lines
;
15653 rc
= SCROLLING_SUCCESS
;
15660 /* Compute a suitable window start for window W if display of W starts
15661 on a continuation line. Value is true if a new window start
15664 The new window start will be computed, based on W's width, starting
15665 from the start of the continued line. It is the start of the
15666 screen line with the minimum distance from the old start W->start,
15667 which is still before point (otherwise point will definitely not
15668 be visible in the window). */
15671 compute_window_start_on_continuation_line (struct window
*w
)
15673 struct text_pos pos
, start_pos
, pos_before_pt
;
15674 bool window_start_changed_p
= false;
15676 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15678 /* If window start is on a continuation line... Window start may be
15679 < BEGV in case there's invisible text at the start of the
15680 buffer (M-x rmail, for example). */
15681 if (CHARPOS (start_pos
) > BEGV
15682 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15685 struct glyph_row
*row
;
15687 /* Handle the case that the window start is out of range. */
15688 if (CHARPOS (start_pos
) < BEGV
)
15689 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15690 else if (CHARPOS (start_pos
) > ZV
)
15691 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15693 /* Find the start of the continued line. This should be fast
15694 because find_newline is fast (newline cache). */
15695 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15696 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15697 row
, DEFAULT_FACE_ID
);
15698 reseat_at_previous_visible_line_start (&it
);
15700 /* If the line start is "too far" away from the window start,
15701 say it takes too much time to compute a new window start.
15702 Also, give up if the line start is after point, as in that
15703 case point will not be visible with any window start we
15705 if (IT_CHARPOS (it
) <= PT
15706 || (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15707 /* PXW: Do we need upper bounds here? */
15708 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
)))
15710 int min_distance
, distance
;
15712 /* Move forward by display lines to find the new window
15713 start. If window width was enlarged, the new start can
15714 be expected to be > the old start. If window width was
15715 decreased, the new window start will be < the old start.
15716 So, we're looking for the display line start with the
15717 minimum distance from the old window start. */
15718 pos_before_pt
= pos
= it
.current
.pos
;
15719 min_distance
= INFINITY
;
15720 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15721 distance
< min_distance
)
15723 min_distance
= distance
;
15724 if (CHARPOS (pos
) <= PT
)
15725 pos_before_pt
= pos
;
15726 pos
= it
.current
.pos
;
15727 if (it
.line_wrap
== WORD_WRAP
)
15729 /* Under WORD_WRAP, move_it_by_lines is likely to
15730 overshoot and stop not at the first, but the
15731 second character from the left margin. So in
15732 that case, we need a more tight control on the X
15733 coordinate of the iterator than move_it_by_lines
15734 promises in its contract. The method is to first
15735 go to the last (rightmost) visible character of a
15736 line, then move to the leftmost character on the
15737 next line in a separate call. */
15738 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15739 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15740 move_it_to (&it
, ZV
, 0,
15741 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15742 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15745 move_it_by_lines (&it
, 1);
15748 /* It makes very little sense to make the new window start
15749 after point, as point won't be visible. If that's what
15750 the loop above finds, fall back on the candidate before
15751 or at point that is closest to the old window start. */
15752 if (CHARPOS (pos
) > PT
)
15753 pos
= pos_before_pt
;
15755 /* Set the window start there. */
15756 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15757 window_start_changed_p
= true;
15761 return window_start_changed_p
;
15765 /* Try cursor movement in case text has not changed in window WINDOW,
15766 with window start STARTP. Value is
15768 CURSOR_MOVEMENT_SUCCESS if successful
15770 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15772 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15773 display. *SCROLL_STEP is set to true, under certain circumstances, if
15774 we want to scroll as if scroll-step were set to 1. See the code.
15776 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15777 which case we have to abort this redisplay, and adjust matrices
15782 CURSOR_MOVEMENT_SUCCESS
,
15783 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15784 CURSOR_MOVEMENT_MUST_SCROLL
,
15785 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15789 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15792 struct window
*w
= XWINDOW (window
);
15793 struct frame
*f
= XFRAME (w
->frame
);
15794 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15797 if (inhibit_try_cursor_movement
)
15801 /* Previously, there was a check for Lisp integer in the
15802 if-statement below. Now, this field is converted to
15803 ptrdiff_t, thus zero means invalid position in a buffer. */
15804 eassert (w
->last_point
> 0);
15805 /* Likewise there was a check whether window_end_vpos is nil or larger
15806 than the window. Now window_end_vpos is int and so never nil, but
15807 let's leave eassert to check whether it fits in the window. */
15808 eassert (!w
->window_end_valid
15809 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15811 /* Handle case where text has not changed, only point, and it has
15812 not moved off the frame. */
15813 if (/* Point may be in this window. */
15814 PT
>= CHARPOS (startp
)
15815 /* Selective display hasn't changed. */
15816 && !current_buffer
->clip_changed
15817 /* Function force-mode-line-update is used to force a thorough
15818 redisplay. It sets either windows_or_buffers_changed or
15819 update_mode_lines. So don't take a shortcut here for these
15821 && !update_mode_lines
15822 && !windows_or_buffers_changed
15823 && !f
->cursor_type_changed
15824 && NILP (Vshow_trailing_whitespace
)
15825 /* This code is not used for mini-buffer for the sake of the case
15826 of redisplaying to replace an echo area message; since in
15827 that case the mini-buffer contents per se are usually
15828 unchanged. This code is of no real use in the mini-buffer
15829 since the handling of this_line_start_pos, etc., in redisplay
15830 handles the same cases. */
15831 && !EQ (window
, minibuf_window
)
15832 && (FRAME_WINDOW_P (f
)
15833 || !overlay_arrow_in_current_buffer_p ()))
15835 int this_scroll_margin
, top_scroll_margin
;
15836 struct glyph_row
*row
= NULL
;
15839 debug_method_add (w
, "cursor movement");
15842 this_scroll_margin
= window_scroll_margin (w
, MARGIN_IN_PIXELS
);
15844 top_scroll_margin
= this_scroll_margin
;
15845 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15846 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15848 /* Start with the row the cursor was displayed during the last
15849 not paused redisplay. Give up if that row is not valid. */
15850 if (w
->last_cursor_vpos
< 0
15851 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15852 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15855 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15856 if (row
->mode_line_p
)
15858 if (!row
->enabled_p
)
15859 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15862 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15864 bool scroll_p
= false, must_scroll
= false;
15865 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15867 if (PT
> w
->last_point
)
15869 /* Point has moved forward. */
15870 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15871 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15873 eassert (row
->enabled_p
);
15877 /* If the end position of a row equals the start
15878 position of the next row, and PT is at that position,
15879 we would rather display cursor in the next line. */
15880 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15881 && MATRIX_ROW_END_CHARPOS (row
) == PT
15882 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15883 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15884 && !cursor_row_p (row
))
15887 /* If within the scroll margin, scroll. Note that
15888 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15889 the next line would be drawn, and that
15890 this_scroll_margin can be zero. */
15891 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15892 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15893 /* Line is completely visible last line in window
15894 and PT is to be set in the next line. */
15895 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15896 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15897 && !row
->ends_at_zv_p
15898 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15901 else if (PT
< w
->last_point
)
15903 /* Cursor has to be moved backward. Note that PT >=
15904 CHARPOS (startp) because of the outer if-statement. */
15905 while (!row
->mode_line_p
15906 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15907 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15908 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15909 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15910 row
> w
->current_matrix
->rows
15911 && (row
-1)->ends_in_newline_from_string_p
))))
15912 && (row
->y
> top_scroll_margin
15913 || CHARPOS (startp
) == BEGV
))
15915 eassert (row
->enabled_p
);
15919 /* Consider the following case: Window starts at BEGV,
15920 there is invisible, intangible text at BEGV, so that
15921 display starts at some point START > BEGV. It can
15922 happen that we are called with PT somewhere between
15923 BEGV and START. Try to handle that case. */
15924 if (row
< w
->current_matrix
->rows
15925 || row
->mode_line_p
)
15927 row
= w
->current_matrix
->rows
;
15928 if (row
->mode_line_p
)
15932 /* Due to newlines in overlay strings, we may have to
15933 skip forward over overlay strings. */
15934 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15935 && MATRIX_ROW_END_CHARPOS (row
) == PT
15936 && !cursor_row_p (row
))
15939 /* If within the scroll margin, scroll. */
15940 if (row
->y
< top_scroll_margin
15941 && CHARPOS (startp
) != BEGV
)
15946 /* Cursor did not move. So don't scroll even if cursor line
15947 is partially visible, as it was so before. */
15948 rc
= CURSOR_MOVEMENT_SUCCESS
;
15951 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15952 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15954 /* if PT is not in the glyph row, give up. */
15955 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15956 must_scroll
= true;
15958 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15959 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15961 struct glyph_row
*row1
;
15963 /* If rows are bidi-reordered and point moved, back up
15964 until we find a row that does not belong to a
15965 continuation line. This is because we must consider
15966 all rows of a continued line as candidates for the
15967 new cursor positioning, since row start and end
15968 positions change non-linearly with vertical position
15970 /* FIXME: Revisit this when glyph ``spilling'' in
15971 continuation lines' rows is implemented for
15972 bidi-reordered rows. */
15973 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15974 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15977 /* If we hit the beginning of the displayed portion
15978 without finding the first row of a continued
15982 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15985 eassert (row
->enabled_p
);
15990 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15991 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15992 /* Make sure this isn't a header line by any chance, since
15993 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15994 && !row
->mode_line_p
15995 && make_cursor_line_fully_visible_p
)
15997 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15998 && !row
->ends_at_zv_p
15999 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16000 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
16001 else if (row
->height
> window_box_height (w
))
16003 /* If we end up in a partially visible line, let's
16004 make it fully visible, except when it's taller
16005 than the window, in which case we can't do much
16007 *scroll_step
= true;
16008 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
16012 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16013 if (!cursor_row_fully_visible_p (w
, false, true))
16014 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
16016 rc
= CURSOR_MOVEMENT_SUCCESS
;
16020 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
16021 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
16022 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
16024 /* With bidi-reordered rows, there could be more than
16025 one candidate row whose start and end positions
16026 occlude point. We need to let set_cursor_from_row
16027 find the best candidate. */
16028 /* FIXME: Revisit this when glyph ``spilling'' in
16029 continuation lines' rows is implemented for
16030 bidi-reordered rows. */
16035 bool at_zv_p
= false, exact_match_p
= false;
16037 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
16038 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
16039 && cursor_row_p (row
))
16040 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
16042 /* As soon as we've found the exact match for point,
16043 or the first suitable row whose ends_at_zv_p flag
16044 is set, we are done. */
16047 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
16048 w
->cursor
.vpos
)->ends_at_zv_p
;
16050 && w
->cursor
.hpos
>= 0
16051 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
16054 struct glyph_row
*candidate
=
16055 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16057 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16058 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
16061 (BUFFERP (g
->object
) && g
->charpos
== PT
)
16062 || (NILP (g
->object
)
16063 && (g
->charpos
== PT
16064 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
16066 if (at_zv_p
|| exact_match_p
)
16068 rc
= CURSOR_MOVEMENT_SUCCESS
;
16072 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
16076 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
16077 || row
->continued_p
)
16078 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
16079 || (MATRIX_ROW_START_CHARPOS (row
) == PT
16080 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
16081 /* If we didn't find any candidate rows, or exited the
16082 loop before all the candidates were examined, signal
16083 to the caller that this method failed. */
16084 if (rc
!= CURSOR_MOVEMENT_SUCCESS
16086 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
16087 && !row
->continued_p
))
16088 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
16090 rc
= CURSOR_MOVEMENT_SUCCESS
;
16096 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
16098 rc
= CURSOR_MOVEMENT_SUCCESS
;
16103 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
16104 && MATRIX_ROW_START_CHARPOS (row
) == PT
16105 && cursor_row_p (row
));
16115 set_vertical_scroll_bar (struct window
*w
)
16117 ptrdiff_t start
, end
, whole
;
16119 /* Calculate the start and end positions for the current window.
16120 At some point, it would be nice to choose between scrollbars
16121 which reflect the whole buffer size, with special markers
16122 indicating narrowing, and scrollbars which reflect only the
16125 Note that mini-buffers sometimes aren't displaying any text. */
16126 if (!MINI_WINDOW_P (w
)
16127 || (w
== XWINDOW (minibuf_window
)
16128 && NILP (echo_area_buffer
[0])))
16130 struct buffer
*buf
= XBUFFER (w
->contents
);
16131 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
16132 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
16133 /* I don't think this is guaranteed to be right. For the
16134 moment, we'll pretend it is. */
16135 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
16139 if (whole
< (end
- start
))
16140 whole
= end
- start
;
16143 start
= end
= whole
= 0;
16145 /* Indicate what this scroll bar ought to be displaying now. */
16146 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
16147 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
16148 (w
, end
- start
, whole
, start
);
16153 set_horizontal_scroll_bar (struct window
*w
)
16155 int start
, end
, whole
, portion
;
16157 if (!MINI_WINDOW_P (w
)
16158 || (w
== XWINDOW (minibuf_window
)
16159 && NILP (echo_area_buffer
[0])))
16161 struct buffer
*b
= XBUFFER (w
->contents
);
16162 struct buffer
*old_buffer
= NULL
;
16164 struct text_pos startp
;
16166 if (b
!= current_buffer
)
16168 old_buffer
= current_buffer
;
16169 set_buffer_internal (b
);
16172 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16173 start_display (&it
, w
, startp
);
16174 it
.last_visible_x
= INT_MAX
;
16175 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
16176 MOVE_TO_X
| MOVE_TO_Y
);
16177 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
16178 window_box_height (w), -1,
16179 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
16181 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
16182 end
= start
+ window_box_width (w
, TEXT_AREA
);
16183 portion
= end
- start
;
16184 /* After enlarging a horizontally scrolled window such that it
16185 gets at least as wide as the text it contains, make sure that
16186 the thumb doesn't fill the entire scroll bar so we can still
16187 drag it back to see the entire text. */
16188 whole
= max (whole
, end
);
16194 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
16195 if (EQ (pdir
, Qright_to_left
))
16197 start
= whole
- end
;
16198 end
= start
+ portion
;
16203 set_buffer_internal (old_buffer
);
16206 start
= end
= whole
= portion
= 0;
16208 w
->hscroll_whole
= whole
;
16210 /* Indicate what this scroll bar ought to be displaying now. */
16211 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16212 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
16213 (w
, portion
, whole
, start
);
16217 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
16218 selected_window is redisplayed.
16220 We can return without actually redisplaying the window if fonts has been
16221 changed on window's frame. In that case, redisplay_internal will retry.
16223 As one of the important parts of redisplaying a window, we need to
16224 decide whether the previous window-start position (stored in the
16225 window's w->start marker position) is still valid, and if it isn't,
16226 recompute it. Some details about that:
16228 . The previous window-start could be in a continuation line, in
16229 which case we need to recompute it when the window width
16230 changes. See compute_window_start_on_continuation_line and its
16233 . The text that changed since last redisplay could include the
16234 previous window-start position. In that case, we try to salvage
16235 what we can from the current glyph matrix by calling
16236 try_scrolling, which see.
16238 . Some Emacs command could force us to use a specific window-start
16239 position by setting the window's force_start flag, or gently
16240 propose doing that by setting the window's optional_new_start
16241 flag. In these cases, we try using the specified start point if
16242 that succeeds (i.e. the window desired matrix is successfully
16243 recomputed, and point location is within the window). In case
16244 of optional_new_start, we first check if the specified start
16245 position is feasible, i.e. if it will allow point to be
16246 displayed in the window. If using the specified start point
16247 fails, e.g., if new fonts are needed to be loaded, we abort the
16248 redisplay cycle and leave it up to the next cycle to figure out
16251 . Note that the window's force_start flag is sometimes set by
16252 redisplay itself, when it decides that the previous window start
16253 point is fine and should be kept. Search for "goto force_start"
16254 below to see the details. Like the values of window-start
16255 specified outside of redisplay, these internally-deduced values
16256 are tested for feasibility, and ignored if found to be
16259 . Note that the function try_window, used to completely redisplay
16260 a window, accepts the window's start point as its argument.
16261 This is used several times in the redisplay code to control
16262 where the window start will be, according to user options such
16263 as scroll-conservatively, and also to ensure the screen line
16264 showing point will be fully (as opposed to partially) visible on
16268 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
16270 struct window
*w
= XWINDOW (window
);
16271 struct frame
*f
= XFRAME (w
->frame
);
16272 struct buffer
*buffer
= XBUFFER (w
->contents
);
16273 struct buffer
*old
= current_buffer
;
16274 struct text_pos lpoint
, opoint
, startp
;
16275 bool update_mode_line
;
16278 /* Record it now because it's overwritten. */
16279 bool current_matrix_up_to_date_p
= false;
16280 bool used_current_matrix_p
= false;
16281 /* This is less strict than current_matrix_up_to_date_p.
16282 It indicates that the buffer contents and narrowing are unchanged. */
16283 bool buffer_unchanged_p
= false;
16284 bool temp_scroll_step
= false;
16285 ptrdiff_t count
= SPECPDL_INDEX ();
16287 int centering_position
= -1;
16288 bool last_line_misfit
= false;
16289 ptrdiff_t beg_unchanged
, end_unchanged
;
16290 int frame_line_height
, margin
;
16291 bool use_desired_matrix
;
16292 void *itdata
= NULL
;
16294 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16298 *w
->desired_matrix
->method
= 0;
16301 if (!just_this_one_p
16302 && REDISPLAY_SOME_P ()
16304 && !w
->update_mode_line
16307 && !buffer
->text
->redisplay
16308 && BUF_PT (buffer
) == w
->last_point
)
16311 /* Make sure that both W's markers are valid. */
16312 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16313 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16315 /* We come here again if we need to run window-text-change-functions
16318 reconsider_clip_changes (w
);
16319 frame_line_height
= default_line_pixel_height (w
);
16320 margin
= window_scroll_margin (w
, MARGIN_IN_LINES
);
16323 /* Has the mode line to be updated? */
16324 update_mode_line
= (w
->update_mode_line
16325 || update_mode_lines
16326 || buffer
->clip_changed
16327 || buffer
->prevent_redisplay_optimizations_p
);
16329 if (!just_this_one_p
)
16330 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16331 cleverly elsewhere. */
16332 w
->must_be_updated_p
= true;
16334 if (MINI_WINDOW_P (w
))
16336 if (w
== XWINDOW (echo_area_window
)
16337 && !NILP (echo_area_buffer
[0]))
16339 if (update_mode_line
)
16340 /* We may have to update a tty frame's menu bar or a
16341 tool-bar. Example `M-x C-h C-h C-g'. */
16342 goto finish_menu_bars
;
16344 /* We've already displayed the echo area glyphs in this window. */
16345 goto finish_scroll_bars
;
16347 else if ((w
!= XWINDOW (minibuf_window
)
16348 || minibuf_level
== 0)
16349 /* When buffer is nonempty, redisplay window normally. */
16350 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16351 /* Quail displays non-mini buffers in minibuffer window.
16352 In that case, redisplay the window normally. */
16353 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16355 /* W is a mini-buffer window, but it's not active, so clear
16357 int yb
= window_text_bottom_y (w
);
16358 struct glyph_row
*row
;
16361 for (y
= 0, row
= w
->desired_matrix
->rows
;
16363 y
+= row
->height
, ++row
)
16364 blank_row (w
, row
, y
);
16365 goto finish_scroll_bars
;
16368 clear_glyph_matrix (w
->desired_matrix
);
16371 /* Otherwise set up data on this window; select its buffer and point
16373 /* Really select the buffer, for the sake of buffer-local
16375 set_buffer_internal_1 (XBUFFER (w
->contents
));
16377 current_matrix_up_to_date_p
16378 = (w
->window_end_valid
16379 && !current_buffer
->clip_changed
16380 && !current_buffer
->prevent_redisplay_optimizations_p
16381 && !window_outdated (w
));
16383 /* Run the window-text-change-functions
16384 if it is possible that the text on the screen has changed
16385 (either due to modification of the text, or any other reason). */
16386 if (!current_matrix_up_to_date_p
16387 && !NILP (Vwindow_text_change_functions
))
16389 safe_run_hooks (Qwindow_text_change_functions
);
16393 beg_unchanged
= BEG_UNCHANGED
;
16394 end_unchanged
= END_UNCHANGED
;
16396 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16398 specbind (Qinhibit_point_motion_hooks
, Qt
);
16401 = (w
->window_end_valid
16402 && !current_buffer
->clip_changed
16403 && !window_outdated (w
));
16405 /* When windows_or_buffers_changed is non-zero, we can't rely
16406 on the window end being valid, so set it to zero there. */
16407 if (windows_or_buffers_changed
)
16409 /* If window starts on a continuation line, maybe adjust the
16410 window start in case the window's width changed. */
16411 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16412 compute_window_start_on_continuation_line (w
);
16414 w
->window_end_valid
= false;
16415 /* If so, we also can't rely on current matrix
16416 and should not fool try_cursor_movement below. */
16417 current_matrix_up_to_date_p
= false;
16420 /* Some sanity checks. */
16421 CHECK_WINDOW_END (w
);
16422 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16424 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16427 if (mode_line_update_needed (w
))
16428 update_mode_line
= true;
16430 /* Point refers normally to the selected window. For any other
16431 window, set up appropriate value. */
16432 if (!EQ (window
, selected_window
))
16434 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16435 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16440 new_pt_byte
= BEGV_BYTE
;
16441 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16443 else if (new_pt
> (ZV
- 1))
16446 new_pt_byte
= ZV_BYTE
;
16447 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16450 /* We don't use SET_PT so that the point-motion hooks don't run. */
16451 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16454 /* If any of the character widths specified in the display table
16455 have changed, invalidate the width run cache. It's true that
16456 this may be a bit late to catch such changes, but the rest of
16457 redisplay goes (non-fatally) haywire when the display table is
16458 changed, so why should we worry about doing any better? */
16459 if (current_buffer
->width_run_cache
16460 || (current_buffer
->base_buffer
16461 && current_buffer
->base_buffer
->width_run_cache
))
16463 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16465 if (! disptab_matches_widthtab
16466 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16468 struct buffer
*buf
= current_buffer
;
16470 if (buf
->base_buffer
)
16471 buf
= buf
->base_buffer
;
16472 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16473 recompute_width_table (current_buffer
, disptab
);
16477 /* If window-start is screwed up, choose a new one. */
16478 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16481 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16483 /* If someone specified a new starting point but did not insist,
16484 check whether it can be used. */
16485 if ((w
->optional_new_start
|| window_frozen_p (w
))
16486 && CHARPOS (startp
) >= BEGV
16487 && CHARPOS (startp
) <= ZV
)
16489 ptrdiff_t it_charpos
;
16491 w
->optional_new_start
= false;
16492 start_display (&it
, w
, startp
);
16493 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16494 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16495 /* Record IT's position now, since line_bottom_y might change
16497 it_charpos
= IT_CHARPOS (it
);
16498 /* Make sure we set the force_start flag only if the cursor row
16499 will be fully visible. Otherwise, the code under force_start
16500 label below will try to move point back into view, which is
16501 not what the code which sets optional_new_start wants. */
16502 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16503 && !w
->force_start
)
16505 if (it_charpos
== PT
)
16506 w
->force_start
= true;
16507 /* IT may overshoot PT if text at PT is invisible. */
16508 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16509 w
->force_start
= true;
16511 if (w
->force_start
)
16513 if (window_frozen_p (w
))
16514 debug_method_add (w
, "set force_start from frozen window start");
16516 debug_method_add (w
, "set force_start from optional_new_start");
16524 /* Handle case where place to start displaying has been specified,
16525 unless the specified location is outside the accessible range. */
16526 if (w
->force_start
)
16528 /* We set this later on if we have to adjust point. */
16531 w
->force_start
= false;
16533 w
->window_end_valid
= false;
16535 /* Forget any recorded base line for line number display. */
16536 if (!buffer_unchanged_p
)
16537 w
->base_line_number
= 0;
16539 /* Redisplay the mode line. Select the buffer properly for that.
16540 Also, run the hook window-scroll-functions
16541 because we have scrolled. */
16542 /* Note, we do this after clearing force_start because
16543 if there's an error, it is better to forget about force_start
16544 than to get into an infinite loop calling the hook functions
16545 and having them get more errors. */
16546 if (!update_mode_line
16547 || ! NILP (Vwindow_scroll_functions
))
16549 update_mode_line
= true;
16550 w
->update_mode_line
= true;
16551 startp
= run_window_scroll_functions (window
, startp
);
16554 if (CHARPOS (startp
) < BEGV
)
16555 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16556 else if (CHARPOS (startp
) > ZV
)
16557 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16559 /* Redisplay, then check if cursor has been set during the
16560 redisplay. Give up if new fonts were loaded. */
16561 /* We used to issue a CHECK_MARGINS argument to try_window here,
16562 but this causes scrolling to fail when point begins inside
16563 the scroll margin (bug#148) -- cyd */
16564 if (!try_window (window
, startp
, 0))
16566 w
->force_start
= true;
16567 clear_glyph_matrix (w
->desired_matrix
);
16568 goto need_larger_matrices
;
16571 if (w
->cursor
.vpos
< 0)
16573 /* If point does not appear, try to move point so it does
16574 appear. The desired matrix has been built above, so we
16575 can use it here. First see if point is in invisible
16576 text, and if so, move it to the first visible buffer
16577 position past that. */
16578 struct glyph_row
*r
= NULL
;
16579 Lisp_Object invprop
=
16580 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16583 if (TEXT_PROP_MEANS_INVISIBLE (invprop
) != 0)
16586 Lisp_Object invprop_end
=
16587 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16590 if (NATNUMP (invprop_end
))
16591 alt_pt
= XFASTINT (invprop_end
);
16594 r
= row_containing_pos (w
, alt_pt
, w
->desired_matrix
->rows
,
16598 new_vpos
= MATRIX_ROW_BOTTOM_Y (r
);
16599 else /* Give up and just move to the middle of the window. */
16600 new_vpos
= window_box_height (w
) / 2;
16603 if (!cursor_row_fully_visible_p (w
, false, false))
16605 /* Point does appear, but on a line partly visible at end of window.
16606 Move it back to a fully-visible line. */
16607 new_vpos
= window_box_height (w
);
16608 /* But if window_box_height suggests a Y coordinate that is
16609 not less than we already have, that line will clearly not
16610 be fully visible, so give up and scroll the display.
16611 This can happen when the default face uses a font whose
16612 dimensions are different from the frame's default
16614 if (new_vpos
>= w
->cursor
.y
)
16616 w
->cursor
.vpos
= -1;
16617 clear_glyph_matrix (w
->desired_matrix
);
16618 goto try_to_scroll
;
16621 else if (w
->cursor
.vpos
>= 0)
16623 /* Some people insist on not letting point enter the scroll
16624 margin, even though this part handles windows that didn't
16626 int pixel_margin
= margin
* frame_line_height
;
16627 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16629 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16630 below, which finds the row to move point to, advances by
16631 the Y coordinate of the _next_ row, see the definition of
16632 MATRIX_ROW_BOTTOM_Y. */
16633 if (w
->cursor
.vpos
< margin
+ header_line
)
16635 w
->cursor
.vpos
= -1;
16636 clear_glyph_matrix (w
->desired_matrix
);
16637 goto try_to_scroll
;
16641 int window_height
= window_box_height (w
);
16644 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16645 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16647 w
->cursor
.vpos
= -1;
16648 clear_glyph_matrix (w
->desired_matrix
);
16649 goto try_to_scroll
;
16654 /* If we need to move point for either of the above reasons,
16655 now actually do it. */
16658 struct glyph_row
*row
;
16660 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16661 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16664 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16665 MATRIX_ROW_START_BYTEPOS (row
));
16667 if (w
!= XWINDOW (selected_window
))
16668 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16669 else if (current_buffer
== old
)
16670 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16672 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16674 /* Re-run pre-redisplay-function so it can update the region
16675 according to the new position of point. */
16676 /* Other than the cursor, w's redisplay is done so we can set its
16677 redisplay to false. Also the buffer's redisplay can be set to
16678 false, since propagate_buffer_redisplay should have already
16679 propagated its info to `w' anyway. */
16680 w
->redisplay
= false;
16681 XBUFFER (w
->contents
)->text
->redisplay
= false;
16682 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16684 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16686 /* pre-redisplay-function made changes (e.g. move the region)
16687 that require another round of redisplay. */
16688 clear_glyph_matrix (w
->desired_matrix
);
16689 if (!try_window (window
, startp
, 0))
16690 goto need_larger_matrices
;
16693 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16695 clear_glyph_matrix (w
->desired_matrix
);
16696 goto try_to_scroll
;
16700 debug_method_add (w
, "forced window start");
16705 /* Handle case where text has not changed, only point, and it has
16706 not moved off the frame, and we are not retrying after hscroll.
16707 (current_matrix_up_to_date_p is true when retrying.) */
16708 if (current_matrix_up_to_date_p
16709 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16710 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16714 case CURSOR_MOVEMENT_SUCCESS
:
16715 used_current_matrix_p
= true;
16718 case CURSOR_MOVEMENT_MUST_SCROLL
:
16719 goto try_to_scroll
;
16725 /* If current starting point was originally the beginning of a line
16726 but no longer is, find a new starting point. */
16727 else if (w
->start_at_line_beg
16728 && !(CHARPOS (startp
) <= BEGV
16729 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16732 debug_method_add (w
, "recenter 1");
16737 /* Try scrolling with try_window_id. Value is > 0 if update has
16738 been done, it is -1 if we know that the same window start will
16739 not work. It is 0 if unsuccessful for some other reason. */
16740 else if ((tem
= try_window_id (w
)) != 0)
16743 debug_method_add (w
, "try_window_id %d", tem
);
16746 if (f
->fonts_changed
)
16747 goto need_larger_matrices
;
16751 /* Otherwise try_window_id has returned -1 which means that we
16752 don't want the alternative below this comment to execute. */
16754 else if (CHARPOS (startp
) >= BEGV
16755 && CHARPOS (startp
) <= ZV
16756 && PT
>= CHARPOS (startp
)
16757 && (CHARPOS (startp
) < ZV
16758 /* Avoid starting at end of buffer. */
16759 || CHARPOS (startp
) == BEGV
16760 || !window_outdated (w
)))
16762 int d1
, d2
, d5
, d6
;
16765 /* If first window line is a continuation line, and window start
16766 is inside the modified region, but the first change is before
16767 current window start, we must select a new window start.
16769 However, if this is the result of a down-mouse event (e.g. by
16770 extending the mouse-drag-overlay), we don't want to select a
16771 new window start, since that would change the position under
16772 the mouse, resulting in an unwanted mouse-movement rather
16773 than a simple mouse-click. */
16774 if (!w
->start_at_line_beg
16775 && NILP (do_mouse_tracking
)
16776 && CHARPOS (startp
) > BEGV
16777 && CHARPOS (startp
) > BEG
+ beg_unchanged
16778 && CHARPOS (startp
) <= Z
- end_unchanged
16779 /* Even if w->start_at_line_beg is nil, a new window may
16780 start at a line_beg, since that's how set_buffer_window
16781 sets it. So, we need to check the return value of
16782 compute_window_start_on_continuation_line. (See also
16784 && XMARKER (w
->start
)->buffer
== current_buffer
16785 && compute_window_start_on_continuation_line (w
)
16786 /* It doesn't make sense to force the window start like we
16787 do at label force_start if it is already known that point
16788 will not be fully visible in the resulting window, because
16789 doing so will move point from its correct position
16790 instead of scrolling the window to bring point into view.
16792 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16793 /* A very tall row could need more than the window height,
16794 in which case we accept that it is partially visible. */
16795 && (rtop
!= 0) == (rbot
!= 0))
16797 w
->force_start
= true;
16798 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16800 debug_method_add (w
, "recomputed window start in continuation line");
16806 debug_method_add (w
, "same window start");
16809 /* Try to redisplay starting at same place as before.
16810 If point has not moved off frame, accept the results. */
16811 if (!current_matrix_up_to_date_p
16812 /* Don't use try_window_reusing_current_matrix in this case
16813 because a window scroll function can have changed the
16815 || !NILP (Vwindow_scroll_functions
)
16816 || MINI_WINDOW_P (w
)
16817 || !(used_current_matrix_p
16818 = try_window_reusing_current_matrix (w
)))
16820 IF_DEBUG (debug_method_add (w
, "1"));
16821 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16822 /* -1 means we need to scroll.
16823 0 means we need new matrices, but fonts_changed
16824 is set in that case, so we will detect it below. */
16825 goto try_to_scroll
;
16828 if (f
->fonts_changed
)
16829 goto need_larger_matrices
;
16831 if (w
->cursor
.vpos
>= 0)
16833 if (!just_this_one_p
16834 || current_buffer
->clip_changed
16835 || BEG_UNCHANGED
< CHARPOS (startp
))
16836 /* Forget any recorded base line for line number display. */
16837 w
->base_line_number
= 0;
16839 if (!cursor_row_fully_visible_p (w
, true, false))
16841 clear_glyph_matrix (w
->desired_matrix
);
16842 last_line_misfit
= true;
16844 /* Drop through and scroll. */
16849 clear_glyph_matrix (w
->desired_matrix
);
16854 /* Redisplay the mode line. Select the buffer properly for that. */
16855 if (!update_mode_line
)
16857 update_mode_line
= true;
16858 w
->update_mode_line
= true;
16861 /* Try to scroll by specified few lines. */
16862 if ((scroll_conservatively
16863 || emacs_scroll_step
16864 || temp_scroll_step
16865 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16866 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16867 && CHARPOS (startp
) >= BEGV
16868 && CHARPOS (startp
) <= ZV
)
16870 /* The function returns -1 if new fonts were loaded, 1 if
16871 successful, 0 if not successful. */
16872 int ss
= try_scrolling (window
, just_this_one_p
,
16873 scroll_conservatively
,
16875 temp_scroll_step
, last_line_misfit
);
16878 case SCROLLING_SUCCESS
:
16881 case SCROLLING_NEED_LARGER_MATRICES
:
16882 goto need_larger_matrices
;
16884 case SCROLLING_FAILED
:
16892 /* Finally, just choose a place to start which positions point
16893 according to user preferences. */
16898 debug_method_add (w
, "recenter");
16901 /* Forget any previously recorded base line for line number display. */
16902 if (!buffer_unchanged_p
)
16903 w
->base_line_number
= 0;
16905 /* Determine the window start relative to point. */
16906 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16907 it
.current_y
= it
.last_visible_y
;
16908 if (centering_position
< 0)
16910 ptrdiff_t margin_pos
= CHARPOS (startp
);
16911 Lisp_Object aggressive
;
16914 /* If there is a scroll margin at the top of the window, find
16915 its character position. */
16917 /* Cannot call start_display if startp is not in the
16918 accessible region of the buffer. This can happen when we
16919 have just switched to a different buffer and/or changed
16920 its restriction. In that case, startp is initialized to
16921 the character position 1 (BEGV) because we did not yet
16922 have chance to display the buffer even once. */
16923 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16926 void *it1data
= NULL
;
16928 SAVE_IT (it1
, it
, it1data
);
16929 start_display (&it1
, w
, startp
);
16930 move_it_vertically (&it1
, margin
* frame_line_height
);
16931 margin_pos
= IT_CHARPOS (it1
);
16932 RESTORE_IT (&it
, &it
, it1data
);
16934 scrolling_up
= PT
> margin_pos
;
16937 ? BVAR (current_buffer
, scroll_up_aggressively
)
16938 : BVAR (current_buffer
, scroll_down_aggressively
);
16940 if (!MINI_WINDOW_P (w
)
16941 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16945 /* Setting scroll-conservatively overrides
16946 scroll-*-aggressively. */
16947 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16949 double float_amount
= XFLOATINT (aggressive
);
16951 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16952 if (pt_offset
== 0 && float_amount
> 0)
16954 if (pt_offset
&& margin
> 0)
16957 /* Compute how much to move the window start backward from
16958 point so that point will be displayed where the user
16962 centering_position
= it
.last_visible_y
;
16964 centering_position
-= pt_offset
;
16965 centering_position
-=
16966 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16967 + WINDOW_HEADER_LINE_HEIGHT (w
));
16968 /* Don't let point enter the scroll margin near top of
16970 if (centering_position
< margin
* frame_line_height
)
16971 centering_position
= margin
* frame_line_height
;
16974 centering_position
= margin
* frame_line_height
+ pt_offset
;
16977 /* Set the window start half the height of the window backward
16979 centering_position
= window_box_height (w
) / 2;
16981 move_it_vertically_backward (&it
, centering_position
);
16983 eassert (IT_CHARPOS (it
) >= BEGV
);
16985 /* The function move_it_vertically_backward may move over more
16986 than the specified y-distance. If it->w is small, e.g. a
16987 mini-buffer window, we may end up in front of the window's
16988 display area. Start displaying at the start of the line
16989 containing PT in this case. */
16990 if (it
.current_y
<= 0)
16992 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16993 move_it_vertically_backward (&it
, 0);
16997 it
.current_x
= it
.hpos
= 0;
16999 /* Set the window start position here explicitly, to avoid an
17000 infinite loop in case the functions in window-scroll-functions
17002 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
17004 /* Run scroll hooks. */
17005 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
17007 /* We invoke try_window and try_window_reusing_current_matrix below,
17008 and they manipulate the bidi cache. Save and restore the cache
17009 state of our iterator, so we could continue using it after that. */
17010 itdata
= bidi_shelve_cache ();
17012 /* Redisplay the window. */
17013 use_desired_matrix
= false;
17014 if (!current_matrix_up_to_date_p
17015 || windows_or_buffers_changed
17016 || f
->cursor_type_changed
17017 /* Don't use try_window_reusing_current_matrix in this case
17018 because it can have changed the buffer. */
17019 || !NILP (Vwindow_scroll_functions
)
17020 || !just_this_one_p
17021 || MINI_WINDOW_P (w
)
17022 || !(used_current_matrix_p
17023 = try_window_reusing_current_matrix (w
)))
17024 use_desired_matrix
= (try_window (window
, startp
, 0) == 1);
17026 bidi_unshelve_cache (itdata
, false);
17028 /* If new fonts have been loaded (due to fontsets), give up. We
17029 have to start a new redisplay since we need to re-adjust glyph
17031 if (f
->fonts_changed
)
17032 goto need_larger_matrices
;
17034 /* If cursor did not appear assume that the middle of the window is
17035 in the first line of the window. Do it again with the next line.
17036 (Imagine a window of height 100, displaying two lines of height
17037 60. Moving back 50 from it->last_visible_y will end in the first
17039 if (w
->cursor
.vpos
< 0)
17041 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
17043 clear_glyph_matrix (w
->desired_matrix
);
17044 move_it_by_lines (&it
, 1);
17045 try_window (window
, it
.current
.pos
, 0);
17047 else if (PT
< IT_CHARPOS (it
))
17049 clear_glyph_matrix (w
->desired_matrix
);
17050 move_it_by_lines (&it
, -1);
17051 try_window (window
, it
.current
.pos
, 0);
17053 else if (scroll_conservatively
> SCROLL_LIMIT
17054 && (it
.method
== GET_FROM_STRING
17055 || overlay_touches_p (IT_CHARPOS (it
)))
17056 && IT_CHARPOS (it
) < ZV
)
17058 /* If the window starts with a before-string that spans more
17059 than one screen line, using that position to display the
17060 window might fail to bring point into the view, because
17061 start_display will always start by displaying the string,
17062 whereas the code above determines where to set w->start
17063 by the buffer position of the place where it takes screen
17064 coordinates. Try to recover by finding the next screen
17065 line that displays buffer text. */
17066 ptrdiff_t pos0
= IT_CHARPOS (it
);
17068 clear_glyph_matrix (w
->desired_matrix
);
17070 move_it_by_lines (&it
, 1);
17071 } while (IT_CHARPOS (it
) == pos0
);
17072 try_window (window
, it
.current
.pos
, 0);
17076 /* Not much we can do about it. */
17080 /* Consider the following case: Window starts at BEGV, there is
17081 invisible, intangible text at BEGV, so that display starts at
17082 some point START > BEGV. It can happen that we are called with
17083 PT somewhere between BEGV and START. Try to handle that case,
17084 and similar ones. */
17085 if (w
->cursor
.vpos
< 0)
17087 /* Prefer the desired matrix to the current matrix, if possible,
17088 in the fallback calculations below. This is because using
17089 the current matrix might completely goof, e.g. if its first
17090 row is after point. */
17091 struct glyph_matrix
*matrix
=
17092 use_desired_matrix
? w
->desired_matrix
: w
->current_matrix
;
17093 /* First, try locating the proper glyph row for PT. */
17094 struct glyph_row
*row
=
17095 row_containing_pos (w
, PT
, matrix
->rows
, NULL
, 0);
17097 /* Sometimes point is at the beginning of invisible text that is
17098 before the 1st character displayed in the row. In that case,
17099 row_containing_pos fails to find the row, because no glyphs
17100 with appropriate buffer positions are present in the row.
17101 Therefore, we next try to find the row which shows the 1st
17102 position after the invisible text. */
17106 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
17109 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
17112 Lisp_Object invis_end
=
17113 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
17116 if (NATNUMP (invis_end
))
17117 alt_pos
= XFASTINT (invis_end
);
17120 row
= row_containing_pos (w
, alt_pos
, matrix
->rows
, NULL
, 0);
17123 /* Finally, fall back on the first row of the window after the
17124 header line (if any). This is slightly better than not
17125 displaying the cursor at all. */
17128 row
= matrix
->rows
;
17129 if (row
->mode_line_p
)
17132 set_cursor_from_row (w
, row
, matrix
, 0, 0, 0, 0);
17135 if (!cursor_row_fully_visible_p (w
, false, false))
17137 /* If vscroll is enabled, disable it and try again. */
17141 clear_glyph_matrix (w
->desired_matrix
);
17145 /* Users who set scroll-conservatively to a large number want
17146 point just above/below the scroll margin. If we ended up
17147 with point's row partially visible, move the window start to
17148 make that row fully visible and out of the margin. */
17149 if (scroll_conservatively
> SCROLL_LIMIT
)
17151 int window_total_lines
17152 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17153 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
17155 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
17156 clear_glyph_matrix (w
->desired_matrix
);
17157 if (1 == try_window (window
, it
.current
.pos
,
17158 TRY_WINDOW_CHECK_MARGINS
))
17162 /* If centering point failed to make the whole line visible,
17163 put point at the top instead. That has to make the whole line
17164 visible, if it can be done. */
17165 if (centering_position
== 0)
17168 clear_glyph_matrix (w
->desired_matrix
);
17169 centering_position
= 0;
17175 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
17176 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
17177 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
17179 /* Display the mode line, if we must. */
17180 if ((update_mode_line
17181 /* If window not full width, must redo its mode line
17182 if (a) the window to its side is being redone and
17183 (b) we do a frame-based redisplay. This is a consequence
17184 of how inverted lines are drawn in frame-based redisplay. */
17185 || (!just_this_one_p
17186 && !FRAME_WINDOW_P (f
)
17187 && !WINDOW_FULL_WIDTH_P (w
))
17188 /* Line number to display. */
17189 || w
->base_line_pos
> 0
17190 /* Column number is displayed and different from the one displayed. */
17191 || (w
->column_number_displayed
!= -1
17192 && (w
->column_number_displayed
!= current_column ())))
17193 /* This means that the window has a mode line. */
17194 && (WINDOW_WANTS_MODELINE_P (w
)
17195 || WINDOW_WANTS_HEADER_LINE_P (w
)))
17198 display_mode_lines (w
);
17200 /* If mode line height has changed, arrange for a thorough
17201 immediate redisplay using the correct mode line height. */
17202 if (WINDOW_WANTS_MODELINE_P (w
)
17203 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
17205 f
->fonts_changed
= true;
17206 w
->mode_line_height
= -1;
17207 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
17208 = DESIRED_MODE_LINE_HEIGHT (w
);
17211 /* If header line height has changed, arrange for a thorough
17212 immediate redisplay using the correct header line height. */
17213 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17214 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
17216 f
->fonts_changed
= true;
17217 w
->header_line_height
= -1;
17218 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
17219 = DESIRED_HEADER_LINE_HEIGHT (w
);
17222 if (f
->fonts_changed
)
17223 goto need_larger_matrices
;
17226 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
17228 w
->base_line_pos
= 0;
17229 w
->base_line_number
= 0;
17234 /* When we reach a frame's selected window, redo the frame's menu
17235 bar and the frame's title. */
17236 if (update_mode_line
17237 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
17239 bool redisplay_menu_p
;
17241 if (FRAME_WINDOW_P (f
))
17243 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
17244 || defined (HAVE_NS) || defined (USE_GTK)
17245 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
17247 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17251 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
17253 if (redisplay_menu_p
)
17254 display_menu_bar (w
);
17256 #ifdef HAVE_WINDOW_SYSTEM
17257 if (FRAME_WINDOW_P (f
))
17259 #if defined (USE_GTK) || defined (HAVE_NS)
17260 if (FRAME_EXTERNAL_TOOL_BAR (f
))
17261 redisplay_tool_bar (f
);
17263 if (WINDOWP (f
->tool_bar_window
)
17264 && (FRAME_TOOL_BAR_LINES (f
) > 0
17265 || !NILP (Vauto_resize_tool_bars
))
17266 && redisplay_tool_bar (f
))
17267 ignore_mouse_drag_p
= true;
17270 x_consider_frame_title (w
->frame
);
17274 #ifdef HAVE_WINDOW_SYSTEM
17275 if (FRAME_WINDOW_P (f
)
17276 && update_window_fringes (w
, (just_this_one_p
17277 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
17278 || w
->pseudo_window_p
)))
17282 if (draw_window_fringes (w
, true))
17284 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
17285 x_draw_right_divider (w
);
17287 x_draw_vertical_border (w
);
17293 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
17294 x_draw_bottom_divider (w
);
17295 #endif /* HAVE_WINDOW_SYSTEM */
17297 /* We go to this label, with fonts_changed set, if it is
17298 necessary to try again using larger glyph matrices.
17299 We have to redeem the scroll bar even in this case,
17300 because the loop in redisplay_internal expects that. */
17301 need_larger_matrices
:
17303 finish_scroll_bars
:
17305 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17307 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
17308 /* Set the thumb's position and size. */
17309 set_vertical_scroll_bar (w
);
17311 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17312 /* Set the thumb's position and size. */
17313 set_horizontal_scroll_bar (w
);
17315 /* Note that we actually used the scroll bar attached to this
17316 window, so it shouldn't be deleted at the end of redisplay. */
17317 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
17318 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
17321 /* Restore current_buffer and value of point in it. The window
17322 update may have changed the buffer, so first make sure `opoint'
17323 is still valid (Bug#6177). */
17324 if (CHARPOS (opoint
) < BEGV
)
17325 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17326 else if (CHARPOS (opoint
) > ZV
)
17327 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
17329 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
17331 set_buffer_internal_1 (old
);
17332 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
17333 shorter. This can be caused by log truncation in *Messages*. */
17334 if (CHARPOS (lpoint
) <= ZV
)
17335 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17337 unbind_to (count
, Qnil
);
17341 /* Build the complete desired matrix of WINDOW with a window start
17342 buffer position POS.
17344 Value is 1 if successful. It is zero if fonts were loaded during
17345 redisplay which makes re-adjusting glyph matrices necessary, and -1
17346 if point would appear in the scroll margins.
17347 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
17348 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
17352 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
17354 struct window
*w
= XWINDOW (window
);
17356 struct glyph_row
*last_text_row
= NULL
;
17357 struct frame
*f
= XFRAME (w
->frame
);
17359 /* Make POS the new window start. */
17360 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
17362 /* Mark cursor position as unknown. No overlay arrow seen. */
17363 w
->cursor
.vpos
= -1;
17364 overlay_arrow_seen
= false;
17366 /* Initialize iterator and info to start at POS. */
17367 start_display (&it
, w
, pos
);
17368 it
.glyph_row
->reversed_p
= false;
17370 /* Display all lines of W. */
17371 while (it
.current_y
< it
.last_visible_y
)
17373 if (display_line (&it
))
17374 last_text_row
= it
.glyph_row
- 1;
17375 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17379 /* Don't let the cursor end in the scroll margins. */
17380 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17381 && !MINI_WINDOW_P (w
))
17383 int this_scroll_margin
= window_scroll_margin (w
, MARGIN_IN_PIXELS
);
17385 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17386 && w
->cursor
.y
< this_scroll_margin
17387 && CHARPOS (pos
) > BEGV
17388 && IT_CHARPOS (it
) < ZV
)
17389 /* rms: considering make_cursor_line_fully_visible_p here
17390 seems to give wrong results. We don't want to recenter
17391 when the last line is partly visible, we want to allow
17392 that case to be handled in the usual way. */
17393 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17395 w
->cursor
.vpos
= -1;
17396 clear_glyph_matrix (w
->desired_matrix
);
17401 /* If bottom moved off end of frame, change mode line percentage. */
17402 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17403 w
->update_mode_line
= true;
17405 /* Set window_end_pos to the offset of the last character displayed
17406 on the window from the end of current_buffer. Set
17407 window_end_vpos to its row number. */
17410 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17411 adjust_window_ends (w
, last_text_row
, false);
17413 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17414 w
->window_end_vpos
)));
17418 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17419 w
->window_end_pos
= Z
- ZV
;
17420 w
->window_end_vpos
= 0;
17423 /* But that is not valid info until redisplay finishes. */
17424 w
->window_end_valid
= false;
17430 /************************************************************************
17431 Window redisplay reusing current matrix when buffer has not changed
17432 ************************************************************************/
17434 /* Try redisplay of window W showing an unchanged buffer with a
17435 different window start than the last time it was displayed by
17436 reusing its current matrix. Value is true if successful.
17437 W->start is the new window start. */
17440 try_window_reusing_current_matrix (struct window
*w
)
17442 struct frame
*f
= XFRAME (w
->frame
);
17443 struct glyph_row
*bottom_row
;
17446 struct text_pos start
, new_start
;
17447 int nrows_scrolled
, i
;
17448 struct glyph_row
*last_text_row
;
17449 struct glyph_row
*last_reused_text_row
;
17450 struct glyph_row
*start_row
;
17451 int start_vpos
, min_y
, max_y
;
17454 if (inhibit_try_window_reusing
)
17458 if (/* This function doesn't handle terminal frames. */
17459 !FRAME_WINDOW_P (f
)
17460 /* Don't try to reuse the display if windows have been split
17462 || windows_or_buffers_changed
17463 || f
->cursor_type_changed
)
17466 /* Can't do this if showing trailing whitespace. */
17467 if (!NILP (Vshow_trailing_whitespace
))
17470 /* If top-line visibility has changed, give up. */
17471 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17472 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17475 /* Give up if old or new display is scrolled vertically. We could
17476 make this function handle this, but right now it doesn't. */
17477 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17478 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17481 /* The variable new_start now holds the new window start. The old
17482 start `start' can be determined from the current matrix. */
17483 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17484 start
= start_row
->minpos
;
17485 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17487 /* Clear the desired matrix for the display below. */
17488 clear_glyph_matrix (w
->desired_matrix
);
17490 if (CHARPOS (new_start
) <= CHARPOS (start
))
17492 /* Don't use this method if the display starts with an ellipsis
17493 displayed for invisible text. It's not easy to handle that case
17494 below, and it's certainly not worth the effort since this is
17495 not a frequent case. */
17496 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17499 IF_DEBUG (debug_method_add (w
, "twu1"));
17501 /* Display up to a row that can be reused. The variable
17502 last_text_row is set to the last row displayed that displays
17503 text. Note that it.vpos == 0 if or if not there is a
17504 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17505 start_display (&it
, w
, new_start
);
17506 w
->cursor
.vpos
= -1;
17507 last_text_row
= last_reused_text_row
= NULL
;
17509 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17511 /* If we have reached into the characters in the START row,
17512 that means the line boundaries have changed. So we
17513 can't start copying with the row START. Maybe it will
17514 work to start copying with the following row. */
17515 while (IT_CHARPOS (it
) > CHARPOS (start
))
17517 /* Advance to the next row as the "start". */
17519 start
= start_row
->minpos
;
17520 /* If there are no more rows to try, or just one, give up. */
17521 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17522 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17523 || CHARPOS (start
) == ZV
)
17525 clear_glyph_matrix (w
->desired_matrix
);
17529 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17531 /* If we have reached alignment, we can copy the rest of the
17533 if (IT_CHARPOS (it
) == CHARPOS (start
)
17534 /* Don't accept "alignment" inside a display vector,
17535 since start_row could have started in the middle of
17536 that same display vector (thus their character
17537 positions match), and we have no way of telling if
17538 that is the case. */
17539 && it
.current
.dpvec_index
< 0)
17542 it
.glyph_row
->reversed_p
= false;
17543 if (display_line (&it
))
17544 last_text_row
= it
.glyph_row
- 1;
17548 /* A value of current_y < last_visible_y means that we stopped
17549 at the previous window start, which in turn means that we
17550 have at least one reusable row. */
17551 if (it
.current_y
< it
.last_visible_y
)
17553 struct glyph_row
*row
;
17555 /* IT.vpos always starts from 0; it counts text lines. */
17556 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17558 /* Find PT if not already found in the lines displayed. */
17559 if (w
->cursor
.vpos
< 0)
17561 int dy
= it
.current_y
- start_row
->y
;
17563 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17564 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17566 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17567 dy
, nrows_scrolled
);
17570 clear_glyph_matrix (w
->desired_matrix
);
17575 /* Scroll the display. Do it before the current matrix is
17576 changed. The problem here is that update has not yet
17577 run, i.e. part of the current matrix is not up to date.
17578 scroll_run_hook will clear the cursor, and use the
17579 current matrix to get the height of the row the cursor is
17581 run
.current_y
= start_row
->y
;
17582 run
.desired_y
= it
.current_y
;
17583 run
.height
= it
.last_visible_y
- it
.current_y
;
17585 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17588 FRAME_RIF (f
)->update_window_begin_hook (w
);
17589 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17590 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17591 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17595 /* Shift current matrix down by nrows_scrolled lines. */
17596 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17597 rotate_matrix (w
->current_matrix
,
17599 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17602 /* Disable lines that must be updated. */
17603 for (i
= 0; i
< nrows_scrolled
; ++i
)
17604 (start_row
+ i
)->enabled_p
= false;
17606 /* Re-compute Y positions. */
17607 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17608 max_y
= it
.last_visible_y
;
17609 for (row
= start_row
+ nrows_scrolled
;
17613 row
->y
= it
.current_y
;
17614 row
->visible_height
= row
->height
;
17616 if (row
->y
< min_y
)
17617 row
->visible_height
-= min_y
- row
->y
;
17618 if (row
->y
+ row
->height
> max_y
)
17619 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17620 if (row
->fringe_bitmap_periodic_p
)
17621 row
->redraw_fringe_bitmaps_p
= true;
17623 it
.current_y
+= row
->height
;
17625 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17626 last_reused_text_row
= row
;
17627 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17631 /* Disable lines in the current matrix which are now
17632 below the window. */
17633 for (++row
; row
< bottom_row
; ++row
)
17634 row
->enabled_p
= row
->mode_line_p
= false;
17637 /* Update window_end_pos etc.; last_reused_text_row is the last
17638 reused row from the current matrix containing text, if any.
17639 The value of last_text_row is the last displayed line
17640 containing text. */
17641 if (last_reused_text_row
)
17642 adjust_window_ends (w
, last_reused_text_row
, true);
17643 else if (last_text_row
)
17644 adjust_window_ends (w
, last_text_row
, false);
17647 /* This window must be completely empty. */
17648 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17649 w
->window_end_pos
= Z
- ZV
;
17650 w
->window_end_vpos
= 0;
17652 w
->window_end_valid
= false;
17654 /* Update hint: don't try scrolling again in update_window. */
17655 w
->desired_matrix
->no_scrolling_p
= true;
17658 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17662 else if (CHARPOS (new_start
) > CHARPOS (start
))
17664 struct glyph_row
*pt_row
, *row
;
17665 struct glyph_row
*first_reusable_row
;
17666 struct glyph_row
*first_row_to_display
;
17668 int yb
= window_text_bottom_y (w
);
17670 /* Find the row starting at new_start, if there is one. Don't
17671 reuse a partially visible line at the end. */
17672 first_reusable_row
= start_row
;
17673 while (first_reusable_row
->enabled_p
17674 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17675 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17676 < CHARPOS (new_start
)))
17677 ++first_reusable_row
;
17679 /* Give up if there is no row to reuse. */
17680 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17681 || !first_reusable_row
->enabled_p
17682 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17683 != CHARPOS (new_start
)))
17686 /* We can reuse fully visible rows beginning with
17687 first_reusable_row to the end of the window. Set
17688 first_row_to_display to the first row that cannot be reused.
17689 Set pt_row to the row containing point, if there is any. */
17691 for (first_row_to_display
= first_reusable_row
;
17692 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17693 ++first_row_to_display
)
17695 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17696 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17697 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17698 && first_row_to_display
->ends_at_zv_p
17699 && pt_row
== NULL
)))
17700 pt_row
= first_row_to_display
;
17703 /* Start displaying at the start of first_row_to_display. */
17704 eassert (first_row_to_display
->y
< yb
);
17705 init_to_row_start (&it
, w
, first_row_to_display
);
17707 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17709 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17711 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17712 + WINDOW_HEADER_LINE_HEIGHT (w
));
17714 /* Display lines beginning with first_row_to_display in the
17715 desired matrix. Set last_text_row to the last row displayed
17716 that displays text. */
17717 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17718 if (pt_row
== NULL
)
17719 w
->cursor
.vpos
= -1;
17720 last_text_row
= NULL
;
17721 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17722 if (display_line (&it
))
17723 last_text_row
= it
.glyph_row
- 1;
17725 /* If point is in a reused row, adjust y and vpos of the cursor
17729 w
->cursor
.vpos
-= nrows_scrolled
;
17730 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17733 /* Give up if point isn't in a row displayed or reused. (This
17734 also handles the case where w->cursor.vpos < nrows_scrolled
17735 after the calls to display_line, which can happen with scroll
17736 margins. See bug#1295.) */
17737 if (w
->cursor
.vpos
< 0)
17739 clear_glyph_matrix (w
->desired_matrix
);
17743 /* Scroll the display. */
17744 run
.current_y
= first_reusable_row
->y
;
17745 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17746 run
.height
= it
.last_visible_y
- run
.current_y
;
17747 dy
= run
.current_y
- run
.desired_y
;
17752 FRAME_RIF (f
)->update_window_begin_hook (w
);
17753 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17754 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17755 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17759 /* Adjust Y positions of reused rows. */
17760 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17761 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17762 max_y
= it
.last_visible_y
;
17763 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17766 row
->visible_height
= row
->height
;
17767 if (row
->y
< min_y
)
17768 row
->visible_height
-= min_y
- row
->y
;
17769 if (row
->y
+ row
->height
> max_y
)
17770 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17771 if (row
->fringe_bitmap_periodic_p
)
17772 row
->redraw_fringe_bitmaps_p
= true;
17775 /* Scroll the current matrix. */
17776 eassert (nrows_scrolled
> 0);
17777 rotate_matrix (w
->current_matrix
,
17779 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17782 /* Disable rows not reused. */
17783 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17784 row
->enabled_p
= false;
17786 /* Point may have moved to a different line, so we cannot assume that
17787 the previous cursor position is valid; locate the correct row. */
17790 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17792 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17793 && !row
->ends_at_zv_p
;
17797 w
->cursor
.y
= row
->y
;
17799 if (row
< bottom_row
)
17801 /* Can't simply scan the row for point with
17802 bidi-reordered glyph rows. Let set_cursor_from_row
17803 figure out where to put the cursor, and if it fails,
17805 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17807 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17810 clear_glyph_matrix (w
->desired_matrix
);
17816 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17817 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17820 && (!BUFFERP (glyph
->object
)
17821 || glyph
->charpos
< PT
);
17825 w
->cursor
.x
+= glyph
->pixel_width
;
17831 /* Adjust window end. A null value of last_text_row means that
17832 the window end is in reused rows which in turn means that
17833 only its vpos can have changed. */
17835 adjust_window_ends (w
, last_text_row
, false);
17837 w
->window_end_vpos
-= nrows_scrolled
;
17839 w
->window_end_valid
= false;
17840 w
->desired_matrix
->no_scrolling_p
= true;
17843 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17853 /************************************************************************
17854 Window redisplay reusing current matrix when buffer has changed
17855 ************************************************************************/
17857 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17858 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17859 ptrdiff_t *, ptrdiff_t *);
17860 static struct glyph_row
*
17861 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17862 struct glyph_row
*);
17865 /* Return the last row in MATRIX displaying text. If row START is
17866 non-null, start searching with that row. IT gives the dimensions
17867 of the display. Value is null if matrix is empty; otherwise it is
17868 a pointer to the row found. */
17870 static struct glyph_row
*
17871 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17872 struct glyph_row
*start
)
17874 struct glyph_row
*row
, *row_found
;
17876 /* Set row_found to the last row in IT->w's current matrix
17877 displaying text. The loop looks funny but think of partially
17880 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17881 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17883 eassert (row
->enabled_p
);
17885 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17894 /* Return the last row in the current matrix of W that is not affected
17895 by changes at the start of current_buffer that occurred since W's
17896 current matrix was built. Value is null if no such row exists.
17898 BEG_UNCHANGED us the number of characters unchanged at the start of
17899 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17900 first changed character in current_buffer. Characters at positions <
17901 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17902 when the current matrix was built. */
17904 static struct glyph_row
*
17905 find_last_unchanged_at_beg_row (struct window
*w
)
17907 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17908 struct glyph_row
*row
;
17909 struct glyph_row
*row_found
= NULL
;
17910 int yb
= window_text_bottom_y (w
);
17912 /* Find the last row displaying unchanged text. */
17913 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17914 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17915 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17918 if (/* If row ends before first_changed_pos, it is unchanged,
17919 except in some case. */
17920 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17921 /* When row ends in ZV and we write at ZV it is not
17923 && !row
->ends_at_zv_p
17924 /* When first_changed_pos is the end of a continued line,
17925 row is not unchanged because it may be no longer
17927 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17928 && (row
->continued_p
17929 || row
->exact_window_width_line_p
))
17930 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17931 needs to be recomputed, so don't consider this row as
17932 unchanged. This happens when the last line was
17933 bidi-reordered and was killed immediately before this
17934 redisplay cycle. In that case, ROW->end stores the
17935 buffer position of the first visual-order character of
17936 the killed text, which is now beyond ZV. */
17937 && CHARPOS (row
->end
.pos
) <= ZV
)
17940 /* Stop if last visible row. */
17941 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17949 /* Find the first glyph row in the current matrix of W that is not
17950 affected by changes at the end of current_buffer since the
17951 time W's current matrix was built.
17953 Return in *DELTA the number of chars by which buffer positions in
17954 unchanged text at the end of current_buffer must be adjusted.
17956 Return in *DELTA_BYTES the corresponding number of bytes.
17958 Value is null if no such row exists, i.e. all rows are affected by
17961 static struct glyph_row
*
17962 find_first_unchanged_at_end_row (struct window
*w
,
17963 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17965 struct glyph_row
*row
;
17966 struct glyph_row
*row_found
= NULL
;
17968 *delta
= *delta_bytes
= 0;
17970 /* Display must not have been paused, otherwise the current matrix
17971 is not up to date. */
17972 eassert (w
->window_end_valid
);
17974 /* A value of window_end_pos >= END_UNCHANGED means that the window
17975 end is in the range of changed text. If so, there is no
17976 unchanged row at the end of W's current matrix. */
17977 if (w
->window_end_pos
>= END_UNCHANGED
)
17980 /* Set row to the last row in W's current matrix displaying text. */
17981 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17983 /* If matrix is entirely empty, no unchanged row exists. */
17984 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17986 /* The value of row is the last glyph row in the matrix having a
17987 meaningful buffer position in it. The end position of row
17988 corresponds to window_end_pos. This allows us to translate
17989 buffer positions in the current matrix to current buffer
17990 positions for characters not in changed text. */
17992 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17993 ptrdiff_t Z_BYTE_old
=
17994 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17995 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17996 struct glyph_row
*first_text_row
17997 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17999 *delta
= Z
- Z_old
;
18000 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
18002 /* Set last_unchanged_pos to the buffer position of the last
18003 character in the buffer that has not been changed. Z is the
18004 index + 1 of the last character in current_buffer, i.e. by
18005 subtracting END_UNCHANGED we get the index of the last
18006 unchanged character, and we have to add BEG to get its buffer
18008 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
18009 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
18011 /* Search backward from ROW for a row displaying a line that
18012 starts at a minimum position >= last_unchanged_pos_old. */
18013 for (; row
> first_text_row
; --row
)
18015 /* This used to abort, but it can happen.
18016 It is ok to just stop the search instead here. KFS. */
18017 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
18020 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
18025 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
18031 /* Make sure that glyph rows in the current matrix of window W
18032 reference the same glyph memory as corresponding rows in the
18033 frame's frame matrix. This function is called after scrolling W's
18034 current matrix on a terminal frame in try_window_id and
18035 try_window_reusing_current_matrix. */
18038 sync_frame_with_window_matrix_rows (struct window
*w
)
18040 struct frame
*f
= XFRAME (w
->frame
);
18041 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
18043 /* Preconditions: W must be a leaf window and full-width. Its frame
18044 must have a frame matrix. */
18045 eassert (BUFFERP (w
->contents
));
18046 eassert (WINDOW_FULL_WIDTH_P (w
));
18047 eassert (!FRAME_WINDOW_P (f
));
18049 /* If W is a full-width window, glyph pointers in W's current matrix
18050 have, by definition, to be the same as glyph pointers in the
18051 corresponding frame matrix. Note that frame matrices have no
18052 marginal areas (see build_frame_matrix). */
18053 window_row
= w
->current_matrix
->rows
;
18054 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
18055 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
18056 while (window_row
< window_row_end
)
18058 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
18059 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
18061 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
18062 frame_row
->glyphs
[TEXT_AREA
] = start
;
18063 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
18064 frame_row
->glyphs
[LAST_AREA
] = end
;
18066 /* Disable frame rows whose corresponding window rows have
18067 been disabled in try_window_id. */
18068 if (!window_row
->enabled_p
)
18069 frame_row
->enabled_p
= false;
18071 ++window_row
, ++frame_row
;
18076 /* Find the glyph row in window W containing CHARPOS. Consider all
18077 rows between START and END (not inclusive). END null means search
18078 all rows to the end of the display area of W. Value is the row
18079 containing CHARPOS or null. */
18082 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
18083 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
18085 struct glyph_row
*row
= start
;
18086 struct glyph_row
*best_row
= NULL
;
18087 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
18090 /* If we happen to start on a header-line, skip that. */
18091 if (row
->mode_line_p
)
18094 if ((end
&& row
>= end
) || !row
->enabled_p
)
18097 last_y
= window_text_bottom_y (w
) - dy
;
18101 /* Give up if we have gone too far. */
18102 if ((end
&& row
>= end
) || !row
->enabled_p
)
18104 /* This formerly returned if they were equal.
18105 I think that both quantities are of a "last plus one" type;
18106 if so, when they are equal, the row is within the screen. -- rms. */
18107 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
18110 /* If it is in this row, return this row. */
18111 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
18112 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
18113 /* The end position of a row equals the start
18114 position of the next row. If CHARPOS is there, we
18115 would rather consider it displayed in the next
18116 line, except when this line ends in ZV. */
18117 && !row_for_charpos_p (row
, charpos
)))
18118 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
18122 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
18123 || (!best_row
&& !row
->continued_p
))
18125 /* In bidi-reordered rows, there could be several rows whose
18126 edges surround CHARPOS, all of these rows belonging to
18127 the same continued line. We need to find the row which
18128 fits CHARPOS the best. */
18129 for (g
= row
->glyphs
[TEXT_AREA
];
18130 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18133 if (!STRINGP (g
->object
))
18135 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
18137 mindif
= eabs (g
->charpos
- charpos
);
18139 /* Exact match always wins. */
18146 else if (best_row
&& !row
->continued_p
)
18153 /* Try to redisplay window W by reusing its existing display. W's
18154 current matrix must be up to date when this function is called,
18155 i.e., window_end_valid must be true.
18159 >= 1 if successful, i.e. display has been updated
18161 1 means the changes were in front of a newline that precedes
18162 the window start, and the whole current matrix was reused
18163 2 means the changes were after the last position displayed
18164 in the window, and the whole current matrix was reused
18165 3 means portions of the current matrix were reused, while
18166 some of the screen lines were redrawn
18167 -1 if redisplay with same window start is known not to succeed
18168 0 if otherwise unsuccessful
18170 The following steps are performed:
18172 1. Find the last row in the current matrix of W that is not
18173 affected by changes at the start of current_buffer. If no such row
18176 2. Find the first row in W's current matrix that is not affected by
18177 changes at the end of current_buffer. Maybe there is no such row.
18179 3. Display lines beginning with the row + 1 found in step 1 to the
18180 row found in step 2 or, if step 2 didn't find a row, to the end of
18183 4. If cursor is not known to appear on the window, give up.
18185 5. If display stopped at the row found in step 2, scroll the
18186 display and current matrix as needed.
18188 6. Maybe display some lines at the end of W, if we must. This can
18189 happen under various circumstances, like a partially visible line
18190 becoming fully visible, or because newly displayed lines are displayed
18191 in smaller font sizes.
18193 7. Update W's window end information. */
18196 try_window_id (struct window
*w
)
18198 struct frame
*f
= XFRAME (w
->frame
);
18199 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
18200 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
18201 struct glyph_row
*last_unchanged_at_beg_row
;
18202 struct glyph_row
*first_unchanged_at_end_row
;
18203 struct glyph_row
*row
;
18204 struct glyph_row
*bottom_row
;
18207 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
18209 struct text_pos start_pos
;
18211 int first_unchanged_at_end_vpos
= 0;
18212 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
18213 struct text_pos start
;
18214 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
18217 if (inhibit_try_window_id
)
18221 /* This is handy for debugging. */
18223 #define GIVE_UP(X) \
18225 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
18229 #define GIVE_UP(X) return 0
18232 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
18234 /* Don't use this for mini-windows because these can show
18235 messages and mini-buffers, and we don't handle that here. */
18236 if (MINI_WINDOW_P (w
))
18239 /* This flag is used to prevent redisplay optimizations. */
18240 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
18243 /* This function's optimizations cannot be used if overlays have
18244 changed in the buffer displayed by the window, so give up if they
18246 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
18249 /* Verify that narrowing has not changed.
18250 Also verify that we were not told to prevent redisplay optimizations.
18251 It would be nice to further
18252 reduce the number of cases where this prevents try_window_id. */
18253 if (current_buffer
->clip_changed
18254 || current_buffer
->prevent_redisplay_optimizations_p
)
18257 /* Window must either use window-based redisplay or be full width. */
18258 if (!FRAME_WINDOW_P (f
)
18259 && (!FRAME_LINE_INS_DEL_OK (f
)
18260 || !WINDOW_FULL_WIDTH_P (w
)))
18263 /* Give up if point is known NOT to appear in W. */
18264 if (PT
< CHARPOS (start
))
18267 /* Another way to prevent redisplay optimizations. */
18268 if (w
->last_modified
== 0)
18271 /* Verify that window is not hscrolled. */
18272 if (w
->hscroll
!= 0)
18275 /* Verify that display wasn't paused. */
18276 if (!w
->window_end_valid
)
18279 /* Likewise if highlighting trailing whitespace. */
18280 if (!NILP (Vshow_trailing_whitespace
))
18283 /* Can't use this if overlay arrow position and/or string have
18285 if (overlay_arrows_changed_p ())
18288 /* When word-wrap is on, adding a space to the first word of a
18289 wrapped line can change the wrap position, altering the line
18290 above it. It might be worthwhile to handle this more
18291 intelligently, but for now just redisplay from scratch. */
18292 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
18295 /* Under bidi reordering, adding or deleting a character in the
18296 beginning of a paragraph, before the first strong directional
18297 character, can change the base direction of the paragraph (unless
18298 the buffer specifies a fixed paragraph direction), which will
18299 require redisplaying the whole paragraph. It might be worthwhile
18300 to find the paragraph limits and widen the range of redisplayed
18301 lines to that, but for now just give up this optimization and
18302 redisplay from scratch. */
18303 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
18304 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
18307 /* Give up if the buffer has line-spacing set, as Lisp-level changes
18308 to that variable require thorough redisplay. */
18309 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
18312 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
18313 only if buffer has really changed. The reason is that the gap is
18314 initially at Z for freshly visited files. The code below would
18315 set end_unchanged to 0 in that case. */
18316 if (MODIFF
> SAVE_MODIFF
18317 /* This seems to happen sometimes after saving a buffer. */
18318 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
18320 if (GPT
- BEG
< BEG_UNCHANGED
)
18321 BEG_UNCHANGED
= GPT
- BEG
;
18322 if (Z
- GPT
< END_UNCHANGED
)
18323 END_UNCHANGED
= Z
- GPT
;
18326 /* The position of the first and last character that has been changed. */
18327 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
18328 last_changed_charpos
= Z
- END_UNCHANGED
;
18330 /* If window starts after a line end, and the last change is in
18331 front of that newline, then changes don't affect the display.
18332 This case happens with stealth-fontification. Note that although
18333 the display is unchanged, glyph positions in the matrix have to
18334 be adjusted, of course. */
18335 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
18336 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
18337 && ((last_changed_charpos
< CHARPOS (start
)
18338 && CHARPOS (start
) == BEGV
)
18339 || (last_changed_charpos
< CHARPOS (start
) - 1
18340 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
18342 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
18343 struct glyph_row
*r0
;
18345 /* Compute how many chars/bytes have been added to or removed
18346 from the buffer. */
18347 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
18348 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
18349 Z_delta
= Z
- Z_old
;
18350 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
18352 /* Give up if PT is not in the window. Note that it already has
18353 been checked at the start of try_window_id that PT is not in
18354 front of the window start. */
18355 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18358 /* If window start is unchanged, we can reuse the whole matrix
18359 as is, after adjusting glyph positions. No need to compute
18360 the window end again, since its offset from Z hasn't changed. */
18361 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18362 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18363 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18364 /* PT must not be in a partially visible line. */
18365 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18366 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18368 /* Adjust positions in the glyph matrix. */
18369 if (Z_delta
|| Z_delta_bytes
)
18371 struct glyph_row
*r1
18372 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18373 increment_matrix_positions (w
->current_matrix
,
18374 MATRIX_ROW_VPOS (r0
, current_matrix
),
18375 MATRIX_ROW_VPOS (r1
, current_matrix
),
18376 Z_delta
, Z_delta_bytes
);
18379 /* Set the cursor. */
18380 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18382 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18387 /* Handle the case that changes are all below what is displayed in
18388 the window, and that PT is in the window. This shortcut cannot
18389 be taken if ZV is visible in the window, and text has been added
18390 there that is visible in the window. */
18391 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18392 /* ZV is not visible in the window, or there are no
18393 changes at ZV, actually. */
18394 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18395 || first_changed_charpos
== last_changed_charpos
))
18397 struct glyph_row
*r0
;
18399 /* Give up if PT is not in the window. Note that it already has
18400 been checked at the start of try_window_id that PT is not in
18401 front of the window start. */
18402 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18405 /* If window start is unchanged, we can reuse the whole matrix
18406 as is, without changing glyph positions since no text has
18407 been added/removed in front of the window end. */
18408 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18409 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18410 /* PT must not be in a partially visible line. */
18411 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18412 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18414 /* We have to compute the window end anew since text
18415 could have been added/removed after it. */
18416 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18417 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18419 /* Set the cursor. */
18420 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18422 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18427 /* Give up if window start is in the changed area.
18429 The condition used to read
18431 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18433 but why that was tested escapes me at the moment. */
18434 if (CHARPOS (start
) >= first_changed_charpos
18435 && CHARPOS (start
) <= last_changed_charpos
)
18438 /* Check that window start agrees with the start of the first glyph
18439 row in its current matrix. Check this after we know the window
18440 start is not in changed text, otherwise positions would not be
18442 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18443 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18446 /* Give up if the window ends in strings. Overlay strings
18447 at the end are difficult to handle, so don't try. */
18448 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18449 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18452 /* Compute the position at which we have to start displaying new
18453 lines. Some of the lines at the top of the window might be
18454 reusable because they are not displaying changed text. Find the
18455 last row in W's current matrix not affected by changes at the
18456 start of current_buffer. Value is null if changes start in the
18457 first line of window. */
18458 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18459 if (last_unchanged_at_beg_row
)
18461 /* Avoid starting to display in the middle of a character, a TAB
18462 for instance. This is easier than to set up the iterator
18463 exactly, and it's not a frequent case, so the additional
18464 effort wouldn't really pay off. */
18465 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18466 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18467 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18468 --last_unchanged_at_beg_row
;
18470 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18473 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18475 start_pos
= it
.current
.pos
;
18477 /* Start displaying new lines in the desired matrix at the same
18478 vpos we would use in the current matrix, i.e. below
18479 last_unchanged_at_beg_row. */
18480 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18482 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18483 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18485 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18489 /* There are no reusable lines at the start of the window.
18490 Start displaying in the first text line. */
18491 start_display (&it
, w
, start
);
18492 it
.vpos
= it
.first_vpos
;
18493 start_pos
= it
.current
.pos
;
18496 /* Find the first row that is not affected by changes at the end of
18497 the buffer. Value will be null if there is no unchanged row, in
18498 which case we must redisplay to the end of the window. delta
18499 will be set to the value by which buffer positions beginning with
18500 first_unchanged_at_end_row have to be adjusted due to text
18502 first_unchanged_at_end_row
18503 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18504 IF_DEBUG (debug_delta
= delta
);
18505 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18507 /* Set stop_pos to the buffer position up to which we will have to
18508 display new lines. If first_unchanged_at_end_row != NULL, this
18509 is the buffer position of the start of the line displayed in that
18510 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18511 that we don't stop at a buffer position. */
18513 if (first_unchanged_at_end_row
)
18515 eassert (last_unchanged_at_beg_row
== NULL
18516 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18518 /* If this is a continuation line, move forward to the next one
18519 that isn't. Changes in lines above affect this line.
18520 Caution: this may move first_unchanged_at_end_row to a row
18521 not displaying text. */
18522 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18523 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18524 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18525 < it
.last_visible_y
))
18526 ++first_unchanged_at_end_row
;
18528 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18529 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18530 >= it
.last_visible_y
))
18531 first_unchanged_at_end_row
= NULL
;
18534 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18536 first_unchanged_at_end_vpos
18537 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18538 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18541 else if (last_unchanged_at_beg_row
== NULL
)
18547 /* Either there is no unchanged row at the end, or the one we have
18548 now displays text. This is a necessary condition for the window
18549 end pos calculation at the end of this function. */
18550 eassert (first_unchanged_at_end_row
== NULL
18551 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18553 debug_last_unchanged_at_beg_vpos
18554 = (last_unchanged_at_beg_row
18555 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18557 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18559 #endif /* GLYPH_DEBUG */
18562 /* Display new lines. Set last_text_row to the last new line
18563 displayed which has text on it, i.e. might end up as being the
18564 line where the window_end_vpos is. */
18565 w
->cursor
.vpos
= -1;
18566 last_text_row
= NULL
;
18567 overlay_arrow_seen
= false;
18568 if (it
.current_y
< it
.last_visible_y
18569 && !f
->fonts_changed
18570 && (first_unchanged_at_end_row
== NULL
18571 || IT_CHARPOS (it
) < stop_pos
))
18572 it
.glyph_row
->reversed_p
= false;
18573 while (it
.current_y
< it
.last_visible_y
18574 && !f
->fonts_changed
18575 && (first_unchanged_at_end_row
== NULL
18576 || IT_CHARPOS (it
) < stop_pos
))
18578 if (display_line (&it
))
18579 last_text_row
= it
.glyph_row
- 1;
18582 if (f
->fonts_changed
)
18585 /* The redisplay iterations in display_line above could have
18586 triggered font-lock, which could have done something that
18587 invalidates IT->w window's end-point information, on which we
18588 rely below. E.g., one package, which will remain unnamed, used
18589 to install a font-lock-fontify-region-function that called
18590 bury-buffer, whose side effect is to switch the buffer displayed
18591 by IT->w, and that predictably resets IT->w's window_end_valid
18592 flag, which we already tested at the entry to this function.
18593 Amply punish such packages/modes by giving up on this
18594 optimization in those cases. */
18595 if (!w
->window_end_valid
)
18597 clear_glyph_matrix (w
->desired_matrix
);
18601 /* Compute differences in buffer positions, y-positions etc. for
18602 lines reused at the bottom of the window. Compute what we can
18604 if (first_unchanged_at_end_row
18605 /* No lines reused because we displayed everything up to the
18606 bottom of the window. */
18607 && it
.current_y
< it
.last_visible_y
)
18610 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18612 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18613 run
.current_y
= first_unchanged_at_end_row
->y
;
18614 run
.desired_y
= run
.current_y
+ dy
;
18615 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18619 delta
= delta_bytes
= dvpos
= dy
18620 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18621 first_unchanged_at_end_row
= NULL
;
18623 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18626 /* Find the cursor if not already found. We have to decide whether
18627 PT will appear on this window (it sometimes doesn't, but this is
18628 not a very frequent case.) This decision has to be made before
18629 the current matrix is altered. A value of cursor.vpos < 0 means
18630 that PT is either in one of the lines beginning at
18631 first_unchanged_at_end_row or below the window. Don't care for
18632 lines that might be displayed later at the window end; as
18633 mentioned, this is not a frequent case. */
18634 if (w
->cursor
.vpos
< 0)
18636 /* Cursor in unchanged rows at the top? */
18637 if (PT
< CHARPOS (start_pos
)
18638 && last_unchanged_at_beg_row
)
18640 row
= row_containing_pos (w
, PT
,
18641 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18642 last_unchanged_at_beg_row
+ 1, 0);
18644 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18647 /* Start from first_unchanged_at_end_row looking for PT. */
18648 else if (first_unchanged_at_end_row
)
18650 row
= row_containing_pos (w
, PT
- delta
,
18651 first_unchanged_at_end_row
, NULL
, 0);
18653 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18654 delta_bytes
, dy
, dvpos
);
18657 /* Give up if cursor was not found. */
18658 if (w
->cursor
.vpos
< 0)
18660 clear_glyph_matrix (w
->desired_matrix
);
18665 /* Don't let the cursor end in the scroll margins. */
18667 int this_scroll_margin
= window_scroll_margin (w
, MARGIN_IN_PIXELS
);
18668 int cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18670 if ((w
->cursor
.y
< this_scroll_margin
18671 && CHARPOS (start
) > BEGV
)
18672 /* Old redisplay didn't take scroll margin into account at the bottom,
18673 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18674 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18675 ? cursor_height
+ this_scroll_margin
18676 : 1)) > it
.last_visible_y
)
18678 w
->cursor
.vpos
= -1;
18679 clear_glyph_matrix (w
->desired_matrix
);
18684 /* Scroll the display. Do it before changing the current matrix so
18685 that xterm.c doesn't get confused about where the cursor glyph is
18687 if (dy
&& run
.height
)
18691 if (FRAME_WINDOW_P (f
))
18693 FRAME_RIF (f
)->update_window_begin_hook (w
);
18694 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18695 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18696 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18700 /* Terminal frame. In this case, dvpos gives the number of
18701 lines to scroll by; dvpos < 0 means scroll up. */
18703 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18704 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18705 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18706 + WINDOW_WANTS_HEADER_LINE_P (w
)
18707 + window_internal_height (w
));
18709 #if defined (HAVE_GPM) || defined (MSDOS)
18710 x_clear_window_mouse_face (w
);
18712 /* Perform the operation on the screen. */
18715 /* Scroll last_unchanged_at_beg_row to the end of the
18716 window down dvpos lines. */
18717 set_terminal_window (f
, end
);
18719 /* On dumb terminals delete dvpos lines at the end
18720 before inserting dvpos empty lines. */
18721 if (!FRAME_SCROLL_REGION_OK (f
))
18722 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18724 /* Insert dvpos empty lines in front of
18725 last_unchanged_at_beg_row. */
18726 ins_del_lines (f
, from
, dvpos
);
18728 else if (dvpos
< 0)
18730 /* Scroll up last_unchanged_at_beg_vpos to the end of
18731 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18732 set_terminal_window (f
, end
);
18734 /* Delete dvpos lines in front of
18735 last_unchanged_at_beg_vpos. ins_del_lines will set
18736 the cursor to the given vpos and emit |dvpos| delete
18738 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18740 /* On a dumb terminal insert dvpos empty lines at the
18742 if (!FRAME_SCROLL_REGION_OK (f
))
18743 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18746 set_terminal_window (f
, 0);
18752 /* Shift reused rows of the current matrix to the right position.
18753 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18755 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18756 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18759 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18760 bottom_vpos
, dvpos
);
18761 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18764 else if (dvpos
> 0)
18766 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18767 bottom_vpos
, dvpos
);
18768 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18769 first_unchanged_at_end_vpos
+ dvpos
);
18772 /* For frame-based redisplay, make sure that current frame and window
18773 matrix are in sync with respect to glyph memory. */
18774 if (!FRAME_WINDOW_P (f
))
18775 sync_frame_with_window_matrix_rows (w
);
18777 /* Adjust buffer positions in reused rows. */
18778 if (delta
|| delta_bytes
)
18779 increment_matrix_positions (current_matrix
,
18780 first_unchanged_at_end_vpos
+ dvpos
,
18781 bottom_vpos
, delta
, delta_bytes
);
18783 /* Adjust Y positions. */
18785 shift_glyph_matrix (w
, current_matrix
,
18786 first_unchanged_at_end_vpos
+ dvpos
,
18789 if (first_unchanged_at_end_row
)
18791 first_unchanged_at_end_row
+= dvpos
;
18792 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18793 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18794 first_unchanged_at_end_row
= NULL
;
18797 /* If scrolling up, there may be some lines to display at the end of
18799 last_text_row_at_end
= NULL
;
18802 /* Scrolling up can leave for example a partially visible line
18803 at the end of the window to be redisplayed. */
18804 /* Set last_row to the glyph row in the current matrix where the
18805 window end line is found. It has been moved up or down in
18806 the matrix by dvpos. */
18807 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18808 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18810 /* If last_row is the window end line, it should display text. */
18811 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18813 /* If window end line was partially visible before, begin
18814 displaying at that line. Otherwise begin displaying with the
18815 line following it. */
18816 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18818 init_to_row_start (&it
, w
, last_row
);
18819 it
.vpos
= last_vpos
;
18820 it
.current_y
= last_row
->y
;
18824 init_to_row_end (&it
, w
, last_row
);
18825 it
.vpos
= 1 + last_vpos
;
18826 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18830 /* We may start in a continuation line. If so, we have to
18831 get the right continuation_lines_width and current_x. */
18832 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18833 it
.hpos
= it
.current_x
= 0;
18835 /* Display the rest of the lines at the window end. */
18836 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18837 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18839 /* Is it always sure that the display agrees with lines in
18840 the current matrix? I don't think so, so we mark rows
18841 displayed invalid in the current matrix by setting their
18842 enabled_p flag to false. */
18843 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18844 if (display_line (&it
))
18845 last_text_row_at_end
= it
.glyph_row
- 1;
18849 /* Update window_end_pos and window_end_vpos. */
18850 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18852 /* Window end line if one of the preserved rows from the current
18853 matrix. Set row to the last row displaying text in current
18854 matrix starting at first_unchanged_at_end_row, after
18856 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18857 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18858 first_unchanged_at_end_row
);
18859 eassume (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18860 adjust_window_ends (w
, row
, true);
18861 eassert (w
->window_end_bytepos
>= 0);
18862 IF_DEBUG (debug_method_add (w
, "A"));
18864 else if (last_text_row_at_end
)
18866 adjust_window_ends (w
, last_text_row_at_end
, false);
18867 eassert (w
->window_end_bytepos
>= 0);
18868 IF_DEBUG (debug_method_add (w
, "B"));
18870 else if (last_text_row
)
18872 /* We have displayed either to the end of the window or at the
18873 end of the window, i.e. the last row with text is to be found
18874 in the desired matrix. */
18875 adjust_window_ends (w
, last_text_row
, false);
18876 eassert (w
->window_end_bytepos
>= 0);
18878 else if (first_unchanged_at_end_row
== NULL
18879 && last_text_row
== NULL
18880 && last_text_row_at_end
== NULL
)
18882 /* Displayed to end of window, but no line containing text was
18883 displayed. Lines were deleted at the end of the window. */
18884 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18885 int vpos
= w
->window_end_vpos
;
18886 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18887 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18889 for (row
= NULL
; !row
; --vpos
, --current_row
, --desired_row
)
18891 eassert (first_vpos
<= vpos
);
18892 if (desired_row
->enabled_p
)
18894 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18897 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18901 w
->window_end_vpos
= vpos
+ 1;
18902 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18903 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18904 eassert (w
->window_end_bytepos
>= 0);
18905 IF_DEBUG (debug_method_add (w
, "C"));
18910 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18911 debug_end_vpos
= w
->window_end_vpos
));
18913 /* Record that display has not been completed. */
18914 w
->window_end_valid
= false;
18915 w
->desired_matrix
->no_scrolling_p
= true;
18923 /***********************************************************************
18924 More debugging support
18925 ***********************************************************************/
18929 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18930 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18931 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18934 /* Dump the contents of glyph matrix MATRIX on stderr.
18936 GLYPHS 0 means don't show glyph contents.
18937 GLYPHS 1 means show glyphs in short form
18938 GLYPHS > 1 means show glyphs in long form. */
18941 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18944 for (i
= 0; i
< matrix
->nrows
; ++i
)
18945 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18949 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18950 the glyph row and area where the glyph comes from. */
18953 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18955 if (glyph
->type
== CHAR_GLYPH
18956 || glyph
->type
== GLYPHLESS_GLYPH
)
18959 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18960 glyph
- row
->glyphs
[TEXT_AREA
],
18961 (glyph
->type
== CHAR_GLYPH
18965 (BUFFERP (glyph
->object
)
18967 : (STRINGP (glyph
->object
)
18969 : (NILP (glyph
->object
)
18972 glyph
->pixel_width
,
18974 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18978 glyph
->left_box_line_p
,
18979 glyph
->right_box_line_p
);
18981 else if (glyph
->type
== STRETCH_GLYPH
)
18984 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18985 glyph
- row
->glyphs
[TEXT_AREA
],
18988 (BUFFERP (glyph
->object
)
18990 : (STRINGP (glyph
->object
)
18992 : (NILP (glyph
->object
)
18995 glyph
->pixel_width
,
18999 glyph
->left_box_line_p
,
19000 glyph
->right_box_line_p
);
19002 else if (glyph
->type
== IMAGE_GLYPH
)
19005 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
19006 glyph
- row
->glyphs
[TEXT_AREA
],
19009 (BUFFERP (glyph
->object
)
19011 : (STRINGP (glyph
->object
)
19013 : (NILP (glyph
->object
)
19016 glyph
->pixel_width
,
19020 glyph
->left_box_line_p
,
19021 glyph
->right_box_line_p
);
19023 else if (glyph
->type
== COMPOSITE_GLYPH
)
19026 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
19027 glyph
- row
->glyphs
[TEXT_AREA
],
19030 (BUFFERP (glyph
->object
)
19032 : (STRINGP (glyph
->object
)
19034 : (NILP (glyph
->object
)
19037 glyph
->pixel_width
,
19039 if (glyph
->u
.cmp
.automatic
)
19042 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
19043 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
19045 glyph
->left_box_line_p
,
19046 glyph
->right_box_line_p
);
19048 else if (glyph
->type
== XWIDGET_GLYPH
)
19050 #ifndef HAVE_XWIDGETS
19054 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
19055 glyph
- row
->glyphs
[TEXT_AREA
],
19058 (BUFFERP (glyph
->object
)
19060 : (STRINGP (glyph
->object
)
19063 glyph
->pixel_width
,
19067 glyph
->left_box_line_p
,
19068 glyph
->right_box_line_p
);
19074 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
19075 GLYPHS 0 means don't show glyph contents.
19076 GLYPHS 1 means show glyphs in short form
19077 GLYPHS > 1 means show glyphs in long form. */
19080 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
19084 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
19085 fprintf (stderr
, "==============================================================================\n");
19087 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
19088 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
19090 MATRIX_ROW_START_CHARPOS (row
),
19091 MATRIX_ROW_END_CHARPOS (row
),
19092 row
->used
[TEXT_AREA
],
19093 row
->contains_overlapping_glyphs_p
,
19095 row
->truncated_on_left_p
,
19096 row
->truncated_on_right_p
,
19098 MATRIX_ROW_CONTINUATION_LINE_P (row
),
19099 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
19102 row
->ends_in_middle_of_char_p
,
19103 row
->starts_in_middle_of_char_p
,
19109 row
->visible_height
,
19112 /* The next 3 lines should align to "Start" in the header. */
19113 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
19114 row
->end
.overlay_string_index
,
19115 row
->continuation_lines_width
);
19116 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
19117 CHARPOS (row
->start
.string_pos
),
19118 CHARPOS (row
->end
.string_pos
));
19119 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
19120 row
->end
.dpvec_index
);
19127 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19129 struct glyph
*glyph
= row
->glyphs
[area
];
19130 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
19132 /* Glyph for a line end in text. */
19133 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
19136 if (glyph
< glyph_end
)
19137 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
19139 for (; glyph
< glyph_end
; ++glyph
)
19140 dump_glyph (row
, glyph
, area
);
19143 else if (glyphs
== 1)
19146 char s
[SHRT_MAX
+ 4];
19148 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19152 for (i
= 0; i
< row
->used
[area
]; ++i
)
19154 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
19155 if (i
== row
->used
[area
] - 1
19156 && area
== TEXT_AREA
19157 && NILP (glyph
->object
)
19158 && glyph
->type
== CHAR_GLYPH
19159 && glyph
->u
.ch
== ' ')
19161 strcpy (&s
[i
], "[\\n]");
19164 else if (glyph
->type
== CHAR_GLYPH
19165 && glyph
->u
.ch
< 0x80
19166 && glyph
->u
.ch
>= ' ')
19167 s
[i
] = glyph
->u
.ch
;
19173 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
19179 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
19180 Sdump_glyph_matrix
, 0, 1, "p",
19181 doc
: /* Dump the current matrix of the selected window to stderr.
19182 Shows contents of glyph row structures. With non-nil
19183 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
19184 glyphs in short form, otherwise show glyphs in long form.
19186 Interactively, no argument means show glyphs in short form;
19187 with numeric argument, its value is passed as the GLYPHS flag. */)
19188 (Lisp_Object glyphs
)
19190 struct window
*w
= XWINDOW (selected_window
);
19191 struct buffer
*buffer
= XBUFFER (w
->contents
);
19193 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
19194 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
19195 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
19196 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
19197 fprintf (stderr
, "=============================================\n");
19198 dump_glyph_matrix (w
->current_matrix
,
19199 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
19204 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
19205 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
19206 Only text-mode frames have frame glyph matrices. */)
19209 struct frame
*f
= XFRAME (selected_frame
);
19211 if (f
->current_matrix
)
19212 dump_glyph_matrix (f
->current_matrix
, 1);
19214 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
19219 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
19220 doc
: /* Dump glyph row ROW to stderr.
19221 GLYPH 0 means don't dump glyphs.
19222 GLYPH 1 means dump glyphs in short form.
19223 GLYPH > 1 or omitted means dump glyphs in long form. */)
19224 (Lisp_Object row
, Lisp_Object glyphs
)
19226 struct glyph_matrix
*matrix
;
19229 CHECK_NUMBER (row
);
19230 matrix
= XWINDOW (selected_window
)->current_matrix
;
19232 if (vpos
>= 0 && vpos
< matrix
->nrows
)
19233 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
19235 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19240 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
19241 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
19242 GLYPH 0 means don't dump glyphs.
19243 GLYPH 1 means dump glyphs in short form.
19244 GLYPH > 1 or omitted means dump glyphs in long form.
19246 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
19248 (Lisp_Object row
, Lisp_Object glyphs
)
19250 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19251 struct frame
*sf
= SELECTED_FRAME ();
19252 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
19255 CHECK_NUMBER (row
);
19257 if (vpos
>= 0 && vpos
< m
->nrows
)
19258 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
19259 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19265 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
19266 doc
: /* Toggle tracing of redisplay.
19267 With ARG, turn tracing on if and only if ARG is positive. */)
19271 trace_redisplay_p
= !trace_redisplay_p
;
19274 arg
= Fprefix_numeric_value (arg
);
19275 trace_redisplay_p
= XINT (arg
) > 0;
19282 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
19283 doc
: /* Like `format', but print result to stderr.
19284 usage: (trace-to-stderr STRING &rest OBJECTS) */)
19285 (ptrdiff_t nargs
, Lisp_Object
*args
)
19287 Lisp_Object s
= Fformat (nargs
, args
);
19288 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
19292 #endif /* GLYPH_DEBUG */
19296 /***********************************************************************
19297 Building Desired Matrix Rows
19298 ***********************************************************************/
19300 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
19301 Used for non-window-redisplay windows, and for windows w/o left fringe. */
19303 static struct glyph_row
*
19304 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
19306 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19307 struct buffer
*buffer
= XBUFFER (w
->contents
);
19308 struct buffer
*old
= current_buffer
;
19309 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
19310 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
19311 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
19312 const unsigned char *p
;
19315 int n_glyphs_before
;
19317 set_buffer_temp (buffer
);
19318 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
19319 scratch_glyph_row
.reversed_p
= false;
19320 it
.glyph_row
->used
[TEXT_AREA
] = 0;
19321 SET_TEXT_POS (it
.position
, 0, 0);
19323 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
19325 while (p
< arrow_end
)
19327 Lisp_Object face
, ilisp
;
19329 /* Get the next character. */
19331 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
19334 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
19335 if (! ASCII_CHAR_P (it
.c
))
19336 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
19340 /* Get its face. */
19341 ilisp
= make_number (p
- arrow_string
);
19342 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
19343 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
19345 /* Compute its width, get its glyphs. */
19346 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
19347 SET_TEXT_POS (it
.position
, -1, -1);
19348 PRODUCE_GLYPHS (&it
);
19350 /* If this character doesn't fit any more in the line, we have
19351 to remove some glyphs. */
19352 if (it
.current_x
> it
.last_visible_x
)
19354 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19359 set_buffer_temp (old
);
19360 return it
.glyph_row
;
19364 /* Insert truncation glyphs at the start of IT->glyph_row. Which
19365 glyphs to insert is determined by produce_special_glyphs. */
19368 insert_left_trunc_glyphs (struct it
*it
)
19370 struct it truncate_it
;
19371 struct glyph
*from
, *end
, *to
, *toend
;
19373 eassert (!FRAME_WINDOW_P (it
->f
)
19374 || (!it
->glyph_row
->reversed_p
19375 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19376 || (it
->glyph_row
->reversed_p
19377 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
19379 /* Get the truncation glyphs. */
19381 truncate_it
.current_x
= 0;
19382 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19383 truncate_it
.glyph_row
= &scratch_glyph_row
;
19384 truncate_it
.area
= TEXT_AREA
;
19385 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19386 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19387 truncate_it
.object
= Qnil
;
19388 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19390 /* Overwrite glyphs from IT with truncation glyphs. */
19391 if (!it
->glyph_row
->reversed_p
)
19393 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19395 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19396 end
= from
+ tused
;
19397 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19398 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19399 if (FRAME_WINDOW_P (it
->f
))
19401 /* On GUI frames, when variable-size fonts are displayed,
19402 the truncation glyphs may need more pixels than the row's
19403 glyphs they overwrite. We overwrite more glyphs to free
19404 enough screen real estate, and enlarge the stretch glyph
19405 on the right (see display_line), if there is one, to
19406 preserve the screen position of the truncation glyphs on
19409 struct glyph
*g
= to
;
19412 /* The first glyph could be partially visible, in which case
19413 it->glyph_row->x will be negative. But we want the left
19414 truncation glyphs to be aligned at the left margin of the
19415 window, so we override the x coordinate at which the row
19417 it
->glyph_row
->x
= 0;
19418 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19420 w
+= g
->pixel_width
;
19423 if (g
- to
- tused
> 0)
19425 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19426 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19428 used
= it
->glyph_row
->used
[TEXT_AREA
];
19429 if (it
->glyph_row
->truncated_on_right_p
19430 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19431 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19434 int extra
= w
- it
->truncation_pixel_width
;
19436 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19443 /* There may be padding glyphs left over. Overwrite them too. */
19444 if (!FRAME_WINDOW_P (it
->f
))
19446 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19448 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19455 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19459 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19461 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19462 that back to front. */
19463 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19464 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19465 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19466 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19467 if (FRAME_WINDOW_P (it
->f
))
19470 struct glyph
*g
= to
;
19472 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19474 w
+= g
->pixel_width
;
19477 if (to
- g
- tused
> 0)
19479 if (it
->glyph_row
->truncated_on_right_p
19480 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19481 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19483 int extra
= w
- it
->truncation_pixel_width
;
19485 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19489 while (from
>= end
&& to
>= toend
)
19491 if (!FRAME_WINDOW_P (it
->f
))
19493 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19496 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19497 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19498 while (from
>= end
&& to
>= toend
)
19504 /* Need to free some room before prepending additional
19506 int move_by
= from
- end
+ 1;
19507 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19508 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19510 for ( ; g
>= g0
; g
--)
19512 while (from
>= end
)
19514 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19519 /* Compute the hash code for ROW. */
19521 row_hash (struct glyph_row
*row
)
19524 unsigned hashval
= 0;
19526 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19527 for (k
= 0; k
< row
->used
[area
]; ++k
)
19528 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19529 + row
->glyphs
[area
][k
].u
.val
19530 + row
->glyphs
[area
][k
].face_id
19531 + row
->glyphs
[area
][k
].padding_p
19532 + (row
->glyphs
[area
][k
].type
<< 2));
19537 /* Compute the pixel height and width of IT->glyph_row.
19539 Most of the time, ascent and height of a display line will be equal
19540 to the max_ascent and max_height values of the display iterator
19541 structure. This is not the case if
19543 1. We hit ZV without displaying anything. In this case, max_ascent
19544 and max_height will be zero.
19546 2. We have some glyphs that don't contribute to the line height.
19547 (The glyph row flag contributes_to_line_height_p is for future
19548 pixmap extensions).
19550 The first case is easily covered by using default values because in
19551 these cases, the line height does not really matter, except that it
19552 must not be zero. */
19555 compute_line_metrics (struct it
*it
)
19557 struct glyph_row
*row
= it
->glyph_row
;
19559 if (FRAME_WINDOW_P (it
->f
))
19561 int i
, min_y
, max_y
;
19563 /* The line may consist of one space only, that was added to
19564 place the cursor on it. If so, the row's height hasn't been
19566 if (row
->height
== 0)
19568 if (it
->max_ascent
+ it
->max_descent
== 0)
19569 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19570 row
->ascent
= it
->max_ascent
;
19571 row
->height
= it
->max_ascent
+ it
->max_descent
;
19572 row
->phys_ascent
= it
->max_phys_ascent
;
19573 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19574 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19577 /* Compute the width of this line. */
19578 row
->pixel_width
= row
->x
;
19579 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19580 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19582 eassert (row
->pixel_width
>= 0);
19583 eassert (row
->ascent
>= 0 && row
->height
> 0);
19585 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19586 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19588 /* If first line's physical ascent is larger than its logical
19589 ascent, use the physical ascent, and make the row taller.
19590 This makes accented characters fully visible. */
19591 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19592 && row
->phys_ascent
> row
->ascent
)
19594 row
->height
+= row
->phys_ascent
- row
->ascent
;
19595 row
->ascent
= row
->phys_ascent
;
19598 /* Compute how much of the line is visible. */
19599 row
->visible_height
= row
->height
;
19601 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19602 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19604 if (row
->y
< min_y
)
19605 row
->visible_height
-= min_y
- row
->y
;
19606 if (row
->y
+ row
->height
> max_y
)
19607 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19611 row
->pixel_width
= row
->used
[TEXT_AREA
];
19612 if (row
->continued_p
)
19613 row
->pixel_width
-= it
->continuation_pixel_width
;
19614 else if (row
->truncated_on_right_p
)
19615 row
->pixel_width
-= it
->truncation_pixel_width
;
19616 row
->ascent
= row
->phys_ascent
= 0;
19617 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19618 row
->extra_line_spacing
= 0;
19621 /* Compute a hash code for this row. */
19622 row
->hash
= row_hash (row
);
19624 it
->max_ascent
= it
->max_descent
= 0;
19625 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19629 /* Append one space to the glyph row of iterator IT if doing a
19630 window-based redisplay. The space has the same face as
19631 IT->face_id. Value is true if a space was added.
19633 This function is called to make sure that there is always one glyph
19634 at the end of a glyph row that the cursor can be set on under
19635 window-systems. (If there weren't such a glyph we would not know
19636 how wide and tall a box cursor should be displayed).
19638 At the same time this space let's a nicely handle clearing to the
19639 end of the line if the row ends in italic text. */
19642 append_space_for_newline (struct it
*it
, bool default_face_p
)
19644 if (FRAME_WINDOW_P (it
->f
))
19646 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19648 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19649 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19651 /* Save some values that must not be changed.
19652 Must save IT->c and IT->len because otherwise
19653 ITERATOR_AT_END_P wouldn't work anymore after
19654 append_space_for_newline has been called. */
19655 enum display_element_type saved_what
= it
->what
;
19656 int saved_c
= it
->c
, saved_len
= it
->len
;
19657 int saved_char_to_display
= it
->char_to_display
;
19658 int saved_x
= it
->current_x
;
19659 int saved_face_id
= it
->face_id
;
19660 bool saved_box_end
= it
->end_of_box_run_p
;
19661 struct text_pos saved_pos
;
19662 Lisp_Object saved_object
;
19665 saved_object
= it
->object
;
19666 saved_pos
= it
->position
;
19668 it
->what
= IT_CHARACTER
;
19669 memset (&it
->position
, 0, sizeof it
->position
);
19671 it
->c
= it
->char_to_display
= ' ';
19674 /* If the default face was remapped, be sure to use the
19675 remapped face for the appended newline. */
19676 if (default_face_p
)
19677 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19678 else if (it
->face_before_selective_p
)
19679 it
->face_id
= it
->saved_face_id
;
19680 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19681 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19682 /* In R2L rows, we will prepend a stretch glyph that will
19683 have the end_of_box_run_p flag set for it, so there's no
19684 need for the appended newline glyph to have that flag
19686 if (it
->glyph_row
->reversed_p
19687 /* But if the appended newline glyph goes all the way to
19688 the end of the row, there will be no stretch glyph,
19689 so leave the box flag set. */
19690 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19691 it
->end_of_box_run_p
= false;
19693 PRODUCE_GLYPHS (it
);
19695 #ifdef HAVE_WINDOW_SYSTEM
19696 /* Make sure this space glyph has the right ascent and
19697 descent values, or else cursor at end of line will look
19698 funny, and height of empty lines will be incorrect. */
19699 struct glyph
*g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19700 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19703 Lisp_Object height
, total_height
;
19704 int extra_line_spacing
= it
->extra_line_spacing
;
19705 int boff
= font
->baseline_offset
;
19707 if (font
->vertical_centering
)
19708 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19710 it
->object
= saved_object
; /* get_it_property needs this */
19711 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19712 /* Must do a subset of line height processing from
19713 x_produce_glyph for newline characters. */
19714 height
= get_it_property (it
, Qline_height
);
19716 && CONSP (XCDR (height
))
19717 && NILP (XCDR (XCDR (height
))))
19719 total_height
= XCAR (XCDR (height
));
19720 height
= XCAR (height
);
19723 total_height
= Qnil
;
19724 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19726 if (it
->override_ascent
>= 0)
19728 it
->ascent
= it
->override_ascent
;
19729 it
->descent
= it
->override_descent
;
19730 boff
= it
->override_boff
;
19732 if (EQ (height
, Qt
))
19733 extra_line_spacing
= 0;
19736 Lisp_Object spacing
;
19738 it
->phys_ascent
= it
->ascent
;
19739 it
->phys_descent
= it
->descent
;
19741 && XINT (height
) > it
->ascent
+ it
->descent
)
19742 it
->ascent
= XINT (height
) - it
->descent
;
19744 if (!NILP (total_height
))
19745 spacing
= calc_line_height_property (it
, total_height
, font
,
19749 spacing
= get_it_property (it
, Qline_spacing
);
19750 spacing
= calc_line_height_property (it
, spacing
, font
,
19753 if (INTEGERP (spacing
))
19755 extra_line_spacing
= XINT (spacing
);
19756 if (!NILP (total_height
))
19757 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19760 if (extra_line_spacing
> 0)
19762 it
->descent
+= extra_line_spacing
;
19763 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19764 it
->max_extra_line_spacing
= extra_line_spacing
;
19766 it
->max_ascent
= it
->ascent
;
19767 it
->max_descent
= it
->descent
;
19768 /* Make sure compute_line_metrics recomputes the row height. */
19769 it
->glyph_row
->height
= 0;
19772 g
->ascent
= it
->max_ascent
;
19773 g
->descent
= it
->max_descent
;
19776 it
->override_ascent
= -1;
19777 it
->constrain_row_ascent_descent_p
= false;
19778 it
->current_x
= saved_x
;
19779 it
->object
= saved_object
;
19780 it
->position
= saved_pos
;
19781 it
->what
= saved_what
;
19782 it
->face_id
= saved_face_id
;
19783 it
->len
= saved_len
;
19785 it
->char_to_display
= saved_char_to_display
;
19786 it
->end_of_box_run_p
= saved_box_end
;
19795 /* Extend the face of the last glyph in the text area of IT->glyph_row
19796 to the end of the display line. Called from display_line. If the
19797 glyph row is empty, add a space glyph to it so that we know the
19798 face to draw. Set the glyph row flag fill_line_p. If the glyph
19799 row is R2L, prepend a stretch glyph to cover the empty space to the
19800 left of the leftmost glyph. */
19803 extend_face_to_end_of_line (struct it
*it
)
19805 struct face
*face
, *default_face
;
19806 struct frame
*f
= it
->f
;
19808 /* If line is already filled, do nothing. Non window-system frames
19809 get a grace of one more ``pixel'' because their characters are
19810 1-``pixel'' wide, so they hit the equality too early. This grace
19811 is needed only for R2L rows that are not continued, to produce
19812 one extra blank where we could display the cursor. */
19813 if ((it
->current_x
>= it
->last_visible_x
19814 + (!FRAME_WINDOW_P (f
)
19815 && it
->glyph_row
->reversed_p
19816 && !it
->glyph_row
->continued_p
))
19817 /* If the window has display margins, we will need to extend
19818 their face even if the text area is filled. */
19819 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19820 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19823 /* The default face, possibly remapped. */
19824 default_face
= FACE_FROM_ID_OR_NULL (f
,
19825 lookup_basic_face (f
, DEFAULT_FACE_ID
));
19827 /* Face extension extends the background and box of IT->face_id
19828 to the end of the line. If the background equals the background
19829 of the frame, we don't have to do anything. */
19830 face
= FACE_FROM_ID (f
, (it
->face_before_selective_p
19831 ? it
->saved_face_id
19834 if (FRAME_WINDOW_P (f
)
19835 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19836 && face
->box
== FACE_NO_BOX
19837 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19838 #ifdef HAVE_WINDOW_SYSTEM
19841 && !it
->glyph_row
->reversed_p
)
19844 /* Set the glyph row flag indicating that the face of the last glyph
19845 in the text area has to be drawn to the end of the text area. */
19846 it
->glyph_row
->fill_line_p
= true;
19848 /* If current character of IT is not ASCII, make sure we have the
19849 ASCII face. This will be automatically undone the next time
19850 get_next_display_element returns a multibyte character. Note
19851 that the character will always be single byte in unibyte
19853 if (!ASCII_CHAR_P (it
->c
))
19855 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19858 if (FRAME_WINDOW_P (f
))
19860 /* If the row is empty, add a space with the current face of IT,
19861 so that we know which face to draw. */
19862 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19864 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19865 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19866 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19868 /* Mode line and the header line don't have margins, and
19869 likewise the frame's tool-bar window, if there is any. */
19870 if (!(it
->glyph_row
->mode_line_p
19871 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19872 || (WINDOWP (f
->tool_bar_window
)
19873 && it
->w
== XWINDOW (f
->tool_bar_window
))
19877 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19878 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19880 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19881 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19883 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19885 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19886 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19888 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19889 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19891 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19894 #ifdef HAVE_WINDOW_SYSTEM
19895 if (it
->glyph_row
->reversed_p
)
19897 /* Prepend a stretch glyph to the row, such that the
19898 rightmost glyph will be drawn flushed all the way to the
19899 right margin of the window. The stretch glyph that will
19900 occupy the empty space, if any, to the left of the
19902 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19903 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19904 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19906 int row_width
, stretch_ascent
, stretch_width
;
19907 struct text_pos saved_pos
;
19909 bool saved_avoid_cursor
, saved_box_start
;
19911 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19912 row_width
+= g
->pixel_width
;
19914 /* FIXME: There are various minor display glitches in R2L
19915 rows when only one of the fringes is missing. The
19916 strange condition below produces the least bad effect. */
19917 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19918 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19919 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19920 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19922 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19923 stretch_width
-= row_width
;
19925 if (stretch_width
> 0)
19928 (((it
->ascent
+ it
->descent
)
19929 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19930 saved_pos
= it
->position
;
19931 memset (&it
->position
, 0, sizeof it
->position
);
19932 saved_avoid_cursor
= it
->avoid_cursor_p
;
19933 it
->avoid_cursor_p
= true;
19934 saved_face_id
= it
->face_id
;
19935 saved_box_start
= it
->start_of_box_run_p
;
19936 /* The last row's stretch glyph should get the default
19937 face, to avoid painting the rest of the window with
19938 the region face, if the region ends at ZV. */
19939 if (it
->glyph_row
->ends_at_zv_p
)
19940 it
->face_id
= default_face
->id
;
19942 it
->face_id
= face
->id
;
19943 it
->start_of_box_run_p
= false;
19944 append_stretch_glyph (it
, Qnil
, stretch_width
,
19945 it
->ascent
+ it
->descent
, stretch_ascent
);
19946 it
->position
= saved_pos
;
19947 it
->avoid_cursor_p
= saved_avoid_cursor
;
19948 it
->face_id
= saved_face_id
;
19949 it
->start_of_box_run_p
= saved_box_start
;
19951 /* If stretch_width comes out negative, it means that the
19952 last glyph is only partially visible. In R2L rows, we
19953 want the leftmost glyph to be partially visible, so we
19954 need to give the row the corresponding left offset. */
19955 if (stretch_width
< 0)
19956 it
->glyph_row
->x
= stretch_width
;
19958 #endif /* HAVE_WINDOW_SYSTEM */
19962 /* Save some values that must not be changed. */
19963 int saved_x
= it
->current_x
;
19964 struct text_pos saved_pos
;
19965 Lisp_Object saved_object
;
19966 enum display_element_type saved_what
= it
->what
;
19967 int saved_face_id
= it
->face_id
;
19969 saved_object
= it
->object
;
19970 saved_pos
= it
->position
;
19972 it
->what
= IT_CHARACTER
;
19973 memset (&it
->position
, 0, sizeof it
->position
);
19975 it
->c
= it
->char_to_display
= ' ';
19978 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19979 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19980 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19981 && !it
->glyph_row
->mode_line_p
19982 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19984 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19985 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19987 for (it
->current_x
= 0; g
< e
; g
++)
19988 it
->current_x
+= g
->pixel_width
;
19990 it
->area
= LEFT_MARGIN_AREA
;
19991 it
->face_id
= default_face
->id
;
19992 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19993 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19995 PRODUCE_GLYPHS (it
);
19996 /* term.c:produce_glyphs advances it->current_x only for
19998 it
->current_x
+= it
->pixel_width
;
20001 it
->current_x
= saved_x
;
20002 it
->area
= TEXT_AREA
;
20005 /* The last row's blank glyphs should get the default face, to
20006 avoid painting the rest of the window with the region face,
20007 if the region ends at ZV. */
20008 if (it
->glyph_row
->ends_at_zv_p
)
20009 it
->face_id
= default_face
->id
;
20011 it
->face_id
= face
->id
;
20012 PRODUCE_GLYPHS (it
);
20014 while (it
->current_x
<= it
->last_visible_x
)
20015 PRODUCE_GLYPHS (it
);
20017 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
20018 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
20019 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
20020 && !it
->glyph_row
->mode_line_p
20021 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
20023 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
20024 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
20026 for ( ; g
< e
; g
++)
20027 it
->current_x
+= g
->pixel_width
;
20029 it
->area
= RIGHT_MARGIN_AREA
;
20030 it
->face_id
= default_face
->id
;
20031 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
20032 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
20034 PRODUCE_GLYPHS (it
);
20035 it
->current_x
+= it
->pixel_width
;
20038 it
->area
= TEXT_AREA
;
20041 /* Don't count these blanks really. It would let us insert a left
20042 truncation glyph below and make us set the cursor on them, maybe. */
20043 it
->current_x
= saved_x
;
20044 it
->object
= saved_object
;
20045 it
->position
= saved_pos
;
20046 it
->what
= saved_what
;
20047 it
->face_id
= saved_face_id
;
20052 /* Value is true if text starting at CHARPOS in current_buffer is
20053 trailing whitespace. */
20056 trailing_whitespace_p (ptrdiff_t charpos
)
20058 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
20061 while (bytepos
< ZV_BYTE
20062 && (c
= FETCH_CHAR (bytepos
),
20063 c
== ' ' || c
== '\t'))
20066 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
20068 if (bytepos
!= PT_BYTE
)
20075 /* Highlight trailing whitespace, if any, in ROW. */
20078 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
20080 int used
= row
->used
[TEXT_AREA
];
20084 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
20085 struct glyph
*glyph
= start
+ used
- 1;
20087 if (row
->reversed_p
)
20089 /* Right-to-left rows need to be processed in the opposite
20090 direction, so swap the edge pointers. */
20092 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
20095 /* Skip over glyphs inserted to display the cursor at the
20096 end of a line, for extending the face of the last glyph
20097 to the end of the line on terminals, and for truncation
20098 and continuation glyphs. */
20099 if (!row
->reversed_p
)
20101 while (glyph
>= start
20102 && glyph
->type
== CHAR_GLYPH
20103 && NILP (glyph
->object
))
20108 while (glyph
<= start
20109 && glyph
->type
== CHAR_GLYPH
20110 && NILP (glyph
->object
))
20114 /* If last glyph is a space or stretch, and it's trailing
20115 whitespace, set the face of all trailing whitespace glyphs in
20116 IT->glyph_row to `trailing-whitespace'. */
20117 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
20118 && BUFFERP (glyph
->object
)
20119 && (glyph
->type
== STRETCH_GLYPH
20120 || (glyph
->type
== CHAR_GLYPH
20121 && glyph
->u
.ch
== ' '))
20122 && trailing_whitespace_p (glyph
->charpos
))
20124 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
20128 if (!row
->reversed_p
)
20130 while (glyph
>= start
20131 && BUFFERP (glyph
->object
)
20132 && (glyph
->type
== STRETCH_GLYPH
20133 || (glyph
->type
== CHAR_GLYPH
20134 && glyph
->u
.ch
== ' ')))
20135 (glyph
--)->face_id
= face_id
;
20139 while (glyph
<= start
20140 && BUFFERP (glyph
->object
)
20141 && (glyph
->type
== STRETCH_GLYPH
20142 || (glyph
->type
== CHAR_GLYPH
20143 && glyph
->u
.ch
== ' ')))
20144 (glyph
++)->face_id
= face_id
;
20151 /* Value is true if glyph row ROW should be
20152 considered to hold the buffer position CHARPOS. */
20155 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
20157 bool result
= true;
20159 if (charpos
== CHARPOS (row
->end
.pos
)
20160 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
20162 /* Suppose the row ends on a string.
20163 Unless the row is continued, that means it ends on a newline
20164 in the string. If it's anything other than a display string
20165 (e.g., a before-string from an overlay), we don't want the
20166 cursor there. (This heuristic seems to give the optimal
20167 behavior for the various types of multi-line strings.)
20168 One exception: if the string has `cursor' property on one of
20169 its characters, we _do_ want the cursor there. */
20170 if (CHARPOS (row
->end
.string_pos
) >= 0)
20172 if (row
->continued_p
)
20176 /* Check for `display' property. */
20177 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
20178 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
20179 struct glyph
*glyph
;
20182 for (glyph
= end
; glyph
>= beg
; --glyph
)
20183 if (STRINGP (glyph
->object
))
20186 = Fget_char_property (make_number (charpos
),
20190 && display_prop_string_p (prop
, glyph
->object
));
20191 /* If there's a `cursor' property on one of the
20192 string's characters, this row is a cursor row,
20193 even though this is not a display string. */
20196 Lisp_Object s
= glyph
->object
;
20198 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
20200 ptrdiff_t gpos
= glyph
->charpos
;
20202 if (!NILP (Fget_char_property (make_number (gpos
),
20214 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
20216 /* If the row ends in middle of a real character,
20217 and the line is continued, we want the cursor here.
20218 That's because CHARPOS (ROW->end.pos) would equal
20219 PT if PT is before the character. */
20220 if (!row
->ends_in_ellipsis_p
)
20221 result
= row
->continued_p
;
20223 /* If the row ends in an ellipsis, then
20224 CHARPOS (ROW->end.pos) will equal point after the
20225 invisible text. We want that position to be displayed
20226 after the ellipsis. */
20229 /* If the row ends at ZV, display the cursor at the end of that
20230 row instead of at the start of the row below. */
20232 result
= row
->ends_at_zv_p
;
20238 /* Value is true if glyph row ROW should be
20239 used to hold the cursor. */
20242 cursor_row_p (struct glyph_row
*row
)
20244 return row_for_charpos_p (row
, PT
);
20249 /* Push the property PROP so that it will be rendered at the current
20250 position in IT. Return true if PROP was successfully pushed, false
20251 otherwise. Called from handle_line_prefix to handle the
20252 `line-prefix' and `wrap-prefix' properties. */
20255 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
20257 struct text_pos pos
=
20258 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
20260 eassert (it
->method
== GET_FROM_BUFFER
20261 || it
->method
== GET_FROM_DISPLAY_VECTOR
20262 || it
->method
== GET_FROM_STRING
20263 || it
->method
== GET_FROM_IMAGE
);
20265 /* We need to save the current buffer/string position, so it will be
20266 restored by pop_it, because iterate_out_of_display_property
20267 depends on that being set correctly, but some situations leave
20268 it->position not yet set when this function is called. */
20269 push_it (it
, &pos
);
20271 if (STRINGP (prop
))
20273 if (SCHARS (prop
) == 0)
20280 it
->string_from_prefix_prop_p
= true;
20281 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
20282 it
->current
.overlay_string_index
= -1;
20283 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
20284 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
20285 it
->method
= GET_FROM_STRING
;
20286 it
->stop_charpos
= 0;
20288 it
->base_level_stop
= 0;
20290 /* Force paragraph direction to be that of the parent
20292 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
20293 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
20295 it
->paragraph_embedding
= L2R
;
20297 /* Set up the bidi iterator for this display string. */
20300 it
->bidi_it
.string
.lstring
= it
->string
;
20301 it
->bidi_it
.string
.s
= NULL
;
20302 it
->bidi_it
.string
.schars
= it
->end_charpos
;
20303 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
20304 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
20305 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
20306 it
->bidi_it
.w
= it
->w
;
20307 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
20310 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
20312 it
->method
= GET_FROM_STRETCH
;
20315 #ifdef HAVE_WINDOW_SYSTEM
20316 else if (IMAGEP (prop
))
20318 it
->what
= IT_IMAGE
;
20319 it
->image_id
= lookup_image (it
->f
, prop
);
20320 it
->method
= GET_FROM_IMAGE
;
20322 #endif /* HAVE_WINDOW_SYSTEM */
20325 pop_it (it
); /* bogus display property, give up */
20332 /* Return the character-property PROP at the current position in IT. */
20335 get_it_property (struct it
*it
, Lisp_Object prop
)
20337 Lisp_Object position
, object
= it
->object
;
20339 if (STRINGP (object
))
20340 position
= make_number (IT_STRING_CHARPOS (*it
));
20341 else if (BUFFERP (object
))
20343 position
= make_number (IT_CHARPOS (*it
));
20344 object
= it
->window
;
20349 return Fget_char_property (position
, prop
, object
);
20352 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
20355 handle_line_prefix (struct it
*it
)
20357 Lisp_Object prefix
;
20359 if (it
->continuation_lines_width
> 0)
20361 prefix
= get_it_property (it
, Qwrap_prefix
);
20363 prefix
= Vwrap_prefix
;
20367 prefix
= get_it_property (it
, Qline_prefix
);
20369 prefix
= Vline_prefix
;
20371 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
20373 /* If the prefix is wider than the window, and we try to wrap
20374 it, it would acquire its own wrap prefix, and so on till the
20375 iterator stack overflows. So, don't wrap the prefix. */
20376 it
->line_wrap
= TRUNCATE
;
20377 it
->avoid_cursor_p
= true;
20383 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
20384 only for R2L lines from display_line and display_string, when they
20385 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
20386 the line/string needs to be continued on the next glyph row. */
20388 unproduce_glyphs (struct it
*it
, int n
)
20390 struct glyph
*glyph
, *end
;
20392 eassert (it
->glyph_row
);
20393 eassert (it
->glyph_row
->reversed_p
);
20394 eassert (it
->area
== TEXT_AREA
);
20395 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20397 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20398 n
= it
->glyph_row
->used
[TEXT_AREA
];
20399 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20400 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20401 for ( ; glyph
< end
; glyph
++)
20402 glyph
[-n
] = *glyph
;
20405 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20406 and ROW->maxpos. */
20408 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20409 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20410 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20412 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20413 lines' rows is implemented for bidi-reordered rows. */
20415 /* ROW->minpos is the value of min_pos, the minimal buffer position
20416 we have in ROW, or ROW->start.pos if that is smaller. */
20417 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20418 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20420 /* We didn't find buffer positions smaller than ROW->start, or
20421 didn't find _any_ valid buffer positions in any of the glyphs,
20422 so we must trust the iterator's computed positions. */
20423 row
->minpos
= row
->start
.pos
;
20426 max_pos
= CHARPOS (it
->current
.pos
);
20427 max_bpos
= BYTEPOS (it
->current
.pos
);
20430 /* Here are the various use-cases for ending the row, and the
20431 corresponding values for ROW->maxpos:
20433 Line ends in a newline from buffer eol_pos + 1
20434 Line is continued from buffer max_pos + 1
20435 Line is truncated on right it->current.pos
20436 Line ends in a newline from string max_pos + 1(*)
20437 (*) + 1 only when line ends in a forward scan
20438 Line is continued from string max_pos
20439 Line is continued from display vector max_pos
20440 Line is entirely from a string min_pos == max_pos
20441 Line is entirely from a display vector min_pos == max_pos
20442 Line that ends at ZV ZV
20444 If you discover other use-cases, please add them here as
20446 if (row
->ends_at_zv_p
)
20447 row
->maxpos
= it
->current
.pos
;
20448 else if (row
->used
[TEXT_AREA
])
20450 bool seen_this_string
= false;
20451 struct glyph_row
*r1
= row
- 1;
20453 /* Did we see the same display string on the previous row? */
20454 if (STRINGP (it
->object
)
20455 /* this is not the first row */
20456 && row
> it
->w
->desired_matrix
->rows
20457 /* previous row is not the header line */
20458 && !r1
->mode_line_p
20459 /* previous row also ends in a newline from a string */
20460 && r1
->ends_in_newline_from_string_p
)
20462 struct glyph
*start
, *end
;
20464 /* Search for the last glyph of the previous row that came
20465 from buffer or string. Depending on whether the row is
20466 L2R or R2L, we need to process it front to back or the
20467 other way round. */
20468 if (!r1
->reversed_p
)
20470 start
= r1
->glyphs
[TEXT_AREA
];
20471 end
= start
+ r1
->used
[TEXT_AREA
];
20472 /* Glyphs inserted by redisplay have nil as their object. */
20474 && NILP ((end
- 1)->object
)
20475 && (end
- 1)->charpos
<= 0)
20479 if (EQ ((end
- 1)->object
, it
->object
))
20480 seen_this_string
= true;
20483 /* If all the glyphs of the previous row were inserted
20484 by redisplay, it means the previous row was
20485 produced from a single newline, which is only
20486 possible if that newline came from the same string
20487 as the one which produced this ROW. */
20488 seen_this_string
= true;
20492 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20493 start
= end
+ r1
->used
[TEXT_AREA
];
20495 && NILP ((end
+ 1)->object
)
20496 && (end
+ 1)->charpos
<= 0)
20500 if (EQ ((end
+ 1)->object
, it
->object
))
20501 seen_this_string
= true;
20504 seen_this_string
= true;
20507 /* Take note of each display string that covers a newline only
20508 once, the first time we see it. This is for when a display
20509 string includes more than one newline in it. */
20510 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20512 /* If we were scanning the buffer forward when we displayed
20513 the string, we want to account for at least one buffer
20514 position that belongs to this row (position covered by
20515 the display string), so that cursor positioning will
20516 consider this row as a candidate when point is at the end
20517 of the visual line represented by this row. This is not
20518 required when scanning back, because max_pos will already
20519 have a much larger value. */
20520 if (CHARPOS (row
->end
.pos
) > max_pos
)
20521 INC_BOTH (max_pos
, max_bpos
);
20522 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20524 else if (CHARPOS (it
->eol_pos
) > 0)
20525 SET_TEXT_POS (row
->maxpos
,
20526 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20527 else if (row
->continued_p
)
20529 /* If max_pos is different from IT's current position, it
20530 means IT->method does not belong to the display element
20531 at max_pos. However, it also means that the display
20532 element at max_pos was displayed in its entirety on this
20533 line, which is equivalent to saying that the next line
20534 starts at the next buffer position. */
20535 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20536 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20539 INC_BOTH (max_pos
, max_bpos
);
20540 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20543 else if (row
->truncated_on_right_p
)
20544 /* display_line already called reseat_at_next_visible_line_start,
20545 which puts the iterator at the beginning of the next line, in
20546 the logical order. */
20547 row
->maxpos
= it
->current
.pos
;
20548 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20549 /* A line that is entirely from a string/image/stretch... */
20550 row
->maxpos
= row
->minpos
;
20555 row
->maxpos
= it
->current
.pos
;
20558 /* Construct the glyph row IT->glyph_row in the desired matrix of
20559 IT->w from text at the current position of IT. See dispextern.h
20560 for an overview of struct it. Value is true if
20561 IT->glyph_row displays text, as opposed to a line displaying ZV
20565 display_line (struct it
*it
)
20567 struct glyph_row
*row
= it
->glyph_row
;
20568 Lisp_Object overlay_arrow_string
;
20570 void *wrap_data
= NULL
;
20571 bool may_wrap
= false;
20573 int wrap_row_used
= -1;
20574 int wrap_row_ascent UNINIT
, wrap_row_height UNINIT
;
20575 int wrap_row_phys_ascent UNINIT
, wrap_row_phys_height UNINIT
;
20576 int wrap_row_extra_line_spacing UNINIT
;
20577 ptrdiff_t wrap_row_min_pos UNINIT
, wrap_row_min_bpos UNINIT
;
20578 ptrdiff_t wrap_row_max_pos UNINIT
, wrap_row_max_bpos UNINIT
;
20580 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20581 ptrdiff_t min_bpos UNINIT
, max_bpos UNINIT
;
20582 bool pending_handle_line_prefix
= false;
20584 /* We always start displaying at hpos zero even if hscrolled. */
20585 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20587 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20588 >= it
->w
->desired_matrix
->nrows
)
20590 it
->w
->nrows_scale_factor
++;
20591 it
->f
->fonts_changed
= true;
20595 /* Clear the result glyph row and enable it. */
20596 prepare_desired_row (it
->w
, row
, false);
20598 row
->y
= it
->current_y
;
20599 row
->start
= it
->start
;
20600 row
->continuation_lines_width
= it
->continuation_lines_width
;
20601 row
->displays_text_p
= true;
20602 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20603 it
->starts_in_middle_of_char_p
= false;
20605 /* Arrange the overlays nicely for our purposes. Usually, we call
20606 display_line on only one line at a time, in which case this
20607 can't really hurt too much, or we call it on lines which appear
20608 one after another in the buffer, in which case all calls to
20609 recenter_overlay_lists but the first will be pretty cheap. */
20610 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20612 /* Move over display elements that are not visible because we are
20613 hscrolled. This may stop at an x-position < IT->first_visible_x
20614 if the first glyph is partially visible or if we hit a line end. */
20615 if (it
->current_x
< it
->first_visible_x
)
20617 enum move_it_result move_result
;
20619 this_line_min_pos
= row
->start
.pos
;
20620 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20621 MOVE_TO_POS
| MOVE_TO_X
);
20622 /* If we are under a large hscroll, move_it_in_display_line_to
20623 could hit the end of the line without reaching
20624 it->first_visible_x. Pretend that we did reach it. This is
20625 especially important on a TTY, where we will call
20626 extend_face_to_end_of_line, which needs to know how many
20627 blank glyphs to produce. */
20628 if (it
->current_x
< it
->first_visible_x
20629 && (move_result
== MOVE_NEWLINE_OR_CR
20630 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20631 it
->current_x
= it
->first_visible_x
;
20633 /* Record the smallest positions seen while we moved over
20634 display elements that are not visible. This is needed by
20635 redisplay_internal for optimizing the case where the cursor
20636 stays inside the same line. The rest of this function only
20637 considers positions that are actually displayed, so
20638 RECORD_MAX_MIN_POS will not otherwise record positions that
20639 are hscrolled to the left of the left edge of the window. */
20640 min_pos
= CHARPOS (this_line_min_pos
);
20641 min_bpos
= BYTEPOS (this_line_min_pos
);
20643 else if (it
->area
== TEXT_AREA
)
20645 /* We only do this when not calling move_it_in_display_line_to
20646 above, because that function calls itself handle_line_prefix. */
20647 handle_line_prefix (it
);
20651 /* Line-prefix and wrap-prefix are always displayed in the text
20652 area. But if this is the first call to display_line after
20653 init_iterator, the iterator might have been set up to write
20654 into a marginal area, e.g. if the line begins with some
20655 display property that writes to the margins. So we need to
20656 wait with the call to handle_line_prefix until whatever
20657 writes to the margin has done its job. */
20658 pending_handle_line_prefix
= true;
20661 /* Get the initial row height. This is either the height of the
20662 text hscrolled, if there is any, or zero. */
20663 row
->ascent
= it
->max_ascent
;
20664 row
->height
= it
->max_ascent
+ it
->max_descent
;
20665 row
->phys_ascent
= it
->max_phys_ascent
;
20666 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20667 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20669 /* Utility macro to record max and min buffer positions seen until now. */
20670 #define RECORD_MAX_MIN_POS(IT) \
20673 bool composition_p \
20674 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20675 ptrdiff_t current_pos = \
20676 composition_p ? (IT)->cmp_it.charpos \
20677 : IT_CHARPOS (*(IT)); \
20678 ptrdiff_t current_bpos = \
20679 composition_p ? CHAR_TO_BYTE (current_pos) \
20680 : IT_BYTEPOS (*(IT)); \
20681 if (current_pos < min_pos) \
20683 min_pos = current_pos; \
20684 min_bpos = current_bpos; \
20686 if (IT_CHARPOS (*it) > max_pos) \
20688 max_pos = IT_CHARPOS (*it); \
20689 max_bpos = IT_BYTEPOS (*it); \
20694 /* Loop generating characters. The loop is left with IT on the next
20695 character to display. */
20698 int n_glyphs_before
, hpos_before
, x_before
;
20700 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20702 /* Retrieve the next thing to display. Value is false if end of
20704 if (!get_next_display_element (it
))
20706 /* Maybe add a space at the end of this line that is used to
20707 display the cursor there under X. Set the charpos of the
20708 first glyph of blank lines not corresponding to any text
20710 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20711 row
->exact_window_width_line_p
= true;
20712 else if ((append_space_for_newline (it
, true)
20713 && row
->used
[TEXT_AREA
] == 1)
20714 || row
->used
[TEXT_AREA
] == 0)
20716 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20717 row
->displays_text_p
= false;
20719 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20720 && (!MINI_WINDOW_P (it
->w
)
20721 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20722 row
->indicate_empty_line_p
= true;
20725 it
->continuation_lines_width
= 0;
20726 row
->ends_at_zv_p
= true;
20727 /* A row that displays right-to-left text must always have
20728 its last face extended all the way to the end of line,
20729 even if this row ends in ZV, because we still write to
20730 the screen left to right. We also need to extend the
20731 last face if the default face is remapped to some
20732 different face, otherwise the functions that clear
20733 portions of the screen will clear with the default face's
20734 background color. */
20735 if (row
->reversed_p
20736 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20737 extend_face_to_end_of_line (it
);
20741 /* Now, get the metrics of what we want to display. This also
20742 generates glyphs in `row' (which is IT->glyph_row). */
20743 n_glyphs_before
= row
->used
[TEXT_AREA
];
20746 /* Remember the line height so far in case the next element doesn't
20747 fit on the line. */
20748 if (it
->line_wrap
!= TRUNCATE
)
20750 ascent
= it
->max_ascent
;
20751 descent
= it
->max_descent
;
20752 phys_ascent
= it
->max_phys_ascent
;
20753 phys_descent
= it
->max_phys_descent
;
20755 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20757 if (IT_DISPLAYING_WHITESPACE (it
))
20761 SAVE_IT (wrap_it
, *it
, wrap_data
);
20763 wrap_row_used
= row
->used
[TEXT_AREA
];
20764 wrap_row_ascent
= row
->ascent
;
20765 wrap_row_height
= row
->height
;
20766 wrap_row_phys_ascent
= row
->phys_ascent
;
20767 wrap_row_phys_height
= row
->phys_height
;
20768 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20769 wrap_row_min_pos
= min_pos
;
20770 wrap_row_min_bpos
= min_bpos
;
20771 wrap_row_max_pos
= max_pos
;
20772 wrap_row_max_bpos
= max_bpos
;
20778 PRODUCE_GLYPHS (it
);
20780 /* If this display element was in marginal areas, continue with
20782 if (it
->area
!= TEXT_AREA
)
20784 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20785 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20786 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20787 row
->phys_height
= max (row
->phys_height
,
20788 it
->max_phys_ascent
+ it
->max_phys_descent
);
20789 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20790 it
->max_extra_line_spacing
);
20791 set_iterator_to_next (it
, true);
20792 /* If we didn't handle the line/wrap prefix above, and the
20793 call to set_iterator_to_next just switched to TEXT_AREA,
20794 process the prefix now. */
20795 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20797 pending_handle_line_prefix
= false;
20798 handle_line_prefix (it
);
20803 /* Does the display element fit on the line? If we truncate
20804 lines, we should draw past the right edge of the window. If
20805 we don't truncate, we want to stop so that we can display the
20806 continuation glyph before the right margin. If lines are
20807 continued, there are two possible strategies for characters
20808 resulting in more than 1 glyph (e.g. tabs): Display as many
20809 glyphs as possible in this line and leave the rest for the
20810 continuation line, or display the whole element in the next
20811 line. Original redisplay did the former, so we do it also. */
20812 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20813 hpos_before
= it
->hpos
;
20816 if (/* Not a newline. */
20818 /* Glyphs produced fit entirely in the line. */
20819 && it
->current_x
< it
->last_visible_x
)
20821 it
->hpos
+= nglyphs
;
20822 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20823 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20824 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20825 row
->phys_height
= max (row
->phys_height
,
20826 it
->max_phys_ascent
+ it
->max_phys_descent
);
20827 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20828 it
->max_extra_line_spacing
);
20829 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20830 /* In R2L rows, we arrange in extend_face_to_end_of_line
20831 to add a right offset to the line, by a suitable
20832 change to the stretch glyph that is the leftmost
20833 glyph of the line. */
20834 && !row
->reversed_p
)
20835 row
->x
= x
- it
->first_visible_x
;
20836 /* Record the maximum and minimum buffer positions seen so
20837 far in glyphs that will be displayed by this row. */
20839 RECORD_MAX_MIN_POS (it
);
20844 struct glyph
*glyph
;
20846 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20848 /* Identify the glyphs added by the last call to
20849 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20850 the previous glyphs. */
20851 if (!row
->reversed_p
)
20852 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20854 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20855 new_x
= x
+ glyph
->pixel_width
;
20857 if (/* Lines are continued. */
20858 it
->line_wrap
!= TRUNCATE
20859 && (/* Glyph doesn't fit on the line. */
20860 new_x
> it
->last_visible_x
20861 /* Or it fits exactly on a window system frame. */
20862 || (new_x
== it
->last_visible_x
20863 && FRAME_WINDOW_P (it
->f
)
20864 && (row
->reversed_p
20865 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20866 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20868 /* End of a continued line. */
20871 || (new_x
== it
->last_visible_x
20872 && FRAME_WINDOW_P (it
->f
)
20873 && (row
->reversed_p
20874 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20875 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20877 /* Current glyph is the only one on the line or
20878 fits exactly on the line. We must continue
20879 the line because we can't draw the cursor
20880 after the glyph. */
20881 row
->continued_p
= true;
20882 it
->current_x
= new_x
;
20883 it
->continuation_lines_width
+= new_x
;
20885 if (i
== nglyphs
- 1)
20887 /* If line-wrap is on, check if a previous
20888 wrap point was found. */
20889 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20890 && wrap_row_used
> 0
20891 /* Even if there is a previous wrap
20892 point, continue the line here as
20893 usual, if (i) the previous character
20894 was a space or tab AND (ii) the
20895 current character is not. */
20897 || IT_DISPLAYING_WHITESPACE (it
)))
20900 /* Record the maximum and minimum buffer
20901 positions seen so far in glyphs that will be
20902 displayed by this row. */
20904 RECORD_MAX_MIN_POS (it
);
20905 set_iterator_to_next (it
, true);
20906 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20908 if (!get_next_display_element (it
))
20910 row
->exact_window_width_line_p
= true;
20911 it
->continuation_lines_width
= 0;
20912 row
->continued_p
= false;
20913 row
->ends_at_zv_p
= true;
20915 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20917 row
->continued_p
= false;
20918 row
->exact_window_width_line_p
= true;
20920 /* If line-wrap is on, check if a
20921 previous wrap point was found. */
20922 else if (wrap_row_used
> 0
20923 /* Even if there is a previous wrap
20924 point, continue the line here as
20925 usual, if (i) the previous character
20926 was a space or tab AND (ii) the
20927 current character is not. */
20929 || IT_DISPLAYING_WHITESPACE (it
)))
20934 else if (it
->bidi_p
)
20935 RECORD_MAX_MIN_POS (it
);
20936 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20937 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20938 extend_face_to_end_of_line (it
);
20940 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20941 && !FRAME_WINDOW_P (it
->f
))
20943 /* A padding glyph that doesn't fit on this line.
20944 This means the whole character doesn't fit
20946 if (row
->reversed_p
)
20947 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20948 - n_glyphs_before
);
20949 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20951 /* Fill the rest of the row with continuation
20952 glyphs like in 20.x. */
20953 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20954 < row
->glyphs
[1 + TEXT_AREA
])
20955 produce_special_glyphs (it
, IT_CONTINUATION
);
20957 row
->continued_p
= true;
20958 it
->current_x
= x_before
;
20959 it
->continuation_lines_width
+= x_before
;
20961 /* Restore the height to what it was before the
20962 element not fitting on the line. */
20963 it
->max_ascent
= ascent
;
20964 it
->max_descent
= descent
;
20965 it
->max_phys_ascent
= phys_ascent
;
20966 it
->max_phys_descent
= phys_descent
;
20967 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20968 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20969 extend_face_to_end_of_line (it
);
20971 else if (wrap_row_used
> 0)
20974 if (row
->reversed_p
)
20975 unproduce_glyphs (it
,
20976 row
->used
[TEXT_AREA
] - wrap_row_used
);
20977 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20978 it
->continuation_lines_width
+= wrap_x
;
20979 row
->used
[TEXT_AREA
] = wrap_row_used
;
20980 row
->ascent
= wrap_row_ascent
;
20981 row
->height
= wrap_row_height
;
20982 row
->phys_ascent
= wrap_row_phys_ascent
;
20983 row
->phys_height
= wrap_row_phys_height
;
20984 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20985 min_pos
= wrap_row_min_pos
;
20986 min_bpos
= wrap_row_min_bpos
;
20987 max_pos
= wrap_row_max_pos
;
20988 max_bpos
= wrap_row_max_bpos
;
20989 row
->continued_p
= true;
20990 row
->ends_at_zv_p
= false;
20991 row
->exact_window_width_line_p
= false;
20992 it
->continuation_lines_width
+= x
;
20994 /* Make sure that a non-default face is extended
20995 up to the right margin of the window. */
20996 extend_face_to_end_of_line (it
);
20998 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
21000 /* A TAB that extends past the right edge of the
21001 window. This produces a single glyph on
21002 window system frames. We leave the glyph in
21003 this row and let it fill the row, but don't
21004 consume the TAB. */
21005 if ((row
->reversed_p
21006 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
21007 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
21008 produce_special_glyphs (it
, IT_CONTINUATION
);
21009 it
->continuation_lines_width
+= it
->last_visible_x
;
21010 row
->ends_in_middle_of_char_p
= true;
21011 row
->continued_p
= true;
21012 glyph
->pixel_width
= it
->last_visible_x
- x
;
21013 it
->starts_in_middle_of_char_p
= true;
21014 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
21015 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
21016 extend_face_to_end_of_line (it
);
21020 /* Something other than a TAB that draws past
21021 the right edge of the window. Restore
21022 positions to values before the element. */
21023 if (row
->reversed_p
)
21024 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21025 - (n_glyphs_before
+ i
));
21026 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21028 /* Display continuation glyphs. */
21029 it
->current_x
= x_before
;
21030 it
->continuation_lines_width
+= x
;
21031 if (!FRAME_WINDOW_P (it
->f
)
21032 || (row
->reversed_p
21033 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
21034 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
21035 produce_special_glyphs (it
, IT_CONTINUATION
);
21036 row
->continued_p
= true;
21038 extend_face_to_end_of_line (it
);
21040 if (nglyphs
> 1 && i
> 0)
21042 row
->ends_in_middle_of_char_p
= true;
21043 it
->starts_in_middle_of_char_p
= true;
21046 /* Restore the height to what it was before the
21047 element not fitting on the line. */
21048 it
->max_ascent
= ascent
;
21049 it
->max_descent
= descent
;
21050 it
->max_phys_ascent
= phys_ascent
;
21051 it
->max_phys_descent
= phys_descent
;
21056 else if (new_x
> it
->first_visible_x
)
21058 /* Increment number of glyphs actually displayed. */
21061 /* Record the maximum and minimum buffer positions
21062 seen so far in glyphs that will be displayed by
21065 RECORD_MAX_MIN_POS (it
);
21067 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
21068 /* Glyph is partially visible, i.e. row starts at
21069 negative X position. Don't do that in R2L
21070 rows, where we arrange to add a right offset to
21071 the line in extend_face_to_end_of_line, by a
21072 suitable change to the stretch glyph that is
21073 the leftmost glyph of the line. */
21074 row
->x
= x
- it
->first_visible_x
;
21075 /* When the last glyph of an R2L row only fits
21076 partially on the line, we need to set row->x to a
21077 negative offset, so that the leftmost glyph is
21078 the one that is partially visible. But if we are
21079 going to produce the truncation glyph, this will
21080 be taken care of in produce_special_glyphs. */
21081 if (row
->reversed_p
21082 && new_x
> it
->last_visible_x
21083 && !(it
->line_wrap
== TRUNCATE
21084 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
21086 eassert (FRAME_WINDOW_P (it
->f
));
21087 row
->x
= it
->last_visible_x
- new_x
;
21092 /* Glyph is completely off the left margin of the
21093 window. This should not happen because of the
21094 move_it_in_display_line at the start of this
21095 function, unless the text display area of the
21096 window is empty. */
21097 eassert (it
->first_visible_x
<= it
->last_visible_x
);
21100 /* Even if this display element produced no glyphs at all,
21101 we want to record its position. */
21102 if (it
->bidi_p
&& nglyphs
== 0)
21103 RECORD_MAX_MIN_POS (it
);
21105 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21106 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21107 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21108 row
->phys_height
= max (row
->phys_height
,
21109 it
->max_phys_ascent
+ it
->max_phys_descent
);
21110 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21111 it
->max_extra_line_spacing
);
21113 /* End of this display line if row is continued. */
21114 if (row
->continued_p
|| row
->ends_at_zv_p
)
21119 /* Is this a line end? If yes, we're also done, after making
21120 sure that a non-default face is extended up to the right
21121 margin of the window. */
21122 if (ITERATOR_AT_END_OF_LINE_P (it
))
21124 int used_before
= row
->used
[TEXT_AREA
];
21126 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
21128 /* Add a space at the end of the line that is used to
21129 display the cursor there. */
21130 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
21131 append_space_for_newline (it
, false);
21133 /* Extend the face to the end of the line. */
21134 extend_face_to_end_of_line (it
);
21136 /* Make sure we have the position. */
21137 if (used_before
== 0)
21138 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
21140 /* Record the position of the newline, for use in
21142 it
->eol_pos
= it
->current
.pos
;
21144 /* Consume the line end. This skips over invisible lines. */
21145 set_iterator_to_next (it
, true);
21146 it
->continuation_lines_width
= 0;
21150 /* Proceed with next display element. Note that this skips
21151 over lines invisible because of selective display. */
21152 set_iterator_to_next (it
, true);
21154 /* If we truncate lines, we are done when the last displayed
21155 glyphs reach past the right margin of the window. */
21156 if (it
->line_wrap
== TRUNCATE
21157 && ((FRAME_WINDOW_P (it
->f
)
21158 /* Images are preprocessed in produce_image_glyph such
21159 that they are cropped at the right edge of the
21160 window, so an image glyph will always end exactly at
21161 last_visible_x, even if there's no right fringe. */
21162 && ((row
->reversed_p
21163 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
21164 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
21165 || it
->what
== IT_IMAGE
))
21166 ? (it
->current_x
>= it
->last_visible_x
)
21167 : (it
->current_x
> it
->last_visible_x
)))
21169 /* Maybe add truncation glyphs. */
21170 if (!FRAME_WINDOW_P (it
->f
)
21171 || (row
->reversed_p
21172 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
21173 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
21177 if (!row
->reversed_p
)
21179 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
21180 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
21185 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
21186 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
21188 /* Remove any padding glyphs at the front of ROW, to
21189 make room for the truncation glyphs we will be
21190 adding below. The loop below always inserts at
21191 least one truncation glyph, so also remove the
21192 last glyph added to ROW. */
21193 unproduce_glyphs (it
, i
+ 1);
21194 /* Adjust i for the loop below. */
21195 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
21198 /* produce_special_glyphs overwrites the last glyph, so
21199 we don't want that if we want to keep that last
21200 glyph, which means it's an image. */
21201 if (it
->current_x
> it
->last_visible_x
)
21203 it
->current_x
= x_before
;
21204 if (!FRAME_WINDOW_P (it
->f
))
21206 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
21208 row
->used
[TEXT_AREA
] = i
;
21209 produce_special_glyphs (it
, IT_TRUNCATION
);
21214 row
->used
[TEXT_AREA
] = i
;
21215 produce_special_glyphs (it
, IT_TRUNCATION
);
21217 it
->hpos
= hpos_before
;
21220 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
21222 /* Don't truncate if we can overflow newline into fringe. */
21223 if (!get_next_display_element (it
))
21225 it
->continuation_lines_width
= 0;
21226 row
->ends_at_zv_p
= true;
21227 row
->exact_window_width_line_p
= true;
21230 if (ITERATOR_AT_END_OF_LINE_P (it
))
21232 row
->exact_window_width_line_p
= true;
21233 goto at_end_of_line
;
21235 it
->current_x
= x_before
;
21236 it
->hpos
= hpos_before
;
21239 row
->truncated_on_right_p
= true;
21240 it
->continuation_lines_width
= 0;
21241 reseat_at_next_visible_line_start (it
, false);
21242 /* We insist below that IT's position be at ZV because in
21243 bidi-reordered lines the character at visible line start
21244 might not be the character that follows the newline in
21245 the logical order. */
21246 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
21247 row
->ends_at_zv_p
=
21248 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
21250 row
->ends_at_zv_p
= false;
21256 bidi_unshelve_cache (wrap_data
, true);
21258 /* If line is not empty and hscrolled, maybe insert truncation glyphs
21259 at the left window margin. */
21260 if (it
->first_visible_x
21261 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
21263 if (!FRAME_WINDOW_P (it
->f
)
21264 || (((row
->reversed_p
21265 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21266 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
21267 /* Don't let insert_left_trunc_glyphs overwrite the
21268 first glyph of the row if it is an image. */
21269 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
21270 insert_left_trunc_glyphs (it
);
21271 row
->truncated_on_left_p
= true;
21274 /* Remember the position at which this line ends.
21276 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
21277 cannot be before the call to find_row_edges below, since that is
21278 where these positions are determined. */
21279 row
->end
= it
->current
;
21282 row
->minpos
= row
->start
.pos
;
21283 row
->maxpos
= row
->end
.pos
;
21287 /* ROW->minpos and ROW->maxpos must be the smallest and
21288 `1 + the largest' buffer positions in ROW. But if ROW was
21289 bidi-reordered, these two positions can be anywhere in the
21290 row, so we must determine them now. */
21291 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
21294 /* If the start of this line is the overlay arrow-position, then
21295 mark this glyph row as the one containing the overlay arrow.
21296 This is clearly a mess with variable size fonts. It would be
21297 better to let it be displayed like cursors under X. */
21298 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
21299 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
21300 !NILP (overlay_arrow_string
)))
21302 /* Overlay arrow in window redisplay is a fringe bitmap. */
21303 if (STRINGP (overlay_arrow_string
))
21305 struct glyph_row
*arrow_row
21306 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
21307 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
21308 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
21309 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
21310 struct glyph
*p2
, *end
;
21312 /* Copy the arrow glyphs. */
21313 while (glyph
< arrow_end
)
21316 /* Throw away padding glyphs. */
21318 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
21319 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
21325 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
21330 eassert (INTEGERP (overlay_arrow_string
));
21331 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
21333 overlay_arrow_seen
= true;
21336 /* Highlight trailing whitespace. */
21337 if (!NILP (Vshow_trailing_whitespace
))
21338 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
21340 /* Compute pixel dimensions of this line. */
21341 compute_line_metrics (it
);
21343 /* Implementation note: No changes in the glyphs of ROW or in their
21344 faces can be done past this point, because compute_line_metrics
21345 computes ROW's hash value and stores it within the glyph_row
21348 /* Record whether this row ends inside an ellipsis. */
21349 row
->ends_in_ellipsis_p
21350 = (it
->method
== GET_FROM_DISPLAY_VECTOR
21351 && it
->ellipsis_p
);
21353 /* Save fringe bitmaps in this row. */
21354 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
21355 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
21356 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
21357 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
21359 it
->left_user_fringe_bitmap
= 0;
21360 it
->left_user_fringe_face_id
= 0;
21361 it
->right_user_fringe_bitmap
= 0;
21362 it
->right_user_fringe_face_id
= 0;
21364 /* Maybe set the cursor. */
21365 cvpos
= it
->w
->cursor
.vpos
;
21367 /* In bidi-reordered rows, keep checking for proper cursor
21368 position even if one has been found already, because buffer
21369 positions in such rows change non-linearly with ROW->VPOS,
21370 when a line is continued. One exception: when we are at ZV,
21371 display cursor on the first suitable glyph row, since all
21372 the empty rows after that also have their position set to ZV. */
21373 /* FIXME: Revisit this when glyph ``spilling'' in continuation
21374 lines' rows is implemented for bidi-reordered rows. */
21376 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
21377 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
21378 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
21379 && cursor_row_p (row
))
21380 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
21382 /* Prepare for the next line. This line starts horizontally at (X
21383 HPOS) = (0 0). Vertical positions are incremented. As a
21384 convenience for the caller, IT->glyph_row is set to the next
21386 it
->current_x
= it
->hpos
= 0;
21387 it
->current_y
+= row
->height
;
21388 SET_TEXT_POS (it
->eol_pos
, 0, 0);
21391 /* The next row should by default use the same value of the
21392 reversed_p flag as this one. set_iterator_to_next decides when
21393 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21394 the flag accordingly. */
21395 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
21396 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21397 it
->start
= row
->end
;
21398 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21400 #undef RECORD_MAX_MIN_POS
21403 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21404 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21405 doc
: /* Return paragraph direction at point in BUFFER.
21406 Value is either `left-to-right' or `right-to-left'.
21407 If BUFFER is omitted or nil, it defaults to the current buffer.
21409 Paragraph direction determines how the text in the paragraph is displayed.
21410 In left-to-right paragraphs, text begins at the left margin of the window
21411 and the reading direction is generally left to right. In right-to-left
21412 paragraphs, text begins at the right margin and is read from right to left.
21414 See also `bidi-paragraph-direction'. */)
21415 (Lisp_Object buffer
)
21417 struct buffer
*buf
= current_buffer
;
21418 struct buffer
*old
= buf
;
21420 if (! NILP (buffer
))
21422 CHECK_BUFFER (buffer
);
21423 buf
= XBUFFER (buffer
);
21426 if (NILP (BVAR (buf
, bidi_display_reordering
))
21427 || NILP (BVAR (buf
, enable_multibyte_characters
))
21428 /* When we are loading loadup.el, the character property tables
21429 needed for bidi iteration are not yet available. */
21430 || redisplay__inhibit_bidi
)
21431 return Qleft_to_right
;
21432 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21433 return BVAR (buf
, bidi_paragraph_direction
);
21436 /* Determine the direction from buffer text. We could try to
21437 use current_matrix if it is up to date, but this seems fast
21438 enough as it is. */
21439 struct bidi_it itb
;
21440 ptrdiff_t pos
= BUF_PT (buf
);
21441 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21443 void *itb_data
= bidi_shelve_cache ();
21445 set_buffer_temp (buf
);
21446 /* bidi_paragraph_init finds the base direction of the paragraph
21447 by searching forward from paragraph start. We need the base
21448 direction of the current or _previous_ paragraph, so we need
21449 to make sure we are within that paragraph. To that end, find
21450 the previous non-empty line. */
21451 if (pos
>= ZV
&& pos
> BEGV
)
21452 DEC_BOTH (pos
, bytepos
);
21453 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21454 if (fast_looking_at (trailing_white_space
,
21455 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21457 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21458 || c
== ' ' || c
== '\t' || c
== '\f')
21460 if (bytepos
<= BEGV_BYTE
)
21465 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21468 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21469 itb
.paragraph_dir
= NEUTRAL_DIR
;
21470 itb
.string
.s
= NULL
;
21471 itb
.string
.lstring
= Qnil
;
21472 itb
.string
.bufpos
= 0;
21473 itb
.string
.from_disp_str
= false;
21474 itb
.string
.unibyte
= false;
21475 /* We have no window to use here for ignoring window-specific
21476 overlays. Using NULL for window pointer will cause
21477 compute_display_string_pos to use the current buffer. */
21479 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21480 bidi_unshelve_cache (itb_data
, false);
21481 set_buffer_temp (old
);
21482 switch (itb
.paragraph_dir
)
21485 return Qleft_to_right
;
21488 return Qright_to_left
;
21496 DEFUN ("bidi-find-overridden-directionality",
21497 Fbidi_find_overridden_directionality
,
21498 Sbidi_find_overridden_directionality
, 2, 3, 0,
21499 doc
: /* Return position between FROM and TO where directionality was overridden.
21501 This function returns the first character position in the specified
21502 region of OBJECT where there is a character whose `bidi-class' property
21503 is `L', but which was forced to display as `R' by a directional
21504 override, and likewise with characters whose `bidi-class' is `R'
21505 or `AL' that were forced to display as `L'.
21507 If no such character is found, the function returns nil.
21509 OBJECT is a Lisp string or buffer to search for overridden
21510 directionality, and defaults to the current buffer if nil or omitted.
21511 OBJECT can also be a window, in which case the function will search
21512 the buffer displayed in that window. Passing the window instead of
21513 a buffer is preferable when the buffer is displayed in some window,
21514 because this function will then be able to correctly account for
21515 window-specific overlays, which can affect the results.
21517 Strong directional characters `L', `R', and `AL' can have their
21518 intrinsic directionality overridden by directional override
21519 control characters RLO (u+202e) and LRO (u+202d). See the
21520 function `get-char-code-property' for a way to inquire about
21521 the `bidi-class' property of a character. */)
21522 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21524 struct buffer
*buf
= current_buffer
;
21525 struct buffer
*old
= buf
;
21526 struct window
*w
= NULL
;
21527 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21528 struct bidi_it itb
;
21529 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21532 if (!NILP (object
))
21534 if (BUFFERP (object
))
21535 buf
= XBUFFER (object
);
21536 else if (WINDOWP (object
))
21538 w
= decode_live_window (object
);
21539 buf
= XBUFFER (w
->contents
);
21540 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21543 CHECK_STRING (object
);
21546 if (STRINGP (object
))
21548 /* Characters in unibyte strings are always treated by bidi.c as
21550 if (!STRING_MULTIBYTE (object
)
21551 /* When we are loading loadup.el, the character property
21552 tables needed for bidi iteration are not yet
21554 || redisplay__inhibit_bidi
)
21557 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21558 if (from_pos
>= SCHARS (object
))
21561 /* Set up the bidi iterator. */
21562 itb_data
= bidi_shelve_cache ();
21563 itb
.paragraph_dir
= NEUTRAL_DIR
;
21564 itb
.string
.lstring
= object
;
21565 itb
.string
.s
= NULL
;
21566 itb
.string
.schars
= SCHARS (object
);
21567 itb
.string
.bufpos
= 0;
21568 itb
.string
.from_disp_str
= false;
21569 itb
.string
.unibyte
= false;
21571 bidi_init_it (0, 0, frame_window_p
, &itb
);
21575 /* Nothing this fancy can happen in unibyte buffers, or in a
21576 buffer that disabled reordering, or if FROM is at EOB. */
21577 if (NILP (BVAR (buf
, bidi_display_reordering
))
21578 || NILP (BVAR (buf
, enable_multibyte_characters
))
21579 /* When we are loading loadup.el, the character property
21580 tables needed for bidi iteration are not yet
21582 || redisplay__inhibit_bidi
)
21585 set_buffer_temp (buf
);
21586 validate_region (&from
, &to
);
21587 from_pos
= XINT (from
);
21588 to_pos
= XINT (to
);
21589 if (from_pos
>= ZV
)
21592 /* Set up the bidi iterator. */
21593 itb_data
= bidi_shelve_cache ();
21594 from_bpos
= CHAR_TO_BYTE (from_pos
);
21595 if (from_pos
== BEGV
)
21597 itb
.charpos
= BEGV
;
21598 itb
.bytepos
= BEGV_BYTE
;
21600 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21602 itb
.charpos
= from_pos
;
21603 itb
.bytepos
= from_bpos
;
21606 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21608 itb
.paragraph_dir
= NEUTRAL_DIR
;
21609 itb
.string
.s
= NULL
;
21610 itb
.string
.lstring
= Qnil
;
21611 itb
.string
.bufpos
= 0;
21612 itb
.string
.from_disp_str
= false;
21613 itb
.string
.unibyte
= false;
21615 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21620 /* For the purposes of this function, the actual base direction of
21621 the paragraph doesn't matter, so just set it to L2R. */
21622 bidi_paragraph_init (L2R
, &itb
, false);
21623 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21625 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21627 bidi_unshelve_cache (itb_data
, false);
21628 set_buffer_temp (old
);
21630 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21633 DEFUN ("move-point-visually", Fmove_point_visually
,
21634 Smove_point_visually
, 1, 1, 0,
21635 doc
: /* Move point in the visual order in the specified DIRECTION.
21636 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21639 Value is the new character position of point. */)
21640 (Lisp_Object direction
)
21642 struct window
*w
= XWINDOW (selected_window
);
21643 struct buffer
*b
= XBUFFER (w
->contents
);
21644 struct glyph_row
*row
;
21646 Lisp_Object paragraph_dir
;
21648 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21649 (!(ROW)->continued_p \
21650 && NILP ((GLYPH)->object) \
21651 && (GLYPH)->type == CHAR_GLYPH \
21652 && (GLYPH)->u.ch == ' ' \
21653 && (GLYPH)->charpos >= 0 \
21654 && !(GLYPH)->avoid_cursor_p)
21656 CHECK_NUMBER (direction
);
21657 dir
= XINT (direction
);
21663 /* If current matrix is up-to-date, we can use the information
21664 recorded in the glyphs, at least as long as the goal is on the
21666 if (w
->window_end_valid
21667 && !windows_or_buffers_changed
21669 && !b
->clip_changed
21670 && !b
->prevent_redisplay_optimizations_p
21671 && !window_outdated (w
)
21672 /* We rely below on the cursor coordinates to be up to date, but
21673 we cannot trust them if some command moved point since the
21674 last complete redisplay. */
21675 && w
->last_point
== BUF_PT (b
)
21676 && w
->cursor
.vpos
>= 0
21677 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21678 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21680 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21681 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21682 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21684 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21686 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21688 SET_PT (g
->charpos
);
21689 w
->cursor
.vpos
= -1;
21690 return make_number (PT
);
21692 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21696 if (BUFFERP (gpt
->object
))
21699 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21700 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21702 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21704 else if (BUFFERP (g
->object
))
21705 new_pos
= g
->charpos
;
21709 w
->cursor
.vpos
= -1;
21710 return make_number (PT
);
21712 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21714 /* Glyphs inserted at the end of a non-empty line for
21715 positioning the cursor have zero charpos, so we must
21716 deduce the value of point by other means. */
21717 if (g
->charpos
> 0)
21718 SET_PT (g
->charpos
);
21719 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21721 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21722 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21725 w
->cursor
.vpos
= -1;
21726 return make_number (PT
);
21729 if (g
== e
|| NILP (g
->object
))
21731 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21732 goto simulate_display
;
21733 if (!row
->reversed_p
)
21737 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21738 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21739 goto simulate_display
;
21743 if (row
->reversed_p
&& !row
->continued_p
)
21745 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21746 w
->cursor
.vpos
= -1;
21747 return make_number (PT
);
21749 g
= row
->glyphs
[TEXT_AREA
];
21750 e
= g
+ row
->used
[TEXT_AREA
];
21751 for ( ; g
< e
; g
++)
21753 if (BUFFERP (g
->object
)
21754 /* Empty lines have only one glyph, which stands
21755 for the newline, and whose charpos is the
21756 buffer position of the newline. */
21757 || ROW_GLYPH_NEWLINE_P (row
, g
)
21758 /* When the buffer ends in a newline, the line at
21759 EOB also has one glyph, but its charpos is -1. */
21760 || (row
->ends_at_zv_p
21761 && !row
->reversed_p
21762 && NILP (g
->object
)
21763 && g
->type
== CHAR_GLYPH
21764 && g
->u
.ch
== ' '))
21766 if (g
->charpos
> 0)
21767 SET_PT (g
->charpos
);
21768 else if (!row
->reversed_p
21769 && row
->ends_at_zv_p
21774 w
->cursor
.vpos
= -1;
21775 return make_number (PT
);
21781 if (!row
->reversed_p
&& !row
->continued_p
)
21783 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21784 w
->cursor
.vpos
= -1;
21785 return make_number (PT
);
21787 e
= row
->glyphs
[TEXT_AREA
];
21788 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21789 for ( ; g
>= e
; g
--)
21791 if (BUFFERP (g
->object
)
21792 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21794 /* Empty R2L lines on GUI frames have the buffer
21795 position of the newline stored in the stretch
21797 || g
->type
== STRETCH_GLYPH
21798 || (row
->ends_at_zv_p
21800 && NILP (g
->object
)
21801 && g
->type
== CHAR_GLYPH
21802 && g
->u
.ch
== ' '))
21804 if (g
->charpos
> 0)
21805 SET_PT (g
->charpos
);
21806 else if (row
->reversed_p
21807 && row
->ends_at_zv_p
21812 w
->cursor
.vpos
= -1;
21813 return make_number (PT
);
21822 /* If we wind up here, we failed to move by using the glyphs, so we
21823 need to simulate display instead. */
21826 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21828 paragraph_dir
= Qleft_to_right
;
21829 if (EQ (paragraph_dir
, Qright_to_left
))
21831 if (PT
<= BEGV
&& dir
< 0)
21832 xsignal0 (Qbeginning_of_buffer
);
21833 else if (PT
>= ZV
&& dir
> 0)
21834 xsignal0 (Qend_of_buffer
);
21837 struct text_pos pt
;
21839 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21841 bool overshoot_expected
= false;
21842 bool target_is_eol_p
= false;
21844 /* Setup the arena. */
21845 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21846 start_display (&it
, w
, pt
);
21847 /* When lines are truncated, we could be called with point
21848 outside of the windows edges, in which case move_it_*
21849 functions either prematurely stop at window's edge or jump to
21850 the next screen line, whereas we rely below on our ability to
21851 reach point, in order to start from its X coordinate. So we
21852 need to disregard the window's horizontal extent in that case. */
21853 if (it
.line_wrap
== TRUNCATE
)
21854 it
.last_visible_x
= INFINITY
;
21856 if (it
.cmp_it
.id
< 0
21857 && it
.method
== GET_FROM_STRING
21858 && it
.area
== TEXT_AREA
21859 && it
.string_from_display_prop_p
21860 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21861 overshoot_expected
= true;
21863 /* Find the X coordinate of point. We start from the beginning
21864 of this or previous line to make sure we are before point in
21865 the logical order (since the move_it_* functions can only
21868 reseat_at_previous_visible_line_start (&it
);
21869 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21870 if (IT_CHARPOS (it
) != PT
)
21872 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21873 -1, -1, -1, MOVE_TO_POS
);
21874 /* If we missed point because the character there is
21875 displayed out of a display vector that has more than one
21876 glyph, retry expecting overshoot. */
21877 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21878 && it
.current
.dpvec_index
> 0
21879 && !overshoot_expected
)
21881 overshoot_expected
= true;
21884 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21885 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21887 pt_x
= it
.current_x
;
21889 if (dir
> 0 || overshoot_expected
)
21891 struct glyph_row
*row
= it
.glyph_row
;
21893 /* When point is at beginning of line, we don't have
21894 information about the glyph there loaded into struct
21895 it. Calling get_next_display_element fixes that. */
21897 get_next_display_element (&it
);
21898 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21899 it
.glyph_row
= NULL
;
21900 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21901 it
.glyph_row
= row
;
21902 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21903 it, lest it will become out of sync with it's buffer
21905 it
.current_x
= pt_x
;
21908 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21909 pixel_width
= it
.pixel_width
;
21910 if (overshoot_expected
&& at_eol_p
)
21912 else if (pixel_width
<= 0)
21915 /* If there's a display string (or something similar) at point,
21916 we are actually at the glyph to the left of point, so we need
21917 to correct the X coordinate. */
21918 if (overshoot_expected
)
21921 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21923 pt_x
+= pixel_width
;
21926 /* Compute target X coordinate, either to the left or to the
21927 right of point. On TTY frames, all characters have the same
21928 pixel width of 1, so we can use that. On GUI frames we don't
21929 have an easy way of getting at the pixel width of the
21930 character to the left of point, so we use a different method
21931 of getting to that place. */
21933 target_x
= pt_x
+ pixel_width
;
21935 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21937 /* Target X coordinate could be one line above or below the line
21938 of point, in which case we need to adjust the target X
21939 coordinate. Also, if moving to the left, we need to begin at
21940 the left edge of the point's screen line. */
21945 start_display (&it
, w
, pt
);
21946 if (it
.line_wrap
== TRUNCATE
)
21947 it
.last_visible_x
= INFINITY
;
21948 reseat_at_previous_visible_line_start (&it
);
21949 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21951 move_it_by_lines (&it
, pt_vpos
);
21955 move_it_by_lines (&it
, -1);
21956 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21957 target_is_eol_p
= true;
21958 /* Under word-wrap, we don't know the x coordinate of
21959 the last character displayed on the previous line,
21960 which immediately precedes the wrap point. To find
21961 out its x coordinate, we try moving to the right
21962 margin of the window, which will stop at the wrap
21963 point, and then reset target_x to point at the
21964 character that precedes the wrap point. This is not
21965 needed on GUI frames, because (see below) there we
21966 move from the left margin one grapheme cluster at a
21967 time, and stop when we hit the wrap point. */
21968 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21970 void *it_data
= NULL
;
21973 SAVE_IT (it2
, it
, it_data
);
21974 move_it_in_display_line_to (&it
, ZV
, target_x
,
21975 MOVE_TO_POS
| MOVE_TO_X
);
21976 /* If we arrived at target_x, that _is_ the last
21977 character on the previous line. */
21978 if (it
.current_x
!= target_x
)
21979 target_x
= it
.current_x
- 1;
21980 RESTORE_IT (&it
, &it2
, it_data
);
21987 || (target_x
>= it
.last_visible_x
21988 && it
.line_wrap
!= TRUNCATE
))
21991 move_it_by_lines (&it
, 0);
21992 move_it_by_lines (&it
, 1);
21997 /* Move to the target X coordinate. */
21998 /* On GUI frames, as we don't know the X coordinate of the
21999 character to the left of point, moving point to the left
22000 requires walking, one grapheme cluster at a time, until we
22001 find ourself at a place immediately to the left of the
22002 character at point. */
22003 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
22005 struct text_pos new_pos
;
22006 enum move_it_result rc
= MOVE_X_REACHED
;
22008 if (it
.current_x
== 0)
22009 get_next_display_element (&it
);
22010 if (it
.what
== IT_COMPOSITION
)
22012 new_pos
.charpos
= it
.cmp_it
.charpos
;
22013 new_pos
.bytepos
= -1;
22016 new_pos
= it
.current
.pos
;
22018 while (it
.current_x
+ it
.pixel_width
<= target_x
22019 && (rc
== MOVE_X_REACHED
22020 /* Under word-wrap, move_it_in_display_line_to
22021 stops at correct coordinates, but sometimes
22022 returns MOVE_POS_MATCH_OR_ZV. */
22023 || (it
.line_wrap
== WORD_WRAP
22024 && rc
== MOVE_POS_MATCH_OR_ZV
)))
22026 int new_x
= it
.current_x
+ it
.pixel_width
;
22028 /* For composed characters, we want the position of the
22029 first character in the grapheme cluster (usually, the
22030 composition's base character), whereas it.current
22031 might give us the position of the _last_ one, e.g. if
22032 the composition is rendered in reverse due to bidi
22034 if (it
.what
== IT_COMPOSITION
)
22036 new_pos
.charpos
= it
.cmp_it
.charpos
;
22037 new_pos
.bytepos
= -1;
22040 new_pos
= it
.current
.pos
;
22041 if (new_x
== it
.current_x
)
22043 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
22044 MOVE_TO_POS
| MOVE_TO_X
);
22045 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
22048 /* The previous position we saw in the loop is the one we
22050 if (new_pos
.bytepos
== -1)
22051 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
22052 it
.current
.pos
= new_pos
;
22054 else if (it
.current_x
!= target_x
)
22055 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
22057 /* If we ended up in a display string that covers point, move to
22058 buffer position to the right in the visual order. */
22061 while (IT_CHARPOS (it
) == PT
)
22063 set_iterator_to_next (&it
, false);
22064 if (!get_next_display_element (&it
))
22069 /* Move point to that position. */
22070 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
22073 return make_number (PT
);
22075 #undef ROW_GLYPH_NEWLINE_P
22078 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
22079 Sbidi_resolved_levels
, 0, 1, 0,
22080 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
22082 The resolved levels are produced by the Emacs bidi reordering engine
22083 that implements the UBA, the Unicode Bidirectional Algorithm. Please
22084 read the Unicode Standard Annex 9 (UAX#9) for background information
22085 about these levels.
22087 VPOS is the zero-based number of the current window's screen line
22088 for which to produce the resolved levels. If VPOS is nil or omitted,
22089 it defaults to the screen line of point. If the window displays a
22090 header line, VPOS of zero will report on the header line, and first
22091 line of text in the window will have VPOS of 1.
22093 Value is an array of resolved levels, indexed by glyph number.
22094 Glyphs are numbered from zero starting from the beginning of the
22095 screen line, i.e. the left edge of the window for left-to-right lines
22096 and from the right edge for right-to-left lines. The resolved levels
22097 are produced only for the window's text area; text in display margins
22100 If the selected window's display is not up-to-date, or if the specified
22101 screen line does not display text, this function returns nil. It is
22102 highly recommended to bind this function to some simple key, like F8,
22103 in order to avoid these problems.
22105 This function exists mainly for testing the correctness of the
22106 Emacs UBA implementation, in particular with the test suite. */)
22109 struct window
*w
= XWINDOW (selected_window
);
22110 struct buffer
*b
= XBUFFER (w
->contents
);
22112 struct glyph_row
*row
;
22116 int d1
, d2
, d3
, d4
, d5
;
22118 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
22122 CHECK_NUMBER_COERCE_MARKER (vpos
);
22123 nrow
= XINT (vpos
);
22126 /* We require up-to-date glyph matrix for this window. */
22127 if (w
->window_end_valid
22128 && !windows_or_buffers_changed
22130 && !b
->clip_changed
22131 && !b
->prevent_redisplay_optimizations_p
22132 && !window_outdated (w
)
22134 && nrow
< w
->current_matrix
->nrows
22135 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
22136 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
22138 struct glyph
*g
, *e
, *g1
;
22140 Lisp_Object levels
;
22142 if (!row
->reversed_p
) /* Left-to-right glyph row. */
22144 g
= g1
= row
->glyphs
[TEXT_AREA
];
22145 e
= g
+ row
->used
[TEXT_AREA
];
22147 /* Skip over glyphs at the start of the row that was
22148 generated by redisplay for its own needs. */
22150 && NILP (g
->object
)
22155 /* Count the "interesting" glyphs in this row. */
22156 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
22159 /* Create and fill the array. */
22160 levels
= make_uninit_vector (nglyphs
);
22161 for (i
= 0; g1
< g
; i
++, g1
++)
22162 ASET (levels
, i
, make_number (g1
->resolved_level
));
22164 else /* Right-to-left glyph row. */
22166 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
22167 e
= row
->glyphs
[TEXT_AREA
] - 1;
22169 && NILP (g
->object
)
22173 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
22175 levels
= make_uninit_vector (nglyphs
);
22176 for (i
= 0; g1
> g
; i
++, g1
--)
22177 ASET (levels
, i
, make_number (g1
->resolved_level
));
22187 /***********************************************************************
22189 ***********************************************************************/
22191 /* Redisplay the menu bar in the frame for window W.
22193 The menu bar of X frames that don't have X toolkit support is
22194 displayed in a special window W->frame->menu_bar_window.
22196 The menu bar of terminal frames is treated specially as far as
22197 glyph matrices are concerned. Menu bar lines are not part of
22198 windows, so the update is done directly on the frame matrix rows
22199 for the menu bar. */
22202 display_menu_bar (struct window
*w
)
22204 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22209 /* Don't do all this for graphical frames. */
22211 if (FRAME_W32_P (f
))
22214 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22220 if (FRAME_NS_P (f
))
22222 #endif /* HAVE_NS */
22224 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22225 eassert (!FRAME_WINDOW_P (f
));
22226 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
22227 it
.first_visible_x
= 0;
22228 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22229 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
22230 if (FRAME_WINDOW_P (f
))
22232 /* Menu bar lines are displayed in the desired matrix of the
22233 dummy window menu_bar_window. */
22234 struct window
*menu_w
;
22235 menu_w
= XWINDOW (f
->menu_bar_window
);
22236 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
22238 it
.first_visible_x
= 0;
22239 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22242 #endif /* not USE_X_TOOLKIT and not USE_GTK */
22244 /* This is a TTY frame, i.e. character hpos/vpos are used as
22246 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
22248 it
.first_visible_x
= 0;
22249 it
.last_visible_x
= FRAME_COLS (f
);
22252 /* FIXME: This should be controlled by a user option. See the
22253 comments in redisplay_tool_bar and display_mode_line about
22255 it
.paragraph_embedding
= L2R
;
22257 /* Clear all rows of the menu bar. */
22258 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
22260 struct glyph_row
*row
= it
.glyph_row
+ i
;
22261 clear_glyph_row (row
);
22262 row
->enabled_p
= true;
22263 row
->full_width_p
= true;
22264 row
->reversed_p
= false;
22267 /* Display all items of the menu bar. */
22268 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
22269 for (i
= 0; i
< ASIZE (items
); i
+= 4)
22271 Lisp_Object string
;
22273 /* Stop at nil string. */
22274 string
= AREF (items
, i
+ 1);
22278 /* Remember where item was displayed. */
22279 ASET (items
, i
+ 3, make_number (it
.hpos
));
22281 /* Display the item, pad with one space. */
22282 if (it
.current_x
< it
.last_visible_x
)
22283 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
22284 SCHARS (string
) + 1, 0, 0, -1);
22287 /* Fill out the line with spaces. */
22288 if (it
.current_x
< it
.last_visible_x
)
22289 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
22291 /* Compute the total height of the lines. */
22292 compute_line_metrics (&it
);
22295 /* Deep copy of a glyph row, including the glyphs. */
22297 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
22299 struct glyph
*pointers
[1 + LAST_AREA
];
22300 int to_used
= to
->used
[TEXT_AREA
];
22302 /* Save glyph pointers of TO. */
22303 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
22305 /* Do a structure assignment. */
22308 /* Restore original glyph pointers of TO. */
22309 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
22311 /* Copy the glyphs. */
22312 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
22313 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
22315 /* If we filled only part of the TO row, fill the rest with
22316 space_glyph (which will display as empty space). */
22317 if (to_used
> from
->used
[TEXT_AREA
])
22318 fill_up_frame_row_with_spaces (to
, to_used
);
22321 /* Display one menu item on a TTY, by overwriting the glyphs in the
22322 frame F's desired glyph matrix with glyphs produced from the menu
22323 item text. Called from term.c to display TTY drop-down menus one
22326 ITEM_TEXT is the menu item text as a C string.
22328 FACE_ID is the face ID to be used for this menu item. FACE_ID
22329 could specify one of 3 faces: a face for an enabled item, a face
22330 for a disabled item, or a face for a selected item.
22332 X and Y are coordinates of the first glyph in the frame's desired
22333 matrix to be overwritten by the menu item. Since this is a TTY, Y
22334 is the zero-based number of the glyph row and X is the zero-based
22335 glyph number in the row, starting from left, where to start
22336 displaying the item.
22338 SUBMENU means this menu item drops down a submenu, which
22339 should be indicated by displaying a proper visual cue after the
22343 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
22344 int x
, int y
, bool submenu
)
22347 struct frame
*f
= SELECTED_FRAME ();
22348 struct window
*w
= XWINDOW (f
->selected_window
);
22349 struct glyph_row
*row
;
22350 size_t item_len
= strlen (item_text
);
22352 eassert (FRAME_TERMCAP_P (f
));
22354 /* Don't write beyond the matrix's last row. This can happen for
22355 TTY screens that are not high enough to show the entire menu.
22356 (This is actually a bit of defensive programming, as
22357 tty_menu_display already limits the number of menu items to one
22358 less than the number of screen lines.) */
22359 if (y
>= f
->desired_matrix
->nrows
)
22362 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
22363 it
.first_visible_x
= 0;
22364 it
.last_visible_x
= FRAME_COLS (f
) - 1;
22365 row
= it
.glyph_row
;
22366 /* Start with the row contents from the current matrix. */
22367 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
22368 bool saved_width
= row
->full_width_p
;
22369 row
->full_width_p
= true;
22370 bool saved_reversed
= row
->reversed_p
;
22371 row
->reversed_p
= false;
22372 row
->enabled_p
= true;
22374 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22376 eassert (x
< f
->desired_matrix
->matrix_w
);
22377 it
.current_x
= it
.hpos
= x
;
22378 it
.current_y
= it
.vpos
= y
;
22379 int saved_used
= row
->used
[TEXT_AREA
];
22380 bool saved_truncated
= row
->truncated_on_right_p
;
22381 row
->used
[TEXT_AREA
] = x
;
22382 it
.face_id
= face_id
;
22383 it
.line_wrap
= TRUNCATE
;
22385 /* FIXME: This should be controlled by a user option. See the
22386 comments in redisplay_tool_bar and display_mode_line about this.
22387 Also, if paragraph_embedding could ever be R2L, changes will be
22388 needed to avoid shifting to the right the row characters in
22389 term.c:append_glyph. */
22390 it
.paragraph_embedding
= L2R
;
22392 /* Pad with a space on the left. */
22393 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22395 /* Display the menu item, pad with spaces to WIDTH. */
22398 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22399 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22401 /* Indicate with " >" that there's a submenu. */
22402 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22403 FRAME_COLS (f
) - 1, -1);
22406 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22407 width
, 0, FRAME_COLS (f
) - 1, -1);
22409 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22410 row
->truncated_on_right_p
= saved_truncated
;
22411 row
->hash
= row_hash (row
);
22412 row
->full_width_p
= saved_width
;
22413 row
->reversed_p
= saved_reversed
;
22416 /***********************************************************************
22418 ***********************************************************************/
22420 /* Redisplay mode lines in the window tree whose root is WINDOW.
22421 If FORCE, redisplay mode lines unconditionally.
22422 Otherwise, redisplay only mode lines that are garbaged. Value is
22423 the number of windows whose mode lines were redisplayed. */
22426 redisplay_mode_lines (Lisp_Object window
, bool force
)
22430 while (!NILP (window
))
22432 struct window
*w
= XWINDOW (window
);
22434 if (WINDOWP (w
->contents
))
22435 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22437 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22438 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22440 struct text_pos lpoint
;
22441 struct buffer
*old
= current_buffer
;
22443 /* Set the window's buffer for the mode line display. */
22444 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22445 set_buffer_internal_1 (XBUFFER (w
->contents
));
22447 /* Point refers normally to the selected window. For any
22448 other window, set up appropriate value. */
22449 if (!EQ (window
, selected_window
))
22451 struct text_pos pt
;
22453 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22454 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22457 /* Display mode lines. */
22458 clear_glyph_matrix (w
->desired_matrix
);
22459 if (display_mode_lines (w
))
22462 /* Restore old settings. */
22463 set_buffer_internal_1 (old
);
22464 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22474 /* Display the mode and/or header line of window W. Value is the
22475 sum number of mode lines and header lines displayed. */
22478 display_mode_lines (struct window
*w
)
22480 Lisp_Object old_selected_window
= selected_window
;
22481 Lisp_Object old_selected_frame
= selected_frame
;
22482 Lisp_Object new_frame
= w
->frame
;
22483 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22486 selected_frame
= new_frame
;
22487 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22488 or window's point, then we'd need select_window_1 here as well. */
22489 XSETWINDOW (selected_window
, w
);
22490 XFRAME (new_frame
)->selected_window
= selected_window
;
22492 /* These will be set while the mode line specs are processed. */
22493 line_number_displayed
= false;
22494 w
->column_number_displayed
= -1;
22496 if (WINDOW_WANTS_MODELINE_P (w
))
22498 struct window
*sel_w
= XWINDOW (old_selected_window
);
22500 /* Select mode line face based on the real selected window. */
22501 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22502 BVAR (current_buffer
, mode_line_format
));
22506 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22508 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22509 BVAR (current_buffer
, header_line_format
));
22513 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22514 selected_frame
= old_selected_frame
;
22515 selected_window
= old_selected_window
;
22517 w
->must_be_updated_p
= true;
22522 /* Display mode or header line of window W. FACE_ID specifies which
22523 line to display; it is either MODE_LINE_FACE_ID or
22524 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22525 display. Value is the pixel height of the mode/header line
22529 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22533 ptrdiff_t count
= SPECPDL_INDEX ();
22535 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22536 /* Don't extend on a previously drawn mode-line.
22537 This may happen if called from pos_visible_p. */
22538 it
.glyph_row
->enabled_p
= false;
22539 prepare_desired_row (w
, it
.glyph_row
, true);
22541 it
.glyph_row
->mode_line_p
= true;
22543 /* FIXME: This should be controlled by a user option. But
22544 supporting such an option is not trivial, since the mode line is
22545 made up of many separate strings. */
22546 it
.paragraph_embedding
= L2R
;
22548 record_unwind_protect (unwind_format_mode_line
,
22549 format_mode_line_unwind_data (NULL
, NULL
,
22552 mode_line_target
= MODE_LINE_DISPLAY
;
22554 /* Temporarily make frame's keyboard the current kboard so that
22555 kboard-local variables in the mode_line_format will get the right
22557 push_kboard (FRAME_KBOARD (it
.f
));
22558 record_unwind_save_match_data ();
22559 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22562 unbind_to (count
, Qnil
);
22564 /* Fill up with spaces. */
22565 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22567 compute_line_metrics (&it
);
22568 it
.glyph_row
->full_width_p
= true;
22569 it
.glyph_row
->continued_p
= false;
22570 it
.glyph_row
->truncated_on_left_p
= false;
22571 it
.glyph_row
->truncated_on_right_p
= false;
22573 /* Make a 3D mode-line have a shadow at its right end. */
22574 face
= FACE_FROM_ID (it
.f
, face_id
);
22575 extend_face_to_end_of_line (&it
);
22576 if (face
->box
!= FACE_NO_BOX
)
22578 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22579 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22580 last
->right_box_line_p
= true;
22583 return it
.glyph_row
->height
;
22586 /* Move element ELT in LIST to the front of LIST.
22587 Return the updated list. */
22590 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22592 register Lisp_Object tail
, prev
;
22593 register Lisp_Object tem
;
22597 while (CONSP (tail
))
22603 /* Splice out the link TAIL. */
22605 list
= XCDR (tail
);
22607 Fsetcdr (prev
, XCDR (tail
));
22609 /* Now make it the first. */
22610 Fsetcdr (tail
, list
);
22615 tail
= XCDR (tail
);
22619 /* Not found--return unchanged LIST. */
22623 /* Contribute ELT to the mode line for window IT->w. How it
22624 translates into text depends on its data type.
22626 IT describes the display environment in which we display, as usual.
22628 DEPTH is the depth in recursion. It is used to prevent
22629 infinite recursion here.
22631 FIELD_WIDTH is the number of characters the display of ELT should
22632 occupy in the mode line, and PRECISION is the maximum number of
22633 characters to display from ELT's representation. See
22634 display_string for details.
22636 Returns the hpos of the end of the text generated by ELT.
22638 PROPS is a property list to add to any string we encounter.
22640 If RISKY, remove (disregard) any properties in any string
22641 we encounter, and ignore :eval and :propertize.
22643 The global variable `mode_line_target' determines whether the
22644 output is passed to `store_mode_line_noprop',
22645 `store_mode_line_string', or `display_string'. */
22648 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22649 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22651 int n
= 0, field
, prec
;
22652 bool literal
= false;
22656 elt
= build_string ("*too-deep*");
22660 switch (XTYPE (elt
))
22664 /* A string: output it and check for %-constructs within it. */
22666 ptrdiff_t offset
= 0;
22668 if (SCHARS (elt
) > 0
22669 && (!NILP (props
) || risky
))
22671 Lisp_Object oprops
, aelt
;
22672 oprops
= Ftext_properties_at (make_number (0), elt
);
22674 /* If the starting string's properties are not what
22675 we want, translate the string. Also, if the string
22676 is risky, do that anyway. */
22678 if (NILP (Fequal (props
, oprops
)) || risky
)
22680 /* If the starting string has properties,
22681 merge the specified ones onto the existing ones. */
22682 if (! NILP (oprops
) && !risky
)
22686 oprops
= Fcopy_sequence (oprops
);
22688 while (CONSP (tem
))
22690 oprops
= Fplist_put (oprops
, XCAR (tem
),
22691 XCAR (XCDR (tem
)));
22692 tem
= XCDR (XCDR (tem
));
22697 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22698 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22700 /* AELT is what we want. Move it to the front
22701 without consing. */
22703 mode_line_proptrans_alist
22704 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22710 /* If AELT has the wrong props, it is useless.
22711 so get rid of it. */
22713 mode_line_proptrans_alist
22714 = Fdelq (aelt
, mode_line_proptrans_alist
);
22716 elt
= Fcopy_sequence (elt
);
22717 Fset_text_properties (make_number (0), Flength (elt
),
22719 /* Add this item to mode_line_proptrans_alist. */
22720 mode_line_proptrans_alist
22721 = Fcons (Fcons (elt
, props
),
22722 mode_line_proptrans_alist
);
22723 /* Truncate mode_line_proptrans_alist
22724 to at most 50 elements. */
22725 tem
= Fnthcdr (make_number (50),
22726 mode_line_proptrans_alist
);
22728 XSETCDR (tem
, Qnil
);
22737 prec
= precision
- n
;
22738 switch (mode_line_target
)
22740 case MODE_LINE_NOPROP
:
22741 case MODE_LINE_TITLE
:
22742 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22744 case MODE_LINE_STRING
:
22745 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22747 case MODE_LINE_DISPLAY
:
22748 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22749 0, prec
, 0, STRING_MULTIBYTE (elt
));
22756 /* Handle the non-literal case. */
22758 while ((precision
<= 0 || n
< precision
)
22759 && SREF (elt
, offset
) != 0
22760 && (mode_line_target
!= MODE_LINE_DISPLAY
22761 || it
->current_x
< it
->last_visible_x
))
22763 ptrdiff_t last_offset
= offset
;
22765 /* Advance to end of string or next format specifier. */
22766 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22769 if (offset
- 1 != last_offset
)
22771 ptrdiff_t nchars
, nbytes
;
22773 /* Output to end of string or up to '%'. Field width
22774 is length of string. Don't output more than
22775 PRECISION allows us. */
22778 prec
= c_string_width (SDATA (elt
) + last_offset
,
22779 offset
- last_offset
, precision
- n
,
22782 switch (mode_line_target
)
22784 case MODE_LINE_NOPROP
:
22785 case MODE_LINE_TITLE
:
22786 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22788 case MODE_LINE_STRING
:
22790 ptrdiff_t bytepos
= last_offset
;
22791 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22792 ptrdiff_t endpos
= (precision
<= 0
22793 ? string_byte_to_char (elt
, offset
)
22794 : charpos
+ nchars
);
22795 Lisp_Object mode_string
22796 = Fsubstring (elt
, make_number (charpos
),
22797 make_number (endpos
));
22798 n
+= store_mode_line_string (NULL
, mode_string
, false,
22802 case MODE_LINE_DISPLAY
:
22804 ptrdiff_t bytepos
= last_offset
;
22805 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22807 if (precision
<= 0)
22808 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22809 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22811 STRING_MULTIBYTE (elt
));
22816 else /* c == '%' */
22818 ptrdiff_t percent_position
= offset
;
22820 /* Get the specified minimum width. Zero means
22823 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22824 field
= field
* 10 + c
- '0';
22826 /* Don't pad beyond the total padding allowed. */
22827 if (field_width
- n
> 0 && field
> field_width
- n
)
22828 field
= field_width
- n
;
22830 /* Note that either PRECISION <= 0 or N < PRECISION. */
22831 prec
= precision
- n
;
22834 n
+= display_mode_element (it
, depth
, field
, prec
,
22835 Vglobal_mode_string
, props
,
22840 ptrdiff_t bytepos
, charpos
;
22842 Lisp_Object string
;
22844 bytepos
= percent_position
;
22845 charpos
= (STRING_MULTIBYTE (elt
)
22846 ? string_byte_to_char (elt
, bytepos
)
22848 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22849 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22851 switch (mode_line_target
)
22853 case MODE_LINE_NOPROP
:
22854 case MODE_LINE_TITLE
:
22855 n
+= store_mode_line_noprop (spec
, field
, prec
);
22857 case MODE_LINE_STRING
:
22859 Lisp_Object tem
= build_string (spec
);
22860 props
= Ftext_properties_at (make_number (charpos
), elt
);
22861 /* Should only keep face property in props */
22862 n
+= store_mode_line_string (NULL
, tem
, false,
22863 field
, prec
, props
);
22866 case MODE_LINE_DISPLAY
:
22868 int nglyphs_before
, nwritten
;
22870 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22871 nwritten
= display_string (spec
, string
, elt
,
22876 /* Assign to the glyphs written above the
22877 string where the `%x' came from, position
22881 struct glyph
*glyph
22882 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22886 for (i
= 0; i
< nwritten
; ++i
)
22888 glyph
[i
].object
= elt
;
22889 glyph
[i
].charpos
= charpos
;
22906 /* A symbol: process the value of the symbol recursively
22907 as if it appeared here directly. Avoid error if symbol void.
22908 Special case: if value of symbol is a string, output the string
22911 register Lisp_Object tem
;
22913 /* If the variable is not marked as risky to set
22914 then its contents are risky to use. */
22915 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22918 tem
= Fboundp (elt
);
22921 tem
= Fsymbol_value (elt
);
22922 /* If value is a string, output that string literally:
22923 don't check for % within it. */
22927 if (!EQ (tem
, elt
))
22929 /* Give up right away for nil or t. */
22939 register Lisp_Object car
, tem
;
22941 /* A cons cell: five distinct cases.
22942 If first element is :eval or :propertize, do something special.
22943 If first element is a string or a cons, process all the elements
22944 and effectively concatenate them.
22945 If first element is a negative number, truncate displaying cdr to
22946 at most that many characters. If positive, pad (with spaces)
22947 to at least that many characters.
22948 If first element is a symbol, process the cadr or caddr recursively
22949 according to whether the symbol's value is non-nil or nil. */
22951 if (EQ (car
, QCeval
))
22953 /* An element of the form (:eval FORM) means evaluate FORM
22954 and use the result as mode line elements. */
22959 if (CONSP (XCDR (elt
)))
22962 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22963 n
+= display_mode_element (it
, depth
, field_width
- n
,
22964 precision
- n
, spec
, props
,
22968 else if (EQ (car
, QCpropertize
))
22970 /* An element of the form (:propertize ELT PROPS...)
22971 means display ELT but applying properties PROPS. */
22976 if (CONSP (XCDR (elt
)))
22977 n
+= display_mode_element (it
, depth
, field_width
- n
,
22978 precision
- n
, XCAR (XCDR (elt
)),
22979 XCDR (XCDR (elt
)), risky
);
22981 else if (SYMBOLP (car
))
22983 tem
= Fboundp (car
);
22987 /* elt is now the cdr, and we know it is a cons cell.
22988 Use its car if CAR has a non-nil value. */
22991 tem
= Fsymbol_value (car
);
22998 /* Symbol's value is nil (or symbol is unbound)
22999 Get the cddr of the original list
23000 and if possible find the caddr and use that. */
23004 else if (!CONSP (elt
))
23009 else if (INTEGERP (car
))
23011 register int lim
= XINT (car
);
23015 /* Negative int means reduce maximum width. */
23016 if (precision
<= 0)
23019 precision
= min (precision
, -lim
);
23023 /* Padding specified. Don't let it be more than
23024 current maximum. */
23026 lim
= min (precision
, lim
);
23028 /* If that's more padding than already wanted, queue it.
23029 But don't reduce padding already specified even if
23030 that is beyond the current truncation point. */
23031 field_width
= max (lim
, field_width
);
23035 else if (STRINGP (car
) || CONSP (car
))
23037 Lisp_Object halftail
= elt
;
23041 && (precision
<= 0 || n
< precision
))
23043 n
+= display_mode_element (it
, depth
,
23044 /* Do padding only after the last
23045 element in the list. */
23046 (! CONSP (XCDR (elt
))
23049 precision
- n
, XCAR (elt
),
23053 if ((len
& 1) == 0)
23054 halftail
= XCDR (halftail
);
23055 /* Check for cycle. */
23056 if (EQ (halftail
, elt
))
23065 elt
= build_string ("*invalid*");
23069 /* Pad to FIELD_WIDTH. */
23070 if (field_width
> 0 && n
< field_width
)
23072 switch (mode_line_target
)
23074 case MODE_LINE_NOPROP
:
23075 case MODE_LINE_TITLE
:
23076 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
23078 case MODE_LINE_STRING
:
23079 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
23082 case MODE_LINE_DISPLAY
:
23083 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
23092 /* Store a mode-line string element in mode_line_string_list.
23094 If STRING is non-null, display that C string. Otherwise, the Lisp
23095 string LISP_STRING is displayed.
23097 FIELD_WIDTH is the minimum number of output glyphs to produce.
23098 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23099 with spaces. FIELD_WIDTH <= 0 means don't pad.
23101 PRECISION is the maximum number of characters to output from
23102 STRING. PRECISION <= 0 means don't truncate the string.
23104 If COPY_STRING, make a copy of LISP_STRING before adding
23105 properties to the string.
23107 PROPS are the properties to add to the string.
23108 The mode_line_string_face face property is always added to the string.
23112 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
23114 int field_width
, int precision
, Lisp_Object props
)
23119 if (string
!= NULL
)
23121 len
= strlen (string
);
23122 if (precision
> 0 && len
> precision
)
23124 lisp_string
= make_string (string
, len
);
23126 props
= mode_line_string_face_prop
;
23127 else if (!NILP (mode_line_string_face
))
23129 Lisp_Object face
= Fplist_get (props
, Qface
);
23130 props
= Fcopy_sequence (props
);
23132 face
= mode_line_string_face
;
23134 face
= list2 (face
, mode_line_string_face
);
23135 props
= Fplist_put (props
, Qface
, face
);
23137 Fadd_text_properties (make_number (0), make_number (len
),
23138 props
, lisp_string
);
23142 len
= XFASTINT (Flength (lisp_string
));
23143 if (precision
> 0 && len
> precision
)
23146 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
23149 if (!NILP (mode_line_string_face
))
23153 props
= Ftext_properties_at (make_number (0), lisp_string
);
23154 face
= Fplist_get (props
, Qface
);
23156 face
= mode_line_string_face
;
23158 face
= list2 (face
, mode_line_string_face
);
23159 props
= list2 (Qface
, face
);
23161 lisp_string
= Fcopy_sequence (lisp_string
);
23164 Fadd_text_properties (make_number (0), make_number (len
),
23165 props
, lisp_string
);
23170 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
23174 if (field_width
> len
)
23176 field_width
-= len
;
23177 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
23179 Fadd_text_properties (make_number (0), make_number (field_width
),
23180 props
, lisp_string
);
23181 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
23189 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
23191 doc
: /* Format a string out of a mode line format specification.
23192 First arg FORMAT specifies the mode line format (see `mode-line-format'
23193 for details) to use.
23195 By default, the format is evaluated for the currently selected window.
23197 Optional second arg FACE specifies the face property to put on all
23198 characters for which no face is specified. The value nil means the
23199 default face. The value t means whatever face the window's mode line
23200 currently uses (either `mode-line' or `mode-line-inactive',
23201 depending on whether the window is the selected window or not).
23202 An integer value means the value string has no text
23205 Optional third and fourth args WINDOW and BUFFER specify the window
23206 and buffer to use as the context for the formatting (defaults
23207 are the selected window and the WINDOW's buffer). */)
23208 (Lisp_Object format
, Lisp_Object face
,
23209 Lisp_Object window
, Lisp_Object buffer
)
23214 struct buffer
*old_buffer
= NULL
;
23216 bool no_props
= INTEGERP (face
);
23217 ptrdiff_t count
= SPECPDL_INDEX ();
23219 int string_start
= 0;
23221 w
= decode_any_window (window
);
23222 XSETWINDOW (window
, w
);
23225 buffer
= w
->contents
;
23226 CHECK_BUFFER (buffer
);
23228 /* Make formatting the modeline a non-op when noninteractive, otherwise
23229 there will be problems later caused by a partially initialized frame. */
23230 if (NILP (format
) || noninteractive
)
23231 return empty_unibyte_string
;
23236 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
23237 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
23238 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
23239 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
23240 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
23241 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
23242 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
23245 old_buffer
= current_buffer
;
23247 /* Save things including mode_line_proptrans_alist,
23248 and set that to nil so that we don't alter the outer value. */
23249 record_unwind_protect (unwind_format_mode_line
,
23250 format_mode_line_unwind_data
23251 (XFRAME (WINDOW_FRAME (w
)),
23252 old_buffer
, selected_window
, true));
23253 mode_line_proptrans_alist
= Qnil
;
23255 Fselect_window (window
, Qt
);
23256 set_buffer_internal_1 (XBUFFER (buffer
));
23258 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
23262 mode_line_target
= MODE_LINE_NOPROP
;
23263 mode_line_string_face_prop
= Qnil
;
23264 mode_line_string_list
= Qnil
;
23265 string_start
= MODE_LINE_NOPROP_LEN (0);
23269 mode_line_target
= MODE_LINE_STRING
;
23270 mode_line_string_list
= Qnil
;
23271 mode_line_string_face
= face
;
23272 mode_line_string_face_prop
23273 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
23276 push_kboard (FRAME_KBOARD (it
.f
));
23277 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
23282 len
= MODE_LINE_NOPROP_LEN (string_start
);
23283 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
23287 mode_line_string_list
= Fnreverse (mode_line_string_list
);
23288 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
23289 empty_unibyte_string
);
23292 unbind_to (count
, Qnil
);
23296 /* Write a null-terminated, right justified decimal representation of
23297 the positive integer D to BUF using a minimal field width WIDTH. */
23300 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
23302 register char *p
= buf
;
23310 *p
++ = d
% 10 + '0';
23315 for (width
-= (int) (p
- buf
); width
> 0; --width
)
23326 /* Write a null-terminated, right justified decimal and "human
23327 readable" representation of the nonnegative integer D to BUF using
23328 a minimal field width WIDTH. D should be smaller than 999.5e24. */
23330 static const char power_letter
[] =
23344 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
23346 /* We aim to represent the nonnegative integer D as
23347 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
23348 ptrdiff_t quotient
= d
;
23350 /* -1 means: do not use TENTHS. */
23354 /* Length of QUOTIENT.TENTHS as a string. */
23360 if (quotient
>= 1000)
23362 /* Scale to the appropriate EXPONENT. */
23365 remainder
= quotient
% 1000;
23369 while (quotient
>= 1000);
23371 /* Round to nearest and decide whether to use TENTHS or not. */
23374 tenths
= remainder
/ 100;
23375 if (remainder
% 100 >= 50)
23382 if (quotient
== 10)
23390 if (remainder
>= 500)
23392 if (quotient
< 999)
23403 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23404 if (tenths
== -1 && quotient
<= 99)
23411 p
= psuffix
= buf
+ max (width
, length
);
23413 /* Print EXPONENT. */
23414 *psuffix
++ = power_letter
[exponent
];
23417 /* Print TENTHS. */
23420 *--p
= '0' + tenths
;
23424 /* Print QUOTIENT. */
23427 int digit
= quotient
% 10;
23428 *--p
= '0' + digit
;
23430 while ((quotient
/= 10) != 0);
23432 /* Print leading spaces. */
23437 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23438 If EOL_FLAG, set also a mnemonic character for end-of-line
23439 type of CODING_SYSTEM. Return updated pointer into BUF. */
23441 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23444 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23447 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23448 const unsigned char *eol_str
;
23450 /* The EOL conversion we are using. */
23451 Lisp_Object eoltype
;
23453 val
= CODING_SYSTEM_SPEC (coding_system
);
23456 if (!VECTORP (val
)) /* Not yet decided. */
23458 *buf
++ = multibyte
? '-' : ' ';
23460 eoltype
= eol_mnemonic_undecided
;
23461 /* Don't mention EOL conversion if it isn't decided. */
23466 Lisp_Object eolvalue
;
23468 attrs
= AREF (val
, 0);
23469 eolvalue
= AREF (val
, 2);
23472 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23477 /* The EOL conversion that is normal on this system. */
23479 if (NILP (eolvalue
)) /* Not yet decided. */
23480 eoltype
= eol_mnemonic_undecided
;
23481 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23482 eoltype
= eol_mnemonic_undecided
;
23483 else /* eolvalue is Qunix, Qdos, or Qmac. */
23484 eoltype
= (EQ (eolvalue
, Qunix
)
23485 ? eol_mnemonic_unix
23486 : EQ (eolvalue
, Qdos
)
23487 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23493 /* Mention the EOL conversion if it is not the usual one. */
23494 if (STRINGP (eoltype
))
23496 eol_str
= SDATA (eoltype
);
23497 eol_str_len
= SBYTES (eoltype
);
23499 else if (CHARACTERP (eoltype
))
23501 int c
= XFASTINT (eoltype
);
23502 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23506 eol_str
= invalid_eol_type
;
23507 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23509 memcpy (buf
, eol_str
, eol_str_len
);
23510 buf
+= eol_str_len
;
23516 /* Return the approximate percentage N is of D (rounding upward), or 99,
23517 whichever is less. Assume 0 < D and 0 <= N <= D * INT_MAX / 100. */
23520 percent99 (ptrdiff_t n
, ptrdiff_t d
)
23522 int percent
= (d
- 1 + 100.0 * n
) / d
;
23523 return min (percent
, 99);
23526 /* Return a string for the output of a mode line %-spec for window W,
23527 generated by character C. FIELD_WIDTH > 0 means pad the string
23528 returned with spaces to that value. Return a Lisp string in
23529 *STRING if the resulting string is taken from that Lisp string.
23531 Note we operate on the current buffer for most purposes. */
23533 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23535 static const char *
23536 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23537 Lisp_Object
*string
)
23540 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23541 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23542 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23543 produce strings from numerical values, so limit preposterously
23544 large values of FIELD_WIDTH to avoid overrunning the buffer's
23545 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23546 bytes plus the terminating null. */
23547 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23548 struct buffer
*b
= current_buffer
;
23556 if (!NILP (BVAR (b
, read_only
)))
23558 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23563 /* This differs from %* only for a modified read-only buffer. */
23564 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23566 if (!NILP (BVAR (b
, read_only
)))
23571 /* This differs from %* in ignoring read-only-ness. */
23572 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23584 if (command_loop_level
> 5)
23586 p
= decode_mode_spec_buf
;
23587 for (i
= 0; i
< command_loop_level
; i
++)
23590 return decode_mode_spec_buf
;
23598 if (command_loop_level
> 5)
23600 p
= decode_mode_spec_buf
;
23601 for (i
= 0; i
< command_loop_level
; i
++)
23604 return decode_mode_spec_buf
;
23611 /* Let lots_of_dashes be a string of infinite length. */
23612 if (mode_line_target
== MODE_LINE_NOPROP
23613 || mode_line_target
== MODE_LINE_STRING
)
23615 if (field_width
<= 0
23616 || field_width
> sizeof (lots_of_dashes
))
23618 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23619 decode_mode_spec_buf
[i
] = '-';
23620 decode_mode_spec_buf
[i
] = '\0';
23621 return decode_mode_spec_buf
;
23624 return lots_of_dashes
;
23628 obj
= BVAR (b
, name
);
23632 /* %c and %l are ignored in `frame-title-format'.
23633 (In redisplay_internal, the frame title is drawn _before_ the
23634 windows are updated, so the stuff which depends on actual
23635 window contents (such as %l) may fail to render properly, or
23636 even crash emacs.) */
23637 if (mode_line_target
== MODE_LINE_TITLE
)
23641 ptrdiff_t col
= current_column ();
23642 w
->column_number_displayed
= col
;
23643 pint2str (decode_mode_spec_buf
, width
, col
);
23644 return decode_mode_spec_buf
;
23648 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23650 if (NILP (Vmemory_full
))
23653 return "!MEM FULL! ";
23660 /* %F displays the frame name. */
23661 if (!NILP (f
->title
))
23662 return SSDATA (f
->title
);
23663 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23664 return SSDATA (f
->name
);
23668 obj
= BVAR (b
, filename
);
23673 ptrdiff_t size
= ZV
- BEGV
;
23674 pint2str (decode_mode_spec_buf
, width
, size
);
23675 return decode_mode_spec_buf
;
23680 ptrdiff_t size
= ZV
- BEGV
;
23681 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23682 return decode_mode_spec_buf
;
23687 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23688 ptrdiff_t topline
, nlines
, height
;
23691 /* %c and %l are ignored in `frame-title-format'. */
23692 if (mode_line_target
== MODE_LINE_TITLE
)
23695 startpos
= marker_position (w
->start
);
23696 startpos_byte
= marker_byte_position (w
->start
);
23697 height
= WINDOW_TOTAL_LINES (w
);
23699 /* If we decided that this buffer isn't suitable for line numbers,
23700 don't forget that too fast. */
23701 if (w
->base_line_pos
== -1)
23704 /* If the buffer is very big, don't waste time. */
23705 if (INTEGERP (Vline_number_display_limit
)
23706 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23708 w
->base_line_pos
= 0;
23709 w
->base_line_number
= 0;
23713 if (w
->base_line_number
> 0
23714 && w
->base_line_pos
> 0
23715 && w
->base_line_pos
<= startpos
)
23717 line
= w
->base_line_number
;
23718 linepos
= w
->base_line_pos
;
23719 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23724 linepos
= BUF_BEGV (b
);
23725 linepos_byte
= BUF_BEGV_BYTE (b
);
23728 /* Count lines from base line to window start position. */
23729 nlines
= display_count_lines (linepos_byte
,
23733 topline
= nlines
+ line
;
23735 /* Determine a new base line, if the old one is too close
23736 or too far away, or if we did not have one.
23737 "Too close" means it's plausible a scroll-down would
23738 go back past it. */
23739 if (startpos
== BUF_BEGV (b
))
23741 w
->base_line_number
= topline
;
23742 w
->base_line_pos
= BUF_BEGV (b
);
23744 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23745 || linepos
== BUF_BEGV (b
))
23747 ptrdiff_t limit
= BUF_BEGV (b
);
23748 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23749 ptrdiff_t position
;
23750 ptrdiff_t distance
=
23751 (height
* 2 + 30) * line_number_display_limit_width
;
23753 if (startpos
- distance
> limit
)
23755 limit
= startpos
- distance
;
23756 limit_byte
= CHAR_TO_BYTE (limit
);
23759 nlines
= display_count_lines (startpos_byte
,
23761 - (height
* 2 + 30),
23763 /* If we couldn't find the lines we wanted within
23764 line_number_display_limit_width chars per line,
23765 give up on line numbers for this window. */
23766 if (position
== limit_byte
&& limit
== startpos
- distance
)
23768 w
->base_line_pos
= -1;
23769 w
->base_line_number
= 0;
23773 w
->base_line_number
= topline
- nlines
;
23774 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23777 /* Now count lines from the start pos to point. */
23778 nlines
= display_count_lines (startpos_byte
,
23779 PT_BYTE
, PT
, &junk
);
23781 /* Record that we did display the line number. */
23782 line_number_displayed
= true;
23784 /* Make the string to show. */
23785 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23786 return decode_mode_spec_buf
;
23789 char *p
= decode_mode_spec_buf
;
23790 int pad
= width
- 2;
23796 return decode_mode_spec_buf
;
23802 obj
= BVAR (b
, mode_name
);
23806 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23812 ptrdiff_t pos
= marker_position (w
->start
);
23813 ptrdiff_t begv
= BUF_BEGV (b
);
23814 ptrdiff_t zv
= BUF_ZV (b
);
23816 if (w
->window_end_pos
<= BUF_Z (b
) - zv
)
23817 return pos
<= begv
? "All" : "Bottom";
23818 else if (pos
<= begv
)
23822 sprintf (decode_mode_spec_buf
, "%2d%%",
23823 percent99 (pos
- begv
, zv
- begv
));
23824 return decode_mode_spec_buf
;
23828 /* Display percentage of size above the bottom of the screen. */
23831 ptrdiff_t toppos
= marker_position (w
->start
);
23832 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23833 ptrdiff_t begv
= BUF_BEGV (b
);
23834 ptrdiff_t zv
= BUF_ZV (b
);
23837 return toppos
<= begv
? "All" : "Bottom";
23840 sprintf (decode_mode_spec_buf
,
23841 &"Top%2d%%"[begv
< toppos
? sizeof "Top" - 1 : 0],
23842 percent99 (botpos
- begv
, zv
- begv
));
23843 return decode_mode_spec_buf
;
23848 /* status of process */
23849 obj
= Fget_buffer_process (Fcurrent_buffer ());
23851 return "no process";
23853 obj
= Fsymbol_name (Fprocess_status (obj
));
23859 ptrdiff_t count
= inhibit_garbage_collection ();
23860 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23861 Lisp_Object val
= Qnil
;
23863 if (STRINGP (curdir
))
23864 val
= call1 (intern ("file-remote-p"), curdir
);
23866 unbind_to (count
, Qnil
);
23875 /* coding-system (not including end-of-line format) */
23877 /* coding-system (including end-of-line type) */
23879 bool eol_flag
= (c
== 'Z');
23880 char *p
= decode_mode_spec_buf
;
23882 if (! FRAME_WINDOW_P (f
))
23884 /* No need to mention EOL here--the terminal never needs
23885 to do EOL conversion. */
23886 p
= decode_mode_spec_coding (CODING_ID_NAME
23887 (FRAME_KEYBOARD_CODING (f
)->id
),
23889 p
= decode_mode_spec_coding (CODING_ID_NAME
23890 (FRAME_TERMINAL_CODING (f
)->id
),
23893 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23896 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23897 #ifdef subprocesses
23898 obj
= Fget_buffer_process (Fcurrent_buffer ());
23899 if (PROCESSP (obj
))
23901 p
= decode_mode_spec_coding
23902 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23903 p
= decode_mode_spec_coding
23904 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23906 #endif /* subprocesses */
23909 return decode_mode_spec_buf
;
23916 return SSDATA (obj
);
23923 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23924 means count lines back from START_BYTE. But don't go beyond
23925 LIMIT_BYTE. Return the number of lines thus found (always
23928 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23929 either the position COUNT lines after/before START_BYTE, if we
23930 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23934 display_count_lines (ptrdiff_t start_byte
,
23935 ptrdiff_t limit_byte
, ptrdiff_t count
,
23936 ptrdiff_t *byte_pos_ptr
)
23938 register unsigned char *cursor
;
23939 unsigned char *base
;
23941 register ptrdiff_t ceiling
;
23942 register unsigned char *ceiling_addr
;
23943 ptrdiff_t orig_count
= count
;
23945 /* If we are not in selective display mode,
23946 check only for newlines. */
23947 bool selective_display
23948 = (!NILP (BVAR (current_buffer
, selective_display
))
23949 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23953 while (start_byte
< limit_byte
)
23955 ceiling
= BUFFER_CEILING_OF (start_byte
);
23956 ceiling
= min (limit_byte
- 1, ceiling
);
23957 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23958 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23962 if (selective_display
)
23964 while (*cursor
!= '\n' && *cursor
!= 015
23965 && ++cursor
!= ceiling_addr
)
23967 if (cursor
== ceiling_addr
)
23972 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23981 start_byte
+= cursor
- base
;
23982 *byte_pos_ptr
= start_byte
;
23986 while (cursor
< ceiling_addr
);
23988 start_byte
+= ceiling_addr
- base
;
23993 while (start_byte
> limit_byte
)
23995 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23996 ceiling
= max (limit_byte
, ceiling
);
23997 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23998 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
24001 if (selective_display
)
24003 while (--cursor
>= ceiling_addr
24004 && *cursor
!= '\n' && *cursor
!= 015)
24006 if (cursor
< ceiling_addr
)
24011 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
24018 start_byte
+= cursor
- base
+ 1;
24019 *byte_pos_ptr
= start_byte
;
24020 /* When scanning backwards, we should
24021 not count the newline posterior to which we stop. */
24022 return - orig_count
- 1;
24025 start_byte
+= ceiling_addr
- base
;
24029 *byte_pos_ptr
= limit_byte
;
24032 return - orig_count
+ count
;
24033 return orig_count
- count
;
24039 /***********************************************************************
24041 ***********************************************************************/
24043 /* Display a NUL-terminated string, starting with index START.
24045 If STRING is non-null, display that C string. Otherwise, the Lisp
24046 string LISP_STRING is displayed. There's a case that STRING is
24047 non-null and LISP_STRING is not nil. It means STRING is a string
24048 data of LISP_STRING. In that case, we display LISP_STRING while
24049 ignoring its text properties.
24051 If FACE_STRING is not nil, FACE_STRING_POS is a position in
24052 FACE_STRING. Display STRING or LISP_STRING with the face at
24053 FACE_STRING_POS in FACE_STRING:
24055 Display the string in the environment given by IT, but use the
24056 standard display table, temporarily.
24058 FIELD_WIDTH is the minimum number of output glyphs to produce.
24059 If STRING has fewer characters than FIELD_WIDTH, pad to the right
24060 with spaces. If STRING has more characters, more than FIELD_WIDTH
24061 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
24063 PRECISION is the maximum number of characters to output from
24064 STRING. PRECISION < 0 means don't truncate the string.
24066 This is roughly equivalent to printf format specifiers:
24068 FIELD_WIDTH PRECISION PRINTF
24069 ----------------------------------------
24075 MULTIBYTE zero means do not display multibyte chars, > 0 means do
24076 display them, and < 0 means obey the current buffer's value of
24077 enable_multibyte_characters.
24079 Value is the number of columns displayed. */
24082 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
24083 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
24084 int field_width
, int precision
, int max_x
, int multibyte
)
24086 int hpos_at_start
= it
->hpos
;
24087 int saved_face_id
= it
->face_id
;
24088 struct glyph_row
*row
= it
->glyph_row
;
24089 ptrdiff_t it_charpos
;
24091 /* Initialize the iterator IT for iteration over STRING beginning
24092 with index START. */
24093 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
24094 precision
, field_width
, multibyte
);
24095 if (string
&& STRINGP (lisp_string
))
24096 /* LISP_STRING is the one returned by decode_mode_spec. We should
24097 ignore its text properties. */
24098 it
->stop_charpos
= it
->end_charpos
;
24100 /* If displaying STRING, set up the face of the iterator from
24101 FACE_STRING, if that's given. */
24102 if (STRINGP (face_string
))
24108 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
24109 0, &endptr
, it
->base_face_id
, false);
24110 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24111 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
24114 /* Set max_x to the maximum allowed X position. Don't let it go
24115 beyond the right edge of the window. */
24117 max_x
= it
->last_visible_x
;
24119 max_x
= min (max_x
, it
->last_visible_x
);
24121 /* Skip over display elements that are not visible. because IT->w is
24123 if (it
->current_x
< it
->first_visible_x
)
24124 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
24125 MOVE_TO_POS
| MOVE_TO_X
);
24127 row
->ascent
= it
->max_ascent
;
24128 row
->height
= it
->max_ascent
+ it
->max_descent
;
24129 row
->phys_ascent
= it
->max_phys_ascent
;
24130 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
24131 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
24133 if (STRINGP (it
->string
))
24134 it_charpos
= IT_STRING_CHARPOS (*it
);
24136 it_charpos
= IT_CHARPOS (*it
);
24138 /* This condition is for the case that we are called with current_x
24139 past last_visible_x. */
24140 while (it
->current_x
< max_x
)
24142 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
24144 /* Get the next display element. */
24145 if (!get_next_display_element (it
))
24148 /* Produce glyphs. */
24149 x_before
= it
->current_x
;
24150 n_glyphs_before
= row
->used
[TEXT_AREA
];
24151 PRODUCE_GLYPHS (it
);
24153 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
24156 while (i
< nglyphs
)
24158 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
24160 if (it
->line_wrap
!= TRUNCATE
24161 && x
+ glyph
->pixel_width
> max_x
)
24163 /* End of continued line or max_x reached. */
24164 if (CHAR_GLYPH_PADDING_P (*glyph
))
24166 /* A wide character is unbreakable. */
24167 if (row
->reversed_p
)
24168 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
24169 - n_glyphs_before
);
24170 row
->used
[TEXT_AREA
] = n_glyphs_before
;
24171 it
->current_x
= x_before
;
24175 if (row
->reversed_p
)
24176 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
24177 - (n_glyphs_before
+ i
));
24178 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
24183 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
24185 /* Glyph is at least partially visible. */
24187 if (x
< it
->first_visible_x
)
24188 row
->x
= x
- it
->first_visible_x
;
24192 /* Glyph is off the left margin of the display area.
24193 Should not happen. */
24197 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
24198 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
24199 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
24200 row
->phys_height
= max (row
->phys_height
,
24201 it
->max_phys_ascent
+ it
->max_phys_descent
);
24202 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
24203 it
->max_extra_line_spacing
);
24204 x
+= glyph
->pixel_width
;
24208 /* Stop if max_x reached. */
24212 /* Stop at line ends. */
24213 if (ITERATOR_AT_END_OF_LINE_P (it
))
24215 it
->continuation_lines_width
= 0;
24219 set_iterator_to_next (it
, true);
24220 if (STRINGP (it
->string
))
24221 it_charpos
= IT_STRING_CHARPOS (*it
);
24223 it_charpos
= IT_CHARPOS (*it
);
24225 /* Stop if truncating at the right edge. */
24226 if (it
->line_wrap
== TRUNCATE
24227 && it
->current_x
>= it
->last_visible_x
)
24229 /* Add truncation mark, but don't do it if the line is
24230 truncated at a padding space. */
24231 if (it_charpos
< it
->string_nchars
)
24233 if (!FRAME_WINDOW_P (it
->f
))
24237 if (it
->current_x
> it
->last_visible_x
)
24239 if (!row
->reversed_p
)
24241 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
24242 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24247 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
24248 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24250 unproduce_glyphs (it
, ii
+ 1);
24251 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
24253 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
24255 row
->used
[TEXT_AREA
] = ii
;
24256 produce_special_glyphs (it
, IT_TRUNCATION
);
24259 produce_special_glyphs (it
, IT_TRUNCATION
);
24261 row
->truncated_on_right_p
= true;
24267 /* Maybe insert a truncation at the left. */
24268 if (it
->first_visible_x
24271 if (!FRAME_WINDOW_P (it
->f
)
24272 || (row
->reversed_p
24273 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24274 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
24275 insert_left_trunc_glyphs (it
);
24276 row
->truncated_on_left_p
= true;
24279 it
->face_id
= saved_face_id
;
24281 /* Value is number of columns displayed. */
24282 return it
->hpos
- hpos_at_start
;
24287 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
24288 appears as an element of LIST or as the car of an element of LIST.
24289 If PROPVAL is a list, compare each element against LIST in that
24290 way, and return 1/2 if any element of PROPVAL is found in LIST.
24291 Otherwise return 0. This function cannot quit.
24292 The return value is 2 if the text is invisible but with an ellipsis
24293 and 1 if it's invisible and without an ellipsis. */
24296 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
24298 Lisp_Object tail
, proptail
;
24300 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24302 register Lisp_Object tem
;
24304 if (EQ (propval
, tem
))
24306 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
24307 return NILP (XCDR (tem
)) ? 1 : 2;
24310 if (CONSP (propval
))
24312 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
24314 Lisp_Object propelt
;
24315 propelt
= XCAR (proptail
);
24316 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24318 register Lisp_Object tem
;
24320 if (EQ (propelt
, tem
))
24322 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
24323 return NILP (XCDR (tem
)) ? 1 : 2;
24331 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
24332 doc
: /* Non-nil if the property makes the text invisible.
24333 POS-OR-PROP can be a marker or number, in which case it is taken to be
24334 a position in the current buffer and the value of the `invisible' property
24335 is checked; or it can be some other value, which is then presumed to be the
24336 value of the `invisible' property of the text of interest.
24337 The non-nil value returned can be t for truly invisible text or something
24338 else if the text is replaced by an ellipsis. */)
24339 (Lisp_Object pos_or_prop
)
24342 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
24343 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
24345 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
24346 return (invis
== 0 ? Qnil
24348 : make_number (invis
));
24351 /* Calculate a width or height in pixels from a specification using
24352 the following elements:
24355 NUM - a (fractional) multiple of the default font width/height
24356 (NUM) - specifies exactly NUM pixels
24357 UNIT - a fixed number of pixels, see below.
24358 ELEMENT - size of a display element in pixels, see below.
24359 (NUM . SPEC) - equals NUM * SPEC
24360 (+ SPEC SPEC ...) - add pixel values
24361 (- SPEC SPEC ...) - subtract pixel values
24362 (- SPEC) - negate pixel value
24365 INT or FLOAT - a number constant
24366 SYMBOL - use symbol's (buffer local) variable binding.
24369 in - pixels per inch *)
24370 mm - pixels per 1/1000 meter *)
24371 cm - pixels per 1/100 meter *)
24372 width - width of current font in pixels.
24373 height - height of current font in pixels.
24375 *) using the ratio(s) defined in display-pixels-per-inch.
24379 left-fringe - left fringe width in pixels
24380 right-fringe - right fringe width in pixels
24382 left-margin - left margin width in pixels
24383 right-margin - right margin width in pixels
24385 scroll-bar - scroll-bar area width in pixels
24389 Pixels corresponding to 5 inches:
24392 Total width of non-text areas on left side of window (if scroll-bar is on left):
24393 '(space :width (+ left-fringe left-margin scroll-bar))
24395 Align to first text column (in header line):
24396 '(space :align-to 0)
24398 Align to middle of text area minus half the width of variable `my-image'
24399 containing a loaded image:
24400 '(space :align-to (0.5 . (- text my-image)))
24402 Width of left margin minus width of 1 character in the default font:
24403 '(space :width (- left-margin 1))
24405 Width of left margin minus width of 2 characters in the current font:
24406 '(space :width (- left-margin (2 . width)))
24408 Center 1 character over left-margin (in header line):
24409 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24411 Different ways to express width of left fringe plus left margin minus one pixel:
24412 '(space :width (- (+ left-fringe left-margin) (1)))
24413 '(space :width (+ left-fringe left-margin (- (1))))
24414 '(space :width (+ left-fringe left-margin (-1)))
24419 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24420 struct font
*font
, bool width_p
, int *align_to
)
24424 # define OK_PIXELS(val) (*res = (val), true)
24425 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24428 return OK_PIXELS (0);
24430 eassert (FRAME_LIVE_P (it
->f
));
24432 if (SYMBOLP (prop
))
24434 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24436 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24438 if (unit
[0] == 'i' && unit
[1] == 'n')
24440 else if (unit
[0] == 'm' && unit
[1] == 'm')
24442 else if (unit
[0] == 'c' && unit
[1] == 'm')
24448 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24449 : FRAME_RES_Y (it
->f
));
24452 return OK_PIXELS (ppi
/ pixels
);
24457 #ifdef HAVE_WINDOW_SYSTEM
24458 if (EQ (prop
, Qheight
))
24459 return OK_PIXELS (font
24460 ? normal_char_height (font
, -1)
24461 : FRAME_LINE_HEIGHT (it
->f
));
24462 if (EQ (prop
, Qwidth
))
24463 return OK_PIXELS (font
24464 ? FONT_WIDTH (font
)
24465 : FRAME_COLUMN_WIDTH (it
->f
));
24467 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24468 return OK_PIXELS (1);
24471 if (EQ (prop
, Qtext
))
24472 return OK_PIXELS (width_p
24473 ? window_box_width (it
->w
, TEXT_AREA
)
24474 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24476 if (align_to
&& *align_to
< 0)
24479 if (EQ (prop
, Qleft
))
24480 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24481 if (EQ (prop
, Qright
))
24482 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24483 if (EQ (prop
, Qcenter
))
24484 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24485 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24486 if (EQ (prop
, Qleft_fringe
))
24487 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24488 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24489 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24490 if (EQ (prop
, Qright_fringe
))
24491 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24492 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24493 : window_box_right_offset (it
->w
, TEXT_AREA
));
24494 if (EQ (prop
, Qleft_margin
))
24495 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24496 if (EQ (prop
, Qright_margin
))
24497 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24498 if (EQ (prop
, Qscroll_bar
))
24499 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24501 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24502 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24503 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24508 if (EQ (prop
, Qleft_fringe
))
24509 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24510 if (EQ (prop
, Qright_fringe
))
24511 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24512 if (EQ (prop
, Qleft_margin
))
24513 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24514 if (EQ (prop
, Qright_margin
))
24515 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24516 if (EQ (prop
, Qscroll_bar
))
24517 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24520 prop
= buffer_local_value (prop
, it
->w
->contents
);
24521 if (EQ (prop
, Qunbound
))
24525 if (NUMBERP (prop
))
24527 int base_unit
= (width_p
24528 ? FRAME_COLUMN_WIDTH (it
->f
)
24529 : FRAME_LINE_HEIGHT (it
->f
));
24530 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24535 Lisp_Object car
= XCAR (prop
);
24536 Lisp_Object cdr
= XCDR (prop
);
24540 #ifdef HAVE_WINDOW_SYSTEM
24541 if (FRAME_WINDOW_P (it
->f
)
24542 && valid_image_p (prop
))
24544 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24545 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24547 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24549 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24551 /* TODO: Don't return dummy size. */
24552 return OK_PIXELS (100);
24555 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24561 while (CONSP (cdr
))
24563 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24564 font
, width_p
, align_to
))
24567 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24572 if (EQ (car
, Qminus
))
24574 return OK_PIXELS (pixels
);
24577 car
= buffer_local_value (car
, it
->w
->contents
);
24578 if (EQ (car
, Qunbound
))
24585 pixels
= XFLOATINT (car
);
24587 return OK_PIXELS (pixels
);
24588 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24589 font
, width_p
, align_to
))
24590 return OK_PIXELS (pixels
* fact
);
24601 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24603 #ifdef HAVE_WINDOW_SYSTEM
24604 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24612 /***********************************************************************
24614 ***********************************************************************/
24616 #ifdef HAVE_WINDOW_SYSTEM
24621 dump_glyph_string (struct glyph_string
*s
)
24623 fprintf (stderr
, "glyph string\n");
24624 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24625 s
->x
, s
->y
, s
->width
, s
->height
);
24626 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24627 fprintf (stderr
, " hl = %d\n", s
->hl
);
24628 fprintf (stderr
, " left overhang = %d, right = %d\n",
24629 s
->left_overhang
, s
->right_overhang
);
24630 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24631 fprintf (stderr
, " extends to end of line = %d\n",
24632 s
->extends_to_end_of_line_p
);
24633 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24634 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24637 #endif /* GLYPH_DEBUG */
24639 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24640 of XChar2b structures for S; it can't be allocated in
24641 init_glyph_string because it must be allocated via `alloca'. W
24642 is the window on which S is drawn. ROW and AREA are the glyph row
24643 and area within the row from which S is constructed. START is the
24644 index of the first glyph structure covered by S. HL is a
24645 face-override for drawing S. */
24648 #define OPTIONAL_HDC(hdc) HDC hdc,
24649 #define DECLARE_HDC(hdc) HDC hdc;
24650 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24651 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24654 #ifndef OPTIONAL_HDC
24655 #define OPTIONAL_HDC(hdc)
24656 #define DECLARE_HDC(hdc)
24657 #define ALLOCATE_HDC(hdc, f)
24658 #define RELEASE_HDC(hdc, f)
24662 init_glyph_string (struct glyph_string
*s
,
24664 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24665 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24667 memset (s
, 0, sizeof *s
);
24669 s
->f
= XFRAME (w
->frame
);
24673 s
->display
= FRAME_X_DISPLAY (s
->f
);
24674 s
->char2b
= char2b
;
24678 s
->first_glyph
= row
->glyphs
[area
] + start
;
24679 s
->height
= row
->height
;
24680 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24681 s
->ybase
= s
->y
+ row
->ascent
;
24685 /* Append the list of glyph strings with head H and tail T to the list
24686 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24689 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24690 struct glyph_string
*h
, struct glyph_string
*t
)
24704 /* Prepend the list of glyph strings with head H and tail T to the
24705 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24709 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24710 struct glyph_string
*h
, struct glyph_string
*t
)
24724 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24725 Set *HEAD and *TAIL to the resulting list. */
24728 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24729 struct glyph_string
*s
)
24731 s
->next
= s
->prev
= NULL
;
24732 append_glyph_string_lists (head
, tail
, s
, s
);
24736 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24737 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24738 make sure that X resources for the face returned are allocated.
24739 Value is a pointer to a realized face that is ready for display if
24742 static struct face
*
24743 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24744 XChar2b
*char2b
, bool display_p
)
24746 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24751 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24753 if (code
== FONT_INVALID_CODE
)
24756 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24758 /* Make sure X resources of the face are allocated. */
24759 #ifdef HAVE_X_WINDOWS
24763 eassert (face
!= NULL
);
24764 prepare_face_for_display (f
, face
);
24771 /* Get face and two-byte form of character glyph GLYPH on frame F.
24772 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24773 a pointer to a realized face that is ready for display. */
24775 static struct face
*
24776 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24782 eassert (glyph
->type
== CHAR_GLYPH
);
24783 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24785 /* Make sure X resources of the face are allocated. */
24786 prepare_face_for_display (f
, face
);
24790 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24791 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24793 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24795 if (code
== FONT_INVALID_CODE
)
24799 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24804 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24805 Return true iff FONT has a glyph for C. */
24808 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24812 if (CHAR_BYTE8_P (c
))
24813 code
= CHAR_TO_BYTE8 (c
);
24815 code
= font
->driver
->encode_char (font
, c
);
24817 if (code
== FONT_INVALID_CODE
)
24819 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24824 /* Fill glyph string S with composition components specified by S->cmp.
24826 BASE_FACE is the base face of the composition.
24827 S->cmp_from is the index of the first component for S.
24829 OVERLAPS non-zero means S should draw the foreground only, and use
24830 its physical height for clipping. See also draw_glyphs.
24832 Value is the index of a component not in S. */
24835 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24839 /* For all glyphs of this composition, starting at the offset
24840 S->cmp_from, until we reach the end of the definition or encounter a
24841 glyph that requires the different face, add it to S. */
24846 s
->for_overlaps
= overlaps
;
24849 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24851 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24853 /* TAB in a composition means display glyphs with padding space
24854 on the left or right. */
24857 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24860 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24861 s
->char2b
+ i
, true);
24867 s
->font
= s
->face
->font
;
24869 else if (s
->face
!= face
)
24877 if (s
->face
== NULL
)
24879 s
->face
= base_face
->ascii_face
;
24880 s
->font
= s
->face
->font
;
24883 /* All glyph strings for the same composition has the same width,
24884 i.e. the width set for the first component of the composition. */
24885 s
->width
= s
->first_glyph
->pixel_width
;
24887 /* If the specified font could not be loaded, use the frame's
24888 default font, but record the fact that we couldn't load it in
24889 the glyph string so that we can draw rectangles for the
24890 characters of the glyph string. */
24891 if (s
->font
== NULL
)
24893 s
->font_not_found_p
= true;
24894 s
->font
= FRAME_FONT (s
->f
);
24897 /* Adjust base line for subscript/superscript text. */
24898 s
->ybase
+= s
->first_glyph
->voffset
;
24904 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24905 int start
, int end
, int overlaps
)
24907 struct glyph
*glyph
, *last
;
24908 Lisp_Object lgstring
;
24911 s
->for_overlaps
= overlaps
;
24912 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24913 last
= s
->row
->glyphs
[s
->area
] + end
;
24914 s
->cmp_id
= glyph
->u
.cmp
.id
;
24915 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24916 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24917 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24918 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24919 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24921 while (glyph
< last
24922 && glyph
->u
.cmp
.automatic
24923 && glyph
->u
.cmp
.id
== s
->cmp_id
24924 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24925 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24927 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24929 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24930 unsigned code
= LGLYPH_CODE (lglyph
);
24932 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24934 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24935 return glyph
- s
->row
->glyphs
[s
->area
];
24939 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24940 See the comment of fill_glyph_string for arguments.
24941 Value is the index of the first glyph not in S. */
24945 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24946 int start
, int end
, int overlaps
)
24948 struct glyph
*glyph
, *last
;
24951 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24952 s
->for_overlaps
= overlaps
;
24953 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24954 last
= s
->row
->glyphs
[s
->area
] + end
;
24955 voffset
= glyph
->voffset
;
24956 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24957 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24959 s
->width
= glyph
->pixel_width
;
24961 while (glyph
< last
24962 && glyph
->type
== GLYPHLESS_GLYPH
24963 && glyph
->voffset
== voffset
24964 && glyph
->face_id
== face_id
)
24967 s
->width
+= glyph
->pixel_width
;
24970 s
->ybase
+= voffset
;
24971 return glyph
- s
->row
->glyphs
[s
->area
];
24975 /* Fill glyph string S from a sequence of character glyphs.
24977 FACE_ID is the face id of the string. START is the index of the
24978 first glyph to consider, END is the index of the last + 1.
24979 OVERLAPS non-zero means S should draw the foreground only, and use
24980 its physical height for clipping. See also draw_glyphs.
24982 Value is the index of the first glyph not in S. */
24985 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24986 int start
, int end
, int overlaps
)
24988 struct glyph
*glyph
, *last
;
24990 bool glyph_not_available_p
;
24992 eassert (s
->f
== XFRAME (s
->w
->frame
));
24993 eassert (s
->nchars
== 0);
24994 eassert (start
>= 0 && end
> start
);
24996 s
->for_overlaps
= overlaps
;
24997 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24998 last
= s
->row
->glyphs
[s
->area
] + end
;
24999 voffset
= glyph
->voffset
;
25000 s
->padding_p
= glyph
->padding_p
;
25001 glyph_not_available_p
= glyph
->glyph_not_available_p
;
25003 while (glyph
< last
25004 && glyph
->type
== CHAR_GLYPH
25005 && glyph
->voffset
== voffset
25006 /* Same face id implies same font, nowadays. */
25007 && glyph
->face_id
== face_id
25008 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
25010 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
25011 s
->char2b
+ s
->nchars
);
25013 eassert (s
->nchars
<= end
- start
);
25014 s
->width
+= glyph
->pixel_width
;
25015 if (glyph
++->padding_p
!= s
->padding_p
)
25019 s
->font
= s
->face
->font
;
25021 /* If the specified font could not be loaded, use the frame's font,
25022 but record the fact that we couldn't load it in
25023 S->font_not_found_p so that we can draw rectangles for the
25024 characters of the glyph string. */
25025 if (s
->font
== NULL
|| glyph_not_available_p
)
25027 s
->font_not_found_p
= true;
25028 s
->font
= FRAME_FONT (s
->f
);
25031 /* Adjust base line for subscript/superscript text. */
25032 s
->ybase
+= voffset
;
25034 eassert (s
->face
&& s
->face
->gc
);
25035 return glyph
- s
->row
->glyphs
[s
->area
];
25039 /* Fill glyph string S from image glyph S->first_glyph. */
25042 fill_image_glyph_string (struct glyph_string
*s
)
25044 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
25045 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
25047 s
->slice
= s
->first_glyph
->slice
.img
;
25048 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
25049 s
->font
= s
->face
->font
;
25050 s
->width
= s
->first_glyph
->pixel_width
;
25052 /* Adjust base line for subscript/superscript text. */
25053 s
->ybase
+= s
->first_glyph
->voffset
;
25057 #ifdef HAVE_XWIDGETS
25059 fill_xwidget_glyph_string (struct glyph_string
*s
)
25061 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
25062 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
25063 s
->font
= s
->face
->font
;
25064 s
->width
= s
->first_glyph
->pixel_width
;
25065 s
->ybase
+= s
->first_glyph
->voffset
;
25066 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
25069 /* Fill glyph string S from a sequence of stretch glyphs.
25071 START is the index of the first glyph to consider,
25072 END is the index of the last + 1.
25074 Value is the index of the first glyph not in S. */
25077 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
25079 struct glyph
*glyph
, *last
;
25080 int voffset
, face_id
;
25082 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
25084 glyph
= s
->row
->glyphs
[s
->area
] + start
;
25085 last
= s
->row
->glyphs
[s
->area
] + end
;
25086 face_id
= glyph
->face_id
;
25087 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
25088 s
->font
= s
->face
->font
;
25089 s
->width
= glyph
->pixel_width
;
25091 voffset
= glyph
->voffset
;
25095 && glyph
->type
== STRETCH_GLYPH
25096 && glyph
->voffset
== voffset
25097 && glyph
->face_id
== face_id
);
25099 s
->width
+= glyph
->pixel_width
;
25101 /* Adjust base line for subscript/superscript text. */
25102 s
->ybase
+= voffset
;
25104 /* The case that face->gc == 0 is handled when drawing the glyph
25105 string by calling prepare_face_for_display. */
25107 return glyph
- s
->row
->glyphs
[s
->area
];
25110 static struct font_metrics
*
25111 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
25113 static struct font_metrics metrics
;
25118 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
25119 if (code
== FONT_INVALID_CODE
)
25121 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
25125 /* A subroutine that computes "normal" values of ASCENT and DESCENT
25126 for FONT. Values are taken from font-global ones, except for fonts
25127 that claim preposterously large values, but whose glyphs actually
25128 have reasonable dimensions. C is the character to use for metrics
25129 if the font-global values are too large; if C is negative, the
25130 function selects a default character. */
25132 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
25134 *ascent
= FONT_BASE (font
);
25135 *descent
= FONT_DESCENT (font
);
25137 if (FONT_TOO_HIGH (font
))
25141 /* Get metrics of C, defaulting to a reasonably sized ASCII
25143 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
25145 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
25147 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
25149 /* We add 1 pixel to character dimensions as heuristics
25150 that produces nicer display, e.g. when the face has
25151 the box attribute. */
25152 *ascent
= pcm
->ascent
+ 1;
25153 *descent
= pcm
->descent
+ 1;
25159 /* A subroutine that computes a reasonable "normal character height"
25160 for fonts that claim preposterously large vertical dimensions, but
25161 whose glyphs are actually reasonably sized. C is the character
25162 whose metrics to use for those fonts, or -1 for default
25165 normal_char_height (struct font
*font
, int c
)
25167 int ascent
, descent
;
25169 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
25171 return ascent
+ descent
;
25175 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
25176 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
25177 assumed to be zero. */
25180 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
25182 *left
= *right
= 0;
25184 if (glyph
->type
== CHAR_GLYPH
)
25187 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
25190 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
25193 if (pcm
->rbearing
> pcm
->width
)
25194 *right
= pcm
->rbearing
- pcm
->width
;
25195 if (pcm
->lbearing
< 0)
25196 *left
= -pcm
->lbearing
;
25200 else if (glyph
->type
== COMPOSITE_GLYPH
)
25202 if (! glyph
->u
.cmp
.automatic
)
25204 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
25206 if (cmp
->rbearing
> cmp
->pixel_width
)
25207 *right
= cmp
->rbearing
- cmp
->pixel_width
;
25208 if (cmp
->lbearing
< 0)
25209 *left
= - cmp
->lbearing
;
25213 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
25214 struct font_metrics metrics
;
25216 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
25217 glyph
->slice
.cmp
.to
+ 1, &metrics
);
25218 if (metrics
.rbearing
> metrics
.width
)
25219 *right
= metrics
.rbearing
- metrics
.width
;
25220 if (metrics
.lbearing
< 0)
25221 *left
= - metrics
.lbearing
;
25227 /* Return the index of the first glyph preceding glyph string S that
25228 is overwritten by S because of S's left overhang. Value is -1
25229 if no glyphs are overwritten. */
25232 left_overwritten (struct glyph_string
*s
)
25236 if (s
->left_overhang
)
25239 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25240 int first
= s
->first_glyph
- glyphs
;
25242 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
25243 x
-= glyphs
[i
].pixel_width
;
25254 /* Return the index of the first glyph preceding glyph string S that
25255 is overwriting S because of its right overhang. Value is -1 if no
25256 glyph in front of S overwrites S. */
25259 left_overwriting (struct glyph_string
*s
)
25262 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25263 int first
= s
->first_glyph
- glyphs
;
25267 for (i
= first
- 1; i
>= 0; --i
)
25270 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25273 x
-= glyphs
[i
].pixel_width
;
25280 /* Return the index of the last glyph following glyph string S that is
25281 overwritten by S because of S's right overhang. Value is -1 if
25282 no such glyph is found. */
25285 right_overwritten (struct glyph_string
*s
)
25289 if (s
->right_overhang
)
25292 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25293 int first
= (s
->first_glyph
- glyphs
25294 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25295 int end
= s
->row
->used
[s
->area
];
25297 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
25298 x
+= glyphs
[i
].pixel_width
;
25307 /* Return the index of the last glyph following glyph string S that
25308 overwrites S because of its left overhang. Value is negative
25309 if no such glyph is found. */
25312 right_overwriting (struct glyph_string
*s
)
25315 int end
= s
->row
->used
[s
->area
];
25316 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25317 int first
= (s
->first_glyph
- glyphs
25318 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25322 for (i
= first
; i
< end
; ++i
)
25325 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25328 x
+= glyphs
[i
].pixel_width
;
25335 /* Set background width of glyph string S. START is the index of the
25336 first glyph following S. LAST_X is the right-most x-position + 1
25337 in the drawing area. */
25340 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
25342 /* If the face of this glyph string has to be drawn to the end of
25343 the drawing area, set S->extends_to_end_of_line_p. */
25345 if (start
== s
->row
->used
[s
->area
]
25346 && ((s
->row
->fill_line_p
25347 && (s
->hl
== DRAW_NORMAL_TEXT
25348 || s
->hl
== DRAW_IMAGE_RAISED
25349 || s
->hl
== DRAW_IMAGE_SUNKEN
))
25350 || s
->hl
== DRAW_MOUSE_FACE
))
25351 s
->extends_to_end_of_line_p
= true;
25353 /* If S extends its face to the end of the line, set its
25354 background_width to the distance to the right edge of the drawing
25356 if (s
->extends_to_end_of_line_p
)
25357 s
->background_width
= last_x
- s
->x
+ 1;
25359 s
->background_width
= s
->width
;
25363 /* Compute overhangs and x-positions for glyph string S and its
25364 predecessors, or successors. X is the starting x-position for S.
25365 BACKWARD_P means process predecessors. */
25368 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
25374 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25375 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25385 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25386 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25396 /* The following macros are only called from draw_glyphs below.
25397 They reference the following parameters of that function directly:
25398 `w', `row', `area', and `overlap_p'
25399 as well as the following local variables:
25400 `s', `f', and `hdc' (in W32) */
25403 /* On W32, silently add local `hdc' variable to argument list of
25404 init_glyph_string. */
25405 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25406 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25408 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25409 init_glyph_string (s, char2b, w, row, area, start, hl)
25412 /* Add a glyph string for a stretch glyph to the list of strings
25413 between HEAD and TAIL. START is the index of the stretch glyph in
25414 row area AREA of glyph row ROW. END is the index of the last glyph
25415 in that glyph row area. X is the current output position assigned
25416 to the new glyph string constructed. HL overrides that face of the
25417 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25418 is the right-most x-position of the drawing area. */
25420 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25421 and below -- keep them on one line. */
25422 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25425 s = alloca (sizeof *s); \
25426 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25427 START = fill_stretch_glyph_string (s, START, END); \
25428 append_glyph_string (&HEAD, &TAIL, s); \
25434 /* Add a glyph string for an image glyph to the list of strings
25435 between HEAD and TAIL. START is the index of the image glyph in
25436 row area AREA of glyph row ROW. END is the index of the last glyph
25437 in that glyph row area. X is the current output position assigned
25438 to the new glyph string constructed. HL overrides that face of the
25439 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25440 is the right-most x-position of the drawing area. */
25442 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25445 s = alloca (sizeof *s); \
25446 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25447 fill_image_glyph_string (s); \
25448 append_glyph_string (&HEAD, &TAIL, s); \
25454 #ifndef HAVE_XWIDGETS
25455 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25458 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25461 s = alloca (sizeof *s); \
25462 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25463 fill_xwidget_glyph_string (s); \
25464 append_glyph_string (&(HEAD), &(TAIL), s); \
25471 /* Add a glyph string for a sequence of character glyphs to the list
25472 of strings between HEAD and TAIL. START is the index of the first
25473 glyph in row area AREA of glyph row ROW that is part of the new
25474 glyph string. END is the index of the last glyph in that glyph row
25475 area. X is the current output position assigned to the new glyph
25476 string constructed. HL overrides that face of the glyph; e.g. it
25477 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25478 right-most x-position of the drawing area. */
25480 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25486 face_id = (row)->glyphs[area][START].face_id; \
25488 s = alloca (sizeof *s); \
25489 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25490 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25491 append_glyph_string (&HEAD, &TAIL, s); \
25493 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25498 /* Add a glyph string for a composite sequence to the list of strings
25499 between HEAD and TAIL. START is the index of the first glyph in
25500 row area AREA of glyph row ROW that is part of the new glyph
25501 string. END is the index of the last glyph in that glyph row area.
25502 X is the current output position assigned to the new glyph string
25503 constructed. HL overrides that face of the glyph; e.g. it is
25504 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25505 x-position of the drawing area. */
25507 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25509 int face_id = (row)->glyphs[area][START].face_id; \
25510 struct face *base_face = FACE_FROM_ID (f, face_id); \
25511 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25512 struct composition *cmp = composition_table[cmp_id]; \
25514 struct glyph_string *first_s = NULL; \
25517 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25519 /* Make glyph_strings for each glyph sequence that is drawable by \
25520 the same face, and append them to HEAD/TAIL. */ \
25521 for (n = 0; n < cmp->glyph_len;) \
25523 s = alloca (sizeof *s); \
25524 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25525 append_glyph_string (&(HEAD), &(TAIL), s); \
25531 n = fill_composite_glyph_string (s, base_face, overlaps); \
25539 /* Add a glyph string for a glyph-string sequence to the list of strings
25540 between HEAD and TAIL. */
25542 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25546 Lisp_Object gstring; \
25548 face_id = (row)->glyphs[area][START].face_id; \
25549 gstring = (composition_gstring_from_id \
25550 ((row)->glyphs[area][START].u.cmp.id)); \
25551 s = alloca (sizeof *s); \
25552 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25553 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25554 append_glyph_string (&(HEAD), &(TAIL), s); \
25556 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25560 /* Add a glyph string for a sequence of glyphless character's glyphs
25561 to the list of strings between HEAD and TAIL. The meanings of
25562 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25564 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25569 face_id = (row)->glyphs[area][START].face_id; \
25571 s = alloca (sizeof *s); \
25572 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25573 append_glyph_string (&HEAD, &TAIL, s); \
25575 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25581 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25582 of AREA of glyph row ROW on window W between indices START and END.
25583 HL overrides the face for drawing glyph strings, e.g. it is
25584 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25585 x-positions of the drawing area.
25587 This is an ugly monster macro construct because we must use alloca
25588 to allocate glyph strings (because draw_glyphs can be called
25589 asynchronously). */
25591 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25594 HEAD = TAIL = NULL; \
25595 while (START < END) \
25597 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25598 switch (first_glyph->type) \
25601 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25605 case COMPOSITE_GLYPH: \
25606 if (first_glyph->u.cmp.automatic) \
25607 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25610 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25614 case STRETCH_GLYPH: \
25615 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25619 case IMAGE_GLYPH: \
25620 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25624 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25625 case XWIDGET_GLYPH: \
25626 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25630 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25631 case GLYPHLESS_GLYPH: \
25632 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25642 set_glyph_string_background_width (s, START, LAST_X); \
25649 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25650 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25651 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25652 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25655 /* Draw glyphs between START and END in AREA of ROW on window W,
25656 starting at x-position X. X is relative to AREA in W. HL is a
25657 face-override with the following meaning:
25659 DRAW_NORMAL_TEXT draw normally
25660 DRAW_CURSOR draw in cursor face
25661 DRAW_MOUSE_FACE draw in mouse face.
25662 DRAW_INVERSE_VIDEO draw in mode line face
25663 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25664 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25666 If OVERLAPS is non-zero, draw only the foreground of characters and
25667 clip to the physical height of ROW. Non-zero value also defines
25668 the overlapping part to be drawn:
25670 OVERLAPS_PRED overlap with preceding rows
25671 OVERLAPS_SUCC overlap with succeeding rows
25672 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25673 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25675 Value is the x-position reached, relative to AREA of W. */
25678 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25679 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25680 enum draw_glyphs_face hl
, int overlaps
)
25682 struct glyph_string
*head
, *tail
;
25683 struct glyph_string
*s
;
25684 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25685 int i
, j
, x_reached
, last_x
, area_left
= 0;
25686 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25689 ALLOCATE_HDC (hdc
, f
);
25691 /* Let's rather be paranoid than getting a SEGV. */
25692 end
= min (end
, row
->used
[area
]);
25693 start
= clip_to_bounds (0, start
, end
);
25695 /* Translate X to frame coordinates. Set last_x to the right
25696 end of the drawing area. */
25697 if (row
->full_width_p
)
25699 /* X is relative to the left edge of W, without scroll bars
25701 area_left
= WINDOW_LEFT_EDGE_X (w
);
25702 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25703 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25707 area_left
= window_box_left (w
, area
);
25708 last_x
= area_left
+ window_box_width (w
, area
);
25712 /* Build a doubly-linked list of glyph_string structures between
25713 head and tail from what we have to draw. Note that the macro
25714 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25715 the reason we use a separate variable `i'. */
25718 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25720 x_reached
= tail
->x
+ tail
->background_width
;
25724 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25725 the row, redraw some glyphs in front or following the glyph
25726 strings built above. */
25727 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25729 struct glyph_string
*h
, *t
;
25730 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25731 int mouse_beg_col UNINIT
, mouse_end_col UNINIT
;
25732 bool check_mouse_face
= false;
25735 /* If mouse highlighting is on, we may need to draw adjacent
25736 glyphs using mouse-face highlighting. */
25737 if (area
== TEXT_AREA
&& row
->mouse_face_p
25738 && hlinfo
->mouse_face_beg_row
>= 0
25739 && hlinfo
->mouse_face_end_row
>= 0)
25741 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25743 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25744 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25746 check_mouse_face
= true;
25747 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25748 ? hlinfo
->mouse_face_beg_col
: 0;
25749 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25750 ? hlinfo
->mouse_face_end_col
25751 : row
->used
[TEXT_AREA
];
25755 /* Compute overhangs for all glyph strings. */
25756 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25757 for (s
= head
; s
; s
= s
->next
)
25758 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25760 /* Prepend glyph strings for glyphs in front of the first glyph
25761 string that are overwritten because of the first glyph
25762 string's left overhang. The background of all strings
25763 prepended must be drawn because the first glyph string
25765 i
= left_overwritten (head
);
25768 enum draw_glyphs_face overlap_hl
;
25770 /* If this row contains mouse highlighting, attempt to draw
25771 the overlapped glyphs with the correct highlight. This
25772 code fails if the overlap encompasses more than one glyph
25773 and mouse-highlight spans only some of these glyphs.
25774 However, making it work perfectly involves a lot more
25775 code, and I don't know if the pathological case occurs in
25776 practice, so we'll stick to this for now. --- cyd */
25777 if (check_mouse_face
25778 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25779 overlap_hl
= DRAW_MOUSE_FACE
;
25781 overlap_hl
= DRAW_NORMAL_TEXT
;
25783 if (hl
!= overlap_hl
)
25786 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25787 overlap_hl
, dummy_x
, last_x
);
25789 compute_overhangs_and_x (t
, head
->x
, true);
25790 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25791 if (clip_head
== NULL
)
25795 /* Prepend glyph strings for glyphs in front of the first glyph
25796 string that overwrite that glyph string because of their
25797 right overhang. For these strings, only the foreground must
25798 be drawn, because it draws over the glyph string at `head'.
25799 The background must not be drawn because this would overwrite
25800 right overhangs of preceding glyphs for which no glyph
25802 i
= left_overwriting (head
);
25805 enum draw_glyphs_face overlap_hl
;
25807 if (check_mouse_face
25808 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25809 overlap_hl
= DRAW_MOUSE_FACE
;
25811 overlap_hl
= DRAW_NORMAL_TEXT
;
25813 if (hl
== overlap_hl
|| clip_head
== NULL
)
25815 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25816 overlap_hl
, dummy_x
, last_x
);
25817 for (s
= h
; s
; s
= s
->next
)
25818 s
->background_filled_p
= true;
25819 compute_overhangs_and_x (t
, head
->x
, true);
25820 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25823 /* Append glyphs strings for glyphs following the last glyph
25824 string tail that are overwritten by tail. The background of
25825 these strings has to be drawn because tail's foreground draws
25827 i
= right_overwritten (tail
);
25830 enum draw_glyphs_face overlap_hl
;
25832 if (check_mouse_face
25833 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25834 overlap_hl
= DRAW_MOUSE_FACE
;
25836 overlap_hl
= DRAW_NORMAL_TEXT
;
25838 if (hl
!= overlap_hl
)
25840 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25841 overlap_hl
, x
, last_x
);
25842 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25843 we don't have `end = i;' here. */
25844 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25845 append_glyph_string_lists (&head
, &tail
, h
, t
);
25846 if (clip_tail
== NULL
)
25850 /* Append glyph strings for glyphs following the last glyph
25851 string tail that overwrite tail. The foreground of such
25852 glyphs has to be drawn because it writes into the background
25853 of tail. The background must not be drawn because it could
25854 paint over the foreground of following glyphs. */
25855 i
= right_overwriting (tail
);
25858 enum draw_glyphs_face overlap_hl
;
25859 if (check_mouse_face
25860 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25861 overlap_hl
= DRAW_MOUSE_FACE
;
25863 overlap_hl
= DRAW_NORMAL_TEXT
;
25865 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25867 i
++; /* We must include the Ith glyph. */
25868 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25869 overlap_hl
, x
, last_x
);
25870 for (s
= h
; s
; s
= s
->next
)
25871 s
->background_filled_p
= true;
25872 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25873 append_glyph_string_lists (&head
, &tail
, h
, t
);
25875 if (clip_head
|| clip_tail
)
25876 for (s
= head
; s
; s
= s
->next
)
25878 s
->clip_head
= clip_head
;
25879 s
->clip_tail
= clip_tail
;
25883 /* Draw all strings. */
25884 for (s
= head
; s
; s
= s
->next
)
25885 FRAME_RIF (f
)->draw_glyph_string (s
);
25888 /* When focus a sole frame and move horizontally, this clears on_p
25889 causing a failure to erase prev cursor position. */
25890 if (area
== TEXT_AREA
25891 && !row
->full_width_p
25892 /* When drawing overlapping rows, only the glyph strings'
25893 foreground is drawn, which doesn't erase a cursor
25897 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25898 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25899 : (tail
? tail
->x
+ tail
->background_width
: x
));
25903 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25904 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25908 /* Value is the x-position up to which drawn, relative to AREA of W.
25909 This doesn't include parts drawn because of overhangs. */
25910 if (row
->full_width_p
)
25911 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25913 x_reached
-= area_left
;
25915 RELEASE_HDC (hdc
, f
);
25921 /* Expand row matrix if too narrow. Don't expand if area
25924 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25926 if (!it->f->fonts_changed \
25927 && (it->glyph_row->glyphs[area] \
25928 < it->glyph_row->glyphs[area + 1])) \
25930 it->w->ncols_scale_factor++; \
25931 it->f->fonts_changed = true; \
25935 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25936 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25939 append_glyph (struct it
*it
)
25941 struct glyph
*glyph
;
25942 enum glyph_row_area area
= it
->area
;
25944 eassert (it
->glyph_row
);
25945 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25947 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25948 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25950 /* If the glyph row is reversed, we need to prepend the glyph
25951 rather than append it. */
25952 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25956 /* Make room for the additional glyph. */
25957 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25959 glyph
= it
->glyph_row
->glyphs
[area
];
25961 glyph
->charpos
= CHARPOS (it
->position
);
25962 glyph
->object
= it
->object
;
25963 if (it
->pixel_width
> 0)
25965 eassert (it
->pixel_width
<= SHRT_MAX
);
25966 glyph
->pixel_width
= it
->pixel_width
;
25967 glyph
->padding_p
= false;
25971 /* Assure at least 1-pixel width. Otherwise, cursor can't
25972 be displayed correctly. */
25973 glyph
->pixel_width
= 1;
25974 glyph
->padding_p
= true;
25976 glyph
->ascent
= it
->ascent
;
25977 glyph
->descent
= it
->descent
;
25978 glyph
->voffset
= it
->voffset
;
25979 glyph
->type
= CHAR_GLYPH
;
25980 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25981 glyph
->multibyte_p
= it
->multibyte_p
;
25982 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25984 /* In R2L rows, the left and the right box edges need to be
25985 drawn in reverse direction. */
25986 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25987 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25991 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25992 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25994 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25995 || it
->phys_descent
> it
->descent
);
25996 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25997 glyph
->face_id
= it
->face_id
;
25998 glyph
->u
.ch
= it
->char_to_display
;
25999 glyph
->slice
.img
= null_glyph_slice
;
26000 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26003 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26004 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26005 glyph
->bidi_type
= it
->bidi_it
.type
;
26009 glyph
->resolved_level
= 0;
26010 glyph
->bidi_type
= UNKNOWN_BT
;
26012 ++it
->glyph_row
->used
[area
];
26015 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26018 /* Store one glyph for the composition IT->cmp_it.id in
26019 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
26023 append_composite_glyph (struct it
*it
)
26025 struct glyph
*glyph
;
26026 enum glyph_row_area area
= it
->area
;
26028 eassert (it
->glyph_row
);
26030 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26031 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26033 /* If the glyph row is reversed, we need to prepend the glyph
26034 rather than append it. */
26035 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
26039 /* Make room for the new glyph. */
26040 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26042 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26044 glyph
->charpos
= it
->cmp_it
.charpos
;
26045 glyph
->object
= it
->object
;
26046 eassert (it
->pixel_width
<= SHRT_MAX
);
26047 glyph
->pixel_width
= it
->pixel_width
;
26048 glyph
->ascent
= it
->ascent
;
26049 glyph
->descent
= it
->descent
;
26050 glyph
->voffset
= it
->voffset
;
26051 glyph
->type
= COMPOSITE_GLYPH
;
26052 if (it
->cmp_it
.ch
< 0)
26054 glyph
->u
.cmp
.automatic
= false;
26055 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
26056 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
26060 glyph
->u
.cmp
.automatic
= true;
26061 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
26062 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
26063 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
26065 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26066 glyph
->multibyte_p
= it
->multibyte_p
;
26067 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26069 /* In R2L rows, the left and the right box edges need to be
26070 drawn in reverse direction. */
26071 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26072 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26076 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26077 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26079 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26080 || it
->phys_descent
> it
->descent
);
26081 glyph
->padding_p
= false;
26082 glyph
->glyph_not_available_p
= false;
26083 glyph
->face_id
= it
->face_id
;
26084 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26087 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26088 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26089 glyph
->bidi_type
= it
->bidi_it
.type
;
26091 ++it
->glyph_row
->used
[area
];
26094 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26098 /* Change IT->ascent and IT->height according to the setting of
26102 take_vertical_position_into_account (struct it
*it
)
26106 if (it
->voffset
< 0)
26107 /* Increase the ascent so that we can display the text higher
26109 it
->ascent
-= it
->voffset
;
26111 /* Increase the descent so that we can display the text lower
26113 it
->descent
+= it
->voffset
;
26118 /* Produce glyphs/get display metrics for the image IT is loaded with.
26119 See the description of struct display_iterator in dispextern.h for
26120 an overview of struct display_iterator. */
26123 produce_image_glyph (struct it
*it
)
26127 int glyph_ascent
, crop
;
26128 struct glyph_slice slice
;
26130 eassert (it
->what
== IT_IMAGE
);
26132 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26133 /* Make sure X resources of the face is loaded. */
26134 prepare_face_for_display (it
->f
, face
);
26136 if (it
->image_id
< 0)
26138 /* Fringe bitmap. */
26139 it
->ascent
= it
->phys_ascent
= 0;
26140 it
->descent
= it
->phys_descent
= 0;
26141 it
->pixel_width
= 0;
26146 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
26147 /* Make sure X resources of the image is loaded. */
26148 prepare_image_for_display (it
->f
, img
);
26150 slice
.x
= slice
.y
= 0;
26151 slice
.width
= img
->width
;
26152 slice
.height
= img
->height
;
26154 if (INTEGERP (it
->slice
.x
))
26155 slice
.x
= XINT (it
->slice
.x
);
26156 else if (FLOATP (it
->slice
.x
))
26157 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
26159 if (INTEGERP (it
->slice
.y
))
26160 slice
.y
= XINT (it
->slice
.y
);
26161 else if (FLOATP (it
->slice
.y
))
26162 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
26164 if (INTEGERP (it
->slice
.width
))
26165 slice
.width
= XINT (it
->slice
.width
);
26166 else if (FLOATP (it
->slice
.width
))
26167 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
26169 if (INTEGERP (it
->slice
.height
))
26170 slice
.height
= XINT (it
->slice
.height
);
26171 else if (FLOATP (it
->slice
.height
))
26172 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
26174 if (slice
.x
>= img
->width
)
26175 slice
.x
= img
->width
;
26176 if (slice
.y
>= img
->height
)
26177 slice
.y
= img
->height
;
26178 if (slice
.x
+ slice
.width
>= img
->width
)
26179 slice
.width
= img
->width
- slice
.x
;
26180 if (slice
.y
+ slice
.height
> img
->height
)
26181 slice
.height
= img
->height
- slice
.y
;
26183 if (slice
.width
== 0 || slice
.height
== 0)
26186 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
26188 it
->descent
= slice
.height
- glyph_ascent
;
26190 it
->descent
+= img
->vmargin
;
26191 if (slice
.y
+ slice
.height
== img
->height
)
26192 it
->descent
+= img
->vmargin
;
26193 it
->phys_descent
= it
->descent
;
26195 it
->pixel_width
= slice
.width
;
26197 it
->pixel_width
+= img
->hmargin
;
26198 if (slice
.x
+ slice
.width
== img
->width
)
26199 it
->pixel_width
+= img
->hmargin
;
26201 /* It's quite possible for images to have an ascent greater than
26202 their height, so don't get confused in that case. */
26203 if (it
->descent
< 0)
26208 if (face
->box
!= FACE_NO_BOX
)
26210 if (face
->box_line_width
> 0)
26213 it
->ascent
+= face
->box_line_width
;
26214 if (slice
.y
+ slice
.height
== img
->height
)
26215 it
->descent
+= face
->box_line_width
;
26218 if (it
->start_of_box_run_p
&& slice
.x
== 0)
26219 it
->pixel_width
+= eabs (face
->box_line_width
);
26220 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
26221 it
->pixel_width
+= eabs (face
->box_line_width
);
26224 take_vertical_position_into_account (it
);
26226 /* Automatically crop wide image glyphs at right edge so we can
26227 draw the cursor on same display row. */
26228 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
26229 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26231 it
->pixel_width
-= crop
;
26232 slice
.width
-= crop
;
26237 struct glyph
*glyph
;
26238 enum glyph_row_area area
= it
->area
;
26240 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26241 if (it
->glyph_row
->reversed_p
)
26245 /* Make room for the new glyph. */
26246 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26248 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26250 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26252 glyph
->charpos
= CHARPOS (it
->position
);
26253 glyph
->object
= it
->object
;
26254 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26255 glyph
->ascent
= glyph_ascent
;
26256 glyph
->descent
= it
->descent
;
26257 glyph
->voffset
= it
->voffset
;
26258 glyph
->type
= IMAGE_GLYPH
;
26259 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26260 glyph
->multibyte_p
= it
->multibyte_p
;
26261 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26263 /* In R2L rows, the left and the right box edges need to be
26264 drawn in reverse direction. */
26265 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26266 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26270 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26271 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26273 glyph
->overlaps_vertically_p
= false;
26274 glyph
->padding_p
= false;
26275 glyph
->glyph_not_available_p
= false;
26276 glyph
->face_id
= it
->face_id
;
26277 glyph
->u
.img_id
= img
->id
;
26278 glyph
->slice
.img
= slice
;
26279 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26282 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26283 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26284 glyph
->bidi_type
= it
->bidi_it
.type
;
26286 ++it
->glyph_row
->used
[area
];
26289 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26294 produce_xwidget_glyph (struct it
*it
)
26296 #ifdef HAVE_XWIDGETS
26297 struct xwidget
*xw
;
26298 int glyph_ascent
, crop
;
26299 eassert (it
->what
== IT_XWIDGET
);
26301 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26302 /* Make sure X resources of the face is loaded. */
26303 prepare_face_for_display (it
->f
, face
);
26306 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
26307 it
->descent
= xw
->height
/2;
26308 it
->phys_descent
= it
->descent
;
26309 it
->pixel_width
= xw
->width
;
26310 /* It's quite possible for images to have an ascent greater than
26311 their height, so don't get confused in that case. */
26312 if (it
->descent
< 0)
26317 if (face
->box
!= FACE_NO_BOX
)
26319 if (face
->box_line_width
> 0)
26321 it
->ascent
+= face
->box_line_width
;
26322 it
->descent
+= face
->box_line_width
;
26325 if (it
->start_of_box_run_p
)
26326 it
->pixel_width
+= eabs (face
->box_line_width
);
26327 it
->pixel_width
+= eabs (face
->box_line_width
);
26330 take_vertical_position_into_account (it
);
26332 /* Automatically crop wide image glyphs at right edge so we can
26333 draw the cursor on same display row. */
26334 crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
);
26335 if (crop
> 0 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26336 it
->pixel_width
-= crop
;
26340 enum glyph_row_area area
= it
->area
;
26341 struct glyph
*glyph
26342 = it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26344 if (it
->glyph_row
->reversed_p
)
26348 /* Make room for the new glyph. */
26349 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26351 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26353 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26355 glyph
->charpos
= CHARPOS (it
->position
);
26356 glyph
->object
= it
->object
;
26357 glyph
->pixel_width
= clip_to_bounds (-1, it
->pixel_width
, SHRT_MAX
);
26358 glyph
->ascent
= glyph_ascent
;
26359 glyph
->descent
= it
->descent
;
26360 glyph
->voffset
= it
->voffset
;
26361 glyph
->type
= XWIDGET_GLYPH
;
26362 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26363 glyph
->multibyte_p
= it
->multibyte_p
;
26364 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26366 /* In R2L rows, the left and the right box edges need to be
26367 drawn in reverse direction. */
26368 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26369 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26373 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26374 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26376 glyph
->overlaps_vertically_p
= 0;
26377 glyph
->padding_p
= 0;
26378 glyph
->glyph_not_available_p
= 0;
26379 glyph
->face_id
= it
->face_id
;
26380 glyph
->u
.xwidget
= it
->xwidget
;
26381 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26384 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26385 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26386 glyph
->bidi_type
= it
->bidi_it
.type
;
26388 ++it
->glyph_row
->used
[area
];
26391 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26396 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
26397 of the glyph, WIDTH and HEIGHT are the width and height of the
26398 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
26401 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
26402 int width
, int height
, int ascent
)
26404 struct glyph
*glyph
;
26405 enum glyph_row_area area
= it
->area
;
26407 eassert (ascent
>= 0 && ascent
<= height
);
26409 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26410 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26412 /* If the glyph row is reversed, we need to prepend the glyph
26413 rather than append it. */
26414 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26418 /* Make room for the additional glyph. */
26419 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26421 glyph
= it
->glyph_row
->glyphs
[area
];
26423 /* Decrease the width of the first glyph of the row that
26424 begins before first_visible_x (e.g., due to hscroll).
26425 This is so the overall width of the row becomes smaller
26426 by the scroll amount, and the stretch glyph appended by
26427 extend_face_to_end_of_line will be wider, to shift the
26428 row glyphs to the right. (In L2R rows, the corresponding
26429 left-shift effect is accomplished by setting row->x to a
26430 negative value, which won't work with R2L rows.)
26432 This must leave us with a positive value of WIDTH, since
26433 otherwise the call to move_it_in_display_line_to at the
26434 beginning of display_line would have got past the entire
26435 first glyph, and then it->current_x would have been
26436 greater or equal to it->first_visible_x. */
26437 if (it
->current_x
< it
->first_visible_x
)
26438 width
-= it
->first_visible_x
- it
->current_x
;
26439 eassert (width
> 0);
26441 glyph
->charpos
= CHARPOS (it
->position
);
26442 glyph
->object
= object
;
26443 /* FIXME: It would be better to use TYPE_MAX here, but
26444 __typeof__ is not portable enough... */
26445 glyph
->pixel_width
= clip_to_bounds (-1, width
, SHRT_MAX
);
26446 glyph
->ascent
= ascent
;
26447 glyph
->descent
= height
- ascent
;
26448 glyph
->voffset
= it
->voffset
;
26449 glyph
->type
= STRETCH_GLYPH
;
26450 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26451 glyph
->multibyte_p
= it
->multibyte_p
;
26452 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26454 /* In R2L rows, the left and the right box edges need to be
26455 drawn in reverse direction. */
26456 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26457 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26461 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26462 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26464 glyph
->overlaps_vertically_p
= false;
26465 glyph
->padding_p
= false;
26466 glyph
->glyph_not_available_p
= false;
26467 glyph
->face_id
= it
->face_id
;
26468 glyph
->u
.stretch
.ascent
= ascent
;
26469 glyph
->u
.stretch
.height
= height
;
26470 glyph
->slice
.img
= null_glyph_slice
;
26471 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26474 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26475 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26476 glyph
->bidi_type
= it
->bidi_it
.type
;
26480 glyph
->resolved_level
= 0;
26481 glyph
->bidi_type
= UNKNOWN_BT
;
26483 ++it
->glyph_row
->used
[area
];
26486 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26489 #endif /* HAVE_WINDOW_SYSTEM */
26491 /* Produce a stretch glyph for iterator IT. IT->object is the value
26492 of the glyph property displayed. The value must be a list
26493 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26496 1. `:width WIDTH' specifies that the space should be WIDTH *
26497 canonical char width wide. WIDTH may be an integer or floating
26500 2. `:relative-width FACTOR' specifies that the width of the stretch
26501 should be computed from the width of the first character having the
26502 `glyph' property, and should be FACTOR times that width.
26504 3. `:align-to HPOS' specifies that the space should be wide enough
26505 to reach HPOS, a value in canonical character units.
26507 Exactly one of the above pairs must be present.
26509 4. `:height HEIGHT' specifies that the height of the stretch produced
26510 should be HEIGHT, measured in canonical character units.
26512 5. `:relative-height FACTOR' specifies that the height of the
26513 stretch should be FACTOR times the height of the characters having
26514 the glyph property.
26516 Either none or exactly one of 4 or 5 must be present.
26518 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26519 of the stretch should be used for the ascent of the stretch.
26520 ASCENT must be in the range 0 <= ASCENT <= 100. */
26523 produce_stretch_glyph (struct it
*it
)
26525 /* (space :width WIDTH :height HEIGHT ...) */
26526 Lisp_Object prop
, plist
;
26527 int width
= 0, height
= 0, align_to
= -1;
26528 bool zero_width_ok_p
= false;
26530 struct font
*font
= NULL
;
26532 #ifdef HAVE_WINDOW_SYSTEM
26534 bool zero_height_ok_p
= false;
26536 if (FRAME_WINDOW_P (it
->f
))
26538 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26539 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26540 prepare_face_for_display (it
->f
, face
);
26544 /* List should start with `space'. */
26545 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26546 plist
= XCDR (it
->object
);
26548 /* Compute the width of the stretch. */
26549 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26550 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26552 /* Absolute width `:width WIDTH' specified and valid. */
26553 zero_width_ok_p
= true;
26556 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26558 /* Relative width `:relative-width FACTOR' specified and valid.
26559 Compute the width of the characters having the `glyph'
26562 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26565 if (it
->multibyte_p
)
26566 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26569 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26570 if (! ASCII_CHAR_P (it2
.c
))
26571 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26574 it2
.glyph_row
= NULL
;
26575 it2
.what
= IT_CHARACTER
;
26576 PRODUCE_GLYPHS (&it2
);
26577 width
= NUMVAL (prop
) * it2
.pixel_width
;
26579 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26580 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26583 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26584 align_to
= (align_to
< 0
26586 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26587 else if (align_to
< 0)
26588 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26589 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26590 zero_width_ok_p
= true;
26593 /* Nothing specified -> width defaults to canonical char width. */
26594 width
= FRAME_COLUMN_WIDTH (it
->f
);
26596 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26599 #ifdef HAVE_WINDOW_SYSTEM
26600 /* Compute height. */
26601 if (FRAME_WINDOW_P (it
->f
))
26603 int default_height
= normal_char_height (font
, ' ');
26605 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26606 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26609 zero_height_ok_p
= true;
26611 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26613 height
= default_height
* NUMVAL (prop
);
26615 height
= default_height
;
26617 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26620 /* Compute percentage of height used for ascent. If
26621 `:ascent ASCENT' is present and valid, use that. Otherwise,
26622 derive the ascent from the font in use. */
26623 if (prop
= Fplist_get (plist
, QCascent
),
26624 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26625 ascent
= height
* NUMVAL (prop
) / 100.0;
26626 else if (!NILP (prop
)
26627 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26628 ascent
= min (max (0, (int)tem
), height
);
26630 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26633 #endif /* HAVE_WINDOW_SYSTEM */
26636 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26637 && it
->current_x
+ width
> it
->last_visible_x
)
26639 width
= it
->last_visible_x
- it
->current_x
;
26640 #ifdef HAVE_WINDOW_SYSTEM
26641 /* Subtract one more pixel from the stretch width, but only on
26642 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26643 width
-= FRAME_WINDOW_P (it
->f
);
26647 if (width
> 0 && height
> 0 && it
->glyph_row
)
26649 Lisp_Object o_object
= it
->object
;
26650 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26653 if (!STRINGP (object
))
26654 object
= it
->w
->contents
;
26655 #ifdef HAVE_WINDOW_SYSTEM
26656 if (FRAME_WINDOW_P (it
->f
))
26657 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26661 it
->object
= object
;
26662 it
->char_to_display
= ' ';
26663 it
->pixel_width
= it
->len
= 1;
26665 tty_append_glyph (it
);
26666 it
->object
= o_object
;
26670 it
->pixel_width
= width
;
26671 #ifdef HAVE_WINDOW_SYSTEM
26672 if (FRAME_WINDOW_P (it
->f
))
26674 it
->ascent
= it
->phys_ascent
= ascent
;
26675 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26676 it
->nglyphs
= width
> 0 && height
> 0;
26677 take_vertical_position_into_account (it
);
26681 it
->nglyphs
= width
;
26684 /* Get information about special display element WHAT in an
26685 environment described by IT. WHAT is one of IT_TRUNCATION or
26686 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26687 non-null glyph_row member. This function ensures that fields like
26688 face_id, c, len of IT are left untouched. */
26691 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26698 temp_it
.object
= Qnil
;
26699 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26701 if (what
== IT_CONTINUATION
)
26703 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26704 if (it
->bidi_it
.paragraph_dir
== R2L
)
26705 SET_GLYPH_FROM_CHAR (glyph
, '/');
26707 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26709 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26711 /* FIXME: Should we mirror GC for R2L lines? */
26712 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26713 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26716 else if (what
== IT_TRUNCATION
)
26718 /* Truncation glyph. */
26719 SET_GLYPH_FROM_CHAR (glyph
, '$');
26721 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26723 /* FIXME: Should we mirror GC for R2L lines? */
26724 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26725 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26731 #ifdef HAVE_WINDOW_SYSTEM
26732 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26733 is turned off, we precede the truncation/continuation glyphs by a
26734 stretch glyph whose width is computed such that these special
26735 glyphs are aligned at the window margin, even when very different
26736 fonts are used in different glyph rows. */
26737 if (FRAME_WINDOW_P (temp_it
.f
)
26738 /* init_iterator calls this with it->glyph_row == NULL, and it
26739 wants only the pixel width of the truncation/continuation
26741 && temp_it
.glyph_row
26742 /* insert_left_trunc_glyphs calls us at the beginning of the
26743 row, and it has its own calculation of the stretch glyph
26745 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26746 && (temp_it
.glyph_row
->reversed_p
26747 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26748 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26750 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26752 if (stretch_width
> 0)
26754 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26755 struct font
*font
=
26756 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26757 int stretch_ascent
=
26758 (((temp_it
.ascent
+ temp_it
.descent
)
26759 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26761 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26762 temp_it
.ascent
+ temp_it
.descent
,
26769 temp_it
.what
= IT_CHARACTER
;
26770 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26771 temp_it
.face_id
= GLYPH_FACE (glyph
);
26772 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26774 PRODUCE_GLYPHS (&temp_it
);
26775 it
->pixel_width
= temp_it
.pixel_width
;
26776 it
->nglyphs
= temp_it
.nglyphs
;
26779 #ifdef HAVE_WINDOW_SYSTEM
26781 /* Calculate line-height and line-spacing properties.
26782 An integer value specifies explicit pixel value.
26783 A float value specifies relative value to current face height.
26784 A cons (float . face-name) specifies relative value to
26785 height of specified face font.
26787 Returns height in pixels, or nil. */
26790 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26791 int boff
, bool override
)
26793 Lisp_Object face_name
= Qnil
;
26794 int ascent
, descent
, height
;
26796 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26801 face_name
= XCAR (val
);
26803 if (!NUMBERP (val
))
26804 val
= make_number (1);
26805 if (NILP (face_name
))
26807 height
= it
->ascent
+ it
->descent
;
26812 if (NILP (face_name
))
26814 font
= FRAME_FONT (it
->f
);
26815 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26817 else if (EQ (face_name
, Qt
))
26826 face_id
= lookup_named_face (it
->f
, face_name
, false);
26827 face
= FACE_FROM_ID_OR_NULL (it
->f
, face_id
);
26828 if (face
== NULL
|| ((font
= face
->font
) == NULL
))
26829 return make_number (-1);
26830 boff
= font
->baseline_offset
;
26831 if (font
->vertical_centering
)
26832 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26835 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26839 it
->override_ascent
= ascent
;
26840 it
->override_descent
= descent
;
26841 it
->override_boff
= boff
;
26844 height
= ascent
+ descent
;
26848 height
= (int)(XFLOAT_DATA (val
) * height
);
26849 else if (INTEGERP (val
))
26850 height
*= XINT (val
);
26852 return make_number (height
);
26856 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26857 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26858 and only if this is for a character for which no font was found.
26860 If the display method (it->glyphless_method) is
26861 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26862 length of the acronym or the hexadecimal string, UPPER_XOFF and
26863 UPPER_YOFF are pixel offsets for the upper part of the string,
26864 LOWER_XOFF and LOWER_YOFF are for the lower part.
26866 For the other display methods, LEN through LOWER_YOFF are zero. */
26869 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26870 short upper_xoff
, short upper_yoff
,
26871 short lower_xoff
, short lower_yoff
)
26873 struct glyph
*glyph
;
26874 enum glyph_row_area area
= it
->area
;
26876 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26877 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26879 /* If the glyph row is reversed, we need to prepend the glyph
26880 rather than append it. */
26881 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26885 /* Make room for the additional glyph. */
26886 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26888 glyph
= it
->glyph_row
->glyphs
[area
];
26890 glyph
->charpos
= CHARPOS (it
->position
);
26891 glyph
->object
= it
->object
;
26892 eassert (it
->pixel_width
<= SHRT_MAX
);
26893 glyph
->pixel_width
= it
->pixel_width
;
26894 glyph
->ascent
= it
->ascent
;
26895 glyph
->descent
= it
->descent
;
26896 glyph
->voffset
= it
->voffset
;
26897 glyph
->type
= GLYPHLESS_GLYPH
;
26898 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26899 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26900 glyph
->u
.glyphless
.len
= len
;
26901 glyph
->u
.glyphless
.ch
= it
->c
;
26902 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26903 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26904 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26905 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26906 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26907 glyph
->multibyte_p
= it
->multibyte_p
;
26908 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26910 /* In R2L rows, the left and the right box edges need to be
26911 drawn in reverse direction. */
26912 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26913 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26917 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26918 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26920 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26921 || it
->phys_descent
> it
->descent
);
26922 glyph
->padding_p
= false;
26923 glyph
->glyph_not_available_p
= false;
26924 glyph
->face_id
= face_id
;
26925 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26928 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26929 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26930 glyph
->bidi_type
= it
->bidi_it
.type
;
26932 ++it
->glyph_row
->used
[area
];
26935 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26939 /* Produce a glyph for a glyphless character for iterator IT.
26940 IT->glyphless_method specifies which method to use for displaying
26941 the character. See the description of enum
26942 glyphless_display_method in dispextern.h for the detail.
26944 FOR_NO_FONT is true if and only if this is for a character for
26945 which no font was found. ACRONYM, if non-nil, is an acronym string
26946 for the character. */
26949 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26954 int base_width
, base_height
, width
, height
;
26955 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26958 /* Get the metrics of the base font. We always refer to the current
26960 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26961 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26962 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26963 it
->ascent
+= font
->baseline_offset
;
26964 it
->descent
-= font
->baseline_offset
;
26965 base_height
= it
->ascent
+ it
->descent
;
26966 base_width
= font
->average_width
;
26968 face_id
= merge_glyphless_glyph_face (it
);
26970 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26972 it
->pixel_width
= THIN_SPACE_WIDTH
;
26974 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26976 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26978 width
= CHARACTER_WIDTH (it
->c
);
26981 else if (width
> 4)
26983 it
->pixel_width
= base_width
* width
;
26985 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26991 unsigned int code
[6];
26993 int ascent
, descent
;
26994 struct font_metrics metrics_upper
, metrics_lower
;
26996 face
= FACE_FROM_ID (it
->f
, face_id
);
26997 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26998 prepare_face_for_display (it
->f
, face
);
27000 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
27002 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
27003 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
27004 if (CONSP (acronym
))
27005 acronym
= XCAR (acronym
);
27006 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
27010 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
27011 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
27014 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
27015 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
27016 upper_len
= (len
+ 1) / 2;
27017 font
->driver
->text_extents (font
, code
, upper_len
,
27019 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
27024 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
27025 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
27026 upper_xoff
= upper_yoff
= 2; /* the typical case */
27027 if (base_width
>= width
)
27029 /* Align the upper to the left, the lower to the right. */
27030 it
->pixel_width
= base_width
;
27031 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
27035 /* Center the shorter one. */
27036 it
->pixel_width
= width
;
27037 if (metrics_upper
.width
>= metrics_lower
.width
)
27038 lower_xoff
= (width
- metrics_lower
.width
) / 2;
27041 /* FIXME: This code doesn't look right. It formerly was
27042 missing the "lower_xoff = 0;", which couldn't have
27043 been right since it left lower_xoff uninitialized. */
27045 upper_xoff
= (width
- metrics_upper
.width
) / 2;
27049 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
27050 top, bottom, and between upper and lower strings. */
27051 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
27052 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
27053 /* Center vertically.
27054 H:base_height, D:base_descent
27055 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
27057 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
27058 descent = D - H/2 + h/2;
27059 lower_yoff = descent - 2 - ld;
27060 upper_yoff = lower_yoff - la - 1 - ud; */
27061 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
27062 descent
= it
->descent
- (base_height
- height
) / 2;
27063 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
27064 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
27065 - metrics_upper
.descent
);
27066 /* Don't make the height shorter than the base height. */
27067 if (height
> base_height
)
27069 it
->ascent
= ascent
;
27070 it
->descent
= descent
;
27074 it
->phys_ascent
= it
->ascent
;
27075 it
->phys_descent
= it
->descent
;
27077 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
27078 upper_xoff
, upper_yoff
,
27079 lower_xoff
, lower_yoff
);
27081 take_vertical_position_into_account (it
);
27086 Produce glyphs/get display metrics for the display element IT is
27087 loaded with. See the description of struct it in dispextern.h
27088 for an overview of struct it. */
27091 x_produce_glyphs (struct it
*it
)
27093 int extra_line_spacing
= it
->extra_line_spacing
;
27095 it
->glyph_not_available_p
= false;
27097 if (it
->what
== IT_CHARACTER
)
27100 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27101 struct font
*font
= face
->font
;
27102 struct font_metrics
*pcm
= NULL
;
27103 int boff
; /* Baseline offset. */
27107 /* When no suitable font is found, display this character by
27108 the method specified in the first extra slot of
27109 Vglyphless_char_display. */
27110 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
27112 eassert (it
->what
== IT_GLYPHLESS
);
27113 produce_glyphless_glyph (it
, true,
27114 STRINGP (acronym
) ? acronym
: Qnil
);
27118 boff
= font
->baseline_offset
;
27119 if (font
->vertical_centering
)
27120 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27122 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
27126 if (it
->override_ascent
>= 0)
27128 it
->ascent
= it
->override_ascent
;
27129 it
->descent
= it
->override_descent
;
27130 boff
= it
->override_boff
;
27134 it
->ascent
= FONT_BASE (font
) + boff
;
27135 it
->descent
= FONT_DESCENT (font
) - boff
;
27138 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
27140 pcm
= get_per_char_metric (font
, &char2b
);
27141 if (pcm
->width
== 0
27142 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27148 it
->phys_ascent
= pcm
->ascent
+ boff
;
27149 it
->phys_descent
= pcm
->descent
- boff
;
27150 it
->pixel_width
= pcm
->width
;
27151 /* Don't use font-global values for ascent and descent
27152 if they result in an exceedingly large line height. */
27153 if (it
->override_ascent
< 0)
27155 if (FONT_TOO_HIGH (font
))
27157 it
->ascent
= it
->phys_ascent
;
27158 it
->descent
= it
->phys_descent
;
27159 /* These limitations are enforced by an
27160 assertion near the end of this function. */
27161 if (it
->ascent
< 0)
27163 if (it
->descent
< 0)
27170 it
->glyph_not_available_p
= true;
27171 it
->phys_ascent
= it
->ascent
;
27172 it
->phys_descent
= it
->descent
;
27173 it
->pixel_width
= font
->space_width
;
27176 if (it
->constrain_row_ascent_descent_p
)
27178 if (it
->descent
> it
->max_descent
)
27180 it
->ascent
+= it
->descent
- it
->max_descent
;
27181 it
->descent
= it
->max_descent
;
27183 if (it
->ascent
> it
->max_ascent
)
27185 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27186 it
->ascent
= it
->max_ascent
;
27188 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27189 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27190 extra_line_spacing
= 0;
27193 /* If this is a space inside a region of text with
27194 `space-width' property, change its width. */
27196 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
27198 it
->pixel_width
*= XFLOATINT (it
->space_width
);
27200 /* If face has a box, add the box thickness to the character
27201 height. If character has a box line to the left and/or
27202 right, add the box line width to the character's width. */
27203 if (face
->box
!= FACE_NO_BOX
)
27205 int thick
= face
->box_line_width
;
27209 it
->ascent
+= thick
;
27210 it
->descent
+= thick
;
27215 if (it
->start_of_box_run_p
)
27216 it
->pixel_width
+= thick
;
27217 if (it
->end_of_box_run_p
)
27218 it
->pixel_width
+= thick
;
27221 /* If face has an overline, add the height of the overline
27222 (1 pixel) and a 1 pixel margin to the character height. */
27223 if (face
->overline_p
)
27224 it
->ascent
+= overline_margin
;
27226 if (it
->constrain_row_ascent_descent_p
)
27228 if (it
->ascent
> it
->max_ascent
)
27229 it
->ascent
= it
->max_ascent
;
27230 if (it
->descent
> it
->max_descent
)
27231 it
->descent
= it
->max_descent
;
27234 take_vertical_position_into_account (it
);
27236 /* If we have to actually produce glyphs, do it. */
27241 /* Translate a space with a `space-width' property
27242 into a stretch glyph. */
27243 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
27244 / FONT_HEIGHT (font
));
27245 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27246 it
->ascent
+ it
->descent
, ascent
);
27251 /* If characters with lbearing or rbearing are displayed
27252 in this line, record that fact in a flag of the
27253 glyph row. This is used to optimize X output code. */
27254 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
27255 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27257 if (! stretched_p
&& it
->pixel_width
== 0)
27258 /* We assure that all visible glyphs have at least 1-pixel
27260 it
->pixel_width
= 1;
27262 else if (it
->char_to_display
== '\n')
27264 /* A newline has no width, but we need the height of the
27265 line. But if previous part of the line sets a height,
27266 don't increase that height. */
27268 Lisp_Object height
;
27269 Lisp_Object total_height
= Qnil
;
27271 it
->override_ascent
= -1;
27272 it
->pixel_width
= 0;
27275 height
= get_it_property (it
, Qline_height
);
27276 /* Split (line-height total-height) list. */
27278 && CONSP (XCDR (height
))
27279 && NILP (XCDR (XCDR (height
))))
27281 total_height
= XCAR (XCDR (height
));
27282 height
= XCAR (height
);
27284 height
= calc_line_height_property (it
, height
, font
, boff
, true);
27286 if (it
->override_ascent
>= 0)
27288 it
->ascent
= it
->override_ascent
;
27289 it
->descent
= it
->override_descent
;
27290 boff
= it
->override_boff
;
27294 if (FONT_TOO_HIGH (font
))
27296 it
->ascent
= font
->pixel_size
+ boff
- 1;
27297 it
->descent
= -boff
+ 1;
27298 if (it
->descent
< 0)
27303 it
->ascent
= FONT_BASE (font
) + boff
;
27304 it
->descent
= FONT_DESCENT (font
) - boff
;
27308 if (EQ (height
, Qt
))
27310 if (it
->descent
> it
->max_descent
)
27312 it
->ascent
+= it
->descent
- it
->max_descent
;
27313 it
->descent
= it
->max_descent
;
27315 if (it
->ascent
> it
->max_ascent
)
27317 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27318 it
->ascent
= it
->max_ascent
;
27320 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27321 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27322 it
->constrain_row_ascent_descent_p
= true;
27323 extra_line_spacing
= 0;
27327 Lisp_Object spacing
;
27329 it
->phys_ascent
= it
->ascent
;
27330 it
->phys_descent
= it
->descent
;
27332 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
27333 && face
->box
!= FACE_NO_BOX
27334 && face
->box_line_width
> 0)
27336 it
->ascent
+= face
->box_line_width
;
27337 it
->descent
+= face
->box_line_width
;
27340 && XINT (height
) > it
->ascent
+ it
->descent
)
27341 it
->ascent
= XINT (height
) - it
->descent
;
27343 if (!NILP (total_height
))
27344 spacing
= calc_line_height_property (it
, total_height
, font
,
27348 spacing
= get_it_property (it
, Qline_spacing
);
27349 spacing
= calc_line_height_property (it
, spacing
, font
,
27352 if (INTEGERP (spacing
))
27354 extra_line_spacing
= XINT (spacing
);
27355 if (!NILP (total_height
))
27356 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
27360 else /* i.e. (it->char_to_display == '\t') */
27362 if (font
->space_width
> 0)
27364 int tab_width
= it
->tab_width
* font
->space_width
;
27365 int x
= it
->current_x
+ it
->continuation_lines_width
;
27366 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
27368 /* If the distance from the current position to the next tab
27369 stop is less than a space character width, use the
27370 tab stop after that. */
27371 if (next_tab_x
- x
< font
->space_width
)
27372 next_tab_x
+= tab_width
;
27374 it
->pixel_width
= next_tab_x
- x
;
27376 if (FONT_TOO_HIGH (font
))
27378 if (get_char_glyph_code (' ', font
, &char2b
))
27380 pcm
= get_per_char_metric (font
, &char2b
);
27381 if (pcm
->width
== 0
27382 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27388 it
->ascent
= pcm
->ascent
+ boff
;
27389 it
->descent
= pcm
->descent
- boff
;
27393 it
->ascent
= font
->pixel_size
+ boff
- 1;
27394 it
->descent
= -boff
+ 1;
27396 if (it
->ascent
< 0)
27398 if (it
->descent
< 0)
27403 it
->ascent
= FONT_BASE (font
) + boff
;
27404 it
->descent
= FONT_DESCENT (font
) - boff
;
27406 it
->phys_ascent
= it
->ascent
;
27407 it
->phys_descent
= it
->descent
;
27411 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27412 it
->ascent
+ it
->descent
, it
->ascent
);
27417 it
->pixel_width
= 0;
27422 if (FONT_TOO_HIGH (font
))
27424 int font_ascent
, font_descent
;
27426 /* For very large fonts, where we ignore the declared font
27427 dimensions, and go by per-character metrics instead,
27428 don't let the row ascent and descent values (and the row
27429 height computed from them) be smaller than the "normal"
27430 character metrics. This avoids unpleasant effects
27431 whereby lines on display would change their height
27432 depending on which characters are shown. */
27433 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27434 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
27435 it
->max_descent
= max (it
->max_descent
, font_descent
);
27438 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
27440 /* A static composition.
27442 Note: A composition is represented as one glyph in the
27443 glyph matrix. There are no padding glyphs.
27445 Important note: pixel_width, ascent, and descent are the
27446 values of what is drawn by draw_glyphs (i.e. the values of
27447 the overall glyphs composed). */
27448 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27449 int boff
; /* baseline offset */
27450 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
27451 int glyph_len
= cmp
->glyph_len
;
27452 struct font
*font
= face
->font
;
27456 /* If we have not yet calculated pixel size data of glyphs of
27457 the composition for the current face font, calculate them
27458 now. Theoretically, we have to check all fonts for the
27459 glyphs, but that requires much time and memory space. So,
27460 here we check only the font of the first glyph. This may
27461 lead to incorrect display, but it's very rare, and C-l
27462 (recenter-top-bottom) can correct the display anyway. */
27463 if (! cmp
->font
|| cmp
->font
!= font
)
27465 /* Ascent and descent of the font of the first character
27466 of this composition (adjusted by baseline offset).
27467 Ascent and descent of overall glyphs should not be less
27468 than these, respectively. */
27469 int font_ascent
, font_descent
, font_height
;
27470 /* Bounding box of the overall glyphs. */
27471 int leftmost
, rightmost
, lowest
, highest
;
27472 int lbearing
, rbearing
;
27473 int i
, width
, ascent
, descent
;
27476 struct font_metrics
*pcm
;
27479 eassume (0 < glyph_len
); /* See Bug#8512. */
27481 c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1);
27482 while (c
== '\t' && 0 < --glyph_len
);
27484 bool right_padded
= glyph_len
< cmp
->glyph_len
;
27485 for (i
= 0; i
< glyph_len
; i
++)
27487 c
= COMPOSITION_GLYPH (cmp
, i
);
27490 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27492 bool left_padded
= i
> 0;
27494 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
27495 : IT_CHARPOS (*it
));
27496 /* If no suitable font is found, use the default font. */
27497 bool font_not_found_p
= font
== NULL
;
27498 if (font_not_found_p
)
27500 face
= face
->ascii_face
;
27503 boff
= font
->baseline_offset
;
27504 if (font
->vertical_centering
)
27505 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27506 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27507 font_ascent
+= boff
;
27508 font_descent
-= boff
;
27509 font_height
= font_ascent
+ font_descent
;
27514 if (! font_not_found_p
)
27516 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27518 pcm
= get_per_char_metric (font
, &char2b
);
27521 /* Initialize the bounding box. */
27524 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27525 ascent
= pcm
->ascent
;
27526 descent
= pcm
->descent
;
27527 lbearing
= pcm
->lbearing
;
27528 rbearing
= pcm
->rbearing
;
27532 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27533 ascent
= FONT_BASE (font
);
27534 descent
= FONT_DESCENT (font
);
27541 lowest
= - descent
+ boff
;
27542 highest
= ascent
+ boff
;
27544 if (! font_not_found_p
27545 && font
->default_ascent
27546 && CHAR_TABLE_P (Vuse_default_ascent
)
27547 && !NILP (Faref (Vuse_default_ascent
,
27548 make_number (it
->char_to_display
))))
27549 highest
= font
->default_ascent
+ boff
;
27551 /* Draw the first glyph at the normal position. It may be
27552 shifted to right later if some other glyphs are drawn
27554 cmp
->offsets
[i
* 2] = 0;
27555 cmp
->offsets
[i
* 2 + 1] = boff
;
27556 cmp
->lbearing
= lbearing
;
27557 cmp
->rbearing
= rbearing
;
27559 /* Set cmp->offsets for the remaining glyphs. */
27560 for (i
++; i
< glyph_len
; i
++)
27562 int left
, right
, btm
, top
;
27563 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27565 struct face
*this_face
;
27569 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27570 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27571 font
= this_face
->font
;
27577 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27579 pcm
= get_per_char_metric (font
, &char2b
);
27582 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27585 width
= pcm
->width
;
27586 ascent
= pcm
->ascent
;
27587 descent
= pcm
->descent
;
27588 lbearing
= pcm
->lbearing
;
27589 rbearing
= pcm
->rbearing
;
27590 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27592 /* Relative composition with or without
27593 alternate chars. */
27594 left
= (leftmost
+ rightmost
- width
) / 2;
27595 btm
= - descent
+ boff
;
27596 if (font
->relative_compose
27597 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27598 || NILP (Faref (Vignore_relative_composition
,
27599 make_number (ch
)))))
27602 if (- descent
>= font
->relative_compose
)
27603 /* One extra pixel between two glyphs. */
27605 else if (ascent
<= 0)
27606 /* One extra pixel between two glyphs. */
27607 btm
= lowest
- 1 - ascent
- descent
;
27612 /* A composition rule is specified by an integer
27613 value that encodes global and new reference
27614 points (GREF and NREF). GREF and NREF are
27615 specified by numbers as below:
27617 0---1---2 -- ascent
27621 9--10--11 -- center
27623 ---3---4---5--- baseline
27625 6---7---8 -- descent
27627 int rule
= COMPOSITION_RULE (cmp
, i
);
27628 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27630 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27631 grefx
= gref
% 3, nrefx
= nref
% 3;
27632 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27634 xoff
= font_height
* (xoff
- 128) / 256;
27636 yoff
= font_height
* (yoff
- 128) / 256;
27639 + grefx
* (rightmost
- leftmost
) / 2
27640 - nrefx
* width
/ 2
27643 btm
= ((grefy
== 0 ? highest
27645 : grefy
== 2 ? lowest
27646 : (highest
+ lowest
) / 2)
27647 - (nrefy
== 0 ? ascent
+ descent
27648 : nrefy
== 1 ? descent
- boff
27650 : (ascent
+ descent
) / 2)
27654 cmp
->offsets
[i
* 2] = left
;
27655 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27657 /* Update the bounding box of the overall glyphs. */
27660 right
= left
+ width
;
27661 if (left
< leftmost
)
27663 if (right
> rightmost
)
27666 top
= btm
+ descent
+ ascent
;
27672 if (cmp
->lbearing
> left
+ lbearing
)
27673 cmp
->lbearing
= left
+ lbearing
;
27674 if (cmp
->rbearing
< left
+ rbearing
)
27675 cmp
->rbearing
= left
+ rbearing
;
27679 /* If there are glyphs whose x-offsets are negative,
27680 shift all glyphs to the right and make all x-offsets
27684 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27685 cmp
->offsets
[i
* 2] -= leftmost
;
27686 rightmost
-= leftmost
;
27687 cmp
->lbearing
-= leftmost
;
27688 cmp
->rbearing
-= leftmost
;
27691 if (left_padded
&& cmp
->lbearing
< 0)
27693 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27694 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27695 rightmost
-= cmp
->lbearing
;
27696 cmp
->rbearing
-= cmp
->lbearing
;
27699 if (right_padded
&& rightmost
< cmp
->rbearing
)
27701 rightmost
= cmp
->rbearing
;
27704 cmp
->pixel_width
= rightmost
;
27705 cmp
->ascent
= highest
;
27706 cmp
->descent
= - lowest
;
27707 if (cmp
->ascent
< font_ascent
)
27708 cmp
->ascent
= font_ascent
;
27709 if (cmp
->descent
< font_descent
)
27710 cmp
->descent
= font_descent
;
27714 && (cmp
->lbearing
< 0
27715 || cmp
->rbearing
> cmp
->pixel_width
))
27716 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27718 it
->pixel_width
= cmp
->pixel_width
;
27719 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27720 it
->descent
= it
->phys_descent
= cmp
->descent
;
27721 if (face
->box
!= FACE_NO_BOX
)
27723 int thick
= face
->box_line_width
;
27727 it
->ascent
+= thick
;
27728 it
->descent
+= thick
;
27733 if (it
->start_of_box_run_p
)
27734 it
->pixel_width
+= thick
;
27735 if (it
->end_of_box_run_p
)
27736 it
->pixel_width
+= thick
;
27739 /* If face has an overline, add the height of the overline
27740 (1 pixel) and a 1 pixel margin to the character height. */
27741 if (face
->overline_p
)
27742 it
->ascent
+= overline_margin
;
27744 take_vertical_position_into_account (it
);
27745 if (it
->ascent
< 0)
27747 if (it
->descent
< 0)
27750 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27751 append_composite_glyph (it
);
27753 else if (it
->what
== IT_COMPOSITION
)
27755 /* A dynamic (automatic) composition. */
27756 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27757 Lisp_Object gstring
;
27758 struct font_metrics metrics
;
27762 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27764 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27767 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27768 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27769 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27770 it
->descent
= it
->phys_descent
= metrics
.descent
;
27771 if (face
->box
!= FACE_NO_BOX
)
27773 int thick
= face
->box_line_width
;
27777 it
->ascent
+= thick
;
27778 it
->descent
+= thick
;
27783 if (it
->start_of_box_run_p
)
27784 it
->pixel_width
+= thick
;
27785 if (it
->end_of_box_run_p
)
27786 it
->pixel_width
+= thick
;
27788 /* If face has an overline, add the height of the overline
27789 (1 pixel) and a 1 pixel margin to the character height. */
27790 if (face
->overline_p
)
27791 it
->ascent
+= overline_margin
;
27792 take_vertical_position_into_account (it
);
27793 if (it
->ascent
< 0)
27795 if (it
->descent
< 0)
27799 append_composite_glyph (it
);
27801 else if (it
->what
== IT_GLYPHLESS
)
27802 produce_glyphless_glyph (it
, false, Qnil
);
27803 else if (it
->what
== IT_IMAGE
)
27804 produce_image_glyph (it
);
27805 else if (it
->what
== IT_STRETCH
)
27806 produce_stretch_glyph (it
);
27807 else if (it
->what
== IT_XWIDGET
)
27808 produce_xwidget_glyph (it
);
27811 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27812 because this isn't true for images with `:ascent 100'. */
27813 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27814 if (it
->area
== TEXT_AREA
)
27815 it
->current_x
+= it
->pixel_width
;
27817 if (extra_line_spacing
> 0)
27819 it
->descent
+= extra_line_spacing
;
27820 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27821 it
->max_extra_line_spacing
= extra_line_spacing
;
27824 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27825 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27826 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27827 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27831 Output LEN glyphs starting at START at the nominal cursor position.
27832 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27833 being updated, and UPDATED_AREA is the area of that row being updated. */
27836 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27837 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27839 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27841 eassert (updated_row
);
27842 /* When the window is hscrolled, cursor hpos can legitimately be out
27843 of bounds, but we draw the cursor at the corresponding window
27844 margin in that case. */
27845 if (!updated_row
->reversed_p
&& chpos
< 0)
27847 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27848 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27852 /* Write glyphs. */
27854 hpos
= start
- updated_row
->glyphs
[updated_area
];
27855 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27856 updated_row
, updated_area
,
27858 DRAW_NORMAL_TEXT
, 0);
27860 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27861 if (updated_area
== TEXT_AREA
27862 && w
->phys_cursor_on_p
27863 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27865 && chpos
< hpos
+ len
)
27866 w
->phys_cursor_on_p
= false;
27870 /* Advance the output cursor. */
27871 w
->output_cursor
.hpos
+= len
;
27872 w
->output_cursor
.x
= x
;
27877 Insert LEN glyphs from START at the nominal cursor position. */
27880 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27881 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27884 int line_height
, shift_by_width
, shifted_region_width
;
27885 struct glyph_row
*row
;
27886 struct glyph
*glyph
;
27887 int frame_x
, frame_y
;
27890 eassert (updated_row
);
27892 f
= XFRAME (WINDOW_FRAME (w
));
27894 /* Get the height of the line we are in. */
27896 line_height
= row
->height
;
27898 /* Get the width of the glyphs to insert. */
27899 shift_by_width
= 0;
27900 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27901 shift_by_width
+= glyph
->pixel_width
;
27903 /* Get the width of the region to shift right. */
27904 shifted_region_width
= (window_box_width (w
, updated_area
)
27905 - w
->output_cursor
.x
27909 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27910 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27912 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27913 line_height
, shift_by_width
);
27915 /* Write the glyphs. */
27916 hpos
= start
- row
->glyphs
[updated_area
];
27917 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27919 DRAW_NORMAL_TEXT
, 0);
27921 /* Advance the output cursor. */
27922 w
->output_cursor
.hpos
+= len
;
27923 w
->output_cursor
.x
+= shift_by_width
;
27929 Erase the current text line from the nominal cursor position
27930 (inclusive) to pixel column TO_X (exclusive). The idea is that
27931 everything from TO_X onward is already erased.
27933 TO_X is a pixel position relative to UPDATED_AREA of currently
27934 updated window W. TO_X == -1 means clear to the end of this area. */
27937 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27938 enum glyph_row_area updated_area
, int to_x
)
27941 int max_x
, min_y
, max_y
;
27942 int from_x
, from_y
, to_y
;
27944 eassert (updated_row
);
27945 f
= XFRAME (w
->frame
);
27947 if (updated_row
->full_width_p
)
27948 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27949 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27951 max_x
= window_box_width (w
, updated_area
);
27952 max_y
= window_text_bottom_y (w
);
27954 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27955 of window. For TO_X > 0, truncate to end of drawing area. */
27961 to_x
= min (to_x
, max_x
);
27963 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27965 /* Notice if the cursor will be cleared by this operation. */
27966 if (!updated_row
->full_width_p
)
27967 notice_overwritten_cursor (w
, updated_area
,
27968 w
->output_cursor
.x
, -1,
27970 MATRIX_ROW_BOTTOM_Y (updated_row
));
27972 from_x
= w
->output_cursor
.x
;
27974 /* Translate to frame coordinates. */
27975 if (updated_row
->full_width_p
)
27977 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27978 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27982 int area_left
= window_box_left (w
, updated_area
);
27983 from_x
+= area_left
;
27987 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27988 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27989 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27991 /* Prevent inadvertently clearing to end of the X window. */
27992 if (to_x
> from_x
&& to_y
> from_y
)
27995 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27996 to_x
- from_x
, to_y
- from_y
);
28001 #endif /* HAVE_WINDOW_SYSTEM */
28005 /***********************************************************************
28007 ***********************************************************************/
28009 /* Value is the internal representation of the specified cursor type
28010 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
28011 of the bar cursor. */
28013 static enum text_cursor_kinds
28014 get_specified_cursor_type (Lisp_Object arg
, int *width
)
28016 enum text_cursor_kinds type
;
28021 if (EQ (arg
, Qbox
))
28022 return FILLED_BOX_CURSOR
;
28024 if (EQ (arg
, Qhollow
))
28025 return HOLLOW_BOX_CURSOR
;
28027 if (EQ (arg
, Qbar
))
28034 && EQ (XCAR (arg
), Qbar
)
28035 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
28037 *width
= XINT (XCDR (arg
));
28041 if (EQ (arg
, Qhbar
))
28044 return HBAR_CURSOR
;
28048 && EQ (XCAR (arg
), Qhbar
)
28049 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
28051 *width
= XINT (XCDR (arg
));
28052 return HBAR_CURSOR
;
28055 /* Treat anything unknown as "hollow box cursor".
28056 It was bad to signal an error; people have trouble fixing
28057 .Xdefaults with Emacs, when it has something bad in it. */
28058 type
= HOLLOW_BOX_CURSOR
;
28063 /* Set the default cursor types for specified frame. */
28065 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
28070 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
28071 FRAME_CURSOR_WIDTH (f
) = width
;
28073 /* By default, set up the blink-off state depending on the on-state. */
28075 tem
= Fassoc (arg
, Vblink_cursor_alist
);
28078 FRAME_BLINK_OFF_CURSOR (f
)
28079 = get_specified_cursor_type (XCDR (tem
), &width
);
28080 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
28083 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
28085 /* Make sure the cursor gets redrawn. */
28086 f
->cursor_type_changed
= true;
28090 #ifdef HAVE_WINDOW_SYSTEM
28092 /* Return the cursor we want to be displayed in window W. Return
28093 width of bar/hbar cursor through WIDTH arg. Return with
28094 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
28095 (i.e. if the `system caret' should track this cursor).
28097 In a mini-buffer window, we want the cursor only to appear if we
28098 are reading input from this window. For the selected window, we
28099 want the cursor type given by the frame parameter or buffer local
28100 setting of cursor-type. If explicitly marked off, draw no cursor.
28101 In all other cases, we want a hollow box cursor. */
28103 static enum text_cursor_kinds
28104 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
28105 bool *active_cursor
)
28107 struct frame
*f
= XFRAME (w
->frame
);
28108 struct buffer
*b
= XBUFFER (w
->contents
);
28109 int cursor_type
= DEFAULT_CURSOR
;
28110 Lisp_Object alt_cursor
;
28111 bool non_selected
= false;
28113 *active_cursor
= true;
28116 if (cursor_in_echo_area
28117 && FRAME_HAS_MINIBUF_P (f
)
28118 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
28120 if (w
== XWINDOW (echo_area_window
))
28122 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
28124 *width
= FRAME_CURSOR_WIDTH (f
);
28125 return FRAME_DESIRED_CURSOR (f
);
28128 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
28131 *active_cursor
= false;
28132 non_selected
= true;
28135 /* Detect a nonselected window or nonselected frame. */
28136 else if (w
!= XWINDOW (f
->selected_window
)
28137 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
28139 *active_cursor
= false;
28141 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
28144 non_selected
= true;
28147 /* Never display a cursor in a window in which cursor-type is nil. */
28148 if (NILP (BVAR (b
, cursor_type
)))
28151 /* Get the normal cursor type for this window. */
28152 if (EQ (BVAR (b
, cursor_type
), Qt
))
28154 cursor_type
= FRAME_DESIRED_CURSOR (f
);
28155 *width
= FRAME_CURSOR_WIDTH (f
);
28158 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
28160 /* Use cursor-in-non-selected-windows instead
28161 for non-selected window or frame. */
28164 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
28165 if (!EQ (Qt
, alt_cursor
))
28166 return get_specified_cursor_type (alt_cursor
, width
);
28167 /* t means modify the normal cursor type. */
28168 if (cursor_type
== FILLED_BOX_CURSOR
)
28169 cursor_type
= HOLLOW_BOX_CURSOR
;
28170 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
28172 return cursor_type
;
28175 /* Use normal cursor if not blinked off. */
28176 if (!w
->cursor_off_p
)
28178 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
)
28180 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28182 if (cursor_type
== FILLED_BOX_CURSOR
)
28184 /* Using a block cursor on large images can be very annoying.
28185 So use a hollow cursor for "large" images.
28186 If image is not transparent (no mask), also use hollow cursor. */
28187 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
28188 if (img
!= NULL
&& IMAGEP (img
->spec
))
28190 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
28191 where N = size of default frame font size.
28192 This should cover most of the "tiny" icons people may use. */
28194 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
28195 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
28196 cursor_type
= HOLLOW_BOX_CURSOR
;
28199 else if (cursor_type
!= NO_CURSOR
)
28201 /* Display current only supports BOX and HOLLOW cursors for images.
28202 So for now, unconditionally use a HOLLOW cursor when cursor is
28203 not a solid box cursor. */
28204 cursor_type
= HOLLOW_BOX_CURSOR
;
28207 return cursor_type
;
28210 /* Cursor is blinked off, so determine how to "toggle" it. */
28212 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
28213 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
28214 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
28216 /* Then see if frame has specified a specific blink off cursor type. */
28217 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
28219 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
28220 return FRAME_BLINK_OFF_CURSOR (f
);
28224 /* Some people liked having a permanently visible blinking cursor,
28225 while others had very strong opinions against it. So it was
28226 decided to remove it. KFS 2003-09-03 */
28228 /* Finally perform built-in cursor blinking:
28229 filled box <-> hollow box
28230 wide [h]bar <-> narrow [h]bar
28231 narrow [h]bar <-> no cursor
28232 other type <-> no cursor */
28234 if (cursor_type
== FILLED_BOX_CURSOR
)
28235 return HOLLOW_BOX_CURSOR
;
28237 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
28240 return cursor_type
;
28248 /* Notice when the text cursor of window W has been completely
28249 overwritten by a drawing operation that outputs glyphs in AREA
28250 starting at X0 and ending at X1 in the line starting at Y0 and
28251 ending at Y1. X coordinates are area-relative. X1 < 0 means all
28252 the rest of the line after X0 has been written. Y coordinates
28253 are window-relative. */
28256 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
28257 int x0
, int x1
, int y0
, int y1
)
28259 int cx0
, cx1
, cy0
, cy1
;
28260 struct glyph_row
*row
;
28262 if (!w
->phys_cursor_on_p
)
28264 if (area
!= TEXT_AREA
)
28267 if (w
->phys_cursor
.vpos
< 0
28268 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
28269 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
28270 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
28273 if (row
->cursor_in_fringe_p
)
28275 row
->cursor_in_fringe_p
= false;
28276 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
28277 w
->phys_cursor_on_p
= false;
28281 cx0
= w
->phys_cursor
.x
;
28282 cx1
= cx0
+ w
->phys_cursor_width
;
28283 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
28286 /* The cursor image will be completely removed from the
28287 screen if the output area intersects the cursor area in
28288 y-direction. When we draw in [y0 y1[, and some part of
28289 the cursor is at y < y0, that part must have been drawn
28290 before. When scrolling, the cursor is erased before
28291 actually scrolling, so we don't come here. When not
28292 scrolling, the rows above the old cursor row must have
28293 changed, and in this case these rows must have written
28294 over the cursor image.
28296 Likewise if part of the cursor is below y1, with the
28297 exception of the cursor being in the first blank row at
28298 the buffer and window end because update_text_area
28299 doesn't draw that row. (Except when it does, but
28300 that's handled in update_text_area.) */
28302 cy0
= w
->phys_cursor
.y
;
28303 cy1
= cy0
+ w
->phys_cursor_height
;
28304 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
28307 w
->phys_cursor_on_p
= false;
28310 #endif /* HAVE_WINDOW_SYSTEM */
28313 /************************************************************************
28315 ************************************************************************/
28317 #ifdef HAVE_WINDOW_SYSTEM
28320 Fix the display of area AREA of overlapping row ROW in window W
28321 with respect to the overlapping part OVERLAPS. */
28324 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
28325 enum glyph_row_area area
, int overlaps
)
28332 for (i
= 0; i
< row
->used
[area
];)
28334 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
28336 int start
= i
, start_x
= x
;
28340 x
+= row
->glyphs
[area
][i
].pixel_width
;
28343 while (i
< row
->used
[area
]
28344 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
28346 draw_glyphs (w
, start_x
, row
, area
,
28348 DRAW_NORMAL_TEXT
, overlaps
);
28352 x
+= row
->glyphs
[area
][i
].pixel_width
;
28362 Draw the cursor glyph of window W in glyph row ROW. See the
28363 comment of draw_glyphs for the meaning of HL. */
28366 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
28367 enum draw_glyphs_face hl
)
28369 /* If cursor hpos is out of bounds, don't draw garbage. This can
28370 happen in mini-buffer windows when switching between echo area
28371 glyphs and mini-buffer. */
28372 if ((row
->reversed_p
28373 ? (w
->phys_cursor
.hpos
>= 0)
28374 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
28376 bool on_p
= w
->phys_cursor_on_p
;
28378 int hpos
= w
->phys_cursor
.hpos
;
28380 /* When the window is hscrolled, cursor hpos can legitimately be
28381 out of bounds, but we draw the cursor at the corresponding
28382 window margin in that case. */
28383 if (!row
->reversed_p
&& hpos
< 0)
28385 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28386 hpos
= row
->used
[TEXT_AREA
] - 1;
28388 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
28390 w
->phys_cursor_on_p
= on_p
;
28392 if (hl
== DRAW_CURSOR
)
28393 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28394 /* When we erase the cursor, and ROW is overlapped by other
28395 rows, make sure that these overlapping parts of other rows
28397 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
28399 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28401 if (row
> w
->current_matrix
->rows
28402 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
28403 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
28404 OVERLAPS_ERASED_CURSOR
);
28406 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
28407 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
28408 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
28409 OVERLAPS_ERASED_CURSOR
);
28415 /* Erase the image of a cursor of window W from the screen. */
28418 erase_phys_cursor (struct window
*w
)
28420 struct frame
*f
= XFRAME (w
->frame
);
28421 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28422 int hpos
= w
->phys_cursor
.hpos
;
28423 int vpos
= w
->phys_cursor
.vpos
;
28424 bool mouse_face_here_p
= false;
28425 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
28426 struct glyph_row
*cursor_row
;
28427 struct glyph
*cursor_glyph
;
28428 enum draw_glyphs_face hl
;
28430 /* No cursor displayed or row invalidated => nothing to do on the
28432 if (w
->phys_cursor_type
== NO_CURSOR
)
28433 goto mark_cursor_off
;
28435 /* VPOS >= active_glyphs->nrows means that window has been resized.
28436 Don't bother to erase the cursor. */
28437 if (vpos
>= active_glyphs
->nrows
)
28438 goto mark_cursor_off
;
28440 /* If row containing cursor is marked invalid, there is nothing we
28442 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
28443 if (!cursor_row
->enabled_p
)
28444 goto mark_cursor_off
;
28446 /* If line spacing is > 0, old cursor may only be partially visible in
28447 window after split-window. So adjust visible height. */
28448 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
28449 window_text_bottom_y (w
) - cursor_row
->y
);
28451 /* If row is completely invisible, don't attempt to delete a cursor which
28452 isn't there. This can happen if cursor is at top of a window, and
28453 we switch to a buffer with a header line in that window. */
28454 if (cursor_row
->visible_height
<= 0)
28455 goto mark_cursor_off
;
28457 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
28458 if (cursor_row
->cursor_in_fringe_p
)
28460 cursor_row
->cursor_in_fringe_p
= false;
28461 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
28462 goto mark_cursor_off
;
28465 /* This can happen when the new row is shorter than the old one.
28466 In this case, either draw_glyphs or clear_end_of_line
28467 should have cleared the cursor. Note that we wouldn't be
28468 able to erase the cursor in this case because we don't have a
28469 cursor glyph at hand. */
28470 if ((cursor_row
->reversed_p
28471 ? (w
->phys_cursor
.hpos
< 0)
28472 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
28473 goto mark_cursor_off
;
28475 /* When the window is hscrolled, cursor hpos can legitimately be out
28476 of bounds, but we draw the cursor at the corresponding window
28477 margin in that case. */
28478 if (!cursor_row
->reversed_p
&& hpos
< 0)
28480 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
28481 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
28483 /* If the cursor is in the mouse face area, redisplay that when
28484 we clear the cursor. */
28485 if (! NILP (hlinfo
->mouse_face_window
)
28486 && coords_in_mouse_face_p (w
, hpos
, vpos
)
28487 /* Don't redraw the cursor's spot in mouse face if it is at the
28488 end of a line (on a newline). The cursor appears there, but
28489 mouse highlighting does not. */
28490 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
28491 mouse_face_here_p
= true;
28493 /* Maybe clear the display under the cursor. */
28494 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
28497 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
28500 cursor_glyph
= get_phys_cursor_glyph (w
);
28501 if (cursor_glyph
== NULL
)
28502 goto mark_cursor_off
;
28504 width
= cursor_glyph
->pixel_width
;
28505 x
= w
->phys_cursor
.x
;
28511 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
28512 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
28513 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
28516 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
28519 /* Erase the cursor by redrawing the character underneath it. */
28520 if (mouse_face_here_p
)
28521 hl
= DRAW_MOUSE_FACE
;
28523 hl
= DRAW_NORMAL_TEXT
;
28524 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28527 w
->phys_cursor_on_p
= false;
28528 w
->phys_cursor_type
= NO_CURSOR
;
28532 /* Display or clear cursor of window W. If !ON, clear the cursor.
28533 If ON, display the cursor; where to put the cursor is specified by
28534 HPOS, VPOS, X and Y. */
28537 display_and_set_cursor (struct window
*w
, bool on
,
28538 int hpos
, int vpos
, int x
, int y
)
28540 struct frame
*f
= XFRAME (w
->frame
);
28541 int new_cursor_type
;
28542 int new_cursor_width
;
28543 bool active_cursor
;
28544 struct glyph_row
*glyph_row
;
28545 struct glyph
*glyph
;
28547 /* This is pointless on invisible frames, and dangerous on garbaged
28548 windows and frames; in the latter case, the frame or window may
28549 be in the midst of changing its size, and x and y may be off the
28551 if (! FRAME_VISIBLE_P (f
)
28552 || FRAME_GARBAGED_P (f
)
28553 || vpos
>= w
->current_matrix
->nrows
28554 || hpos
>= w
->current_matrix
->matrix_w
)
28557 /* If cursor is off and we want it off, return quickly. */
28558 if (!on
&& !w
->phys_cursor_on_p
)
28561 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28562 /* If cursor row is not enabled, we don't really know where to
28563 display the cursor. */
28564 if (!glyph_row
->enabled_p
)
28566 w
->phys_cursor_on_p
= false;
28571 if (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
])
28572 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28574 eassert (input_blocked_p ());
28576 /* Set new_cursor_type to the cursor we want to be displayed. */
28577 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28578 &new_cursor_width
, &active_cursor
);
28580 /* If cursor is currently being shown and we don't want it to be or
28581 it is in the wrong place, or the cursor type is not what we want,
28583 if (w
->phys_cursor_on_p
28585 || w
->phys_cursor
.x
!= x
28586 || w
->phys_cursor
.y
!= y
28587 /* HPOS can be negative in R2L rows whose
28588 exact_window_width_line_p flag is set (i.e. their newline
28589 would "overflow into the fringe"). */
28591 || new_cursor_type
!= w
->phys_cursor_type
28592 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28593 && new_cursor_width
!= w
->phys_cursor_width
)))
28594 erase_phys_cursor (w
);
28596 /* Don't check phys_cursor_on_p here because that flag is only set
28597 to false in some cases where we know that the cursor has been
28598 completely erased, to avoid the extra work of erasing the cursor
28599 twice. In other words, phys_cursor_on_p can be true and the cursor
28600 still not be visible, or it has only been partly erased. */
28603 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28604 w
->phys_cursor_height
= glyph_row
->height
;
28606 /* Set phys_cursor_.* before x_draw_.* is called because some
28607 of them may need the information. */
28608 w
->phys_cursor
.x
= x
;
28609 w
->phys_cursor
.y
= glyph_row
->y
;
28610 w
->phys_cursor
.hpos
= hpos
;
28611 w
->phys_cursor
.vpos
= vpos
;
28614 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28615 new_cursor_type
, new_cursor_width
,
28616 on
, active_cursor
);
28620 /* Switch the display of W's cursor on or off, according to the value
28624 update_window_cursor (struct window
*w
, bool on
)
28626 /* Don't update cursor in windows whose frame is in the process
28627 of being deleted. */
28628 if (w
->current_matrix
)
28630 int hpos
= w
->phys_cursor
.hpos
;
28631 int vpos
= w
->phys_cursor
.vpos
;
28632 struct glyph_row
*row
;
28634 if (vpos
>= w
->current_matrix
->nrows
28635 || hpos
>= w
->current_matrix
->matrix_w
)
28638 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28640 /* When the window is hscrolled, cursor hpos can legitimately be
28641 out of bounds, but we draw the cursor at the corresponding
28642 window margin in that case. */
28643 if (!row
->reversed_p
&& hpos
< 0)
28645 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28646 hpos
= row
->used
[TEXT_AREA
] - 1;
28649 display_and_set_cursor (w
, on
, hpos
, vpos
,
28650 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28656 /* Call update_window_cursor with parameter ON_P on all leaf windows
28657 in the window tree rooted at W. */
28660 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28664 if (WINDOWP (w
->contents
))
28665 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28667 update_window_cursor (w
, on_p
);
28669 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28675 Display the cursor on window W, or clear it, according to ON_P.
28676 Don't change the cursor's position. */
28679 x_update_cursor (struct frame
*f
, bool on_p
)
28681 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28686 Clear the cursor of window W to background color, and mark the
28687 cursor as not shown. This is used when the text where the cursor
28688 is about to be rewritten. */
28691 x_clear_cursor (struct window
*w
)
28693 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28694 update_window_cursor (w
, false);
28697 #endif /* HAVE_WINDOW_SYSTEM */
28699 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28702 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28703 int start_hpos
, int end_hpos
,
28704 enum draw_glyphs_face draw
)
28706 #ifdef HAVE_WINDOW_SYSTEM
28707 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28709 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28713 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28714 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28718 /* Display the active region described by mouse_face_* according to DRAW. */
28721 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28723 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28724 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28726 if (/* If window is in the process of being destroyed, don't bother
28728 w
->current_matrix
!= NULL
28729 /* Don't update mouse highlight if hidden. */
28730 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28731 /* Recognize when we are called to operate on rows that don't exist
28732 anymore. This can happen when a window is split. */
28733 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28735 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28736 struct glyph_row
*row
, *first
, *last
;
28738 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28739 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28741 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28743 int start_hpos
, end_hpos
, start_x
;
28745 /* For all but the first row, the highlight starts at column 0. */
28748 /* R2L rows have BEG and END in reversed order, but the
28749 screen drawing geometry is always left to right. So
28750 we need to mirror the beginning and end of the
28751 highlighted area in R2L rows. */
28752 if (!row
->reversed_p
)
28754 start_hpos
= hlinfo
->mouse_face_beg_col
;
28755 start_x
= hlinfo
->mouse_face_beg_x
;
28757 else if (row
== last
)
28759 start_hpos
= hlinfo
->mouse_face_end_col
;
28760 start_x
= hlinfo
->mouse_face_end_x
;
28768 else if (row
->reversed_p
&& row
== last
)
28770 start_hpos
= hlinfo
->mouse_face_end_col
;
28771 start_x
= hlinfo
->mouse_face_end_x
;
28781 if (!row
->reversed_p
)
28782 end_hpos
= hlinfo
->mouse_face_end_col
;
28783 else if (row
== first
)
28784 end_hpos
= hlinfo
->mouse_face_beg_col
;
28787 end_hpos
= row
->used
[TEXT_AREA
];
28788 if (draw
== DRAW_NORMAL_TEXT
)
28789 row
->fill_line_p
= true; /* Clear to end of line. */
28792 else if (row
->reversed_p
&& row
== first
)
28793 end_hpos
= hlinfo
->mouse_face_beg_col
;
28796 end_hpos
= row
->used
[TEXT_AREA
];
28797 if (draw
== DRAW_NORMAL_TEXT
)
28798 row
->fill_line_p
= true; /* Clear to end of line. */
28801 if (end_hpos
> start_hpos
)
28803 draw_row_with_mouse_face (w
, start_x
, row
,
28804 start_hpos
, end_hpos
, draw
);
28807 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28811 /* When we've written over the cursor, arrange for it to
28812 be displayed again. */
28813 if (FRAME_WINDOW_P (f
)
28814 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28816 #ifdef HAVE_WINDOW_SYSTEM
28817 int hpos
= w
->phys_cursor
.hpos
;
28819 /* When the window is hscrolled, cursor hpos can legitimately be
28820 out of bounds, but we draw the cursor at the corresponding
28821 window margin in that case. */
28822 if (!row
->reversed_p
&& hpos
< 0)
28824 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28825 hpos
= row
->used
[TEXT_AREA
] - 1;
28828 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28829 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28831 #endif /* HAVE_WINDOW_SYSTEM */
28835 #ifdef HAVE_WINDOW_SYSTEM
28836 /* Change the mouse cursor. */
28837 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28839 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28840 if (draw
== DRAW_NORMAL_TEXT
28841 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28842 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28845 if (draw
== DRAW_MOUSE_FACE
)
28846 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28848 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28850 #endif /* HAVE_WINDOW_SYSTEM */
28854 Clear out the mouse-highlighted active region.
28855 Redraw it un-highlighted first. Value is true if mouse
28856 face was actually drawn unhighlighted. */
28859 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28862 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28864 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28865 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28866 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28867 hlinfo
->mouse_face_window
= Qnil
;
28868 hlinfo
->mouse_face_overlay
= Qnil
;
28872 /* Return true if the coordinates HPOS and VPOS on windows W are
28873 within the mouse face on that window. */
28875 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28877 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28879 /* Quickly resolve the easy cases. */
28880 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28881 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28883 if (vpos
< hlinfo
->mouse_face_beg_row
28884 || vpos
> hlinfo
->mouse_face_end_row
)
28886 if (vpos
> hlinfo
->mouse_face_beg_row
28887 && vpos
< hlinfo
->mouse_face_end_row
)
28890 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28892 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28894 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28897 else if ((vpos
== hlinfo
->mouse_face_beg_row
28898 && hpos
>= hlinfo
->mouse_face_beg_col
)
28899 || (vpos
== hlinfo
->mouse_face_end_row
28900 && hpos
< hlinfo
->mouse_face_end_col
))
28905 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28907 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28910 else if ((vpos
== hlinfo
->mouse_face_beg_row
28911 && hpos
<= hlinfo
->mouse_face_beg_col
)
28912 || (vpos
== hlinfo
->mouse_face_end_row
28913 && hpos
> hlinfo
->mouse_face_end_col
))
28921 True if physical cursor of window W is within mouse face. */
28924 cursor_in_mouse_face_p (struct window
*w
)
28926 int hpos
= w
->phys_cursor
.hpos
;
28927 int vpos
= w
->phys_cursor
.vpos
;
28928 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28930 /* When the window is hscrolled, cursor hpos can legitimately be out
28931 of bounds, but we draw the cursor at the corresponding window
28932 margin in that case. */
28933 if (!row
->reversed_p
&& hpos
< 0)
28935 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28936 hpos
= row
->used
[TEXT_AREA
] - 1;
28938 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28943 /* Find the glyph rows START_ROW and END_ROW of window W that display
28944 characters between buffer positions START_CHARPOS and END_CHARPOS
28945 (excluding END_CHARPOS). DISP_STRING is a display string that
28946 covers these buffer positions. This is similar to
28947 row_containing_pos, but is more accurate when bidi reordering makes
28948 buffer positions change non-linearly with glyph rows. */
28950 rows_from_pos_range (struct window
*w
,
28951 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28952 Lisp_Object disp_string
,
28953 struct glyph_row
**start
, struct glyph_row
**end
)
28955 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28956 int last_y
= window_text_bottom_y (w
);
28957 struct glyph_row
*row
;
28962 while (!first
->enabled_p
28963 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28966 /* Find the START row. */
28968 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28971 /* A row can potentially be the START row if the range of the
28972 characters it displays intersects the range
28973 [START_CHARPOS..END_CHARPOS). */
28974 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28975 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28976 /* See the commentary in row_containing_pos, for the
28977 explanation of the complicated way to check whether
28978 some position is beyond the end of the characters
28979 displayed by a row. */
28980 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28981 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28982 && !row
->ends_at_zv_p
28983 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28984 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28985 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28986 && !row
->ends_at_zv_p
28987 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28989 /* Found a candidate row. Now make sure at least one of the
28990 glyphs it displays has a charpos from the range
28991 [START_CHARPOS..END_CHARPOS).
28993 This is not obvious because bidi reordering could make
28994 buffer positions of a row be 1,2,3,102,101,100, and if we
28995 want to highlight characters in [50..60), we don't want
28996 this row, even though [50..60) does intersect [1..103),
28997 the range of character positions given by the row's start
28998 and end positions. */
28999 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
29000 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
29004 if (((BUFFERP (g
->object
) || NILP (g
->object
))
29005 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
29006 /* A glyph that comes from DISP_STRING is by
29007 definition to be highlighted. */
29008 || EQ (g
->object
, disp_string
))
29017 /* Find the END row. */
29019 /* If the last row is partially visible, start looking for END
29020 from that row, instead of starting from FIRST. */
29021 && !(row
->enabled_p
29022 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
29024 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
29026 struct glyph_row
*next
= row
+ 1;
29027 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
29029 if (!next
->enabled_p
29030 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
29031 /* The first row >= START whose range of displayed characters
29032 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
29033 is the row END + 1. */
29034 || (start_charpos
< next_start
29035 && end_charpos
< next_start
)
29036 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
29037 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
29038 && !next
->ends_at_zv_p
29039 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
29040 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
29041 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
29042 && !next
->ends_at_zv_p
29043 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
29050 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
29051 but none of the characters it displays are in the range, it is
29053 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
29054 struct glyph
*s
= g
;
29055 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
29059 if (((BUFFERP (g
->object
) || NILP (g
->object
))
29060 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
29061 /* If the buffer position of the first glyph in
29062 the row is equal to END_CHARPOS, it means
29063 the last character to be highlighted is the
29064 newline of ROW, and we must consider NEXT as
29066 || (((!next
->reversed_p
&& g
== s
)
29067 || (next
->reversed_p
&& g
== e
- 1))
29068 && (g
->charpos
== end_charpos
29069 /* Special case for when NEXT is an
29070 empty line at ZV. */
29071 || (g
->charpos
== -1
29072 && !row
->ends_at_zv_p
29073 && next_start
== end_charpos
)))))
29074 /* A glyph that comes from DISP_STRING is by
29075 definition to be highlighted. */
29076 || EQ (g
->object
, disp_string
))
29085 /* The first row that ends at ZV must be the last to be
29087 else if (next
->ends_at_zv_p
)
29096 /* This function sets the mouse_face_* elements of HLINFO, assuming
29097 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
29098 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
29099 for the overlay or run of text properties specifying the mouse
29100 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
29101 before-string and after-string that must also be highlighted.
29102 DISP_STRING, if non-nil, is a display string that may cover some
29103 or all of the highlighted text. */
29106 mouse_face_from_buffer_pos (Lisp_Object window
,
29107 Mouse_HLInfo
*hlinfo
,
29108 ptrdiff_t mouse_charpos
,
29109 ptrdiff_t start_charpos
,
29110 ptrdiff_t end_charpos
,
29111 Lisp_Object before_string
,
29112 Lisp_Object after_string
,
29113 Lisp_Object disp_string
)
29115 struct window
*w
= XWINDOW (window
);
29116 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29117 struct glyph_row
*r1
, *r2
;
29118 struct glyph
*glyph
, *end
;
29119 ptrdiff_t ignore
, pos
;
29122 eassert (NILP (disp_string
) || STRINGP (disp_string
));
29123 eassert (NILP (before_string
) || STRINGP (before_string
));
29124 eassert (NILP (after_string
) || STRINGP (after_string
));
29126 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
29127 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
29129 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29130 /* If the before-string or display-string contains newlines,
29131 rows_from_pos_range skips to its last row. Move back. */
29132 if (!NILP (before_string
) || !NILP (disp_string
))
29134 struct glyph_row
*prev
;
29135 while ((prev
= r1
- 1, prev
>= first
)
29136 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
29137 && prev
->used
[TEXT_AREA
] > 0)
29139 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
29140 glyph
= beg
+ prev
->used
[TEXT_AREA
];
29141 while (--glyph
>= beg
&& NILP (glyph
->object
));
29143 || !(EQ (glyph
->object
, before_string
)
29144 || EQ (glyph
->object
, disp_string
)))
29151 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29152 hlinfo
->mouse_face_past_end
= true;
29154 else if (!NILP (after_string
))
29156 /* If the after-string has newlines, advance to its last row. */
29157 struct glyph_row
*next
;
29158 struct glyph_row
*last
29159 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
29161 for (next
= r2
+ 1;
29163 && next
->used
[TEXT_AREA
] > 0
29164 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
29168 /* The rest of the display engine assumes that mouse_face_beg_row is
29169 either above mouse_face_end_row or identical to it. But with
29170 bidi-reordered continued lines, the row for START_CHARPOS could
29171 be below the row for END_CHARPOS. If so, swap the rows and store
29172 them in correct order. */
29175 struct glyph_row
*tem
= r2
;
29181 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
29182 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
29184 /* For a bidi-reordered row, the positions of BEFORE_STRING,
29185 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
29186 could be anywhere in the row and in any order. The strategy
29187 below is to find the leftmost and the rightmost glyph that
29188 belongs to either of these 3 strings, or whose position is
29189 between START_CHARPOS and END_CHARPOS, and highlight all the
29190 glyphs between those two. This may cover more than just the text
29191 between START_CHARPOS and END_CHARPOS if the range of characters
29192 strides the bidi level boundary, e.g. if the beginning is in R2L
29193 text while the end is in L2R text or vice versa. */
29194 if (!r1
->reversed_p
)
29196 /* This row is in a left to right paragraph. Scan it left to
29198 glyph
= r1
->glyphs
[TEXT_AREA
];
29199 end
= glyph
+ r1
->used
[TEXT_AREA
];
29202 /* Skip truncation glyphs at the start of the glyph row. */
29203 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29205 && NILP (glyph
->object
)
29206 && glyph
->charpos
< 0;
29208 x
+= glyph
->pixel_width
;
29210 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29211 or DISP_STRING, and the first glyph from buffer whose
29212 position is between START_CHARPOS and END_CHARPOS. */
29214 && !NILP (glyph
->object
)
29215 && !EQ (glyph
->object
, disp_string
)
29216 && !(BUFFERP (glyph
->object
)
29217 && (glyph
->charpos
>= start_charpos
29218 && glyph
->charpos
< end_charpos
));
29221 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29222 are present at buffer positions between START_CHARPOS and
29223 END_CHARPOS, or if they come from an overlay. */
29224 if (EQ (glyph
->object
, before_string
))
29226 pos
= string_buffer_position (before_string
,
29228 /* If pos == 0, it means before_string came from an
29229 overlay, not from a buffer position. */
29230 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29233 else if (EQ (glyph
->object
, after_string
))
29235 pos
= string_buffer_position (after_string
, end_charpos
);
29236 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29239 x
+= glyph
->pixel_width
;
29241 hlinfo
->mouse_face_beg_x
= x
;
29242 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29246 /* This row is in a right to left paragraph. Scan it right to
29250 end
= r1
->glyphs
[TEXT_AREA
] - 1;
29251 glyph
= end
+ r1
->used
[TEXT_AREA
];
29253 /* Skip truncation glyphs at the start of the glyph row. */
29254 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29256 && NILP (glyph
->object
)
29257 && glyph
->charpos
< 0;
29261 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29262 or DISP_STRING, and the first glyph from buffer whose
29263 position is between START_CHARPOS and END_CHARPOS. */
29265 && !NILP (glyph
->object
)
29266 && !EQ (glyph
->object
, disp_string
)
29267 && !(BUFFERP (glyph
->object
)
29268 && (glyph
->charpos
>= start_charpos
29269 && glyph
->charpos
< end_charpos
));
29272 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29273 are present at buffer positions between START_CHARPOS and
29274 END_CHARPOS, or if they come from an overlay. */
29275 if (EQ (glyph
->object
, before_string
))
29277 pos
= string_buffer_position (before_string
, start_charpos
);
29278 /* If pos == 0, it means before_string came from an
29279 overlay, not from a buffer position. */
29280 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29283 else if (EQ (glyph
->object
, after_string
))
29285 pos
= string_buffer_position (after_string
, end_charpos
);
29286 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29291 glyph
++; /* first glyph to the right of the highlighted area */
29292 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
29293 x
+= g
->pixel_width
;
29294 hlinfo
->mouse_face_beg_x
= x
;
29295 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29298 /* If the highlight ends in a different row, compute GLYPH and END
29299 for the end row. Otherwise, reuse the values computed above for
29300 the row where the highlight begins. */
29303 if (!r2
->reversed_p
)
29305 glyph
= r2
->glyphs
[TEXT_AREA
];
29306 end
= glyph
+ r2
->used
[TEXT_AREA
];
29311 end
= r2
->glyphs
[TEXT_AREA
] - 1;
29312 glyph
= end
+ r2
->used
[TEXT_AREA
];
29316 if (!r2
->reversed_p
)
29318 /* Skip truncation and continuation glyphs near the end of the
29319 row, and also blanks and stretch glyphs inserted by
29320 extend_face_to_end_of_line. */
29322 && NILP ((end
- 1)->object
))
29324 /* Scan the rest of the glyph row from the end, looking for the
29325 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29326 DISP_STRING, or whose position is between START_CHARPOS
29330 && !NILP (end
->object
)
29331 && !EQ (end
->object
, disp_string
)
29332 && !(BUFFERP (end
->object
)
29333 && (end
->charpos
>= start_charpos
29334 && end
->charpos
< end_charpos
));
29337 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29338 are present at buffer positions between START_CHARPOS and
29339 END_CHARPOS, or if they come from an overlay. */
29340 if (EQ (end
->object
, before_string
))
29342 pos
= string_buffer_position (before_string
, start_charpos
);
29343 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29346 else if (EQ (end
->object
, after_string
))
29348 pos
= string_buffer_position (after_string
, end_charpos
);
29349 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29353 /* Find the X coordinate of the last glyph to be highlighted. */
29354 for (; glyph
<= end
; ++glyph
)
29355 x
+= glyph
->pixel_width
;
29357 hlinfo
->mouse_face_end_x
= x
;
29358 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
29362 /* Skip truncation and continuation glyphs near the end of the
29363 row, and also blanks and stretch glyphs inserted by
29364 extend_face_to_end_of_line. */
29368 && NILP (end
->object
))
29370 x
+= end
->pixel_width
;
29373 /* Scan the rest of the glyph row from the end, looking for the
29374 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29375 DISP_STRING, or whose position is between START_CHARPOS
29379 && !NILP (end
->object
)
29380 && !EQ (end
->object
, disp_string
)
29381 && !(BUFFERP (end
->object
)
29382 && (end
->charpos
>= start_charpos
29383 && end
->charpos
< end_charpos
));
29386 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29387 are present at buffer positions between START_CHARPOS and
29388 END_CHARPOS, or if they come from an overlay. */
29389 if (EQ (end
->object
, before_string
))
29391 pos
= string_buffer_position (before_string
, start_charpos
);
29392 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29395 else if (EQ (end
->object
, after_string
))
29397 pos
= string_buffer_position (after_string
, end_charpos
);
29398 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29401 x
+= end
->pixel_width
;
29403 /* If we exited the above loop because we arrived at the last
29404 glyph of the row, and its buffer position is still not in
29405 range, it means the last character in range is the preceding
29406 newline. Bump the end column and x values to get past the
29409 && BUFFERP (end
->object
)
29410 && (end
->charpos
< start_charpos
29411 || end
->charpos
>= end_charpos
))
29413 x
+= end
->pixel_width
;
29416 hlinfo
->mouse_face_end_x
= x
;
29417 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
29420 hlinfo
->mouse_face_window
= window
;
29421 hlinfo
->mouse_face_face_id
29422 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
29424 !hlinfo
->mouse_face_hidden
, -1);
29425 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29428 /* The following function is not used anymore (replaced with
29429 mouse_face_from_string_pos), but I leave it here for the time
29430 being, in case someone would. */
29432 #if false /* not used */
29434 /* Find the position of the glyph for position POS in OBJECT in
29435 window W's current matrix, and return in *X, *Y the pixel
29436 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
29438 RIGHT_P means return the position of the right edge of the glyph.
29439 !RIGHT_P means return the left edge position.
29441 If no glyph for POS exists in the matrix, return the position of
29442 the glyph with the next smaller position that is in the matrix, if
29443 RIGHT_P is false. If RIGHT_P, and no glyph for POS
29444 exists in the matrix, return the position of the glyph with the
29445 next larger position in OBJECT.
29447 Value is true if a glyph was found. */
29450 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
29451 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
29453 int yb
= window_text_bottom_y (w
);
29454 struct glyph_row
*r
;
29455 struct glyph
*best_glyph
= NULL
;
29456 struct glyph_row
*best_row
= NULL
;
29459 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29460 r
->enabled_p
&& r
->y
< yb
;
29463 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
29464 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
29467 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29468 if (EQ (g
->object
, object
))
29470 if (g
->charpos
== pos
)
29477 else if (best_glyph
== NULL
29478 || ((eabs (g
->charpos
- pos
)
29479 < eabs (best_glyph
->charpos
- pos
))
29482 : g
->charpos
> pos
)))
29496 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
29500 *x
+= best_glyph
->pixel_width
;
29505 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
29508 return best_glyph
!= NULL
;
29510 #endif /* not used */
29512 /* Find the positions of the first and the last glyphs in window W's
29513 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29514 (assumed to be a string), and return in HLINFO's mouse_face_*
29515 members the pixel and column/row coordinates of those glyphs. */
29518 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29519 Lisp_Object object
,
29520 ptrdiff_t startpos
, ptrdiff_t endpos
)
29522 int yb
= window_text_bottom_y (w
);
29523 struct glyph_row
*r
;
29524 struct glyph
*g
, *e
;
29526 bool found
= false;
29528 /* Find the glyph row with at least one position in the range
29529 [STARTPOS..ENDPOS), and the first glyph in that row whose
29530 position belongs to that range. */
29531 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29532 r
->enabled_p
&& r
->y
< yb
;
29535 if (!r
->reversed_p
)
29537 g
= r
->glyphs
[TEXT_AREA
];
29538 e
= g
+ r
->used
[TEXT_AREA
];
29539 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29540 if (EQ (g
->object
, object
)
29541 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29543 hlinfo
->mouse_face_beg_row
29544 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29545 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29546 hlinfo
->mouse_face_beg_x
= gx
;
29555 e
= r
->glyphs
[TEXT_AREA
];
29556 g
= e
+ r
->used
[TEXT_AREA
];
29557 for ( ; g
> e
; --g
)
29558 if (EQ ((g
-1)->object
, object
)
29559 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29561 hlinfo
->mouse_face_beg_row
29562 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29563 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29564 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29565 gx
+= g1
->pixel_width
;
29566 hlinfo
->mouse_face_beg_x
= gx
;
29578 /* Starting with the next row, look for the first row which does NOT
29579 include any glyphs whose positions are in the range. */
29580 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29582 g
= r
->glyphs
[TEXT_AREA
];
29583 e
= g
+ r
->used
[TEXT_AREA
];
29585 for ( ; g
< e
; ++g
)
29586 if (EQ (g
->object
, object
)
29587 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29596 /* The highlighted region ends on the previous row. */
29599 /* Set the end row. */
29600 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29602 /* Compute and set the end column and the end column's horizontal
29603 pixel coordinate. */
29604 if (!r
->reversed_p
)
29606 g
= r
->glyphs
[TEXT_AREA
];
29607 e
= g
+ r
->used
[TEXT_AREA
];
29608 for ( ; e
> g
; --e
)
29609 if (EQ ((e
-1)->object
, object
)
29610 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29612 hlinfo
->mouse_face_end_col
= e
- g
;
29614 for (gx
= r
->x
; g
< e
; ++g
)
29615 gx
+= g
->pixel_width
;
29616 hlinfo
->mouse_face_end_x
= gx
;
29620 e
= r
->glyphs
[TEXT_AREA
];
29621 g
= e
+ r
->used
[TEXT_AREA
];
29622 for (gx
= r
->x
; e
< g
; ++e
)
29624 if (EQ (e
->object
, object
)
29625 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29627 gx
+= e
->pixel_width
;
29629 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29630 hlinfo
->mouse_face_end_x
= gx
;
29634 #ifdef HAVE_WINDOW_SYSTEM
29636 /* See if position X, Y is within a hot-spot of an image. */
29639 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29641 if (!CONSP (hot_spot
))
29644 if (EQ (XCAR (hot_spot
), Qrect
))
29646 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29647 Lisp_Object rect
= XCDR (hot_spot
);
29651 if (!CONSP (XCAR (rect
)))
29653 if (!CONSP (XCDR (rect
)))
29655 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29657 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29659 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29661 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29665 else if (EQ (XCAR (hot_spot
), Qcircle
))
29667 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29668 Lisp_Object circ
= XCDR (hot_spot
);
29669 Lisp_Object lr
, lx0
, ly0
;
29671 && CONSP (XCAR (circ
))
29672 && (lr
= XCDR (circ
), NUMBERP (lr
))
29673 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29674 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29676 double r
= XFLOATINT (lr
);
29677 double dx
= XINT (lx0
) - x
;
29678 double dy
= XINT (ly0
) - y
;
29679 return (dx
* dx
+ dy
* dy
<= r
* r
);
29682 else if (EQ (XCAR (hot_spot
), Qpoly
))
29684 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29685 if (VECTORP (XCDR (hot_spot
)))
29687 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29688 Lisp_Object
*poly
= v
->contents
;
29689 ptrdiff_t n
= v
->header
.size
;
29691 bool inside
= false;
29692 Lisp_Object lx
, ly
;
29695 /* Need an even number of coordinates, and at least 3 edges. */
29696 if (n
< 6 || n
& 1)
29699 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29700 If count is odd, we are inside polygon. Pixels on edges
29701 may or may not be included depending on actual geometry of the
29703 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29704 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29706 x0
= XINT (lx
), y0
= XINT (ly
);
29707 for (i
= 0; i
< n
; i
+= 2)
29709 int x1
= x0
, y1
= y0
;
29710 if ((lx
= poly
[i
], !INTEGERP (lx
))
29711 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29713 x0
= XINT (lx
), y0
= XINT (ly
);
29715 /* Does this segment cross the X line? */
29723 if (y
> y0
&& y
> y1
)
29725 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29735 find_hot_spot (Lisp_Object map
, int x
, int y
)
29737 while (CONSP (map
))
29739 if (CONSP (XCAR (map
))
29740 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29748 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29750 doc
: /* Lookup in image map MAP coordinates X and Y.
29751 An image map is an alist where each element has the format (AREA ID PLIST).
29752 An AREA is specified as either a rectangle, a circle, or a polygon:
29753 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29754 pixel coordinates of the upper left and bottom right corners.
29755 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29756 and the radius of the circle; r may be a float or integer.
29757 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29758 vector describes one corner in the polygon.
29759 Returns the alist element for the first matching AREA in MAP. */)
29760 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29768 return find_hot_spot (map
,
29769 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29770 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29772 #endif /* HAVE_WINDOW_SYSTEM */
29775 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29777 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29779 #ifdef HAVE_WINDOW_SYSTEM
29780 if (!FRAME_WINDOW_P (f
))
29783 /* Do not change cursor shape while dragging mouse. */
29784 if (EQ (do_mouse_tracking
, Qdragging
))
29787 if (!NILP (pointer
))
29789 if (EQ (pointer
, Qarrow
))
29790 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29791 else if (EQ (pointer
, Qhand
))
29792 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29793 else if (EQ (pointer
, Qtext
))
29794 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29795 else if (EQ (pointer
, intern ("hdrag")))
29796 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29797 else if (EQ (pointer
, intern ("nhdrag")))
29798 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29799 # ifdef HAVE_X_WINDOWS
29800 else if (EQ (pointer
, intern ("vdrag")))
29801 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29803 else if (EQ (pointer
, intern ("hourglass")))
29804 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29805 else if (EQ (pointer
, Qmodeline
))
29806 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29808 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29811 if (cursor
!= No_Cursor
)
29812 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29816 /* Take proper action when mouse has moved to the mode or header line
29817 or marginal area AREA of window W, x-position X and y-position Y.
29818 X is relative to the start of the text display area of W, so the
29819 width of bitmap areas and scroll bars must be subtracted to get a
29820 position relative to the start of the mode line. */
29823 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29824 enum window_part area
)
29826 struct window
*w
= XWINDOW (window
);
29827 struct frame
*f
= XFRAME (w
->frame
);
29828 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29829 #ifdef HAVE_WINDOW_SYSTEM
29830 Display_Info
*dpyinfo
;
29832 Cursor cursor
= No_Cursor
;
29833 Lisp_Object pointer
= Qnil
;
29834 int dx
, dy
, width
, height
;
29836 Lisp_Object string
, object
= Qnil
;
29837 Lisp_Object pos UNINIT
;
29838 Lisp_Object mouse_face
;
29839 int original_x_pixel
= x
;
29840 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29841 struct glyph_row
*row UNINIT
;
29843 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29848 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29849 returns them in row/column units! */
29850 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29851 &object
, &dx
, &dy
, &width
, &height
);
29853 row
= (area
== ON_MODE_LINE
29854 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29855 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29857 /* Find the glyph under the mouse pointer. */
29858 if (row
->mode_line_p
&& row
->enabled_p
)
29860 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29861 end
= glyph
+ row
->used
[TEXT_AREA
];
29863 for (x0
= original_x_pixel
;
29864 glyph
< end
&& x0
>= glyph
->pixel_width
;
29866 x0
-= glyph
->pixel_width
;
29874 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29875 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29876 returns them in row/column units! */
29877 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29878 &object
, &dx
, &dy
, &width
, &height
);
29881 Lisp_Object help
= Qnil
;
29883 #ifdef HAVE_WINDOW_SYSTEM
29884 if (IMAGEP (object
))
29886 Lisp_Object image_map
, hotspot
;
29887 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29889 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29891 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29895 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29896 If so, we could look for mouse-enter, mouse-leave
29897 properties in PLIST (and do something...). */
29898 hotspot
= XCDR (hotspot
);
29899 if (CONSP (hotspot
)
29900 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29902 pointer
= Fplist_get (plist
, Qpointer
);
29903 if (NILP (pointer
))
29905 help
= Fplist_get (plist
, Qhelp_echo
);
29908 help_echo_string
= help
;
29909 XSETWINDOW (help_echo_window
, w
);
29910 help_echo_object
= w
->contents
;
29911 help_echo_pos
= charpos
;
29915 if (NILP (pointer
))
29916 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29918 #endif /* HAVE_WINDOW_SYSTEM */
29920 if (STRINGP (string
))
29921 pos
= make_number (charpos
);
29923 /* Set the help text and mouse pointer. If the mouse is on a part
29924 of the mode line without any text (e.g. past the right edge of
29925 the mode line text), use the default help text and pointer. */
29926 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29928 /* Arrange to display the help by setting the global variables
29929 help_echo_string, help_echo_object, and help_echo_pos. */
29932 if (STRINGP (string
))
29933 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29937 help_echo_string
= help
;
29938 XSETWINDOW (help_echo_window
, w
);
29939 help_echo_object
= string
;
29940 help_echo_pos
= charpos
;
29942 else if (area
== ON_MODE_LINE
)
29944 Lisp_Object default_help
29945 = buffer_local_value (Qmode_line_default_help_echo
,
29948 if (STRINGP (default_help
))
29950 help_echo_string
= default_help
;
29951 XSETWINDOW (help_echo_window
, w
);
29952 help_echo_object
= Qnil
;
29953 help_echo_pos
= -1;
29958 #ifdef HAVE_WINDOW_SYSTEM
29959 /* Change the mouse pointer according to what is under it. */
29960 if (FRAME_WINDOW_P (f
))
29962 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29964 || NILP (Vresize_mini_windows
));
29966 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29967 if (STRINGP (string
))
29969 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29971 if (NILP (pointer
))
29972 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29974 /* Change the mouse pointer according to what is under X/Y. */
29976 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29979 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29980 if (!KEYMAPP (map
))
29981 map
= Fget_text_property (pos
, Qkeymap
, string
);
29982 if (!KEYMAPP (map
) && draggable
)
29983 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29986 else if (draggable
)
29987 /* Default mode-line pointer. */
29988 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29993 /* Change the mouse face according to what is under X/Y. */
29994 bool mouse_face_shown
= false;
29995 if (STRINGP (string
))
29997 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29998 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29999 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
30004 struct glyph
* tmp_glyph
;
30008 int total_pixel_width
;
30009 ptrdiff_t begpos
, endpos
, ignore
;
30013 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
30014 Qmouse_face
, string
, Qnil
);
30020 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
30022 endpos
= SCHARS (string
);
30026 /* Calculate the glyph position GPOS of GLYPH in the
30027 displayed string, relative to the beginning of the
30028 highlighted part of the string.
30030 Note: GPOS is different from CHARPOS. CHARPOS is the
30031 position of GLYPH in the internal string object. A mode
30032 line string format has structures which are converted to
30033 a flattened string by the Emacs Lisp interpreter. The
30034 internal string is an element of those structures. The
30035 displayed string is the flattened string. */
30036 tmp_glyph
= row_start_glyph
;
30037 while (tmp_glyph
< glyph
30038 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
30039 && begpos
<= tmp_glyph
->charpos
30040 && tmp_glyph
->charpos
< endpos
)))
30042 gpos
= glyph
- tmp_glyph
;
30044 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
30045 the highlighted part of the displayed string to which
30046 GLYPH belongs. Note: GSEQ_LENGTH is different from
30047 SCHARS (STRING), because the latter returns the length of
30048 the internal string. */
30049 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
30051 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
30052 && begpos
<= tmp_glyph
->charpos
30053 && tmp_glyph
->charpos
< endpos
));
30056 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
30058 /* Calculate the total pixel width of all the glyphs between
30059 the beginning of the highlighted area and GLYPH. */
30060 total_pixel_width
= 0;
30061 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
30062 total_pixel_width
+= tmp_glyph
->pixel_width
;
30064 /* Pre calculation of re-rendering position. Note: X is in
30065 column units here, after the call to mode_line_string or
30066 marginal_area_string. */
30068 vpos
= (area
== ON_MODE_LINE
30069 ? (w
->current_matrix
)->nrows
- 1
30072 /* If GLYPH's position is included in the region that is
30073 already drawn in mouse face, we have nothing to do. */
30074 if ( EQ (window
, hlinfo
->mouse_face_window
)
30075 && (!row
->reversed_p
30076 ? (hlinfo
->mouse_face_beg_col
<= hpos
30077 && hpos
< hlinfo
->mouse_face_end_col
)
30078 /* In R2L rows we swap BEG and END, see below. */
30079 : (hlinfo
->mouse_face_end_col
<= hpos
30080 && hpos
< hlinfo
->mouse_face_beg_col
))
30081 && hlinfo
->mouse_face_beg_row
== vpos
)
30084 if (clear_mouse_face (hlinfo
))
30085 cursor
= No_Cursor
;
30087 if (!row
->reversed_p
)
30089 hlinfo
->mouse_face_beg_col
= hpos
;
30090 hlinfo
->mouse_face_beg_x
= original_x_pixel
30091 - (total_pixel_width
+ dx
);
30092 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
30093 hlinfo
->mouse_face_end_x
= 0;
30097 /* In R2L rows, show_mouse_face expects BEG and END
30098 coordinates to be swapped. */
30099 hlinfo
->mouse_face_end_col
= hpos
;
30100 hlinfo
->mouse_face_end_x
= original_x_pixel
30101 - (total_pixel_width
+ dx
);
30102 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
30103 hlinfo
->mouse_face_beg_x
= 0;
30106 hlinfo
->mouse_face_beg_row
= vpos
;
30107 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
30108 hlinfo
->mouse_face_past_end
= false;
30109 hlinfo
->mouse_face_window
= window
;
30111 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
30116 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30117 mouse_face_shown
= true;
30119 if (NILP (pointer
))
30124 /* If mouse-face doesn't need to be shown, clear any existing
30126 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
30127 clear_mouse_face (hlinfo
);
30129 define_frame_cursor1 (f
, cursor
, pointer
);
30134 Take proper action when the mouse has moved to position X, Y on
30135 frame F with regards to highlighting portions of display that have
30136 mouse-face properties. Also de-highlight portions of display where
30137 the mouse was before, set the mouse pointer shape as appropriate
30138 for the mouse coordinates, and activate help echo (tooltips).
30139 X and Y can be negative or out of range. */
30142 note_mouse_highlight (struct frame
*f
, int x
, int y
)
30144 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30145 enum window_part part
= ON_NOTHING
;
30146 Lisp_Object window
;
30148 Cursor cursor
= No_Cursor
;
30149 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
30152 /* When a menu is active, don't highlight because this looks odd. */
30153 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
30154 if (popup_activated ())
30158 if (!f
->glyphs_initialized_p
30159 || f
->pointer_invisible
)
30162 hlinfo
->mouse_face_mouse_x
= x
;
30163 hlinfo
->mouse_face_mouse_y
= y
;
30164 hlinfo
->mouse_face_mouse_frame
= f
;
30166 if (hlinfo
->mouse_face_defer
)
30169 /* Which window is that in? */
30170 window
= window_from_coordinates (f
, x
, y
, &part
, true);
30172 /* If displaying active text in another window, clear that. */
30173 if (! EQ (window
, hlinfo
->mouse_face_window
)
30174 /* Also clear if we move out of text area in same window. */
30175 || (!NILP (hlinfo
->mouse_face_window
)
30178 && part
!= ON_MODE_LINE
30179 && part
!= ON_HEADER_LINE
))
30180 clear_mouse_face (hlinfo
);
30182 /* Not on a window -> return. */
30183 if (!WINDOWP (window
))
30186 /* Reset help_echo_string. It will get recomputed below. */
30187 help_echo_string
= Qnil
;
30189 /* Convert to window-relative pixel coordinates. */
30190 w
= XWINDOW (window
);
30191 frame_to_window_pixel_xy (w
, &x
, &y
);
30193 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
30194 /* Handle tool-bar window differently since it doesn't display a
30196 if (EQ (window
, f
->tool_bar_window
))
30198 note_tool_bar_highlight (f
, x
, y
);
30203 /* Mouse is on the mode, header line or margin? */
30204 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
30205 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30207 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
30209 #ifdef HAVE_WINDOW_SYSTEM
30210 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
30212 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30213 /* Show non-text cursor (Bug#16647). */
30221 #ifdef HAVE_WINDOW_SYSTEM
30222 if (part
== ON_VERTICAL_BORDER
)
30224 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30225 help_echo_string
= build_string ("drag-mouse-1: resize");
30227 else if (part
== ON_RIGHT_DIVIDER
)
30229 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30230 help_echo_string
= build_string ("drag-mouse-1: resize");
30232 else if (part
== ON_BOTTOM_DIVIDER
)
30233 if (! WINDOW_BOTTOMMOST_P (w
)
30235 || NILP (Vresize_mini_windows
))
30237 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
30238 help_echo_string
= build_string ("drag-mouse-1: resize");
30241 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30242 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
30243 || part
== ON_VERTICAL_SCROLL_BAR
30244 || part
== ON_HORIZONTAL_SCROLL_BAR
)
30245 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30247 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
30250 /* Are we in a window whose display is up to date?
30251 And verify the buffer's text has not changed. */
30252 b
= XBUFFER (w
->contents
);
30253 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
30255 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
30257 struct glyph
*glyph
;
30258 Lisp_Object object
;
30259 Lisp_Object mouse_face
= Qnil
, position
;
30260 Lisp_Object
*overlay_vec
= NULL
;
30261 ptrdiff_t i
, noverlays
;
30262 struct buffer
*obuf
;
30263 ptrdiff_t obegv
, ozv
;
30266 /* Find the glyph under X/Y. */
30267 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
30269 #ifdef HAVE_WINDOW_SYSTEM
30270 /* Look for :pointer property on image. */
30271 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
30273 struct image
*img
= IMAGE_OPT_FROM_ID (f
, glyph
->u
.img_id
);
30274 if (img
!= NULL
&& IMAGEP (img
->spec
))
30276 Lisp_Object image_map
, hotspot
;
30277 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
30279 && (hotspot
= find_hot_spot (image_map
,
30280 glyph
->slice
.img
.x
+ dx
,
30281 glyph
->slice
.img
.y
+ dy
),
30283 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
30287 /* Could check XCAR (hotspot) to see if we enter/leave
30289 If so, we could look for mouse-enter, mouse-leave
30290 properties in PLIST (and do something...). */
30291 hotspot
= XCDR (hotspot
);
30292 if (CONSP (hotspot
)
30293 && (plist
= XCAR (hotspot
), CONSP (plist
)))
30295 pointer
= Fplist_get (plist
, Qpointer
);
30296 if (NILP (pointer
))
30298 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
30299 if (!NILP (help_echo_string
))
30301 help_echo_window
= window
;
30302 help_echo_object
= glyph
->object
;
30303 help_echo_pos
= glyph
->charpos
;
30307 if (NILP (pointer
))
30308 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
30311 #endif /* HAVE_WINDOW_SYSTEM */
30313 /* Clear mouse face if X/Y not over text. */
30315 || area
!= TEXT_AREA
30316 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
30317 /* Glyph's OBJECT is nil for glyphs inserted by the
30318 display engine for its internal purposes, like truncation
30319 and continuation glyphs and blanks beyond the end of
30320 line's text on text terminals. If we are over such a
30321 glyph, we are not over any text. */
30322 || NILP (glyph
->object
)
30323 /* R2L rows have a stretch glyph at their front, which
30324 stands for no text, whereas L2R rows have no glyphs at
30325 all beyond the end of text. Treat such stretch glyphs
30326 like we do with NULL glyphs in L2R rows. */
30327 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
30328 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
30329 && glyph
->type
== STRETCH_GLYPH
30330 && glyph
->avoid_cursor_p
))
30332 if (clear_mouse_face (hlinfo
))
30333 cursor
= No_Cursor
;
30334 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30336 #ifdef HAVE_WINDOW_SYSTEM
30337 if (area
!= TEXT_AREA
)
30338 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30340 pointer
= Vvoid_text_area_pointer
;
30346 pos
= glyph
->charpos
;
30347 object
= glyph
->object
;
30348 if (!STRINGP (object
) && !BUFFERP (object
))
30351 /* If we get an out-of-range value, return now; avoid an error. */
30352 if (BUFFERP (object
) && pos
> BUF_Z (b
))
30355 /* Make the window's buffer temporarily current for
30356 overlays_at and compute_char_face. */
30357 obuf
= current_buffer
;
30358 current_buffer
= b
;
30364 /* Is this char mouse-active or does it have help-echo? */
30365 position
= make_number (pos
);
30369 if (BUFFERP (object
))
30371 /* Put all the overlays we want in a vector in overlay_vec. */
30372 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
30373 /* Sort overlays into increasing priority order. */
30374 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
30379 if (NILP (Vmouse_highlight
))
30381 clear_mouse_face (hlinfo
);
30382 goto check_help_echo
;
30385 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
30388 cursor
= No_Cursor
;
30390 /* Check mouse-face highlighting. */
30392 /* If there exists an overlay with mouse-face overlapping
30393 the one we are currently highlighting, we have to
30394 check if we enter the overlapping overlay, and then
30395 highlight only that. */
30396 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
30397 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
30399 /* Find the highest priority overlay with a mouse-face. */
30400 Lisp_Object overlay
= Qnil
;
30401 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
30403 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
30404 if (!NILP (mouse_face
))
30405 overlay
= overlay_vec
[i
];
30408 /* If we're highlighting the same overlay as before, there's
30409 no need to do that again. */
30410 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
30411 goto check_help_echo
;
30412 hlinfo
->mouse_face_overlay
= overlay
;
30414 /* Clear the display of the old active region, if any. */
30415 if (clear_mouse_face (hlinfo
))
30416 cursor
= No_Cursor
;
30418 /* If no overlay applies, get a text property. */
30419 if (NILP (overlay
))
30420 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
30422 /* Next, compute the bounds of the mouse highlighting and
30424 if (!NILP (mouse_face
) && STRINGP (object
))
30426 /* The mouse-highlighting comes from a display string
30427 with a mouse-face. */
30431 s
= Fprevious_single_property_change
30432 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
30433 e
= Fnext_single_property_change
30434 (position
, Qmouse_face
, object
, Qnil
);
30436 s
= make_number (0);
30438 e
= make_number (SCHARS (object
));
30439 mouse_face_from_string_pos (w
, hlinfo
, object
,
30440 XINT (s
), XINT (e
));
30441 hlinfo
->mouse_face_past_end
= false;
30442 hlinfo
->mouse_face_window
= window
;
30443 hlinfo
->mouse_face_face_id
30444 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
30445 glyph
->face_id
, true);
30446 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30447 cursor
= No_Cursor
;
30451 /* The mouse-highlighting, if any, comes from an overlay
30452 or text property in the buffer. */
30453 Lisp_Object buffer UNINIT
;
30454 Lisp_Object disp_string UNINIT
;
30456 if (STRINGP (object
))
30458 /* If we are on a display string with no mouse-face,
30459 check if the text under it has one. */
30460 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
30461 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30462 pos
= string_buffer_position (object
, start
);
30465 mouse_face
= get_char_property_and_overlay
30466 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
30467 buffer
= w
->contents
;
30468 disp_string
= object
;
30474 disp_string
= Qnil
;
30477 if (!NILP (mouse_face
))
30479 Lisp_Object before
, after
;
30480 Lisp_Object before_string
, after_string
;
30481 /* To correctly find the limits of mouse highlight
30482 in a bidi-reordered buffer, we must not use the
30483 optimization of limiting the search in
30484 previous-single-property-change and
30485 next-single-property-change, because
30486 rows_from_pos_range needs the real start and end
30487 positions to DTRT in this case. That's because
30488 the first row visible in a window does not
30489 necessarily display the character whose position
30490 is the smallest. */
30492 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30493 ? Fmarker_position (w
->start
)
30496 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30497 ? make_number (BUF_Z (XBUFFER (buffer
))
30498 - w
->window_end_pos
)
30501 if (NILP (overlay
))
30503 /* Handle the text property case. */
30504 before
= Fprevious_single_property_change
30505 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
30506 after
= Fnext_single_property_change
30507 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
30508 before_string
= after_string
= Qnil
;
30512 /* Handle the overlay case. */
30513 before
= Foverlay_start (overlay
);
30514 after
= Foverlay_end (overlay
);
30515 before_string
= Foverlay_get (overlay
, Qbefore_string
);
30516 after_string
= Foverlay_get (overlay
, Qafter_string
);
30518 if (!STRINGP (before_string
)) before_string
= Qnil
;
30519 if (!STRINGP (after_string
)) after_string
= Qnil
;
30522 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30525 : XFASTINT (before
),
30527 ? BUF_Z (XBUFFER (buffer
))
30528 : XFASTINT (after
),
30529 before_string
, after_string
,
30531 cursor
= No_Cursor
;
30538 /* Look for a `help-echo' property. */
30539 if (NILP (help_echo_string
)) {
30540 Lisp_Object help
, overlay
;
30542 /* Check overlays first. */
30543 help
= overlay
= Qnil
;
30544 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30546 overlay
= overlay_vec
[i
];
30547 help
= Foverlay_get (overlay
, Qhelp_echo
);
30552 help_echo_string
= help
;
30553 help_echo_window
= window
;
30554 help_echo_object
= overlay
;
30555 help_echo_pos
= pos
;
30559 Lisp_Object obj
= glyph
->object
;
30560 ptrdiff_t charpos
= glyph
->charpos
;
30562 /* Try text properties. */
30565 && charpos
< SCHARS (obj
))
30567 help
= Fget_text_property (make_number (charpos
),
30571 /* If the string itself doesn't specify a help-echo,
30572 see if the buffer text ``under'' it does. */
30573 struct glyph_row
*r
30574 = MATRIX_ROW (w
->current_matrix
, vpos
);
30575 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30576 ptrdiff_t p
= string_buffer_position (obj
, start
);
30579 help
= Fget_char_property (make_number (p
),
30580 Qhelp_echo
, w
->contents
);
30589 else if (BUFFERP (obj
)
30592 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30597 help_echo_string
= help
;
30598 help_echo_window
= window
;
30599 help_echo_object
= obj
;
30600 help_echo_pos
= charpos
;
30605 #ifdef HAVE_WINDOW_SYSTEM
30606 /* Look for a `pointer' property. */
30607 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30609 /* Check overlays first. */
30610 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30611 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30613 if (NILP (pointer
))
30615 Lisp_Object obj
= glyph
->object
;
30616 ptrdiff_t charpos
= glyph
->charpos
;
30618 /* Try text properties. */
30621 && charpos
< SCHARS (obj
))
30623 pointer
= Fget_text_property (make_number (charpos
),
30625 if (NILP (pointer
))
30627 /* If the string itself doesn't specify a pointer,
30628 see if the buffer text ``under'' it does. */
30629 struct glyph_row
*r
30630 = MATRIX_ROW (w
->current_matrix
, vpos
);
30631 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30632 ptrdiff_t p
= string_buffer_position (obj
, start
);
30634 pointer
= Fget_char_property (make_number (p
),
30635 Qpointer
, w
->contents
);
30638 else if (BUFFERP (obj
)
30641 pointer
= Fget_text_property (make_number (charpos
),
30645 #endif /* HAVE_WINDOW_SYSTEM */
30649 current_buffer
= obuf
;
30654 define_frame_cursor1 (f
, cursor
, pointer
);
30659 Clear any mouse-face on window W. This function is part of the
30660 redisplay interface, and is called from try_window_id and similar
30661 functions to ensure the mouse-highlight is off. */
30664 x_clear_window_mouse_face (struct window
*w
)
30666 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30667 Lisp_Object window
;
30670 XSETWINDOW (window
, w
);
30671 if (EQ (window
, hlinfo
->mouse_face_window
))
30672 clear_mouse_face (hlinfo
);
30678 Just discard the mouse face information for frame F, if any.
30679 This is used when the size of F is changed. */
30682 cancel_mouse_face (struct frame
*f
)
30684 Lisp_Object window
;
30685 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30687 window
= hlinfo
->mouse_face_window
;
30688 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30689 reset_mouse_highlight (hlinfo
);
30694 /***********************************************************************
30696 ***********************************************************************/
30698 #ifdef HAVE_WINDOW_SYSTEM
30700 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30701 which intersects rectangle R. R is in window-relative coordinates. */
30704 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30705 enum glyph_row_area area
)
30707 struct glyph
*first
= row
->glyphs
[area
];
30708 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30709 struct glyph
*last
;
30710 int first_x
, start_x
, x
;
30712 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30713 /* If row extends face to end of line write the whole line. */
30714 draw_glyphs (w
, 0, row
, area
,
30715 0, row
->used
[area
],
30716 DRAW_NORMAL_TEXT
, 0);
30719 /* Set START_X to the window-relative start position for drawing glyphs of
30720 AREA. The first glyph of the text area can be partially visible.
30721 The first glyphs of other areas cannot. */
30722 start_x
= window_box_left_offset (w
, area
);
30724 if (area
== TEXT_AREA
)
30727 /* Find the first glyph that must be redrawn. */
30729 && x
+ first
->pixel_width
< r
->x
)
30731 x
+= first
->pixel_width
;
30735 /* Find the last one. */
30738 /* Use a signed int intermediate value to avoid catastrophic
30739 failures due to comparison between signed and unsigned, when
30740 x is negative (can happen for wide images that are hscrolled). */
30741 int r_end
= r
->x
+ r
->width
;
30742 while (last
< end
&& x
< r_end
)
30744 x
+= last
->pixel_width
;
30750 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30751 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30752 DRAW_NORMAL_TEXT
, 0);
30757 /* Redraw the parts of the glyph row ROW on window W intersecting
30758 rectangle R. R is in window-relative coordinates. Value is
30759 true if mouse-face was overwritten. */
30762 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30764 eassert (row
->enabled_p
);
30766 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30767 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30768 0, row
->used
[TEXT_AREA
],
30769 DRAW_NORMAL_TEXT
, 0);
30772 if (row
->used
[LEFT_MARGIN_AREA
])
30773 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30774 if (row
->used
[TEXT_AREA
])
30775 expose_area (w
, row
, r
, TEXT_AREA
);
30776 if (row
->used
[RIGHT_MARGIN_AREA
])
30777 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30778 draw_row_fringe_bitmaps (w
, row
);
30781 return row
->mouse_face_p
;
30785 /* Redraw those parts of glyphs rows during expose event handling that
30786 overlap other rows. Redrawing of an exposed line writes over parts
30787 of lines overlapping that exposed line; this function fixes that.
30789 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30790 row in W's current matrix that is exposed and overlaps other rows.
30791 LAST_OVERLAPPING_ROW is the last such row. */
30794 expose_overlaps (struct window
*w
,
30795 struct glyph_row
*first_overlapping_row
,
30796 struct glyph_row
*last_overlapping_row
,
30799 struct glyph_row
*row
;
30801 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30802 if (row
->overlapping_p
)
30804 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30807 if (row
->used
[LEFT_MARGIN_AREA
])
30808 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30810 if (row
->used
[TEXT_AREA
])
30811 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30813 if (row
->used
[RIGHT_MARGIN_AREA
])
30814 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30820 /* Return true if W's cursor intersects rectangle R. */
30823 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30825 XRectangle cr
, result
;
30826 struct glyph
*cursor_glyph
;
30827 struct glyph_row
*row
;
30829 if (w
->phys_cursor
.vpos
>= 0
30830 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30831 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30833 && row
->cursor_in_fringe_p
)
30835 /* Cursor is in the fringe. */
30836 cr
.x
= window_box_right_offset (w
,
30837 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30838 ? RIGHT_MARGIN_AREA
30841 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30842 cr
.height
= row
->height
;
30843 return x_intersect_rectangles (&cr
, r
, &result
);
30846 cursor_glyph
= get_phys_cursor_glyph (w
);
30849 /* r is relative to W's box, but w->phys_cursor.x is relative
30850 to left edge of W's TEXT area. Adjust it. */
30851 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30852 cr
.y
= w
->phys_cursor
.y
;
30853 cr
.width
= cursor_glyph
->pixel_width
;
30854 cr
.height
= w
->phys_cursor_height
;
30855 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30856 I assume the effect is the same -- and this is portable. */
30857 return x_intersect_rectangles (&cr
, r
, &result
);
30859 /* If we don't understand the format, pretend we're not in the hot-spot. */
30865 Draw a vertical window border to the right of window W if W doesn't
30866 have vertical scroll bars. */
30869 x_draw_vertical_border (struct window
*w
)
30871 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30873 /* We could do better, if we knew what type of scroll-bar the adjacent
30874 windows (on either side) have... But we don't :-(
30875 However, I think this works ok. ++KFS 2003-04-25 */
30877 /* Redraw borders between horizontally adjacent windows. Don't
30878 do it for frames with vertical scroll bars because either the
30879 right scroll bar of a window, or the left scroll bar of its
30880 neighbor will suffice as a border. */
30881 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30884 /* Note: It is necessary to redraw both the left and the right
30885 borders, for when only this single window W is being
30887 if (!WINDOW_RIGHTMOST_P (w
)
30888 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30890 int x0
, x1
, y0
, y1
;
30892 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30895 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30898 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30901 if (!WINDOW_LEFTMOST_P (w
)
30902 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30904 int x0
, x1
, y0
, y1
;
30906 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30909 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30912 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30917 /* Draw window dividers for window W. */
30920 x_draw_right_divider (struct window
*w
)
30922 struct frame
*f
= WINDOW_XFRAME (w
);
30924 if (w
->mini
|| w
->pseudo_window_p
)
30926 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30928 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30929 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30930 int y0
= WINDOW_TOP_EDGE_Y (w
);
30931 /* The bottom divider prevails. */
30932 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30934 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30939 x_draw_bottom_divider (struct window
*w
)
30941 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30943 if (w
->mini
|| w
->pseudo_window_p
)
30945 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30947 int x0
= WINDOW_LEFT_EDGE_X (w
);
30948 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30949 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30950 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30952 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30956 /* Redraw the part of window W intersection rectangle FR. Pixel
30957 coordinates in FR are frame-relative. Call this function with
30958 input blocked. Value is true if the exposure overwrites
30962 expose_window (struct window
*w
, XRectangle
*fr
)
30964 struct frame
*f
= XFRAME (w
->frame
);
30966 bool mouse_face_overwritten_p
= false;
30968 /* If window is not yet fully initialized, do nothing. This can
30969 happen when toolkit scroll bars are used and a window is split.
30970 Reconfiguring the scroll bar will generate an expose for a newly
30972 if (w
->current_matrix
== NULL
)
30975 /* When we're currently updating the window, display and current
30976 matrix usually don't agree. Arrange for a thorough display
30978 if (w
->must_be_updated_p
)
30980 SET_FRAME_GARBAGED (f
);
30984 /* Frame-relative pixel rectangle of W. */
30985 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30986 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30987 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30988 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30990 if (x_intersect_rectangles (fr
, &wr
, &r
))
30992 int yb
= window_text_bottom_y (w
);
30993 struct glyph_row
*row
;
30994 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30996 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30997 r
.x
, r
.y
, r
.width
, r
.height
));
30999 /* Convert to window coordinates. */
31000 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
31001 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
31003 /* Turn off the cursor. */
31004 bool cursor_cleared_p
= (!w
->pseudo_window_p
31005 && phys_cursor_in_rect_p (w
, &r
));
31006 if (cursor_cleared_p
)
31007 x_clear_cursor (w
);
31009 /* If the row containing the cursor extends face to end of line,
31010 then expose_area might overwrite the cursor outside the
31011 rectangle and thus notice_overwritten_cursor might clear
31012 w->phys_cursor_on_p. We remember the original value and
31013 check later if it is changed. */
31014 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
31016 /* Use a signed int intermediate value to avoid catastrophic
31017 failures due to comparison between signed and unsigned, when
31018 y0 or y1 is negative (can happen for tall images). */
31019 int r_bottom
= r
.y
+ r
.height
;
31021 /* Update lines intersecting rectangle R. */
31022 first_overlapping_row
= last_overlapping_row
= NULL
;
31023 for (row
= w
->current_matrix
->rows
;
31028 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
31030 if ((y0
>= r
.y
&& y0
< r_bottom
)
31031 || (y1
> r
.y
&& y1
< r_bottom
)
31032 || (r
.y
>= y0
&& r
.y
< y1
)
31033 || (r_bottom
> y0
&& r_bottom
< y1
))
31035 /* A header line may be overlapping, but there is no need
31036 to fix overlapping areas for them. KFS 2005-02-12 */
31037 if (row
->overlapping_p
&& !row
->mode_line_p
)
31039 if (first_overlapping_row
== NULL
)
31040 first_overlapping_row
= row
;
31041 last_overlapping_row
= row
;
31045 if (expose_line (w
, row
, &r
))
31046 mouse_face_overwritten_p
= true;
31049 else if (row
->overlapping_p
)
31051 /* We must redraw a row overlapping the exposed area. */
31053 ? y0
+ row
->phys_height
> r
.y
31054 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
31056 if (first_overlapping_row
== NULL
)
31057 first_overlapping_row
= row
;
31058 last_overlapping_row
= row
;
31066 /* Display the mode line if there is one. */
31067 if (WINDOW_WANTS_MODELINE_P (w
)
31068 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
31070 && row
->y
< r_bottom
)
31072 if (expose_line (w
, row
, &r
))
31073 mouse_face_overwritten_p
= true;
31076 if (!w
->pseudo_window_p
)
31078 /* Fix the display of overlapping rows. */
31079 if (first_overlapping_row
)
31080 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
31083 /* Draw border between windows. */
31084 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
31085 x_draw_right_divider (w
);
31087 x_draw_vertical_border (w
);
31089 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
31090 x_draw_bottom_divider (w
);
31092 /* Turn the cursor on again. */
31093 if (cursor_cleared_p
31094 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
31095 update_window_cursor (w
, true);
31099 return mouse_face_overwritten_p
;
31104 /* Redraw (parts) of all windows in the window tree rooted at W that
31105 intersect R. R contains frame pixel coordinates. Value is
31106 true if the exposure overwrites mouse-face. */
31109 expose_window_tree (struct window
*w
, XRectangle
*r
)
31111 struct frame
*f
= XFRAME (w
->frame
);
31112 bool mouse_face_overwritten_p
= false;
31114 while (w
&& !FRAME_GARBAGED_P (f
))
31116 mouse_face_overwritten_p
31117 |= (WINDOWP (w
->contents
)
31118 ? expose_window_tree (XWINDOW (w
->contents
), r
)
31119 : expose_window (w
, r
));
31121 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
31124 return mouse_face_overwritten_p
;
31129 Redisplay an exposed area of frame F. X and Y are the upper-left
31130 corner of the exposed rectangle. W and H are width and height of
31131 the exposed area. All are pixel values. W or H zero means redraw
31132 the entire frame. */
31135 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
31138 bool mouse_face_overwritten_p
= false;
31140 TRACE ((stderr
, "expose_frame "));
31142 /* No need to redraw if frame will be redrawn soon. */
31143 if (FRAME_GARBAGED_P (f
))
31145 TRACE ((stderr
, " garbaged\n"));
31149 /* If basic faces haven't been realized yet, there is no point in
31150 trying to redraw anything. This can happen when we get an expose
31151 event while Emacs is starting, e.g. by moving another window. */
31152 if (FRAME_FACE_CACHE (f
) == NULL
31153 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
31155 TRACE ((stderr
, " no faces\n"));
31159 if (w
== 0 || h
== 0)
31162 r
.width
= FRAME_TEXT_WIDTH (f
);
31163 r
.height
= FRAME_TEXT_HEIGHT (f
);
31173 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
31174 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
31176 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
31177 if (WINDOWP (f
->tool_bar_window
))
31178 mouse_face_overwritten_p
31179 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
31182 #ifdef HAVE_X_WINDOWS
31184 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
31185 if (WINDOWP (f
->menu_bar_window
))
31186 mouse_face_overwritten_p
31187 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
31188 #endif /* not USE_X_TOOLKIT and not USE_GTK */
31192 /* Some window managers support a focus-follows-mouse style with
31193 delayed raising of frames. Imagine a partially obscured frame,
31194 and moving the mouse into partially obscured mouse-face on that
31195 frame. The visible part of the mouse-face will be highlighted,
31196 then the WM raises the obscured frame. With at least one WM, KDE
31197 2.1, Emacs is not getting any event for the raising of the frame
31198 (even tried with SubstructureRedirectMask), only Expose events.
31199 These expose events will draw text normally, i.e. not
31200 highlighted. Which means we must redo the highlight here.
31201 Subsume it under ``we love X''. --gerd 2001-08-15 */
31202 /* Included in Windows version because Windows most likely does not
31203 do the right thing if any third party tool offers
31204 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
31205 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
31207 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
31208 if (f
== hlinfo
->mouse_face_mouse_frame
)
31210 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
31211 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
31212 clear_mouse_face (hlinfo
);
31213 note_mouse_highlight (f
, mouse_x
, mouse_y
);
31220 Determine the intersection of two rectangles R1 and R2. Return
31221 the intersection in *RESULT. Value is true if RESULT is not
31225 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
31227 XRectangle
*left
, *right
;
31228 XRectangle
*upper
, *lower
;
31229 bool intersection_p
= false;
31231 /* Rearrange so that R1 is the left-most rectangle. */
31233 left
= r1
, right
= r2
;
31235 left
= r2
, right
= r1
;
31237 /* X0 of the intersection is right.x0, if this is inside R1,
31238 otherwise there is no intersection. */
31239 if (right
->x
<= left
->x
+ left
->width
)
31241 result
->x
= right
->x
;
31243 /* The right end of the intersection is the minimum of
31244 the right ends of left and right. */
31245 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
31248 /* Same game for Y. */
31250 upper
= r1
, lower
= r2
;
31252 upper
= r2
, lower
= r1
;
31254 /* The upper end of the intersection is lower.y0, if this is inside
31255 of upper. Otherwise, there is no intersection. */
31256 if (lower
->y
<= upper
->y
+ upper
->height
)
31258 result
->y
= lower
->y
;
31260 /* The lower end of the intersection is the minimum of the lower
31261 ends of upper and lower. */
31262 result
->height
= (min (lower
->y
+ lower
->height
,
31263 upper
->y
+ upper
->height
)
31265 intersection_p
= true;
31269 return intersection_p
;
31272 #endif /* HAVE_WINDOW_SYSTEM */
31275 /***********************************************************************
31277 ***********************************************************************/
31280 syms_of_xdisp (void)
31282 Vwith_echo_area_save_vector
= Qnil
;
31283 staticpro (&Vwith_echo_area_save_vector
);
31285 Vmessage_stack
= Qnil
;
31286 staticpro (&Vmessage_stack
);
31288 /* Non-nil means don't actually do any redisplay. */
31289 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
31291 DEFSYM (Qredisplay_internal_xC_functionx
, "redisplay_internal (C function)");
31293 DEFVAR_BOOL("inhibit-message", inhibit_message
,
31294 doc
: /* Non-nil means calls to `message' are not displayed.
31295 They are still logged to the *Messages* buffer. */);
31296 inhibit_message
= 0;
31298 message_dolog_marker1
= Fmake_marker ();
31299 staticpro (&message_dolog_marker1
);
31300 message_dolog_marker2
= Fmake_marker ();
31301 staticpro (&message_dolog_marker2
);
31302 message_dolog_marker3
= Fmake_marker ();
31303 staticpro (&message_dolog_marker3
);
31305 defsubr (&Sset_buffer_redisplay
);
31307 defsubr (&Sdump_frame_glyph_matrix
);
31308 defsubr (&Sdump_glyph_matrix
);
31309 defsubr (&Sdump_glyph_row
);
31310 defsubr (&Sdump_tool_bar_row
);
31311 defsubr (&Strace_redisplay
);
31312 defsubr (&Strace_to_stderr
);
31314 #ifdef HAVE_WINDOW_SYSTEM
31315 defsubr (&Stool_bar_height
);
31316 defsubr (&Slookup_image_map
);
31318 defsubr (&Sline_pixel_height
);
31319 defsubr (&Sformat_mode_line
);
31320 defsubr (&Sinvisible_p
);
31321 defsubr (&Scurrent_bidi_paragraph_direction
);
31322 defsubr (&Swindow_text_pixel_size
);
31323 defsubr (&Smove_point_visually
);
31324 defsubr (&Sbidi_find_overridden_directionality
);
31326 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
31327 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
31328 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
31329 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
31330 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
31331 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
31332 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
31333 DEFSYM (Qeval
, "eval");
31334 DEFSYM (QCdata
, ":data");
31336 /* Names of text properties relevant for redisplay. */
31337 DEFSYM (Qdisplay
, "display");
31338 DEFSYM (Qspace_width
, "space-width");
31339 DEFSYM (Qraise
, "raise");
31340 DEFSYM (Qslice
, "slice");
31341 DEFSYM (Qspace
, "space");
31342 DEFSYM (Qmargin
, "margin");
31343 DEFSYM (Qpointer
, "pointer");
31344 DEFSYM (Qleft_margin
, "left-margin");
31345 DEFSYM (Qright_margin
, "right-margin");
31346 DEFSYM (Qcenter
, "center");
31347 DEFSYM (Qline_height
, "line-height");
31348 DEFSYM (QCalign_to
, ":align-to");
31349 DEFSYM (QCrelative_width
, ":relative-width");
31350 DEFSYM (QCrelative_height
, ":relative-height");
31351 DEFSYM (QCeval
, ":eval");
31352 DEFSYM (QCpropertize
, ":propertize");
31353 DEFSYM (QCfile
, ":file");
31354 DEFSYM (Qfontified
, "fontified");
31355 DEFSYM (Qfontification_functions
, "fontification-functions");
31357 /* Name of the face used to highlight trailing whitespace. */
31358 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
31360 /* Name and number of the face used to highlight escape glyphs. */
31361 DEFSYM (Qescape_glyph
, "escape-glyph");
31363 /* Name and number of the face used to highlight non-breaking
31365 DEFSYM (Qnobreak_space
, "nobreak-space");
31366 DEFSYM (Qnobreak_hyphen
, "nobreak-hyphen");
31368 /* The symbol 'image' which is the car of the lists used to represent
31369 images in Lisp. Also a tool bar style. */
31370 DEFSYM (Qimage
, "image");
31372 /* Tool bar styles. */
31373 DEFSYM (Qtext
, "text");
31374 DEFSYM (Qboth
, "both");
31375 DEFSYM (Qboth_horiz
, "both-horiz");
31376 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
31378 /* The image map types. */
31379 DEFSYM (QCmap
, ":map");
31380 DEFSYM (QCpointer
, ":pointer");
31381 DEFSYM (Qrect
, "rect");
31382 DEFSYM (Qcircle
, "circle");
31383 DEFSYM (Qpoly
, "poly");
31385 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
31387 DEFSYM (Qgrow_only
, "grow-only");
31388 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
31389 DEFSYM (Qposition
, "position");
31390 DEFSYM (Qbuffer_position
, "buffer-position");
31391 DEFSYM (Qobject
, "object");
31393 /* Cursor shapes. */
31394 DEFSYM (Qbar
, "bar");
31395 DEFSYM (Qhbar
, "hbar");
31396 DEFSYM (Qbox
, "box");
31397 DEFSYM (Qhollow
, "hollow");
31399 /* Pointer shapes. */
31400 DEFSYM (Qhand
, "hand");
31401 DEFSYM (Qarrow
, "arrow");
31404 DEFSYM (Qdragging
, "dragging");
31406 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
31408 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
31409 staticpro (&list_of_error
);
31411 /* Values of those variables at last redisplay are stored as
31412 properties on 'overlay-arrow-position' symbol. However, if
31413 Voverlay_arrow_position is a marker, last-arrow-position is its
31414 numerical position. */
31415 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
31416 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
31418 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
31419 properties on a symbol in overlay-arrow-variable-list. */
31420 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
31421 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
31423 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
31424 staticpro (&echo_buffer
[0]);
31425 staticpro (&echo_buffer
[1]);
31427 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
31428 staticpro (&echo_area_buffer
[0]);
31429 staticpro (&echo_area_buffer
[1]);
31431 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
31432 staticpro (&Vmessages_buffer_name
);
31434 mode_line_proptrans_alist
= Qnil
;
31435 staticpro (&mode_line_proptrans_alist
);
31436 mode_line_string_list
= Qnil
;
31437 staticpro (&mode_line_string_list
);
31438 mode_line_string_face
= Qnil
;
31439 staticpro (&mode_line_string_face
);
31440 mode_line_string_face_prop
= Qnil
;
31441 staticpro (&mode_line_string_face_prop
);
31442 Vmode_line_unwind_vector
= Qnil
;
31443 staticpro (&Vmode_line_unwind_vector
);
31445 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
31447 help_echo_string
= Qnil
;
31448 staticpro (&help_echo_string
);
31449 help_echo_object
= Qnil
;
31450 staticpro (&help_echo_object
);
31451 help_echo_window
= Qnil
;
31452 staticpro (&help_echo_window
);
31453 previous_help_echo_string
= Qnil
;
31454 staticpro (&previous_help_echo_string
);
31455 help_echo_pos
= -1;
31457 DEFSYM (Qright_to_left
, "right-to-left");
31458 DEFSYM (Qleft_to_right
, "left-to-right");
31459 defsubr (&Sbidi_resolved_levels
);
31461 #ifdef HAVE_WINDOW_SYSTEM
31462 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
31463 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
31464 For example, if a block cursor is over a tab, it will be drawn as
31465 wide as that tab on the display. */);
31466 x_stretch_cursor_p
= 0;
31469 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
31470 doc
: /* Non-nil means highlight trailing whitespace.
31471 The face used for trailing whitespace is `trailing-whitespace'. */);
31472 Vshow_trailing_whitespace
= Qnil
;
31474 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
31475 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
31476 If the value is t, Emacs highlights non-ASCII chars which have the
31477 same appearance as an ASCII space or hyphen, using the `nobreak-space'
31478 or `nobreak-hyphen' face respectively.
31480 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
31481 U+2011 (non-breaking hyphen) are affected.
31483 Any other non-nil value means to display these characters as a escape
31484 glyph followed by an ordinary space or hyphen.
31486 A value of nil means no special handling of these characters. */);
31487 Vnobreak_char_display
= Qt
;
31489 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
31490 doc
: /* The pointer shape to show in void text areas.
31491 A value of nil means to show the text pointer. Other options are
31492 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
31494 Vvoid_text_area_pointer
= Qarrow
;
31496 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
31497 doc
: /* Non-nil means don't actually do any redisplay.
31498 This is used for internal purposes. */);
31499 Vinhibit_redisplay
= Qnil
;
31501 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
31502 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31503 Vglobal_mode_string
= Qnil
;
31505 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
31506 doc
: /* Marker for where to display an arrow on top of the buffer text.
31507 This must be the beginning of a line in order to work.
31508 See also `overlay-arrow-string'. */);
31509 Voverlay_arrow_position
= Qnil
;
31511 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
31512 doc
: /* String to display as an arrow in non-window frames.
31513 See also `overlay-arrow-position'. */);
31514 Voverlay_arrow_string
= build_pure_c_string ("=>");
31516 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31517 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31518 The symbols on this list are examined during redisplay to determine
31519 where to display overlay arrows. */);
31520 Voverlay_arrow_variable_list
31521 = list1 (intern_c_string ("overlay-arrow-position"));
31523 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31524 doc
: /* The number of lines to try scrolling a window by when point moves out.
31525 If that fails to bring point back on frame, point is centered instead.
31526 If this is zero, point is always centered after it moves off frame.
31527 If you want scrolling to always be a line at a time, you should set
31528 `scroll-conservatively' to a large value rather than set this to 1. */);
31530 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31531 doc
: /* Scroll up to this many lines, to bring point back on screen.
31532 If point moves off-screen, redisplay will scroll by up to
31533 `scroll-conservatively' lines in order to bring point just barely
31534 onto the screen again. If that cannot be done, then redisplay
31535 recenters point as usual.
31537 If the value is greater than 100, redisplay will never recenter point,
31538 but will always scroll just enough text to bring point into view, even
31539 if you move far away.
31541 A value of zero means always recenter point if it moves off screen. */);
31542 scroll_conservatively
= 0;
31544 DEFVAR_INT ("scroll-margin", scroll_margin
,
31545 doc
: /* Number of lines of margin at the top and bottom of a window.
31546 Recenter the window whenever point gets within this many lines
31547 of the top or bottom of the window. */);
31550 DEFVAR_LISP ("maximum-scroll-margin", Vmaximum_scroll_margin
,
31551 doc
: /* Maximum effective value of `scroll-margin'.
31552 Given as a fraction of the current window's lines. The value should
31553 be a floating point number between 0.0 and 0.5. The effective maximum
31554 is limited to (/ (1- window-lines) 2). Non-float values for this
31555 variable are ignored and the default 0.25 is used instead. */);
31556 Vmaximum_scroll_margin
= make_float (0.25);
31558 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31559 doc
: /* Pixels per inch value for non-window system displays.
31560 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31561 Vdisplay_pixels_per_inch
= make_float (72.0);
31564 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31567 DEFVAR_LISP ("truncate-partial-width-windows",
31568 Vtruncate_partial_width_windows
,
31569 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31570 For an integer value, truncate lines in each window narrower than the
31571 full frame width, provided the total window width in column units is less
31572 than that integer; otherwise, respect the value of `truncate-lines'.
31573 The total width of the window is as returned by `window-total-width', it
31574 includes the fringes, the continuation and truncation glyphs, the
31575 display margins (if any), and the scroll bar
31577 For any other non-nil value, truncate lines in all windows that do
31578 not span the full frame width.
31580 A value of nil means to respect the value of `truncate-lines'.
31582 If `word-wrap' is enabled, you might want to reduce this. */);
31583 Vtruncate_partial_width_windows
= make_number (50);
31585 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31586 doc
: /* Maximum buffer size for which line number should be displayed.
31587 If the buffer is bigger than this, the line number does not appear
31588 in the mode line. A value of nil means no limit. */);
31589 Vline_number_display_limit
= Qnil
;
31591 DEFVAR_INT ("line-number-display-limit-width",
31592 line_number_display_limit_width
,
31593 doc
: /* Maximum line width (in characters) for line number display.
31594 If the average length of the lines near point is bigger than this, then the
31595 line number may be omitted from the mode line. */);
31596 line_number_display_limit_width
= 200;
31598 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31599 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31600 highlight_nonselected_windows
= false;
31602 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31603 doc
: /* Non-nil if more than one frame is visible on this display.
31604 Minibuffer-only frames don't count, but iconified frames do.
31605 This variable is not guaranteed to be accurate except while processing
31606 `frame-title-format' and `icon-title-format'. */);
31608 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31609 doc
: /* Template for displaying the title bar of visible frames.
31610 \(Assuming the window manager supports this feature.)
31612 This variable has the same structure as `mode-line-format', except that
31613 the %c and %l constructs are ignored. It is used only on frames for
31614 which no explicit name has been set (see `modify-frame-parameters'). */);
31616 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31617 doc
: /* Template for displaying the title bar of an iconified frame.
31618 \(Assuming the window manager supports this feature.)
31619 This variable has the same structure as `mode-line-format' (which see),
31620 and is used only on frames for which no explicit name has been set
31621 \(see `modify-frame-parameters'). */);
31623 = Vframe_title_format
31624 = listn (CONSTYPE_PURE
, 3,
31625 intern_c_string ("multiple-frames"),
31626 build_pure_c_string ("%b"),
31627 listn (CONSTYPE_PURE
, 4,
31628 empty_unibyte_string
,
31629 intern_c_string ("invocation-name"),
31630 build_pure_c_string ("@"),
31631 intern_c_string ("system-name")));
31633 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31634 doc
: /* Maximum number of lines to keep in the message log buffer.
31635 If nil, disable message logging. If t, log messages but don't truncate
31636 the buffer when it becomes large. */);
31637 Vmessage_log_max
= make_number (1000);
31639 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31640 doc
: /* List of functions to call before redisplaying a window with scrolling.
31641 Each function is called with two arguments, the window and its new
31642 display-start position.
31643 These functions are called whenever the `window-start' marker is modified,
31644 either to point into another buffer (e.g. via `set-window-buffer') or another
31645 place in the same buffer.
31646 Note that the value of `window-end' is not valid when these functions are
31649 Warning: Do not use this feature to alter the way the window
31650 is scrolled. It is not designed for that, and such use probably won't
31652 Vwindow_scroll_functions
= Qnil
;
31654 DEFVAR_LISP ("window-text-change-functions",
31655 Vwindow_text_change_functions
,
31656 doc
: /* Functions to call in redisplay when text in the window might change. */);
31657 Vwindow_text_change_functions
= Qnil
;
31659 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31660 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31661 Each function is called with two arguments, the window and the end trigger value.
31662 See `set-window-redisplay-end-trigger'. */);
31663 Vredisplay_end_trigger_functions
= Qnil
;
31665 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31666 doc
: /* Non-nil means autoselect window with mouse pointer.
31667 If nil, do not autoselect windows.
31668 A positive number means delay autoselection by that many seconds: a
31669 window is autoselected only after the mouse has remained in that
31670 window for the duration of the delay.
31671 A negative number has a similar effect, but causes windows to be
31672 autoselected only after the mouse has stopped moving. (Because of
31673 the way Emacs compares mouse events, you will occasionally wait twice
31674 that time before the window gets selected.)
31675 Any other value means to autoselect window instantaneously when the
31676 mouse pointer enters it.
31678 Autoselection selects the minibuffer only if it is active, and never
31679 unselects the minibuffer if it is active.
31681 When customizing this variable make sure that the actual value of
31682 `focus-follows-mouse' matches the behavior of your window manager. */);
31683 Vmouse_autoselect_window
= Qnil
;
31685 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31686 doc
: /* Non-nil means automatically resize tool-bars.
31687 This dynamically changes the tool-bar's height to the minimum height
31688 that is needed to make all tool-bar items visible.
31689 If value is `grow-only', the tool-bar's height is only increased
31690 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31691 Vauto_resize_tool_bars
= Qt
;
31693 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31694 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31695 auto_raise_tool_bar_buttons_p
= true;
31697 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31698 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31699 make_cursor_line_fully_visible_p
= true;
31701 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31702 doc
: /* Border below tool-bar in pixels.
31703 If an integer, use it as the height of the border.
31704 If it is one of `internal-border-width' or `border-width', use the
31705 value of the corresponding frame parameter.
31706 Otherwise, no border is added below the tool-bar. */);
31707 Vtool_bar_border
= Qinternal_border_width
;
31709 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31710 doc
: /* Margin around tool-bar buttons in pixels.
31711 If an integer, use that for both horizontal and vertical margins.
31712 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31713 HORZ specifying the horizontal margin, and VERT specifying the
31714 vertical margin. */);
31715 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31717 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31718 doc
: /* Relief thickness of tool-bar buttons. */);
31719 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31721 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31722 doc
: /* Tool bar style to use.
31724 image - show images only
31725 text - show text only
31726 both - show both, text below image
31727 both-horiz - show text to the right of the image
31728 text-image-horiz - show text to the left of the image
31729 any other - use system default or image if no system default.
31731 This variable only affects the GTK+ toolkit version of Emacs. */);
31732 Vtool_bar_style
= Qnil
;
31734 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31735 doc
: /* Maximum number of characters a label can have to be shown.
31736 The tool bar style must also show labels for this to have any effect, see
31737 `tool-bar-style'. */);
31738 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31740 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31741 doc
: /* List of functions to call to fontify regions of text.
31742 Each function is called with one argument POS. Functions must
31743 fontify a region starting at POS in the current buffer, and give
31744 fontified regions the property `fontified'. */);
31745 Vfontification_functions
= Qnil
;
31746 Fmake_variable_buffer_local (Qfontification_functions
);
31748 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31749 unibyte_display_via_language_environment
,
31750 doc
: /* Non-nil means display unibyte text according to language environment.
31751 Specifically, this means that raw bytes in the range 160-255 decimal
31752 are displayed by converting them to the equivalent multibyte characters
31753 according to the current language environment. As a result, they are
31754 displayed according to the current fontset.
31756 Note that this variable affects only how these bytes are displayed,
31757 but does not change the fact they are interpreted as raw bytes. */);
31758 unibyte_display_via_language_environment
= false;
31760 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31761 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31762 If a float, it specifies a fraction of the mini-window frame's height.
31763 If an integer, it specifies a number of lines. */);
31764 Vmax_mini_window_height
= make_float (0.25);
31766 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31767 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31768 A value of nil means don't automatically resize mini-windows.
31769 A value of t means resize them to fit the text displayed in them.
31770 A value of `grow-only', the default, means let mini-windows grow only;
31771 they return to their normal size when the minibuffer is closed, or the
31772 echo area becomes empty. */);
31773 /* Contrary to the doc string, we initialize this to nil, so that
31774 loading loadup.el won't try to resize windows before loading
31775 window.el, where some functions we need to call for this live.
31776 We assign the 'grow-only' value right after loading window.el
31778 Vresize_mini_windows
= Qnil
;
31780 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31781 doc
: /* Alist specifying how to blink the cursor off.
31782 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31783 `cursor-type' frame-parameter or variable equals ON-STATE,
31784 comparing using `equal', Emacs uses OFF-STATE to specify
31785 how to blink it off. ON-STATE and OFF-STATE are values for
31786 the `cursor-type' frame parameter.
31788 If a frame's ON-STATE has no entry in this list,
31789 the frame's other specifications determine how to blink the cursor off. */);
31790 Vblink_cursor_alist
= Qnil
;
31792 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31793 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31794 If non-nil, windows are automatically scrolled horizontally to make
31795 point visible. */);
31796 automatic_hscrolling_p
= true;
31797 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31799 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31800 doc
: /* How many columns away from the window edge point is allowed to get
31801 before automatic hscrolling will horizontally scroll the window. */);
31802 hscroll_margin
= 5;
31804 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31805 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31806 When point is less than `hscroll-margin' columns from the window
31807 edge, automatic hscrolling will scroll the window by the amount of columns
31808 determined by this variable. If its value is a positive integer, scroll that
31809 many columns. If it's a positive floating-point number, it specifies the
31810 fraction of the window's width to scroll. If it's nil or zero, point will be
31811 centered horizontally after the scroll. Any other value, including negative
31812 numbers, are treated as if the value were zero.
31814 Automatic hscrolling always moves point outside the scroll margin, so if
31815 point was more than scroll step columns inside the margin, the window will
31816 scroll more than the value given by the scroll step.
31818 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31819 and `scroll-right' overrides this variable's effect. */);
31820 Vhscroll_step
= make_number (0);
31822 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31823 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31824 Bind this around calls to `message' to let it take effect. */);
31825 message_truncate_lines
= false;
31827 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31828 doc
: /* Normal hook run to update the menu bar definitions.
31829 Redisplay runs this hook before it redisplays the menu bar.
31830 This is used to update menus such as Buffers, whose contents depend on
31832 Vmenu_bar_update_hook
= Qnil
;
31834 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31835 doc
: /* Frame for which we are updating a menu.
31836 The enable predicate for a menu binding should check this variable. */);
31837 Vmenu_updating_frame
= Qnil
;
31839 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31840 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31841 inhibit_menubar_update
= false;
31843 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31844 doc
: /* Prefix prepended to all continuation lines at display time.
31845 The value may be a string, an image, or a stretch-glyph; it is
31846 interpreted in the same way as the value of a `display' text property.
31848 This variable is overridden by any `wrap-prefix' text or overlay
31851 To add a prefix to non-continuation lines, use `line-prefix'. */);
31852 Vwrap_prefix
= Qnil
;
31853 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31854 Fmake_variable_buffer_local (Qwrap_prefix
);
31856 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31857 doc
: /* Prefix prepended to all non-continuation lines at display time.
31858 The value may be a string, an image, or a stretch-glyph; it is
31859 interpreted in the same way as the value of a `display' text property.
31861 This variable is overridden by any `line-prefix' text or overlay
31864 To add a prefix to continuation lines, use `wrap-prefix'. */);
31865 Vline_prefix
= Qnil
;
31866 DEFSYM (Qline_prefix
, "line-prefix");
31867 Fmake_variable_buffer_local (Qline_prefix
);
31869 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31870 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31871 inhibit_eval_during_redisplay
= false;
31873 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31874 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31875 inhibit_free_realized_faces
= false;
31877 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31878 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31879 Intended for use during debugging and for testing bidi display;
31880 see biditest.el in the test suite. */);
31881 inhibit_bidi_mirroring
= false;
31884 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31885 doc
: /* Inhibit try_window_id display optimization. */);
31886 inhibit_try_window_id
= false;
31888 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31889 doc
: /* Inhibit try_window_reusing display optimization. */);
31890 inhibit_try_window_reusing
= false;
31892 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31893 doc
: /* Inhibit try_cursor_movement display optimization. */);
31894 inhibit_try_cursor_movement
= false;
31895 #endif /* GLYPH_DEBUG */
31897 DEFVAR_INT ("overline-margin", overline_margin
,
31898 doc
: /* Space between overline and text, in pixels.
31899 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31900 margin to the character height. */);
31901 overline_margin
= 2;
31903 DEFVAR_INT ("underline-minimum-offset",
31904 underline_minimum_offset
,
31905 doc
: /* Minimum distance between baseline and underline.
31906 This can improve legibility of underlined text at small font sizes,
31907 particularly when using variable `x-use-underline-position-properties'
31908 with fonts that specify an UNDERLINE_POSITION relatively close to the
31909 baseline. The default value is 1. */);
31910 underline_minimum_offset
= 1;
31912 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31913 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31914 This feature only works when on a window system that can change
31915 cursor shapes. */);
31916 display_hourglass_p
= true;
31918 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31919 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31920 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31922 #ifdef HAVE_WINDOW_SYSTEM
31923 hourglass_atimer
= NULL
;
31924 hourglass_shown_p
= false;
31925 #endif /* HAVE_WINDOW_SYSTEM */
31927 /* Name of the face used to display glyphless characters. */
31928 DEFSYM (Qglyphless_char
, "glyphless-char");
31930 /* Method symbols for Vglyphless_char_display. */
31931 DEFSYM (Qhex_code
, "hex-code");
31932 DEFSYM (Qempty_box
, "empty-box");
31933 DEFSYM (Qthin_space
, "thin-space");
31934 DEFSYM (Qzero_width
, "zero-width");
31936 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31937 doc
: /* Function run just before redisplay.
31938 It is called with one argument, which is the set of windows that are to
31939 be redisplayed. This set can be nil (meaning, only the selected window),
31940 or t (meaning all windows). */);
31941 Vpre_redisplay_function
= intern ("ignore");
31943 /* Symbol for the purpose of Vglyphless_char_display. */
31944 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31945 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31947 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31948 doc
: /* Char-table defining glyphless characters.
31949 Each element, if non-nil, should be one of the following:
31950 an ASCII acronym string: display this string in a box
31951 `hex-code': display the hexadecimal code of a character in a box
31952 `empty-box': display as an empty box
31953 `thin-space': display as 1-pixel width space
31954 `zero-width': don't display
31955 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31956 display method for graphical terminals and text terminals respectively.
31957 GRAPHICAL and TEXT should each have one of the values listed above.
31959 The char-table has one extra slot to control the display of a character for
31960 which no font is found. This slot only takes effect on graphical terminals.
31961 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31962 `thin-space'. The default is `empty-box'.
31964 If a character has a non-nil entry in an active display table, the
31965 display table takes effect; in this case, Emacs does not consult
31966 `glyphless-char-display' at all. */);
31967 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31968 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31971 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31972 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31973 Vdebug_on_message
= Qnil
;
31975 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31977 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31979 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31981 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31983 DEFVAR_BOOL ("redisplay--inhibit-bidi", redisplay__inhibit_bidi
,
31984 doc
: /* Non-nil means it is not safe to attempt bidi reordering for display. */);
31985 /* Initialize to t, since we need to disable reordering until
31986 loadup.el successfully loads charprop.el. */
31987 redisplay__inhibit_bidi
= true;
31991 /* Initialize this module when Emacs starts. */
31996 CHARPOS (this_line_start_pos
) = 0;
31998 if (!noninteractive
)
32000 struct window
*m
= XWINDOW (minibuf_window
);
32001 Lisp_Object frame
= m
->frame
;
32002 struct frame
*f
= XFRAME (frame
);
32003 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
32004 struct window
*r
= XWINDOW (root
);
32007 echo_area_window
= minibuf_window
;
32009 r
->top_line
= FRAME_TOP_MARGIN (f
);
32010 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
32011 r
->total_cols
= FRAME_COLS (f
);
32012 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
32013 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
32014 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
32016 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
32017 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
32018 m
->total_cols
= FRAME_COLS (f
);
32019 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
32020 m
->total_lines
= 1;
32021 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
32023 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
32024 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
32025 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
32027 /* The default ellipsis glyphs `...'. */
32028 for (i
= 0; i
< 3; ++i
)
32029 default_invis_vector
[i
] = make_number ('.');
32033 /* Allocate the buffer for frame titles.
32034 Also used for `format-mode-line'. */
32036 mode_line_noprop_buf
= xmalloc (size
);
32037 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
32038 mode_line_noprop_ptr
= mode_line_noprop_buf
;
32039 mode_line_target
= MODE_LINE_DISPLAY
;
32042 help_echo_showing_p
= false;
32045 #ifdef HAVE_WINDOW_SYSTEM
32047 /* Platform-independent portion of hourglass implementation. */
32049 /* Timer function of hourglass_atimer. */
32052 show_hourglass (struct atimer
*timer
)
32054 /* The timer implementation will cancel this timer automatically
32055 after this function has run. Set hourglass_atimer to null
32056 so that we know the timer doesn't have to be canceled. */
32057 hourglass_atimer
= NULL
;
32059 if (!hourglass_shown_p
)
32061 Lisp_Object tail
, frame
;
32065 FOR_EACH_FRAME (tail
, frame
)
32067 struct frame
*f
= XFRAME (frame
);
32069 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
32070 && FRAME_RIF (f
)->show_hourglass
)
32071 FRAME_RIF (f
)->show_hourglass (f
);
32074 hourglass_shown_p
= true;
32079 /* Cancel a currently active hourglass timer, and start a new one. */
32082 start_hourglass (void)
32084 struct timespec delay
;
32086 cancel_hourglass ();
32088 if (INTEGERP (Vhourglass_delay
)
32089 && XINT (Vhourglass_delay
) > 0)
32090 delay
= make_timespec (min (XINT (Vhourglass_delay
),
32091 TYPE_MAXIMUM (time_t)),
32093 else if (FLOATP (Vhourglass_delay
)
32094 && XFLOAT_DATA (Vhourglass_delay
) > 0)
32095 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
32097 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
32099 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
32100 show_hourglass
, NULL
);
32103 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
32107 cancel_hourglass (void)
32109 if (hourglass_atimer
)
32111 cancel_atimer (hourglass_atimer
);
32112 hourglass_atimer
= NULL
;
32115 if (hourglass_shown_p
)
32117 Lisp_Object tail
, frame
;
32121 FOR_EACH_FRAME (tail
, frame
)
32123 struct frame
*f
= XFRAME (frame
);
32125 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
32126 && FRAME_RIF (f
)->hide_hourglass
)
32127 FRAME_RIF (f
)->hide_hourglass (f
);
32129 /* No cursors on non GUI frames - restore to stock arrow cursor. */
32130 else if (!FRAME_W32_P (f
))
32131 w32_arrow_cursor ();
32135 hourglass_shown_p
= false;
32140 #endif /* HAVE_WINDOW_SYSTEM */