1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2015 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
54 expose_window (asynchronous) |
56 X expose events -----+
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
91 . try_window_reusing_current_matrix
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
295 #include "keyboard.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
304 #include "commands.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
319 #endif /* HAVE_WINDOW_SYSTEM */
324 #ifndef FRAME_X_OUTPUT
325 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
328 #define INFINITY 10000000
330 /* Holds the list (error). */
331 static Lisp_Object list_of_error
;
333 #ifdef HAVE_WINDOW_SYSTEM
335 /* Test if overflow newline into fringe. Called with iterator IT
336 at or past right window margin, and with IT->current_x set. */
338 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
339 (!NILP (Voverflow_newline_into_fringe) \
340 && FRAME_WINDOW_P ((IT)->f) \
341 && ((IT)->bidi_it.paragraph_dir == R2L \
342 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
343 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
344 && (IT)->current_x == (IT)->last_visible_x)
346 #else /* !HAVE_WINDOW_SYSTEM */
347 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
348 #endif /* HAVE_WINDOW_SYSTEM */
350 /* Test if the display element loaded in IT, or the underlying buffer
351 or string character, is a space or a TAB character. This is used
352 to determine where word wrapping can occur. */
354 #define IT_DISPLAYING_WHITESPACE(it) \
355 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
356 || ((STRINGP (it->string) \
357 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
358 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
360 && (it->s[IT_BYTEPOS (*it)] == ' ' \
361 || it->s[IT_BYTEPOS (*it)] == '\t')) \
362 || (IT_BYTEPOS (*it) < ZV_BYTE \
363 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
364 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
366 /* Non-zero means print newline to stdout before next mini-buffer
369 bool noninteractive_need_newline
;
371 /* Non-zero means print newline to message log before next message. */
373 static bool message_log_need_newline
;
375 /* Three markers that message_dolog uses.
376 It could allocate them itself, but that causes trouble
377 in handling memory-full errors. */
378 static Lisp_Object message_dolog_marker1
;
379 static Lisp_Object message_dolog_marker2
;
380 static Lisp_Object message_dolog_marker3
;
382 /* The buffer position of the first character appearing entirely or
383 partially on the line of the selected window which contains the
384 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
385 redisplay optimization in redisplay_internal. */
387 static struct text_pos this_line_start_pos
;
389 /* Number of characters past the end of the line above, including the
390 terminating newline. */
392 static struct text_pos this_line_end_pos
;
394 /* The vertical positions and the height of this line. */
396 static int this_line_vpos
;
397 static int this_line_y
;
398 static int this_line_pixel_height
;
400 /* X position at which this display line starts. Usually zero;
401 negative if first character is partially visible. */
403 static int this_line_start_x
;
405 /* The smallest character position seen by move_it_* functions as they
406 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
407 hscrolled lines, see display_line. */
409 static struct text_pos this_line_min_pos
;
411 /* Buffer that this_line_.* variables are referring to. */
413 static struct buffer
*this_line_buffer
;
415 /* Nonzero if an overlay arrow has been displayed in this window. */
417 static bool overlay_arrow_seen
;
419 /* Vector containing glyphs for an ellipsis `...'. */
421 static Lisp_Object default_invis_vector
[3];
423 /* This is the window where the echo area message was displayed. It
424 is always a mini-buffer window, but it may not be the same window
425 currently active as a mini-buffer. */
427 Lisp_Object echo_area_window
;
429 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
430 pushes the current message and the value of
431 message_enable_multibyte on the stack, the function restore_message
432 pops the stack and displays MESSAGE again. */
434 static Lisp_Object Vmessage_stack
;
436 /* Nonzero means multibyte characters were enabled when the echo area
437 message was specified. */
439 static bool message_enable_multibyte
;
441 /* Nonzero if we should redraw the mode lines on the next redisplay.
442 If it has value REDISPLAY_SOME, then only redisplay the mode lines where
443 the `redisplay' bit has been set. Otherwise, redisplay all mode lines
444 (the number used is then only used to track down the cause for this
447 int update_mode_lines
;
449 /* Nonzero if window sizes or contents other than selected-window have changed
450 since last redisplay that finished.
451 If it has value REDISPLAY_SOME, then only redisplay the windows where
452 the `redisplay' bit has been set. Otherwise, redisplay all windows
453 (the number used is then only used to track down the cause for this
456 int windows_or_buffers_changed
;
458 /* Nonzero after display_mode_line if %l was used and it displayed a
461 static bool line_number_displayed
;
463 /* The name of the *Messages* buffer, a string. */
465 static Lisp_Object Vmessages_buffer_name
;
467 /* Current, index 0, and last displayed echo area message. Either
468 buffers from echo_buffers, or nil to indicate no message. */
470 Lisp_Object echo_area_buffer
[2];
472 /* The buffers referenced from echo_area_buffer. */
474 static Lisp_Object echo_buffer
[2];
476 /* A vector saved used in with_area_buffer to reduce consing. */
478 static Lisp_Object Vwith_echo_area_save_vector
;
480 /* Non-zero means display_echo_area should display the last echo area
481 message again. Set by redisplay_preserve_echo_area. */
483 static bool display_last_displayed_message_p
;
485 /* Nonzero if echo area is being used by print; zero if being used by
488 static bool message_buf_print
;
490 /* Set to 1 in clear_message to make redisplay_internal aware
491 of an emptied echo area. */
493 static bool message_cleared_p
;
495 /* A scratch glyph row with contents used for generating truncation
496 glyphs. Also used in direct_output_for_insert. */
498 #define MAX_SCRATCH_GLYPHS 100
499 static struct glyph_row scratch_glyph_row
;
500 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
502 /* Ascent and height of the last line processed by move_it_to. */
504 static int last_height
;
506 /* Non-zero if there's a help-echo in the echo area. */
508 bool help_echo_showing_p
;
510 /* The maximum distance to look ahead for text properties. Values
511 that are too small let us call compute_char_face and similar
512 functions too often which is expensive. Values that are too large
513 let us call compute_char_face and alike too often because we
514 might not be interested in text properties that far away. */
516 #define TEXT_PROP_DISTANCE_LIMIT 100
518 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
519 iterator state and later restore it. This is needed because the
520 bidi iterator on bidi.c keeps a stacked cache of its states, which
521 is really a singleton. When we use scratch iterator objects to
522 move around the buffer, we can cause the bidi cache to be pushed or
523 popped, and therefore we need to restore the cache state when we
524 return to the original iterator. */
525 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
528 bidi_unshelve_cache (CACHE, 1); \
530 CACHE = bidi_shelve_cache (); \
533 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
535 if (pITORIG != pITCOPY) \
536 *(pITORIG) = *(pITCOPY); \
537 bidi_unshelve_cache (CACHE, 0); \
541 /* Functions to mark elements as needing redisplay. */
542 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
545 redisplay_other_windows (void)
547 if (!windows_or_buffers_changed
)
548 windows_or_buffers_changed
= REDISPLAY_SOME
;
552 wset_redisplay (struct window
*w
)
554 /* Beware: selected_window can be nil during early stages. */
555 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
556 redisplay_other_windows ();
561 fset_redisplay (struct frame
*f
)
563 redisplay_other_windows ();
568 bset_redisplay (struct buffer
*b
)
570 int count
= buffer_window_count (b
);
573 /* ... it's visible in other window than selected, */
574 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
575 redisplay_other_windows ();
576 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
577 so that if we later set windows_or_buffers_changed, this buffer will
579 b
->text
->redisplay
= true;
584 bset_update_mode_line (struct buffer
*b
)
586 if (!update_mode_lines
)
587 update_mode_lines
= REDISPLAY_SOME
;
588 b
->text
->redisplay
= true;
593 /* Non-zero means print traces of redisplay if compiled with
594 GLYPH_DEBUG defined. */
596 bool trace_redisplay_p
;
598 #endif /* GLYPH_DEBUG */
600 #ifdef DEBUG_TRACE_MOVE
601 /* Non-zero means trace with TRACE_MOVE to stderr. */
604 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
606 #define TRACE_MOVE(x) (void) 0
609 /* Buffer being redisplayed -- for redisplay_window_error. */
611 static struct buffer
*displayed_buffer
;
613 /* Value returned from text property handlers (see below). */
618 HANDLED_RECOMPUTE_PROPS
,
619 HANDLED_OVERLAY_STRING_CONSUMED
,
623 /* A description of text properties that redisplay is interested
628 /* The symbol index of the name of the property. */
631 /* A unique index for the property. */
634 /* A handler function called to set up iterator IT from the property
635 at IT's current position. Value is used to steer handle_stop. */
636 enum prop_handled (*handler
) (struct it
*it
);
639 static enum prop_handled
handle_face_prop (struct it
*);
640 static enum prop_handled
handle_invisible_prop (struct it
*);
641 static enum prop_handled
handle_display_prop (struct it
*);
642 static enum prop_handled
handle_composition_prop (struct it
*);
643 static enum prop_handled
handle_overlay_change (struct it
*);
644 static enum prop_handled
handle_fontified_prop (struct it
*);
646 /* Properties handled by iterators. */
648 static struct props it_props
[] =
650 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
651 /* Handle `face' before `display' because some sub-properties of
652 `display' need to know the face. */
653 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
654 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
655 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
656 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
660 /* Value is the position described by X. If X is a marker, value is
661 the marker_position of X. Otherwise, value is X. */
663 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
665 /* Enumeration returned by some move_it_.* functions internally. */
669 /* Not used. Undefined value. */
672 /* Move ended at the requested buffer position or ZV. */
673 MOVE_POS_MATCH_OR_ZV
,
675 /* Move ended at the requested X pixel position. */
678 /* Move within a line ended at the end of a line that must be
682 /* Move within a line ended at the end of a line that would
683 be displayed truncated. */
686 /* Move within a line ended at a line end. */
690 /* This counter is used to clear the face cache every once in a while
691 in redisplay_internal. It is incremented for each redisplay.
692 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
695 #define CLEAR_FACE_CACHE_COUNT 500
696 static int clear_face_cache_count
;
698 /* Similarly for the image cache. */
700 #ifdef HAVE_WINDOW_SYSTEM
701 #define CLEAR_IMAGE_CACHE_COUNT 101
702 static int clear_image_cache_count
;
704 /* Null glyph slice */
705 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
708 /* True while redisplay_internal is in progress. */
712 /* If a string, XTread_socket generates an event to display that string.
713 (The display is done in read_char.) */
715 Lisp_Object help_echo_string
;
716 Lisp_Object help_echo_window
;
717 Lisp_Object help_echo_object
;
718 ptrdiff_t help_echo_pos
;
720 /* Temporary variable for XTread_socket. */
722 Lisp_Object previous_help_echo_string
;
724 /* Platform-independent portion of hourglass implementation. */
726 #ifdef HAVE_WINDOW_SYSTEM
728 /* Non-zero means an hourglass cursor is currently shown. */
729 static bool hourglass_shown_p
;
731 /* If non-null, an asynchronous timer that, when it expires, displays
732 an hourglass cursor on all frames. */
733 static struct atimer
*hourglass_atimer
;
735 #endif /* HAVE_WINDOW_SYSTEM */
737 /* Default number of seconds to wait before displaying an hourglass
739 #define DEFAULT_HOURGLASS_DELAY 1
741 #ifdef HAVE_WINDOW_SYSTEM
743 /* Default pixel width of `thin-space' display method. */
744 #define THIN_SPACE_WIDTH 1
746 #endif /* HAVE_WINDOW_SYSTEM */
748 /* Function prototypes. */
750 static void setup_for_ellipsis (struct it
*, int);
751 static void set_iterator_to_next (struct it
*, int);
752 static void mark_window_display_accurate_1 (struct window
*, int);
753 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
754 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
755 static int row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
756 static int cursor_row_p (struct glyph_row
*);
757 static int redisplay_mode_lines (Lisp_Object
, bool);
758 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
760 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
762 static void handle_line_prefix (struct it
*);
764 static void pint2str (char *, int, ptrdiff_t);
765 static void pint2hrstr (char *, int, ptrdiff_t);
766 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
768 static int text_outside_line_unchanged_p (struct window
*,
769 ptrdiff_t, ptrdiff_t);
770 static void store_mode_line_noprop_char (char);
771 static int store_mode_line_noprop (const char *, int, int);
772 static void handle_stop (struct it
*);
773 static void handle_stop_backwards (struct it
*, ptrdiff_t);
774 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
775 static void ensure_echo_area_buffers (void);
776 static void unwind_with_echo_area_buffer (Lisp_Object
);
777 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
778 static int with_echo_area_buffer (struct window
*, int,
779 int (*) (ptrdiff_t, Lisp_Object
),
780 ptrdiff_t, Lisp_Object
);
781 static void clear_garbaged_frames (void);
782 static int current_message_1 (ptrdiff_t, Lisp_Object
);
783 static int truncate_message_1 (ptrdiff_t, Lisp_Object
);
784 static void set_message (Lisp_Object
);
785 static int set_message_1 (ptrdiff_t, Lisp_Object
);
786 static int display_echo_area (struct window
*);
787 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
);
788 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
789 static void unwind_redisplay (void);
790 static int string_char_and_length (const unsigned char *, int *);
791 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
793 static int compute_window_start_on_continuation_line (struct window
*);
794 static void insert_left_trunc_glyphs (struct it
*);
795 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
797 static void extend_face_to_end_of_line (struct it
*);
798 static int append_space_for_newline (struct it
*, int);
799 static int cursor_row_fully_visible_p (struct window
*, int, int);
800 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
801 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
802 static int trailing_whitespace_p (ptrdiff_t);
803 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
804 static void push_it (struct it
*, struct text_pos
*);
805 static void iterate_out_of_display_property (struct it
*);
806 static void pop_it (struct it
*);
807 static void sync_frame_with_window_matrix_rows (struct window
*);
808 static void redisplay_internal (void);
809 static bool echo_area_display (bool);
810 static void redisplay_windows (Lisp_Object
);
811 static void redisplay_window (Lisp_Object
, bool);
812 static Lisp_Object
redisplay_window_error (Lisp_Object
);
813 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
814 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
815 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
816 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
818 static int update_menu_bar (struct frame
*, int, int);
819 static int try_window_reusing_current_matrix (struct window
*);
820 static int try_window_id (struct window
*);
821 static int display_line (struct it
*);
822 static int display_mode_lines (struct window
*);
823 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
824 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
825 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
826 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
827 static void display_menu_bar (struct window
*);
828 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
830 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
831 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
832 static void compute_line_metrics (struct it
*);
833 static void run_redisplay_end_trigger_hook (struct it
*);
834 static int get_overlay_strings (struct it
*, ptrdiff_t);
835 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
836 static void next_overlay_string (struct it
*);
837 static void reseat (struct it
*, struct text_pos
, int);
838 static void reseat_1 (struct it
*, struct text_pos
, int);
839 static void back_to_previous_visible_line_start (struct it
*);
840 static void reseat_at_next_visible_line_start (struct it
*, int);
841 static int next_element_from_ellipsis (struct it
*);
842 static int next_element_from_display_vector (struct it
*);
843 static int next_element_from_string (struct it
*);
844 static int next_element_from_c_string (struct it
*);
845 static int next_element_from_buffer (struct it
*);
846 static int next_element_from_composition (struct it
*);
847 static int next_element_from_image (struct it
*);
849 static int next_element_from_xwidget(struct it
*);
851 static int next_element_from_stretch (struct it
*);
852 static void load_overlay_strings (struct it
*, ptrdiff_t);
853 static int init_from_display_pos (struct it
*, struct window
*,
854 struct display_pos
*);
855 static void reseat_to_string (struct it
*, const char *,
856 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
857 static int get_next_display_element (struct it
*);
858 static enum move_it_result
859 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
860 enum move_operation_enum
);
861 static void get_visually_first_element (struct it
*);
862 static void init_to_row_start (struct it
*, struct window
*,
864 static int init_to_row_end (struct it
*, struct window
*,
866 static void back_to_previous_line_start (struct it
*);
867 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
868 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
869 Lisp_Object
, ptrdiff_t);
870 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
871 static struct text_pos
c_string_pos (ptrdiff_t, const char *, bool);
872 static ptrdiff_t number_of_chars (const char *, bool);
873 static void compute_stop_pos (struct it
*);
874 static void compute_string_pos (struct text_pos
*, struct text_pos
,
876 static int face_before_or_after_it_pos (struct it
*, int);
877 static ptrdiff_t next_overlay_change (ptrdiff_t);
878 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
879 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
880 static int handle_single_display_spec (struct it
*, Lisp_Object
,
881 Lisp_Object
, Lisp_Object
,
882 struct text_pos
*, ptrdiff_t, int, int);
883 static int underlying_face_id (struct it
*);
884 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
887 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
888 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
890 #ifdef HAVE_WINDOW_SYSTEM
892 static void x_consider_frame_title (Lisp_Object
);
893 static void update_tool_bar (struct frame
*, int);
894 static int redisplay_tool_bar (struct frame
*);
895 static void x_draw_bottom_divider (struct window
*w
);
896 static void notice_overwritten_cursor (struct window
*,
899 static void append_stretch_glyph (struct it
*, Lisp_Object
,
903 #endif /* HAVE_WINDOW_SYSTEM */
905 static void produce_special_glyphs (struct it
*, enum display_element_type
);
906 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
907 static bool coords_in_mouse_face_p (struct window
*, int, int);
911 /***********************************************************************
912 Window display dimensions
913 ***********************************************************************/
915 /* Return the bottom boundary y-position for text lines in window W.
916 This is the first y position at which a line cannot start.
917 It is relative to the top of the window.
919 This is the height of W minus the height of a mode line, if any. */
922 window_text_bottom_y (struct window
*w
)
924 int height
= WINDOW_PIXEL_HEIGHT (w
);
926 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
928 if (WINDOW_WANTS_MODELINE_P (w
))
929 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
931 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
936 /* Return the pixel width of display area AREA of window W.
937 ANY_AREA means return the total width of W, not including
938 fringes to the left and right of the window. */
941 window_box_width (struct window
*w
, enum glyph_row_area area
)
943 int width
= w
->pixel_width
;
945 if (!w
->pseudo_window_p
)
947 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
948 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
950 if (area
== TEXT_AREA
)
951 width
-= (WINDOW_MARGINS_WIDTH (w
)
952 + WINDOW_FRINGES_WIDTH (w
));
953 else if (area
== LEFT_MARGIN_AREA
)
954 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
955 else if (area
== RIGHT_MARGIN_AREA
)
956 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
959 /* With wide margins, fringes, etc. we might end up with a negative
960 width, correct that here. */
961 return max (0, width
);
965 /* Return the pixel height of the display area of window W, not
966 including mode lines of W, if any. */
969 window_box_height (struct window
*w
)
971 struct frame
*f
= XFRAME (w
->frame
);
972 int height
= WINDOW_PIXEL_HEIGHT (w
);
974 eassert (height
>= 0);
976 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
977 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
979 /* Note: the code below that determines the mode-line/header-line
980 height is essentially the same as that contained in the macro
981 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
982 the appropriate glyph row has its `mode_line_p' flag set,
983 and if it doesn't, uses estimate_mode_line_height instead. */
985 if (WINDOW_WANTS_MODELINE_P (w
))
987 struct glyph_row
*ml_row
988 = (w
->current_matrix
&& w
->current_matrix
->rows
989 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
991 if (ml_row
&& ml_row
->mode_line_p
)
992 height
-= ml_row
->height
;
994 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
997 if (WINDOW_WANTS_HEADER_LINE_P (w
))
999 struct glyph_row
*hl_row
1000 = (w
->current_matrix
&& w
->current_matrix
->rows
1001 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1003 if (hl_row
&& hl_row
->mode_line_p
)
1004 height
-= hl_row
->height
;
1006 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1009 /* With a very small font and a mode-line that's taller than
1010 default, we might end up with a negative height. */
1011 return max (0, height
);
1014 /* Return the window-relative coordinate of the left edge of display
1015 area AREA of window W. ANY_AREA means return the left edge of the
1016 whole window, to the right of the left fringe of W. */
1019 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1023 if (w
->pseudo_window_p
)
1026 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1028 if (area
== TEXT_AREA
)
1029 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1030 + window_box_width (w
, LEFT_MARGIN_AREA
));
1031 else if (area
== RIGHT_MARGIN_AREA
)
1032 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1033 + window_box_width (w
, LEFT_MARGIN_AREA
)
1034 + window_box_width (w
, TEXT_AREA
)
1035 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1037 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1038 else if (area
== LEFT_MARGIN_AREA
1039 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1040 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1042 /* Don't return more than the window's pixel width. */
1043 return min (x
, w
->pixel_width
);
1047 /* Return the window-relative coordinate of the right edge of display
1048 area AREA of window W. ANY_AREA means return the right edge of the
1049 whole window, to the left of the right fringe of W. */
1052 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1054 /* Don't return more than the window's pixel width. */
1055 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1059 /* Return the frame-relative coordinate of the left edge of display
1060 area AREA of window W. ANY_AREA means return the left edge of the
1061 whole window, to the right of the left fringe of W. */
1064 window_box_left (struct window
*w
, enum glyph_row_area area
)
1066 struct frame
*f
= XFRAME (w
->frame
);
1069 if (w
->pseudo_window_p
)
1070 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1072 x
= (WINDOW_LEFT_EDGE_X (w
)
1073 + window_box_left_offset (w
, area
));
1079 /* Return the frame-relative coordinate of the right edge of display
1080 area AREA of window W. ANY_AREA means return the right edge of the
1081 whole window, to the left of the right fringe of W. */
1084 window_box_right (struct window
*w
, enum glyph_row_area area
)
1086 return window_box_left (w
, area
) + window_box_width (w
, area
);
1089 /* Get the bounding box of the display area AREA of window W, without
1090 mode lines, in frame-relative coordinates. ANY_AREA means the
1091 whole window, not including the left and right fringes of
1092 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1093 coordinates of the upper-left corner of the box. Return in
1094 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1097 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1098 int *box_y
, int *box_width
, int *box_height
)
1101 *box_width
= window_box_width (w
, area
);
1103 *box_height
= window_box_height (w
);
1105 *box_x
= window_box_left (w
, area
);
1108 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1109 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1110 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1114 #ifdef HAVE_WINDOW_SYSTEM
1116 /* Get the bounding box of the display area AREA of window W, without
1117 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1118 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1119 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1120 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1124 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1125 int *bottom_right_x
, int *bottom_right_y
)
1127 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1128 bottom_right_x
, bottom_right_y
);
1129 *bottom_right_x
+= *top_left_x
;
1130 *bottom_right_y
+= *top_left_y
;
1133 #endif /* HAVE_WINDOW_SYSTEM */
1135 /***********************************************************************
1137 ***********************************************************************/
1139 /* Return the bottom y-position of the line the iterator IT is in.
1140 This can modify IT's settings. */
1143 line_bottom_y (struct it
*it
)
1145 int line_height
= it
->max_ascent
+ it
->max_descent
;
1146 int line_top_y
= it
->current_y
;
1148 if (line_height
== 0)
1151 line_height
= last_height
;
1152 else if (IT_CHARPOS (*it
) < ZV
)
1154 move_it_by_lines (it
, 1);
1155 line_height
= (it
->max_ascent
|| it
->max_descent
1156 ? it
->max_ascent
+ it
->max_descent
1161 struct glyph_row
*row
= it
->glyph_row
;
1163 /* Use the default character height. */
1164 it
->glyph_row
= NULL
;
1165 it
->what
= IT_CHARACTER
;
1168 PRODUCE_GLYPHS (it
);
1169 line_height
= it
->ascent
+ it
->descent
;
1170 it
->glyph_row
= row
;
1174 return line_top_y
+ line_height
;
1177 DEFUN ("line-pixel-height", Fline_pixel_height
,
1178 Sline_pixel_height
, 0, 0, 0,
1179 doc
: /* Return height in pixels of text line in the selected window.
1181 Value is the height in pixels of the line at point. */)
1186 struct window
*w
= XWINDOW (selected_window
);
1187 struct buffer
*old_buffer
= NULL
;
1190 if (XBUFFER (w
->contents
) != current_buffer
)
1192 old_buffer
= current_buffer
;
1193 set_buffer_internal_1 (XBUFFER (w
->contents
));
1195 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1196 start_display (&it
, w
, pt
);
1197 it
.vpos
= it
.current_y
= 0;
1199 result
= make_number (line_bottom_y (&it
));
1201 set_buffer_internal_1 (old_buffer
);
1206 /* Return the default pixel height of text lines in window W. The
1207 value is the canonical height of the W frame's default font, plus
1208 any extra space required by the line-spacing variable or frame
1211 Implementation note: this ignores any line-spacing text properties
1212 put on the newline characters. This is because those properties
1213 only affect the _screen_ line ending in the newline (i.e., in a
1214 continued line, only the last screen line will be affected), which
1215 means only a small number of lines in a buffer can ever use this
1216 feature. Since this function is used to compute the default pixel
1217 equivalent of text lines in a window, we can safely ignore those
1218 few lines. For the same reasons, we ignore the line-height
1221 default_line_pixel_height (struct window
*w
)
1223 struct frame
*f
= WINDOW_XFRAME (w
);
1224 int height
= FRAME_LINE_HEIGHT (f
);
1226 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1228 struct buffer
*b
= XBUFFER (w
->contents
);
1229 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1232 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1235 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1236 height
+= XFASTINT (val
);
1237 else if (FLOATP (val
))
1239 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1246 height
+= f
->extra_line_spacing
;
1252 /* Subroutine of pos_visible_p below. Extracts a display string, if
1253 any, from the display spec given as its argument. */
1255 string_from_display_spec (Lisp_Object spec
)
1259 while (CONSP (spec
))
1261 if (STRINGP (XCAR (spec
)))
1266 else if (VECTORP (spec
))
1270 for (i
= 0; i
< ASIZE (spec
); i
++)
1272 if (STRINGP (AREF (spec
, i
)))
1273 return AREF (spec
, i
);
1282 /* Limit insanely large values of W->hscroll on frame F to the largest
1283 value that will still prevent first_visible_x and last_visible_x of
1284 'struct it' from overflowing an int. */
1286 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1288 ptrdiff_t window_hscroll
= w
->hscroll
;
1289 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1290 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1292 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1293 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1295 return window_hscroll
;
1298 /* Return 1 if position CHARPOS is visible in window W.
1299 CHARPOS < 0 means return info about WINDOW_END position.
1300 If visible, set *X and *Y to pixel coordinates of top left corner.
1301 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1302 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1305 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1306 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1309 void *itdata
= bidi_shelve_cache ();
1310 struct text_pos top
;
1312 struct buffer
*old_buffer
= NULL
;
1315 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1318 if (XBUFFER (w
->contents
) != current_buffer
)
1320 old_buffer
= current_buffer
;
1321 set_buffer_internal_1 (XBUFFER (w
->contents
));
1324 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1325 /* Scrolling a minibuffer window via scroll bar when the echo area
1326 shows long text sometimes resets the minibuffer contents behind
1328 if (CHARPOS (top
) > ZV
)
1329 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1331 /* Compute exact mode line heights. */
1332 if (WINDOW_WANTS_MODELINE_P (w
))
1334 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1335 BVAR (current_buffer
, mode_line_format
));
1337 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1338 w
->header_line_height
1339 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1340 BVAR (current_buffer
, header_line_format
));
1342 start_display (&it
, w
, top
);
1343 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1344 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1347 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1348 && IT_CHARPOS (it
) >= charpos
)
1349 /* When scanning backwards under bidi iteration, move_it_to
1350 stops at or _before_ CHARPOS, because it stops at or to
1351 the _right_ of the character at CHARPOS. */
1352 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1353 && IT_CHARPOS (it
) <= charpos
)))
1355 /* We have reached CHARPOS, or passed it. How the call to
1356 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1357 or covered by a display property, move_it_to stops at the end
1358 of the invisible text, to the right of CHARPOS. (ii) If
1359 CHARPOS is in a display vector, move_it_to stops on its last
1361 int top_x
= it
.current_x
;
1362 int top_y
= it
.current_y
;
1363 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1366 void *save_it_data
= NULL
;
1368 /* Calling line_bottom_y may change it.method, it.position, etc. */
1369 SAVE_IT (save_it
, it
, save_it_data
);
1371 bottom_y
= line_bottom_y (&it
);
1372 if (top_y
< window_top_y
)
1373 visible_p
= bottom_y
> window_top_y
;
1374 else if (top_y
< it
.last_visible_y
)
1376 if (bottom_y
>= it
.last_visible_y
1377 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1378 && IT_CHARPOS (it
) < charpos
)
1380 /* When the last line of the window is scanned backwards
1381 under bidi iteration, we could be duped into thinking
1382 that we have passed CHARPOS, when in fact move_it_to
1383 simply stopped short of CHARPOS because it reached
1384 last_visible_y. To see if that's what happened, we call
1385 move_it_to again with a slightly larger vertical limit,
1386 and see if it actually moved vertically; if it did, we
1387 didn't really reach CHARPOS, which is beyond window end. */
1388 /* Why 10? because we don't know how many canonical lines
1389 will the height of the next line(s) be. So we guess. */
1390 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1392 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1393 MOVE_TO_POS
| MOVE_TO_Y
);
1394 if (it
.current_y
> top_y
)
1398 RESTORE_IT (&it
, &save_it
, save_it_data
);
1401 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1403 /* We stopped on the last glyph of a display vector.
1404 Try and recompute. Hack alert! */
1405 if (charpos
< 2 || top
.charpos
>= charpos
)
1406 top_x
= it
.glyph_row
->x
;
1409 struct it it2
, it2_prev
;
1410 /* The idea is to get to the previous buffer
1411 position, consume the character there, and use
1412 the pixel coordinates we get after that. But if
1413 the previous buffer position is also displayed
1414 from a display vector, we need to consume all of
1415 the glyphs from that display vector. */
1416 start_display (&it2
, w
, top
);
1417 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1418 /* If we didn't get to CHARPOS - 1, there's some
1419 replacing display property at that position, and
1420 we stopped after it. That is exactly the place
1421 whose coordinates we want. */
1422 if (IT_CHARPOS (it2
) != charpos
- 1)
1426 /* Iterate until we get out of the display
1427 vector that displays the character at
1430 get_next_display_element (&it2
);
1431 PRODUCE_GLYPHS (&it2
);
1433 set_iterator_to_next (&it2
, 1);
1434 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1435 && IT_CHARPOS (it2
) < charpos
);
1437 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1438 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1439 top_x
= it
.glyph_row
->x
;
1442 top_x
= it2_prev
.current_x
;
1443 top_y
= it2_prev
.current_y
;
1447 else if (IT_CHARPOS (it
) != charpos
)
1449 Lisp_Object cpos
= make_number (charpos
);
1450 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1451 Lisp_Object string
= string_from_display_spec (spec
);
1452 struct text_pos tpos
;
1453 int replacing_spec_p
;
1454 bool newline_in_string
1456 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1458 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1461 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1462 charpos
, FRAME_WINDOW_P (it
.f
)));
1463 /* The tricky code below is needed because there's a
1464 discrepancy between move_it_to and how we set cursor
1465 when PT is at the beginning of a portion of text
1466 covered by a display property or an overlay with a
1467 display property, or the display line ends in a
1468 newline from a display string. move_it_to will stop
1469 _after_ such display strings, whereas
1470 set_cursor_from_row conspires with cursor_row_p to
1471 place the cursor on the first glyph produced from the
1474 /* We have overshoot PT because it is covered by a
1475 display property that replaces the text it covers.
1476 If the string includes embedded newlines, we are also
1477 in the wrong display line. Backtrack to the correct
1478 line, where the display property begins. */
1479 if (replacing_spec_p
)
1481 Lisp_Object startpos
, endpos
;
1482 EMACS_INT start
, end
;
1486 /* Find the first and the last buffer positions
1487 covered by the display string. */
1489 Fnext_single_char_property_change (cpos
, Qdisplay
,
1492 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1494 start
= XFASTINT (startpos
);
1495 end
= XFASTINT (endpos
);
1496 /* Move to the last buffer position before the
1497 display property. */
1498 start_display (&it3
, w
, top
);
1499 if (start
> CHARPOS (top
))
1500 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1501 /* Move forward one more line if the position before
1502 the display string is a newline or if it is the
1503 rightmost character on a line that is
1504 continued or word-wrapped. */
1505 if (it3
.method
== GET_FROM_BUFFER
1507 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1508 move_it_by_lines (&it3
, 1);
1509 else if (move_it_in_display_line_to (&it3
, -1,
1513 == MOVE_LINE_CONTINUED
)
1515 move_it_by_lines (&it3
, 1);
1516 /* When we are under word-wrap, the #$@%!
1517 move_it_by_lines moves 2 lines, so we need to
1519 if (it3
.line_wrap
== WORD_WRAP
)
1520 move_it_by_lines (&it3
, -1);
1523 /* Record the vertical coordinate of the display
1524 line where we wound up. */
1525 top_y
= it3
.current_y
;
1528 /* When characters are reordered for display,
1529 the character displayed to the left of the
1530 display string could be _after_ the display
1531 property in the logical order. Use the
1532 smallest vertical position of these two. */
1533 start_display (&it3
, w
, top
);
1534 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1535 if (it3
.current_y
< top_y
)
1536 top_y
= it3
.current_y
;
1538 /* Move from the top of the window to the beginning
1539 of the display line where the display string
1541 start_display (&it3
, w
, top
);
1542 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1543 /* If it3_moved stays zero after the 'while' loop
1544 below, that means we already were at a newline
1545 before the loop (e.g., the display string begins
1546 with a newline), so we don't need to (and cannot)
1547 inspect the glyphs of it3.glyph_row, because
1548 PRODUCE_GLYPHS will not produce anything for a
1549 newline, and thus it3.glyph_row stays at its
1550 stale content it got at top of the window. */
1552 /* Finally, advance the iterator until we hit the
1553 first display element whose character position is
1554 CHARPOS, or until the first newline from the
1555 display string, which signals the end of the
1557 while (get_next_display_element (&it3
))
1559 PRODUCE_GLYPHS (&it3
);
1560 if (IT_CHARPOS (it3
) == charpos
1561 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1564 set_iterator_to_next (&it3
, 0);
1566 top_x
= it3
.current_x
- it3
.pixel_width
;
1567 /* Normally, we would exit the above loop because we
1568 found the display element whose character
1569 position is CHARPOS. For the contingency that we
1570 didn't, and stopped at the first newline from the
1571 display string, move back over the glyphs
1572 produced from the string, until we find the
1573 rightmost glyph not from the string. */
1575 && newline_in_string
1576 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1578 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1579 + it3
.glyph_row
->used
[TEXT_AREA
];
1581 while (EQ ((g
- 1)->object
, string
))
1584 top_x
-= g
->pixel_width
;
1586 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1587 + it3
.glyph_row
->used
[TEXT_AREA
]);
1593 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1594 *rtop
= max (0, window_top_y
- top_y
);
1595 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1596 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1597 - max (top_y
, window_top_y
)));
1599 if (it
.bidi_it
.paragraph_dir
== R2L
)
1605 /* Either we were asked to provide info about WINDOW_END, or
1606 CHARPOS is in the partially visible glyph row at end of
1609 void *it2data
= NULL
;
1611 SAVE_IT (it2
, it
, it2data
);
1612 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1613 move_it_by_lines (&it
, 1);
1614 if (charpos
< IT_CHARPOS (it
)
1615 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1618 RESTORE_IT (&it2
, &it2
, it2data
);
1619 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1621 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1622 *rtop
= max (0, -it2
.current_y
);
1623 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1624 - it
.last_visible_y
));
1625 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1627 - max (it2
.current_y
,
1628 WINDOW_HEADER_LINE_HEIGHT (w
))));
1630 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1634 bidi_unshelve_cache (it2data
, 1);
1636 bidi_unshelve_cache (itdata
, 0);
1639 set_buffer_internal_1 (old_buffer
);
1645 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1646 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1647 /* For lines in an R2L paragraph, we need to mirror the X pixel
1648 coordinate wrt the text area. For the reasons, see the
1649 commentary in buffer_posn_from_coords and the explanation of
1650 the geometry used by the move_it_* functions at the end of
1651 the large commentary near the beginning of this file. */
1653 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1657 /* Debugging code. */
1659 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1660 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1662 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1669 /* Return the next character from STR. Return in *LEN the length of
1670 the character. This is like STRING_CHAR_AND_LENGTH but never
1671 returns an invalid character. If we find one, we return a `?', but
1672 with the length of the invalid character. */
1675 string_char_and_length (const unsigned char *str
, int *len
)
1679 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1680 if (!CHAR_VALID_P (c
))
1681 /* We may not change the length here because other places in Emacs
1682 don't use this function, i.e. they silently accept invalid
1691 /* Given a position POS containing a valid character and byte position
1692 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1694 static struct text_pos
1695 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1697 eassert (STRINGP (string
) && nchars
>= 0);
1699 if (STRING_MULTIBYTE (string
))
1701 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1706 string_char_and_length (p
, &len
);
1709 BYTEPOS (pos
) += len
;
1713 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1719 /* Value is the text position, i.e. character and byte position,
1720 for character position CHARPOS in STRING. */
1722 static struct text_pos
1723 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1725 struct text_pos pos
;
1726 eassert (STRINGP (string
));
1727 eassert (charpos
>= 0);
1728 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1733 /* Value is a text position, i.e. character and byte position, for
1734 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1735 means recognize multibyte characters. */
1737 static struct text_pos
1738 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1740 struct text_pos pos
;
1742 eassert (s
!= NULL
);
1743 eassert (charpos
>= 0);
1749 SET_TEXT_POS (pos
, 0, 0);
1752 string_char_and_length ((const unsigned char *) s
, &len
);
1755 BYTEPOS (pos
) += len
;
1759 SET_TEXT_POS (pos
, charpos
, charpos
);
1765 /* Value is the number of characters in C string S. MULTIBYTE_P
1766 non-zero means recognize multibyte characters. */
1769 number_of_chars (const char *s
, bool multibyte_p
)
1775 ptrdiff_t rest
= strlen (s
);
1777 const unsigned char *p
= (const unsigned char *) s
;
1779 for (nchars
= 0; rest
> 0; ++nchars
)
1781 string_char_and_length (p
, &len
);
1782 rest
-= len
, p
+= len
;
1786 nchars
= strlen (s
);
1792 /* Compute byte position NEWPOS->bytepos corresponding to
1793 NEWPOS->charpos. POS is a known position in string STRING.
1794 NEWPOS->charpos must be >= POS.charpos. */
1797 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1799 eassert (STRINGP (string
));
1800 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1802 if (STRING_MULTIBYTE (string
))
1803 *newpos
= string_pos_nchars_ahead (pos
, string
,
1804 CHARPOS (*newpos
) - CHARPOS (pos
));
1806 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1810 Return an estimation of the pixel height of mode or header lines on
1811 frame F. FACE_ID specifies what line's height to estimate. */
1814 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1816 #ifdef HAVE_WINDOW_SYSTEM
1817 if (FRAME_WINDOW_P (f
))
1819 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1821 /* This function is called so early when Emacs starts that the face
1822 cache and mode line face are not yet initialized. */
1823 if (FRAME_FACE_CACHE (f
))
1825 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1829 height
= FONT_HEIGHT (face
->font
);
1830 if (face
->box_line_width
> 0)
1831 height
+= 2 * face
->box_line_width
;
1842 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1843 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1844 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1845 not force the value into range. */
1848 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1849 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1852 #ifdef HAVE_WINDOW_SYSTEM
1853 if (FRAME_WINDOW_P (f
))
1855 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1856 even for negative values. */
1858 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1860 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1862 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1863 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1866 STORE_NATIVE_RECT (*bounds
,
1867 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1868 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1869 FRAME_COLUMN_WIDTH (f
) - 1,
1870 FRAME_LINE_HEIGHT (f
) - 1);
1872 /* PXW: Should we clip pixels before converting to columns/lines? */
1877 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1878 pix_x
= FRAME_TOTAL_COLS (f
);
1882 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1883 pix_y
= FRAME_TOTAL_LINES (f
);
1893 /* Find the glyph under window-relative coordinates X/Y in window W.
1894 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1895 strings. Return in *HPOS and *VPOS the row and column number of
1896 the glyph found. Return in *AREA the glyph area containing X.
1897 Value is a pointer to the glyph found or null if X/Y is not on
1898 text, or we can't tell because W's current matrix is not up to
1901 static struct glyph
*
1902 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1903 int *dx
, int *dy
, int *area
)
1905 struct glyph
*glyph
, *end
;
1906 struct glyph_row
*row
= NULL
;
1909 /* Find row containing Y. Give up if some row is not enabled. */
1910 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1912 row
= MATRIX_ROW (w
->current_matrix
, i
);
1913 if (!row
->enabled_p
)
1915 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1922 /* Give up if Y is not in the window. */
1923 if (i
== w
->current_matrix
->nrows
)
1926 /* Get the glyph area containing X. */
1927 if (w
->pseudo_window_p
)
1934 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1936 *area
= LEFT_MARGIN_AREA
;
1937 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1939 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1942 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1946 *area
= RIGHT_MARGIN_AREA
;
1947 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1951 /* Find glyph containing X. */
1952 glyph
= row
->glyphs
[*area
];
1953 end
= glyph
+ row
->used
[*area
];
1955 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1957 x
-= glyph
->pixel_width
;
1967 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1970 *hpos
= glyph
- row
->glyphs
[*area
];
1974 /* Convert frame-relative x/y to coordinates relative to window W.
1975 Takes pseudo-windows into account. */
1978 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1980 if (w
->pseudo_window_p
)
1982 /* A pseudo-window is always full-width, and starts at the
1983 left edge of the frame, plus a frame border. */
1984 struct frame
*f
= XFRAME (w
->frame
);
1985 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1986 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1990 *x
-= WINDOW_LEFT_EDGE_X (w
);
1991 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1995 #ifdef HAVE_WINDOW_SYSTEM
1998 Return in RECTS[] at most N clipping rectangles for glyph string S.
1999 Return the number of stored rectangles. */
2002 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2009 if (s
->row
->full_width_p
)
2011 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2012 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2013 if (s
->row
->mode_line_p
)
2014 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2016 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2018 /* Unless displaying a mode or menu bar line, which are always
2019 fully visible, clip to the visible part of the row. */
2020 if (s
->w
->pseudo_window_p
)
2021 r
.height
= s
->row
->visible_height
;
2023 r
.height
= s
->height
;
2027 /* This is a text line that may be partially visible. */
2028 r
.x
= window_box_left (s
->w
, s
->area
);
2029 r
.width
= window_box_width (s
->w
, s
->area
);
2030 r
.height
= s
->row
->visible_height
;
2034 if (r
.x
< s
->clip_head
->x
)
2036 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2037 r
.width
-= s
->clip_head
->x
- r
.x
;
2040 r
.x
= s
->clip_head
->x
;
2043 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2045 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2046 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2051 /* If S draws overlapping rows, it's sufficient to use the top and
2052 bottom of the window for clipping because this glyph string
2053 intentionally draws over other lines. */
2054 if (s
->for_overlaps
)
2056 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2057 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2059 /* Alas, the above simple strategy does not work for the
2060 environments with anti-aliased text: if the same text is
2061 drawn onto the same place multiple times, it gets thicker.
2062 If the overlap we are processing is for the erased cursor, we
2063 take the intersection with the rectangle of the cursor. */
2064 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2066 XRectangle rc
, r_save
= r
;
2068 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2069 rc
.y
= s
->w
->phys_cursor
.y
;
2070 rc
.width
= s
->w
->phys_cursor_width
;
2071 rc
.height
= s
->w
->phys_cursor_height
;
2073 x_intersect_rectangles (&r_save
, &rc
, &r
);
2078 /* Don't use S->y for clipping because it doesn't take partially
2079 visible lines into account. For example, it can be negative for
2080 partially visible lines at the top of a window. */
2081 if (!s
->row
->full_width_p
2082 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2083 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2085 r
.y
= max (0, s
->row
->y
);
2088 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2090 /* If drawing the cursor, don't let glyph draw outside its
2091 advertised boundaries. Cleartype does this under some circumstances. */
2092 if (s
->hl
== DRAW_CURSOR
)
2094 struct glyph
*glyph
= s
->first_glyph
;
2099 if (r
.width
>= s
->x
- r
.x
)
2100 r
.width
-= s
->x
- r
.x
;
2101 else /* R2L hscrolled row with cursor outside text area */
2105 r
.width
= min (r
.width
, glyph
->pixel_width
);
2107 /* If r.y is below window bottom, ensure that we still see a cursor. */
2108 height
= min (glyph
->ascent
+ glyph
->descent
,
2109 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2110 max_y
= window_text_bottom_y (s
->w
) - height
;
2111 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2112 if (s
->ybase
- glyph
->ascent
> max_y
)
2119 /* Don't draw cursor glyph taller than our actual glyph. */
2120 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2121 if (height
< r
.height
)
2123 max_y
= r
.y
+ r
.height
;
2124 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2125 r
.height
= min (max_y
- r
.y
, height
);
2132 XRectangle r_save
= r
;
2134 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2138 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2139 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2141 #ifdef CONVERT_FROM_XRECT
2142 CONVERT_FROM_XRECT (r
, *rects
);
2150 /* If we are processing overlapping and allowed to return
2151 multiple clipping rectangles, we exclude the row of the glyph
2152 string from the clipping rectangle. This is to avoid drawing
2153 the same text on the environment with anti-aliasing. */
2154 #ifdef CONVERT_FROM_XRECT
2157 XRectangle
*rs
= rects
;
2159 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2161 if (s
->for_overlaps
& OVERLAPS_PRED
)
2164 if (r
.y
+ r
.height
> row_y
)
2167 rs
[i
].height
= row_y
- r
.y
;
2173 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2176 if (r
.y
< row_y
+ s
->row
->visible_height
)
2178 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2180 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2181 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2190 #ifdef CONVERT_FROM_XRECT
2191 for (i
= 0; i
< n
; i
++)
2192 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2199 Return in *NR the clipping rectangle for glyph string S. */
2202 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2204 get_glyph_string_clip_rects (s
, nr
, 1);
2209 Return the position and height of the phys cursor in window W.
2210 Set w->phys_cursor_width to width of phys cursor.
2214 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2215 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2217 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2218 int x
, y
, wd
, h
, h0
, y0
;
2220 /* Compute the width of the rectangle to draw. If on a stretch
2221 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2222 rectangle as wide as the glyph, but use a canonical character
2224 wd
= glyph
->pixel_width
;
2226 x
= w
->phys_cursor
.x
;
2233 if (glyph
->type
== STRETCH_GLYPH
2234 && !x_stretch_cursor_p
)
2235 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2236 w
->phys_cursor_width
= wd
;
2238 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2240 /* If y is below window bottom, ensure that we still see a cursor. */
2241 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2243 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2244 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2246 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2249 h
= max (h
- (y0
- y
) + 1, h0
);
2254 y0
= window_text_bottom_y (w
) - h0
;
2262 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2263 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2268 * Remember which glyph the mouse is over.
2272 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2276 struct glyph_row
*r
, *gr
, *end_row
;
2277 enum window_part part
;
2278 enum glyph_row_area area
;
2279 int x
, y
, width
, height
;
2281 /* Try to determine frame pixel position and size of the glyph under
2282 frame pixel coordinates X/Y on frame F. */
2284 if (window_resize_pixelwise
)
2289 else if (!f
->glyphs_initialized_p
2290 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2293 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2294 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2298 w
= XWINDOW (window
);
2299 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2300 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2302 x
= window_relative_x_coord (w
, part
, gx
);
2303 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2305 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2306 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2308 if (w
->pseudo_window_p
)
2311 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2317 case ON_LEFT_MARGIN
:
2318 area
= LEFT_MARGIN_AREA
;
2321 case ON_RIGHT_MARGIN
:
2322 area
= RIGHT_MARGIN_AREA
;
2325 case ON_HEADER_LINE
:
2327 gr
= (part
== ON_HEADER_LINE
2328 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2329 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2332 goto text_glyph_row_found
;
2339 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2340 if (r
->y
+ r
->height
> y
)
2346 text_glyph_row_found
:
2349 struct glyph
*g
= gr
->glyphs
[area
];
2350 struct glyph
*end
= g
+ gr
->used
[area
];
2352 height
= gr
->height
;
2353 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2354 if (gx
+ g
->pixel_width
> x
)
2359 if (g
->type
== IMAGE_GLYPH
)
2361 /* Don't remember when mouse is over image, as
2362 image may have hot-spots. */
2363 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2366 width
= g
->pixel_width
;
2370 /* Use nominal char spacing at end of line. */
2372 gx
+= (x
/ width
) * width
;
2375 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2377 gx
+= window_box_left_offset (w
, area
);
2378 /* Don't expand over the modeline to make sure the vertical
2379 drag cursor is shown early enough. */
2380 height
= min (height
,
2381 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2386 /* Use nominal line height at end of window. */
2387 gx
= (x
/ width
) * width
;
2389 gy
+= (y
/ height
) * height
;
2390 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2391 /* See comment above. */
2392 height
= min (height
,
2393 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2397 case ON_LEFT_FRINGE
:
2398 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2399 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2400 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2401 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2404 case ON_RIGHT_FRINGE
:
2405 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2406 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2407 : window_box_right_offset (w
, TEXT_AREA
));
2408 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2409 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2410 && !WINDOW_RIGHTMOST_P (w
))
2411 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2412 /* Make sure the vertical border can get her own glyph to the
2413 right of the one we build here. */
2414 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2416 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2418 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2422 case ON_VERTICAL_BORDER
:
2423 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2426 case ON_VERTICAL_SCROLL_BAR
:
2427 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2429 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2430 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2431 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2433 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2437 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2438 if (r
->y
+ r
->height
> y
)
2445 height
= gr
->height
;
2448 /* Use nominal line height at end of window. */
2450 gy
+= (y
/ height
) * height
;
2454 case ON_RIGHT_DIVIDER
:
2455 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2456 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2458 /* The bottom divider prevails. */
2459 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2462 case ON_BOTTOM_DIVIDER
:
2464 width
= WINDOW_PIXEL_WIDTH (w
);
2465 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2466 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2472 /* If there is no glyph under the mouse, then we divide the screen
2473 into a grid of the smallest glyph in the frame, and use that
2476 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2477 round down even for negative values. */
2483 gx
= (gx
/ width
) * width
;
2484 gy
= (gy
/ height
) * height
;
2490 gx
+= WINDOW_LEFT_EDGE_X (w
);
2491 gy
+= WINDOW_TOP_EDGE_Y (w
);
2494 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2496 /* Visible feedback for debugging. */
2499 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2500 f
->output_data
.x
->normal_gc
,
2501 gx
, gy
, width
, height
);
2507 #endif /* HAVE_WINDOW_SYSTEM */
2510 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2513 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2514 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2516 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2519 /***********************************************************************
2520 Lisp form evaluation
2521 ***********************************************************************/
2523 /* Error handler for safe_eval and safe_call. */
2526 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2528 add_to_log ("Error during redisplay: %S signaled %S",
2529 Flist (nargs
, args
), arg
);
2533 /* Call function FUNC with the rest of NARGS - 1 arguments
2534 following. Return the result, or nil if something went
2535 wrong. Prevent redisplay during the evaluation. */
2538 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2542 if (inhibit_eval_during_redisplay
)
2547 ptrdiff_t count
= SPECPDL_INDEX ();
2550 SAFE_ALLOCA_LISP (args
, nargs
);
2553 for (i
= 1; i
< nargs
; i
++)
2554 args
[i
] = va_arg (ap
, Lisp_Object
);
2556 specbind (Qinhibit_redisplay
, Qt
);
2558 specbind (Qinhibit_quit
, Qt
);
2559 /* Use Qt to ensure debugger does not run,
2560 so there is no possibility of wanting to redisplay. */
2561 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2564 val
= unbind_to (count
, val
);
2571 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2576 va_start (ap
, func
);
2577 retval
= safe__call (false, nargs
, func
, ap
);
2582 /* Call function FN with one argument ARG.
2583 Return the result, or nil if something went wrong. */
2586 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2588 return safe_call (2, fn
, arg
);
2592 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2598 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2604 safe_eval (Lisp_Object sexpr
)
2606 return safe__call1 (false, Qeval
, sexpr
);
2610 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2612 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2615 /* Call function FN with two arguments ARG1 and ARG2.
2616 Return the result, or nil if something went wrong. */
2619 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2621 return safe_call (3, fn
, arg1
, arg2
);
2626 /***********************************************************************
2628 ***********************************************************************/
2632 /* Define CHECK_IT to perform sanity checks on iterators.
2633 This is for debugging. It is too slow to do unconditionally. */
2636 check_it (struct it
*it
)
2638 if (it
->method
== GET_FROM_STRING
)
2640 eassert (STRINGP (it
->string
));
2641 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2645 eassert (IT_STRING_CHARPOS (*it
) < 0);
2646 if (it
->method
== GET_FROM_BUFFER
)
2648 /* Check that character and byte positions agree. */
2649 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2654 eassert (it
->current
.dpvec_index
>= 0);
2656 eassert (it
->current
.dpvec_index
< 0);
2659 #define CHECK_IT(IT) check_it ((IT))
2663 #define CHECK_IT(IT) (void) 0
2668 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2670 /* Check that the window end of window W is what we expect it
2671 to be---the last row in the current matrix displaying text. */
2674 check_window_end (struct window
*w
)
2676 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2678 struct glyph_row
*row
;
2679 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2681 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2682 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2686 #define CHECK_WINDOW_END(W) check_window_end ((W))
2690 #define CHECK_WINDOW_END(W) (void) 0
2692 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2694 /***********************************************************************
2695 Iterator initialization
2696 ***********************************************************************/
2698 /* Initialize IT for displaying current_buffer in window W, starting
2699 at character position CHARPOS. CHARPOS < 0 means that no buffer
2700 position is specified which is useful when the iterator is assigned
2701 a position later. BYTEPOS is the byte position corresponding to
2704 If ROW is not null, calls to produce_glyphs with IT as parameter
2705 will produce glyphs in that row.
2707 BASE_FACE_ID is the id of a base face to use. It must be one of
2708 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2709 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2710 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2712 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2713 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2714 will be initialized to use the corresponding mode line glyph row of
2715 the desired matrix of W. */
2718 init_iterator (struct it
*it
, struct window
*w
,
2719 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2720 struct glyph_row
*row
, enum face_id base_face_id
)
2722 enum face_id remapped_base_face_id
= base_face_id
;
2724 /* Some precondition checks. */
2725 eassert (w
!= NULL
&& it
!= NULL
);
2726 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2729 /* If face attributes have been changed since the last redisplay,
2730 free realized faces now because they depend on face definitions
2731 that might have changed. Don't free faces while there might be
2732 desired matrices pending which reference these faces. */
2733 if (face_change
&& !inhibit_free_realized_faces
)
2735 face_change
= false;
2736 free_all_realized_faces (Qnil
);
2739 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2740 if (! NILP (Vface_remapping_alist
))
2741 remapped_base_face_id
2742 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2744 /* Use one of the mode line rows of W's desired matrix if
2748 if (base_face_id
== MODE_LINE_FACE_ID
2749 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2750 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2751 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2752 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2755 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2756 Other parts of redisplay rely on that. */
2757 memclear (it
, sizeof *it
);
2758 it
->current
.overlay_string_index
= -1;
2759 it
->current
.dpvec_index
= -1;
2760 it
->base_face_id
= remapped_base_face_id
;
2761 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2762 it
->paragraph_embedding
= L2R
;
2765 /* The window in which we iterate over current_buffer: */
2766 XSETWINDOW (it
->window
, w
);
2768 it
->f
= XFRAME (w
->frame
);
2772 /* Extra space between lines (on window systems only). */
2773 if (base_face_id
== DEFAULT_FACE_ID
2774 && FRAME_WINDOW_P (it
->f
))
2776 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2777 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2778 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2779 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2780 * FRAME_LINE_HEIGHT (it
->f
));
2781 else if (it
->f
->extra_line_spacing
> 0)
2782 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2785 /* If realized faces have been removed, e.g. because of face
2786 attribute changes of named faces, recompute them. When running
2787 in batch mode, the face cache of the initial frame is null. If
2788 we happen to get called, make a dummy face cache. */
2789 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2790 init_frame_faces (it
->f
);
2791 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2792 recompute_basic_faces (it
->f
);
2794 it
->override_ascent
= -1;
2796 /* Are control characters displayed as `^C'? */
2797 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2799 /* -1 means everything between a CR and the following line end
2800 is invisible. >0 means lines indented more than this value are
2802 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2804 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2806 : (!NILP (BVAR (current_buffer
, selective_display
))
2808 it
->selective_display_ellipsis_p
2809 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2811 /* Display table to use. */
2812 it
->dp
= window_display_table (w
);
2814 /* Are multibyte characters enabled in current_buffer? */
2815 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2817 /* Get the position at which the redisplay_end_trigger hook should
2818 be run, if it is to be run at all. */
2819 if (MARKERP (w
->redisplay_end_trigger
)
2820 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2821 it
->redisplay_end_trigger_charpos
2822 = marker_position (w
->redisplay_end_trigger
);
2823 else if (INTEGERP (w
->redisplay_end_trigger
))
2824 it
->redisplay_end_trigger_charpos
2825 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2828 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2830 /* Are lines in the display truncated? */
2832 it
->line_wrap
= TRUNCATE
;
2833 if (base_face_id
== DEFAULT_FACE_ID
2835 && (WINDOW_FULL_WIDTH_P (it
->w
)
2836 || NILP (Vtruncate_partial_width_windows
)
2837 || (INTEGERP (Vtruncate_partial_width_windows
)
2838 /* PXW: Shall we do something about this? */
2839 && (XINT (Vtruncate_partial_width_windows
)
2840 <= WINDOW_TOTAL_COLS (it
->w
))))
2841 && NILP (BVAR (current_buffer
, truncate_lines
)))
2842 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2843 ? WINDOW_WRAP
: WORD_WRAP
;
2845 /* Get dimensions of truncation and continuation glyphs. These are
2846 displayed as fringe bitmaps under X, but we need them for such
2847 frames when the fringes are turned off. But leave the dimensions
2848 zero for tooltip frames, as these glyphs look ugly there and also
2849 sabotage calculations of tooltip dimensions in x-show-tip. */
2850 #ifdef HAVE_WINDOW_SYSTEM
2851 if (!(FRAME_WINDOW_P (it
->f
)
2852 && FRAMEP (tip_frame
)
2853 && it
->f
== XFRAME (tip_frame
)))
2856 if (it
->line_wrap
== TRUNCATE
)
2858 /* We will need the truncation glyph. */
2859 eassert (it
->glyph_row
== NULL
);
2860 produce_special_glyphs (it
, IT_TRUNCATION
);
2861 it
->truncation_pixel_width
= it
->pixel_width
;
2865 /* We will need the continuation glyph. */
2866 eassert (it
->glyph_row
== NULL
);
2867 produce_special_glyphs (it
, IT_CONTINUATION
);
2868 it
->continuation_pixel_width
= it
->pixel_width
;
2872 /* Reset these values to zero because the produce_special_glyphs
2873 above has changed them. */
2874 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2875 it
->phys_ascent
= it
->phys_descent
= 0;
2877 /* Set this after getting the dimensions of truncation and
2878 continuation glyphs, so that we don't produce glyphs when calling
2879 produce_special_glyphs, above. */
2880 it
->glyph_row
= row
;
2881 it
->area
= TEXT_AREA
;
2883 /* Get the dimensions of the display area. The display area
2884 consists of the visible window area plus a horizontally scrolled
2885 part to the left of the window. All x-values are relative to the
2886 start of this total display area. */
2887 if (base_face_id
!= DEFAULT_FACE_ID
)
2889 /* Mode lines, menu bar in terminal frames. */
2890 it
->first_visible_x
= 0;
2891 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2896 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2897 it
->last_visible_x
= (it
->first_visible_x
2898 + window_box_width (w
, TEXT_AREA
));
2900 /* If we truncate lines, leave room for the truncation glyph(s) at
2901 the right margin. Otherwise, leave room for the continuation
2902 glyph(s). Done only if the window has no right fringe. */
2903 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2905 if (it
->line_wrap
== TRUNCATE
)
2906 it
->last_visible_x
-= it
->truncation_pixel_width
;
2908 it
->last_visible_x
-= it
->continuation_pixel_width
;
2911 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2912 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2915 /* Leave room for a border glyph. */
2916 if (!FRAME_WINDOW_P (it
->f
)
2917 && !WINDOW_RIGHTMOST_P (it
->w
))
2918 it
->last_visible_x
-= 1;
2920 it
->last_visible_y
= window_text_bottom_y (w
);
2922 /* For mode lines and alike, arrange for the first glyph having a
2923 left box line if the face specifies a box. */
2924 if (base_face_id
!= DEFAULT_FACE_ID
)
2928 it
->face_id
= remapped_base_face_id
;
2930 /* If we have a boxed mode line, make the first character appear
2931 with a left box line. */
2932 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2933 if (face
&& face
->box
!= FACE_NO_BOX
)
2934 it
->start_of_box_run_p
= true;
2937 /* If a buffer position was specified, set the iterator there,
2938 getting overlays and face properties from that position. */
2939 if (charpos
>= BUF_BEG (current_buffer
))
2941 it
->stop_charpos
= charpos
;
2942 it
->end_charpos
= ZV
;
2943 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2944 IT_CHARPOS (*it
) = charpos
;
2945 IT_BYTEPOS (*it
) = bytepos
;
2947 /* We will rely on `reseat' to set this up properly, via
2948 handle_face_prop. */
2949 it
->face_id
= it
->base_face_id
;
2951 it
->start
= it
->current
;
2952 /* Do we need to reorder bidirectional text? Not if this is a
2953 unibyte buffer: by definition, none of the single-byte
2954 characters are strong R2L, so no reordering is needed. And
2955 bidi.c doesn't support unibyte buffers anyway. Also, don't
2956 reorder while we are loading loadup.el, since the tables of
2957 character properties needed for reordering are not yet
2961 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2964 /* If we are to reorder bidirectional text, init the bidi
2968 /* Since we don't know at this point whether there will be
2969 any R2L lines in the window, we reserve space for
2970 truncation/continuation glyphs even if only the left
2971 fringe is absent. */
2972 if (base_face_id
== DEFAULT_FACE_ID
2973 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2974 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2976 if (it
->line_wrap
== TRUNCATE
)
2977 it
->last_visible_x
-= it
->truncation_pixel_width
;
2979 it
->last_visible_x
-= it
->continuation_pixel_width
;
2981 /* Note the paragraph direction that this buffer wants to
2983 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2985 it
->paragraph_embedding
= L2R
;
2986 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2988 it
->paragraph_embedding
= R2L
;
2990 it
->paragraph_embedding
= NEUTRAL_DIR
;
2991 bidi_unshelve_cache (NULL
, 0);
2992 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2996 /* Compute faces etc. */
2997 reseat (it
, it
->current
.pos
, 1);
3004 /* Initialize IT for the display of window W with window start POS. */
3007 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3009 struct glyph_row
*row
;
3010 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3012 row
= w
->desired_matrix
->rows
+ first_vpos
;
3013 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3014 it
->first_vpos
= first_vpos
;
3016 /* Don't reseat to previous visible line start if current start
3017 position is in a string or image. */
3018 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3020 int start_at_line_beg_p
;
3021 int first_y
= it
->current_y
;
3023 /* If window start is not at a line start, skip forward to POS to
3024 get the correct continuation lines width. */
3025 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3026 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3027 if (!start_at_line_beg_p
)
3031 reseat_at_previous_visible_line_start (it
);
3032 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3034 new_x
= it
->current_x
+ it
->pixel_width
;
3036 /* If lines are continued, this line may end in the middle
3037 of a multi-glyph character (e.g. a control character
3038 displayed as \003, or in the middle of an overlay
3039 string). In this case move_it_to above will not have
3040 taken us to the start of the continuation line but to the
3041 end of the continued line. */
3042 if (it
->current_x
> 0
3043 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3044 && (/* And glyph doesn't fit on the line. */
3045 new_x
> it
->last_visible_x
3046 /* Or it fits exactly and we're on a window
3048 || (new_x
== it
->last_visible_x
3049 && FRAME_WINDOW_P (it
->f
)
3050 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3051 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3052 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3054 if ((it
->current
.dpvec_index
>= 0
3055 || it
->current
.overlay_string_index
>= 0)
3056 /* If we are on a newline from a display vector or
3057 overlay string, then we are already at the end of
3058 a screen line; no need to go to the next line in
3059 that case, as this line is not really continued.
3060 (If we do go to the next line, C-e will not DTRT.) */
3063 set_iterator_to_next (it
, 1);
3064 move_it_in_display_line_to (it
, -1, -1, 0);
3067 it
->continuation_lines_width
+= it
->current_x
;
3069 /* If the character at POS is displayed via a display
3070 vector, move_it_to above stops at the final glyph of
3071 IT->dpvec. To make the caller redisplay that character
3072 again (a.k.a. start at POS), we need to reset the
3073 dpvec_index to the beginning of IT->dpvec. */
3074 else if (it
->current
.dpvec_index
>= 0)
3075 it
->current
.dpvec_index
= 0;
3077 /* We're starting a new display line, not affected by the
3078 height of the continued line, so clear the appropriate
3079 fields in the iterator structure. */
3080 it
->max_ascent
= it
->max_descent
= 0;
3081 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3083 it
->current_y
= first_y
;
3085 it
->current_x
= it
->hpos
= 0;
3091 /* Return 1 if POS is a position in ellipses displayed for invisible
3092 text. W is the window we display, for text property lookup. */
3095 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3097 Lisp_Object prop
, window
;
3099 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3101 /* If POS specifies a position in a display vector, this might
3102 be for an ellipsis displayed for invisible text. We won't
3103 get the iterator set up for delivering that ellipsis unless
3104 we make sure that it gets aware of the invisible text. */
3105 if (pos
->dpvec_index
>= 0
3106 && pos
->overlay_string_index
< 0
3107 && CHARPOS (pos
->string_pos
) < 0
3109 && (XSETWINDOW (window
, w
),
3110 prop
= Fget_char_property (make_number (charpos
),
3111 Qinvisible
, window
),
3112 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3114 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3116 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3123 /* Initialize IT for stepping through current_buffer in window W,
3124 starting at position POS that includes overlay string and display
3125 vector/ control character translation position information. Value
3126 is zero if there are overlay strings with newlines at POS. */
3129 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3131 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3132 int i
, overlay_strings_with_newlines
= 0;
3134 /* If POS specifies a position in a display vector, this might
3135 be for an ellipsis displayed for invisible text. We won't
3136 get the iterator set up for delivering that ellipsis unless
3137 we make sure that it gets aware of the invisible text. */
3138 if (in_ellipses_for_invisible_text_p (pos
, w
))
3144 /* Keep in mind: the call to reseat in init_iterator skips invisible
3145 text, so we might end up at a position different from POS. This
3146 is only a problem when POS is a row start after a newline and an
3147 overlay starts there with an after-string, and the overlay has an
3148 invisible property. Since we don't skip invisible text in
3149 display_line and elsewhere immediately after consuming the
3150 newline before the row start, such a POS will not be in a string,
3151 but the call to init_iterator below will move us to the
3153 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3155 /* This only scans the current chunk -- it should scan all chunks.
3156 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3157 to 16 in 22.1 to make this a lesser problem. */
3158 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3160 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3161 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3163 while (s
< e
&& *s
!= '\n')
3168 overlay_strings_with_newlines
= 1;
3173 /* If position is within an overlay string, set up IT to the right
3175 if (pos
->overlay_string_index
>= 0)
3179 /* If the first overlay string happens to have a `display'
3180 property for an image, the iterator will be set up for that
3181 image, and we have to undo that setup first before we can
3182 correct the overlay string index. */
3183 if (it
->method
== GET_FROM_IMAGE
)
3186 /* We already have the first chunk of overlay strings in
3187 IT->overlay_strings. Load more until the one for
3188 pos->overlay_string_index is in IT->overlay_strings. */
3189 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3191 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3192 it
->current
.overlay_string_index
= 0;
3195 load_overlay_strings (it
, 0);
3196 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3200 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3201 relative_index
= (it
->current
.overlay_string_index
3202 % OVERLAY_STRING_CHUNK_SIZE
);
3203 it
->string
= it
->overlay_strings
[relative_index
];
3204 eassert (STRINGP (it
->string
));
3205 it
->current
.string_pos
= pos
->string_pos
;
3206 it
->method
= GET_FROM_STRING
;
3207 it
->end_charpos
= SCHARS (it
->string
);
3208 /* Set up the bidi iterator for this overlay string. */
3211 it
->bidi_it
.string
.lstring
= it
->string
;
3212 it
->bidi_it
.string
.s
= NULL
;
3213 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3214 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3215 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3216 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3217 it
->bidi_it
.w
= it
->w
;
3218 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3219 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3221 /* Synchronize the state of the bidi iterator with
3222 pos->string_pos. For any string position other than
3223 zero, this will be done automagically when we resume
3224 iteration over the string and get_visually_first_element
3225 is called. But if string_pos is zero, and the string is
3226 to be reordered for display, we need to resync manually,
3227 since it could be that the iteration state recorded in
3228 pos ended at string_pos of 0 moving backwards in string. */
3229 if (CHARPOS (pos
->string_pos
) == 0)
3231 get_visually_first_element (it
);
3232 if (IT_STRING_CHARPOS (*it
) != 0)
3235 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3236 bidi_move_to_visually_next (&it
->bidi_it
);
3237 } while (it
->bidi_it
.charpos
!= 0);
3239 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3240 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3244 if (CHARPOS (pos
->string_pos
) >= 0)
3246 /* Recorded position is not in an overlay string, but in another
3247 string. This can only be a string from a `display' property.
3248 IT should already be filled with that string. */
3249 it
->current
.string_pos
= pos
->string_pos
;
3250 eassert (STRINGP (it
->string
));
3252 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3253 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3256 /* Restore position in display vector translations, control
3257 character translations or ellipses. */
3258 if (pos
->dpvec_index
>= 0)
3260 if (it
->dpvec
== NULL
)
3261 get_next_display_element (it
);
3262 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3263 it
->current
.dpvec_index
= pos
->dpvec_index
;
3267 return !overlay_strings_with_newlines
;
3271 /* Initialize IT for stepping through current_buffer in window W
3272 starting at ROW->start. */
3275 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3277 init_from_display_pos (it
, w
, &row
->start
);
3278 it
->start
= row
->start
;
3279 it
->continuation_lines_width
= row
->continuation_lines_width
;
3284 /* Initialize IT for stepping through current_buffer in window W
3285 starting in the line following ROW, i.e. starting at ROW->end.
3286 Value is zero if there are overlay strings with newlines at ROW's
3290 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3294 if (init_from_display_pos (it
, w
, &row
->end
))
3296 if (row
->continued_p
)
3297 it
->continuation_lines_width
3298 = row
->continuation_lines_width
+ row
->pixel_width
;
3309 /***********************************************************************
3311 ***********************************************************************/
3313 /* Called when IT reaches IT->stop_charpos. Handle text property and
3314 overlay changes. Set IT->stop_charpos to the next position where
3318 handle_stop (struct it
*it
)
3320 enum prop_handled handled
;
3321 int handle_overlay_change_p
;
3325 it
->current
.dpvec_index
= -1;
3326 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3327 it
->ignore_overlay_strings_at_pos_p
= 0;
3330 /* Use face of preceding text for ellipsis (if invisible) */
3331 if (it
->selective_display_ellipsis_p
)
3332 it
->saved_face_id
= it
->face_id
;
3334 /* Here's the description of the semantics of, and the logic behind,
3335 the various HANDLED_* statuses:
3337 HANDLED_NORMALLY means the handler did its job, and the loop
3338 should proceed to calling the next handler in order.
3340 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3341 change in the properties and overlays at current position, so the
3342 loop should be restarted, to re-invoke the handlers that were
3343 already called. This happens when fontification-functions were
3344 called by handle_fontified_prop, and actually fontified
3345 something. Another case where HANDLED_RECOMPUTE_PROPS is
3346 returned is when we discover overlay strings that need to be
3347 displayed right away. The loop below will continue for as long
3348 as the status is HANDLED_RECOMPUTE_PROPS.
3350 HANDLED_RETURN means return immediately to the caller, to
3351 continue iteration without calling any further handlers. This is
3352 used when we need to act on some property right away, for example
3353 when we need to display the ellipsis or a replacing display
3354 property, such as display string or image.
3356 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3357 consumed, and the handler switched to the next overlay string.
3358 This signals the loop below to refrain from looking for more
3359 overlays before all the overlay strings of the current overlay
3362 Some of the handlers called by the loop push the iterator state
3363 onto the stack (see 'push_it'), and arrange for the iteration to
3364 continue with another object, such as an image, a display string,
3365 or an overlay string. In most such cases, it->stop_charpos is
3366 set to the first character of the string, so that when the
3367 iteration resumes, this function will immediately be called
3368 again, to examine the properties at the beginning of the string.
3370 When a display or overlay string is exhausted, the iterator state
3371 is popped (see 'pop_it'), and iteration continues with the
3372 previous object. Again, in many such cases this function is
3373 called again to find the next position where properties might
3378 handled
= HANDLED_NORMALLY
;
3380 /* Call text property handlers. */
3381 for (p
= it_props
; p
->handler
; ++p
)
3383 handled
= p
->handler (it
);
3385 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3387 else if (handled
== HANDLED_RETURN
)
3389 /* We still want to show before and after strings from
3390 overlays even if the actual buffer text is replaced. */
3391 if (!handle_overlay_change_p
3393 /* Don't call get_overlay_strings_1 if we already
3394 have overlay strings loaded, because doing so
3395 will load them again and push the iterator state
3396 onto the stack one more time, which is not
3397 expected by the rest of the code that processes
3399 || (it
->current
.overlay_string_index
< 0
3400 ? !get_overlay_strings_1 (it
, 0, 0)
3404 setup_for_ellipsis (it
, 0);
3405 /* When handling a display spec, we might load an
3406 empty string. In that case, discard it here. We
3407 used to discard it in handle_single_display_spec,
3408 but that causes get_overlay_strings_1, above, to
3409 ignore overlay strings that we must check. */
3410 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3414 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3418 it
->ignore_overlay_strings_at_pos_p
= true;
3419 it
->string_from_display_prop_p
= 0;
3420 it
->from_disp_prop_p
= 0;
3421 handle_overlay_change_p
= 0;
3423 handled
= HANDLED_RECOMPUTE_PROPS
;
3426 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3427 handle_overlay_change_p
= 0;
3430 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3432 /* Don't check for overlay strings below when set to deliver
3433 characters from a display vector. */
3434 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3435 handle_overlay_change_p
= 0;
3437 /* Handle overlay changes.
3438 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3439 if it finds overlays. */
3440 if (handle_overlay_change_p
)
3441 handled
= handle_overlay_change (it
);
3446 setup_for_ellipsis (it
, 0);
3450 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3452 /* Determine where to stop next. */
3453 if (handled
== HANDLED_NORMALLY
)
3454 compute_stop_pos (it
);
3458 /* Compute IT->stop_charpos from text property and overlay change
3459 information for IT's current position. */
3462 compute_stop_pos (struct it
*it
)
3464 register INTERVAL iv
, next_iv
;
3465 Lisp_Object object
, limit
, position
;
3466 ptrdiff_t charpos
, bytepos
;
3468 if (STRINGP (it
->string
))
3470 /* Strings are usually short, so don't limit the search for
3472 it
->stop_charpos
= it
->end_charpos
;
3473 object
= it
->string
;
3475 charpos
= IT_STRING_CHARPOS (*it
);
3476 bytepos
= IT_STRING_BYTEPOS (*it
);
3482 /* If end_charpos is out of range for some reason, such as a
3483 misbehaving display function, rationalize it (Bug#5984). */
3484 if (it
->end_charpos
> ZV
)
3485 it
->end_charpos
= ZV
;
3486 it
->stop_charpos
= it
->end_charpos
;
3488 /* If next overlay change is in front of the current stop pos
3489 (which is IT->end_charpos), stop there. Note: value of
3490 next_overlay_change is point-max if no overlay change
3492 charpos
= IT_CHARPOS (*it
);
3493 bytepos
= IT_BYTEPOS (*it
);
3494 pos
= next_overlay_change (charpos
);
3495 if (pos
< it
->stop_charpos
)
3496 it
->stop_charpos
= pos
;
3498 /* Set up variables for computing the stop position from text
3499 property changes. */
3500 XSETBUFFER (object
, current_buffer
);
3501 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3504 /* Get the interval containing IT's position. Value is a null
3505 interval if there isn't such an interval. */
3506 position
= make_number (charpos
);
3507 iv
= validate_interval_range (object
, &position
, &position
, 0);
3510 Lisp_Object values_here
[LAST_PROP_IDX
];
3513 /* Get properties here. */
3514 for (p
= it_props
; p
->handler
; ++p
)
3515 values_here
[p
->idx
] = textget (iv
->plist
,
3516 builtin_lisp_symbol (p
->name
));
3518 /* Look for an interval following iv that has different
3520 for (next_iv
= next_interval (iv
);
3523 || XFASTINT (limit
) > next_iv
->position
));
3524 next_iv
= next_interval (next_iv
))
3526 for (p
= it_props
; p
->handler
; ++p
)
3528 Lisp_Object new_value
= textget (next_iv
->plist
,
3529 builtin_lisp_symbol (p
->name
));
3530 if (!EQ (values_here
[p
->idx
], new_value
))
3540 if (INTEGERP (limit
)
3541 && next_iv
->position
>= XFASTINT (limit
))
3542 /* No text property change up to limit. */
3543 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3545 /* Text properties change in next_iv. */
3546 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3550 if (it
->cmp_it
.id
< 0)
3552 ptrdiff_t stoppos
= it
->end_charpos
;
3554 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3556 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3557 stoppos
, it
->string
);
3560 eassert (STRINGP (it
->string
)
3561 || (it
->stop_charpos
>= BEGV
3562 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3566 /* Return the position of the next overlay change after POS in
3567 current_buffer. Value is point-max if no overlay change
3568 follows. This is like `next-overlay-change' but doesn't use
3572 next_overlay_change (ptrdiff_t pos
)
3574 ptrdiff_t i
, noverlays
;
3576 Lisp_Object
*overlays
;
3579 /* Get all overlays at the given position. */
3580 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3582 /* If any of these overlays ends before endpos,
3583 use its ending point instead. */
3584 for (i
= 0; i
< noverlays
; ++i
)
3589 oend
= OVERLAY_END (overlays
[i
]);
3590 oendpos
= OVERLAY_POSITION (oend
);
3591 endpos
= min (endpos
, oendpos
);
3598 /* How many characters forward to search for a display property or
3599 display string. Searching too far forward makes the bidi display
3600 sluggish, especially in small windows. */
3601 #define MAX_DISP_SCAN 250
3603 /* Return the character position of a display string at or after
3604 position specified by POSITION. If no display string exists at or
3605 after POSITION, return ZV. A display string is either an overlay
3606 with `display' property whose value is a string, or a `display'
3607 text property whose value is a string. STRING is data about the
3608 string to iterate; if STRING->lstring is nil, we are iterating a
3609 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3610 on a GUI frame. DISP_PROP is set to zero if we searched
3611 MAX_DISP_SCAN characters forward without finding any display
3612 strings, non-zero otherwise. It is set to 2 if the display string
3613 uses any kind of `(space ...)' spec that will produce a stretch of
3614 white space in the text area. */
3616 compute_display_string_pos (struct text_pos
*position
,
3617 struct bidi_string_data
*string
,
3619 int frame_window_p
, int *disp_prop
)
3621 /* OBJECT = nil means current buffer. */
3622 Lisp_Object object
, object1
;
3623 Lisp_Object pos
, spec
, limpos
;
3624 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3625 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3626 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3627 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3629 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3630 struct text_pos tpos
;
3633 if (string
&& STRINGP (string
->lstring
))
3634 object1
= object
= string
->lstring
;
3635 else if (w
&& !string_p
)
3637 XSETWINDOW (object
, w
);
3641 object1
= object
= Qnil
;
3646 /* We don't support display properties whose values are strings
3647 that have display string properties. */
3648 || string
->from_disp_str
3649 /* C strings cannot have display properties. */
3650 || (string
->s
&& !STRINGP (object
)))
3656 /* If the character at CHARPOS is where the display string begins,
3658 pos
= make_number (charpos
);
3659 if (STRINGP (object
))
3660 bufpos
= string
->bufpos
;
3664 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3666 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3669 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3677 /* Look forward for the first character with a `display' property
3678 that will replace the underlying text when displayed. */
3679 limpos
= make_number (lim
);
3681 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3682 CHARPOS (tpos
) = XFASTINT (pos
);
3683 if (CHARPOS (tpos
) >= lim
)
3688 if (STRINGP (object
))
3689 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3691 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3692 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3693 if (!STRINGP (object
))
3694 bufpos
= CHARPOS (tpos
);
3695 } while (NILP (spec
)
3696 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3697 bufpos
, frame_window_p
)));
3701 return CHARPOS (tpos
);
3704 /* Return the character position of the end of the display string that
3705 started at CHARPOS. If there's no display string at CHARPOS,
3706 return -1. A display string is either an overlay with `display'
3707 property whose value is a string or a `display' text property whose
3708 value is a string. */
3710 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3712 /* OBJECT = nil means current buffer. */
3713 Lisp_Object object
=
3714 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3715 Lisp_Object pos
= make_number (charpos
);
3717 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3719 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3722 /* It could happen that the display property or overlay was removed
3723 since we found it in compute_display_string_pos above. One way
3724 this can happen is if JIT font-lock was called (through
3725 handle_fontified_prop), and jit-lock-functions remove text
3726 properties or overlays from the portion of buffer that includes
3727 CHARPOS. Muse mode is known to do that, for example. In this
3728 case, we return -1 to the caller, to signal that no display
3729 string is actually present at CHARPOS. See bidi_fetch_char for
3730 how this is handled.
3732 An alternative would be to never look for display properties past
3733 it->stop_charpos. But neither compute_display_string_pos nor
3734 bidi_fetch_char that calls it know or care where the next
3736 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3739 /* Look forward for the first character where the `display' property
3741 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3743 return XFASTINT (pos
);
3748 /***********************************************************************
3750 ***********************************************************************/
3752 /* Handle changes in the `fontified' property of the current buffer by
3753 calling hook functions from Qfontification_functions to fontify
3756 static enum prop_handled
3757 handle_fontified_prop (struct it
*it
)
3759 Lisp_Object prop
, pos
;
3760 enum prop_handled handled
= HANDLED_NORMALLY
;
3762 if (!NILP (Vmemory_full
))
3765 /* Get the value of the `fontified' property at IT's current buffer
3766 position. (The `fontified' property doesn't have a special
3767 meaning in strings.) If the value is nil, call functions from
3768 Qfontification_functions. */
3769 if (!STRINGP (it
->string
)
3771 && !NILP (Vfontification_functions
)
3772 && !NILP (Vrun_hooks
)
3773 && (pos
= make_number (IT_CHARPOS (*it
)),
3774 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3775 /* Ignore the special cased nil value always present at EOB since
3776 no amount of fontifying will be able to change it. */
3777 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3779 ptrdiff_t count
= SPECPDL_INDEX ();
3781 struct buffer
*obuf
= current_buffer
;
3782 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3783 bool old_clip_changed
= current_buffer
->clip_changed
;
3785 val
= Vfontification_functions
;
3786 specbind (Qfontification_functions
, Qnil
);
3788 eassert (it
->end_charpos
== ZV
);
3790 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3791 safe_call1 (val
, pos
);
3794 Lisp_Object fns
, fn
;
3795 struct gcpro gcpro1
, gcpro2
;
3800 for (; CONSP (val
); val
= XCDR (val
))
3806 /* A value of t indicates this hook has a local
3807 binding; it means to run the global binding too.
3808 In a global value, t should not occur. If it
3809 does, we must ignore it to avoid an endless
3811 for (fns
= Fdefault_value (Qfontification_functions
);
3817 safe_call1 (fn
, pos
);
3821 safe_call1 (fn
, pos
);
3827 unbind_to (count
, Qnil
);
3829 /* Fontification functions routinely call `save-restriction'.
3830 Normally, this tags clip_changed, which can confuse redisplay
3831 (see discussion in Bug#6671). Since we don't perform any
3832 special handling of fontification changes in the case where
3833 `save-restriction' isn't called, there's no point doing so in
3834 this case either. So, if the buffer's restrictions are
3835 actually left unchanged, reset clip_changed. */
3836 if (obuf
== current_buffer
)
3838 if (begv
== BEGV
&& zv
== ZV
)
3839 current_buffer
->clip_changed
= old_clip_changed
;
3841 /* There isn't much we can reasonably do to protect against
3842 misbehaving fontification, but here's a fig leaf. */
3843 else if (BUFFER_LIVE_P (obuf
))
3844 set_buffer_internal_1 (obuf
);
3846 /* The fontification code may have added/removed text.
3847 It could do even a lot worse, but let's at least protect against
3848 the most obvious case where only the text past `pos' gets changed',
3849 as is/was done in grep.el where some escapes sequences are turned
3850 into face properties (bug#7876). */
3851 it
->end_charpos
= ZV
;
3853 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3854 something. This avoids an endless loop if they failed to
3855 fontify the text for which reason ever. */
3856 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3857 handled
= HANDLED_RECOMPUTE_PROPS
;
3865 /***********************************************************************
3867 ***********************************************************************/
3869 /* Set up iterator IT from face properties at its current position.
3870 Called from handle_stop. */
3872 static enum prop_handled
3873 handle_face_prop (struct it
*it
)
3876 ptrdiff_t next_stop
;
3878 if (!STRINGP (it
->string
))
3881 = face_at_buffer_position (it
->w
,
3885 + TEXT_PROP_DISTANCE_LIMIT
),
3886 false, it
->base_face_id
);
3888 /* Is this a start of a run of characters with box face?
3889 Caveat: this can be called for a freshly initialized
3890 iterator; face_id is -1 in this case. We know that the new
3891 face will not change until limit, i.e. if the new face has a
3892 box, all characters up to limit will have one. But, as
3893 usual, we don't know whether limit is really the end. */
3894 if (new_face_id
!= it
->face_id
)
3896 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3897 /* If it->face_id is -1, old_face below will be NULL, see
3898 the definition of FACE_FROM_ID. This will happen if this
3899 is the initial call that gets the face. */
3900 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3902 /* If the value of face_id of the iterator is -1, we have to
3903 look in front of IT's position and see whether there is a
3904 face there that's different from new_face_id. */
3905 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3907 int prev_face_id
= face_before_it_pos (it
);
3909 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3912 /* If the new face has a box, but the old face does not,
3913 this is the start of a run of characters with box face,
3914 i.e. this character has a shadow on the left side. */
3915 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3916 && (old_face
== NULL
|| !old_face
->box
));
3917 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3925 Lisp_Object from_overlay
3926 = (it
->current
.overlay_string_index
>= 0
3927 ? it
->string_overlays
[it
->current
.overlay_string_index
3928 % OVERLAY_STRING_CHUNK_SIZE
]
3931 /* See if we got to this string directly or indirectly from
3932 an overlay property. That includes the before-string or
3933 after-string of an overlay, strings in display properties
3934 provided by an overlay, their text properties, etc.
3936 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3937 if (! NILP (from_overlay
))
3938 for (i
= it
->sp
- 1; i
>= 0; i
--)
3940 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3942 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3943 % OVERLAY_STRING_CHUNK_SIZE
];
3944 else if (! NILP (it
->stack
[i
].from_overlay
))
3945 from_overlay
= it
->stack
[i
].from_overlay
;
3947 if (!NILP (from_overlay
))
3951 if (! NILP (from_overlay
))
3953 bufpos
= IT_CHARPOS (*it
);
3954 /* For a string from an overlay, the base face depends
3955 only on text properties and ignores overlays. */
3957 = face_for_overlay_string (it
->w
,
3961 + TEXT_PROP_DISTANCE_LIMIT
),
3969 /* For strings from a `display' property, use the face at
3970 IT's current buffer position as the base face to merge
3971 with, so that overlay strings appear in the same face as
3972 surrounding text, unless they specify their own faces.
3973 For strings from wrap-prefix and line-prefix properties,
3974 use the default face, possibly remapped via
3975 Vface_remapping_alist. */
3976 /* Note that the fact that we use the face at _buffer_
3977 position means that a 'display' property on an overlay
3978 string will not inherit the face of that overlay string,
3979 but will instead revert to the face of buffer text
3980 covered by the overlay. This is visible, e.g., when the
3981 overlay specifies a box face, but neither the buffer nor
3982 the display string do. This sounds like a design bug,
3983 but Emacs always did that since v21.1, so changing that
3984 might be a big deal. */
3985 base_face_id
= it
->string_from_prefix_prop_p
3986 ? (!NILP (Vface_remapping_alist
)
3987 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3989 : underlying_face_id (it
);
3992 new_face_id
= face_at_string_position (it
->w
,
3994 IT_STRING_CHARPOS (*it
),
3997 base_face_id
, false);
3999 /* Is this a start of a run of characters with box? Caveat:
4000 this can be called for a freshly allocated iterator; face_id
4001 is -1 is this case. We know that the new face will not
4002 change until the next check pos, i.e. if the new face has a
4003 box, all characters up to that position will have a
4004 box. But, as usual, we don't know whether that position
4005 is really the end. */
4006 if (new_face_id
!= it
->face_id
)
4008 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4009 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4011 /* If new face has a box but old face hasn't, this is the
4012 start of a run of characters with box, i.e. it has a
4013 shadow on the left side. */
4014 it
->start_of_box_run_p
4015 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4016 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4020 it
->face_id
= new_face_id
;
4021 return HANDLED_NORMALLY
;
4025 /* Return the ID of the face ``underlying'' IT's current position,
4026 which is in a string. If the iterator is associated with a
4027 buffer, return the face at IT's current buffer position.
4028 Otherwise, use the iterator's base_face_id. */
4031 underlying_face_id (struct it
*it
)
4033 int face_id
= it
->base_face_id
, i
;
4035 eassert (STRINGP (it
->string
));
4037 for (i
= it
->sp
- 1; i
>= 0; --i
)
4038 if (NILP (it
->stack
[i
].string
))
4039 face_id
= it
->stack
[i
].face_id
;
4045 /* Compute the face one character before or after the current position
4046 of IT, in the visual order. BEFORE_P non-zero means get the face
4047 in front (to the left in L2R paragraphs, to the right in R2L
4048 paragraphs) of IT's screen position. Value is the ID of the face. */
4051 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4054 ptrdiff_t next_check_charpos
;
4056 void *it_copy_data
= NULL
;
4058 eassert (it
->s
== NULL
);
4060 if (STRINGP (it
->string
))
4062 ptrdiff_t bufpos
, charpos
;
4065 /* No face change past the end of the string (for the case
4066 we are padding with spaces). No face change before the
4068 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4069 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4074 /* Set charpos to the position before or after IT's current
4075 position, in the logical order, which in the non-bidi
4076 case is the same as the visual order. */
4078 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4079 else if (it
->what
== IT_COMPOSITION
)
4080 /* For composition, we must check the character after the
4082 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4084 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4090 /* With bidi iteration, the character before the current
4091 in the visual order cannot be found by simple
4092 iteration, because "reverse" reordering is not
4093 supported. Instead, we need to use the move_it_*
4094 family of functions. */
4095 /* Ignore face changes before the first visible
4096 character on this display line. */
4097 if (it
->current_x
<= it
->first_visible_x
)
4099 SAVE_IT (it_copy
, *it
, it_copy_data
);
4100 /* Implementation note: Since move_it_in_display_line
4101 works in the iterator geometry, and thinks the first
4102 character is always the leftmost, even in R2L lines,
4103 we don't need to distinguish between the R2L and L2R
4105 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4106 it_copy
.current_x
- 1, MOVE_TO_X
);
4107 charpos
= IT_STRING_CHARPOS (it_copy
);
4108 RESTORE_IT (it
, it
, it_copy_data
);
4112 /* Set charpos to the string position of the character
4113 that comes after IT's current position in the visual
4115 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4119 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4121 charpos
= it_copy
.bidi_it
.charpos
;
4124 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4126 if (it
->current
.overlay_string_index
>= 0)
4127 bufpos
= IT_CHARPOS (*it
);
4131 base_face_id
= underlying_face_id (it
);
4133 /* Get the face for ASCII, or unibyte. */
4134 face_id
= face_at_string_position (it
->w
,
4138 &next_check_charpos
,
4139 base_face_id
, false);
4141 /* Correct the face for charsets different from ASCII. Do it
4142 for the multibyte case only. The face returned above is
4143 suitable for unibyte text if IT->string is unibyte. */
4144 if (STRING_MULTIBYTE (it
->string
))
4146 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4147 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4149 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4151 c
= string_char_and_length (p
, &len
);
4152 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4157 struct text_pos pos
;
4159 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4160 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4163 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4164 pos
= it
->current
.pos
;
4169 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4172 if (it
->what
== IT_COMPOSITION
)
4174 /* For composition, we must check the position after
4176 pos
.charpos
+= it
->cmp_it
.nchars
;
4177 pos
.bytepos
+= it
->len
;
4180 INC_TEXT_POS (pos
, it
->multibyte_p
);
4187 /* With bidi iteration, the character before the current
4188 in the visual order cannot be found by simple
4189 iteration, because "reverse" reordering is not
4190 supported. Instead, we need to use the move_it_*
4191 family of functions. */
4192 /* Ignore face changes before the first visible
4193 character on this display line. */
4194 if (it
->current_x
<= it
->first_visible_x
)
4196 SAVE_IT (it_copy
, *it
, it_copy_data
);
4197 /* Implementation note: Since move_it_in_display_line
4198 works in the iterator geometry, and thinks the first
4199 character is always the leftmost, even in R2L lines,
4200 we don't need to distinguish between the R2L and L2R
4202 move_it_in_display_line (&it_copy
, ZV
,
4203 it_copy
.current_x
- 1, MOVE_TO_X
);
4204 pos
= it_copy
.current
.pos
;
4205 RESTORE_IT (it
, it
, it_copy_data
);
4209 /* Set charpos to the buffer position of the character
4210 that comes after IT's current position in the visual
4212 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4216 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4219 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4222 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4224 /* Determine face for CHARSET_ASCII, or unibyte. */
4225 face_id
= face_at_buffer_position (it
->w
,
4227 &next_check_charpos
,
4230 /* Correct the face for charsets different from ASCII. Do it
4231 for the multibyte case only. The face returned above is
4232 suitable for unibyte text if current_buffer is unibyte. */
4233 if (it
->multibyte_p
)
4235 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4236 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4237 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4246 /***********************************************************************
4248 ***********************************************************************/
4250 /* Set up iterator IT from invisible properties at its current
4251 position. Called from handle_stop. */
4253 static enum prop_handled
4254 handle_invisible_prop (struct it
*it
)
4256 enum prop_handled handled
= HANDLED_NORMALLY
;
4260 if (STRINGP (it
->string
))
4262 Lisp_Object end_charpos
, limit
, charpos
;
4264 /* Get the value of the invisible text property at the
4265 current position. Value will be nil if there is no such
4267 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4268 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4269 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4271 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4273 /* Record whether we have to display an ellipsis for the
4275 int display_ellipsis_p
= (invis_p
== 2);
4276 ptrdiff_t len
, endpos
;
4278 handled
= HANDLED_RECOMPUTE_PROPS
;
4280 /* Get the position at which the next visible text can be
4281 found in IT->string, if any. */
4282 endpos
= len
= SCHARS (it
->string
);
4283 XSETINT (limit
, len
);
4286 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4288 if (INTEGERP (end_charpos
))
4290 endpos
= XFASTINT (end_charpos
);
4291 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4292 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4294 display_ellipsis_p
= true;
4297 while (invis_p
&& endpos
< len
);
4299 if (display_ellipsis_p
)
4300 it
->ellipsis_p
= true;
4304 /* Text at END_CHARPOS is visible. Move IT there. */
4305 struct text_pos old
;
4308 old
= it
->current
.string_pos
;
4309 oldpos
= CHARPOS (old
);
4312 if (it
->bidi_it
.first_elt
4313 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4314 bidi_paragraph_init (it
->paragraph_embedding
,
4316 /* Bidi-iterate out of the invisible text. */
4319 bidi_move_to_visually_next (&it
->bidi_it
);
4321 while (oldpos
<= it
->bidi_it
.charpos
4322 && it
->bidi_it
.charpos
< endpos
);
4324 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4325 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4326 if (IT_CHARPOS (*it
) >= endpos
)
4327 it
->prev_stop
= endpos
;
4331 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4332 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4337 /* The rest of the string is invisible. If this is an
4338 overlay string, proceed with the next overlay string
4339 or whatever comes and return a character from there. */
4340 if (it
->current
.overlay_string_index
>= 0
4341 && !display_ellipsis_p
)
4343 next_overlay_string (it
);
4344 /* Don't check for overlay strings when we just
4345 finished processing them. */
4346 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4350 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4351 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4358 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4359 Lisp_Object pos
, overlay
;
4361 /* First of all, is there invisible text at this position? */
4362 tem
= start_charpos
= IT_CHARPOS (*it
);
4363 pos
= make_number (tem
);
4364 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4366 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4368 /* If we are on invisible text, skip over it. */
4369 if (invis_p
&& start_charpos
< it
->end_charpos
)
4371 /* Record whether we have to display an ellipsis for the
4373 int display_ellipsis_p
= invis_p
== 2;
4375 handled
= HANDLED_RECOMPUTE_PROPS
;
4377 /* Loop skipping over invisible text. The loop is left at
4378 ZV or with IT on the first char being visible again. */
4381 /* Try to skip some invisible text. Return value is the
4382 position reached which can be equal to where we start
4383 if there is nothing invisible there. This skips both
4384 over invisible text properties and overlays with
4385 invisible property. */
4386 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4388 /* If we skipped nothing at all we weren't at invisible
4389 text in the first place. If everything to the end of
4390 the buffer was skipped, end the loop. */
4391 if (newpos
== tem
|| newpos
>= ZV
)
4395 /* We skipped some characters but not necessarily
4396 all there are. Check if we ended up on visible
4397 text. Fget_char_property returns the property of
4398 the char before the given position, i.e. if we
4399 get invis_p = 0, this means that the char at
4400 newpos is visible. */
4401 pos
= make_number (newpos
);
4402 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4403 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4406 /* If we ended up on invisible text, proceed to
4407 skip starting with next_stop. */
4411 /* If there are adjacent invisible texts, don't lose the
4412 second one's ellipsis. */
4414 display_ellipsis_p
= true;
4418 /* The position newpos is now either ZV or on visible text. */
4421 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4423 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4425 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4427 /* If the invisible text ends on a newline or on a
4428 character after a newline, we can avoid the costly,
4429 character by character, bidi iteration to NEWPOS, and
4430 instead simply reseat the iterator there. That's
4431 because all bidi reordering information is tossed at
4432 the newline. This is a big win for modes that hide
4433 complete lines, like Outline, Org, etc. */
4434 if (on_newline
|| after_newline
)
4436 struct text_pos tpos
;
4437 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4439 SET_TEXT_POS (tpos
, newpos
, bpos
);
4440 reseat_1 (it
, tpos
, 0);
4441 /* If we reseat on a newline/ZV, we need to prep the
4442 bidi iterator for advancing to the next character
4443 after the newline/EOB, keeping the current paragraph
4444 direction (so that PRODUCE_GLYPHS does TRT wrt
4445 prepending/appending glyphs to a glyph row). */
4448 it
->bidi_it
.first_elt
= 0;
4449 it
->bidi_it
.paragraph_dir
= pdir
;
4450 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4451 it
->bidi_it
.nchars
= 1;
4452 it
->bidi_it
.ch_len
= 1;
4455 else /* Must use the slow method. */
4457 /* With bidi iteration, the region of invisible text
4458 could start and/or end in the middle of a
4459 non-base embedding level. Therefore, we need to
4460 skip invisible text using the bidi iterator,
4461 starting at IT's current position, until we find
4462 ourselves outside of the invisible text.
4463 Skipping invisible text _after_ bidi iteration
4464 avoids affecting the visual order of the
4465 displayed text when invisible properties are
4466 added or removed. */
4467 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4469 /* If we were `reseat'ed to a new paragraph,
4470 determine the paragraph base direction. We
4471 need to do it now because
4472 next_element_from_buffer may not have a
4473 chance to do it, if we are going to skip any
4474 text at the beginning, which resets the
4476 bidi_paragraph_init (it
->paragraph_embedding
,
4481 bidi_move_to_visually_next (&it
->bidi_it
);
4483 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4484 && it
->bidi_it
.charpos
< newpos
);
4485 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4486 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4487 /* If we overstepped NEWPOS, record its position in
4488 the iterator, so that we skip invisible text if
4489 later the bidi iteration lands us in the
4490 invisible region again. */
4491 if (IT_CHARPOS (*it
) >= newpos
)
4492 it
->prev_stop
= newpos
;
4497 IT_CHARPOS (*it
) = newpos
;
4498 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4501 /* If there are before-strings at the start of invisible
4502 text, and the text is invisible because of a text
4503 property, arrange to show before-strings because 20.x did
4504 it that way. (If the text is invisible because of an
4505 overlay property instead of a text property, this is
4506 already handled in the overlay code.) */
4508 && get_overlay_strings (it
, it
->stop_charpos
))
4510 handled
= HANDLED_RECOMPUTE_PROPS
;
4513 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4514 /* The call to get_overlay_strings above recomputes
4515 it->stop_charpos, but it only considers changes
4516 in properties and overlays beyond iterator's
4517 current position. This causes us to miss changes
4518 that happen exactly where the invisible property
4519 ended. So we play it safe here and force the
4520 iterator to check for potential stop positions
4521 immediately after the invisible text. Note that
4522 if get_overlay_strings returns non-zero, it
4523 normally also pushed the iterator stack, so we
4524 need to update the stop position in the slot
4525 below the current one. */
4526 it
->stack
[it
->sp
- 1].stop_charpos
4527 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4530 else if (display_ellipsis_p
)
4532 /* Make sure that the glyphs of the ellipsis will get
4533 correct `charpos' values. If we would not update
4534 it->position here, the glyphs would belong to the
4535 last visible character _before_ the invisible
4536 text, which confuses `set_cursor_from_row'.
4538 We use the last invisible position instead of the
4539 first because this way the cursor is always drawn on
4540 the first "." of the ellipsis, whenever PT is inside
4541 the invisible text. Otherwise the cursor would be
4542 placed _after_ the ellipsis when the point is after the
4543 first invisible character. */
4544 if (!STRINGP (it
->object
))
4546 it
->position
.charpos
= newpos
- 1;
4547 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4549 it
->ellipsis_p
= true;
4550 /* Let the ellipsis display before
4551 considering any properties of the following char.
4552 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4553 handled
= HANDLED_RETURN
;
4562 /* Make iterator IT return `...' next.
4563 Replaces LEN characters from buffer. */
4566 setup_for_ellipsis (struct it
*it
, int len
)
4568 /* Use the display table definition for `...'. Invalid glyphs
4569 will be handled by the method returning elements from dpvec. */
4570 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4572 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4573 it
->dpvec
= v
->contents
;
4574 it
->dpend
= v
->contents
+ v
->header
.size
;
4578 /* Default `...'. */
4579 it
->dpvec
= default_invis_vector
;
4580 it
->dpend
= default_invis_vector
+ 3;
4583 it
->dpvec_char_len
= len
;
4584 it
->current
.dpvec_index
= 0;
4585 it
->dpvec_face_id
= -1;
4587 /* Remember the current face id in case glyphs specify faces.
4588 IT's face is restored in set_iterator_to_next.
4589 saved_face_id was set to preceding char's face in handle_stop. */
4590 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4591 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4593 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4594 it
->ellipsis_p
= true;
4599 /***********************************************************************
4601 ***********************************************************************/
4603 /* Set up iterator IT from `display' property at its current position.
4604 Called from handle_stop.
4605 We return HANDLED_RETURN if some part of the display property
4606 overrides the display of the buffer text itself.
4607 Otherwise we return HANDLED_NORMALLY. */
4609 static enum prop_handled
4610 handle_display_prop (struct it
*it
)
4612 Lisp_Object propval
, object
, overlay
;
4613 struct text_pos
*position
;
4615 /* Nonzero if some property replaces the display of the text itself. */
4616 int display_replaced_p
= 0;
4618 if (STRINGP (it
->string
))
4620 object
= it
->string
;
4621 position
= &it
->current
.string_pos
;
4622 bufpos
= CHARPOS (it
->current
.pos
);
4626 XSETWINDOW (object
, it
->w
);
4627 position
= &it
->current
.pos
;
4628 bufpos
= CHARPOS (*position
);
4631 /* Reset those iterator values set from display property values. */
4632 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4633 it
->space_width
= Qnil
;
4634 it
->font_height
= Qnil
;
4637 /* We don't support recursive `display' properties, i.e. string
4638 values that have a string `display' property, that have a string
4639 `display' property etc. */
4640 if (!it
->string_from_display_prop_p
)
4641 it
->area
= TEXT_AREA
;
4643 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4644 Qdisplay
, object
, &overlay
);
4646 return HANDLED_NORMALLY
;
4647 /* Now OVERLAY is the overlay that gave us this property, or nil
4648 if it was a text property. */
4650 if (!STRINGP (it
->string
))
4651 object
= it
->w
->contents
;
4653 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4655 FRAME_WINDOW_P (it
->f
));
4657 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4660 /* Subroutine of handle_display_prop. Returns non-zero if the display
4661 specification in SPEC is a replacing specification, i.e. it would
4662 replace the text covered by `display' property with something else,
4663 such as an image or a display string. If SPEC includes any kind or
4664 `(space ...) specification, the value is 2; this is used by
4665 compute_display_string_pos, which see.
4667 See handle_single_display_spec for documentation of arguments.
4668 frame_window_p is non-zero if the window being redisplayed is on a
4669 GUI frame; this argument is used only if IT is NULL, see below.
4671 IT can be NULL, if this is called by the bidi reordering code
4672 through compute_display_string_pos, which see. In that case, this
4673 function only examines SPEC, but does not otherwise "handle" it, in
4674 the sense that it doesn't set up members of IT from the display
4677 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4678 Lisp_Object overlay
, struct text_pos
*position
,
4679 ptrdiff_t bufpos
, int frame_window_p
)
4681 int replacing_p
= 0;
4685 /* Simple specifications. */
4686 && !EQ (XCAR (spec
), Qimage
)
4687 #ifdef HAVE_XWIDGETS
4688 && !EQ (XCAR (spec
), Qxwidget
)
4690 && !EQ (XCAR (spec
), Qspace
)
4691 && !EQ (XCAR (spec
), Qwhen
)
4692 && !EQ (XCAR (spec
), Qslice
)
4693 && !EQ (XCAR (spec
), Qspace_width
)
4694 && !EQ (XCAR (spec
), Qheight
)
4695 && !EQ (XCAR (spec
), Qraise
)
4696 /* Marginal area specifications. */
4697 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4698 && !EQ (XCAR (spec
), Qleft_fringe
)
4699 && !EQ (XCAR (spec
), Qright_fringe
)
4700 && !NILP (XCAR (spec
)))
4702 for (; CONSP (spec
); spec
= XCDR (spec
))
4704 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4705 overlay
, position
, bufpos
,
4706 replacing_p
, frame_window_p
)))
4709 /* If some text in a string is replaced, `position' no
4710 longer points to the position of `object'. */
4711 if (!it
|| STRINGP (object
))
4716 else if (VECTORP (spec
))
4719 for (i
= 0; i
< ASIZE (spec
); ++i
)
4720 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4721 overlay
, position
, bufpos
,
4722 replacing_p
, frame_window_p
)))
4725 /* If some text in a string is replaced, `position' no
4726 longer points to the position of `object'. */
4727 if (!it
|| STRINGP (object
))
4733 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4734 position
, bufpos
, 0,
4742 /* Value is the position of the end of the `display' property starting
4743 at START_POS in OBJECT. */
4745 static struct text_pos
4746 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4749 struct text_pos end_pos
;
4751 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4752 Qdisplay
, object
, Qnil
);
4753 CHARPOS (end_pos
) = XFASTINT (end
);
4754 if (STRINGP (object
))
4755 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4757 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4763 /* Set up IT from a single `display' property specification SPEC. OBJECT
4764 is the object in which the `display' property was found. *POSITION
4765 is the position in OBJECT at which the `display' property was found.
4766 BUFPOS is the buffer position of OBJECT (different from POSITION if
4767 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4768 previously saw a display specification which already replaced text
4769 display with something else, for example an image; we ignore such
4770 properties after the first one has been processed.
4772 OVERLAY is the overlay this `display' property came from,
4773 or nil if it was a text property.
4775 If SPEC is a `space' or `image' specification, and in some other
4776 cases too, set *POSITION to the position where the `display'
4779 If IT is NULL, only examine the property specification in SPEC, but
4780 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4781 is intended to be displayed in a window on a GUI frame.
4783 Value is non-zero if something was found which replaces the display
4784 of buffer or string text. */
4787 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4788 Lisp_Object overlay
, struct text_pos
*position
,
4789 ptrdiff_t bufpos
, int display_replaced_p
,
4793 Lisp_Object location
, value
;
4794 struct text_pos start_pos
= *position
;
4797 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4798 If the result is non-nil, use VALUE instead of SPEC. */
4800 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4809 if (!NILP (form
) && !EQ (form
, Qt
))
4811 ptrdiff_t count
= SPECPDL_INDEX ();
4812 struct gcpro gcpro1
;
4814 /* Bind `object' to the object having the `display' property, a
4815 buffer or string. Bind `position' to the position in the
4816 object where the property was found, and `buffer-position'
4817 to the current position in the buffer. */
4820 XSETBUFFER (object
, current_buffer
);
4821 specbind (Qobject
, object
);
4822 specbind (Qposition
, make_number (CHARPOS (*position
)));
4823 specbind (Qbuffer_position
, make_number (bufpos
));
4825 form
= safe_eval (form
);
4827 unbind_to (count
, Qnil
);
4833 /* Handle `(height HEIGHT)' specifications. */
4835 && EQ (XCAR (spec
), Qheight
)
4836 && CONSP (XCDR (spec
)))
4840 if (!FRAME_WINDOW_P (it
->f
))
4843 it
->font_height
= XCAR (XCDR (spec
));
4844 if (!NILP (it
->font_height
))
4846 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4847 int new_height
= -1;
4849 if (CONSP (it
->font_height
)
4850 && (EQ (XCAR (it
->font_height
), Qplus
)
4851 || EQ (XCAR (it
->font_height
), Qminus
))
4852 && CONSP (XCDR (it
->font_height
))
4853 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4855 /* `(+ N)' or `(- N)' where N is an integer. */
4856 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4857 if (EQ (XCAR (it
->font_height
), Qplus
))
4859 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4861 else if (FUNCTIONP (it
->font_height
))
4863 /* Call function with current height as argument.
4864 Value is the new height. */
4866 height
= safe_call1 (it
->font_height
,
4867 face
->lface
[LFACE_HEIGHT_INDEX
]);
4868 if (NUMBERP (height
))
4869 new_height
= XFLOATINT (height
);
4871 else if (NUMBERP (it
->font_height
))
4873 /* Value is a multiple of the canonical char height. */
4876 f
= FACE_FROM_ID (it
->f
,
4877 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4878 new_height
= (XFLOATINT (it
->font_height
)
4879 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4883 /* Evaluate IT->font_height with `height' bound to the
4884 current specified height to get the new height. */
4885 ptrdiff_t count
= SPECPDL_INDEX ();
4887 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4888 value
= safe_eval (it
->font_height
);
4889 unbind_to (count
, Qnil
);
4891 if (NUMBERP (value
))
4892 new_height
= XFLOATINT (value
);
4896 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4903 /* Handle `(space-width WIDTH)'. */
4905 && EQ (XCAR (spec
), Qspace_width
)
4906 && CONSP (XCDR (spec
)))
4910 if (!FRAME_WINDOW_P (it
->f
))
4913 value
= XCAR (XCDR (spec
));
4914 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4915 it
->space_width
= value
;
4921 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4923 && EQ (XCAR (spec
), Qslice
))
4929 if (!FRAME_WINDOW_P (it
->f
))
4932 if (tem
= XCDR (spec
), CONSP (tem
))
4934 it
->slice
.x
= XCAR (tem
);
4935 if (tem
= XCDR (tem
), CONSP (tem
))
4937 it
->slice
.y
= XCAR (tem
);
4938 if (tem
= XCDR (tem
), CONSP (tem
))
4940 it
->slice
.width
= XCAR (tem
);
4941 if (tem
= XCDR (tem
), CONSP (tem
))
4942 it
->slice
.height
= XCAR (tem
);
4951 /* Handle `(raise FACTOR)'. */
4953 && EQ (XCAR (spec
), Qraise
)
4954 && CONSP (XCDR (spec
)))
4958 if (!FRAME_WINDOW_P (it
->f
))
4961 #ifdef HAVE_WINDOW_SYSTEM
4962 value
= XCAR (XCDR (spec
));
4963 if (NUMBERP (value
))
4965 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4966 it
->voffset
= - (XFLOATINT (value
)
4967 * (FONT_HEIGHT (face
->font
)));
4969 #endif /* HAVE_WINDOW_SYSTEM */
4975 /* Don't handle the other kinds of display specifications
4976 inside a string that we got from a `display' property. */
4977 if (it
&& it
->string_from_display_prop_p
)
4980 /* Characters having this form of property are not displayed, so
4981 we have to find the end of the property. */
4984 start_pos
= *position
;
4985 *position
= display_prop_end (it
, object
, start_pos
);
4989 /* Stop the scan at that end position--we assume that all
4990 text properties change there. */
4992 it
->stop_charpos
= position
->charpos
;
4994 /* Handle `(left-fringe BITMAP [FACE])'
4995 and `(right-fringe BITMAP [FACE])'. */
4997 && (EQ (XCAR (spec
), Qleft_fringe
)
4998 || EQ (XCAR (spec
), Qright_fringe
))
4999 && CONSP (XCDR (spec
)))
5005 if (!FRAME_WINDOW_P (it
->f
))
5006 /* If we return here, POSITION has been advanced
5007 across the text with this property. */
5009 /* Synchronize the bidi iterator with POSITION. This is
5010 needed because we are not going to push the iterator
5011 on behalf of this display property, so there will be
5012 no pop_it call to do this synchronization for us. */
5015 it
->position
= *position
;
5016 iterate_out_of_display_property (it
);
5017 *position
= it
->position
;
5019 /* If we were to display this fringe bitmap,
5020 next_element_from_image would have reset this flag.
5021 Do the same, to avoid affecting overlays that
5023 it
->ignore_overlay_strings_at_pos_p
= 0;
5027 else if (!frame_window_p
)
5030 #ifdef HAVE_WINDOW_SYSTEM
5031 value
= XCAR (XCDR (spec
));
5032 if (!SYMBOLP (value
)
5033 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5034 /* If we return here, POSITION has been advanced
5035 across the text with this property. */
5037 if (it
&& it
->bidi_p
)
5039 it
->position
= *position
;
5040 iterate_out_of_display_property (it
);
5041 *position
= it
->position
;
5044 /* Reset this flag like next_element_from_image would. */
5045 it
->ignore_overlay_strings_at_pos_p
= 0;
5051 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5053 if (CONSP (XCDR (XCDR (spec
))))
5055 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5056 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5062 /* Save current settings of IT so that we can restore them
5063 when we are finished with the glyph property value. */
5064 push_it (it
, position
);
5066 it
->area
= TEXT_AREA
;
5067 it
->what
= IT_IMAGE
;
5068 it
->image_id
= -1; /* no image */
5069 it
->position
= start_pos
;
5070 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5071 it
->method
= GET_FROM_IMAGE
;
5072 it
->from_overlay
= Qnil
;
5073 it
->face_id
= face_id
;
5074 it
->from_disp_prop_p
= true;
5076 /* Say that we haven't consumed the characters with
5077 `display' property yet. The call to pop_it in
5078 set_iterator_to_next will clean this up. */
5079 *position
= start_pos
;
5081 if (EQ (XCAR (spec
), Qleft_fringe
))
5083 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5084 it
->left_user_fringe_face_id
= face_id
;
5088 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5089 it
->right_user_fringe_face_id
= face_id
;
5092 #endif /* HAVE_WINDOW_SYSTEM */
5096 /* Prepare to handle `((margin left-margin) ...)',
5097 `((margin right-margin) ...)' and `((margin nil) ...)'
5098 prefixes for display specifications. */
5099 location
= Qunbound
;
5100 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5104 value
= XCDR (spec
);
5106 value
= XCAR (value
);
5109 if (EQ (XCAR (tem
), Qmargin
)
5110 && (tem
= XCDR (tem
),
5111 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5113 || EQ (tem
, Qleft_margin
)
5114 || EQ (tem
, Qright_margin
))))
5118 if (EQ (location
, Qunbound
))
5124 /* After this point, VALUE is the property after any
5125 margin prefix has been stripped. It must be a string,
5126 an image specification, or `(space ...)'.
5128 LOCATION specifies where to display: `left-margin',
5129 `right-margin' or nil. */
5131 valid_p
= (STRINGP (value
)
5132 #ifdef HAVE_WINDOW_SYSTEM
5133 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5134 && valid_image_p (value
))
5135 #endif /* not HAVE_WINDOW_SYSTEM */
5136 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5137 #ifdef HAVE_XWIDGETS
5138 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5139 && valid_xwidget_spec_p(value
))
5143 if (valid_p
&& !display_replaced_p
)
5149 /* Callers need to know whether the display spec is any kind
5150 of `(space ...)' spec that is about to affect text-area
5152 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5157 /* Save current settings of IT so that we can restore them
5158 when we are finished with the glyph property value. */
5159 push_it (it
, position
);
5160 it
->from_overlay
= overlay
;
5161 it
->from_disp_prop_p
= true;
5163 if (NILP (location
))
5164 it
->area
= TEXT_AREA
;
5165 else if (EQ (location
, Qleft_margin
))
5166 it
->area
= LEFT_MARGIN_AREA
;
5168 it
->area
= RIGHT_MARGIN_AREA
;
5170 if (STRINGP (value
))
5173 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5174 it
->current
.overlay_string_index
= -1;
5175 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5176 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5177 it
->method
= GET_FROM_STRING
;
5178 it
->stop_charpos
= 0;
5180 it
->base_level_stop
= 0;
5181 it
->string_from_display_prop_p
= true;
5182 /* Say that we haven't consumed the characters with
5183 `display' property yet. The call to pop_it in
5184 set_iterator_to_next will clean this up. */
5185 if (BUFFERP (object
))
5186 *position
= start_pos
;
5188 /* Force paragraph direction to be that of the parent
5189 object. If the parent object's paragraph direction is
5190 not yet determined, default to L2R. */
5191 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5192 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5194 it
->paragraph_embedding
= L2R
;
5196 /* Set up the bidi iterator for this display string. */
5199 it
->bidi_it
.string
.lstring
= it
->string
;
5200 it
->bidi_it
.string
.s
= NULL
;
5201 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5202 it
->bidi_it
.string
.bufpos
= bufpos
;
5203 it
->bidi_it
.string
.from_disp_str
= 1;
5204 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5205 it
->bidi_it
.w
= it
->w
;
5206 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5209 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5211 it
->method
= GET_FROM_STRETCH
;
5213 *position
= it
->position
= start_pos
;
5214 retval
= 1 + (it
->area
== TEXT_AREA
);
5216 #ifdef HAVE_XWIDGETS
5217 else if (valid_xwidget_spec_p(value
))
5219 it
->what
= IT_XWIDGET
;
5220 it
->method
= GET_FROM_XWIDGET
;
5221 it
->position
= start_pos
;
5222 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5223 *position
= start_pos
;
5225 it
->xwidget
= lookup_xwidget(value
);
5228 #ifdef HAVE_WINDOW_SYSTEM
5231 it
->what
= IT_IMAGE
;
5232 it
->image_id
= lookup_image (it
->f
, value
);
5233 it
->position
= start_pos
;
5234 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5235 it
->method
= GET_FROM_IMAGE
;
5237 /* Say that we haven't consumed the characters with
5238 `display' property yet. The call to pop_it in
5239 set_iterator_to_next will clean this up. */
5240 *position
= start_pos
;
5242 #endif /* HAVE_WINDOW_SYSTEM */
5247 /* Invalid property or property not supported. Restore
5248 POSITION to what it was before. */
5249 *position
= start_pos
;
5253 /* Check if PROP is a display property value whose text should be
5254 treated as intangible. OVERLAY is the overlay from which PROP
5255 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5256 specify the buffer position covered by PROP. */
5259 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5260 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5262 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5263 struct text_pos position
;
5265 SET_TEXT_POS (position
, charpos
, bytepos
);
5266 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5267 &position
, charpos
, frame_window_p
);
5271 /* Return 1 if PROP is a display sub-property value containing STRING.
5273 Implementation note: this and the following function are really
5274 special cases of handle_display_spec and
5275 handle_single_display_spec, and should ideally use the same code.
5276 Until they do, these two pairs must be consistent and must be
5277 modified in sync. */
5280 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5282 if (EQ (string
, prop
))
5285 /* Skip over `when FORM'. */
5286 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5291 /* Actually, the condition following `when' should be eval'ed,
5292 like handle_single_display_spec does, and we should return
5293 zero if it evaluates to nil. However, this function is
5294 called only when the buffer was already displayed and some
5295 glyph in the glyph matrix was found to come from a display
5296 string. Therefore, the condition was already evaluated, and
5297 the result was non-nil, otherwise the display string wouldn't
5298 have been displayed and we would have never been called for
5299 this property. Thus, we can skip the evaluation and assume
5300 its result is non-nil. */
5305 /* Skip over `margin LOCATION'. */
5306 if (EQ (XCAR (prop
), Qmargin
))
5317 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5321 /* Return 1 if STRING appears in the `display' property PROP. */
5324 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5327 && !EQ (XCAR (prop
), Qwhen
)
5328 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5330 /* A list of sub-properties. */
5331 while (CONSP (prop
))
5333 if (single_display_spec_string_p (XCAR (prop
), string
))
5338 else if (VECTORP (prop
))
5340 /* A vector of sub-properties. */
5342 for (i
= 0; i
< ASIZE (prop
); ++i
)
5343 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5347 return single_display_spec_string_p (prop
, string
);
5352 /* Look for STRING in overlays and text properties in the current
5353 buffer, between character positions FROM and TO (excluding TO).
5354 BACK_P non-zero means look back (in this case, TO is supposed to be
5356 Value is the first character position where STRING was found, or
5357 zero if it wasn't found before hitting TO.
5359 This function may only use code that doesn't eval because it is
5360 called asynchronously from note_mouse_highlight. */
5363 string_buffer_position_lim (Lisp_Object string
,
5364 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5366 Lisp_Object limit
, prop
, pos
;
5369 pos
= make_number (max (from
, BEGV
));
5371 if (!back_p
) /* looking forward */
5373 limit
= make_number (min (to
, ZV
));
5374 while (!found
&& !EQ (pos
, limit
))
5376 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5377 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5380 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5384 else /* looking back */
5386 limit
= make_number (max (to
, BEGV
));
5387 while (!found
&& !EQ (pos
, limit
))
5389 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5390 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5393 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5398 return found
? XINT (pos
) : 0;
5401 /* Determine which buffer position in current buffer STRING comes from.
5402 AROUND_CHARPOS is an approximate position where it could come from.
5403 Value is the buffer position or 0 if it couldn't be determined.
5405 This function is necessary because we don't record buffer positions
5406 in glyphs generated from strings (to keep struct glyph small).
5407 This function may only use code that doesn't eval because it is
5408 called asynchronously from note_mouse_highlight. */
5411 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5413 const int MAX_DISTANCE
= 1000;
5414 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5415 around_charpos
+ MAX_DISTANCE
,
5419 found
= string_buffer_position_lim (string
, around_charpos
,
5420 around_charpos
- MAX_DISTANCE
, 1);
5426 /***********************************************************************
5427 `composition' property
5428 ***********************************************************************/
5430 /* Set up iterator IT from `composition' property at its current
5431 position. Called from handle_stop. */
5433 static enum prop_handled
5434 handle_composition_prop (struct it
*it
)
5436 Lisp_Object prop
, string
;
5437 ptrdiff_t pos
, pos_byte
, start
, end
;
5439 if (STRINGP (it
->string
))
5443 pos
= IT_STRING_CHARPOS (*it
);
5444 pos_byte
= IT_STRING_BYTEPOS (*it
);
5445 string
= it
->string
;
5446 s
= SDATA (string
) + pos_byte
;
5447 it
->c
= STRING_CHAR (s
);
5451 pos
= IT_CHARPOS (*it
);
5452 pos_byte
= IT_BYTEPOS (*it
);
5454 it
->c
= FETCH_CHAR (pos_byte
);
5457 /* If there's a valid composition and point is not inside of the
5458 composition (in the case that the composition is from the current
5459 buffer), draw a glyph composed from the composition components. */
5460 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5461 && composition_valid_p (start
, end
, prop
)
5462 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5465 /* As we can't handle this situation (perhaps font-lock added
5466 a new composition), we just return here hoping that next
5467 redisplay will detect this composition much earlier. */
5468 return HANDLED_NORMALLY
;
5471 if (STRINGP (it
->string
))
5472 pos_byte
= string_char_to_byte (it
->string
, start
);
5474 pos_byte
= CHAR_TO_BYTE (start
);
5476 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5479 if (it
->cmp_it
.id
>= 0)
5482 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5483 it
->cmp_it
.nglyphs
= -1;
5487 return HANDLED_NORMALLY
;
5492 /***********************************************************************
5494 ***********************************************************************/
5496 /* The following structure is used to record overlay strings for
5497 later sorting in load_overlay_strings. */
5499 struct overlay_entry
5501 Lisp_Object overlay
;
5508 /* Set up iterator IT from overlay strings at its current position.
5509 Called from handle_stop. */
5511 static enum prop_handled
5512 handle_overlay_change (struct it
*it
)
5514 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5515 return HANDLED_RECOMPUTE_PROPS
;
5517 return HANDLED_NORMALLY
;
5521 /* Set up the next overlay string for delivery by IT, if there is an
5522 overlay string to deliver. Called by set_iterator_to_next when the
5523 end of the current overlay string is reached. If there are more
5524 overlay strings to display, IT->string and
5525 IT->current.overlay_string_index are set appropriately here.
5526 Otherwise IT->string is set to nil. */
5529 next_overlay_string (struct it
*it
)
5531 ++it
->current
.overlay_string_index
;
5532 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5534 /* No more overlay strings. Restore IT's settings to what
5535 they were before overlay strings were processed, and
5536 continue to deliver from current_buffer. */
5538 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5541 || (NILP (it
->string
)
5542 && it
->method
== GET_FROM_BUFFER
5543 && it
->stop_charpos
>= BEGV
5544 && it
->stop_charpos
<= it
->end_charpos
));
5545 it
->current
.overlay_string_index
= -1;
5546 it
->n_overlay_strings
= 0;
5547 it
->overlay_strings_charpos
= -1;
5548 /* If there's an empty display string on the stack, pop the
5549 stack, to resync the bidi iterator with IT's position. Such
5550 empty strings are pushed onto the stack in
5551 get_overlay_strings_1. */
5552 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5555 /* If we're at the end of the buffer, record that we have
5556 processed the overlay strings there already, so that
5557 next_element_from_buffer doesn't try it again. */
5558 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5559 it
->overlay_strings_at_end_processed_p
= true;
5563 /* There are more overlay strings to process. If
5564 IT->current.overlay_string_index has advanced to a position
5565 where we must load IT->overlay_strings with more strings, do
5566 it. We must load at the IT->overlay_strings_charpos where
5567 IT->n_overlay_strings was originally computed; when invisible
5568 text is present, this might not be IT_CHARPOS (Bug#7016). */
5569 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5571 if (it
->current
.overlay_string_index
&& i
== 0)
5572 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5574 /* Initialize IT to deliver display elements from the overlay
5576 it
->string
= it
->overlay_strings
[i
];
5577 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5578 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5579 it
->method
= GET_FROM_STRING
;
5580 it
->stop_charpos
= 0;
5581 it
->end_charpos
= SCHARS (it
->string
);
5582 if (it
->cmp_it
.stop_pos
>= 0)
5583 it
->cmp_it
.stop_pos
= 0;
5585 it
->base_level_stop
= 0;
5587 /* Set up the bidi iterator for this overlay string. */
5590 it
->bidi_it
.string
.lstring
= it
->string
;
5591 it
->bidi_it
.string
.s
= NULL
;
5592 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5593 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5594 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5595 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5596 it
->bidi_it
.w
= it
->w
;
5597 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5605 /* Compare two overlay_entry structures E1 and E2. Used as a
5606 comparison function for qsort in load_overlay_strings. Overlay
5607 strings for the same position are sorted so that
5609 1. All after-strings come in front of before-strings, except
5610 when they come from the same overlay.
5612 2. Within after-strings, strings are sorted so that overlay strings
5613 from overlays with higher priorities come first.
5615 2. Within before-strings, strings are sorted so that overlay
5616 strings from overlays with higher priorities come last.
5618 Value is analogous to strcmp. */
5622 compare_overlay_entries (const void *e1
, const void *e2
)
5624 struct overlay_entry
const *entry1
= e1
;
5625 struct overlay_entry
const *entry2
= e2
;
5628 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5630 /* Let after-strings appear in front of before-strings if
5631 they come from different overlays. */
5632 if (EQ (entry1
->overlay
, entry2
->overlay
))
5633 result
= entry1
->after_string_p
? 1 : -1;
5635 result
= entry1
->after_string_p
? -1 : 1;
5637 else if (entry1
->priority
!= entry2
->priority
)
5639 if (entry1
->after_string_p
)
5640 /* After-strings sorted in order of decreasing priority. */
5641 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5643 /* Before-strings sorted in order of increasing priority. */
5644 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5653 /* Load the vector IT->overlay_strings with overlay strings from IT's
5654 current buffer position, or from CHARPOS if that is > 0. Set
5655 IT->n_overlays to the total number of overlay strings found.
5657 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5658 a time. On entry into load_overlay_strings,
5659 IT->current.overlay_string_index gives the number of overlay
5660 strings that have already been loaded by previous calls to this
5663 IT->add_overlay_start contains an additional overlay start
5664 position to consider for taking overlay strings from, if non-zero.
5665 This position comes into play when the overlay has an `invisible'
5666 property, and both before and after-strings. When we've skipped to
5667 the end of the overlay, because of its `invisible' property, we
5668 nevertheless want its before-string to appear.
5669 IT->add_overlay_start will contain the overlay start position
5672 Overlay strings are sorted so that after-string strings come in
5673 front of before-string strings. Within before and after-strings,
5674 strings are sorted by overlay priority. See also function
5675 compare_overlay_entries. */
5678 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5680 Lisp_Object overlay
, window
, str
, invisible
;
5681 struct Lisp_Overlay
*ov
;
5682 ptrdiff_t start
, end
;
5683 ptrdiff_t n
= 0, i
, j
;
5685 struct overlay_entry entriesbuf
[20];
5686 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5687 struct overlay_entry
*entries
= entriesbuf
;
5691 charpos
= IT_CHARPOS (*it
);
5693 /* Append the overlay string STRING of overlay OVERLAY to vector
5694 `entries' which has size `size' and currently contains `n'
5695 elements. AFTER_P non-zero means STRING is an after-string of
5697 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5700 Lisp_Object priority; \
5704 struct overlay_entry *old = entries; \
5705 SAFE_NALLOCA (entries, 2, size); \
5706 memcpy (entries, old, size * sizeof *entries); \
5710 entries[n].string = (STRING); \
5711 entries[n].overlay = (OVERLAY); \
5712 priority = Foverlay_get ((OVERLAY), Qpriority); \
5713 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5714 entries[n].after_string_p = (AFTER_P); \
5719 /* Process overlay before the overlay center. */
5720 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5722 XSETMISC (overlay
, ov
);
5723 eassert (OVERLAYP (overlay
));
5724 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5725 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5730 /* Skip this overlay if it doesn't start or end at IT's current
5732 if (end
!= charpos
&& start
!= charpos
)
5735 /* Skip this overlay if it doesn't apply to IT->w. */
5736 window
= Foverlay_get (overlay
, Qwindow
);
5737 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5740 /* If the text ``under'' the overlay is invisible, both before-
5741 and after-strings from this overlay are visible; start and
5742 end position are indistinguishable. */
5743 invisible
= Foverlay_get (overlay
, Qinvisible
);
5744 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5746 /* If overlay has a non-empty before-string, record it. */
5747 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5748 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5750 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5752 /* If overlay has a non-empty after-string, record it. */
5753 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5754 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5756 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5759 /* Process overlays after the overlay center. */
5760 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5762 XSETMISC (overlay
, ov
);
5763 eassert (OVERLAYP (overlay
));
5764 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5765 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5767 if (start
> charpos
)
5770 /* Skip this overlay if it doesn't start or end at IT's current
5772 if (end
!= charpos
&& start
!= charpos
)
5775 /* Skip this overlay if it doesn't apply to IT->w. */
5776 window
= Foverlay_get (overlay
, Qwindow
);
5777 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5780 /* If the text ``under'' the overlay is invisible, it has a zero
5781 dimension, and both before- and after-strings apply. */
5782 invisible
= Foverlay_get (overlay
, Qinvisible
);
5783 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5785 /* If overlay has a non-empty before-string, record it. */
5786 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5787 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5789 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5791 /* If overlay has a non-empty after-string, record it. */
5792 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5793 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5795 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5798 #undef RECORD_OVERLAY_STRING
5802 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5804 /* Record number of overlay strings, and where we computed it. */
5805 it
->n_overlay_strings
= n
;
5806 it
->overlay_strings_charpos
= charpos
;
5808 /* IT->current.overlay_string_index is the number of overlay strings
5809 that have already been consumed by IT. Copy some of the
5810 remaining overlay strings to IT->overlay_strings. */
5812 j
= it
->current
.overlay_string_index
;
5813 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5815 it
->overlay_strings
[i
] = entries
[j
].string
;
5816 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5824 /* Get the first chunk of overlay strings at IT's current buffer
5825 position, or at CHARPOS if that is > 0. Value is non-zero if at
5826 least one overlay string was found. */
5829 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5831 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5832 process. This fills IT->overlay_strings with strings, and sets
5833 IT->n_overlay_strings to the total number of strings to process.
5834 IT->pos.overlay_string_index has to be set temporarily to zero
5835 because load_overlay_strings needs this; it must be set to -1
5836 when no overlay strings are found because a zero value would
5837 indicate a position in the first overlay string. */
5838 it
->current
.overlay_string_index
= 0;
5839 load_overlay_strings (it
, charpos
);
5841 /* If we found overlay strings, set up IT to deliver display
5842 elements from the first one. Otherwise set up IT to deliver
5843 from current_buffer. */
5844 if (it
->n_overlay_strings
)
5846 /* Make sure we know settings in current_buffer, so that we can
5847 restore meaningful values when we're done with the overlay
5850 compute_stop_pos (it
);
5851 eassert (it
->face_id
>= 0);
5853 /* Save IT's settings. They are restored after all overlay
5854 strings have been processed. */
5855 eassert (!compute_stop_p
|| it
->sp
== 0);
5857 /* When called from handle_stop, there might be an empty display
5858 string loaded. In that case, don't bother saving it. But
5859 don't use this optimization with the bidi iterator, since we
5860 need the corresponding pop_it call to resync the bidi
5861 iterator's position with IT's position, after we are done
5862 with the overlay strings. (The corresponding call to pop_it
5863 in case of an empty display string is in
5864 next_overlay_string.) */
5866 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5869 /* Set up IT to deliver display elements from the first overlay
5871 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5872 it
->string
= it
->overlay_strings
[0];
5873 it
->from_overlay
= Qnil
;
5874 it
->stop_charpos
= 0;
5875 eassert (STRINGP (it
->string
));
5876 it
->end_charpos
= SCHARS (it
->string
);
5878 it
->base_level_stop
= 0;
5879 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5880 it
->method
= GET_FROM_STRING
;
5881 it
->from_disp_prop_p
= 0;
5883 /* Force paragraph direction to be that of the parent
5885 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5886 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5888 it
->paragraph_embedding
= L2R
;
5890 /* Set up the bidi iterator for this overlay string. */
5893 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5895 it
->bidi_it
.string
.lstring
= it
->string
;
5896 it
->bidi_it
.string
.s
= NULL
;
5897 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5898 it
->bidi_it
.string
.bufpos
= pos
;
5899 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5900 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5901 it
->bidi_it
.w
= it
->w
;
5902 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5907 it
->current
.overlay_string_index
= -1;
5912 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5915 it
->method
= GET_FROM_BUFFER
;
5917 (void) get_overlay_strings_1 (it
, charpos
, 1);
5921 /* Value is non-zero if we found at least one overlay string. */
5922 return STRINGP (it
->string
);
5927 /***********************************************************************
5928 Saving and restoring state
5929 ***********************************************************************/
5931 /* Save current settings of IT on IT->stack. Called, for example,
5932 before setting up IT for an overlay string, to be able to restore
5933 IT's settings to what they were after the overlay string has been
5934 processed. If POSITION is non-NULL, it is the position to save on
5935 the stack instead of IT->position. */
5938 push_it (struct it
*it
, struct text_pos
*position
)
5940 struct iterator_stack_entry
*p
;
5942 eassert (it
->sp
< IT_STACK_SIZE
);
5943 p
= it
->stack
+ it
->sp
;
5945 p
->stop_charpos
= it
->stop_charpos
;
5946 p
->prev_stop
= it
->prev_stop
;
5947 p
->base_level_stop
= it
->base_level_stop
;
5948 p
->cmp_it
= it
->cmp_it
;
5949 eassert (it
->face_id
>= 0);
5950 p
->face_id
= it
->face_id
;
5951 p
->string
= it
->string
;
5952 p
->method
= it
->method
;
5953 p
->from_overlay
= it
->from_overlay
;
5956 case GET_FROM_IMAGE
:
5957 p
->u
.image
.object
= it
->object
;
5958 p
->u
.image
.image_id
= it
->image_id
;
5959 p
->u
.image
.slice
= it
->slice
;
5961 case GET_FROM_STRETCH
:
5962 p
->u
.stretch
.object
= it
->object
;
5964 #ifdef HAVE_XWIDGETS
5965 case GET_FROM_XWIDGET
:
5966 p
->u
.xwidget
.object
= it
->object
;
5970 p
->position
= position
? *position
: it
->position
;
5971 p
->current
= it
->current
;
5972 p
->end_charpos
= it
->end_charpos
;
5973 p
->string_nchars
= it
->string_nchars
;
5975 p
->multibyte_p
= it
->multibyte_p
;
5976 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5977 p
->space_width
= it
->space_width
;
5978 p
->font_height
= it
->font_height
;
5979 p
->voffset
= it
->voffset
;
5980 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5981 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5982 p
->display_ellipsis_p
= 0;
5983 p
->line_wrap
= it
->line_wrap
;
5984 p
->bidi_p
= it
->bidi_p
;
5985 p
->paragraph_embedding
= it
->paragraph_embedding
;
5986 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5989 /* Save the state of the bidi iterator as well. */
5991 bidi_push_it (&it
->bidi_it
);
5995 iterate_out_of_display_property (struct it
*it
)
5997 int buffer_p
= !STRINGP (it
->string
);
5998 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5999 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6001 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6003 /* Maybe initialize paragraph direction. If we are at the beginning
6004 of a new paragraph, next_element_from_buffer may not have a
6005 chance to do that. */
6006 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6007 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6008 /* prev_stop can be zero, so check against BEGV as well. */
6009 while (it
->bidi_it
.charpos
>= bob
6010 && it
->prev_stop
<= it
->bidi_it
.charpos
6011 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6012 && it
->bidi_it
.charpos
< eob
)
6013 bidi_move_to_visually_next (&it
->bidi_it
);
6014 /* Record the stop_pos we just crossed, for when we cross it
6016 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6017 it
->prev_stop
= CHARPOS (it
->position
);
6018 /* If we ended up not where pop_it put us, resync IT's
6019 positional members with the bidi iterator. */
6020 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6021 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6023 it
->current
.pos
= it
->position
;
6025 it
->current
.string_pos
= it
->position
;
6028 /* Restore IT's settings from IT->stack. Called, for example, when no
6029 more overlay strings must be processed, and we return to delivering
6030 display elements from a buffer, or when the end of a string from a
6031 `display' property is reached and we return to delivering display
6032 elements from an overlay string, or from a buffer. */
6035 pop_it (struct it
*it
)
6037 struct iterator_stack_entry
*p
;
6038 int from_display_prop
= it
->from_disp_prop_p
;
6040 eassert (it
->sp
> 0);
6042 p
= it
->stack
+ it
->sp
;
6043 it
->stop_charpos
= p
->stop_charpos
;
6044 it
->prev_stop
= p
->prev_stop
;
6045 it
->base_level_stop
= p
->base_level_stop
;
6046 it
->cmp_it
= p
->cmp_it
;
6047 it
->face_id
= p
->face_id
;
6048 it
->current
= p
->current
;
6049 it
->position
= p
->position
;
6050 it
->string
= p
->string
;
6051 it
->from_overlay
= p
->from_overlay
;
6052 if (NILP (it
->string
))
6053 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6054 it
->method
= p
->method
;
6057 case GET_FROM_IMAGE
:
6058 it
->image_id
= p
->u
.image
.image_id
;
6059 it
->object
= p
->u
.image
.object
;
6060 it
->slice
= p
->u
.image
.slice
;
6062 #ifdef HAVE_XWIDGETS
6063 case GET_FROM_XWIDGET
:
6064 it
->object
= p
->u
.xwidget
.object
;
6067 case GET_FROM_STRETCH
:
6068 it
->object
= p
->u
.stretch
.object
;
6070 case GET_FROM_BUFFER
:
6071 it
->object
= it
->w
->contents
;
6073 case GET_FROM_STRING
:
6075 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6077 /* Restore the face_box_p flag, since it could have been
6078 overwritten by the face of the object that we just finished
6081 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6082 it
->object
= it
->string
;
6085 case GET_FROM_DISPLAY_VECTOR
:
6087 it
->method
= GET_FROM_C_STRING
;
6088 else if (STRINGP (it
->string
))
6089 it
->method
= GET_FROM_STRING
;
6092 it
->method
= GET_FROM_BUFFER
;
6093 it
->object
= it
->w
->contents
;
6096 it
->end_charpos
= p
->end_charpos
;
6097 it
->string_nchars
= p
->string_nchars
;
6099 it
->multibyte_p
= p
->multibyte_p
;
6100 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6101 it
->space_width
= p
->space_width
;
6102 it
->font_height
= p
->font_height
;
6103 it
->voffset
= p
->voffset
;
6104 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6105 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6106 it
->line_wrap
= p
->line_wrap
;
6107 it
->bidi_p
= p
->bidi_p
;
6108 it
->paragraph_embedding
= p
->paragraph_embedding
;
6109 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6112 bidi_pop_it (&it
->bidi_it
);
6113 /* Bidi-iterate until we get out of the portion of text, if any,
6114 covered by a `display' text property or by an overlay with
6115 `display' property. (We cannot just jump there, because the
6116 internal coherency of the bidi iterator state can not be
6117 preserved across such jumps.) We also must determine the
6118 paragraph base direction if the overlay we just processed is
6119 at the beginning of a new paragraph. */
6120 if (from_display_prop
6121 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6122 iterate_out_of_display_property (it
);
6124 eassert ((BUFFERP (it
->object
)
6125 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6126 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6127 || (STRINGP (it
->object
)
6128 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6129 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6130 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6136 /***********************************************************************
6138 ***********************************************************************/
6140 /* Set IT's current position to the previous line start. */
6143 back_to_previous_line_start (struct it
*it
)
6145 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6148 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6152 /* Move IT to the next line start.
6154 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6155 we skipped over part of the text (as opposed to moving the iterator
6156 continuously over the text). Otherwise, don't change the value
6159 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6160 iterator on the newline, if it was found.
6162 Newlines may come from buffer text, overlay strings, or strings
6163 displayed via the `display' property. That's the reason we can't
6164 simply use find_newline_no_quit.
6166 Note that this function may not skip over invisible text that is so
6167 because of text properties and immediately follows a newline. If
6168 it would, function reseat_at_next_visible_line_start, when called
6169 from set_iterator_to_next, would effectively make invisible
6170 characters following a newline part of the wrong glyph row, which
6171 leads to wrong cursor motion. */
6174 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6175 struct bidi_it
*bidi_it_prev
)
6177 ptrdiff_t old_selective
;
6178 int newline_found_p
, n
;
6179 const int MAX_NEWLINE_DISTANCE
= 500;
6181 /* If already on a newline, just consume it to avoid unintended
6182 skipping over invisible text below. */
6183 if (it
->what
== IT_CHARACTER
6185 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6187 if (it
->bidi_p
&& bidi_it_prev
)
6188 *bidi_it_prev
= it
->bidi_it
;
6189 set_iterator_to_next (it
, 0);
6194 /* Don't handle selective display in the following. It's (a)
6195 unnecessary because it's done by the caller, and (b) leads to an
6196 infinite recursion because next_element_from_ellipsis indirectly
6197 calls this function. */
6198 old_selective
= it
->selective
;
6201 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6202 from buffer text. */
6203 for (n
= newline_found_p
= 0;
6204 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6205 n
+= STRINGP (it
->string
) ? 0 : 1)
6207 if (!get_next_display_element (it
))
6209 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6210 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6211 *bidi_it_prev
= it
->bidi_it
;
6212 set_iterator_to_next (it
, 0);
6215 /* If we didn't find a newline near enough, see if we can use a
6217 if (!newline_found_p
)
6219 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6220 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6224 eassert (!STRINGP (it
->string
));
6226 /* If there isn't any `display' property in sight, and no
6227 overlays, we can just use the position of the newline in
6229 if (it
->stop_charpos
>= limit
6230 || ((pos
= Fnext_single_property_change (make_number (start
),
6232 make_number (limit
)),
6234 && next_overlay_change (start
) == ZV
))
6238 IT_CHARPOS (*it
) = limit
;
6239 IT_BYTEPOS (*it
) = bytepos
;
6243 struct bidi_it bprev
;
6245 /* Help bidi.c avoid expensive searches for display
6246 properties and overlays, by telling it that there are
6247 none up to `limit'. */
6248 if (it
->bidi_it
.disp_pos
< limit
)
6250 it
->bidi_it
.disp_pos
= limit
;
6251 it
->bidi_it
.disp_prop
= 0;
6254 bprev
= it
->bidi_it
;
6255 bidi_move_to_visually_next (&it
->bidi_it
);
6256 } while (it
->bidi_it
.charpos
!= limit
);
6257 IT_CHARPOS (*it
) = limit
;
6258 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6260 *bidi_it_prev
= bprev
;
6262 *skipped_p
= newline_found_p
= true;
6266 while (get_next_display_element (it
)
6267 && !newline_found_p
)
6269 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6270 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6271 *bidi_it_prev
= it
->bidi_it
;
6272 set_iterator_to_next (it
, 0);
6277 it
->selective
= old_selective
;
6278 return newline_found_p
;
6282 /* Set IT's current position to the previous visible line start. Skip
6283 invisible text that is so either due to text properties or due to
6284 selective display. Caution: this does not change IT->current_x and
6288 back_to_previous_visible_line_start (struct it
*it
)
6290 while (IT_CHARPOS (*it
) > BEGV
)
6292 back_to_previous_line_start (it
);
6294 if (IT_CHARPOS (*it
) <= BEGV
)
6297 /* If selective > 0, then lines indented more than its value are
6299 if (it
->selective
> 0
6300 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6304 /* Check the newline before point for invisibility. */
6307 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6308 Qinvisible
, it
->window
);
6309 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6313 if (IT_CHARPOS (*it
) <= BEGV
)
6318 void *it2data
= NULL
;
6321 Lisp_Object val
, overlay
;
6323 SAVE_IT (it2
, *it
, it2data
);
6325 /* If newline is part of a composition, continue from start of composition */
6326 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6327 && beg
< IT_CHARPOS (*it
))
6330 /* If newline is replaced by a display property, find start of overlay
6331 or interval and continue search from that point. */
6332 pos
= --IT_CHARPOS (it2
);
6335 bidi_unshelve_cache (NULL
, 0);
6336 it2
.string_from_display_prop_p
= 0;
6337 it2
.from_disp_prop_p
= 0;
6338 if (handle_display_prop (&it2
) == HANDLED_RETURN
6339 && !NILP (val
= get_char_property_and_overlay
6340 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6341 && (OVERLAYP (overlay
)
6342 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6343 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6345 RESTORE_IT (it
, it
, it2data
);
6349 /* Newline is not replaced by anything -- so we are done. */
6350 RESTORE_IT (it
, it
, it2data
);
6356 IT_CHARPOS (*it
) = beg
;
6357 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6361 it
->continuation_lines_width
= 0;
6363 eassert (IT_CHARPOS (*it
) >= BEGV
);
6364 eassert (IT_CHARPOS (*it
) == BEGV
6365 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6370 /* Reseat iterator IT at the previous visible line start. Skip
6371 invisible text that is so either due to text properties or due to
6372 selective display. At the end, update IT's overlay information,
6373 face information etc. */
6376 reseat_at_previous_visible_line_start (struct it
*it
)
6378 back_to_previous_visible_line_start (it
);
6379 reseat (it
, it
->current
.pos
, 1);
6384 /* Reseat iterator IT on the next visible line start in the current
6385 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6386 preceding the line start. Skip over invisible text that is so
6387 because of selective display. Compute faces, overlays etc at the
6388 new position. Note that this function does not skip over text that
6389 is invisible because of text properties. */
6392 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6394 int newline_found_p
, skipped_p
= 0;
6395 struct bidi_it bidi_it_prev
;
6397 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6399 /* Skip over lines that are invisible because they are indented
6400 more than the value of IT->selective. */
6401 if (it
->selective
> 0)
6402 while (IT_CHARPOS (*it
) < ZV
6403 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6406 eassert (IT_BYTEPOS (*it
) == BEGV
6407 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6409 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6412 /* Position on the newline if that's what's requested. */
6413 if (on_newline_p
&& newline_found_p
)
6415 if (STRINGP (it
->string
))
6417 if (IT_STRING_CHARPOS (*it
) > 0)
6421 --IT_STRING_CHARPOS (*it
);
6422 --IT_STRING_BYTEPOS (*it
);
6426 /* We need to restore the bidi iterator to the state
6427 it had on the newline, and resync the IT's
6428 position with that. */
6429 it
->bidi_it
= bidi_it_prev
;
6430 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6431 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6435 else if (IT_CHARPOS (*it
) > BEGV
)
6444 /* We need to restore the bidi iterator to the state it
6445 had on the newline and resync IT with that. */
6446 it
->bidi_it
= bidi_it_prev
;
6447 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6448 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6450 reseat (it
, it
->current
.pos
, 0);
6454 reseat (it
, it
->current
.pos
, 0);
6461 /***********************************************************************
6462 Changing an iterator's position
6463 ***********************************************************************/
6465 /* Change IT's current position to POS in current_buffer. If FORCE_P
6466 is non-zero, always check for text properties at the new position.
6467 Otherwise, text properties are only looked up if POS >=
6468 IT->check_charpos of a property. */
6471 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6473 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6475 reseat_1 (it
, pos
, 0);
6477 /* Determine where to check text properties. Avoid doing it
6478 where possible because text property lookup is very expensive. */
6480 || CHARPOS (pos
) > it
->stop_charpos
6481 || CHARPOS (pos
) < original_pos
)
6485 /* For bidi iteration, we need to prime prev_stop and
6486 base_level_stop with our best estimations. */
6487 /* Implementation note: Of course, POS is not necessarily a
6488 stop position, so assigning prev_pos to it is a lie; we
6489 should have called compute_stop_backwards. However, if
6490 the current buffer does not include any R2L characters,
6491 that call would be a waste of cycles, because the
6492 iterator will never move back, and thus never cross this
6493 "fake" stop position. So we delay that backward search
6494 until the time we really need it, in next_element_from_buffer. */
6495 if (CHARPOS (pos
) != it
->prev_stop
)
6496 it
->prev_stop
= CHARPOS (pos
);
6497 if (CHARPOS (pos
) < it
->base_level_stop
)
6498 it
->base_level_stop
= 0; /* meaning it's unknown */
6504 it
->prev_stop
= it
->base_level_stop
= 0;
6513 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6514 IT->stop_pos to POS, also. */
6517 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6519 /* Don't call this function when scanning a C string. */
6520 eassert (it
->s
== NULL
);
6522 /* POS must be a reasonable value. */
6523 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6525 it
->current
.pos
= it
->position
= pos
;
6526 it
->end_charpos
= ZV
;
6528 it
->current
.dpvec_index
= -1;
6529 it
->current
.overlay_string_index
= -1;
6530 IT_STRING_CHARPOS (*it
) = -1;
6531 IT_STRING_BYTEPOS (*it
) = -1;
6533 it
->method
= GET_FROM_BUFFER
;
6534 it
->object
= it
->w
->contents
;
6535 it
->area
= TEXT_AREA
;
6536 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6538 it
->string_from_display_prop_p
= 0;
6539 it
->string_from_prefix_prop_p
= 0;
6541 it
->from_disp_prop_p
= 0;
6542 it
->face_before_selective_p
= 0;
6545 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6547 bidi_unshelve_cache (NULL
, 0);
6548 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6549 it
->bidi_it
.string
.s
= NULL
;
6550 it
->bidi_it
.string
.lstring
= Qnil
;
6551 it
->bidi_it
.string
.bufpos
= 0;
6552 it
->bidi_it
.string
.from_disp_str
= 0;
6553 it
->bidi_it
.string
.unibyte
= 0;
6554 it
->bidi_it
.w
= it
->w
;
6559 it
->stop_charpos
= CHARPOS (pos
);
6560 it
->base_level_stop
= CHARPOS (pos
);
6562 /* This make the information stored in it->cmp_it invalidate. */
6567 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6568 If S is non-null, it is a C string to iterate over. Otherwise,
6569 STRING gives a Lisp string to iterate over.
6571 If PRECISION > 0, don't return more then PRECISION number of
6572 characters from the string.
6574 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6575 characters have been returned. FIELD_WIDTH < 0 means an infinite
6578 MULTIBYTE = 0 means disable processing of multibyte characters,
6579 MULTIBYTE > 0 means enable it,
6580 MULTIBYTE < 0 means use IT->multibyte_p.
6582 IT must be initialized via a prior call to init_iterator before
6583 calling this function. */
6586 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6587 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6590 /* No text property checks performed by default, but see below. */
6591 it
->stop_charpos
= -1;
6593 /* Set iterator position and end position. */
6594 memset (&it
->current
, 0, sizeof it
->current
);
6595 it
->current
.overlay_string_index
= -1;
6596 it
->current
.dpvec_index
= -1;
6597 eassert (charpos
>= 0);
6599 /* If STRING is specified, use its multibyteness, otherwise use the
6600 setting of MULTIBYTE, if specified. */
6602 it
->multibyte_p
= multibyte
> 0;
6604 /* Bidirectional reordering of strings is controlled by the default
6605 value of bidi-display-reordering. Don't try to reorder while
6606 loading loadup.el, as the necessary character property tables are
6607 not yet available. */
6610 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6614 eassert (STRINGP (string
));
6615 it
->string
= string
;
6617 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6618 it
->method
= GET_FROM_STRING
;
6619 it
->current
.string_pos
= string_pos (charpos
, string
);
6623 it
->bidi_it
.string
.lstring
= string
;
6624 it
->bidi_it
.string
.s
= NULL
;
6625 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6626 it
->bidi_it
.string
.bufpos
= 0;
6627 it
->bidi_it
.string
.from_disp_str
= 0;
6628 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6629 it
->bidi_it
.w
= it
->w
;
6630 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6631 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6636 it
->s
= (const unsigned char *) s
;
6639 /* Note that we use IT->current.pos, not it->current.string_pos,
6640 for displaying C strings. */
6641 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6642 if (it
->multibyte_p
)
6644 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6645 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6649 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6650 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6655 it
->bidi_it
.string
.lstring
= Qnil
;
6656 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6657 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6658 it
->bidi_it
.string
.bufpos
= 0;
6659 it
->bidi_it
.string
.from_disp_str
= 0;
6660 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6661 it
->bidi_it
.w
= it
->w
;
6662 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6665 it
->method
= GET_FROM_C_STRING
;
6668 /* PRECISION > 0 means don't return more than PRECISION characters
6670 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6672 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6674 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6677 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6678 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6679 FIELD_WIDTH < 0 means infinite field width. This is useful for
6680 padding with `-' at the end of a mode line. */
6681 if (field_width
< 0)
6682 field_width
= INFINITY
;
6683 /* Implementation note: We deliberately don't enlarge
6684 it->bidi_it.string.schars here to fit it->end_charpos, because
6685 the bidi iterator cannot produce characters out of thin air. */
6686 if (field_width
> it
->end_charpos
- charpos
)
6687 it
->end_charpos
= charpos
+ field_width
;
6689 /* Use the standard display table for displaying strings. */
6690 if (DISP_TABLE_P (Vstandard_display_table
))
6691 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6693 it
->stop_charpos
= charpos
;
6694 it
->prev_stop
= charpos
;
6695 it
->base_level_stop
= 0;
6698 it
->bidi_it
.first_elt
= 1;
6699 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6700 it
->bidi_it
.disp_pos
= -1;
6702 if (s
== NULL
&& it
->multibyte_p
)
6704 ptrdiff_t endpos
= SCHARS (it
->string
);
6705 if (endpos
> it
->end_charpos
)
6706 endpos
= it
->end_charpos
;
6707 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6715 /***********************************************************************
6717 ***********************************************************************/
6719 /* Map enum it_method value to corresponding next_element_from_* function. */
6721 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6723 next_element_from_buffer
,
6724 next_element_from_display_vector
,
6725 next_element_from_string
,
6726 next_element_from_c_string
,
6727 next_element_from_image
,
6728 next_element_from_stretch
6729 #ifdef HAVE_XWIDGETS
6730 ,next_element_from_xwidget
6734 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6737 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6738 (possibly with the following characters). */
6740 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6741 ((IT)->cmp_it.id >= 0 \
6742 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6743 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6744 END_CHARPOS, (IT)->w, \
6745 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6749 /* Lookup the char-table Vglyphless_char_display for character C (-1
6750 if we want information for no-font case), and return the display
6751 method symbol. By side-effect, update it->what and
6752 it->glyphless_method. This function is called from
6753 get_next_display_element for each character element, and from
6754 x_produce_glyphs when no suitable font was found. */
6757 lookup_glyphless_char_display (int c
, struct it
*it
)
6759 Lisp_Object glyphless_method
= Qnil
;
6761 if (CHAR_TABLE_P (Vglyphless_char_display
)
6762 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6766 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6767 if (CONSP (glyphless_method
))
6768 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6769 ? XCAR (glyphless_method
)
6770 : XCDR (glyphless_method
);
6773 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6777 if (NILP (glyphless_method
))
6780 /* The default is to display the character by a proper font. */
6782 /* The default for the no-font case is to display an empty box. */
6783 glyphless_method
= Qempty_box
;
6785 if (EQ (glyphless_method
, Qzero_width
))
6788 return glyphless_method
;
6789 /* This method can't be used for the no-font case. */
6790 glyphless_method
= Qempty_box
;
6792 if (EQ (glyphless_method
, Qthin_space
))
6793 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6794 else if (EQ (glyphless_method
, Qempty_box
))
6795 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6796 else if (EQ (glyphless_method
, Qhex_code
))
6797 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6798 else if (STRINGP (glyphless_method
))
6799 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6802 /* Invalid value. We use the default method. */
6803 glyphless_method
= Qnil
;
6806 it
->what
= IT_GLYPHLESS
;
6807 return glyphless_method
;
6810 /* Merge escape glyph face and cache the result. */
6812 static struct frame
*last_escape_glyph_frame
= NULL
;
6813 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6814 static int last_escape_glyph_merged_face_id
= 0;
6817 merge_escape_glyph_face (struct it
*it
)
6821 if (it
->f
== last_escape_glyph_frame
6822 && it
->face_id
== last_escape_glyph_face_id
)
6823 face_id
= last_escape_glyph_merged_face_id
;
6826 /* Merge the `escape-glyph' face into the current face. */
6827 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6828 last_escape_glyph_frame
= it
->f
;
6829 last_escape_glyph_face_id
= it
->face_id
;
6830 last_escape_glyph_merged_face_id
= face_id
;
6835 /* Likewise for glyphless glyph face. */
6837 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6838 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6839 static int last_glyphless_glyph_merged_face_id
= 0;
6842 merge_glyphless_glyph_face (struct it
*it
)
6846 if (it
->f
== last_glyphless_glyph_frame
6847 && it
->face_id
== last_glyphless_glyph_face_id
)
6848 face_id
= last_glyphless_glyph_merged_face_id
;
6851 /* Merge the `glyphless-char' face into the current face. */
6852 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6853 last_glyphless_glyph_frame
= it
->f
;
6854 last_glyphless_glyph_face_id
= it
->face_id
;
6855 last_glyphless_glyph_merged_face_id
= face_id
;
6860 /* Load IT's display element fields with information about the next
6861 display element from the current position of IT. Value is zero if
6862 end of buffer (or C string) is reached. */
6865 get_next_display_element (struct it
*it
)
6867 /* Non-zero means that we found a display element. Zero means that
6868 we hit the end of what we iterate over. Performance note: the
6869 function pointer `method' used here turns out to be faster than
6870 using a sequence of if-statements. */
6874 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6876 if (it
->what
== IT_CHARACTER
)
6878 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6879 and only if (a) the resolved directionality of that character
6881 /* FIXME: Do we need an exception for characters from display
6883 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6884 && !inhibit_bidi_mirroring
)
6885 it
->c
= bidi_mirror_char (it
->c
);
6886 /* Map via display table or translate control characters.
6887 IT->c, IT->len etc. have been set to the next character by
6888 the function call above. If we have a display table, and it
6889 contains an entry for IT->c, translate it. Don't do this if
6890 IT->c itself comes from a display table, otherwise we could
6891 end up in an infinite recursion. (An alternative could be to
6892 count the recursion depth of this function and signal an
6893 error when a certain maximum depth is reached.) Is it worth
6895 if (success_p
&& it
->dpvec
== NULL
)
6898 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6899 int nonascii_space_p
= 0;
6900 int nonascii_hyphen_p
= 0;
6901 int c
= it
->c
; /* This is the character to display. */
6903 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6905 eassert (SINGLE_BYTE_CHAR_P (c
));
6906 if (unibyte_display_via_language_environment
)
6908 c
= DECODE_CHAR (unibyte
, c
);
6910 c
= BYTE8_TO_CHAR (it
->c
);
6913 c
= BYTE8_TO_CHAR (it
->c
);
6917 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6920 struct Lisp_Vector
*v
= XVECTOR (dv
);
6922 /* Return the first character from the display table
6923 entry, if not empty. If empty, don't display the
6924 current character. */
6927 it
->dpvec_char_len
= it
->len
;
6928 it
->dpvec
= v
->contents
;
6929 it
->dpend
= v
->contents
+ v
->header
.size
;
6930 it
->current
.dpvec_index
= 0;
6931 it
->dpvec_face_id
= -1;
6932 it
->saved_face_id
= it
->face_id
;
6933 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6938 set_iterator_to_next (it
, 0);
6943 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6945 if (it
->what
== IT_GLYPHLESS
)
6947 /* Don't display this character. */
6948 set_iterator_to_next (it
, 0);
6952 /* If `nobreak-char-display' is non-nil, we display
6953 non-ASCII spaces and hyphens specially. */
6954 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6957 nonascii_space_p
= true;
6958 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6959 nonascii_hyphen_p
= true;
6962 /* Translate control characters into `\003' or `^C' form.
6963 Control characters coming from a display table entry are
6964 currently not translated because we use IT->dpvec to hold
6965 the translation. This could easily be changed but I
6966 don't believe that it is worth doing.
6968 The characters handled by `nobreak-char-display' must be
6971 Non-printable characters and raw-byte characters are also
6972 translated to octal form. */
6973 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6974 ? (it
->area
!= TEXT_AREA
6975 /* In mode line, treat \n, \t like other crl chars. */
6978 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6979 || (c
!= '\n' && c
!= '\t'))
6981 || nonascii_hyphen_p
6983 || ! CHAR_PRINTABLE_P (c
))))
6985 /* C is a control character, non-ASCII space/hyphen,
6986 raw-byte, or a non-printable character which must be
6987 displayed either as '\003' or as `^C' where the '\\'
6988 and '^' can be defined in the display table. Fill
6989 IT->ctl_chars with glyphs for what we have to
6990 display. Then, set IT->dpvec to these glyphs. */
6997 /* Handle control characters with ^. */
6999 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7003 g
= '^'; /* default glyph for Control */
7004 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7006 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7008 g
= GLYPH_CODE_CHAR (gc
);
7009 lface_id
= GLYPH_CODE_FACE (gc
);
7013 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7014 : merge_escape_glyph_face (it
));
7016 XSETINT (it
->ctl_chars
[0], g
);
7017 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7019 goto display_control
;
7022 /* Handle non-ascii space in the mode where it only gets
7025 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7027 /* Merge `nobreak-space' into the current face. */
7028 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7030 XSETINT (it
->ctl_chars
[0], ' ');
7032 goto display_control
;
7035 /* Handle sequences that start with the "escape glyph". */
7037 /* the default escape glyph is \. */
7038 escape_glyph
= '\\';
7041 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7043 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7044 lface_id
= GLYPH_CODE_FACE (gc
);
7048 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7049 : merge_escape_glyph_face (it
));
7051 /* Draw non-ASCII hyphen with just highlighting: */
7053 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7055 XSETINT (it
->ctl_chars
[0], '-');
7057 goto display_control
;
7060 /* Draw non-ASCII space/hyphen with escape glyph: */
7062 if (nonascii_space_p
|| nonascii_hyphen_p
)
7064 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7065 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7067 goto display_control
;
7074 if (CHAR_BYTE8_P (c
))
7075 /* Display \200 instead of \17777600. */
7076 c
= CHAR_TO_BYTE8 (c
);
7077 len
= sprintf (str
, "%03o", c
);
7079 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7080 for (i
= 0; i
< len
; i
++)
7081 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7086 /* Set up IT->dpvec and return first character from it. */
7087 it
->dpvec_char_len
= it
->len
;
7088 it
->dpvec
= it
->ctl_chars
;
7089 it
->dpend
= it
->dpvec
+ ctl_len
;
7090 it
->current
.dpvec_index
= 0;
7091 it
->dpvec_face_id
= face_id
;
7092 it
->saved_face_id
= it
->face_id
;
7093 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7097 it
->char_to_display
= c
;
7101 it
->char_to_display
= it
->c
;
7105 #ifdef HAVE_WINDOW_SYSTEM
7106 /* Adjust face id for a multibyte character. There are no multibyte
7107 character in unibyte text. */
7108 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7111 && FRAME_WINDOW_P (it
->f
))
7113 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7115 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7117 /* Automatic composition with glyph-string. */
7118 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7120 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7124 ptrdiff_t pos
= (it
->s
? -1
7125 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7126 : IT_CHARPOS (*it
));
7129 if (it
->what
== IT_CHARACTER
)
7130 c
= it
->char_to_display
;
7133 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7137 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7138 /* TAB in a composition means display glyphs with
7139 padding space on the left or right. */
7140 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7143 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7146 #endif /* HAVE_WINDOW_SYSTEM */
7149 /* Is this character the last one of a run of characters with
7150 box? If yes, set IT->end_of_box_run_p to 1. */
7154 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7156 int face_id
= underlying_face_id (it
);
7157 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7161 if (face
->box
== FACE_NO_BOX
)
7163 /* If the box comes from face properties in a
7164 display string, check faces in that string. */
7165 int string_face_id
= face_after_it_pos (it
);
7166 it
->end_of_box_run_p
7167 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7170 /* Otherwise, the box comes from the underlying face.
7171 If this is the last string character displayed, check
7172 the next buffer location. */
7173 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7174 /* n_overlay_strings is unreliable unless
7175 overlay_string_index is non-negative. */
7176 && ((it
->current
.overlay_string_index
>= 0
7177 && (it
->current
.overlay_string_index
7178 == it
->n_overlay_strings
- 1))
7179 /* A string from display property. */
7180 || it
->from_disp_prop_p
))
7184 struct text_pos pos
= it
->current
.pos
;
7186 /* For a string from a display property, the next
7187 buffer position is stored in the 'position'
7188 member of the iteration stack slot below the
7189 current one, see handle_single_display_spec. By
7190 contrast, it->current.pos was is not yet updated
7191 to point to that buffer position; that will
7192 happen in pop_it, after we finish displaying the
7193 current string. Note that we already checked
7194 above that it->sp is positive, so subtracting one
7196 if (it
->from_disp_prop_p
)
7197 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7199 INC_TEXT_POS (pos
, it
->multibyte_p
);
7201 if (CHARPOS (pos
) >= ZV
)
7202 it
->end_of_box_run_p
= true;
7205 next_face_id
= face_at_buffer_position
7206 (it
->w
, CHARPOS (pos
), &ignore
,
7207 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7208 it
->end_of_box_run_p
7209 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7215 /* next_element_from_display_vector sets this flag according to
7216 faces of the display vector glyphs, see there. */
7217 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7219 int face_id
= face_after_it_pos (it
);
7220 it
->end_of_box_run_p
7221 = (face_id
!= it
->face_id
7222 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7225 /* If we reached the end of the object we've been iterating (e.g., a
7226 display string or an overlay string), and there's something on
7227 IT->stack, proceed with what's on the stack. It doesn't make
7228 sense to return zero if there's unprocessed stuff on the stack,
7229 because otherwise that stuff will never be displayed. */
7230 if (!success_p
&& it
->sp
> 0)
7232 set_iterator_to_next (it
, 0);
7233 success_p
= get_next_display_element (it
);
7236 /* Value is 0 if end of buffer or string reached. */
7241 /* Move IT to the next display element.
7243 RESEAT_P non-zero means if called on a newline in buffer text,
7244 skip to the next visible line start.
7246 Functions get_next_display_element and set_iterator_to_next are
7247 separate because I find this arrangement easier to handle than a
7248 get_next_display_element function that also increments IT's
7249 position. The way it is we can first look at an iterator's current
7250 display element, decide whether it fits on a line, and if it does,
7251 increment the iterator position. The other way around we probably
7252 would either need a flag indicating whether the iterator has to be
7253 incremented the next time, or we would have to implement a
7254 decrement position function which would not be easy to write. */
7257 set_iterator_to_next (struct it
*it
, int reseat_p
)
7259 /* Reset flags indicating start and end of a sequence of characters
7260 with box. Reset them at the start of this function because
7261 moving the iterator to a new position might set them. */
7262 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7266 case GET_FROM_BUFFER
:
7267 /* The current display element of IT is a character from
7268 current_buffer. Advance in the buffer, and maybe skip over
7269 invisible lines that are so because of selective display. */
7270 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7271 reseat_at_next_visible_line_start (it
, 0);
7272 else if (it
->cmp_it
.id
>= 0)
7274 /* We are currently getting glyphs from a composition. */
7277 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7278 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7284 /* Update IT's char/byte positions to point to the first
7285 character of the next grapheme cluster, or to the
7286 character visually after the current composition. */
7287 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7288 bidi_move_to_visually_next (&it
->bidi_it
);
7289 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7290 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7293 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7294 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7296 /* Composition created while scanning forward. Proceed
7297 to the next grapheme cluster. */
7298 it
->cmp_it
.from
= it
->cmp_it
.to
;
7300 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7301 && it
->cmp_it
.from
> 0)
7303 /* Composition created while scanning backward. Proceed
7304 to the previous grapheme cluster. */
7305 it
->cmp_it
.to
= it
->cmp_it
.from
;
7309 /* No more grapheme clusters in this composition.
7310 Find the next stop position. */
7311 ptrdiff_t stop
= it
->end_charpos
;
7313 if (it
->bidi_it
.scan_dir
< 0)
7314 /* Now we are scanning backward and don't know
7317 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7318 IT_BYTEPOS (*it
), stop
, Qnil
);
7323 eassert (it
->len
!= 0);
7327 IT_BYTEPOS (*it
) += it
->len
;
7328 IT_CHARPOS (*it
) += 1;
7332 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7333 /* If this is a new paragraph, determine its base
7334 direction (a.k.a. its base embedding level). */
7335 if (it
->bidi_it
.new_paragraph
)
7336 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7337 bidi_move_to_visually_next (&it
->bidi_it
);
7338 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7339 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7340 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7342 /* As the scan direction was changed, we must
7343 re-compute the stop position for composition. */
7344 ptrdiff_t stop
= it
->end_charpos
;
7345 if (it
->bidi_it
.scan_dir
< 0)
7347 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7348 IT_BYTEPOS (*it
), stop
, Qnil
);
7351 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7355 case GET_FROM_C_STRING
:
7356 /* Current display element of IT is from a C string. */
7358 /* If the string position is beyond string's end, it means
7359 next_element_from_c_string is padding the string with
7360 blanks, in which case we bypass the bidi iterator,
7361 because it cannot deal with such virtual characters. */
7362 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7364 IT_BYTEPOS (*it
) += it
->len
;
7365 IT_CHARPOS (*it
) += 1;
7369 bidi_move_to_visually_next (&it
->bidi_it
);
7370 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7371 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7375 case GET_FROM_DISPLAY_VECTOR
:
7376 /* Current display element of IT is from a display table entry.
7377 Advance in the display table definition. Reset it to null if
7378 end reached, and continue with characters from buffers/
7380 ++it
->current
.dpvec_index
;
7382 /* Restore face of the iterator to what they were before the
7383 display vector entry (these entries may contain faces). */
7384 it
->face_id
= it
->saved_face_id
;
7386 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7388 int recheck_faces
= it
->ellipsis_p
;
7391 it
->method
= GET_FROM_C_STRING
;
7392 else if (STRINGP (it
->string
))
7393 it
->method
= GET_FROM_STRING
;
7396 it
->method
= GET_FROM_BUFFER
;
7397 it
->object
= it
->w
->contents
;
7401 it
->current
.dpvec_index
= -1;
7403 /* Skip over characters which were displayed via IT->dpvec. */
7404 if (it
->dpvec_char_len
< 0)
7405 reseat_at_next_visible_line_start (it
, 1);
7406 else if (it
->dpvec_char_len
> 0)
7408 if (it
->method
== GET_FROM_STRING
7409 && it
->current
.overlay_string_index
>= 0
7410 && it
->n_overlay_strings
> 0)
7411 it
->ignore_overlay_strings_at_pos_p
= true;
7412 it
->len
= it
->dpvec_char_len
;
7413 set_iterator_to_next (it
, reseat_p
);
7416 /* Maybe recheck faces after display vector. */
7418 it
->stop_charpos
= IT_CHARPOS (*it
);
7422 case GET_FROM_STRING
:
7423 /* Current display element is a character from a Lisp string. */
7424 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7425 /* Don't advance past string end. These conditions are true
7426 when set_iterator_to_next is called at the end of
7427 get_next_display_element, in which case the Lisp string is
7428 already exhausted, and all we want is pop the iterator
7430 if (it
->current
.overlay_string_index
>= 0)
7432 /* This is an overlay string, so there's no padding with
7433 spaces, and the number of characters in the string is
7434 where the string ends. */
7435 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7436 goto consider_string_end
;
7440 /* Not an overlay string. There could be padding, so test
7441 against it->end_charpos. */
7442 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7443 goto consider_string_end
;
7445 if (it
->cmp_it
.id
>= 0)
7447 /* We are delivering display elements from a composition.
7448 Update the string position past the grapheme cluster
7449 we've just processed. */
7452 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7453 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7459 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7460 bidi_move_to_visually_next (&it
->bidi_it
);
7461 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7462 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7465 /* Did we exhaust all the grapheme clusters of this
7467 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7468 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7470 /* Not all the grapheme clusters were processed yet;
7471 advance to the next cluster. */
7472 it
->cmp_it
.from
= it
->cmp_it
.to
;
7474 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7475 && it
->cmp_it
.from
> 0)
7477 /* Likewise: advance to the next cluster, but going in
7478 the reverse direction. */
7479 it
->cmp_it
.to
= it
->cmp_it
.from
;
7483 /* This composition was fully processed; find the next
7484 candidate place for checking for composed
7486 /* Always limit string searches to the string length;
7487 any padding spaces are not part of the string, and
7488 there cannot be any compositions in that padding. */
7489 ptrdiff_t stop
= SCHARS (it
->string
);
7491 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7493 else if (it
->end_charpos
< stop
)
7495 /* Cf. PRECISION in reseat_to_string: we might be
7496 limited in how many of the string characters we
7498 stop
= it
->end_charpos
;
7500 composition_compute_stop_pos (&it
->cmp_it
,
7501 IT_STRING_CHARPOS (*it
),
7502 IT_STRING_BYTEPOS (*it
), stop
,
7509 /* If the string position is beyond string's end, it
7510 means next_element_from_string is padding the string
7511 with blanks, in which case we bypass the bidi
7512 iterator, because it cannot deal with such virtual
7514 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7516 IT_STRING_BYTEPOS (*it
) += it
->len
;
7517 IT_STRING_CHARPOS (*it
) += 1;
7521 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7523 bidi_move_to_visually_next (&it
->bidi_it
);
7524 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7525 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7526 /* If the scan direction changes, we may need to update
7527 the place where to check for composed characters. */
7528 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7530 ptrdiff_t stop
= SCHARS (it
->string
);
7532 if (it
->bidi_it
.scan_dir
< 0)
7534 else if (it
->end_charpos
< stop
)
7535 stop
= it
->end_charpos
;
7537 composition_compute_stop_pos (&it
->cmp_it
,
7538 IT_STRING_CHARPOS (*it
),
7539 IT_STRING_BYTEPOS (*it
), stop
,
7545 consider_string_end
:
7547 if (it
->current
.overlay_string_index
>= 0)
7549 /* IT->string is an overlay string. Advance to the
7550 next, if there is one. */
7551 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7554 next_overlay_string (it
);
7556 setup_for_ellipsis (it
, 0);
7561 /* IT->string is not an overlay string. If we reached
7562 its end, and there is something on IT->stack, proceed
7563 with what is on the stack. This can be either another
7564 string, this time an overlay string, or a buffer. */
7565 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7569 if (it
->method
== GET_FROM_STRING
)
7570 goto consider_string_end
;
7575 case GET_FROM_IMAGE
:
7576 case GET_FROM_STRETCH
:
7577 #ifdef HAVE_XWIDGETS
7578 case GET_FROM_XWIDGET
:
7581 /* The position etc with which we have to proceed are on
7582 the stack. The position may be at the end of a string,
7583 if the `display' property takes up the whole string. */
7584 eassert (it
->sp
> 0);
7586 if (it
->method
== GET_FROM_STRING
)
7587 goto consider_string_end
;
7591 /* There are no other methods defined, so this should be a bug. */
7595 eassert (it
->method
!= GET_FROM_STRING
7596 || (STRINGP (it
->string
)
7597 && IT_STRING_CHARPOS (*it
) >= 0));
7600 /* Load IT's display element fields with information about the next
7601 display element which comes from a display table entry or from the
7602 result of translating a control character to one of the forms `^C'
7605 IT->dpvec holds the glyphs to return as characters.
7606 IT->saved_face_id holds the face id before the display vector--it
7607 is restored into IT->face_id in set_iterator_to_next. */
7610 next_element_from_display_vector (struct it
*it
)
7613 int prev_face_id
= it
->face_id
;
7617 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7619 it
->face_id
= it
->saved_face_id
;
7621 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7622 That seemed totally bogus - so I changed it... */
7623 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7625 if (GLYPH_CODE_P (gc
))
7627 struct face
*this_face
, *prev_face
, *next_face
;
7629 it
->c
= GLYPH_CODE_CHAR (gc
);
7630 it
->len
= CHAR_BYTES (it
->c
);
7632 /* The entry may contain a face id to use. Such a face id is
7633 the id of a Lisp face, not a realized face. A face id of
7634 zero means no face is specified. */
7635 if (it
->dpvec_face_id
>= 0)
7636 it
->face_id
= it
->dpvec_face_id
;
7639 int lface_id
= GLYPH_CODE_FACE (gc
);
7641 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7645 /* Glyphs in the display vector could have the box face, so we
7646 need to set the related flags in the iterator, as
7648 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7649 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7651 /* Is this character the first character of a box-face run? */
7652 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7654 || prev_face
->box
== FACE_NO_BOX
));
7656 /* For the last character of the box-face run, we need to look
7657 either at the next glyph from the display vector, or at the
7658 face we saw before the display vector. */
7659 next_face_id
= it
->saved_face_id
;
7660 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7662 if (it
->dpvec_face_id
>= 0)
7663 next_face_id
= it
->dpvec_face_id
;
7667 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7670 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7674 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7675 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7677 || next_face
->box
== FACE_NO_BOX
));
7678 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7681 /* Display table entry is invalid. Return a space. */
7682 it
->c
= ' ', it
->len
= 1;
7684 /* Don't change position and object of the iterator here. They are
7685 still the values of the character that had this display table
7686 entry or was translated, and that's what we want. */
7687 it
->what
= IT_CHARACTER
;
7691 /* Get the first element of string/buffer in the visual order, after
7692 being reseated to a new position in a string or a buffer. */
7694 get_visually_first_element (struct it
*it
)
7696 int string_p
= STRINGP (it
->string
) || it
->s
;
7697 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7698 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7700 if (STRINGP (it
->string
))
7702 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7703 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7707 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7708 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7711 if (it
->bidi_it
.charpos
== eob
)
7713 /* Nothing to do, but reset the FIRST_ELT flag, like
7714 bidi_paragraph_init does, because we are not going to
7716 it
->bidi_it
.first_elt
= 0;
7718 else if (it
->bidi_it
.charpos
== bob
7720 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7721 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7723 /* If we are at the beginning of a line/string, we can produce
7724 the next element right away. */
7725 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7726 bidi_move_to_visually_next (&it
->bidi_it
);
7730 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7732 /* We need to prime the bidi iterator starting at the line's or
7733 string's beginning, before we will be able to produce the
7736 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7738 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7739 IT_BYTEPOS (*it
), -1,
7740 &it
->bidi_it
.bytepos
);
7741 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7744 /* Now return to buffer/string position where we were asked
7745 to get the next display element, and produce that. */
7746 bidi_move_to_visually_next (&it
->bidi_it
);
7748 while (it
->bidi_it
.bytepos
!= orig_bytepos
7749 && it
->bidi_it
.charpos
< eob
);
7752 /* Adjust IT's position information to where we ended up. */
7753 if (STRINGP (it
->string
))
7755 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7756 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7760 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7761 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7764 if (STRINGP (it
->string
) || !it
->s
)
7766 ptrdiff_t stop
, charpos
, bytepos
;
7768 if (STRINGP (it
->string
))
7771 stop
= SCHARS (it
->string
);
7772 if (stop
> it
->end_charpos
)
7773 stop
= it
->end_charpos
;
7774 charpos
= IT_STRING_CHARPOS (*it
);
7775 bytepos
= IT_STRING_BYTEPOS (*it
);
7779 stop
= it
->end_charpos
;
7780 charpos
= IT_CHARPOS (*it
);
7781 bytepos
= IT_BYTEPOS (*it
);
7783 if (it
->bidi_it
.scan_dir
< 0)
7785 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7790 /* Load IT with the next display element from Lisp string IT->string.
7791 IT->current.string_pos is the current position within the string.
7792 If IT->current.overlay_string_index >= 0, the Lisp string is an
7796 next_element_from_string (struct it
*it
)
7798 struct text_pos position
;
7800 eassert (STRINGP (it
->string
));
7801 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7802 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7803 position
= it
->current
.string_pos
;
7805 /* With bidi reordering, the character to display might not be the
7806 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7807 that we were reseat()ed to a new string, whose paragraph
7808 direction is not known. */
7809 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7811 get_visually_first_element (it
);
7812 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7815 /* Time to check for invisible text? */
7816 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7818 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7821 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7822 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7824 /* With bidi non-linear iteration, we could find
7825 ourselves far beyond the last computed stop_charpos,
7826 with several other stop positions in between that we
7827 missed. Scan them all now, in buffer's logical
7828 order, until we find and handle the last stop_charpos
7829 that precedes our current position. */
7830 handle_stop_backwards (it
, it
->stop_charpos
);
7831 return GET_NEXT_DISPLAY_ELEMENT (it
);
7837 /* Take note of the stop position we just moved
7838 across, for when we will move back across it. */
7839 it
->prev_stop
= it
->stop_charpos
;
7840 /* If we are at base paragraph embedding level, take
7841 note of the last stop position seen at this
7843 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7844 it
->base_level_stop
= it
->stop_charpos
;
7848 /* Since a handler may have changed IT->method, we must
7850 return GET_NEXT_DISPLAY_ELEMENT (it
);
7854 /* If we are before prev_stop, we may have overstepped
7855 on our way backwards a stop_pos, and if so, we need
7856 to handle that stop_pos. */
7857 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7858 /* We can sometimes back up for reasons that have nothing
7859 to do with bidi reordering. E.g., compositions. The
7860 code below is only needed when we are above the base
7861 embedding level, so test for that explicitly. */
7862 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7864 /* If we lost track of base_level_stop, we have no better
7865 place for handle_stop_backwards to start from than string
7866 beginning. This happens, e.g., when we were reseated to
7867 the previous screenful of text by vertical-motion. */
7868 if (it
->base_level_stop
<= 0
7869 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7870 it
->base_level_stop
= 0;
7871 handle_stop_backwards (it
, it
->base_level_stop
);
7872 return GET_NEXT_DISPLAY_ELEMENT (it
);
7876 if (it
->current
.overlay_string_index
>= 0)
7878 /* Get the next character from an overlay string. In overlay
7879 strings, there is no field width or padding with spaces to
7881 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7886 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7887 IT_STRING_BYTEPOS (*it
),
7888 it
->bidi_it
.scan_dir
< 0
7890 : SCHARS (it
->string
))
7891 && next_element_from_composition (it
))
7895 else if (STRING_MULTIBYTE (it
->string
))
7897 const unsigned char *s
= (SDATA (it
->string
)
7898 + IT_STRING_BYTEPOS (*it
));
7899 it
->c
= string_char_and_length (s
, &it
->len
);
7903 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7909 /* Get the next character from a Lisp string that is not an
7910 overlay string. Such strings come from the mode line, for
7911 example. We may have to pad with spaces, or truncate the
7912 string. See also next_element_from_c_string. */
7913 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7918 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7920 /* Pad with spaces. */
7921 it
->c
= ' ', it
->len
= 1;
7922 CHARPOS (position
) = BYTEPOS (position
) = -1;
7924 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7925 IT_STRING_BYTEPOS (*it
),
7926 it
->bidi_it
.scan_dir
< 0
7928 : it
->string_nchars
)
7929 && next_element_from_composition (it
))
7933 else if (STRING_MULTIBYTE (it
->string
))
7935 const unsigned char *s
= (SDATA (it
->string
)
7936 + IT_STRING_BYTEPOS (*it
));
7937 it
->c
= string_char_and_length (s
, &it
->len
);
7941 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7946 /* Record what we have and where it came from. */
7947 it
->what
= IT_CHARACTER
;
7948 it
->object
= it
->string
;
7949 it
->position
= position
;
7954 /* Load IT with next display element from C string IT->s.
7955 IT->string_nchars is the maximum number of characters to return
7956 from the string. IT->end_charpos may be greater than
7957 IT->string_nchars when this function is called, in which case we
7958 may have to return padding spaces. Value is zero if end of string
7959 reached, including padding spaces. */
7962 next_element_from_c_string (struct it
*it
)
7964 bool success_p
= true;
7967 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7968 it
->what
= IT_CHARACTER
;
7969 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7970 it
->object
= make_number (0);
7972 /* With bidi reordering, the character to display might not be the
7973 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7974 we were reseated to a new string, whose paragraph direction is
7976 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7977 get_visually_first_element (it
);
7979 /* IT's position can be greater than IT->string_nchars in case a
7980 field width or precision has been specified when the iterator was
7982 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7984 /* End of the game. */
7988 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7990 /* Pad with spaces. */
7991 it
->c
= ' ', it
->len
= 1;
7992 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7994 else if (it
->multibyte_p
)
7995 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7997 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8003 /* Set up IT to return characters from an ellipsis, if appropriate.
8004 The definition of the ellipsis glyphs may come from a display table
8005 entry. This function fills IT with the first glyph from the
8006 ellipsis if an ellipsis is to be displayed. */
8009 next_element_from_ellipsis (struct it
*it
)
8011 if (it
->selective_display_ellipsis_p
)
8012 setup_for_ellipsis (it
, it
->len
);
8015 /* The face at the current position may be different from the
8016 face we find after the invisible text. Remember what it
8017 was in IT->saved_face_id, and signal that it's there by
8018 setting face_before_selective_p. */
8019 it
->saved_face_id
= it
->face_id
;
8020 it
->method
= GET_FROM_BUFFER
;
8021 it
->object
= it
->w
->contents
;
8022 reseat_at_next_visible_line_start (it
, 1);
8023 it
->face_before_selective_p
= true;
8026 return GET_NEXT_DISPLAY_ELEMENT (it
);
8030 /* Deliver an image display element. The iterator IT is already
8031 filled with image information (done in handle_display_prop). Value
8036 next_element_from_image (struct it
*it
)
8038 it
->what
= IT_IMAGE
;
8039 it
->ignore_overlay_strings_at_pos_p
= 0;
8043 #ifdef HAVE_XWIDGETS
8044 /* im not sure about this FIXME JAVE*/
8046 next_element_from_xwidget (struct it
*it
)
8048 it
->what
= IT_XWIDGET
;
8054 /* Fill iterator IT with next display element from a stretch glyph
8055 property. IT->object is the value of the text property. Value is
8059 next_element_from_stretch (struct it
*it
)
8061 it
->what
= IT_STRETCH
;
8065 /* Scan backwards from IT's current position until we find a stop
8066 position, or until BEGV. This is called when we find ourself
8067 before both the last known prev_stop and base_level_stop while
8068 reordering bidirectional text. */
8071 compute_stop_pos_backwards (struct it
*it
)
8073 const int SCAN_BACK_LIMIT
= 1000;
8074 struct text_pos pos
;
8075 struct display_pos save_current
= it
->current
;
8076 struct text_pos save_position
= it
->position
;
8077 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8078 ptrdiff_t where_we_are
= charpos
;
8079 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8080 ptrdiff_t save_end_pos
= it
->end_charpos
;
8082 eassert (NILP (it
->string
) && !it
->s
);
8083 eassert (it
->bidi_p
);
8087 it
->end_charpos
= min (charpos
+ 1, ZV
);
8088 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8089 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8090 reseat_1 (it
, pos
, 0);
8091 compute_stop_pos (it
);
8092 /* We must advance forward, right? */
8093 if (it
->stop_charpos
<= charpos
)
8096 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8098 if (it
->stop_charpos
<= where_we_are
)
8099 it
->prev_stop
= it
->stop_charpos
;
8101 it
->prev_stop
= BEGV
;
8103 it
->current
= save_current
;
8104 it
->position
= save_position
;
8105 it
->stop_charpos
= save_stop_pos
;
8106 it
->end_charpos
= save_end_pos
;
8109 /* Scan forward from CHARPOS in the current buffer/string, until we
8110 find a stop position > current IT's position. Then handle the stop
8111 position before that. This is called when we bump into a stop
8112 position while reordering bidirectional text. CHARPOS should be
8113 the last previously processed stop_pos (or BEGV/0, if none were
8114 processed yet) whose position is less that IT's current
8118 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8120 int bufp
= !STRINGP (it
->string
);
8121 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8122 struct display_pos save_current
= it
->current
;
8123 struct text_pos save_position
= it
->position
;
8124 struct text_pos pos1
;
8125 ptrdiff_t next_stop
;
8127 /* Scan in strict logical order. */
8128 eassert (it
->bidi_p
);
8132 it
->prev_stop
= charpos
;
8135 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8136 reseat_1 (it
, pos1
, 0);
8139 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8140 compute_stop_pos (it
);
8141 /* We must advance forward, right? */
8142 if (it
->stop_charpos
<= it
->prev_stop
)
8144 charpos
= it
->stop_charpos
;
8146 while (charpos
<= where_we_are
);
8149 it
->current
= save_current
;
8150 it
->position
= save_position
;
8151 next_stop
= it
->stop_charpos
;
8152 it
->stop_charpos
= it
->prev_stop
;
8154 it
->stop_charpos
= next_stop
;
8157 /* Load IT with the next display element from current_buffer. Value
8158 is zero if end of buffer reached. IT->stop_charpos is the next
8159 position at which to stop and check for text properties or buffer
8163 next_element_from_buffer (struct it
*it
)
8165 bool success_p
= true;
8167 eassert (IT_CHARPOS (*it
) >= BEGV
);
8168 eassert (NILP (it
->string
) && !it
->s
);
8169 eassert (!it
->bidi_p
8170 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8171 && it
->bidi_it
.string
.s
== NULL
));
8173 /* With bidi reordering, the character to display might not be the
8174 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8175 we were reseat()ed to a new buffer position, which is potentially
8176 a different paragraph. */
8177 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8179 get_visually_first_element (it
);
8180 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8183 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8185 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8187 int overlay_strings_follow_p
;
8189 /* End of the game, except when overlay strings follow that
8190 haven't been returned yet. */
8191 if (it
->overlay_strings_at_end_processed_p
)
8192 overlay_strings_follow_p
= 0;
8195 it
->overlay_strings_at_end_processed_p
= true;
8196 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8199 if (overlay_strings_follow_p
)
8200 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8204 it
->position
= it
->current
.pos
;
8208 else if (!(!it
->bidi_p
8209 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8210 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8212 /* With bidi non-linear iteration, we could find ourselves
8213 far beyond the last computed stop_charpos, with several
8214 other stop positions in between that we missed. Scan
8215 them all now, in buffer's logical order, until we find
8216 and handle the last stop_charpos that precedes our
8217 current position. */
8218 handle_stop_backwards (it
, it
->stop_charpos
);
8219 return GET_NEXT_DISPLAY_ELEMENT (it
);
8225 /* Take note of the stop position we just moved across,
8226 for when we will move back across it. */
8227 it
->prev_stop
= it
->stop_charpos
;
8228 /* If we are at base paragraph embedding level, take
8229 note of the last stop position seen at this
8231 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8232 it
->base_level_stop
= it
->stop_charpos
;
8235 return GET_NEXT_DISPLAY_ELEMENT (it
);
8239 /* If we are before prev_stop, we may have overstepped on
8240 our way backwards a stop_pos, and if so, we need to
8241 handle that stop_pos. */
8242 && IT_CHARPOS (*it
) < it
->prev_stop
8243 /* We can sometimes back up for reasons that have nothing
8244 to do with bidi reordering. E.g., compositions. The
8245 code below is only needed when we are above the base
8246 embedding level, so test for that explicitly. */
8247 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8249 if (it
->base_level_stop
<= 0
8250 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8252 /* If we lost track of base_level_stop, we need to find
8253 prev_stop by looking backwards. This happens, e.g., when
8254 we were reseated to the previous screenful of text by
8256 it
->base_level_stop
= BEGV
;
8257 compute_stop_pos_backwards (it
);
8258 handle_stop_backwards (it
, it
->prev_stop
);
8261 handle_stop_backwards (it
, it
->base_level_stop
);
8262 return GET_NEXT_DISPLAY_ELEMENT (it
);
8266 /* No face changes, overlays etc. in sight, so just return a
8267 character from current_buffer. */
8271 /* We moved to the next buffer position, so any info about
8272 previously seen overlays is no longer valid. */
8273 it
->ignore_overlay_strings_at_pos_p
= 0;
8275 /* Maybe run the redisplay end trigger hook. Performance note:
8276 This doesn't seem to cost measurable time. */
8277 if (it
->redisplay_end_trigger_charpos
8279 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8280 run_redisplay_end_trigger_hook (it
);
8282 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8283 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8285 && next_element_from_composition (it
))
8290 /* Get the next character, maybe multibyte. */
8291 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8292 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8293 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8295 it
->c
= *p
, it
->len
= 1;
8297 /* Record what we have and where it came from. */
8298 it
->what
= IT_CHARACTER
;
8299 it
->object
= it
->w
->contents
;
8300 it
->position
= it
->current
.pos
;
8302 /* Normally we return the character found above, except when we
8303 really want to return an ellipsis for selective display. */
8308 /* A value of selective > 0 means hide lines indented more
8309 than that number of columns. */
8310 if (it
->selective
> 0
8311 && IT_CHARPOS (*it
) + 1 < ZV
8312 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8313 IT_BYTEPOS (*it
) + 1,
8316 success_p
= next_element_from_ellipsis (it
);
8317 it
->dpvec_char_len
= -1;
8320 else if (it
->c
== '\r' && it
->selective
== -1)
8322 /* A value of selective == -1 means that everything from the
8323 CR to the end of the line is invisible, with maybe an
8324 ellipsis displayed for it. */
8325 success_p
= next_element_from_ellipsis (it
);
8326 it
->dpvec_char_len
= -1;
8331 /* Value is zero if end of buffer reached. */
8332 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8337 /* Run the redisplay end trigger hook for IT. */
8340 run_redisplay_end_trigger_hook (struct it
*it
)
8342 /* IT->glyph_row should be non-null, i.e. we should be actually
8343 displaying something, or otherwise we should not run the hook. */
8344 eassert (it
->glyph_row
);
8346 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8347 it
->redisplay_end_trigger_charpos
= 0;
8349 /* Since we are *trying* to run these functions, don't try to run
8350 them again, even if they get an error. */
8351 wset_redisplay_end_trigger (it
->w
, Qnil
);
8352 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8353 make_number (charpos
));
8355 /* Notice if it changed the face of the character we are on. */
8356 handle_face_prop (it
);
8360 /* Deliver a composition display element. Unlike the other
8361 next_element_from_XXX, this function is not registered in the array
8362 get_next_element[]. It is called from next_element_from_buffer and
8363 next_element_from_string when necessary. */
8366 next_element_from_composition (struct it
*it
)
8368 it
->what
= IT_COMPOSITION
;
8369 it
->len
= it
->cmp_it
.nbytes
;
8370 if (STRINGP (it
->string
))
8374 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8375 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8378 it
->position
= it
->current
.string_pos
;
8379 it
->object
= it
->string
;
8380 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8381 IT_STRING_BYTEPOS (*it
), it
->string
);
8387 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8388 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8391 if (it
->bidi_it
.new_paragraph
)
8392 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8393 /* Resync the bidi iterator with IT's new position.
8394 FIXME: this doesn't support bidirectional text. */
8395 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8396 bidi_move_to_visually_next (&it
->bidi_it
);
8400 it
->position
= it
->current
.pos
;
8401 it
->object
= it
->w
->contents
;
8402 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8403 IT_BYTEPOS (*it
), Qnil
);
8410 /***********************************************************************
8411 Moving an iterator without producing glyphs
8412 ***********************************************************************/
8414 /* Check if iterator is at a position corresponding to a valid buffer
8415 position after some move_it_ call. */
8417 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8418 ((it)->method == GET_FROM_STRING \
8419 ? IT_STRING_CHARPOS (*it) == 0 \
8423 /* Move iterator IT to a specified buffer or X position within one
8424 line on the display without producing glyphs.
8426 OP should be a bit mask including some or all of these bits:
8427 MOVE_TO_X: Stop upon reaching x-position TO_X.
8428 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8429 Regardless of OP's value, stop upon reaching the end of the display line.
8431 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8432 This means, in particular, that TO_X includes window's horizontal
8435 The return value has several possible values that
8436 say what condition caused the scan to stop:
8438 MOVE_POS_MATCH_OR_ZV
8439 - when TO_POS or ZV was reached.
8442 -when TO_X was reached before TO_POS or ZV were reached.
8445 - when we reached the end of the display area and the line must
8449 - when we reached the end of the display area and the line is
8453 - when we stopped at a line end, i.e. a newline or a CR and selective
8456 static enum move_it_result
8457 move_it_in_display_line_to (struct it
*it
,
8458 ptrdiff_t to_charpos
, int to_x
,
8459 enum move_operation_enum op
)
8461 enum move_it_result result
= MOVE_UNDEFINED
;
8462 struct glyph_row
*saved_glyph_row
;
8463 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8464 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8465 void *ppos_data
= NULL
;
8467 enum it_method prev_method
= it
->method
;
8468 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8469 int saw_smaller_pos
= prev_pos
< to_charpos
;
8471 /* Don't produce glyphs in produce_glyphs. */
8472 saved_glyph_row
= it
->glyph_row
;
8473 it
->glyph_row
= NULL
;
8475 /* Use wrap_it to save a copy of IT wherever a word wrap could
8476 occur. Use atpos_it to save a copy of IT at the desired buffer
8477 position, if found, so that we can scan ahead and check if the
8478 word later overshoots the window edge. Use atx_it similarly, for
8484 /* Use ppos_it under bidi reordering to save a copy of IT for the
8485 initial position. We restore that position in IT when we have
8486 scanned the entire display line without finding a match for
8487 TO_CHARPOS and all the character positions are greater than
8488 TO_CHARPOS. We then restart the scan from the initial position,
8489 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8490 the closest to TO_CHARPOS. */
8493 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8495 SAVE_IT (ppos_it
, *it
, ppos_data
);
8496 closest_pos
= IT_CHARPOS (*it
);
8502 #define BUFFER_POS_REACHED_P() \
8503 ((op & MOVE_TO_POS) != 0 \
8504 && BUFFERP (it->object) \
8505 && (IT_CHARPOS (*it) == to_charpos \
8507 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8508 && IT_CHARPOS (*it) > to_charpos) \
8509 || (it->what == IT_COMPOSITION \
8510 && ((IT_CHARPOS (*it) > to_charpos \
8511 && to_charpos >= it->cmp_it.charpos) \
8512 || (IT_CHARPOS (*it) < to_charpos \
8513 && to_charpos <= it->cmp_it.charpos)))) \
8514 && (it->method == GET_FROM_BUFFER \
8515 || (it->method == GET_FROM_DISPLAY_VECTOR \
8516 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8518 /* If there's a line-/wrap-prefix, handle it. */
8519 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8520 && it
->current_y
< it
->last_visible_y
)
8521 handle_line_prefix (it
);
8523 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8524 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8528 int x
, i
, ascent
= 0, descent
= 0;
8530 /* Utility macro to reset an iterator with x, ascent, and descent. */
8531 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8532 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8533 (IT)->max_descent = descent)
8535 /* Stop if we move beyond TO_CHARPOS (after an image or a
8536 display string or stretch glyph). */
8537 if ((op
& MOVE_TO_POS
) != 0
8538 && BUFFERP (it
->object
)
8539 && it
->method
== GET_FROM_BUFFER
8541 /* When the iterator is at base embedding level, we
8542 are guaranteed that characters are delivered for
8543 display in strictly increasing order of their
8544 buffer positions. */
8545 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8546 && IT_CHARPOS (*it
) > to_charpos
)
8548 && (prev_method
== GET_FROM_IMAGE
8549 || prev_method
== GET_FROM_STRETCH
8550 || prev_method
== GET_FROM_STRING
)
8551 /* Passed TO_CHARPOS from left to right. */
8552 && ((prev_pos
< to_charpos
8553 && IT_CHARPOS (*it
) > to_charpos
)
8554 /* Passed TO_CHARPOS from right to left. */
8555 || (prev_pos
> to_charpos
8556 && IT_CHARPOS (*it
) < to_charpos
)))))
8558 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8560 result
= MOVE_POS_MATCH_OR_ZV
;
8563 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8564 /* If wrap_it is valid, the current position might be in a
8565 word that is wrapped. So, save the iterator in
8566 atpos_it and continue to see if wrapping happens. */
8567 SAVE_IT (atpos_it
, *it
, atpos_data
);
8570 /* Stop when ZV reached.
8571 We used to stop here when TO_CHARPOS reached as well, but that is
8572 too soon if this glyph does not fit on this line. So we handle it
8573 explicitly below. */
8574 if (!get_next_display_element (it
))
8576 result
= MOVE_POS_MATCH_OR_ZV
;
8580 if (it
->line_wrap
== TRUNCATE
)
8582 if (BUFFER_POS_REACHED_P ())
8584 result
= MOVE_POS_MATCH_OR_ZV
;
8590 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8592 if (IT_DISPLAYING_WHITESPACE (it
))
8596 /* We have reached a glyph that follows one or more
8597 whitespace characters. If the position is
8598 already found, we are done. */
8599 if (atpos_it
.sp
>= 0)
8601 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8602 result
= MOVE_POS_MATCH_OR_ZV
;
8607 RESTORE_IT (it
, &atx_it
, atx_data
);
8608 result
= MOVE_X_REACHED
;
8611 /* Otherwise, we can wrap here. */
8612 SAVE_IT (wrap_it
, *it
, wrap_data
);
8618 /* Remember the line height for the current line, in case
8619 the next element doesn't fit on the line. */
8620 ascent
= it
->max_ascent
;
8621 descent
= it
->max_descent
;
8623 /* The call to produce_glyphs will get the metrics of the
8624 display element IT is loaded with. Record the x-position
8625 before this display element, in case it doesn't fit on the
8629 PRODUCE_GLYPHS (it
);
8631 if (it
->area
!= TEXT_AREA
)
8633 prev_method
= it
->method
;
8634 if (it
->method
== GET_FROM_BUFFER
)
8635 prev_pos
= IT_CHARPOS (*it
);
8636 set_iterator_to_next (it
, 1);
8637 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8638 SET_TEXT_POS (this_line_min_pos
,
8639 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8641 && (op
& MOVE_TO_POS
)
8642 && IT_CHARPOS (*it
) > to_charpos
8643 && IT_CHARPOS (*it
) < closest_pos
)
8644 closest_pos
= IT_CHARPOS (*it
);
8648 /* The number of glyphs we get back in IT->nglyphs will normally
8649 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8650 character on a terminal frame, or (iii) a line end. For the
8651 second case, IT->nglyphs - 1 padding glyphs will be present.
8652 (On X frames, there is only one glyph produced for a
8653 composite character.)
8655 The behavior implemented below means, for continuation lines,
8656 that as many spaces of a TAB as fit on the current line are
8657 displayed there. For terminal frames, as many glyphs of a
8658 multi-glyph character are displayed in the current line, too.
8659 This is what the old redisplay code did, and we keep it that
8660 way. Under X, the whole shape of a complex character must
8661 fit on the line or it will be completely displayed in the
8664 Note that both for tabs and padding glyphs, all glyphs have
8668 /* More than one glyph or glyph doesn't fit on line. All
8669 glyphs have the same width. */
8670 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8672 int x_before_this_char
= x
;
8673 int hpos_before_this_char
= it
->hpos
;
8675 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8677 new_x
= x
+ single_glyph_width
;
8679 /* We want to leave anything reaching TO_X to the caller. */
8680 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8682 if (BUFFER_POS_REACHED_P ())
8684 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8685 goto buffer_pos_reached
;
8686 if (atpos_it
.sp
< 0)
8688 SAVE_IT (atpos_it
, *it
, atpos_data
);
8689 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8694 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8697 result
= MOVE_X_REACHED
;
8702 SAVE_IT (atx_it
, *it
, atx_data
);
8703 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8708 if (/* Lines are continued. */
8709 it
->line_wrap
!= TRUNCATE
8710 && (/* And glyph doesn't fit on the line. */
8711 new_x
> it
->last_visible_x
8712 /* Or it fits exactly and we're on a window
8714 || (new_x
== it
->last_visible_x
8715 && FRAME_WINDOW_P (it
->f
)
8716 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8717 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8718 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8720 if (/* IT->hpos == 0 means the very first glyph
8721 doesn't fit on the line, e.g. a wide image. */
8723 || (new_x
== it
->last_visible_x
8724 && FRAME_WINDOW_P (it
->f
)))
8727 it
->current_x
= new_x
;
8729 /* The character's last glyph just barely fits
8731 if (i
== it
->nglyphs
- 1)
8733 /* If this is the destination position,
8734 return a position *before* it in this row,
8735 now that we know it fits in this row. */
8736 if (BUFFER_POS_REACHED_P ())
8738 if (it
->line_wrap
!= WORD_WRAP
8741 it
->hpos
= hpos_before_this_char
;
8742 it
->current_x
= x_before_this_char
;
8743 result
= MOVE_POS_MATCH_OR_ZV
;
8746 if (it
->line_wrap
== WORD_WRAP
8749 SAVE_IT (atpos_it
, *it
, atpos_data
);
8750 atpos_it
.current_x
= x_before_this_char
;
8751 atpos_it
.hpos
= hpos_before_this_char
;
8755 prev_method
= it
->method
;
8756 if (it
->method
== GET_FROM_BUFFER
)
8757 prev_pos
= IT_CHARPOS (*it
);
8758 set_iterator_to_next (it
, 1);
8759 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8760 SET_TEXT_POS (this_line_min_pos
,
8761 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8762 /* On graphical terminals, newlines may
8763 "overflow" into the fringe if
8764 overflow-newline-into-fringe is non-nil.
8765 On text terminals, and on graphical
8766 terminals with no right margin, newlines
8767 may overflow into the last glyph on the
8769 if (!FRAME_WINDOW_P (it
->f
)
8771 && it
->bidi_it
.paragraph_dir
== R2L
)
8772 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8773 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8774 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8776 if (!get_next_display_element (it
))
8778 result
= MOVE_POS_MATCH_OR_ZV
;
8781 if (BUFFER_POS_REACHED_P ())
8783 if (ITERATOR_AT_END_OF_LINE_P (it
))
8784 result
= MOVE_POS_MATCH_OR_ZV
;
8786 result
= MOVE_LINE_CONTINUED
;
8789 if (ITERATOR_AT_END_OF_LINE_P (it
)
8790 && (it
->line_wrap
!= WORD_WRAP
8792 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8794 result
= MOVE_NEWLINE_OR_CR
;
8801 IT_RESET_X_ASCENT_DESCENT (it
);
8803 if (wrap_it
.sp
>= 0)
8805 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8810 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8812 result
= MOVE_LINE_CONTINUED
;
8816 if (BUFFER_POS_REACHED_P ())
8818 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8819 goto buffer_pos_reached
;
8820 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8822 SAVE_IT (atpos_it
, *it
, atpos_data
);
8823 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8827 if (new_x
> it
->first_visible_x
)
8829 /* Glyph is visible. Increment number of glyphs that
8830 would be displayed. */
8835 if (result
!= MOVE_UNDEFINED
)
8838 else if (BUFFER_POS_REACHED_P ())
8841 IT_RESET_X_ASCENT_DESCENT (it
);
8842 result
= MOVE_POS_MATCH_OR_ZV
;
8845 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8847 /* Stop when TO_X specified and reached. This check is
8848 necessary here because of lines consisting of a line end,
8849 only. The line end will not produce any glyphs and we
8850 would never get MOVE_X_REACHED. */
8851 eassert (it
->nglyphs
== 0);
8852 result
= MOVE_X_REACHED
;
8856 /* Is this a line end? If yes, we're done. */
8857 if (ITERATOR_AT_END_OF_LINE_P (it
))
8859 /* If we are past TO_CHARPOS, but never saw any character
8860 positions smaller than TO_CHARPOS, return
8861 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8863 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8865 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8867 if (closest_pos
< ZV
)
8869 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8870 /* Don't recurse if closest_pos is equal to
8871 to_charpos, since we have just tried that. */
8872 if (closest_pos
!= to_charpos
)
8873 move_it_in_display_line_to (it
, closest_pos
, -1,
8875 result
= MOVE_POS_MATCH_OR_ZV
;
8878 goto buffer_pos_reached
;
8880 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8881 && IT_CHARPOS (*it
) > to_charpos
)
8882 goto buffer_pos_reached
;
8884 result
= MOVE_NEWLINE_OR_CR
;
8887 result
= MOVE_NEWLINE_OR_CR
;
8891 prev_method
= it
->method
;
8892 if (it
->method
== GET_FROM_BUFFER
)
8893 prev_pos
= IT_CHARPOS (*it
);
8894 /* The current display element has been consumed. Advance
8896 set_iterator_to_next (it
, 1);
8897 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8898 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8899 if (IT_CHARPOS (*it
) < to_charpos
)
8900 saw_smaller_pos
= 1;
8902 && (op
& MOVE_TO_POS
)
8903 && IT_CHARPOS (*it
) >= to_charpos
8904 && IT_CHARPOS (*it
) < closest_pos
)
8905 closest_pos
= IT_CHARPOS (*it
);
8907 /* Stop if lines are truncated and IT's current x-position is
8908 past the right edge of the window now. */
8909 if (it
->line_wrap
== TRUNCATE
8910 && it
->current_x
>= it
->last_visible_x
)
8912 if (!FRAME_WINDOW_P (it
->f
)
8913 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8914 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8915 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8916 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8920 if ((at_eob_p
= !get_next_display_element (it
))
8921 || BUFFER_POS_REACHED_P ()
8922 /* If we are past TO_CHARPOS, but never saw any
8923 character positions smaller than TO_CHARPOS,
8924 return MOVE_POS_MATCH_OR_ZV, like the
8925 unidirectional display did. */
8926 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8928 && IT_CHARPOS (*it
) > to_charpos
))
8931 && !BUFFER_POS_REACHED_P ()
8932 && !at_eob_p
&& closest_pos
< ZV
)
8934 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8935 if (closest_pos
!= to_charpos
)
8936 move_it_in_display_line_to (it
, closest_pos
, -1,
8939 result
= MOVE_POS_MATCH_OR_ZV
;
8942 if (ITERATOR_AT_END_OF_LINE_P (it
))
8944 result
= MOVE_NEWLINE_OR_CR
;
8948 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8950 && IT_CHARPOS (*it
) > to_charpos
)
8952 if (closest_pos
< ZV
)
8954 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8955 if (closest_pos
!= to_charpos
)
8956 move_it_in_display_line_to (it
, closest_pos
, -1,
8959 result
= MOVE_POS_MATCH_OR_ZV
;
8962 result
= MOVE_LINE_TRUNCATED
;
8965 #undef IT_RESET_X_ASCENT_DESCENT
8968 #undef BUFFER_POS_REACHED_P
8970 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8971 restore the saved iterator. */
8972 if (atpos_it
.sp
>= 0)
8973 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8974 else if (atx_it
.sp
>= 0)
8975 RESTORE_IT (it
, &atx_it
, atx_data
);
8980 bidi_unshelve_cache (atpos_data
, 1);
8982 bidi_unshelve_cache (atx_data
, 1);
8984 bidi_unshelve_cache (wrap_data
, 1);
8986 bidi_unshelve_cache (ppos_data
, 1);
8988 /* Restore the iterator settings altered at the beginning of this
8990 it
->glyph_row
= saved_glyph_row
;
8994 /* For external use. */
8996 move_it_in_display_line (struct it
*it
,
8997 ptrdiff_t to_charpos
, int to_x
,
8998 enum move_operation_enum op
)
9000 if (it
->line_wrap
== WORD_WRAP
9001 && (op
& MOVE_TO_X
))
9004 void *save_data
= NULL
;
9007 SAVE_IT (save_it
, *it
, save_data
);
9008 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9009 /* When word-wrap is on, TO_X may lie past the end
9010 of a wrapped line. Then it->current is the
9011 character on the next line, so backtrack to the
9012 space before the wrap point. */
9013 if (skip
== MOVE_LINE_CONTINUED
)
9015 int prev_x
= max (it
->current_x
- 1, 0);
9016 RESTORE_IT (it
, &save_it
, save_data
);
9017 move_it_in_display_line_to
9018 (it
, -1, prev_x
, MOVE_TO_X
);
9021 bidi_unshelve_cache (save_data
, 1);
9024 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9028 /* Move IT forward until it satisfies one or more of the criteria in
9029 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9031 OP is a bit-mask that specifies where to stop, and in particular,
9032 which of those four position arguments makes a difference. See the
9033 description of enum move_operation_enum.
9035 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9036 screen line, this function will set IT to the next position that is
9037 displayed to the right of TO_CHARPOS on the screen.
9039 Return the maximum pixel length of any line scanned but never more
9040 than it.last_visible_x. */
9043 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9045 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9046 int line_height
, line_start_x
= 0, reached
= 0;
9047 int max_current_x
= 0;
9048 void *backup_data
= NULL
;
9052 if (op
& MOVE_TO_VPOS
)
9054 /* If no TO_CHARPOS and no TO_X specified, stop at the
9055 start of the line TO_VPOS. */
9056 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9058 if (it
->vpos
== to_vpos
)
9064 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9068 /* TO_VPOS >= 0 means stop at TO_X in the line at
9069 TO_VPOS, or at TO_POS, whichever comes first. */
9070 if (it
->vpos
== to_vpos
)
9076 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9078 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9083 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9085 /* We have reached TO_X but not in the line we want. */
9086 skip
= move_it_in_display_line_to (it
, to_charpos
,
9088 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9096 else if (op
& MOVE_TO_Y
)
9098 struct it it_backup
;
9100 if (it
->line_wrap
== WORD_WRAP
)
9101 SAVE_IT (it_backup
, *it
, backup_data
);
9103 /* TO_Y specified means stop at TO_X in the line containing
9104 TO_Y---or at TO_CHARPOS if this is reached first. The
9105 problem is that we can't really tell whether the line
9106 contains TO_Y before we have completely scanned it, and
9107 this may skip past TO_X. What we do is to first scan to
9110 If TO_X is not specified, use a TO_X of zero. The reason
9111 is to make the outcome of this function more predictable.
9112 If we didn't use TO_X == 0, we would stop at the end of
9113 the line which is probably not what a caller would expect
9115 skip
= move_it_in_display_line_to
9116 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9117 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9119 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9120 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9122 else if (skip
== MOVE_X_REACHED
)
9124 /* If TO_X was reached, we want to know whether TO_Y is
9125 in the line. We know this is the case if the already
9126 scanned glyphs make the line tall enough. Otherwise,
9127 we must check by scanning the rest of the line. */
9128 line_height
= it
->max_ascent
+ it
->max_descent
;
9129 if (to_y
>= it
->current_y
9130 && to_y
< it
->current_y
+ line_height
)
9135 SAVE_IT (it_backup
, *it
, backup_data
);
9136 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9137 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9139 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9140 line_height
= it
->max_ascent
+ it
->max_descent
;
9141 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9143 if (to_y
>= it
->current_y
9144 && to_y
< it
->current_y
+ line_height
)
9146 /* If TO_Y is in this line and TO_X was reached
9147 above, we scanned too far. We have to restore
9148 IT's settings to the ones before skipping. But
9149 keep the more accurate values of max_ascent and
9150 max_descent we've found while skipping the rest
9151 of the line, for the sake of callers, such as
9152 pos_visible_p, that need to know the line
9154 int max_ascent
= it
->max_ascent
;
9155 int max_descent
= it
->max_descent
;
9157 RESTORE_IT (it
, &it_backup
, backup_data
);
9158 it
->max_ascent
= max_ascent
;
9159 it
->max_descent
= max_descent
;
9165 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9171 /* Check whether TO_Y is in this line. */
9172 line_height
= it
->max_ascent
+ it
->max_descent
;
9173 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9175 if (to_y
>= it
->current_y
9176 && to_y
< it
->current_y
+ line_height
)
9178 if (to_y
> it
->current_y
)
9179 max_current_x
= max (it
->current_x
, max_current_x
);
9181 /* When word-wrap is on, TO_X may lie past the end
9182 of a wrapped line. Then it->current is the
9183 character on the next line, so backtrack to the
9184 space before the wrap point. */
9185 if (skip
== MOVE_LINE_CONTINUED
9186 && it
->line_wrap
== WORD_WRAP
)
9188 int prev_x
= max (it
->current_x
- 1, 0);
9189 RESTORE_IT (it
, &it_backup
, backup_data
);
9190 skip
= move_it_in_display_line_to
9191 (it
, -1, prev_x
, MOVE_TO_X
);
9200 max_current_x
= max (it
->current_x
, max_current_x
);
9204 else if (BUFFERP (it
->object
)
9205 && (it
->method
== GET_FROM_BUFFER
9206 || it
->method
== GET_FROM_STRETCH
)
9207 && IT_CHARPOS (*it
) >= to_charpos
9208 /* Under bidi iteration, a call to set_iterator_to_next
9209 can scan far beyond to_charpos if the initial
9210 portion of the next line needs to be reordered. In
9211 that case, give move_it_in_display_line_to another
9214 && it
->bidi_it
.scan_dir
== -1))
9215 skip
= MOVE_POS_MATCH_OR_ZV
;
9217 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9221 case MOVE_POS_MATCH_OR_ZV
:
9222 max_current_x
= max (it
->current_x
, max_current_x
);
9226 case MOVE_NEWLINE_OR_CR
:
9227 max_current_x
= max (it
->current_x
, max_current_x
);
9228 set_iterator_to_next (it
, 1);
9229 it
->continuation_lines_width
= 0;
9232 case MOVE_LINE_TRUNCATED
:
9233 max_current_x
= it
->last_visible_x
;
9234 it
->continuation_lines_width
= 0;
9235 reseat_at_next_visible_line_start (it
, 0);
9236 if ((op
& MOVE_TO_POS
) != 0
9237 && IT_CHARPOS (*it
) > to_charpos
)
9244 case MOVE_LINE_CONTINUED
:
9245 max_current_x
= it
->last_visible_x
;
9246 /* For continued lines ending in a tab, some of the glyphs
9247 associated with the tab are displayed on the current
9248 line. Since it->current_x does not include these glyphs,
9249 we use it->last_visible_x instead. */
9252 it
->continuation_lines_width
+= it
->last_visible_x
;
9253 /* When moving by vpos, ensure that the iterator really
9254 advances to the next line (bug#847, bug#969). Fixme:
9255 do we need to do this in other circumstances? */
9256 if (it
->current_x
!= it
->last_visible_x
9257 && (op
& MOVE_TO_VPOS
)
9258 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9260 line_start_x
= it
->current_x
+ it
->pixel_width
9261 - it
->last_visible_x
;
9262 if (FRAME_WINDOW_P (it
->f
))
9264 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9265 struct font
*face_font
= face
->font
;
9267 /* When display_line produces a continued line
9268 that ends in a TAB, it skips a tab stop that
9269 is closer than the font's space character
9270 width (see x_produce_glyphs where it produces
9271 the stretch glyph which represents a TAB).
9272 We need to reproduce the same logic here. */
9273 eassert (face_font
);
9276 if (line_start_x
< face_font
->space_width
)
9278 += it
->tab_width
* face_font
->space_width
;
9281 set_iterator_to_next (it
, 0);
9285 it
->continuation_lines_width
+= it
->current_x
;
9292 /* Reset/increment for the next run. */
9293 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9294 it
->current_x
= line_start_x
;
9297 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9299 last_height
= it
->max_ascent
+ it
->max_descent
;
9300 it
->max_ascent
= it
->max_descent
= 0;
9305 /* On text terminals, we may stop at the end of a line in the middle
9306 of a multi-character glyph. If the glyph itself is continued,
9307 i.e. it is actually displayed on the next line, don't treat this
9308 stopping point as valid; move to the next line instead (unless
9309 that brings us offscreen). */
9310 if (!FRAME_WINDOW_P (it
->f
)
9312 && IT_CHARPOS (*it
) == to_charpos
9313 && it
->what
== IT_CHARACTER
9315 && it
->line_wrap
== WINDOW_WRAP
9316 && it
->current_x
== it
->last_visible_x
- 1
9319 && it
->w
->window_end_valid
9320 && it
->vpos
< it
->w
->window_end_vpos
)
9322 it
->continuation_lines_width
+= it
->current_x
;
9323 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9324 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9326 last_height
= it
->max_ascent
+ it
->max_descent
;
9330 bidi_unshelve_cache (backup_data
, 1);
9332 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9334 return max_current_x
;
9338 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9340 If DY > 0, move IT backward at least that many pixels. DY = 0
9341 means move IT backward to the preceding line start or BEGV. This
9342 function may move over more than DY pixels if IT->current_y - DY
9343 ends up in the middle of a line; in this case IT->current_y will be
9344 set to the top of the line moved to. */
9347 move_it_vertically_backward (struct it
*it
, int dy
)
9351 void *it2data
= NULL
, *it3data
= NULL
;
9352 ptrdiff_t start_pos
;
9354 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9355 ptrdiff_t pos_limit
;
9360 start_pos
= IT_CHARPOS (*it
);
9362 /* Estimate how many newlines we must move back. */
9363 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9364 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9367 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9369 /* Set the iterator's position that many lines back. But don't go
9370 back more than NLINES full screen lines -- this wins a day with
9371 buffers which have very long lines. */
9372 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9373 back_to_previous_visible_line_start (it
);
9375 /* Reseat the iterator here. When moving backward, we don't want
9376 reseat to skip forward over invisible text, set up the iterator
9377 to deliver from overlay strings at the new position etc. So,
9378 use reseat_1 here. */
9379 reseat_1 (it
, it
->current
.pos
, 1);
9381 /* We are now surely at a line start. */
9382 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9383 reordering is in effect. */
9384 it
->continuation_lines_width
= 0;
9386 /* Move forward and see what y-distance we moved. First move to the
9387 start of the next line so that we get its height. We need this
9388 height to be able to tell whether we reached the specified
9390 SAVE_IT (it2
, *it
, it2data
);
9391 it2
.max_ascent
= it2
.max_descent
= 0;
9394 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9395 MOVE_TO_POS
| MOVE_TO_VPOS
);
9397 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9398 /* If we are in a display string which starts at START_POS,
9399 and that display string includes a newline, and we are
9400 right after that newline (i.e. at the beginning of a
9401 display line), exit the loop, because otherwise we will
9402 infloop, since move_it_to will see that it is already at
9403 START_POS and will not move. */
9404 || (it2
.method
== GET_FROM_STRING
9405 && IT_CHARPOS (it2
) == start_pos
9406 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9407 eassert (IT_CHARPOS (*it
) >= BEGV
);
9408 SAVE_IT (it3
, it2
, it3data
);
9410 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9411 eassert (IT_CHARPOS (*it
) >= BEGV
);
9412 /* H is the actual vertical distance from the position in *IT
9413 and the starting position. */
9414 h
= it2
.current_y
- it
->current_y
;
9415 /* NLINES is the distance in number of lines. */
9416 nlines
= it2
.vpos
- it
->vpos
;
9418 /* Correct IT's y and vpos position
9419 so that they are relative to the starting point. */
9425 /* DY == 0 means move to the start of the screen line. The
9426 value of nlines is > 0 if continuation lines were involved,
9427 or if the original IT position was at start of a line. */
9428 RESTORE_IT (it
, it
, it2data
);
9430 move_it_by_lines (it
, nlines
);
9431 /* The above code moves us to some position NLINES down,
9432 usually to its first glyph (leftmost in an L2R line), but
9433 that's not necessarily the start of the line, under bidi
9434 reordering. We want to get to the character position
9435 that is immediately after the newline of the previous
9438 && !it
->continuation_lines_width
9439 && !STRINGP (it
->string
)
9440 && IT_CHARPOS (*it
) > BEGV
9441 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9443 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9446 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9447 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9449 bidi_unshelve_cache (it3data
, 1);
9453 /* The y-position we try to reach, relative to *IT.
9454 Note that H has been subtracted in front of the if-statement. */
9455 int target_y
= it
->current_y
+ h
- dy
;
9456 int y0
= it3
.current_y
;
9460 RESTORE_IT (&it3
, &it3
, it3data
);
9461 y1
= line_bottom_y (&it3
);
9462 line_height
= y1
- y0
;
9463 RESTORE_IT (it
, it
, it2data
);
9464 /* If we did not reach target_y, try to move further backward if
9465 we can. If we moved too far backward, try to move forward. */
9466 if (target_y
< it
->current_y
9467 /* This is heuristic. In a window that's 3 lines high, with
9468 a line height of 13 pixels each, recentering with point
9469 on the bottom line will try to move -39/2 = 19 pixels
9470 backward. Try to avoid moving into the first line. */
9471 && (it
->current_y
- target_y
9472 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9473 && IT_CHARPOS (*it
) > BEGV
)
9475 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9476 target_y
- it
->current_y
));
9477 dy
= it
->current_y
- target_y
;
9478 goto move_further_back
;
9480 else if (target_y
>= it
->current_y
+ line_height
9481 && IT_CHARPOS (*it
) < ZV
)
9483 /* Should move forward by at least one line, maybe more.
9485 Note: Calling move_it_by_lines can be expensive on
9486 terminal frames, where compute_motion is used (via
9487 vmotion) to do the job, when there are very long lines
9488 and truncate-lines is nil. That's the reason for
9489 treating terminal frames specially here. */
9491 if (!FRAME_WINDOW_P (it
->f
))
9492 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9497 move_it_by_lines (it
, 1);
9499 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9506 /* Move IT by a specified amount of pixel lines DY. DY negative means
9507 move backwards. DY = 0 means move to start of screen line. At the
9508 end, IT will be on the start of a screen line. */
9511 move_it_vertically (struct it
*it
, int dy
)
9514 move_it_vertically_backward (it
, -dy
);
9517 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9518 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9519 MOVE_TO_POS
| MOVE_TO_Y
);
9520 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9522 /* If buffer ends in ZV without a newline, move to the start of
9523 the line to satisfy the post-condition. */
9524 if (IT_CHARPOS (*it
) == ZV
9526 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9527 move_it_by_lines (it
, 0);
9532 /* Move iterator IT past the end of the text line it is in. */
9535 move_it_past_eol (struct it
*it
)
9537 enum move_it_result rc
;
9539 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9540 if (rc
== MOVE_NEWLINE_OR_CR
)
9541 set_iterator_to_next (it
, 0);
9545 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9546 negative means move up. DVPOS == 0 means move to the start of the
9549 Optimization idea: If we would know that IT->f doesn't use
9550 a face with proportional font, we could be faster for
9551 truncate-lines nil. */
9554 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9557 /* The commented-out optimization uses vmotion on terminals. This
9558 gives bad results, because elements like it->what, on which
9559 callers such as pos_visible_p rely, aren't updated. */
9560 /* struct position pos;
9561 if (!FRAME_WINDOW_P (it->f))
9563 struct text_pos textpos;
9565 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9566 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9567 reseat (it, textpos, 1);
9568 it->vpos += pos.vpos;
9569 it->current_y += pos.vpos;
9575 /* DVPOS == 0 means move to the start of the screen line. */
9576 move_it_vertically_backward (it
, 0);
9577 /* Let next call to line_bottom_y calculate real line height. */
9582 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9583 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9585 /* Only move to the next buffer position if we ended up in a
9586 string from display property, not in an overlay string
9587 (before-string or after-string). That is because the
9588 latter don't conceal the underlying buffer position, so
9589 we can ask to move the iterator to the exact position we
9590 are interested in. Note that, even if we are already at
9591 IT_CHARPOS (*it), the call below is not a no-op, as it
9592 will detect that we are at the end of the string, pop the
9593 iterator, and compute it->current_x and it->hpos
9595 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9596 -1, -1, -1, MOVE_TO_POS
);
9602 void *it2data
= NULL
;
9603 ptrdiff_t start_charpos
, i
;
9605 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9606 bool hit_pos_limit
= false;
9607 ptrdiff_t pos_limit
;
9609 /* Start at the beginning of the screen line containing IT's
9610 position. This may actually move vertically backwards,
9611 in case of overlays, so adjust dvpos accordingly. */
9613 move_it_vertically_backward (it
, 0);
9616 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9617 screen lines, and reseat the iterator there. */
9618 start_charpos
= IT_CHARPOS (*it
);
9619 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9622 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9624 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9625 back_to_previous_visible_line_start (it
);
9626 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9627 hit_pos_limit
= true;
9628 reseat (it
, it
->current
.pos
, 1);
9630 /* Move further back if we end up in a string or an image. */
9631 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9633 /* First try to move to start of display line. */
9635 move_it_vertically_backward (it
, 0);
9637 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9639 /* If start of line is still in string or image,
9640 move further back. */
9641 back_to_previous_visible_line_start (it
);
9642 reseat (it
, it
->current
.pos
, 1);
9646 it
->current_x
= it
->hpos
= 0;
9648 /* Above call may have moved too far if continuation lines
9649 are involved. Scan forward and see if it did. */
9650 SAVE_IT (it2
, *it
, it2data
);
9651 it2
.vpos
= it2
.current_y
= 0;
9652 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9653 it
->vpos
-= it2
.vpos
;
9654 it
->current_y
-= it2
.current_y
;
9655 it
->current_x
= it
->hpos
= 0;
9657 /* If we moved too far back, move IT some lines forward. */
9658 if (it2
.vpos
> -dvpos
)
9660 int delta
= it2
.vpos
+ dvpos
;
9662 RESTORE_IT (&it2
, &it2
, it2data
);
9663 SAVE_IT (it2
, *it
, it2data
);
9664 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9665 /* Move back again if we got too far ahead. */
9666 if (IT_CHARPOS (*it
) >= start_charpos
)
9667 RESTORE_IT (it
, &it2
, it2data
);
9669 bidi_unshelve_cache (it2data
, 1);
9671 else if (hit_pos_limit
&& pos_limit
> BEGV
9672 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9674 /* If we hit the limit, but still didn't make it far enough
9675 back, that means there's a display string with a newline
9676 covering a large chunk of text, and that caused
9677 back_to_previous_visible_line_start try to go too far.
9678 Punish those who commit such atrocities by going back
9679 until we've reached DVPOS, after lifting the limit, which
9680 could make it slow for very long lines. "If it hurts,
9683 RESTORE_IT (it
, it
, it2data
);
9684 for (i
= -dvpos
; i
> 0; --i
)
9686 back_to_previous_visible_line_start (it
);
9689 reseat_1 (it
, it
->current
.pos
, 1);
9692 RESTORE_IT (it
, it
, it2data
);
9696 /* Return true if IT points into the middle of a display vector. */
9699 in_display_vector_p (struct it
*it
)
9701 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9702 && it
->current
.dpvec_index
> 0
9703 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9706 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9707 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9708 WINDOW must be a live window and defaults to the selected one. The
9709 return value is a cons of the maximum pixel-width of any text line and
9710 the maximum pixel-height of all text lines.
9712 The optional argument FROM, if non-nil, specifies the first text
9713 position and defaults to the minimum accessible position of the buffer.
9714 If FROM is t, use the minimum accessible position that is not a newline
9715 character. TO, if non-nil, specifies the last text position and
9716 defaults to the maximum accessible position of the buffer. If TO is t,
9717 use the maximum accessible position that is not a newline character.
9719 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9720 width that can be returned. X-LIMIT nil or omitted, means to use the
9721 pixel-width of WINDOW's body; use this if you do not intend to change
9722 the width of WINDOW. Use the maximum width WINDOW may assume if you
9723 intend to change WINDOW's width. In any case, text whose x-coordinate
9724 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9725 can take some time, it's always a good idea to make this argument as
9726 small as possible; in particular, if the buffer contains long lines that
9727 shall be truncated anyway.
9729 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9730 height that can be returned. Text lines whose y-coordinate is beyond
9731 Y-LIMIT are ignored. Since calculating the text height of a large
9732 buffer can take some time, it makes sense to specify this argument if
9733 the size of the buffer is unknown.
9735 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9736 include the height of the mode- or header-line of WINDOW in the return
9737 value. If it is either the symbol `mode-line' or `header-line', include
9738 only the height of that line, if present, in the return value. If t,
9739 include the height of both, if present, in the return value. */)
9740 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9741 Lisp_Object mode_and_header_line
)
9743 struct window
*w
= decode_live_window (window
);
9747 struct buffer
*old_buffer
= NULL
;
9748 ptrdiff_t start
, end
, pos
;
9749 struct text_pos startp
;
9750 void *itdata
= NULL
;
9751 int c
, max_y
= -1, x
= 0, y
= 0;
9757 if (b
!= current_buffer
)
9759 old_buffer
= current_buffer
;
9760 set_buffer_internal (b
);
9765 else if (EQ (from
, Qt
))
9768 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9769 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9771 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9776 CHECK_NUMBER_COERCE_MARKER (from
);
9777 start
= min (max (XINT (from
), BEGV
), ZV
);
9782 else if (EQ (to
, Qt
))
9785 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9786 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9788 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9793 CHECK_NUMBER_COERCE_MARKER (to
);
9794 end
= max (start
, min (XINT (to
), ZV
));
9797 if (!NILP (y_limit
))
9799 CHECK_NUMBER (y_limit
);
9800 max_y
= min (XINT (y_limit
), INT_MAX
);
9803 itdata
= bidi_shelve_cache ();
9804 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9805 start_display (&it
, w
, startp
);
9808 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9811 CHECK_NUMBER (x_limit
);
9812 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9813 /* Actually, we never want move_it_to stop at to_x. But to make
9814 sure that move_it_in_display_line_to always moves far enough,
9815 we set it to INT_MAX and specify MOVE_TO_X. */
9816 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9817 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9820 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9822 if (!EQ (mode_and_header_line
, Qheader_line
)
9823 && !EQ (mode_and_header_line
, Qt
))
9824 /* Do not count the header-line which was counted automatically by
9826 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9828 if (EQ (mode_and_header_line
, Qmode_line
)
9829 || EQ (mode_and_header_line
, Qt
))
9830 /* Do count the mode-line which is not included automatically by
9832 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9834 bidi_unshelve_cache (itdata
, 0);
9837 set_buffer_internal (old_buffer
);
9839 return Fcons (make_number (x
), make_number (y
));
9842 /***********************************************************************
9844 ***********************************************************************/
9847 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9851 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9853 Lisp_Object msg
, fmt
;
9856 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9860 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9862 fmt
= build_string (format
);
9863 msg
= CALLN (Fformat
, fmt
, arg1
, arg2
);
9865 len
= SBYTES (msg
) + 1;
9866 buffer
= SAFE_ALLOCA (len
);
9867 memcpy (buffer
, SDATA (msg
), len
);
9869 message_dolog (buffer
, len
- 1, 1, 0);
9876 /* Output a newline in the *Messages* buffer if "needs" one. */
9879 message_log_maybe_newline (void)
9881 if (message_log_need_newline
)
9882 message_dolog ("", 0, 1, 0);
9886 /* Add a string M of length NBYTES to the message log, optionally
9887 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9888 true, means interpret the contents of M as multibyte. This
9889 function calls low-level routines in order to bypass text property
9890 hooks, etc. which might not be safe to run.
9892 This may GC (insert may run before/after change hooks),
9893 so the buffer M must NOT point to a Lisp string. */
9896 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9898 const unsigned char *msg
= (const unsigned char *) m
;
9900 if (!NILP (Vmemory_full
))
9903 if (!NILP (Vmessage_log_max
))
9905 struct buffer
*oldbuf
;
9906 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9907 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9908 ptrdiff_t point_at_end
= 0;
9909 ptrdiff_t zv_at_end
= 0;
9910 Lisp_Object old_deactivate_mark
;
9911 struct gcpro gcpro1
;
9913 old_deactivate_mark
= Vdeactivate_mark
;
9914 oldbuf
= current_buffer
;
9916 /* Ensure the Messages buffer exists, and switch to it.
9917 If we created it, set the major-mode. */
9920 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9922 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9925 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9926 call0 (intern ("messages-buffer-mode"));
9929 bset_undo_list (current_buffer
, Qt
);
9930 bset_cache_long_scans (current_buffer
, Qnil
);
9932 oldpoint
= message_dolog_marker1
;
9933 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9934 oldbegv
= message_dolog_marker2
;
9935 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9936 oldzv
= message_dolog_marker3
;
9937 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9938 GCPRO1 (old_deactivate_mark
);
9946 BEGV_BYTE
= BEG_BYTE
;
9949 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9951 /* Insert the string--maybe converting multibyte to single byte
9952 or vice versa, so that all the text fits the buffer. */
9954 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9960 /* Convert a multibyte string to single-byte
9961 for the *Message* buffer. */
9962 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9964 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9965 work
[0] = CHAR_TO_BYTE8 (c
);
9966 insert_1_both (work
, 1, 1, 1, 0, 0);
9969 else if (! multibyte
9970 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9974 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9975 /* Convert a single-byte string to multibyte
9976 for the *Message* buffer. */
9977 for (i
= 0; i
< nbytes
; i
++)
9980 MAKE_CHAR_MULTIBYTE (c
);
9981 char_bytes
= CHAR_STRING (c
, str
);
9982 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9986 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9990 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9993 insert_1_both ("\n", 1, 1, 1, 0, 0);
9995 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9997 this_bol_byte
= PT_BYTE
;
9999 /* See if this line duplicates the previous one.
10000 If so, combine duplicates. */
10001 if (this_bol
> BEG
)
10003 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10005 prev_bol_byte
= PT_BYTE
;
10007 dups
= message_log_check_duplicate (prev_bol_byte
,
10011 del_range_both (prev_bol
, prev_bol_byte
,
10012 this_bol
, this_bol_byte
, 0);
10015 char dupstr
[sizeof " [ times]"
10016 + INT_STRLEN_BOUND (printmax_t
)];
10018 /* If you change this format, don't forget to also
10019 change message_log_check_duplicate. */
10020 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10021 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10022 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10027 /* If we have more than the desired maximum number of lines
10028 in the *Messages* buffer now, delete the oldest ones.
10029 This is safe because we don't have undo in this buffer. */
10031 if (NATNUMP (Vmessage_log_max
))
10033 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10034 -XFASTINT (Vmessage_log_max
) - 1, 0);
10035 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10038 BEGV
= marker_position (oldbegv
);
10039 BEGV_BYTE
= marker_byte_position (oldbegv
);
10048 ZV
= marker_position (oldzv
);
10049 ZV_BYTE
= marker_byte_position (oldzv
);
10053 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10055 /* We can't do Fgoto_char (oldpoint) because it will run some
10057 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10058 marker_byte_position (oldpoint
));
10061 unchain_marker (XMARKER (oldpoint
));
10062 unchain_marker (XMARKER (oldbegv
));
10063 unchain_marker (XMARKER (oldzv
));
10065 /* We called insert_1_both above with its 5th argument (PREPARE)
10066 zero, which prevents insert_1_both from calling
10067 prepare_to_modify_buffer, which in turns prevents us from
10068 incrementing windows_or_buffers_changed even if *Messages* is
10069 shown in some window. So we must manually set
10070 windows_or_buffers_changed here to make up for that. */
10071 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10072 bset_redisplay (current_buffer
);
10074 set_buffer_internal (oldbuf
);
10076 message_log_need_newline
= !nlflag
;
10077 Vdeactivate_mark
= old_deactivate_mark
;
10082 /* We are at the end of the buffer after just having inserted a newline.
10083 (Note: We depend on the fact we won't be crossing the gap.)
10084 Check to see if the most recent message looks a lot like the previous one.
10085 Return 0 if different, 1 if the new one should just replace it, or a
10086 value N > 1 if we should also append " [N times]". */
10089 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10092 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10094 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10095 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10097 for (i
= 0; i
< len
; i
++)
10099 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10101 if (p1
[i
] != p2
[i
])
10107 if (*p1
++ == ' ' && *p1
++ == '[')
10110 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10111 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10118 /* Display an echo area message M with a specified length of NBYTES
10119 bytes. The string may include null characters. If M is not a
10120 string, clear out any existing message, and let the mini-buffer
10123 This function cancels echoing. */
10126 message3 (Lisp_Object m
)
10128 struct gcpro gcpro1
;
10131 clear_message (true, true);
10134 /* First flush out any partial line written with print. */
10135 message_log_maybe_newline ();
10138 ptrdiff_t nbytes
= SBYTES (m
);
10139 bool multibyte
= STRING_MULTIBYTE (m
);
10142 SAFE_ALLOCA_STRING (buffer
, m
);
10143 message_dolog (buffer
, nbytes
, 1, multibyte
);
10146 message3_nolog (m
);
10152 /* The non-logging version of message3.
10153 This does not cancel echoing, because it is used for echoing.
10154 Perhaps we need to make a separate function for echoing
10155 and make this cancel echoing. */
10158 message3_nolog (Lisp_Object m
)
10160 struct frame
*sf
= SELECTED_FRAME ();
10162 if (FRAME_INITIAL_P (sf
))
10164 if (noninteractive_need_newline
)
10165 putc ('\n', stderr
);
10166 noninteractive_need_newline
= 0;
10169 Lisp_Object s
= ENCODE_SYSTEM (m
);
10171 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10173 if (cursor_in_echo_area
== 0)
10174 fprintf (stderr
, "\n");
10177 /* Error messages get reported properly by cmd_error, so this must be just an
10178 informative message; if the frame hasn't really been initialized yet, just
10180 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10182 /* Get the frame containing the mini-buffer
10183 that the selected frame is using. */
10184 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10185 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10186 struct frame
*f
= XFRAME (frame
);
10188 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10189 Fmake_frame_visible (frame
);
10191 if (STRINGP (m
) && SCHARS (m
) > 0)
10194 if (minibuffer_auto_raise
)
10195 Fraise_frame (frame
);
10196 /* Assume we are not echoing.
10197 (If we are, echo_now will override this.) */
10198 echo_message_buffer
= Qnil
;
10201 clear_message (true, true);
10203 do_pending_window_change (false);
10204 echo_area_display (true);
10205 do_pending_window_change (false);
10206 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10207 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10212 /* Display a null-terminated echo area message M. If M is 0, clear
10213 out any existing message, and let the mini-buffer text show through.
10215 The buffer M must continue to exist until after the echo area gets
10216 cleared or some other message gets displayed there. Do not pass
10217 text that is stored in a Lisp string. Do not pass text in a buffer
10218 that was alloca'd. */
10221 message1 (const char *m
)
10223 message3 (m
? build_unibyte_string (m
) : Qnil
);
10227 /* The non-logging counterpart of message1. */
10230 message1_nolog (const char *m
)
10232 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10235 /* Display a message M which contains a single %s
10236 which gets replaced with STRING. */
10239 message_with_string (const char *m
, Lisp_Object string
, int log
)
10241 CHECK_STRING (string
);
10243 if (noninteractive
)
10247 /* ENCODE_SYSTEM below can GC and/or relocate the
10248 Lisp data, so make sure we don't use it here. */
10249 eassert (relocatable_string_data_p (m
) != 1);
10251 if (noninteractive_need_newline
)
10252 putc ('\n', stderr
);
10253 noninteractive_need_newline
= 0;
10254 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10255 if (!cursor_in_echo_area
)
10256 fprintf (stderr
, "\n");
10260 else if (INTERACTIVE
)
10262 /* The frame whose minibuffer we're going to display the message on.
10263 It may be larger than the selected frame, so we need
10264 to use its buffer, not the selected frame's buffer. */
10265 Lisp_Object mini_window
;
10266 struct frame
*f
, *sf
= SELECTED_FRAME ();
10268 /* Get the frame containing the minibuffer
10269 that the selected frame is using. */
10270 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10271 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10273 /* Error messages get reported properly by cmd_error, so this must be
10274 just an informative message; if the frame hasn't really been
10275 initialized yet, just toss it. */
10276 if (f
->glyphs_initialized_p
)
10278 struct gcpro gcpro1
, gcpro2
;
10280 Lisp_Object fmt
= build_string (m
);
10281 Lisp_Object msg
= string
;
10284 msg
= CALLN (Fformat
, fmt
, msg
);
10289 message3_nolog (msg
);
10293 /* Print should start at the beginning of the message
10294 buffer next time. */
10295 message_buf_print
= 0;
10301 /* Dump an informative message to the minibuf. If M is 0, clear out
10302 any existing message, and let the mini-buffer text show through. */
10305 vmessage (const char *m
, va_list ap
)
10307 if (noninteractive
)
10311 if (noninteractive_need_newline
)
10312 putc ('\n', stderr
);
10313 noninteractive_need_newline
= 0;
10314 vfprintf (stderr
, m
, ap
);
10315 if (cursor_in_echo_area
== 0)
10316 fprintf (stderr
, "\n");
10320 else if (INTERACTIVE
)
10322 /* The frame whose mini-buffer we're going to display the message
10323 on. It may be larger than the selected frame, so we need to
10324 use its buffer, not the selected frame's buffer. */
10325 Lisp_Object mini_window
;
10326 struct frame
*f
, *sf
= SELECTED_FRAME ();
10328 /* Get the frame containing the mini-buffer
10329 that the selected frame is using. */
10330 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10331 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10333 /* Error messages get reported properly by cmd_error, so this must be
10334 just an informative message; if the frame hasn't really been
10335 initialized yet, just toss it. */
10336 if (f
->glyphs_initialized_p
)
10341 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10343 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10345 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10347 message3 (make_string (message_buf
, len
));
10353 /* Print should start at the beginning of the message
10354 buffer next time. */
10355 message_buf_print
= 0;
10361 message (const char *m
, ...)
10371 /* The non-logging version of message. */
10374 message_nolog (const char *m
, ...)
10376 Lisp_Object old_log_max
;
10379 old_log_max
= Vmessage_log_max
;
10380 Vmessage_log_max
= Qnil
;
10382 Vmessage_log_max
= old_log_max
;
10388 /* Display the current message in the current mini-buffer. This is
10389 only called from error handlers in process.c, and is not time
10393 update_echo_area (void)
10395 if (!NILP (echo_area_buffer
[0]))
10397 Lisp_Object string
;
10398 string
= Fcurrent_message ();
10404 /* Make sure echo area buffers in `echo_buffers' are live.
10405 If they aren't, make new ones. */
10408 ensure_echo_area_buffers (void)
10412 for (i
= 0; i
< 2; ++i
)
10413 if (!BUFFERP (echo_buffer
[i
])
10414 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10417 Lisp_Object old_buffer
;
10420 old_buffer
= echo_buffer
[i
];
10421 echo_buffer
[i
] = Fget_buffer_create
10422 (make_formatted_string (name
, " *Echo Area %d*", i
));
10423 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10424 /* to force word wrap in echo area -
10425 it was decided to postpone this*/
10426 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10428 for (j
= 0; j
< 2; ++j
)
10429 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10430 echo_area_buffer
[j
] = echo_buffer
[i
];
10435 /* Call FN with args A1..A2 with either the current or last displayed
10436 echo_area_buffer as current buffer.
10438 WHICH zero means use the current message buffer
10439 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10440 from echo_buffer[] and clear it.
10442 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10443 suitable buffer from echo_buffer[] and clear it.
10445 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10446 that the current message becomes the last displayed one, make
10447 choose a suitable buffer for echo_area_buffer[0], and clear it.
10449 Value is what FN returns. */
10452 with_echo_area_buffer (struct window
*w
, int which
,
10453 int (*fn
) (ptrdiff_t, Lisp_Object
),
10454 ptrdiff_t a1
, Lisp_Object a2
)
10456 Lisp_Object buffer
;
10457 int this_one
, the_other
, clear_buffer_p
, rc
;
10458 ptrdiff_t count
= SPECPDL_INDEX ();
10460 /* If buffers aren't live, make new ones. */
10461 ensure_echo_area_buffers ();
10463 clear_buffer_p
= 0;
10466 this_one
= 0, the_other
= 1;
10467 else if (which
> 0)
10468 this_one
= 1, the_other
= 0;
10471 this_one
= 0, the_other
= 1;
10472 clear_buffer_p
= true;
10474 /* We need a fresh one in case the current echo buffer equals
10475 the one containing the last displayed echo area message. */
10476 if (!NILP (echo_area_buffer
[this_one
])
10477 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10478 echo_area_buffer
[this_one
] = Qnil
;
10481 /* Choose a suitable buffer from echo_buffer[] is we don't
10483 if (NILP (echo_area_buffer
[this_one
]))
10485 echo_area_buffer
[this_one
]
10486 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10487 ? echo_buffer
[the_other
]
10488 : echo_buffer
[this_one
]);
10489 clear_buffer_p
= true;
10492 buffer
= echo_area_buffer
[this_one
];
10494 /* Don't get confused by reusing the buffer used for echoing
10495 for a different purpose. */
10496 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10499 record_unwind_protect (unwind_with_echo_area_buffer
,
10500 with_echo_area_buffer_unwind_data (w
));
10502 /* Make the echo area buffer current. Note that for display
10503 purposes, it is not necessary that the displayed window's buffer
10504 == current_buffer, except for text property lookup. So, let's
10505 only set that buffer temporarily here without doing a full
10506 Fset_window_buffer. We must also change w->pointm, though,
10507 because otherwise an assertions in unshow_buffer fails, and Emacs
10509 set_buffer_internal_1 (XBUFFER (buffer
));
10512 wset_buffer (w
, buffer
);
10513 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10514 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10517 bset_undo_list (current_buffer
, Qt
);
10518 bset_read_only (current_buffer
, Qnil
);
10519 specbind (Qinhibit_read_only
, Qt
);
10520 specbind (Qinhibit_modification_hooks
, Qt
);
10522 if (clear_buffer_p
&& Z
> BEG
)
10523 del_range (BEG
, Z
);
10525 eassert (BEGV
>= BEG
);
10526 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10530 eassert (BEGV
>= BEG
);
10531 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10533 unbind_to (count
, Qnil
);
10538 /* Save state that should be preserved around the call to the function
10539 FN called in with_echo_area_buffer. */
10542 with_echo_area_buffer_unwind_data (struct window
*w
)
10545 Lisp_Object vector
, tmp
;
10547 /* Reduce consing by keeping one vector in
10548 Vwith_echo_area_save_vector. */
10549 vector
= Vwith_echo_area_save_vector
;
10550 Vwith_echo_area_save_vector
= Qnil
;
10553 vector
= Fmake_vector (make_number (11), Qnil
);
10555 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10556 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10557 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10561 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10562 ASET (vector
, i
, w
->contents
); ++i
;
10563 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10564 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10565 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10566 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10567 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10568 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10573 for (; i
< end
; ++i
)
10574 ASET (vector
, i
, Qnil
);
10577 eassert (i
== ASIZE (vector
));
10582 /* Restore global state from VECTOR which was created by
10583 with_echo_area_buffer_unwind_data. */
10586 unwind_with_echo_area_buffer (Lisp_Object vector
)
10588 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10589 Vdeactivate_mark
= AREF (vector
, 1);
10590 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10592 if (WINDOWP (AREF (vector
, 3)))
10595 Lisp_Object buffer
;
10597 w
= XWINDOW (AREF (vector
, 3));
10598 buffer
= AREF (vector
, 4);
10600 wset_buffer (w
, buffer
);
10601 set_marker_both (w
->pointm
, buffer
,
10602 XFASTINT (AREF (vector
, 5)),
10603 XFASTINT (AREF (vector
, 6)));
10604 set_marker_both (w
->old_pointm
, buffer
,
10605 XFASTINT (AREF (vector
, 7)),
10606 XFASTINT (AREF (vector
, 8)));
10607 set_marker_both (w
->start
, buffer
,
10608 XFASTINT (AREF (vector
, 9)),
10609 XFASTINT (AREF (vector
, 10)));
10612 Vwith_echo_area_save_vector
= vector
;
10616 /* Set up the echo area for use by print functions. MULTIBYTE_P
10617 non-zero means we will print multibyte. */
10620 setup_echo_area_for_printing (int multibyte_p
)
10622 /* If we can't find an echo area any more, exit. */
10623 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10624 Fkill_emacs (Qnil
);
10626 ensure_echo_area_buffers ();
10628 if (!message_buf_print
)
10630 /* A message has been output since the last time we printed.
10631 Choose a fresh echo area buffer. */
10632 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10633 echo_area_buffer
[0] = echo_buffer
[1];
10635 echo_area_buffer
[0] = echo_buffer
[0];
10637 /* Switch to that buffer and clear it. */
10638 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10639 bset_truncate_lines (current_buffer
, Qnil
);
10643 ptrdiff_t count
= SPECPDL_INDEX ();
10644 specbind (Qinhibit_read_only
, Qt
);
10645 /* Note that undo recording is always disabled. */
10646 del_range (BEG
, Z
);
10647 unbind_to (count
, Qnil
);
10649 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10651 /* Set up the buffer for the multibyteness we need. */
10653 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10654 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10656 /* Raise the frame containing the echo area. */
10657 if (minibuffer_auto_raise
)
10659 struct frame
*sf
= SELECTED_FRAME ();
10660 Lisp_Object mini_window
;
10661 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10662 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10665 message_log_maybe_newline ();
10666 message_buf_print
= 1;
10670 if (NILP (echo_area_buffer
[0]))
10672 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10673 echo_area_buffer
[0] = echo_buffer
[1];
10675 echo_area_buffer
[0] = echo_buffer
[0];
10678 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10680 /* Someone switched buffers between print requests. */
10681 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10682 bset_truncate_lines (current_buffer
, Qnil
);
10688 /* Display an echo area message in window W. Value is non-zero if W's
10689 height is changed. If display_last_displayed_message_p is
10690 non-zero, display the message that was last displayed, otherwise
10691 display the current message. */
10694 display_echo_area (struct window
*w
)
10696 int i
, no_message_p
, window_height_changed_p
;
10698 /* Temporarily disable garbage collections while displaying the echo
10699 area. This is done because a GC can print a message itself.
10700 That message would modify the echo area buffer's contents while a
10701 redisplay of the buffer is going on, and seriously confuse
10703 ptrdiff_t count
= inhibit_garbage_collection ();
10705 /* If there is no message, we must call display_echo_area_1
10706 nevertheless because it resizes the window. But we will have to
10707 reset the echo_area_buffer in question to nil at the end because
10708 with_echo_area_buffer will sets it to an empty buffer. */
10709 i
= display_last_displayed_message_p
? 1 : 0;
10710 no_message_p
= NILP (echo_area_buffer
[i
]);
10712 window_height_changed_p
10713 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10714 display_echo_area_1
,
10715 (intptr_t) w
, Qnil
);
10718 echo_area_buffer
[i
] = Qnil
;
10720 unbind_to (count
, Qnil
);
10721 return window_height_changed_p
;
10725 /* Helper for display_echo_area. Display the current buffer which
10726 contains the current echo area message in window W, a mini-window,
10727 a pointer to which is passed in A1. A2..A4 are currently not used.
10728 Change the height of W so that all of the message is displayed.
10729 Value is non-zero if height of W was changed. */
10732 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10735 struct window
*w
= (struct window
*) i1
;
10736 Lisp_Object window
;
10737 struct text_pos start
;
10738 int window_height_changed_p
= 0;
10740 /* Do this before displaying, so that we have a large enough glyph
10741 matrix for the display. If we can't get enough space for the
10742 whole text, display the last N lines. That works by setting w->start. */
10743 window_height_changed_p
= resize_mini_window (w
, 0);
10745 /* Use the starting position chosen by resize_mini_window. */
10746 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10749 clear_glyph_matrix (w
->desired_matrix
);
10750 XSETWINDOW (window
, w
);
10751 try_window (window
, start
, 0);
10753 return window_height_changed_p
;
10757 /* Resize the echo area window to exactly the size needed for the
10758 currently displayed message, if there is one. If a mini-buffer
10759 is active, don't shrink it. */
10762 resize_echo_area_exactly (void)
10764 if (BUFFERP (echo_area_buffer
[0])
10765 && WINDOWP (echo_area_window
))
10767 struct window
*w
= XWINDOW (echo_area_window
);
10768 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10769 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10770 (intptr_t) w
, resize_exactly
);
10773 windows_or_buffers_changed
= 42;
10774 update_mode_lines
= 30;
10775 redisplay_internal ();
10781 /* Callback function for with_echo_area_buffer, when used from
10782 resize_echo_area_exactly. A1 contains a pointer to the window to
10783 resize, EXACTLY non-nil means resize the mini-window exactly to the
10784 size of the text displayed. A3 and A4 are not used. Value is what
10785 resize_mini_window returns. */
10788 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10791 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10795 /* Resize mini-window W to fit the size of its contents. EXACT_P
10796 means size the window exactly to the size needed. Otherwise, it's
10797 only enlarged until W's buffer is empty.
10799 Set W->start to the right place to begin display. If the whole
10800 contents fit, start at the beginning. Otherwise, start so as
10801 to make the end of the contents appear. This is particularly
10802 important for y-or-n-p, but seems desirable generally.
10804 Value is non-zero if the window height has been changed. */
10807 resize_mini_window (struct window
*w
, int exact_p
)
10809 struct frame
*f
= XFRAME (w
->frame
);
10810 int window_height_changed_p
= 0;
10812 eassert (MINI_WINDOW_P (w
));
10814 /* By default, start display at the beginning. */
10815 set_marker_both (w
->start
, w
->contents
,
10816 BUF_BEGV (XBUFFER (w
->contents
)),
10817 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10819 /* Don't resize windows while redisplaying a window; it would
10820 confuse redisplay functions when the size of the window they are
10821 displaying changes from under them. Such a resizing can happen,
10822 for instance, when which-func prints a long message while
10823 we are running fontification-functions. We're running these
10824 functions with safe_call which binds inhibit-redisplay to t. */
10825 if (!NILP (Vinhibit_redisplay
))
10828 /* Nil means don't try to resize. */
10829 if (NILP (Vresize_mini_windows
)
10830 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10833 if (!FRAME_MINIBUF_ONLY_P (f
))
10836 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10837 + WINDOW_PIXEL_HEIGHT (w
));
10838 int unit
= FRAME_LINE_HEIGHT (f
);
10839 int height
, max_height
;
10840 struct text_pos start
;
10841 struct buffer
*old_current_buffer
= NULL
;
10843 if (current_buffer
!= XBUFFER (w
->contents
))
10845 old_current_buffer
= current_buffer
;
10846 set_buffer_internal (XBUFFER (w
->contents
));
10849 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10851 /* Compute the max. number of lines specified by the user. */
10852 if (FLOATP (Vmax_mini_window_height
))
10853 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10854 else if (INTEGERP (Vmax_mini_window_height
))
10855 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10857 max_height
= total_height
/ 4;
10859 /* Correct that max. height if it's bogus. */
10860 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10862 /* Find out the height of the text in the window. */
10863 if (it
.line_wrap
== TRUNCATE
)
10868 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10869 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10870 height
= it
.current_y
+ last_height
;
10872 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10873 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10876 /* Compute a suitable window start. */
10877 if (height
> max_height
)
10879 height
= (max_height
/ unit
) * unit
;
10880 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10881 move_it_vertically_backward (&it
, height
- unit
);
10882 start
= it
.current
.pos
;
10885 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10886 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10888 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10890 /* Let it grow only, until we display an empty message, in which
10891 case the window shrinks again. */
10892 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10894 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10896 FRAME_WINDOWS_FROZEN (f
) = 1;
10897 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10898 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10900 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10901 && (exact_p
|| BEGV
== ZV
))
10903 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10905 FRAME_WINDOWS_FROZEN (f
) = 0;
10906 shrink_mini_window (w
, 1);
10907 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10912 /* Always resize to exact size needed. */
10913 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10915 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10917 FRAME_WINDOWS_FROZEN (f
) = 1;
10918 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10919 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10921 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10923 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10925 FRAME_WINDOWS_FROZEN (f
) = 0;
10926 shrink_mini_window (w
, 1);
10930 FRAME_WINDOWS_FROZEN (f
) = 1;
10931 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10934 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10938 if (old_current_buffer
)
10939 set_buffer_internal (old_current_buffer
);
10942 return window_height_changed_p
;
10946 /* Value is the current message, a string, or nil if there is no
10947 current message. */
10950 current_message (void)
10954 if (!BUFFERP (echo_area_buffer
[0]))
10958 with_echo_area_buffer (0, 0, current_message_1
,
10959 (intptr_t) &msg
, Qnil
);
10961 echo_area_buffer
[0] = Qnil
;
10969 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10972 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10975 *msg
= make_buffer_string (BEG
, Z
, 1);
10982 /* Push the current message on Vmessage_stack for later restoration
10983 by restore_message. Value is non-zero if the current message isn't
10984 empty. This is a relatively infrequent operation, so it's not
10985 worth optimizing. */
10988 push_message (void)
10990 Lisp_Object msg
= current_message ();
10991 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10992 return STRINGP (msg
);
10996 /* Restore message display from the top of Vmessage_stack. */
10999 restore_message (void)
11001 eassert (CONSP (Vmessage_stack
));
11002 message3_nolog (XCAR (Vmessage_stack
));
11006 /* Handler for unwind-protect calling pop_message. */
11009 pop_message_unwind (void)
11011 /* Pop the top-most entry off Vmessage_stack. */
11012 eassert (CONSP (Vmessage_stack
));
11013 Vmessage_stack
= XCDR (Vmessage_stack
);
11017 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11018 exits. If the stack is not empty, we have a missing pop_message
11022 check_message_stack (void)
11024 if (!NILP (Vmessage_stack
))
11029 /* Truncate to NCHARS what will be displayed in the echo area the next
11030 time we display it---but don't redisplay it now. */
11033 truncate_echo_area (ptrdiff_t nchars
)
11036 echo_area_buffer
[0] = Qnil
;
11037 else if (!noninteractive
11039 && !NILP (echo_area_buffer
[0]))
11041 struct frame
*sf
= SELECTED_FRAME ();
11042 /* Error messages get reported properly by cmd_error, so this must be
11043 just an informative message; if the frame hasn't really been
11044 initialized yet, just toss it. */
11045 if (sf
->glyphs_initialized_p
)
11046 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11051 /* Helper function for truncate_echo_area. Truncate the current
11052 message to at most NCHARS characters. */
11055 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11057 if (BEG
+ nchars
< Z
)
11058 del_range (BEG
+ nchars
, Z
);
11060 echo_area_buffer
[0] = Qnil
;
11064 /* Set the current message to STRING. */
11067 set_message (Lisp_Object string
)
11069 eassert (STRINGP (string
));
11071 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11073 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11074 message_buf_print
= 0;
11075 help_echo_showing_p
= 0;
11077 if (STRINGP (Vdebug_on_message
)
11078 && STRINGP (string
)
11079 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11080 call_debugger (list2 (Qerror
, string
));
11084 /* Helper function for set_message. First argument is ignored and second
11085 argument has the same meaning as for set_message.
11086 This function is called with the echo area buffer being current. */
11089 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11091 eassert (STRINGP (string
));
11093 /* Change multibyteness of the echo buffer appropriately. */
11094 if (message_enable_multibyte
11095 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11096 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11098 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11099 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11100 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11102 /* Insert new message at BEG. */
11103 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11105 /* This function takes care of single/multibyte conversion.
11106 We just have to ensure that the echo area buffer has the right
11107 setting of enable_multibyte_characters. */
11108 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11114 /* Clear messages. CURRENT_P non-zero means clear the current
11115 message. LAST_DISPLAYED_P non-zero means clear the message
11119 clear_message (bool current_p
, bool last_displayed_p
)
11123 echo_area_buffer
[0] = Qnil
;
11124 message_cleared_p
= true;
11127 if (last_displayed_p
)
11128 echo_area_buffer
[1] = Qnil
;
11130 message_buf_print
= 0;
11133 /* Clear garbaged frames.
11135 This function is used where the old redisplay called
11136 redraw_garbaged_frames which in turn called redraw_frame which in
11137 turn called clear_frame. The call to clear_frame was a source of
11138 flickering. I believe a clear_frame is not necessary. It should
11139 suffice in the new redisplay to invalidate all current matrices,
11140 and ensure a complete redisplay of all windows. */
11143 clear_garbaged_frames (void)
11145 if (frame_garbaged
)
11147 Lisp_Object tail
, frame
;
11149 FOR_EACH_FRAME (tail
, frame
)
11151 struct frame
*f
= XFRAME (frame
);
11153 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11158 clear_current_matrices (f
);
11159 fset_redisplay (f
);
11160 f
->garbaged
= false;
11161 f
->resized_p
= false;
11165 frame_garbaged
= false;
11170 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11171 is non-zero update selected_frame. Value is non-zero if the
11172 mini-windows height has been changed. */
11175 echo_area_display (bool update_frame_p
)
11177 Lisp_Object mini_window
;
11180 bool window_height_changed_p
= false;
11181 struct frame
*sf
= SELECTED_FRAME ();
11183 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11184 w
= XWINDOW (mini_window
);
11185 f
= XFRAME (WINDOW_FRAME (w
));
11187 /* Don't display if frame is invisible or not yet initialized. */
11188 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11191 #ifdef HAVE_WINDOW_SYSTEM
11192 /* When Emacs starts, selected_frame may be the initial terminal
11193 frame. If we let this through, a message would be displayed on
11195 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11197 #endif /* HAVE_WINDOW_SYSTEM */
11199 /* Redraw garbaged frames. */
11200 clear_garbaged_frames ();
11202 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11204 echo_area_window
= mini_window
;
11205 window_height_changed_p
= display_echo_area (w
);
11206 w
->must_be_updated_p
= true;
11208 /* Update the display, unless called from redisplay_internal.
11209 Also don't update the screen during redisplay itself. The
11210 update will happen at the end of redisplay, and an update
11211 here could cause confusion. */
11212 if (update_frame_p
&& !redisplaying_p
)
11216 /* If the display update has been interrupted by pending
11217 input, update mode lines in the frame. Due to the
11218 pending input, it might have been that redisplay hasn't
11219 been called, so that mode lines above the echo area are
11220 garbaged. This looks odd, so we prevent it here. */
11221 if (!display_completed
)
11222 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11224 if (window_height_changed_p
11225 /* Don't do this if Emacs is shutting down. Redisplay
11226 needs to run hooks. */
11227 && !NILP (Vrun_hooks
))
11229 /* Must update other windows. Likewise as in other
11230 cases, don't let this update be interrupted by
11232 ptrdiff_t count
= SPECPDL_INDEX ();
11233 specbind (Qredisplay_dont_pause
, Qt
);
11234 windows_or_buffers_changed
= 44;
11235 redisplay_internal ();
11236 unbind_to (count
, Qnil
);
11238 else if (FRAME_WINDOW_P (f
) && n
== 0)
11240 /* Window configuration is the same as before.
11241 Can do with a display update of the echo area,
11242 unless we displayed some mode lines. */
11243 update_single_window (w
);
11247 update_frame (f
, true, true);
11249 /* If cursor is in the echo area, make sure that the next
11250 redisplay displays the minibuffer, so that the cursor will
11251 be replaced with what the minibuffer wants. */
11252 if (cursor_in_echo_area
)
11253 wset_redisplay (XWINDOW (mini_window
));
11256 else if (!EQ (mini_window
, selected_window
))
11257 wset_redisplay (XWINDOW (mini_window
));
11259 /* Last displayed message is now the current message. */
11260 echo_area_buffer
[1] = echo_area_buffer
[0];
11261 /* Inform read_char that we're not echoing. */
11262 echo_message_buffer
= Qnil
;
11264 /* Prevent redisplay optimization in redisplay_internal by resetting
11265 this_line_start_pos. This is done because the mini-buffer now
11266 displays the message instead of its buffer text. */
11267 if (EQ (mini_window
, selected_window
))
11268 CHARPOS (this_line_start_pos
) = 0;
11270 return window_height_changed_p
;
11273 /* Nonzero if W's buffer was changed but not saved. */
11276 window_buffer_changed (struct window
*w
)
11278 struct buffer
*b
= XBUFFER (w
->contents
);
11280 eassert (BUFFER_LIVE_P (b
));
11282 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11285 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11288 mode_line_update_needed (struct window
*w
)
11290 return (w
->column_number_displayed
!= -1
11291 && !(PT
== w
->last_point
&& !window_outdated (w
))
11292 && (w
->column_number_displayed
!= current_column ()));
11295 /* Nonzero if window start of W is frozen and may not be changed during
11299 window_frozen_p (struct window
*w
)
11301 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11303 Lisp_Object window
;
11305 XSETWINDOW (window
, w
);
11306 if (MINI_WINDOW_P (w
))
11308 else if (EQ (window
, selected_window
))
11310 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11311 && EQ (window
, Vminibuf_scroll_window
))
11312 /* This special window can't be frozen too. */
11320 /***********************************************************************
11321 Mode Lines and Frame Titles
11322 ***********************************************************************/
11324 /* A buffer for constructing non-propertized mode-line strings and
11325 frame titles in it; allocated from the heap in init_xdisp and
11326 resized as needed in store_mode_line_noprop_char. */
11328 static char *mode_line_noprop_buf
;
11330 /* The buffer's end, and a current output position in it. */
11332 static char *mode_line_noprop_buf_end
;
11333 static char *mode_line_noprop_ptr
;
11335 #define MODE_LINE_NOPROP_LEN(start) \
11336 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11339 MODE_LINE_DISPLAY
= 0,
11343 } mode_line_target
;
11345 /* Alist that caches the results of :propertize.
11346 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11347 static Lisp_Object mode_line_proptrans_alist
;
11349 /* List of strings making up the mode-line. */
11350 static Lisp_Object mode_line_string_list
;
11352 /* Base face property when building propertized mode line string. */
11353 static Lisp_Object mode_line_string_face
;
11354 static Lisp_Object mode_line_string_face_prop
;
11357 /* Unwind data for mode line strings */
11359 static Lisp_Object Vmode_line_unwind_vector
;
11362 format_mode_line_unwind_data (struct frame
*target_frame
,
11363 struct buffer
*obuf
,
11365 int save_proptrans
)
11367 Lisp_Object vector
, tmp
;
11369 /* Reduce consing by keeping one vector in
11370 Vwith_echo_area_save_vector. */
11371 vector
= Vmode_line_unwind_vector
;
11372 Vmode_line_unwind_vector
= Qnil
;
11375 vector
= Fmake_vector (make_number (10), Qnil
);
11377 ASET (vector
, 0, make_number (mode_line_target
));
11378 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11379 ASET (vector
, 2, mode_line_string_list
);
11380 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11381 ASET (vector
, 4, mode_line_string_face
);
11382 ASET (vector
, 5, mode_line_string_face_prop
);
11385 XSETBUFFER (tmp
, obuf
);
11388 ASET (vector
, 6, tmp
);
11389 ASET (vector
, 7, owin
);
11392 /* Similarly to `with-selected-window', if the operation selects
11393 a window on another frame, we must restore that frame's
11394 selected window, and (for a tty) the top-frame. */
11395 ASET (vector
, 8, target_frame
->selected_window
);
11396 if (FRAME_TERMCAP_P (target_frame
))
11397 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11404 unwind_format_mode_line (Lisp_Object vector
)
11406 Lisp_Object old_window
= AREF (vector
, 7);
11407 Lisp_Object target_frame_window
= AREF (vector
, 8);
11408 Lisp_Object old_top_frame
= AREF (vector
, 9);
11410 mode_line_target
= XINT (AREF (vector
, 0));
11411 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11412 mode_line_string_list
= AREF (vector
, 2);
11413 if (! EQ (AREF (vector
, 3), Qt
))
11414 mode_line_proptrans_alist
= AREF (vector
, 3);
11415 mode_line_string_face
= AREF (vector
, 4);
11416 mode_line_string_face_prop
= AREF (vector
, 5);
11418 /* Select window before buffer, since it may change the buffer. */
11419 if (!NILP (old_window
))
11421 /* If the operation that we are unwinding had selected a window
11422 on a different frame, reset its frame-selected-window. For a
11423 text terminal, reset its top-frame if necessary. */
11424 if (!NILP (target_frame_window
))
11427 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11429 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11430 Fselect_window (target_frame_window
, Qt
);
11432 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11433 Fselect_frame (old_top_frame
, Qt
);
11436 Fselect_window (old_window
, Qt
);
11439 if (!NILP (AREF (vector
, 6)))
11441 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11442 ASET (vector
, 6, Qnil
);
11445 Vmode_line_unwind_vector
= vector
;
11449 /* Store a single character C for the frame title in mode_line_noprop_buf.
11450 Re-allocate mode_line_noprop_buf if necessary. */
11453 store_mode_line_noprop_char (char c
)
11455 /* If output position has reached the end of the allocated buffer,
11456 increase the buffer's size. */
11457 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11459 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11460 ptrdiff_t size
= len
;
11461 mode_line_noprop_buf
=
11462 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11463 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11464 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11467 *mode_line_noprop_ptr
++ = c
;
11471 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11472 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11473 characters that yield more columns than PRECISION; PRECISION <= 0
11474 means copy the whole string. Pad with spaces until FIELD_WIDTH
11475 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11476 pad. Called from display_mode_element when it is used to build a
11480 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11482 const unsigned char *str
= (const unsigned char *) string
;
11484 ptrdiff_t dummy
, nbytes
;
11486 /* Copy at most PRECISION chars from STR. */
11487 nbytes
= strlen (string
);
11488 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11490 store_mode_line_noprop_char (*str
++);
11492 /* Fill up with spaces until FIELD_WIDTH reached. */
11493 while (field_width
> 0
11494 && n
< field_width
)
11496 store_mode_line_noprop_char (' ');
11503 /***********************************************************************
11505 ***********************************************************************/
11507 #ifdef HAVE_WINDOW_SYSTEM
11509 /* Set the title of FRAME, if it has changed. The title format is
11510 Vicon_title_format if FRAME is iconified, otherwise it is
11511 frame_title_format. */
11514 x_consider_frame_title (Lisp_Object frame
)
11516 struct frame
*f
= XFRAME (frame
);
11518 if (FRAME_WINDOW_P (f
)
11519 || FRAME_MINIBUF_ONLY_P (f
)
11520 || f
->explicit_name
)
11522 /* Do we have more than one visible frame on this X display? */
11523 Lisp_Object tail
, other_frame
, fmt
;
11524 ptrdiff_t title_start
;
11528 ptrdiff_t count
= SPECPDL_INDEX ();
11530 FOR_EACH_FRAME (tail
, other_frame
)
11532 struct frame
*tf
= XFRAME (other_frame
);
11535 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11536 && !FRAME_MINIBUF_ONLY_P (tf
)
11537 && !EQ (other_frame
, tip_frame
)
11538 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11542 /* Set global variable indicating that multiple frames exist. */
11543 multiple_frames
= CONSP (tail
);
11545 /* Switch to the buffer of selected window of the frame. Set up
11546 mode_line_target so that display_mode_element will output into
11547 mode_line_noprop_buf; then display the title. */
11548 record_unwind_protect (unwind_format_mode_line
,
11549 format_mode_line_unwind_data
11550 (f
, current_buffer
, selected_window
, 0));
11552 Fselect_window (f
->selected_window
, Qt
);
11553 set_buffer_internal_1
11554 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11555 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11557 mode_line_target
= MODE_LINE_TITLE
;
11558 title_start
= MODE_LINE_NOPROP_LEN (0);
11559 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11560 NULL
, DEFAULT_FACE_ID
);
11561 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11562 len
= MODE_LINE_NOPROP_LEN (title_start
);
11563 title
= mode_line_noprop_buf
+ title_start
;
11564 unbind_to (count
, Qnil
);
11566 /* Set the title only if it's changed. This avoids consing in
11567 the common case where it hasn't. (If it turns out that we've
11568 already wasted too much time by walking through the list with
11569 display_mode_element, then we might need to optimize at a
11570 higher level than this.) */
11571 if (! STRINGP (f
->name
)
11572 || SBYTES (f
->name
) != len
11573 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11574 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11578 #endif /* not HAVE_WINDOW_SYSTEM */
11581 /***********************************************************************
11583 ***********************************************************************/
11585 /* Non-zero if we will not redisplay all visible windows. */
11586 #define REDISPLAY_SOME_P() \
11587 ((windows_or_buffers_changed == 0 \
11588 || windows_or_buffers_changed == REDISPLAY_SOME) \
11589 && (update_mode_lines == 0 \
11590 || update_mode_lines == REDISPLAY_SOME))
11592 /* Prepare for redisplay by updating menu-bar item lists when
11593 appropriate. This can call eval. */
11596 prepare_menu_bars (void)
11598 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11599 bool some_windows
= REDISPLAY_SOME_P ();
11600 struct gcpro gcpro1
, gcpro2
;
11601 Lisp_Object tooltip_frame
;
11603 #ifdef HAVE_WINDOW_SYSTEM
11604 tooltip_frame
= tip_frame
;
11606 tooltip_frame
= Qnil
;
11609 if (FUNCTIONP (Vpre_redisplay_function
))
11611 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11612 if (all_windows
&& some_windows
)
11614 Lisp_Object ws
= window_list ();
11615 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11617 Lisp_Object
this = XCAR (ws
);
11618 struct window
*w
= XWINDOW (this);
11620 || XFRAME (w
->frame
)->redisplay
11621 || XBUFFER (w
->contents
)->text
->redisplay
)
11623 windows
= Fcons (this, windows
);
11627 safe__call1 (true, Vpre_redisplay_function
, windows
);
11630 /* Update all frame titles based on their buffer names, etc. We do
11631 this before the menu bars so that the buffer-menu will show the
11632 up-to-date frame titles. */
11633 #ifdef HAVE_WINDOW_SYSTEM
11636 Lisp_Object tail
, frame
;
11638 FOR_EACH_FRAME (tail
, frame
)
11640 struct frame
*f
= XFRAME (frame
);
11641 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11645 && !XBUFFER (w
->contents
)->text
->redisplay
)
11648 if (!EQ (frame
, tooltip_frame
)
11649 && (FRAME_ICONIFIED_P (f
)
11650 || FRAME_VISIBLE_P (f
) == 1
11651 /* Exclude TTY frames that are obscured because they
11652 are not the top frame on their console. This is
11653 because x_consider_frame_title actually switches
11654 to the frame, which for TTY frames means it is
11655 marked as garbaged, and will be completely
11656 redrawn on the next redisplay cycle. This causes
11657 TTY frames to be completely redrawn, when there
11658 are more than one of them, even though nothing
11659 should be changed on display. */
11660 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11661 x_consider_frame_title (frame
);
11664 #endif /* HAVE_WINDOW_SYSTEM */
11666 /* Update the menu bar item lists, if appropriate. This has to be
11667 done before any actual redisplay or generation of display lines. */
11671 Lisp_Object tail
, frame
;
11672 ptrdiff_t count
= SPECPDL_INDEX ();
11673 /* 1 means that update_menu_bar has run its hooks
11674 so any further calls to update_menu_bar shouldn't do so again. */
11675 int menu_bar_hooks_run
= 0;
11677 record_unwind_save_match_data ();
11679 FOR_EACH_FRAME (tail
, frame
)
11681 struct frame
*f
= XFRAME (frame
);
11682 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11684 /* Ignore tooltip frame. */
11685 if (EQ (frame
, tooltip_frame
))
11691 && !XBUFFER (w
->contents
)->text
->redisplay
)
11694 /* If a window on this frame changed size, report that to
11695 the user and clear the size-change flag. */
11696 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11698 Lisp_Object functions
;
11700 /* Clear flag first in case we get an error below. */
11701 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11702 functions
= Vwindow_size_change_functions
;
11703 GCPRO2 (tail
, functions
);
11705 while (CONSP (functions
))
11707 if (!EQ (XCAR (functions
), Qt
))
11708 call1 (XCAR (functions
), frame
);
11709 functions
= XCDR (functions
);
11715 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11716 #ifdef HAVE_WINDOW_SYSTEM
11717 update_tool_bar (f
, 0);
11722 unbind_to (count
, Qnil
);
11726 struct frame
*sf
= SELECTED_FRAME ();
11727 update_menu_bar (sf
, 1, 0);
11728 #ifdef HAVE_WINDOW_SYSTEM
11729 update_tool_bar (sf
, 1);
11735 /* Update the menu bar item list for frame F. This has to be done
11736 before we start to fill in any display lines, because it can call
11739 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11741 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11742 already ran the menu bar hooks for this redisplay, so there
11743 is no need to run them again. The return value is the
11744 updated value of this flag, to pass to the next call. */
11747 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11749 Lisp_Object window
;
11750 register struct window
*w
;
11752 /* If called recursively during a menu update, do nothing. This can
11753 happen when, for instance, an activate-menubar-hook causes a
11755 if (inhibit_menubar_update
)
11758 window
= FRAME_SELECTED_WINDOW (f
);
11759 w
= XWINDOW (window
);
11761 if (FRAME_WINDOW_P (f
)
11763 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11764 || defined (HAVE_NS) || defined (USE_GTK)
11765 FRAME_EXTERNAL_MENU_BAR (f
)
11767 FRAME_MENU_BAR_LINES (f
) > 0
11769 : FRAME_MENU_BAR_LINES (f
) > 0)
11771 /* If the user has switched buffers or windows, we need to
11772 recompute to reflect the new bindings. But we'll
11773 recompute when update_mode_lines is set too; that means
11774 that people can use force-mode-line-update to request
11775 that the menu bar be recomputed. The adverse effect on
11776 the rest of the redisplay algorithm is about the same as
11777 windows_or_buffers_changed anyway. */
11778 if (windows_or_buffers_changed
11779 /* This used to test w->update_mode_line, but we believe
11780 there is no need to recompute the menu in that case. */
11781 || update_mode_lines
11782 || window_buffer_changed (w
))
11784 struct buffer
*prev
= current_buffer
;
11785 ptrdiff_t count
= SPECPDL_INDEX ();
11787 specbind (Qinhibit_menubar_update
, Qt
);
11789 set_buffer_internal_1 (XBUFFER (w
->contents
));
11790 if (save_match_data
)
11791 record_unwind_save_match_data ();
11792 if (NILP (Voverriding_local_map_menu_flag
))
11794 specbind (Qoverriding_terminal_local_map
, Qnil
);
11795 specbind (Qoverriding_local_map
, Qnil
);
11800 /* Run the Lucid hook. */
11801 safe_run_hooks (Qactivate_menubar_hook
);
11803 /* If it has changed current-menubar from previous value,
11804 really recompute the menu-bar from the value. */
11805 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11806 call0 (Qrecompute_lucid_menubar
);
11808 safe_run_hooks (Qmenu_bar_update_hook
);
11813 XSETFRAME (Vmenu_updating_frame
, f
);
11814 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11816 /* Redisplay the menu bar in case we changed it. */
11817 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11818 || defined (HAVE_NS) || defined (USE_GTK)
11819 if (FRAME_WINDOW_P (f
))
11821 #if defined (HAVE_NS)
11822 /* All frames on Mac OS share the same menubar. So only
11823 the selected frame should be allowed to set it. */
11824 if (f
== SELECTED_FRAME ())
11826 set_frame_menubar (f
, 0, 0);
11829 /* On a terminal screen, the menu bar is an ordinary screen
11830 line, and this makes it get updated. */
11831 w
->update_mode_line
= 1;
11832 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11833 /* In the non-toolkit version, the menu bar is an ordinary screen
11834 line, and this makes it get updated. */
11835 w
->update_mode_line
= 1;
11836 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11838 unbind_to (count
, Qnil
);
11839 set_buffer_internal_1 (prev
);
11846 /***********************************************************************
11848 ***********************************************************************/
11850 #ifdef HAVE_WINDOW_SYSTEM
11852 /* Select `frame' temporarily without running all the code in
11854 FIXME: Maybe do_switch_frame should be trimmed down similarly
11855 when `norecord' is set. */
11857 fast_set_selected_frame (Lisp_Object frame
)
11859 if (!EQ (selected_frame
, frame
))
11861 selected_frame
= frame
;
11862 selected_window
= XFRAME (frame
)->selected_window
;
11866 /* Update the tool-bar item list for frame F. This has to be done
11867 before we start to fill in any display lines. Called from
11868 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11869 and restore it here. */
11872 update_tool_bar (struct frame
*f
, int save_match_data
)
11874 #if defined (USE_GTK) || defined (HAVE_NS)
11875 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11877 int do_update
= (WINDOWP (f
->tool_bar_window
)
11878 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11883 Lisp_Object window
;
11886 window
= FRAME_SELECTED_WINDOW (f
);
11887 w
= XWINDOW (window
);
11889 /* If the user has switched buffers or windows, we need to
11890 recompute to reflect the new bindings. But we'll
11891 recompute when update_mode_lines is set too; that means
11892 that people can use force-mode-line-update to request
11893 that the menu bar be recomputed. The adverse effect on
11894 the rest of the redisplay algorithm is about the same as
11895 windows_or_buffers_changed anyway. */
11896 if (windows_or_buffers_changed
11897 || w
->update_mode_line
11898 || update_mode_lines
11899 || window_buffer_changed (w
))
11901 struct buffer
*prev
= current_buffer
;
11902 ptrdiff_t count
= SPECPDL_INDEX ();
11903 Lisp_Object frame
, new_tool_bar
;
11904 int new_n_tool_bar
;
11905 struct gcpro gcpro1
;
11907 /* Set current_buffer to the buffer of the selected
11908 window of the frame, so that we get the right local
11910 set_buffer_internal_1 (XBUFFER (w
->contents
));
11912 /* Save match data, if we must. */
11913 if (save_match_data
)
11914 record_unwind_save_match_data ();
11916 /* Make sure that we don't accidentally use bogus keymaps. */
11917 if (NILP (Voverriding_local_map_menu_flag
))
11919 specbind (Qoverriding_terminal_local_map
, Qnil
);
11920 specbind (Qoverriding_local_map
, Qnil
);
11923 GCPRO1 (new_tool_bar
);
11925 /* We must temporarily set the selected frame to this frame
11926 before calling tool_bar_items, because the calculation of
11927 the tool-bar keymap uses the selected frame (see
11928 `tool-bar-make-keymap' in tool-bar.el). */
11929 eassert (EQ (selected_window
,
11930 /* Since we only explicitly preserve selected_frame,
11931 check that selected_window would be redundant. */
11932 XFRAME (selected_frame
)->selected_window
));
11933 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11934 XSETFRAME (frame
, f
);
11935 fast_set_selected_frame (frame
);
11937 /* Build desired tool-bar items from keymaps. */
11939 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11942 /* Redisplay the tool-bar if we changed it. */
11943 if (new_n_tool_bar
!= f
->n_tool_bar_items
11944 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11946 /* Redisplay that happens asynchronously due to an expose event
11947 may access f->tool_bar_items. Make sure we update both
11948 variables within BLOCK_INPUT so no such event interrupts. */
11950 fset_tool_bar_items (f
, new_tool_bar
);
11951 f
->n_tool_bar_items
= new_n_tool_bar
;
11952 w
->update_mode_line
= 1;
11958 unbind_to (count
, Qnil
);
11959 set_buffer_internal_1 (prev
);
11964 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11966 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11967 F's desired tool-bar contents. F->tool_bar_items must have
11968 been set up previously by calling prepare_menu_bars. */
11971 build_desired_tool_bar_string (struct frame
*f
)
11973 int i
, size
, size_needed
;
11974 struct gcpro gcpro1
, gcpro2
;
11975 Lisp_Object image
, plist
;
11977 image
= plist
= Qnil
;
11978 GCPRO2 (image
, plist
);
11980 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11981 Otherwise, make a new string. */
11983 /* The size of the string we might be able to reuse. */
11984 size
= (STRINGP (f
->desired_tool_bar_string
)
11985 ? SCHARS (f
->desired_tool_bar_string
)
11988 /* We need one space in the string for each image. */
11989 size_needed
= f
->n_tool_bar_items
;
11991 /* Reuse f->desired_tool_bar_string, if possible. */
11992 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11993 fset_desired_tool_bar_string
11994 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11997 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11998 struct gcpro gcpro1
;
12000 Fremove_text_properties (make_number (0), make_number (size
),
12001 props
, f
->desired_tool_bar_string
);
12005 /* Put a `display' property on the string for the images to display,
12006 put a `menu_item' property on tool-bar items with a value that
12007 is the index of the item in F's tool-bar item vector. */
12008 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12010 #define PROP(IDX) \
12011 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12013 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12014 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12015 int hmargin
, vmargin
, relief
, idx
, end
;
12017 /* If image is a vector, choose the image according to the
12019 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12020 if (VECTORP (image
))
12024 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12025 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12028 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12029 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12031 eassert (ASIZE (image
) >= idx
);
12032 image
= AREF (image
, idx
);
12037 /* Ignore invalid image specifications. */
12038 if (!valid_image_p (image
))
12041 /* Display the tool-bar button pressed, or depressed. */
12042 plist
= Fcopy_sequence (XCDR (image
));
12044 /* Compute margin and relief to draw. */
12045 relief
= (tool_bar_button_relief
>= 0
12046 ? tool_bar_button_relief
12047 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12048 hmargin
= vmargin
= relief
;
12050 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12051 INT_MAX
- max (hmargin
, vmargin
)))
12053 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12054 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12056 else if (CONSP (Vtool_bar_button_margin
))
12058 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12059 INT_MAX
- hmargin
))
12060 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12062 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12063 INT_MAX
- vmargin
))
12064 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12067 if (auto_raise_tool_bar_buttons_p
)
12069 /* Add a `:relief' property to the image spec if the item is
12073 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12080 /* If image is selected, display it pressed, i.e. with a
12081 negative relief. If it's not selected, display it with a
12083 plist
= Fplist_put (plist
, QCrelief
,
12085 ? make_number (-relief
)
12086 : make_number (relief
)));
12091 /* Put a margin around the image. */
12092 if (hmargin
|| vmargin
)
12094 if (hmargin
== vmargin
)
12095 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12097 plist
= Fplist_put (plist
, QCmargin
,
12098 Fcons (make_number (hmargin
),
12099 make_number (vmargin
)));
12102 /* If button is not enabled, and we don't have special images
12103 for the disabled state, make the image appear disabled by
12104 applying an appropriate algorithm to it. */
12105 if (!enabled_p
&& idx
< 0)
12106 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12108 /* Put a `display' text property on the string for the image to
12109 display. Put a `menu-item' property on the string that gives
12110 the start of this item's properties in the tool-bar items
12112 image
= Fcons (Qimage
, plist
);
12113 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12114 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12115 struct gcpro gcpro1
;
12118 /* Let the last image hide all remaining spaces in the tool bar
12119 string. The string can be longer than needed when we reuse a
12120 previous string. */
12121 if (i
+ 1 == f
->n_tool_bar_items
)
12122 end
= SCHARS (f
->desired_tool_bar_string
);
12125 Fadd_text_properties (make_number (i
), make_number (end
),
12126 props
, f
->desired_tool_bar_string
);
12135 /* Display one line of the tool-bar of frame IT->f.
12137 HEIGHT specifies the desired height of the tool-bar line.
12138 If the actual height of the glyph row is less than HEIGHT, the
12139 row's height is increased to HEIGHT, and the icons are centered
12140 vertically in the new height.
12142 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12143 count a final empty row in case the tool-bar width exactly matches
12148 display_tool_bar_line (struct it
*it
, int height
)
12150 struct glyph_row
*row
= it
->glyph_row
;
12151 int max_x
= it
->last_visible_x
;
12152 struct glyph
*last
;
12154 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12155 clear_glyph_row (row
);
12156 row
->enabled_p
= true;
12157 row
->y
= it
->current_y
;
12159 /* Note that this isn't made use of if the face hasn't a box,
12160 so there's no need to check the face here. */
12161 it
->start_of_box_run_p
= 1;
12163 while (it
->current_x
< max_x
)
12165 int x
, n_glyphs_before
, i
, nglyphs
;
12166 struct it it_before
;
12168 /* Get the next display element. */
12169 if (!get_next_display_element (it
))
12171 /* Don't count empty row if we are counting needed tool-bar lines. */
12172 if (height
< 0 && !it
->hpos
)
12177 /* Produce glyphs. */
12178 n_glyphs_before
= row
->used
[TEXT_AREA
];
12181 PRODUCE_GLYPHS (it
);
12183 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12185 x
= it_before
.current_x
;
12186 while (i
< nglyphs
)
12188 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12190 if (x
+ glyph
->pixel_width
> max_x
)
12192 /* Glyph doesn't fit on line. Backtrack. */
12193 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12195 /* If this is the only glyph on this line, it will never fit on the
12196 tool-bar, so skip it. But ensure there is at least one glyph,
12197 so we don't accidentally disable the tool-bar. */
12198 if (n_glyphs_before
== 0
12199 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12205 x
+= glyph
->pixel_width
;
12209 /* Stop at line end. */
12210 if (ITERATOR_AT_END_OF_LINE_P (it
))
12213 set_iterator_to_next (it
, 1);
12218 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12220 /* Use default face for the border below the tool bar.
12222 FIXME: When auto-resize-tool-bars is grow-only, there is
12223 no additional border below the possibly empty tool-bar lines.
12224 So to make the extra empty lines look "normal", we have to
12225 use the tool-bar face for the border too. */
12226 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12227 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12228 it
->face_id
= DEFAULT_FACE_ID
;
12230 extend_face_to_end_of_line (it
);
12231 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12232 last
->right_box_line_p
= 1;
12233 if (last
== row
->glyphs
[TEXT_AREA
])
12234 last
->left_box_line_p
= 1;
12236 /* Make line the desired height and center it vertically. */
12237 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12239 /* Don't add more than one line height. */
12240 height
%= FRAME_LINE_HEIGHT (it
->f
);
12241 it
->max_ascent
+= height
/ 2;
12242 it
->max_descent
+= (height
+ 1) / 2;
12245 compute_line_metrics (it
);
12247 /* If line is empty, make it occupy the rest of the tool-bar. */
12248 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12250 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12251 row
->visible_height
= row
->height
;
12252 row
->ascent
= row
->phys_ascent
= 0;
12253 row
->extra_line_spacing
= 0;
12256 row
->full_width_p
= 1;
12257 row
->continued_p
= 0;
12258 row
->truncated_on_left_p
= 0;
12259 row
->truncated_on_right_p
= 0;
12261 it
->current_x
= it
->hpos
= 0;
12262 it
->current_y
+= row
->height
;
12268 /* Value is the number of pixels needed to make all tool-bar items of
12269 frame F visible. The actual number of glyph rows needed is
12270 returned in *N_ROWS if non-NULL. */
12272 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12274 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12276 /* tool_bar_height is called from redisplay_tool_bar after building
12277 the desired matrix, so use (unused) mode-line row as temporary row to
12278 avoid destroying the first tool-bar row. */
12279 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12281 /* Initialize an iterator for iteration over
12282 F->desired_tool_bar_string in the tool-bar window of frame F. */
12283 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12284 temp_row
->reversed_p
= false;
12285 it
.first_visible_x
= 0;
12286 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12287 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12288 it
.paragraph_embedding
= L2R
;
12290 while (!ITERATOR_AT_END_P (&it
))
12292 clear_glyph_row (temp_row
);
12293 it
.glyph_row
= temp_row
;
12294 display_tool_bar_line (&it
, -1);
12296 clear_glyph_row (temp_row
);
12298 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12300 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12303 return it
.current_y
;
12305 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12308 #endif /* !USE_GTK && !HAVE_NS */
12310 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12312 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12313 If FRAME is nil or omitted, use the selected frame. Optional argument
12314 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12315 (Lisp_Object frame
, Lisp_Object pixelwise
)
12319 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12320 struct frame
*f
= decode_any_frame (frame
);
12322 if (WINDOWP (f
->tool_bar_window
)
12323 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12325 update_tool_bar (f
, 1);
12326 if (f
->n_tool_bar_items
)
12328 build_desired_tool_bar_string (f
);
12329 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12334 return make_number (height
);
12338 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12339 height should be changed. */
12341 redisplay_tool_bar (struct frame
*f
)
12343 #if defined (USE_GTK) || defined (HAVE_NS)
12345 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12346 update_frame_tool_bar (f
);
12349 #else /* !USE_GTK && !HAVE_NS */
12353 struct glyph_row
*row
;
12355 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12356 do anything. This means you must start with tool-bar-lines
12357 non-zero to get the auto-sizing effect. Or in other words, you
12358 can turn off tool-bars by specifying tool-bar-lines zero. */
12359 if (!WINDOWP (f
->tool_bar_window
)
12360 || (w
= XWINDOW (f
->tool_bar_window
),
12361 WINDOW_TOTAL_LINES (w
) == 0))
12364 /* Set up an iterator for the tool-bar window. */
12365 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12366 it
.first_visible_x
= 0;
12367 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12368 row
= it
.glyph_row
;
12369 row
->reversed_p
= false;
12371 /* Build a string that represents the contents of the tool-bar. */
12372 build_desired_tool_bar_string (f
);
12373 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12374 /* FIXME: This should be controlled by a user option. But it
12375 doesn't make sense to have an R2L tool bar if the menu bar cannot
12376 be drawn also R2L, and making the menu bar R2L is tricky due
12377 toolkit-specific code that implements it. If an R2L tool bar is
12378 ever supported, display_tool_bar_line should also be augmented to
12379 call unproduce_glyphs like display_line and display_string
12381 it
.paragraph_embedding
= L2R
;
12383 if (f
->n_tool_bar_rows
== 0)
12385 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12387 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12389 x_change_tool_bar_height (f
, new_height
);
12390 frame_default_tool_bar_height
= new_height
;
12391 /* Always do that now. */
12392 clear_glyph_matrix (w
->desired_matrix
);
12393 f
->fonts_changed
= 1;
12398 /* Display as many lines as needed to display all tool-bar items. */
12400 if (f
->n_tool_bar_rows
> 0)
12402 int border
, rows
, height
, extra
;
12404 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12405 border
= XINT (Vtool_bar_border
);
12406 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12407 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12408 else if (EQ (Vtool_bar_border
, Qborder_width
))
12409 border
= f
->border_width
;
12415 rows
= f
->n_tool_bar_rows
;
12416 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12417 extra
= it
.last_visible_y
- border
- height
* rows
;
12419 while (it
.current_y
< it
.last_visible_y
)
12422 if (extra
> 0 && rows
-- > 0)
12424 h
= (extra
+ rows
- 1) / rows
;
12427 display_tool_bar_line (&it
, height
+ h
);
12432 while (it
.current_y
< it
.last_visible_y
)
12433 display_tool_bar_line (&it
, 0);
12436 /* It doesn't make much sense to try scrolling in the tool-bar
12437 window, so don't do it. */
12438 w
->desired_matrix
->no_scrolling_p
= 1;
12439 w
->must_be_updated_p
= 1;
12441 if (!NILP (Vauto_resize_tool_bars
))
12443 int change_height_p
= 0;
12445 /* If we couldn't display everything, change the tool-bar's
12446 height if there is room for more. */
12447 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12448 change_height_p
= 1;
12450 /* We subtract 1 because display_tool_bar_line advances the
12451 glyph_row pointer before returning to its caller. We want to
12452 examine the last glyph row produced by
12453 display_tool_bar_line. */
12454 row
= it
.glyph_row
- 1;
12456 /* If there are blank lines at the end, except for a partially
12457 visible blank line at the end that is smaller than
12458 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12459 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12460 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12461 change_height_p
= 1;
12463 /* If row displays tool-bar items, but is partially visible,
12464 change the tool-bar's height. */
12465 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12466 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12467 change_height_p
= 1;
12469 /* Resize windows as needed by changing the `tool-bar-lines'
12470 frame parameter. */
12471 if (change_height_p
)
12474 int new_height
= tool_bar_height (f
, &nrows
, 1);
12476 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12477 && !f
->minimize_tool_bar_window_p
)
12478 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12479 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12480 f
->minimize_tool_bar_window_p
= 0;
12482 if (change_height_p
)
12484 x_change_tool_bar_height (f
, new_height
);
12485 frame_default_tool_bar_height
= new_height
;
12486 clear_glyph_matrix (w
->desired_matrix
);
12487 f
->n_tool_bar_rows
= nrows
;
12488 f
->fonts_changed
= 1;
12495 f
->minimize_tool_bar_window_p
= 0;
12498 #endif /* USE_GTK || HAVE_NS */
12501 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12503 /* Get information about the tool-bar item which is displayed in GLYPH
12504 on frame F. Return in *PROP_IDX the index where tool-bar item
12505 properties start in F->tool_bar_items. Value is zero if
12506 GLYPH doesn't display a tool-bar item. */
12509 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12515 /* This function can be called asynchronously, which means we must
12516 exclude any possibility that Fget_text_property signals an
12518 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12519 charpos
= max (0, charpos
);
12521 /* Get the text property `menu-item' at pos. The value of that
12522 property is the start index of this item's properties in
12523 F->tool_bar_items. */
12524 prop
= Fget_text_property (make_number (charpos
),
12525 Qmenu_item
, f
->current_tool_bar_string
);
12526 if (INTEGERP (prop
))
12528 *prop_idx
= XINT (prop
);
12538 /* Get information about the tool-bar item at position X/Y on frame F.
12539 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12540 the current matrix of the tool-bar window of F, or NULL if not
12541 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12542 item in F->tool_bar_items. Value is
12544 -1 if X/Y is not on a tool-bar item
12545 0 if X/Y is on the same item that was highlighted before.
12549 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12550 int *hpos
, int *vpos
, int *prop_idx
)
12552 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12553 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12556 /* Find the glyph under X/Y. */
12557 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12558 if (*glyph
== NULL
)
12561 /* Get the start of this tool-bar item's properties in
12562 f->tool_bar_items. */
12563 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12566 /* Is mouse on the highlighted item? */
12567 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12568 && *vpos
>= hlinfo
->mouse_face_beg_row
12569 && *vpos
<= hlinfo
->mouse_face_end_row
12570 && (*vpos
> hlinfo
->mouse_face_beg_row
12571 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12572 && (*vpos
< hlinfo
->mouse_face_end_row
12573 || *hpos
< hlinfo
->mouse_face_end_col
12574 || hlinfo
->mouse_face_past_end
))
12582 Handle mouse button event on the tool-bar of frame F, at
12583 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12584 0 for button release. MODIFIERS is event modifiers for button
12588 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12591 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12592 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12593 int hpos
, vpos
, prop_idx
;
12594 struct glyph
*glyph
;
12595 Lisp_Object enabled_p
;
12598 /* If not on the highlighted tool-bar item, and mouse-highlight is
12599 non-nil, return. This is so we generate the tool-bar button
12600 click only when the mouse button is released on the same item as
12601 where it was pressed. However, when mouse-highlight is disabled,
12602 generate the click when the button is released regardless of the
12603 highlight, since tool-bar items are not highlighted in that
12605 frame_to_window_pixel_xy (w
, &x
, &y
);
12606 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12608 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12611 /* When mouse-highlight is off, generate the click for the item
12612 where the button was pressed, disregarding where it was
12614 if (NILP (Vmouse_highlight
) && !down_p
)
12615 prop_idx
= f
->last_tool_bar_item
;
12617 /* If item is disabled, do nothing. */
12618 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12619 if (NILP (enabled_p
))
12624 /* Show item in pressed state. */
12625 if (!NILP (Vmouse_highlight
))
12626 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12627 f
->last_tool_bar_item
= prop_idx
;
12631 Lisp_Object key
, frame
;
12632 struct input_event event
;
12633 EVENT_INIT (event
);
12635 /* Show item in released state. */
12636 if (!NILP (Vmouse_highlight
))
12637 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12639 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12641 XSETFRAME (frame
, f
);
12642 event
.kind
= TOOL_BAR_EVENT
;
12643 event
.frame_or_window
= frame
;
12645 kbd_buffer_store_event (&event
);
12647 event
.kind
= TOOL_BAR_EVENT
;
12648 event
.frame_or_window
= frame
;
12650 event
.modifiers
= modifiers
;
12651 kbd_buffer_store_event (&event
);
12652 f
->last_tool_bar_item
= -1;
12657 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12658 tool-bar window-relative coordinates X/Y. Called from
12659 note_mouse_highlight. */
12662 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12664 Lisp_Object window
= f
->tool_bar_window
;
12665 struct window
*w
= XWINDOW (window
);
12666 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12667 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12669 struct glyph
*glyph
;
12670 struct glyph_row
*row
;
12672 Lisp_Object enabled_p
;
12674 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12675 int mouse_down_p
, rc
;
12677 /* Function note_mouse_highlight is called with negative X/Y
12678 values when mouse moves outside of the frame. */
12679 if (x
<= 0 || y
<= 0)
12681 clear_mouse_face (hlinfo
);
12685 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12688 /* Not on tool-bar item. */
12689 clear_mouse_face (hlinfo
);
12693 /* On same tool-bar item as before. */
12694 goto set_help_echo
;
12696 clear_mouse_face (hlinfo
);
12698 /* Mouse is down, but on different tool-bar item? */
12699 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12700 && f
== dpyinfo
->last_mouse_frame
);
12702 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12705 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12707 /* If tool-bar item is not enabled, don't highlight it. */
12708 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12709 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12711 /* Compute the x-position of the glyph. In front and past the
12712 image is a space. We include this in the highlighted area. */
12713 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12714 for (i
= x
= 0; i
< hpos
; ++i
)
12715 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12717 /* Record this as the current active region. */
12718 hlinfo
->mouse_face_beg_col
= hpos
;
12719 hlinfo
->mouse_face_beg_row
= vpos
;
12720 hlinfo
->mouse_face_beg_x
= x
;
12721 hlinfo
->mouse_face_past_end
= 0;
12723 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12724 hlinfo
->mouse_face_end_row
= vpos
;
12725 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12726 hlinfo
->mouse_face_window
= window
;
12727 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12729 /* Display it as active. */
12730 show_mouse_face (hlinfo
, draw
);
12735 /* Set help_echo_string to a help string to display for this tool-bar item.
12736 XTread_socket does the rest. */
12737 help_echo_object
= help_echo_window
= Qnil
;
12738 help_echo_pos
= -1;
12739 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12740 if (NILP (help_echo_string
))
12741 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12744 #endif /* !USE_GTK && !HAVE_NS */
12746 #endif /* HAVE_WINDOW_SYSTEM */
12750 /************************************************************************
12751 Horizontal scrolling
12752 ************************************************************************/
12754 static int hscroll_window_tree (Lisp_Object
);
12755 static int hscroll_windows (Lisp_Object
);
12757 /* For all leaf windows in the window tree rooted at WINDOW, set their
12758 hscroll value so that PT is (i) visible in the window, and (ii) so
12759 that it is not within a certain margin at the window's left and
12760 right border. Value is non-zero if any window's hscroll has been
12764 hscroll_window_tree (Lisp_Object window
)
12766 int hscrolled_p
= 0;
12767 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12768 int hscroll_step_abs
= 0;
12769 double hscroll_step_rel
= 0;
12771 if (hscroll_relative_p
)
12773 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12774 if (hscroll_step_rel
< 0)
12776 hscroll_relative_p
= 0;
12777 hscroll_step_abs
= 0;
12780 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12782 hscroll_step_abs
= XINT (Vhscroll_step
);
12783 if (hscroll_step_abs
< 0)
12784 hscroll_step_abs
= 0;
12787 hscroll_step_abs
= 0;
12789 while (WINDOWP (window
))
12791 struct window
*w
= XWINDOW (window
);
12793 if (WINDOWP (w
->contents
))
12794 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12795 else if (w
->cursor
.vpos
>= 0)
12798 int text_area_width
;
12799 struct glyph_row
*cursor_row
;
12800 struct glyph_row
*bottom_row
;
12803 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12804 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12805 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12807 cursor_row
= bottom_row
- 1;
12809 if (!cursor_row
->enabled_p
)
12811 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12812 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12813 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12815 cursor_row
= bottom_row
- 1;
12817 row_r2l_p
= cursor_row
->reversed_p
;
12819 text_area_width
= window_box_width (w
, TEXT_AREA
);
12821 /* Scroll when cursor is inside this scroll margin. */
12822 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12824 /* If the position of this window's point has explicitly
12825 changed, no more suspend auto hscrolling. */
12826 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12827 w
->suspend_auto_hscroll
= 0;
12829 /* Remember window point. */
12830 Fset_marker (w
->old_pointm
,
12831 ((w
== XWINDOW (selected_window
))
12832 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12833 : Fmarker_position (w
->pointm
)),
12836 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12837 && w
->suspend_auto_hscroll
== 0
12838 /* In some pathological cases, like restoring a window
12839 configuration into a frame that is much smaller than
12840 the one from which the configuration was saved, we
12841 get glyph rows whose start and end have zero buffer
12842 positions, which we cannot handle below. Just skip
12844 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12845 /* For left-to-right rows, hscroll when cursor is either
12846 (i) inside the right hscroll margin, or (ii) if it is
12847 inside the left margin and the window is already
12850 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12851 || (cursor_row
->enabled_p
12852 && cursor_row
->truncated_on_right_p
12853 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12854 /* For right-to-left rows, the logic is similar,
12855 except that rules for scrolling to left and right
12856 are reversed. E.g., if cursor.x <= h_margin, we
12857 need to hscroll "to the right" unconditionally,
12858 and that will scroll the screen to the left so as
12859 to reveal the next portion of the row. */
12861 && ((cursor_row
->enabled_p
12862 /* FIXME: It is confusing to set the
12863 truncated_on_right_p flag when R2L rows
12864 are actually truncated on the left. */
12865 && cursor_row
->truncated_on_right_p
12866 && w
->cursor
.x
<= h_margin
)
12868 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12872 struct buffer
*saved_current_buffer
;
12876 /* Find point in a display of infinite width. */
12877 saved_current_buffer
= current_buffer
;
12878 current_buffer
= XBUFFER (w
->contents
);
12880 if (w
== XWINDOW (selected_window
))
12883 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12885 /* Move iterator to pt starting at cursor_row->start in
12886 a line with infinite width. */
12887 init_to_row_start (&it
, w
, cursor_row
);
12888 it
.last_visible_x
= INFINITY
;
12889 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12890 current_buffer
= saved_current_buffer
;
12892 /* Position cursor in window. */
12893 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12894 hscroll
= max (0, (it
.current_x
12895 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12896 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12897 : (text_area_width
/ 2))))
12898 / FRAME_COLUMN_WIDTH (it
.f
);
12899 else if ((!row_r2l_p
12900 && w
->cursor
.x
>= text_area_width
- h_margin
)
12901 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12903 if (hscroll_relative_p
)
12904 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12907 wanted_x
= text_area_width
12908 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12911 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12915 if (hscroll_relative_p
)
12916 wanted_x
= text_area_width
* hscroll_step_rel
12919 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12922 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12924 hscroll
= max (hscroll
, w
->min_hscroll
);
12926 /* Don't prevent redisplay optimizations if hscroll
12927 hasn't changed, as it will unnecessarily slow down
12929 if (w
->hscroll
!= hscroll
)
12931 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12932 w
->hscroll
= hscroll
;
12941 /* Value is non-zero if hscroll of any leaf window has been changed. */
12942 return hscrolled_p
;
12946 /* Set hscroll so that cursor is visible and not inside horizontal
12947 scroll margins for all windows in the tree rooted at WINDOW. See
12948 also hscroll_window_tree above. Value is non-zero if any window's
12949 hscroll has been changed. If it has, desired matrices on the frame
12950 of WINDOW are cleared. */
12953 hscroll_windows (Lisp_Object window
)
12955 int hscrolled_p
= hscroll_window_tree (window
);
12957 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12958 return hscrolled_p
;
12963 /************************************************************************
12965 ************************************************************************/
12967 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12968 to a non-zero value. This is sometimes handy to have in a debugger
12973 /* First and last unchanged row for try_window_id. */
12975 static int debug_first_unchanged_at_end_vpos
;
12976 static int debug_last_unchanged_at_beg_vpos
;
12978 /* Delta vpos and y. */
12980 static int debug_dvpos
, debug_dy
;
12982 /* Delta in characters and bytes for try_window_id. */
12984 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12986 /* Values of window_end_pos and window_end_vpos at the end of
12989 static ptrdiff_t debug_end_vpos
;
12991 /* Append a string to W->desired_matrix->method. FMT is a printf
12992 format string. If trace_redisplay_p is true also printf the
12993 resulting string to stderr. */
12995 static void debug_method_add (struct window
*, char const *, ...)
12996 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12999 debug_method_add (struct window
*w
, char const *fmt
, ...)
13002 char *method
= w
->desired_matrix
->method
;
13003 int len
= strlen (method
);
13004 int size
= sizeof w
->desired_matrix
->method
;
13005 int remaining
= size
- len
- 1;
13008 if (len
&& remaining
)
13011 --remaining
, ++len
;
13014 va_start (ap
, fmt
);
13015 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13018 if (trace_redisplay_p
)
13019 fprintf (stderr
, "%p (%s): %s\n",
13021 ((BUFFERP (w
->contents
)
13022 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13023 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13028 #endif /* GLYPH_DEBUG */
13031 /* Value is non-zero if all changes in window W, which displays
13032 current_buffer, are in the text between START and END. START is a
13033 buffer position, END is given as a distance from Z. Used in
13034 redisplay_internal for display optimization. */
13037 text_outside_line_unchanged_p (struct window
*w
,
13038 ptrdiff_t start
, ptrdiff_t end
)
13040 int unchanged_p
= 1;
13042 /* If text or overlays have changed, see where. */
13043 if (window_outdated (w
))
13045 /* Gap in the line? */
13046 if (GPT
< start
|| Z
- GPT
< end
)
13049 /* Changes start in front of the line, or end after it? */
13051 && (BEG_UNCHANGED
< start
- 1
13052 || END_UNCHANGED
< end
))
13055 /* If selective display, can't optimize if changes start at the
13056 beginning of the line. */
13058 && INTEGERP (BVAR (current_buffer
, selective_display
))
13059 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13060 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13063 /* If there are overlays at the start or end of the line, these
13064 may have overlay strings with newlines in them. A change at
13065 START, for instance, may actually concern the display of such
13066 overlay strings as well, and they are displayed on different
13067 lines. So, quickly rule out this case. (For the future, it
13068 might be desirable to implement something more telling than
13069 just BEG/END_UNCHANGED.) */
13072 if (BEG
+ BEG_UNCHANGED
== start
13073 && overlay_touches_p (start
))
13075 if (END_UNCHANGED
== end
13076 && overlay_touches_p (Z
- end
))
13080 /* Under bidi reordering, adding or deleting a character in the
13081 beginning of a paragraph, before the first strong directional
13082 character, can change the base direction of the paragraph (unless
13083 the buffer specifies a fixed paragraph direction), which will
13084 require to redisplay the whole paragraph. It might be worthwhile
13085 to find the paragraph limits and widen the range of redisplayed
13086 lines to that, but for now just give up this optimization. */
13087 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13088 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13092 return unchanged_p
;
13096 /* Do a frame update, taking possible shortcuts into account. This is
13097 the main external entry point for redisplay.
13099 If the last redisplay displayed an echo area message and that message
13100 is no longer requested, we clear the echo area or bring back the
13101 mini-buffer if that is in use. */
13106 redisplay_internal ();
13111 overlay_arrow_string_or_property (Lisp_Object var
)
13115 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13118 return Voverlay_arrow_string
;
13121 /* Return 1 if there are any overlay-arrows in current_buffer. */
13123 overlay_arrow_in_current_buffer_p (void)
13127 for (vlist
= Voverlay_arrow_variable_list
;
13129 vlist
= XCDR (vlist
))
13131 Lisp_Object var
= XCAR (vlist
);
13134 if (!SYMBOLP (var
))
13136 val
= find_symbol_value (var
);
13138 && current_buffer
== XMARKER (val
)->buffer
)
13145 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13149 overlay_arrows_changed_p (void)
13153 for (vlist
= Voverlay_arrow_variable_list
;
13155 vlist
= XCDR (vlist
))
13157 Lisp_Object var
= XCAR (vlist
);
13158 Lisp_Object val
, pstr
;
13160 if (!SYMBOLP (var
))
13162 val
= find_symbol_value (var
);
13163 if (!MARKERP (val
))
13165 if (! EQ (COERCE_MARKER (val
),
13166 Fget (var
, Qlast_arrow_position
))
13167 || ! (pstr
= overlay_arrow_string_or_property (var
),
13168 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13174 /* Mark overlay arrows to be updated on next redisplay. */
13177 update_overlay_arrows (int up_to_date
)
13181 for (vlist
= Voverlay_arrow_variable_list
;
13183 vlist
= XCDR (vlist
))
13185 Lisp_Object var
= XCAR (vlist
);
13187 if (!SYMBOLP (var
))
13190 if (up_to_date
> 0)
13192 Lisp_Object val
= find_symbol_value (var
);
13193 Fput (var
, Qlast_arrow_position
,
13194 COERCE_MARKER (val
));
13195 Fput (var
, Qlast_arrow_string
,
13196 overlay_arrow_string_or_property (var
));
13198 else if (up_to_date
< 0
13199 || !NILP (Fget (var
, Qlast_arrow_position
)))
13201 Fput (var
, Qlast_arrow_position
, Qt
);
13202 Fput (var
, Qlast_arrow_string
, Qt
);
13208 /* Return overlay arrow string to display at row.
13209 Return integer (bitmap number) for arrow bitmap in left fringe.
13210 Return nil if no overlay arrow. */
13213 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13217 for (vlist
= Voverlay_arrow_variable_list
;
13219 vlist
= XCDR (vlist
))
13221 Lisp_Object var
= XCAR (vlist
);
13224 if (!SYMBOLP (var
))
13227 val
= find_symbol_value (var
);
13230 && current_buffer
== XMARKER (val
)->buffer
13231 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13233 if (FRAME_WINDOW_P (it
->f
)
13234 /* FIXME: if ROW->reversed_p is set, this should test
13235 the right fringe, not the left one. */
13236 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13238 #ifdef HAVE_WINDOW_SYSTEM
13239 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13242 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13243 return make_number (fringe_bitmap
);
13246 return make_number (-1); /* Use default arrow bitmap. */
13248 return overlay_arrow_string_or_property (var
);
13255 /* Return 1 if point moved out of or into a composition. Otherwise
13256 return 0. PREV_BUF and PREV_PT are the last point buffer and
13257 position. BUF and PT are the current point buffer and position. */
13260 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13261 struct buffer
*buf
, ptrdiff_t pt
)
13263 ptrdiff_t start
, end
;
13265 Lisp_Object buffer
;
13267 XSETBUFFER (buffer
, buf
);
13268 /* Check a composition at the last point if point moved within the
13270 if (prev_buf
== buf
)
13273 /* Point didn't move. */
13276 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13277 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13278 && composition_valid_p (start
, end
, prop
)
13279 && start
< prev_pt
&& end
> prev_pt
)
13280 /* The last point was within the composition. Return 1 iff
13281 point moved out of the composition. */
13282 return (pt
<= start
|| pt
>= end
);
13285 /* Check a composition at the current point. */
13286 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13287 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13288 && composition_valid_p (start
, end
, prop
)
13289 && start
< pt
&& end
> pt
);
13292 /* Reconsider the clip changes of buffer which is displayed in W. */
13295 reconsider_clip_changes (struct window
*w
)
13297 struct buffer
*b
= XBUFFER (w
->contents
);
13299 if (b
->clip_changed
13300 && w
->window_end_valid
13301 && w
->current_matrix
->buffer
== b
13302 && w
->current_matrix
->zv
== BUF_ZV (b
)
13303 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13304 b
->clip_changed
= 0;
13306 /* If display wasn't paused, and W is not a tool bar window, see if
13307 point has been moved into or out of a composition. In that case,
13308 we set b->clip_changed to 1 to force updating the screen. If
13309 b->clip_changed has already been set to 1, we can skip this
13311 if (!b
->clip_changed
&& w
->window_end_valid
)
13313 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13314 ? PT
: marker_position (w
->pointm
));
13316 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13317 && check_point_in_composition (w
->current_matrix
->buffer
,
13318 w
->last_point
, b
, pt
))
13319 b
->clip_changed
= 1;
13324 propagate_buffer_redisplay (void)
13325 { /* Resetting b->text->redisplay is problematic!
13326 We can't just reset it in the case that some window that displays
13327 it has not been redisplayed; and such a window can stay
13328 unredisplayed for a long time if it's currently invisible.
13329 But we do want to reset it at the end of redisplay otherwise
13330 its displayed windows will keep being redisplayed over and over
13332 So we copy all b->text->redisplay flags up to their windows here,
13333 such that mark_window_display_accurate can safely reset
13334 b->text->redisplay. */
13335 Lisp_Object ws
= window_list ();
13336 for (; CONSP (ws
); ws
= XCDR (ws
))
13338 struct window
*thisw
= XWINDOW (XCAR (ws
));
13339 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13340 if (thisb
->text
->redisplay
)
13341 thisw
->redisplay
= true;
13345 #define STOP_POLLING \
13346 do { if (! polling_stopped_here) stop_polling (); \
13347 polling_stopped_here = 1; } while (0)
13349 #define RESUME_POLLING \
13350 do { if (polling_stopped_here) start_polling (); \
13351 polling_stopped_here = 0; } while (0)
13354 /* Perhaps in the future avoid recentering windows if it
13355 is not necessary; currently that causes some problems. */
13358 redisplay_internal (void)
13360 struct window
*w
= XWINDOW (selected_window
);
13364 bool must_finish
= 0, match_p
;
13365 struct text_pos tlbufpos
, tlendpos
;
13366 int number_of_visible_frames
;
13369 int polling_stopped_here
= 0;
13370 Lisp_Object tail
, frame
;
13372 /* True means redisplay has to consider all windows on all
13373 frames. False, only selected_window is considered. */
13374 bool consider_all_windows_p
;
13376 /* True means redisplay has to redisplay the miniwindow. */
13377 bool update_miniwindow_p
= false;
13379 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13381 /* No redisplay if running in batch mode or frame is not yet fully
13382 initialized, or redisplay is explicitly turned off by setting
13383 Vinhibit_redisplay. */
13384 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13385 || !NILP (Vinhibit_redisplay
))
13388 /* Don't examine these until after testing Vinhibit_redisplay.
13389 When Emacs is shutting down, perhaps because its connection to
13390 X has dropped, we should not look at them at all. */
13391 fr
= XFRAME (w
->frame
);
13392 sf
= SELECTED_FRAME ();
13394 if (!fr
->glyphs_initialized_p
)
13397 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13398 if (popup_activated ())
13402 /* I don't think this happens but let's be paranoid. */
13403 if (redisplaying_p
)
13406 /* Record a function that clears redisplaying_p
13407 when we leave this function. */
13408 count
= SPECPDL_INDEX ();
13409 record_unwind_protect_void (unwind_redisplay
);
13410 redisplaying_p
= 1;
13411 specbind (Qinhibit_free_realized_faces
, Qnil
);
13413 /* Record this function, so it appears on the profiler's backtraces. */
13414 record_in_backtrace (Qredisplay_internal
, 0, 0);
13416 FOR_EACH_FRAME (tail
, frame
)
13417 XFRAME (frame
)->already_hscrolled_p
= 0;
13420 /* Remember the currently selected window. */
13424 last_escape_glyph_frame
= NULL
;
13425 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13426 last_glyphless_glyph_frame
= NULL
;
13427 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13429 /* If face_change, init_iterator will free all realized faces, which
13430 includes the faces referenced from current matrices. So, we
13431 can't reuse current matrices in this case. */
13433 windows_or_buffers_changed
= 47;
13435 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13436 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13438 /* Since frames on a single ASCII terminal share the same
13439 display area, displaying a different frame means redisplay
13440 the whole thing. */
13441 SET_FRAME_GARBAGED (sf
);
13443 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13445 FRAME_TTY (sf
)->previous_frame
= sf
;
13448 /* Set the visible flags for all frames. Do this before checking for
13449 resized or garbaged frames; they want to know if their frames are
13450 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13451 number_of_visible_frames
= 0;
13453 FOR_EACH_FRAME (tail
, frame
)
13455 struct frame
*f
= XFRAME (frame
);
13457 if (FRAME_VISIBLE_P (f
))
13459 ++number_of_visible_frames
;
13460 /* Adjust matrices for visible frames only. */
13461 if (f
->fonts_changed
)
13463 adjust_frame_glyphs (f
);
13464 f
->fonts_changed
= 0;
13466 /* If cursor type has been changed on the frame
13467 other than selected, consider all frames. */
13468 if (f
!= sf
&& f
->cursor_type_changed
)
13469 update_mode_lines
= 31;
13471 clear_desired_matrices (f
);
13474 /* Notice any pending interrupt request to change frame size. */
13475 do_pending_window_change (true);
13477 /* do_pending_window_change could change the selected_window due to
13478 frame resizing which makes the selected window too small. */
13479 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13482 /* Clear frames marked as garbaged. */
13483 clear_garbaged_frames ();
13485 /* Build menubar and tool-bar items. */
13486 if (NILP (Vmemory_full
))
13487 prepare_menu_bars ();
13489 reconsider_clip_changes (w
);
13491 /* In most cases selected window displays current buffer. */
13492 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13495 /* Detect case that we need to write or remove a star in the mode line. */
13496 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13497 w
->update_mode_line
= 1;
13499 if (mode_line_update_needed (w
))
13500 w
->update_mode_line
= 1;
13502 /* If reconsider_clip_changes above decided that the narrowing
13503 in the current buffer changed, make sure all other windows
13504 showing that buffer will be redisplayed. */
13505 if (current_buffer
->clip_changed
)
13506 bset_update_mode_line (current_buffer
);
13509 /* Normally the message* functions will have already displayed and
13510 updated the echo area, but the frame may have been trashed, or
13511 the update may have been preempted, so display the echo area
13512 again here. Checking message_cleared_p captures the case that
13513 the echo area should be cleared. */
13514 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13515 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13516 || (message_cleared_p
13517 && minibuf_level
== 0
13518 /* If the mini-window is currently selected, this means the
13519 echo-area doesn't show through. */
13520 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13522 int window_height_changed_p
= echo_area_display (false);
13524 if (message_cleared_p
)
13525 update_miniwindow_p
= true;
13529 /* If we don't display the current message, don't clear the
13530 message_cleared_p flag, because, if we did, we wouldn't clear
13531 the echo area in the next redisplay which doesn't preserve
13533 if (!display_last_displayed_message_p
)
13534 message_cleared_p
= 0;
13536 if (window_height_changed_p
)
13538 windows_or_buffers_changed
= 50;
13540 /* If window configuration was changed, frames may have been
13541 marked garbaged. Clear them or we will experience
13542 surprises wrt scrolling. */
13543 clear_garbaged_frames ();
13546 else if (EQ (selected_window
, minibuf_window
)
13547 && (current_buffer
->clip_changed
|| window_outdated (w
))
13548 && resize_mini_window (w
, 0))
13550 /* Resized active mini-window to fit the size of what it is
13551 showing if its contents might have changed. */
13554 /* If window configuration was changed, frames may have been
13555 marked garbaged. Clear them or we will experience
13556 surprises wrt scrolling. */
13557 clear_garbaged_frames ();
13560 if (windows_or_buffers_changed
&& !update_mode_lines
)
13561 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13562 only the windows's contents needs to be refreshed, or whether the
13563 mode-lines also need a refresh. */
13564 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13565 ? REDISPLAY_SOME
: 32);
13567 /* If specs for an arrow have changed, do thorough redisplay
13568 to ensure we remove any arrow that should no longer exist. */
13569 if (overlay_arrows_changed_p ())
13570 /* Apparently, this is the only case where we update other windows,
13571 without updating other mode-lines. */
13572 windows_or_buffers_changed
= 49;
13574 consider_all_windows_p
= (update_mode_lines
13575 || windows_or_buffers_changed
);
13577 #define AINC(a,i) \
13578 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13579 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13581 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13582 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13584 /* Optimize the case that only the line containing the cursor in the
13585 selected window has changed. Variables starting with this_ are
13586 set in display_line and record information about the line
13587 containing the cursor. */
13588 tlbufpos
= this_line_start_pos
;
13589 tlendpos
= this_line_end_pos
;
13590 if (!consider_all_windows_p
13591 && CHARPOS (tlbufpos
) > 0
13592 && !w
->update_mode_line
13593 && !current_buffer
->clip_changed
13594 && !current_buffer
->prevent_redisplay_optimizations_p
13595 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13596 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13597 && !XFRAME (w
->frame
)->cursor_type_changed
13598 /* Make sure recorded data applies to current buffer, etc. */
13599 && this_line_buffer
== current_buffer
13602 && !w
->optional_new_start
13603 /* Point must be on the line that we have info recorded about. */
13604 && PT
>= CHARPOS (tlbufpos
)
13605 && PT
<= Z
- CHARPOS (tlendpos
)
13606 /* All text outside that line, including its final newline,
13607 must be unchanged. */
13608 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13609 CHARPOS (tlendpos
)))
13611 if (CHARPOS (tlbufpos
) > BEGV
13612 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13613 && (CHARPOS (tlbufpos
) == ZV
13614 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13615 /* Former continuation line has disappeared by becoming empty. */
13617 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13619 /* We have to handle the case of continuation around a
13620 wide-column character (see the comment in indent.c around
13623 For instance, in the following case:
13625 -------- Insert --------
13626 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13627 J_I_ ==> J_I_ `^^' are cursors.
13631 As we have to redraw the line above, we cannot use this
13635 int line_height_before
= this_line_pixel_height
;
13637 /* Note that start_display will handle the case that the
13638 line starting at tlbufpos is a continuation line. */
13639 start_display (&it
, w
, tlbufpos
);
13641 /* Implementation note: It this still necessary? */
13642 if (it
.current_x
!= this_line_start_x
)
13645 TRACE ((stderr
, "trying display optimization 1\n"));
13646 w
->cursor
.vpos
= -1;
13647 overlay_arrow_seen
= 0;
13648 it
.vpos
= this_line_vpos
;
13649 it
.current_y
= this_line_y
;
13650 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13651 display_line (&it
);
13653 /* If line contains point, is not continued,
13654 and ends at same distance from eob as before, we win. */
13655 if (w
->cursor
.vpos
>= 0
13656 /* Line is not continued, otherwise this_line_start_pos
13657 would have been set to 0 in display_line. */
13658 && CHARPOS (this_line_start_pos
)
13659 /* Line ends as before. */
13660 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13661 /* Line has same height as before. Otherwise other lines
13662 would have to be shifted up or down. */
13663 && this_line_pixel_height
== line_height_before
)
13665 /* If this is not the window's last line, we must adjust
13666 the charstarts of the lines below. */
13667 if (it
.current_y
< it
.last_visible_y
)
13669 struct glyph_row
*row
13670 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13671 ptrdiff_t delta
, delta_bytes
;
13673 /* We used to distinguish between two cases here,
13674 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13675 when the line ends in a newline or the end of the
13676 buffer's accessible portion. But both cases did
13677 the same, so they were collapsed. */
13679 - CHARPOS (tlendpos
)
13680 - MATRIX_ROW_START_CHARPOS (row
));
13681 delta_bytes
= (Z_BYTE
13682 - BYTEPOS (tlendpos
)
13683 - MATRIX_ROW_START_BYTEPOS (row
));
13685 increment_matrix_positions (w
->current_matrix
,
13686 this_line_vpos
+ 1,
13687 w
->current_matrix
->nrows
,
13688 delta
, delta_bytes
);
13691 /* If this row displays text now but previously didn't,
13692 or vice versa, w->window_end_vpos may have to be
13694 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13696 if (w
->window_end_vpos
< this_line_vpos
)
13697 w
->window_end_vpos
= this_line_vpos
;
13699 else if (w
->window_end_vpos
== this_line_vpos
13700 && this_line_vpos
> 0)
13701 w
->window_end_vpos
= this_line_vpos
- 1;
13702 w
->window_end_valid
= 0;
13704 /* Update hint: No need to try to scroll in update_window. */
13705 w
->desired_matrix
->no_scrolling_p
= 1;
13708 *w
->desired_matrix
->method
= 0;
13709 debug_method_add (w
, "optimization 1");
13711 #ifdef HAVE_WINDOW_SYSTEM
13712 update_window_fringes (w
, 0);
13719 else if (/* Cursor position hasn't changed. */
13720 PT
== w
->last_point
13721 /* Make sure the cursor was last displayed
13722 in this window. Otherwise we have to reposition it. */
13724 /* PXW: Must be converted to pixels, probably. */
13725 && 0 <= w
->cursor
.vpos
13726 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13730 do_pending_window_change (true);
13731 /* If selected_window changed, redisplay again. */
13732 if (WINDOWP (selected_window
)
13733 && (w
= XWINDOW (selected_window
)) != sw
)
13736 /* We used to always goto end_of_redisplay here, but this
13737 isn't enough if we have a blinking cursor. */
13738 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13739 goto end_of_redisplay
;
13743 /* If highlighting the region, or if the cursor is in the echo area,
13744 then we can't just move the cursor. */
13745 else if (NILP (Vshow_trailing_whitespace
)
13746 && !cursor_in_echo_area
)
13749 struct glyph_row
*row
;
13751 /* Skip from tlbufpos to PT and see where it is. Note that
13752 PT may be in invisible text. If so, we will end at the
13753 next visible position. */
13754 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13755 NULL
, DEFAULT_FACE_ID
);
13756 it
.current_x
= this_line_start_x
;
13757 it
.current_y
= this_line_y
;
13758 it
.vpos
= this_line_vpos
;
13760 /* The call to move_it_to stops in front of PT, but
13761 moves over before-strings. */
13762 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13764 if (it
.vpos
== this_line_vpos
13765 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13768 eassert (this_line_vpos
== it
.vpos
);
13769 eassert (this_line_y
== it
.current_y
);
13770 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13772 *w
->desired_matrix
->method
= 0;
13773 debug_method_add (w
, "optimization 3");
13782 /* Text changed drastically or point moved off of line. */
13783 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13786 CHARPOS (this_line_start_pos
) = 0;
13787 ++clear_face_cache_count
;
13788 #ifdef HAVE_WINDOW_SYSTEM
13789 ++clear_image_cache_count
;
13792 /* Build desired matrices, and update the display. If
13793 consider_all_windows_p is non-zero, do it for all windows on all
13794 frames. Otherwise do it for selected_window, only. */
13796 if (consider_all_windows_p
)
13798 FOR_EACH_FRAME (tail
, frame
)
13799 XFRAME (frame
)->updated_p
= 0;
13801 propagate_buffer_redisplay ();
13803 FOR_EACH_FRAME (tail
, frame
)
13805 struct frame
*f
= XFRAME (frame
);
13807 /* We don't have to do anything for unselected terminal
13809 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13810 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13815 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_GTK) && !defined (HAVE_NS)
13816 /* Redisplay internal tool bar if this is the first time so we
13817 can adjust the frame height right now, if necessary. */
13818 if (!f
->tool_bar_redisplayed_once
)
13820 if (redisplay_tool_bar (f
))
13821 adjust_frame_glyphs (f
);
13822 f
->tool_bar_redisplayed_once
= true;
13826 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13829 /* Only GC scrollbars when we redisplay the whole frame. */
13830 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13831 /* Mark all the scroll bars to be removed; we'll redeem
13832 the ones we want when we redisplay their windows. */
13833 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13834 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13836 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13837 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13838 /* Remember that the invisible frames need to be redisplayed next
13839 time they're visible. */
13840 else if (!REDISPLAY_SOME_P ())
13841 f
->redisplay
= true;
13843 /* The X error handler may have deleted that frame. */
13844 if (!FRAME_LIVE_P (f
))
13847 /* Any scroll bars which redisplay_windows should have
13848 nuked should now go away. */
13849 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13850 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13852 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13854 /* If fonts changed on visible frame, display again. */
13855 if (f
->fonts_changed
)
13857 adjust_frame_glyphs (f
);
13858 f
->fonts_changed
= false;
13862 /* See if we have to hscroll. */
13863 if (!f
->already_hscrolled_p
)
13865 f
->already_hscrolled_p
= true;
13866 if (hscroll_windows (f
->root_window
))
13870 /* Prevent various kinds of signals during display
13871 update. stdio is not robust about handling
13872 signals, which can cause an apparent I/O error. */
13873 if (interrupt_input
)
13874 unrequest_sigio ();
13877 pending
|= update_frame (f
, false, false);
13878 f
->cursor_type_changed
= false;
13879 f
->updated_p
= true;
13884 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13888 /* Do the mark_window_display_accurate after all windows have
13889 been redisplayed because this call resets flags in buffers
13890 which are needed for proper redisplay. */
13891 FOR_EACH_FRAME (tail
, frame
)
13893 struct frame
*f
= XFRAME (frame
);
13896 f
->redisplay
= false;
13897 mark_window_display_accurate (f
->root_window
, 1);
13898 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13899 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13904 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13906 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13907 struct frame
*mini_frame
;
13909 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13910 /* Use list_of_error, not Qerror, so that
13911 we catch only errors and don't run the debugger. */
13912 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13914 redisplay_window_error
);
13915 if (update_miniwindow_p
)
13916 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13918 redisplay_window_error
);
13920 /* Compare desired and current matrices, perform output. */
13923 /* If fonts changed, display again. */
13924 if (sf
->fonts_changed
)
13927 /* Prevent various kinds of signals during display update.
13928 stdio is not robust about handling signals,
13929 which can cause an apparent I/O error. */
13930 if (interrupt_input
)
13931 unrequest_sigio ();
13934 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13936 if (hscroll_windows (selected_window
))
13939 XWINDOW (selected_window
)->must_be_updated_p
= true;
13940 pending
= update_frame (sf
, false, false);
13941 sf
->cursor_type_changed
= false;
13944 /* We may have called echo_area_display at the top of this
13945 function. If the echo area is on another frame, that may
13946 have put text on a frame other than the selected one, so the
13947 above call to update_frame would not have caught it. Catch
13949 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13950 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13952 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13954 XWINDOW (mini_window
)->must_be_updated_p
= true;
13955 pending
|= update_frame (mini_frame
, false, false);
13956 mini_frame
->cursor_type_changed
= false;
13957 if (!pending
&& hscroll_windows (mini_window
))
13962 /* If display was paused because of pending input, make sure we do a
13963 thorough update the next time. */
13966 /* Prevent the optimization at the beginning of
13967 redisplay_internal that tries a single-line update of the
13968 line containing the cursor in the selected window. */
13969 CHARPOS (this_line_start_pos
) = 0;
13971 /* Let the overlay arrow be updated the next time. */
13972 update_overlay_arrows (0);
13974 /* If we pause after scrolling, some rows in the current
13975 matrices of some windows are not valid. */
13976 if (!WINDOW_FULL_WIDTH_P (w
)
13977 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13978 update_mode_lines
= 36;
13982 if (!consider_all_windows_p
)
13984 /* This has already been done above if
13985 consider_all_windows_p is set. */
13986 if (XBUFFER (w
->contents
)->text
->redisplay
13987 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13988 /* This can happen if b->text->redisplay was set during
13990 propagate_buffer_redisplay ();
13991 mark_window_display_accurate_1 (w
, 1);
13993 /* Say overlay arrows are up to date. */
13994 update_overlay_arrows (1);
13996 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13997 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14000 update_mode_lines
= 0;
14001 windows_or_buffers_changed
= 0;
14004 /* Start SIGIO interrupts coming again. Having them off during the
14005 code above makes it less likely one will discard output, but not
14006 impossible, since there might be stuff in the system buffer here.
14007 But it is much hairier to try to do anything about that. */
14008 if (interrupt_input
)
14012 /* If a frame has become visible which was not before, redisplay
14013 again, so that we display it. Expose events for such a frame
14014 (which it gets when becoming visible) don't call the parts of
14015 redisplay constructing glyphs, so simply exposing a frame won't
14016 display anything in this case. So, we have to display these
14017 frames here explicitly. */
14022 FOR_EACH_FRAME (tail
, frame
)
14024 if (XFRAME (frame
)->visible
)
14028 if (new_count
!= number_of_visible_frames
)
14029 windows_or_buffers_changed
= 52;
14032 /* Change frame size now if a change is pending. */
14033 do_pending_window_change (true);
14035 /* If we just did a pending size change, or have additional
14036 visible frames, or selected_window changed, redisplay again. */
14037 if ((windows_or_buffers_changed
&& !pending
)
14038 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14041 /* Clear the face and image caches.
14043 We used to do this only if consider_all_windows_p. But the cache
14044 needs to be cleared if a timer creates images in the current
14045 buffer (e.g. the test case in Bug#6230). */
14047 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14049 clear_face_cache (false);
14050 clear_face_cache_count
= 0;
14053 #ifdef HAVE_WINDOW_SYSTEM
14054 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14056 clear_image_caches (Qnil
);
14057 clear_image_cache_count
= 0;
14059 #endif /* HAVE_WINDOW_SYSTEM */
14063 ns_set_doc_edited ();
14065 if (interrupt_input
&& interrupts_deferred
)
14068 unbind_to (count
, Qnil
);
14073 /* Redisplay, but leave alone any recent echo area message unless
14074 another message has been requested in its place.
14076 This is useful in situations where you need to redisplay but no
14077 user action has occurred, making it inappropriate for the message
14078 area to be cleared. See tracking_off and
14079 wait_reading_process_output for examples of these situations.
14081 FROM_WHERE is an integer saying from where this function was
14082 called. This is useful for debugging. */
14085 redisplay_preserve_echo_area (int from_where
)
14087 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14089 if (!NILP (echo_area_buffer
[1]))
14091 /* We have a previously displayed message, but no current
14092 message. Redisplay the previous message. */
14093 display_last_displayed_message_p
= true;
14094 redisplay_internal ();
14095 display_last_displayed_message_p
= false;
14098 redisplay_internal ();
14100 flush_frame (SELECTED_FRAME ());
14104 /* Function registered with record_unwind_protect in redisplay_internal. */
14107 unwind_redisplay (void)
14109 redisplaying_p
= 0;
14113 /* Mark the display of leaf window W as accurate or inaccurate.
14114 If ACCURATE_P is non-zero mark display of W as accurate. If
14115 ACCURATE_P is zero, arrange for W to be redisplayed the next
14116 time redisplay_internal is called. */
14119 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14121 struct buffer
*b
= XBUFFER (w
->contents
);
14123 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14124 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14125 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14129 b
->clip_changed
= false;
14130 b
->prevent_redisplay_optimizations_p
= false;
14131 eassert (buffer_window_count (b
) > 0);
14132 /* Resetting b->text->redisplay is problematic!
14133 In order to make it safer to do it here, redisplay_internal must
14134 have copied all b->text->redisplay to their respective windows. */
14135 b
->text
->redisplay
= false;
14137 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14138 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14139 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14140 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14142 w
->current_matrix
->buffer
= b
;
14143 w
->current_matrix
->begv
= BUF_BEGV (b
);
14144 w
->current_matrix
->zv
= BUF_ZV (b
);
14146 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14147 w
->last_cursor_off_p
= w
->cursor_off_p
;
14149 if (w
== XWINDOW (selected_window
))
14150 w
->last_point
= BUF_PT (b
);
14152 w
->last_point
= marker_position (w
->pointm
);
14154 w
->window_end_valid
= true;
14155 w
->update_mode_line
= false;
14158 w
->redisplay
= !accurate_p
;
14162 /* Mark the display of windows in the window tree rooted at WINDOW as
14163 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14164 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14165 be redisplayed the next time redisplay_internal is called. */
14168 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14172 for (; !NILP (window
); window
= w
->next
)
14174 w
= XWINDOW (window
);
14175 if (WINDOWP (w
->contents
))
14176 mark_window_display_accurate (w
->contents
, accurate_p
);
14178 mark_window_display_accurate_1 (w
, accurate_p
);
14182 update_overlay_arrows (1);
14184 /* Force a thorough redisplay the next time by setting
14185 last_arrow_position and last_arrow_string to t, which is
14186 unequal to any useful value of Voverlay_arrow_... */
14187 update_overlay_arrows (-1);
14191 /* Return value in display table DP (Lisp_Char_Table *) for character
14192 C. Since a display table doesn't have any parent, we don't have to
14193 follow parent. Do not call this function directly but use the
14194 macro DISP_CHAR_VECTOR. */
14197 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14201 if (ASCII_CHAR_P (c
))
14204 if (SUB_CHAR_TABLE_P (val
))
14205 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14211 XSETCHAR_TABLE (table
, dp
);
14212 val
= char_table_ref (table
, c
);
14221 /***********************************************************************
14223 ***********************************************************************/
14225 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14228 redisplay_windows (Lisp_Object window
)
14230 while (!NILP (window
))
14232 struct window
*w
= XWINDOW (window
);
14234 if (WINDOWP (w
->contents
))
14235 redisplay_windows (w
->contents
);
14236 else if (BUFFERP (w
->contents
))
14238 displayed_buffer
= XBUFFER (w
->contents
);
14239 /* Use list_of_error, not Qerror, so that
14240 we catch only errors and don't run the debugger. */
14241 internal_condition_case_1 (redisplay_window_0
, window
,
14243 redisplay_window_error
);
14251 redisplay_window_error (Lisp_Object ignore
)
14253 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14258 redisplay_window_0 (Lisp_Object window
)
14260 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14261 redisplay_window (window
, false);
14266 redisplay_window_1 (Lisp_Object window
)
14268 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14269 redisplay_window (window
, true);
14274 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14275 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14276 which positions recorded in ROW differ from current buffer
14279 Return 0 if cursor is not on this row, 1 otherwise. */
14282 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14283 struct glyph_matrix
*matrix
,
14284 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14287 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14288 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14289 struct glyph
*cursor
= NULL
;
14290 /* The last known character position in row. */
14291 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14293 ptrdiff_t pt_old
= PT
- delta
;
14294 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14295 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14296 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14297 /* A glyph beyond the edge of TEXT_AREA which we should never
14299 struct glyph
*glyphs_end
= end
;
14300 /* Non-zero means we've found a match for cursor position, but that
14301 glyph has the avoid_cursor_p flag set. */
14302 int match_with_avoid_cursor
= 0;
14303 /* Non-zero means we've seen at least one glyph that came from a
14305 int string_seen
= 0;
14306 /* Largest and smallest buffer positions seen so far during scan of
14308 ptrdiff_t bpos_max
= pos_before
;
14309 ptrdiff_t bpos_min
= pos_after
;
14310 /* Last buffer position covered by an overlay string with an integer
14311 `cursor' property. */
14312 ptrdiff_t bpos_covered
= 0;
14313 /* Non-zero means the display string on which to display the cursor
14314 comes from a text property, not from an overlay. */
14315 int string_from_text_prop
= 0;
14317 /* Don't even try doing anything if called for a mode-line or
14318 header-line row, since the rest of the code isn't prepared to
14319 deal with such calamities. */
14320 eassert (!row
->mode_line_p
);
14321 if (row
->mode_line_p
)
14324 /* Skip over glyphs not having an object at the start and the end of
14325 the row. These are special glyphs like truncation marks on
14326 terminal frames. */
14327 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14329 if (!row
->reversed_p
)
14332 && NILP (glyph
->object
)
14333 && glyph
->charpos
< 0)
14335 x
+= glyph
->pixel_width
;
14339 && NILP ((end
- 1)->object
)
14340 /* CHARPOS is zero for blanks and stretch glyphs
14341 inserted by extend_face_to_end_of_line. */
14342 && (end
- 1)->charpos
<= 0)
14344 glyph_before
= glyph
- 1;
14351 /* If the glyph row is reversed, we need to process it from back
14352 to front, so swap the edge pointers. */
14353 glyphs_end
= end
= glyph
- 1;
14354 glyph
+= row
->used
[TEXT_AREA
] - 1;
14356 while (glyph
> end
+ 1
14357 && NILP (glyph
->object
)
14358 && glyph
->charpos
< 0)
14361 x
-= glyph
->pixel_width
;
14363 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14365 /* By default, in reversed rows we put the cursor on the
14366 rightmost (first in the reading order) glyph. */
14367 for (g
= end
+ 1; g
< glyph
; g
++)
14368 x
+= g
->pixel_width
;
14370 && NILP ((end
+ 1)->object
)
14371 && (end
+ 1)->charpos
<= 0)
14373 glyph_before
= glyph
+ 1;
14377 else if (row
->reversed_p
)
14379 /* In R2L rows that don't display text, put the cursor on the
14380 rightmost glyph. Case in point: an empty last line that is
14381 part of an R2L paragraph. */
14383 /* Avoid placing the cursor on the last glyph of the row, where
14384 on terminal frames we hold the vertical border between
14385 adjacent windows. */
14386 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14387 && !WINDOW_RIGHTMOST_P (w
)
14388 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14390 x
= -1; /* will be computed below, at label compute_x */
14393 /* Step 1: Try to find the glyph whose character position
14394 corresponds to point. If that's not possible, find 2 glyphs
14395 whose character positions are the closest to point, one before
14396 point, the other after it. */
14397 if (!row
->reversed_p
)
14398 while (/* not marched to end of glyph row */
14400 /* glyph was not inserted by redisplay for internal purposes */
14401 && !NILP (glyph
->object
))
14403 if (BUFFERP (glyph
->object
))
14405 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14407 if (glyph
->charpos
> bpos_max
)
14408 bpos_max
= glyph
->charpos
;
14409 if (glyph
->charpos
< bpos_min
)
14410 bpos_min
= glyph
->charpos
;
14411 if (!glyph
->avoid_cursor_p
)
14413 /* If we hit point, we've found the glyph on which to
14414 display the cursor. */
14417 match_with_avoid_cursor
= 0;
14420 /* See if we've found a better approximation to
14421 POS_BEFORE or to POS_AFTER. */
14422 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14424 pos_before
= glyph
->charpos
;
14425 glyph_before
= glyph
;
14427 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14429 pos_after
= glyph
->charpos
;
14430 glyph_after
= glyph
;
14433 else if (dpos
== 0)
14434 match_with_avoid_cursor
= 1;
14436 else if (STRINGP (glyph
->object
))
14438 Lisp_Object chprop
;
14439 ptrdiff_t glyph_pos
= glyph
->charpos
;
14441 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14443 if (!NILP (chprop
))
14445 /* If the string came from a `display' text property,
14446 look up the buffer position of that property and
14447 use that position to update bpos_max, as if we
14448 actually saw such a position in one of the row's
14449 glyphs. This helps with supporting integer values
14450 of `cursor' property on the display string in
14451 situations where most or all of the row's buffer
14452 text is completely covered by display properties,
14453 so that no glyph with valid buffer positions is
14454 ever seen in the row. */
14455 ptrdiff_t prop_pos
=
14456 string_buffer_position_lim (glyph
->object
, pos_before
,
14459 if (prop_pos
>= pos_before
)
14460 bpos_max
= prop_pos
;
14462 if (INTEGERP (chprop
))
14464 bpos_covered
= bpos_max
+ XINT (chprop
);
14465 /* If the `cursor' property covers buffer positions up
14466 to and including point, we should display cursor on
14467 this glyph. Note that, if a `cursor' property on one
14468 of the string's characters has an integer value, we
14469 will break out of the loop below _before_ we get to
14470 the position match above. IOW, integer values of
14471 the `cursor' property override the "exact match for
14472 point" strategy of positioning the cursor. */
14473 /* Implementation note: bpos_max == pt_old when, e.g.,
14474 we are in an empty line, where bpos_max is set to
14475 MATRIX_ROW_START_CHARPOS, see above. */
14476 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14485 x
+= glyph
->pixel_width
;
14488 else if (glyph
> end
) /* row is reversed */
14489 while (!NILP (glyph
->object
))
14491 if (BUFFERP (glyph
->object
))
14493 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14495 if (glyph
->charpos
> bpos_max
)
14496 bpos_max
= glyph
->charpos
;
14497 if (glyph
->charpos
< bpos_min
)
14498 bpos_min
= glyph
->charpos
;
14499 if (!glyph
->avoid_cursor_p
)
14503 match_with_avoid_cursor
= 0;
14506 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14508 pos_before
= glyph
->charpos
;
14509 glyph_before
= glyph
;
14511 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14513 pos_after
= glyph
->charpos
;
14514 glyph_after
= glyph
;
14517 else if (dpos
== 0)
14518 match_with_avoid_cursor
= 1;
14520 else if (STRINGP (glyph
->object
))
14522 Lisp_Object chprop
;
14523 ptrdiff_t glyph_pos
= glyph
->charpos
;
14525 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14527 if (!NILP (chprop
))
14529 ptrdiff_t prop_pos
=
14530 string_buffer_position_lim (glyph
->object
, pos_before
,
14533 if (prop_pos
>= pos_before
)
14534 bpos_max
= prop_pos
;
14536 if (INTEGERP (chprop
))
14538 bpos_covered
= bpos_max
+ XINT (chprop
);
14539 /* If the `cursor' property covers buffer positions up
14540 to and including point, we should display cursor on
14542 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14551 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14553 x
--; /* can't use any pixel_width */
14556 x
-= glyph
->pixel_width
;
14559 /* Step 2: If we didn't find an exact match for point, we need to
14560 look for a proper place to put the cursor among glyphs between
14561 GLYPH_BEFORE and GLYPH_AFTER. */
14562 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14563 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14564 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14566 /* An empty line has a single glyph whose OBJECT is nil and
14567 whose CHARPOS is the position of a newline on that line.
14568 Note that on a TTY, there are more glyphs after that, which
14569 were produced by extend_face_to_end_of_line, but their
14570 CHARPOS is zero or negative. */
14572 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14573 && NILP (glyph
->object
) && glyph
->charpos
> 0
14574 /* On a TTY, continued and truncated rows also have a glyph at
14575 their end whose OBJECT is nil and whose CHARPOS is
14576 positive (the continuation and truncation glyphs), but such
14577 rows are obviously not "empty". */
14578 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14580 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14582 ptrdiff_t ellipsis_pos
;
14584 /* Scan back over the ellipsis glyphs. */
14585 if (!row
->reversed_p
)
14587 ellipsis_pos
= (glyph
- 1)->charpos
;
14588 while (glyph
> row
->glyphs
[TEXT_AREA
]
14589 && (glyph
- 1)->charpos
== ellipsis_pos
)
14590 glyph
--, x
-= glyph
->pixel_width
;
14591 /* That loop always goes one position too far, including
14592 the glyph before the ellipsis. So scan forward over
14594 x
+= glyph
->pixel_width
;
14597 else /* row is reversed */
14599 ellipsis_pos
= (glyph
+ 1)->charpos
;
14600 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14601 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14602 glyph
++, x
+= glyph
->pixel_width
;
14603 x
-= glyph
->pixel_width
;
14607 else if (match_with_avoid_cursor
)
14609 cursor
= glyph_after
;
14612 else if (string_seen
)
14614 int incr
= row
->reversed_p
? -1 : +1;
14616 /* Need to find the glyph that came out of a string which is
14617 present at point. That glyph is somewhere between
14618 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14619 positioned between POS_BEFORE and POS_AFTER in the
14621 struct glyph
*start
, *stop
;
14622 ptrdiff_t pos
= pos_before
;
14626 /* If the row ends in a newline from a display string,
14627 reordering could have moved the glyphs belonging to the
14628 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14629 in this case we extend the search to the last glyph in
14630 the row that was not inserted by redisplay. */
14631 if (row
->ends_in_newline_from_string_p
)
14634 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14637 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14638 correspond to POS_BEFORE and POS_AFTER, respectively. We
14639 need START and STOP in the order that corresponds to the
14640 row's direction as given by its reversed_p flag. If the
14641 directionality of characters between POS_BEFORE and
14642 POS_AFTER is the opposite of the row's base direction,
14643 these characters will have been reordered for display,
14644 and we need to reverse START and STOP. */
14645 if (!row
->reversed_p
)
14647 start
= min (glyph_before
, glyph_after
);
14648 stop
= max (glyph_before
, glyph_after
);
14652 start
= max (glyph_before
, glyph_after
);
14653 stop
= min (glyph_before
, glyph_after
);
14655 for (glyph
= start
+ incr
;
14656 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14659 /* Any glyphs that come from the buffer are here because
14660 of bidi reordering. Skip them, and only pay
14661 attention to glyphs that came from some string. */
14662 if (STRINGP (glyph
->object
))
14666 /* If the display property covers the newline, we
14667 need to search for it one position farther. */
14668 ptrdiff_t lim
= pos_after
14669 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14671 string_from_text_prop
= 0;
14672 str
= glyph
->object
;
14673 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14674 if (tem
== 0 /* from overlay */
14677 /* If the string from which this glyph came is
14678 found in the buffer at point, or at position
14679 that is closer to point than pos_after, then
14680 we've found the glyph we've been looking for.
14681 If it comes from an overlay (tem == 0), and
14682 it has the `cursor' property on one of its
14683 glyphs, record that glyph as a candidate for
14684 displaying the cursor. (As in the
14685 unidirectional version, we will display the
14686 cursor on the last candidate we find.) */
14689 || (tem
- pt_old
> 0 && tem
< pos_after
))
14691 /* The glyphs from this string could have
14692 been reordered. Find the one with the
14693 smallest string position. Or there could
14694 be a character in the string with the
14695 `cursor' property, which means display
14696 cursor on that character's glyph. */
14697 ptrdiff_t strpos
= glyph
->charpos
;
14702 string_from_text_prop
= 1;
14705 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14706 && EQ (glyph
->object
, str
);
14710 ptrdiff_t gpos
= glyph
->charpos
;
14712 cprop
= Fget_char_property (make_number (gpos
),
14720 if (tem
&& glyph
->charpos
< strpos
)
14722 strpos
= glyph
->charpos
;
14728 || (tem
- pt_old
> 0 && tem
< pos_after
))
14732 pos
= tem
+ 1; /* don't find previous instances */
14734 /* This string is not what we want; skip all of the
14735 glyphs that came from it. */
14736 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14737 && EQ (glyph
->object
, str
))
14744 /* If we reached the end of the line, and END was from a string,
14745 the cursor is not on this line. */
14747 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14748 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14749 && STRINGP (end
->object
)
14750 && row
->continued_p
)
14753 /* A truncated row may not include PT among its character positions.
14754 Setting the cursor inside the scroll margin will trigger
14755 recalculation of hscroll in hscroll_window_tree. But if a
14756 display string covers point, defer to the string-handling
14757 code below to figure this out. */
14758 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14760 cursor
= glyph_before
;
14763 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14764 /* Zero-width characters produce no glyphs. */
14766 && (row
->reversed_p
14767 ? glyph_after
> glyphs_end
14768 : glyph_after
< glyphs_end
)))
14770 cursor
= glyph_after
;
14776 if (cursor
!= NULL
)
14778 else if (glyph
== glyphs_end
14779 && pos_before
== pos_after
14780 && STRINGP ((row
->reversed_p
14781 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14782 : row
->glyphs
[TEXT_AREA
])->object
))
14784 /* If all the glyphs of this row came from strings, put the
14785 cursor on the first glyph of the row. This avoids having the
14786 cursor outside of the text area in this very rare and hard
14790 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14791 : row
->glyphs
[TEXT_AREA
];
14797 /* Need to compute x that corresponds to GLYPH. */
14798 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14800 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14802 x
+= g
->pixel_width
;
14806 /* ROW could be part of a continued line, which, under bidi
14807 reordering, might have other rows whose start and end charpos
14808 occlude point. Only set w->cursor if we found a better
14809 approximation to the cursor position than we have from previously
14810 examined candidate rows belonging to the same continued line. */
14811 if (/* We already have a candidate row. */
14812 w
->cursor
.vpos
>= 0
14813 /* That candidate is not the row we are processing. */
14814 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14815 /* Make sure cursor.vpos specifies a row whose start and end
14816 charpos occlude point, and it is valid candidate for being a
14817 cursor-row. This is because some callers of this function
14818 leave cursor.vpos at the row where the cursor was displayed
14819 during the last redisplay cycle. */
14820 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14821 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14822 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14825 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14827 /* Don't consider glyphs that are outside TEXT_AREA. */
14828 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14830 /* Keep the candidate whose buffer position is the closest to
14831 point or has the `cursor' property. */
14832 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14833 w
->cursor
.hpos
>= 0
14834 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14835 && ((BUFFERP (g1
->object
)
14836 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14837 || (BUFFERP (glyph
->object
)
14838 && eabs (g1
->charpos
- pt_old
)
14839 < eabs (glyph
->charpos
- pt_old
))))
14840 /* Previous candidate is a glyph from a string that has
14841 a non-nil `cursor' property. */
14842 || (STRINGP (g1
->object
)
14843 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14844 Qcursor
, g1
->object
))
14845 /* Previous candidate is from the same display
14846 string as this one, and the display string
14847 came from a text property. */
14848 || (EQ (g1
->object
, glyph
->object
)
14849 && string_from_text_prop
)
14850 /* this candidate is from newline and its
14851 position is not an exact match */
14852 || (NILP (glyph
->object
)
14853 && glyph
->charpos
!= pt_old
)))))
14855 /* If this candidate gives an exact match, use that. */
14856 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14857 /* If this candidate is a glyph created for the
14858 terminating newline of a line, and point is on that
14859 newline, it wins because it's an exact match. */
14860 || (!row
->continued_p
14861 && NILP (glyph
->object
)
14862 && glyph
->charpos
== 0
14863 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14864 /* Otherwise, keep the candidate that comes from a row
14865 spanning less buffer positions. This may win when one or
14866 both candidate positions are on glyphs that came from
14867 display strings, for which we cannot compare buffer
14869 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14870 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14871 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14874 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14876 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14877 w
->cursor
.y
= row
->y
+ dy
;
14879 if (w
== XWINDOW (selected_window
))
14881 if (!row
->continued_p
14882 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14885 this_line_buffer
= XBUFFER (w
->contents
);
14887 CHARPOS (this_line_start_pos
)
14888 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14889 BYTEPOS (this_line_start_pos
)
14890 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14892 CHARPOS (this_line_end_pos
)
14893 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14894 BYTEPOS (this_line_end_pos
)
14895 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14897 this_line_y
= w
->cursor
.y
;
14898 this_line_pixel_height
= row
->height
;
14899 this_line_vpos
= w
->cursor
.vpos
;
14900 this_line_start_x
= row
->x
;
14903 CHARPOS (this_line_start_pos
) = 0;
14910 /* Run window scroll functions, if any, for WINDOW with new window
14911 start STARTP. Sets the window start of WINDOW to that position.
14913 We assume that the window's buffer is really current. */
14915 static struct text_pos
14916 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14918 struct window
*w
= XWINDOW (window
);
14919 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14921 eassert (current_buffer
== XBUFFER (w
->contents
));
14923 if (!NILP (Vwindow_scroll_functions
))
14925 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14926 make_number (CHARPOS (startp
)));
14927 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14928 /* In case the hook functions switch buffers. */
14929 set_buffer_internal (XBUFFER (w
->contents
));
14936 /* Make sure the line containing the cursor is fully visible.
14937 A value of 1 means there is nothing to be done.
14938 (Either the line is fully visible, or it cannot be made so,
14939 or we cannot tell.)
14941 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14942 is higher than window.
14944 If CURRENT_MATRIX_P is non-zero, use the information from the
14945 window's current glyph matrix; otherwise use the desired glyph
14948 A value of 0 means the caller should do scrolling
14949 as if point had gone off the screen. */
14952 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14954 struct glyph_matrix
*matrix
;
14955 struct glyph_row
*row
;
14958 if (!make_cursor_line_fully_visible_p
)
14961 /* It's not always possible to find the cursor, e.g, when a window
14962 is full of overlay strings. Don't do anything in that case. */
14963 if (w
->cursor
.vpos
< 0)
14966 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14967 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14969 /* If the cursor row is not partially visible, there's nothing to do. */
14970 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14973 /* If the row the cursor is in is taller than the window's height,
14974 it's not clear what to do, so do nothing. */
14975 window_height
= window_box_height (w
);
14976 if (row
->height
>= window_height
)
14978 if (!force_p
|| MINI_WINDOW_P (w
)
14979 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14986 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14987 non-zero means only WINDOW is redisplayed in redisplay_internal.
14988 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14989 in redisplay_window to bring a partially visible line into view in
14990 the case that only the cursor has moved.
14992 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14993 last screen line's vertical height extends past the end of the screen.
14997 1 if scrolling succeeded
14999 0 if scrolling didn't find point.
15001 -1 if new fonts have been loaded so that we must interrupt
15002 redisplay, adjust glyph matrices, and try again. */
15008 SCROLLING_NEED_LARGER_MATRICES
15011 /* If scroll-conservatively is more than this, never recenter.
15013 If you change this, don't forget to update the doc string of
15014 `scroll-conservatively' and the Emacs manual. */
15015 #define SCROLL_LIMIT 100
15018 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15019 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15020 int temp_scroll_step
, int last_line_misfit
)
15022 struct window
*w
= XWINDOW (window
);
15023 struct frame
*f
= XFRAME (w
->frame
);
15024 struct text_pos pos
, startp
;
15026 int this_scroll_margin
, scroll_max
, rc
, height
;
15027 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15028 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15029 Lisp_Object aggressive
;
15030 /* We will never try scrolling more than this number of lines. */
15031 int scroll_limit
= SCROLL_LIMIT
;
15032 int frame_line_height
= default_line_pixel_height (w
);
15033 int window_total_lines
15034 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15037 debug_method_add (w
, "try_scrolling");
15040 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15042 /* Compute scroll margin height in pixels. We scroll when point is
15043 within this distance from the top or bottom of the window. */
15044 if (scroll_margin
> 0)
15045 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15046 * frame_line_height
;
15048 this_scroll_margin
= 0;
15050 /* Force arg_scroll_conservatively to have a reasonable value, to
15051 avoid scrolling too far away with slow move_it_* functions. Note
15052 that the user can supply scroll-conservatively equal to
15053 `most-positive-fixnum', which can be larger than INT_MAX. */
15054 if (arg_scroll_conservatively
> scroll_limit
)
15056 arg_scroll_conservatively
= scroll_limit
+ 1;
15057 scroll_max
= scroll_limit
* frame_line_height
;
15059 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15060 /* Compute how much we should try to scroll maximally to bring
15061 point into view. */
15062 scroll_max
= (max (scroll_step
,
15063 max (arg_scroll_conservatively
, temp_scroll_step
))
15064 * frame_line_height
);
15065 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15066 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15067 /* We're trying to scroll because of aggressive scrolling but no
15068 scroll_step is set. Choose an arbitrary one. */
15069 scroll_max
= 10 * frame_line_height
;
15075 /* Decide whether to scroll down. */
15076 if (PT
> CHARPOS (startp
))
15078 int scroll_margin_y
;
15080 /* Compute the pixel ypos of the scroll margin, then move IT to
15081 either that ypos or PT, whichever comes first. */
15082 start_display (&it
, w
, startp
);
15083 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15084 - frame_line_height
* extra_scroll_margin_lines
;
15085 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15086 (MOVE_TO_POS
| MOVE_TO_Y
));
15088 if (PT
> CHARPOS (it
.current
.pos
))
15090 int y0
= line_bottom_y (&it
);
15091 /* Compute how many pixels below window bottom to stop searching
15092 for PT. This avoids costly search for PT that is far away if
15093 the user limited scrolling by a small number of lines, but
15094 always finds PT if scroll_conservatively is set to a large
15095 number, such as most-positive-fixnum. */
15096 int slack
= max (scroll_max
, 10 * frame_line_height
);
15097 int y_to_move
= it
.last_visible_y
+ slack
;
15099 /* Compute the distance from the scroll margin to PT or to
15100 the scroll limit, whichever comes first. This should
15101 include the height of the cursor line, to make that line
15103 move_it_to (&it
, PT
, -1, y_to_move
,
15104 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15105 dy
= line_bottom_y (&it
) - y0
;
15107 if (dy
> scroll_max
)
15108 return SCROLLING_FAILED
;
15117 /* Point is in or below the bottom scroll margin, so move the
15118 window start down. If scrolling conservatively, move it just
15119 enough down to make point visible. If scroll_step is set,
15120 move it down by scroll_step. */
15121 if (arg_scroll_conservatively
)
15123 = min (max (dy
, frame_line_height
),
15124 frame_line_height
* arg_scroll_conservatively
);
15125 else if (scroll_step
|| temp_scroll_step
)
15126 amount_to_scroll
= scroll_max
;
15129 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15130 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15131 if (NUMBERP (aggressive
))
15133 double float_amount
= XFLOATINT (aggressive
) * height
;
15134 int aggressive_scroll
= float_amount
;
15135 if (aggressive_scroll
== 0 && float_amount
> 0)
15136 aggressive_scroll
= 1;
15137 /* Don't let point enter the scroll margin near top of
15138 the window. This could happen if the value of
15139 scroll_up_aggressively is too large and there are
15140 non-zero margins, because scroll_up_aggressively
15141 means put point that fraction of window height
15142 _from_the_bottom_margin_. */
15143 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15144 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15145 amount_to_scroll
= dy
+ aggressive_scroll
;
15149 if (amount_to_scroll
<= 0)
15150 return SCROLLING_FAILED
;
15152 start_display (&it
, w
, startp
);
15153 if (arg_scroll_conservatively
<= scroll_limit
)
15154 move_it_vertically (&it
, amount_to_scroll
);
15157 /* Extra precision for users who set scroll-conservatively
15158 to a large number: make sure the amount we scroll
15159 the window start is never less than amount_to_scroll,
15160 which was computed as distance from window bottom to
15161 point. This matters when lines at window top and lines
15162 below window bottom have different height. */
15164 void *it1data
= NULL
;
15165 /* We use a temporary it1 because line_bottom_y can modify
15166 its argument, if it moves one line down; see there. */
15169 SAVE_IT (it1
, it
, it1data
);
15170 start_y
= line_bottom_y (&it1
);
15172 RESTORE_IT (&it
, &it
, it1data
);
15173 move_it_by_lines (&it
, 1);
15174 SAVE_IT (it1
, it
, it1data
);
15175 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15178 /* If STARTP is unchanged, move it down another screen line. */
15179 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15180 move_it_by_lines (&it
, 1);
15181 startp
= it
.current
.pos
;
15185 struct text_pos scroll_margin_pos
= startp
;
15188 /* See if point is inside the scroll margin at the top of the
15190 if (this_scroll_margin
)
15194 start_display (&it
, w
, startp
);
15195 y_start
= it
.current_y
;
15196 move_it_vertically (&it
, this_scroll_margin
);
15197 scroll_margin_pos
= it
.current
.pos
;
15198 /* If we didn't move enough before hitting ZV, request
15199 additional amount of scroll, to move point out of the
15201 if (IT_CHARPOS (it
) == ZV
15202 && it
.current_y
- y_start
< this_scroll_margin
)
15203 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15206 if (PT
< CHARPOS (scroll_margin_pos
))
15208 /* Point is in the scroll margin at the top of the window or
15209 above what is displayed in the window. */
15212 /* Compute the vertical distance from PT to the scroll
15213 margin position. Move as far as scroll_max allows, or
15214 one screenful, or 10 screen lines, whichever is largest.
15215 Give up if distance is greater than scroll_max or if we
15216 didn't reach the scroll margin position. */
15217 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15218 start_display (&it
, w
, pos
);
15220 y_to_move
= max (it
.last_visible_y
,
15221 max (scroll_max
, 10 * frame_line_height
));
15222 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15224 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15225 dy
= it
.current_y
- y0
;
15226 if (dy
> scroll_max
15227 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15228 return SCROLLING_FAILED
;
15230 /* Additional scroll for when ZV was too close to point. */
15233 /* Compute new window start. */
15234 start_display (&it
, w
, startp
);
15236 if (arg_scroll_conservatively
)
15237 amount_to_scroll
= max (dy
, frame_line_height
15238 * max (scroll_step
, temp_scroll_step
));
15239 else if (scroll_step
|| temp_scroll_step
)
15240 amount_to_scroll
= scroll_max
;
15243 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15244 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15245 if (NUMBERP (aggressive
))
15247 double float_amount
= XFLOATINT (aggressive
) * height
;
15248 int aggressive_scroll
= float_amount
;
15249 if (aggressive_scroll
== 0 && float_amount
> 0)
15250 aggressive_scroll
= 1;
15251 /* Don't let point enter the scroll margin near
15252 bottom of the window, if the value of
15253 scroll_down_aggressively happens to be too
15255 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15256 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15257 amount_to_scroll
= dy
+ aggressive_scroll
;
15261 if (amount_to_scroll
<= 0)
15262 return SCROLLING_FAILED
;
15264 move_it_vertically_backward (&it
, amount_to_scroll
);
15265 startp
= it
.current
.pos
;
15269 /* Run window scroll functions. */
15270 startp
= run_window_scroll_functions (window
, startp
);
15272 /* Display the window. Give up if new fonts are loaded, or if point
15274 if (!try_window (window
, startp
, 0))
15275 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15276 else if (w
->cursor
.vpos
< 0)
15278 clear_glyph_matrix (w
->desired_matrix
);
15279 rc
= SCROLLING_FAILED
;
15283 /* Maybe forget recorded base line for line number display. */
15284 if (!just_this_one_p
15285 || current_buffer
->clip_changed
15286 || BEG_UNCHANGED
< CHARPOS (startp
))
15287 w
->base_line_number
= 0;
15289 /* If cursor ends up on a partially visible line,
15290 treat that as being off the bottom of the screen. */
15291 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15292 /* It's possible that the cursor is on the first line of the
15293 buffer, which is partially obscured due to a vscroll
15294 (Bug#7537). In that case, avoid looping forever. */
15295 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15297 clear_glyph_matrix (w
->desired_matrix
);
15298 ++extra_scroll_margin_lines
;
15301 rc
= SCROLLING_SUCCESS
;
15308 /* Compute a suitable window start for window W if display of W starts
15309 on a continuation line. Value is non-zero if a new window start
15312 The new window start will be computed, based on W's width, starting
15313 from the start of the continued line. It is the start of the
15314 screen line with the minimum distance from the old start W->start. */
15317 compute_window_start_on_continuation_line (struct window
*w
)
15319 struct text_pos pos
, start_pos
;
15320 int window_start_changed_p
= 0;
15322 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15324 /* If window start is on a continuation line... Window start may be
15325 < BEGV in case there's invisible text at the start of the
15326 buffer (M-x rmail, for example). */
15327 if (CHARPOS (start_pos
) > BEGV
15328 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15331 struct glyph_row
*row
;
15333 /* Handle the case that the window start is out of range. */
15334 if (CHARPOS (start_pos
) < BEGV
)
15335 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15336 else if (CHARPOS (start_pos
) > ZV
)
15337 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15339 /* Find the start of the continued line. This should be fast
15340 because find_newline is fast (newline cache). */
15341 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15342 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15343 row
, DEFAULT_FACE_ID
);
15344 reseat_at_previous_visible_line_start (&it
);
15346 /* If the line start is "too far" away from the window start,
15347 say it takes too much time to compute a new window start. */
15348 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15349 /* PXW: Do we need upper bounds here? */
15350 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15352 int min_distance
, distance
;
15354 /* Move forward by display lines to find the new window
15355 start. If window width was enlarged, the new start can
15356 be expected to be > the old start. If window width was
15357 decreased, the new window start will be < the old start.
15358 So, we're looking for the display line start with the
15359 minimum distance from the old window start. */
15360 pos
= it
.current
.pos
;
15361 min_distance
= INFINITY
;
15362 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15363 distance
< min_distance
)
15365 min_distance
= distance
;
15366 pos
= it
.current
.pos
;
15367 if (it
.line_wrap
== WORD_WRAP
)
15369 /* Under WORD_WRAP, move_it_by_lines is likely to
15370 overshoot and stop not at the first, but the
15371 second character from the left margin. So in
15372 that case, we need a more tight control on the X
15373 coordinate of the iterator than move_it_by_lines
15374 promises in its contract. The method is to first
15375 go to the last (rightmost) visible character of a
15376 line, then move to the leftmost character on the
15377 next line in a separate call. */
15378 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15379 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15380 move_it_to (&it
, ZV
, 0,
15381 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15382 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15385 move_it_by_lines (&it
, 1);
15388 /* Set the window start there. */
15389 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15390 window_start_changed_p
= 1;
15394 return window_start_changed_p
;
15398 /* Try cursor movement in case text has not changed in window WINDOW,
15399 with window start STARTP. Value is
15401 CURSOR_MOVEMENT_SUCCESS if successful
15403 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15405 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15406 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15407 we want to scroll as if scroll-step were set to 1. See the code.
15409 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15410 which case we have to abort this redisplay, and adjust matrices
15415 CURSOR_MOVEMENT_SUCCESS
,
15416 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15417 CURSOR_MOVEMENT_MUST_SCROLL
,
15418 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15422 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15424 struct window
*w
= XWINDOW (window
);
15425 struct frame
*f
= XFRAME (w
->frame
);
15426 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15429 if (inhibit_try_cursor_movement
)
15433 /* Previously, there was a check for Lisp integer in the
15434 if-statement below. Now, this field is converted to
15435 ptrdiff_t, thus zero means invalid position in a buffer. */
15436 eassert (w
->last_point
> 0);
15437 /* Likewise there was a check whether window_end_vpos is nil or larger
15438 than the window. Now window_end_vpos is int and so never nil, but
15439 let's leave eassert to check whether it fits in the window. */
15440 eassert (!w
->window_end_valid
15441 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15443 /* Handle case where text has not changed, only point, and it has
15444 not moved off the frame. */
15445 if (/* Point may be in this window. */
15446 PT
>= CHARPOS (startp
)
15447 /* Selective display hasn't changed. */
15448 && !current_buffer
->clip_changed
15449 /* Function force-mode-line-update is used to force a thorough
15450 redisplay. It sets either windows_or_buffers_changed or
15451 update_mode_lines. So don't take a shortcut here for these
15453 && !update_mode_lines
15454 && !windows_or_buffers_changed
15455 && !f
->cursor_type_changed
15456 && NILP (Vshow_trailing_whitespace
)
15457 /* This code is not used for mini-buffer for the sake of the case
15458 of redisplaying to replace an echo area message; since in
15459 that case the mini-buffer contents per se are usually
15460 unchanged. This code is of no real use in the mini-buffer
15461 since the handling of this_line_start_pos, etc., in redisplay
15462 handles the same cases. */
15463 && !EQ (window
, minibuf_window
)
15464 && (FRAME_WINDOW_P (f
)
15465 || !overlay_arrow_in_current_buffer_p ()))
15467 int this_scroll_margin
, top_scroll_margin
;
15468 struct glyph_row
*row
= NULL
;
15469 int frame_line_height
= default_line_pixel_height (w
);
15470 int window_total_lines
15471 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15474 debug_method_add (w
, "cursor movement");
15477 /* Scroll if point within this distance from the top or bottom
15478 of the window. This is a pixel value. */
15479 if (scroll_margin
> 0)
15481 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15482 this_scroll_margin
*= frame_line_height
;
15485 this_scroll_margin
= 0;
15487 top_scroll_margin
= this_scroll_margin
;
15488 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15489 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15491 /* Start with the row the cursor was displayed during the last
15492 not paused redisplay. Give up if that row is not valid. */
15493 if (w
->last_cursor_vpos
< 0
15494 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15495 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15498 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15499 if (row
->mode_line_p
)
15501 if (!row
->enabled_p
)
15502 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15505 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15507 int scroll_p
= 0, must_scroll
= 0;
15508 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15510 if (PT
> w
->last_point
)
15512 /* Point has moved forward. */
15513 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15514 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15516 eassert (row
->enabled_p
);
15520 /* If the end position of a row equals the start
15521 position of the next row, and PT is at that position,
15522 we would rather display cursor in the next line. */
15523 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15524 && MATRIX_ROW_END_CHARPOS (row
) == PT
15525 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15526 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15527 && !cursor_row_p (row
))
15530 /* If within the scroll margin, scroll. Note that
15531 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15532 the next line would be drawn, and that
15533 this_scroll_margin can be zero. */
15534 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15535 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15536 /* Line is completely visible last line in window
15537 and PT is to be set in the next line. */
15538 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15539 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15540 && !row
->ends_at_zv_p
15541 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15544 else if (PT
< w
->last_point
)
15546 /* Cursor has to be moved backward. Note that PT >=
15547 CHARPOS (startp) because of the outer if-statement. */
15548 while (!row
->mode_line_p
15549 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15550 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15551 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15552 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15553 row
> w
->current_matrix
->rows
15554 && (row
-1)->ends_in_newline_from_string_p
))))
15555 && (row
->y
> top_scroll_margin
15556 || CHARPOS (startp
) == BEGV
))
15558 eassert (row
->enabled_p
);
15562 /* Consider the following case: Window starts at BEGV,
15563 there is invisible, intangible text at BEGV, so that
15564 display starts at some point START > BEGV. It can
15565 happen that we are called with PT somewhere between
15566 BEGV and START. Try to handle that case. */
15567 if (row
< w
->current_matrix
->rows
15568 || row
->mode_line_p
)
15570 row
= w
->current_matrix
->rows
;
15571 if (row
->mode_line_p
)
15575 /* Due to newlines in overlay strings, we may have to
15576 skip forward over overlay strings. */
15577 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15578 && MATRIX_ROW_END_CHARPOS (row
) == PT
15579 && !cursor_row_p (row
))
15582 /* If within the scroll margin, scroll. */
15583 if (row
->y
< top_scroll_margin
15584 && CHARPOS (startp
) != BEGV
)
15589 /* Cursor did not move. So don't scroll even if cursor line
15590 is partially visible, as it was so before. */
15591 rc
= CURSOR_MOVEMENT_SUCCESS
;
15594 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15595 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15597 /* if PT is not in the glyph row, give up. */
15598 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15601 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15602 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15604 struct glyph_row
*row1
;
15606 /* If rows are bidi-reordered and point moved, back up
15607 until we find a row that does not belong to a
15608 continuation line. This is because we must consider
15609 all rows of a continued line as candidates for the
15610 new cursor positioning, since row start and end
15611 positions change non-linearly with vertical position
15613 /* FIXME: Revisit this when glyph ``spilling'' in
15614 continuation lines' rows is implemented for
15615 bidi-reordered rows. */
15616 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15617 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15620 /* If we hit the beginning of the displayed portion
15621 without finding the first row of a continued
15625 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15628 eassert (row
->enabled_p
);
15633 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15634 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15635 /* Make sure this isn't a header line by any chance, since
15636 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15637 && !row
->mode_line_p
15638 && make_cursor_line_fully_visible_p
)
15640 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15641 && !row
->ends_at_zv_p
15642 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15643 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15644 else if (row
->height
> window_box_height (w
))
15646 /* If we end up in a partially visible line, let's
15647 make it fully visible, except when it's taller
15648 than the window, in which case we can't do much
15651 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15655 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15656 if (!cursor_row_fully_visible_p (w
, 0, 1))
15657 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15659 rc
= CURSOR_MOVEMENT_SUCCESS
;
15663 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15664 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15665 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15667 /* With bidi-reordered rows, there could be more than
15668 one candidate row whose start and end positions
15669 occlude point. We need to let set_cursor_from_row
15670 find the best candidate. */
15671 /* FIXME: Revisit this when glyph ``spilling'' in
15672 continuation lines' rows is implemented for
15673 bidi-reordered rows. */
15678 int at_zv_p
= 0, exact_match_p
= 0;
15680 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15681 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15682 && cursor_row_p (row
))
15683 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15685 /* As soon as we've found the exact match for point,
15686 or the first suitable row whose ends_at_zv_p flag
15687 is set, we are done. */
15690 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15691 w
->cursor
.vpos
)->ends_at_zv_p
;
15693 && w
->cursor
.hpos
>= 0
15694 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15697 struct glyph_row
*candidate
=
15698 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15700 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15701 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15704 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15705 || (NILP (g
->object
)
15706 && (g
->charpos
== PT
15707 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15709 if (at_zv_p
|| exact_match_p
)
15711 rc
= CURSOR_MOVEMENT_SUCCESS
;
15715 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15719 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15720 || row
->continued_p
)
15721 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15722 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15723 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15724 /* If we didn't find any candidate rows, or exited the
15725 loop before all the candidates were examined, signal
15726 to the caller that this method failed. */
15727 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15729 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15730 && !row
->continued_p
))
15731 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15733 rc
= CURSOR_MOVEMENT_SUCCESS
;
15739 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15741 rc
= CURSOR_MOVEMENT_SUCCESS
;
15746 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15747 && MATRIX_ROW_START_CHARPOS (row
) == PT
15748 && cursor_row_p (row
));
15758 set_vertical_scroll_bar (struct window
*w
)
15760 ptrdiff_t start
, end
, whole
;
15762 /* Calculate the start and end positions for the current window.
15763 At some point, it would be nice to choose between scrollbars
15764 which reflect the whole buffer size, with special markers
15765 indicating narrowing, and scrollbars which reflect only the
15768 Note that mini-buffers sometimes aren't displaying any text. */
15769 if (!MINI_WINDOW_P (w
)
15770 || (w
== XWINDOW (minibuf_window
)
15771 && NILP (echo_area_buffer
[0])))
15773 struct buffer
*buf
= XBUFFER (w
->contents
);
15774 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15775 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15776 /* I don't think this is guaranteed to be right. For the
15777 moment, we'll pretend it is. */
15778 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15782 if (whole
< (end
- start
))
15783 whole
= end
- start
;
15786 start
= end
= whole
= 0;
15788 /* Indicate what this scroll bar ought to be displaying now. */
15789 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15790 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15791 (w
, end
- start
, whole
, start
);
15796 set_horizontal_scroll_bar (struct window
*w
)
15798 int start
, end
, whole
, portion
;
15800 if (!MINI_WINDOW_P (w
)
15801 || (w
== XWINDOW (minibuf_window
)
15802 && NILP (echo_area_buffer
[0])))
15804 struct buffer
*b
= XBUFFER (w
->contents
);
15805 struct buffer
*old_buffer
= NULL
;
15807 struct text_pos startp
;
15809 if (b
!= current_buffer
)
15811 old_buffer
= current_buffer
;
15812 set_buffer_internal (b
);
15815 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15816 start_display (&it
, w
, startp
);
15817 it
.last_visible_x
= INT_MAX
;
15818 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15819 MOVE_TO_X
| MOVE_TO_Y
);
15820 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15821 window_box_height (w), -1,
15822 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15824 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15825 end
= start
+ window_box_width (w
, TEXT_AREA
);
15826 portion
= end
- start
;
15827 /* After enlarging a horizontally scrolled window such that it
15828 gets at least as wide as the text it contains, make sure that
15829 the thumb doesn't fill the entire scroll bar so we can still
15830 drag it back to see the entire text. */
15831 whole
= max (whole
, end
);
15837 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15838 if (EQ (pdir
, Qright_to_left
))
15840 start
= whole
- end
;
15841 end
= start
+ portion
;
15846 set_buffer_internal (old_buffer
);
15849 start
= end
= whole
= portion
= 0;
15851 w
->hscroll_whole
= whole
;
15853 /* Indicate what this scroll bar ought to be displaying now. */
15854 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15855 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15856 (w
, portion
, whole
, start
);
15860 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15861 selected_window is redisplayed.
15863 We can return without actually redisplaying the window if fonts has been
15864 changed on window's frame. In that case, redisplay_internal will retry.
15866 As one of the important parts of redisplaying a window, we need to
15867 decide whether the previous window-start position (stored in the
15868 window's w->start marker position) is still valid, and if it isn't,
15869 recompute it. Some details about that:
15871 . The previous window-start could be in a continuation line, in
15872 which case we need to recompute it when the window width
15873 changes. See compute_window_start_on_continuation_line and its
15876 . The text that changed since last redisplay could include the
15877 previous window-start position. In that case, we try to salvage
15878 what we can from the current glyph matrix by calling
15879 try_scrolling, which see.
15881 . Some Emacs command could force us to use a specific window-start
15882 position by setting the window's force_start flag, or gently
15883 propose doing that by setting the window's optional_new_start
15884 flag. In these cases, we try using the specified start point if
15885 that succeeds (i.e. the window desired matrix is successfully
15886 recomputed, and point location is within the window). In case
15887 of optional_new_start, we first check if the specified start
15888 position is feasible, i.e. if it will allow point to be
15889 displayed in the window. If using the specified start point
15890 fails, e.g., if new fonts are needed to be loaded, we abort the
15891 redisplay cycle and leave it up to the next cycle to figure out
15894 . Note that the window's force_start flag is sometimes set by
15895 redisplay itself, when it decides that the previous window start
15896 point is fine and should be kept. Search for "goto force_start"
15897 below to see the details. Like the values of window-start
15898 specified outside of redisplay, these internally-deduced values
15899 are tested for feasibility, and ignored if found to be
15902 . Note that the function try_window, used to completely redisplay
15903 a window, accepts the window's start point as its argument.
15904 This is used several times in the redisplay code to control
15905 where the window start will be, according to user options such
15906 as scroll-conservatively, and also to ensure the screen line
15907 showing point will be fully (as opposed to partially) visible on
15911 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15913 struct window
*w
= XWINDOW (window
);
15914 struct frame
*f
= XFRAME (w
->frame
);
15915 struct buffer
*buffer
= XBUFFER (w
->contents
);
15916 struct buffer
*old
= current_buffer
;
15917 struct text_pos lpoint
, opoint
, startp
;
15918 int update_mode_line
;
15921 /* Record it now because it's overwritten. */
15922 bool current_matrix_up_to_date_p
= false;
15923 bool used_current_matrix_p
= false;
15924 /* This is less strict than current_matrix_up_to_date_p.
15925 It indicates that the buffer contents and narrowing are unchanged. */
15926 bool buffer_unchanged_p
= false;
15927 int temp_scroll_step
= 0;
15928 ptrdiff_t count
= SPECPDL_INDEX ();
15930 int centering_position
= -1;
15931 int last_line_misfit
= 0;
15932 ptrdiff_t beg_unchanged
, end_unchanged
;
15933 int frame_line_height
;
15935 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15939 *w
->desired_matrix
->method
= 0;
15942 if (!just_this_one_p
15943 && REDISPLAY_SOME_P ()
15946 && !buffer
->text
->redisplay
15947 && BUF_PT (buffer
) == w
->last_point
)
15950 /* Make sure that both W's markers are valid. */
15951 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15952 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15954 /* We come here again if we need to run window-text-change-functions
15957 reconsider_clip_changes (w
);
15958 frame_line_height
= default_line_pixel_height (w
);
15960 /* Has the mode line to be updated? */
15961 update_mode_line
= (w
->update_mode_line
15962 || update_mode_lines
15963 || buffer
->clip_changed
15964 || buffer
->prevent_redisplay_optimizations_p
);
15966 if (!just_this_one_p
)
15967 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15968 cleverly elsewhere. */
15969 w
->must_be_updated_p
= true;
15971 if (MINI_WINDOW_P (w
))
15973 if (w
== XWINDOW (echo_area_window
)
15974 && !NILP (echo_area_buffer
[0]))
15976 if (update_mode_line
)
15977 /* We may have to update a tty frame's menu bar or a
15978 tool-bar. Example `M-x C-h C-h C-g'. */
15979 goto finish_menu_bars
;
15981 /* We've already displayed the echo area glyphs in this window. */
15982 goto finish_scroll_bars
;
15984 else if ((w
!= XWINDOW (minibuf_window
)
15985 || minibuf_level
== 0)
15986 /* When buffer is nonempty, redisplay window normally. */
15987 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15988 /* Quail displays non-mini buffers in minibuffer window.
15989 In that case, redisplay the window normally. */
15990 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15992 /* W is a mini-buffer window, but it's not active, so clear
15994 int yb
= window_text_bottom_y (w
);
15995 struct glyph_row
*row
;
15998 for (y
= 0, row
= w
->desired_matrix
->rows
;
16000 y
+= row
->height
, ++row
)
16001 blank_row (w
, row
, y
);
16002 goto finish_scroll_bars
;
16005 clear_glyph_matrix (w
->desired_matrix
);
16008 /* Otherwise set up data on this window; select its buffer and point
16010 /* Really select the buffer, for the sake of buffer-local
16012 set_buffer_internal_1 (XBUFFER (w
->contents
));
16014 current_matrix_up_to_date_p
16015 = (w
->window_end_valid
16016 && !current_buffer
->clip_changed
16017 && !current_buffer
->prevent_redisplay_optimizations_p
16018 && !window_outdated (w
));
16020 /* Run the window-text-change-functions
16021 if it is possible that the text on the screen has changed
16022 (either due to modification of the text, or any other reason). */
16023 if (!current_matrix_up_to_date_p
16024 && !NILP (Vwindow_text_change_functions
))
16026 safe_run_hooks (Qwindow_text_change_functions
);
16030 beg_unchanged
= BEG_UNCHANGED
;
16031 end_unchanged
= END_UNCHANGED
;
16033 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16035 specbind (Qinhibit_point_motion_hooks
, Qt
);
16038 = (w
->window_end_valid
16039 && !current_buffer
->clip_changed
16040 && !window_outdated (w
));
16042 /* When windows_or_buffers_changed is non-zero, we can't rely
16043 on the window end being valid, so set it to zero there. */
16044 if (windows_or_buffers_changed
)
16046 /* If window starts on a continuation line, maybe adjust the
16047 window start in case the window's width changed. */
16048 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16049 compute_window_start_on_continuation_line (w
);
16051 w
->window_end_valid
= false;
16052 /* If so, we also can't rely on current matrix
16053 and should not fool try_cursor_movement below. */
16054 current_matrix_up_to_date_p
= false;
16057 /* Some sanity checks. */
16058 CHECK_WINDOW_END (w
);
16059 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16061 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16064 if (mode_line_update_needed (w
))
16065 update_mode_line
= 1;
16067 /* Point refers normally to the selected window. For any other
16068 window, set up appropriate value. */
16069 if (!EQ (window
, selected_window
))
16071 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16072 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16077 new_pt_byte
= BEGV_BYTE
;
16078 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16080 else if (new_pt
> (ZV
- 1))
16083 new_pt_byte
= ZV_BYTE
;
16084 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16087 /* We don't use SET_PT so that the point-motion hooks don't run. */
16088 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16091 /* If any of the character widths specified in the display table
16092 have changed, invalidate the width run cache. It's true that
16093 this may be a bit late to catch such changes, but the rest of
16094 redisplay goes (non-fatally) haywire when the display table is
16095 changed, so why should we worry about doing any better? */
16096 if (current_buffer
->width_run_cache
16097 || (current_buffer
->base_buffer
16098 && current_buffer
->base_buffer
->width_run_cache
))
16100 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16102 if (! disptab_matches_widthtab
16103 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16105 struct buffer
*buf
= current_buffer
;
16107 if (buf
->base_buffer
)
16108 buf
= buf
->base_buffer
;
16109 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16110 recompute_width_table (current_buffer
, disptab
);
16114 /* If window-start is screwed up, choose a new one. */
16115 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16118 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16120 /* If someone specified a new starting point but did not insist,
16121 check whether it can be used. */
16122 if ((w
->optional_new_start
|| window_frozen_p (w
))
16123 && CHARPOS (startp
) >= BEGV
16124 && CHARPOS (startp
) <= ZV
)
16126 ptrdiff_t it_charpos
;
16128 w
->optional_new_start
= 0;
16129 start_display (&it
, w
, startp
);
16130 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16131 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16132 /* Record IT's position now, since line_bottom_y might change
16134 it_charpos
= IT_CHARPOS (it
);
16135 /* Make sure we set the force_start flag only if the cursor row
16136 will be fully visible. Otherwise, the code under force_start
16137 label below will try to move point back into view, which is
16138 not what the code which sets optional_new_start wants. */
16139 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16140 && !w
->force_start
)
16142 if (it_charpos
== PT
)
16143 w
->force_start
= 1;
16144 /* IT may overshoot PT if text at PT is invisible. */
16145 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16146 w
->force_start
= 1;
16148 if (w
->force_start
)
16150 if (window_frozen_p (w
))
16151 debug_method_add (w
, "set force_start from frozen window start");
16153 debug_method_add (w
, "set force_start from optional_new_start");
16161 /* Handle case where place to start displaying has been specified,
16162 unless the specified location is outside the accessible range. */
16163 if (w
->force_start
)
16165 /* We set this later on if we have to adjust point. */
16168 w
->force_start
= 0;
16170 w
->window_end_valid
= 0;
16172 /* Forget any recorded base line for line number display. */
16173 if (!buffer_unchanged_p
)
16174 w
->base_line_number
= 0;
16176 /* Redisplay the mode line. Select the buffer properly for that.
16177 Also, run the hook window-scroll-functions
16178 because we have scrolled. */
16179 /* Note, we do this after clearing force_start because
16180 if there's an error, it is better to forget about force_start
16181 than to get into an infinite loop calling the hook functions
16182 and having them get more errors. */
16183 if (!update_mode_line
16184 || ! NILP (Vwindow_scroll_functions
))
16186 update_mode_line
= 1;
16187 w
->update_mode_line
= 1;
16188 startp
= run_window_scroll_functions (window
, startp
);
16191 if (CHARPOS (startp
) < BEGV
)
16192 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16193 else if (CHARPOS (startp
) > ZV
)
16194 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16196 /* Redisplay, then check if cursor has been set during the
16197 redisplay. Give up if new fonts were loaded. */
16198 /* We used to issue a CHECK_MARGINS argument to try_window here,
16199 but this causes scrolling to fail when point begins inside
16200 the scroll margin (bug#148) -- cyd */
16201 if (!try_window (window
, startp
, 0))
16203 w
->force_start
= 1;
16204 clear_glyph_matrix (w
->desired_matrix
);
16205 goto need_larger_matrices
;
16208 if (w
->cursor
.vpos
< 0)
16210 /* If point does not appear, try to move point so it does
16211 appear. The desired matrix has been built above, so we
16212 can use it here. */
16213 new_vpos
= window_box_height (w
) / 2;
16216 if (!cursor_row_fully_visible_p (w
, 0, 0))
16218 /* Point does appear, but on a line partly visible at end of window.
16219 Move it back to a fully-visible line. */
16220 new_vpos
= window_box_height (w
);
16221 /* But if window_box_height suggests a Y coordinate that is
16222 not less than we already have, that line will clearly not
16223 be fully visible, so give up and scroll the display.
16224 This can happen when the default face uses a font whose
16225 dimensions are different from the frame's default
16227 if (new_vpos
>= w
->cursor
.y
)
16229 w
->cursor
.vpos
= -1;
16230 clear_glyph_matrix (w
->desired_matrix
);
16231 goto try_to_scroll
;
16234 else if (w
->cursor
.vpos
>= 0)
16236 /* Some people insist on not letting point enter the scroll
16237 margin, even though this part handles windows that didn't
16239 int window_total_lines
16240 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16241 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16242 int pixel_margin
= margin
* frame_line_height
;
16243 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16245 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16246 below, which finds the row to move point to, advances by
16247 the Y coordinate of the _next_ row, see the definition of
16248 MATRIX_ROW_BOTTOM_Y. */
16249 if (w
->cursor
.vpos
< margin
+ header_line
)
16251 w
->cursor
.vpos
= -1;
16252 clear_glyph_matrix (w
->desired_matrix
);
16253 goto try_to_scroll
;
16257 int window_height
= window_box_height (w
);
16260 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16261 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16263 w
->cursor
.vpos
= -1;
16264 clear_glyph_matrix (w
->desired_matrix
);
16265 goto try_to_scroll
;
16270 /* If we need to move point for either of the above reasons,
16271 now actually do it. */
16274 struct glyph_row
*row
;
16276 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16277 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16280 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16281 MATRIX_ROW_START_BYTEPOS (row
));
16283 if (w
!= XWINDOW (selected_window
))
16284 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16285 else if (current_buffer
== old
)
16286 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16288 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16290 /* Re-run pre-redisplay-function so it can update the region
16291 according to the new position of point. */
16292 /* Other than the cursor, w's redisplay is done so we can set its
16293 redisplay to false. Also the buffer's redisplay can be set to
16294 false, since propagate_buffer_redisplay should have already
16295 propagated its info to `w' anyway. */
16296 w
->redisplay
= false;
16297 XBUFFER (w
->contents
)->text
->redisplay
= false;
16298 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16300 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16302 /* pre-redisplay-function made changes (e.g. move the region)
16303 that require another round of redisplay. */
16304 clear_glyph_matrix (w
->desired_matrix
);
16305 if (!try_window (window
, startp
, 0))
16306 goto need_larger_matrices
;
16309 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, 0, 0))
16311 clear_glyph_matrix (w
->desired_matrix
);
16312 goto try_to_scroll
;
16316 debug_method_add (w
, "forced window start");
16321 /* Handle case where text has not changed, only point, and it has
16322 not moved off the frame, and we are not retrying after hscroll.
16323 (current_matrix_up_to_date_p is nonzero when retrying.) */
16324 if (current_matrix_up_to_date_p
16325 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16326 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16330 case CURSOR_MOVEMENT_SUCCESS
:
16331 used_current_matrix_p
= 1;
16334 case CURSOR_MOVEMENT_MUST_SCROLL
:
16335 goto try_to_scroll
;
16341 /* If current starting point was originally the beginning of a line
16342 but no longer is, find a new starting point. */
16343 else if (w
->start_at_line_beg
16344 && !(CHARPOS (startp
) <= BEGV
16345 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16348 debug_method_add (w
, "recenter 1");
16353 /* Try scrolling with try_window_id. Value is > 0 if update has
16354 been done, it is -1 if we know that the same window start will
16355 not work. It is 0 if unsuccessful for some other reason. */
16356 else if ((tem
= try_window_id (w
)) != 0)
16359 debug_method_add (w
, "try_window_id %d", tem
);
16362 if (f
->fonts_changed
)
16363 goto need_larger_matrices
;
16367 /* Otherwise try_window_id has returned -1 which means that we
16368 don't want the alternative below this comment to execute. */
16370 else if (CHARPOS (startp
) >= BEGV
16371 && CHARPOS (startp
) <= ZV
16372 && PT
>= CHARPOS (startp
)
16373 && (CHARPOS (startp
) < ZV
16374 /* Avoid starting at end of buffer. */
16375 || CHARPOS (startp
) == BEGV
16376 || !window_outdated (w
)))
16378 int d1
, d2
, d5
, d6
;
16381 /* If first window line is a continuation line, and window start
16382 is inside the modified region, but the first change is before
16383 current window start, we must select a new window start.
16385 However, if this is the result of a down-mouse event (e.g. by
16386 extending the mouse-drag-overlay), we don't want to select a
16387 new window start, since that would change the position under
16388 the mouse, resulting in an unwanted mouse-movement rather
16389 than a simple mouse-click. */
16390 if (!w
->start_at_line_beg
16391 && NILP (do_mouse_tracking
)
16392 && CHARPOS (startp
) > BEGV
16393 && CHARPOS (startp
) > BEG
+ beg_unchanged
16394 && CHARPOS (startp
) <= Z
- end_unchanged
16395 /* Even if w->start_at_line_beg is nil, a new window may
16396 start at a line_beg, since that's how set_buffer_window
16397 sets it. So, we need to check the return value of
16398 compute_window_start_on_continuation_line. (See also
16400 && XMARKER (w
->start
)->buffer
== current_buffer
16401 && compute_window_start_on_continuation_line (w
)
16402 /* It doesn't make sense to force the window start like we
16403 do at label force_start if it is already known that point
16404 will not be fully visible in the resulting window, because
16405 doing so will move point from its correct position
16406 instead of scrolling the window to bring point into view.
16408 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16409 /* A very tall row could need more than the window height,
16410 in which case we accept that it is partially visible. */
16411 && (rtop
!= 0) == (rbot
!= 0))
16413 w
->force_start
= 1;
16414 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16416 debug_method_add (w
, "recomputed window start in continuation line");
16422 debug_method_add (w
, "same window start");
16425 /* Try to redisplay starting at same place as before.
16426 If point has not moved off frame, accept the results. */
16427 if (!current_matrix_up_to_date_p
16428 /* Don't use try_window_reusing_current_matrix in this case
16429 because a window scroll function can have changed the
16431 || !NILP (Vwindow_scroll_functions
)
16432 || MINI_WINDOW_P (w
)
16433 || !(used_current_matrix_p
16434 = try_window_reusing_current_matrix (w
)))
16436 IF_DEBUG (debug_method_add (w
, "1"));
16437 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16438 /* -1 means we need to scroll.
16439 0 means we need new matrices, but fonts_changed
16440 is set in that case, so we will detect it below. */
16441 goto try_to_scroll
;
16444 if (f
->fonts_changed
)
16445 goto need_larger_matrices
;
16447 if (w
->cursor
.vpos
>= 0)
16449 if (!just_this_one_p
16450 || current_buffer
->clip_changed
16451 || BEG_UNCHANGED
< CHARPOS (startp
))
16452 /* Forget any recorded base line for line number display. */
16453 w
->base_line_number
= 0;
16455 if (!cursor_row_fully_visible_p (w
, 1, 0))
16457 clear_glyph_matrix (w
->desired_matrix
);
16458 last_line_misfit
= 1;
16460 /* Drop through and scroll. */
16465 clear_glyph_matrix (w
->desired_matrix
);
16470 /* Redisplay the mode line. Select the buffer properly for that. */
16471 if (!update_mode_line
)
16473 update_mode_line
= 1;
16474 w
->update_mode_line
= 1;
16477 /* Try to scroll by specified few lines. */
16478 if ((scroll_conservatively
16479 || emacs_scroll_step
16480 || temp_scroll_step
16481 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16482 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16483 && CHARPOS (startp
) >= BEGV
16484 && CHARPOS (startp
) <= ZV
)
16486 /* The function returns -1 if new fonts were loaded, 1 if
16487 successful, 0 if not successful. */
16488 int ss
= try_scrolling (window
, just_this_one_p
,
16489 scroll_conservatively
,
16491 temp_scroll_step
, last_line_misfit
);
16494 case SCROLLING_SUCCESS
:
16497 case SCROLLING_NEED_LARGER_MATRICES
:
16498 goto need_larger_matrices
;
16500 case SCROLLING_FAILED
:
16508 /* Finally, just choose a place to start which positions point
16509 according to user preferences. */
16514 debug_method_add (w
, "recenter");
16517 /* Forget any previously recorded base line for line number display. */
16518 if (!buffer_unchanged_p
)
16519 w
->base_line_number
= 0;
16521 /* Determine the window start relative to point. */
16522 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16523 it
.current_y
= it
.last_visible_y
;
16524 if (centering_position
< 0)
16526 int window_total_lines
16527 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16529 = scroll_margin
> 0
16530 ? min (scroll_margin
, window_total_lines
/ 4)
16532 ptrdiff_t margin_pos
= CHARPOS (startp
);
16533 Lisp_Object aggressive
;
16536 /* If there is a scroll margin at the top of the window, find
16537 its character position. */
16539 /* Cannot call start_display if startp is not in the
16540 accessible region of the buffer. This can happen when we
16541 have just switched to a different buffer and/or changed
16542 its restriction. In that case, startp is initialized to
16543 the character position 1 (BEGV) because we did not yet
16544 have chance to display the buffer even once. */
16545 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16548 void *it1data
= NULL
;
16550 SAVE_IT (it1
, it
, it1data
);
16551 start_display (&it1
, w
, startp
);
16552 move_it_vertically (&it1
, margin
* frame_line_height
);
16553 margin_pos
= IT_CHARPOS (it1
);
16554 RESTORE_IT (&it
, &it
, it1data
);
16556 scrolling_up
= PT
> margin_pos
;
16559 ? BVAR (current_buffer
, scroll_up_aggressively
)
16560 : BVAR (current_buffer
, scroll_down_aggressively
);
16562 if (!MINI_WINDOW_P (w
)
16563 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16567 /* Setting scroll-conservatively overrides
16568 scroll-*-aggressively. */
16569 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16571 double float_amount
= XFLOATINT (aggressive
);
16573 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16574 if (pt_offset
== 0 && float_amount
> 0)
16576 if (pt_offset
&& margin
> 0)
16579 /* Compute how much to move the window start backward from
16580 point so that point will be displayed where the user
16584 centering_position
= it
.last_visible_y
;
16586 centering_position
-= pt_offset
;
16587 centering_position
-=
16588 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16589 + WINDOW_HEADER_LINE_HEIGHT (w
);
16590 /* Don't let point enter the scroll margin near top of
16592 if (centering_position
< margin
* frame_line_height
)
16593 centering_position
= margin
* frame_line_height
;
16596 centering_position
= margin
* frame_line_height
+ pt_offset
;
16599 /* Set the window start half the height of the window backward
16601 centering_position
= window_box_height (w
) / 2;
16603 move_it_vertically_backward (&it
, centering_position
);
16605 eassert (IT_CHARPOS (it
) >= BEGV
);
16607 /* The function move_it_vertically_backward may move over more
16608 than the specified y-distance. If it->w is small, e.g. a
16609 mini-buffer window, we may end up in front of the window's
16610 display area. Start displaying at the start of the line
16611 containing PT in this case. */
16612 if (it
.current_y
<= 0)
16614 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16615 move_it_vertically_backward (&it
, 0);
16619 it
.current_x
= it
.hpos
= 0;
16621 /* Set the window start position here explicitly, to avoid an
16622 infinite loop in case the functions in window-scroll-functions
16624 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16626 /* Run scroll hooks. */
16627 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16629 /* Redisplay the window. */
16630 if (!current_matrix_up_to_date_p
16631 || windows_or_buffers_changed
16632 || f
->cursor_type_changed
16633 /* Don't use try_window_reusing_current_matrix in this case
16634 because it can have changed the buffer. */
16635 || !NILP (Vwindow_scroll_functions
)
16636 || !just_this_one_p
16637 || MINI_WINDOW_P (w
)
16638 || !(used_current_matrix_p
16639 = try_window_reusing_current_matrix (w
)))
16640 try_window (window
, startp
, 0);
16642 /* If new fonts have been loaded (due to fontsets), give up. We
16643 have to start a new redisplay since we need to re-adjust glyph
16645 if (f
->fonts_changed
)
16646 goto need_larger_matrices
;
16648 /* If cursor did not appear assume that the middle of the window is
16649 in the first line of the window. Do it again with the next line.
16650 (Imagine a window of height 100, displaying two lines of height
16651 60. Moving back 50 from it->last_visible_y will end in the first
16653 if (w
->cursor
.vpos
< 0)
16655 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16657 clear_glyph_matrix (w
->desired_matrix
);
16658 move_it_by_lines (&it
, 1);
16659 try_window (window
, it
.current
.pos
, 0);
16661 else if (PT
< IT_CHARPOS (it
))
16663 clear_glyph_matrix (w
->desired_matrix
);
16664 move_it_by_lines (&it
, -1);
16665 try_window (window
, it
.current
.pos
, 0);
16669 /* Not much we can do about it. */
16673 /* Consider the following case: Window starts at BEGV, there is
16674 invisible, intangible text at BEGV, so that display starts at
16675 some point START > BEGV. It can happen that we are called with
16676 PT somewhere between BEGV and START. Try to handle that case,
16677 and similar ones. */
16678 if (w
->cursor
.vpos
< 0)
16680 /* First, try locating the proper glyph row for PT. */
16681 struct glyph_row
*row
=
16682 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16684 /* Sometimes point is at the beginning of invisible text that is
16685 before the 1st character displayed in the row. In that case,
16686 row_containing_pos fails to find the row, because no glyphs
16687 with appropriate buffer positions are present in the row.
16688 Therefore, we next try to find the row which shows the 1st
16689 position after the invisible text. */
16693 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16696 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16699 Lisp_Object invis_end
=
16700 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16703 if (NATNUMP (invis_end
))
16704 alt_pos
= XFASTINT (invis_end
);
16707 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16711 /* Finally, fall back on the first row of the window after the
16712 header line (if any). This is slightly better than not
16713 displaying the cursor at all. */
16716 row
= w
->current_matrix
->rows
;
16717 if (row
->mode_line_p
)
16720 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16723 if (!cursor_row_fully_visible_p (w
, 0, 0))
16725 /* If vscroll is enabled, disable it and try again. */
16729 clear_glyph_matrix (w
->desired_matrix
);
16733 /* Users who set scroll-conservatively to a large number want
16734 point just above/below the scroll margin. If we ended up
16735 with point's row partially visible, move the window start to
16736 make that row fully visible and out of the margin. */
16737 if (scroll_conservatively
> SCROLL_LIMIT
)
16739 int window_total_lines
16740 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16743 ? min (scroll_margin
, window_total_lines
/ 4)
16745 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16747 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16748 clear_glyph_matrix (w
->desired_matrix
);
16749 if (1 == try_window (window
, it
.current
.pos
,
16750 TRY_WINDOW_CHECK_MARGINS
))
16754 /* If centering point failed to make the whole line visible,
16755 put point at the top instead. That has to make the whole line
16756 visible, if it can be done. */
16757 if (centering_position
== 0)
16760 clear_glyph_matrix (w
->desired_matrix
);
16761 centering_position
= 0;
16767 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16768 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16769 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16771 /* Display the mode line, if we must. */
16772 if ((update_mode_line
16773 /* If window not full width, must redo its mode line
16774 if (a) the window to its side is being redone and
16775 (b) we do a frame-based redisplay. This is a consequence
16776 of how inverted lines are drawn in frame-based redisplay. */
16777 || (!just_this_one_p
16778 && !FRAME_WINDOW_P (f
)
16779 && !WINDOW_FULL_WIDTH_P (w
))
16780 /* Line number to display. */
16781 || w
->base_line_pos
> 0
16782 /* Column number is displayed and different from the one displayed. */
16783 || (w
->column_number_displayed
!= -1
16784 && (w
->column_number_displayed
!= current_column ())))
16785 /* This means that the window has a mode line. */
16786 && (WINDOW_WANTS_MODELINE_P (w
)
16787 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16790 display_mode_lines (w
);
16792 /* If mode line height has changed, arrange for a thorough
16793 immediate redisplay using the correct mode line height. */
16794 if (WINDOW_WANTS_MODELINE_P (w
)
16795 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16797 f
->fonts_changed
= 1;
16798 w
->mode_line_height
= -1;
16799 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16800 = DESIRED_MODE_LINE_HEIGHT (w
);
16803 /* If header line height has changed, arrange for a thorough
16804 immediate redisplay using the correct header line height. */
16805 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16806 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16808 f
->fonts_changed
= 1;
16809 w
->header_line_height
= -1;
16810 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16811 = DESIRED_HEADER_LINE_HEIGHT (w
);
16814 if (f
->fonts_changed
)
16815 goto need_larger_matrices
;
16818 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16820 w
->base_line_pos
= 0;
16821 w
->base_line_number
= 0;
16826 /* When we reach a frame's selected window, redo the frame's menu bar. */
16827 if (update_mode_line
16828 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16830 int redisplay_menu_p
= 0;
16832 if (FRAME_WINDOW_P (f
))
16834 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16835 || defined (HAVE_NS) || defined (USE_GTK)
16836 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16838 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16842 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16844 if (redisplay_menu_p
)
16845 display_menu_bar (w
);
16847 #ifdef HAVE_WINDOW_SYSTEM
16848 if (FRAME_WINDOW_P (f
))
16850 #if defined (USE_GTK) || defined (HAVE_NS)
16851 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16852 redisplay_tool_bar (f
);
16854 if (WINDOWP (f
->tool_bar_window
)
16855 && (FRAME_TOOL_BAR_LINES (f
) > 0
16856 || !NILP (Vauto_resize_tool_bars
))
16857 && redisplay_tool_bar (f
))
16858 ignore_mouse_drag_p
= 1;
16864 #ifdef HAVE_WINDOW_SYSTEM
16865 if (FRAME_WINDOW_P (f
)
16866 && update_window_fringes (w
, (just_this_one_p
16867 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16868 || w
->pseudo_window_p
)))
16872 if (draw_window_fringes (w
, 1))
16874 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16875 x_draw_right_divider (w
);
16877 x_draw_vertical_border (w
);
16883 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16884 x_draw_bottom_divider (w
);
16885 #endif /* HAVE_WINDOW_SYSTEM */
16887 /* We go to this label, with fonts_changed set, if it is
16888 necessary to try again using larger glyph matrices.
16889 We have to redeem the scroll bar even in this case,
16890 because the loop in redisplay_internal expects that. */
16891 need_larger_matrices
:
16893 finish_scroll_bars
:
16895 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16897 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16898 /* Set the thumb's position and size. */
16899 set_vertical_scroll_bar (w
);
16901 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16902 /* Set the thumb's position and size. */
16903 set_horizontal_scroll_bar (w
);
16905 /* Note that we actually used the scroll bar attached to this
16906 window, so it shouldn't be deleted at the end of redisplay. */
16907 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16908 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16911 /* Restore current_buffer and value of point in it. The window
16912 update may have changed the buffer, so first make sure `opoint'
16913 is still valid (Bug#6177). */
16914 if (CHARPOS (opoint
) < BEGV
)
16915 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16916 else if (CHARPOS (opoint
) > ZV
)
16917 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16919 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16921 set_buffer_internal_1 (old
);
16922 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16923 shorter. This can be caused by log truncation in *Messages*. */
16924 if (CHARPOS (lpoint
) <= ZV
)
16925 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16927 unbind_to (count
, Qnil
);
16931 /* Build the complete desired matrix of WINDOW with a window start
16932 buffer position POS.
16934 Value is 1 if successful. It is zero if fonts were loaded during
16935 redisplay which makes re-adjusting glyph matrices necessary, and -1
16936 if point would appear in the scroll margins.
16937 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16938 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16942 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16944 struct window
*w
= XWINDOW (window
);
16946 struct glyph_row
*last_text_row
= NULL
;
16947 struct frame
*f
= XFRAME (w
->frame
);
16948 int frame_line_height
= default_line_pixel_height (w
);
16950 /* Make POS the new window start. */
16951 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16953 /* Mark cursor position as unknown. No overlay arrow seen. */
16954 w
->cursor
.vpos
= -1;
16955 overlay_arrow_seen
= 0;
16957 /* Initialize iterator and info to start at POS. */
16958 start_display (&it
, w
, pos
);
16959 it
.glyph_row
->reversed_p
= false;
16961 /* Display all lines of W. */
16962 while (it
.current_y
< it
.last_visible_y
)
16964 if (display_line (&it
))
16965 last_text_row
= it
.glyph_row
- 1;
16966 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16970 /* Don't let the cursor end in the scroll margins. */
16971 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16972 && !MINI_WINDOW_P (w
))
16974 int this_scroll_margin
;
16975 int window_total_lines
16976 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16978 if (scroll_margin
> 0)
16980 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16981 this_scroll_margin
*= frame_line_height
;
16984 this_scroll_margin
= 0;
16986 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16987 && w
->cursor
.y
< this_scroll_margin
16988 && CHARPOS (pos
) > BEGV
16989 && IT_CHARPOS (it
) < ZV
)
16990 /* rms: considering make_cursor_line_fully_visible_p here
16991 seems to give wrong results. We don't want to recenter
16992 when the last line is partly visible, we want to allow
16993 that case to be handled in the usual way. */
16994 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16996 w
->cursor
.vpos
= -1;
16997 clear_glyph_matrix (w
->desired_matrix
);
17002 /* If bottom moved off end of frame, change mode line percentage. */
17003 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17004 w
->update_mode_line
= 1;
17006 /* Set window_end_pos to the offset of the last character displayed
17007 on the window from the end of current_buffer. Set
17008 window_end_vpos to its row number. */
17011 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17012 adjust_window_ends (w
, last_text_row
, 0);
17014 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17015 w
->window_end_vpos
)));
17019 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17020 w
->window_end_pos
= Z
- ZV
;
17021 w
->window_end_vpos
= 0;
17024 /* But that is not valid info until redisplay finishes. */
17025 w
->window_end_valid
= 0;
17031 /************************************************************************
17032 Window redisplay reusing current matrix when buffer has not changed
17033 ************************************************************************/
17035 /* Try redisplay of window W showing an unchanged buffer with a
17036 different window start than the last time it was displayed by
17037 reusing its current matrix. Value is non-zero if successful.
17038 W->start is the new window start. */
17041 try_window_reusing_current_matrix (struct window
*w
)
17043 struct frame
*f
= XFRAME (w
->frame
);
17044 struct glyph_row
*bottom_row
;
17047 struct text_pos start
, new_start
;
17048 int nrows_scrolled
, i
;
17049 struct glyph_row
*last_text_row
;
17050 struct glyph_row
*last_reused_text_row
;
17051 struct glyph_row
*start_row
;
17052 int start_vpos
, min_y
, max_y
;
17055 if (inhibit_try_window_reusing
)
17059 #ifdef HAVE_XWIDGETS_xxx
17060 //currently this is needed to detect xwidget movement reliably. or probably not.
17061 printf("try_window_reusing_current_matrix\n");
17066 if (/* This function doesn't handle terminal frames. */
17067 !FRAME_WINDOW_P (f
)
17068 /* Don't try to reuse the display if windows have been split
17070 || windows_or_buffers_changed
17071 || f
->cursor_type_changed
)
17074 /* Can't do this if showing trailing whitespace. */
17075 if (!NILP (Vshow_trailing_whitespace
))
17078 /* If top-line visibility has changed, give up. */
17079 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17080 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17083 /* Give up if old or new display is scrolled vertically. We could
17084 make this function handle this, but right now it doesn't. */
17085 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17086 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17089 /* The variable new_start now holds the new window start. The old
17090 start `start' can be determined from the current matrix. */
17091 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17092 start
= start_row
->minpos
;
17093 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17095 /* Clear the desired matrix for the display below. */
17096 clear_glyph_matrix (w
->desired_matrix
);
17098 if (CHARPOS (new_start
) <= CHARPOS (start
))
17100 /* Don't use this method if the display starts with an ellipsis
17101 displayed for invisible text. It's not easy to handle that case
17102 below, and it's certainly not worth the effort since this is
17103 not a frequent case. */
17104 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17107 IF_DEBUG (debug_method_add (w
, "twu1"));
17109 /* Display up to a row that can be reused. The variable
17110 last_text_row is set to the last row displayed that displays
17111 text. Note that it.vpos == 0 if or if not there is a
17112 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17113 start_display (&it
, w
, new_start
);
17114 w
->cursor
.vpos
= -1;
17115 last_text_row
= last_reused_text_row
= NULL
;
17117 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17119 /* If we have reached into the characters in the START row,
17120 that means the line boundaries have changed. So we
17121 can't start copying with the row START. Maybe it will
17122 work to start copying with the following row. */
17123 while (IT_CHARPOS (it
) > CHARPOS (start
))
17125 /* Advance to the next row as the "start". */
17127 start
= start_row
->minpos
;
17128 /* If there are no more rows to try, or just one, give up. */
17129 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17130 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17131 || CHARPOS (start
) == ZV
)
17133 clear_glyph_matrix (w
->desired_matrix
);
17137 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17139 /* If we have reached alignment, we can copy the rest of the
17141 if (IT_CHARPOS (it
) == CHARPOS (start
)
17142 /* Don't accept "alignment" inside a display vector,
17143 since start_row could have started in the middle of
17144 that same display vector (thus their character
17145 positions match), and we have no way of telling if
17146 that is the case. */
17147 && it
.current
.dpvec_index
< 0)
17150 it
.glyph_row
->reversed_p
= false;
17151 if (display_line (&it
))
17152 last_text_row
= it
.glyph_row
- 1;
17156 /* A value of current_y < last_visible_y means that we stopped
17157 at the previous window start, which in turn means that we
17158 have at least one reusable row. */
17159 if (it
.current_y
< it
.last_visible_y
)
17161 struct glyph_row
*row
;
17163 /* IT.vpos always starts from 0; it counts text lines. */
17164 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17166 /* Find PT if not already found in the lines displayed. */
17167 if (w
->cursor
.vpos
< 0)
17169 int dy
= it
.current_y
- start_row
->y
;
17171 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17172 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17174 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17175 dy
, nrows_scrolled
);
17178 clear_glyph_matrix (w
->desired_matrix
);
17183 /* Scroll the display. Do it before the current matrix is
17184 changed. The problem here is that update has not yet
17185 run, i.e. part of the current matrix is not up to date.
17186 scroll_run_hook will clear the cursor, and use the
17187 current matrix to get the height of the row the cursor is
17189 run
.current_y
= start_row
->y
;
17190 run
.desired_y
= it
.current_y
;
17191 run
.height
= it
.last_visible_y
- it
.current_y
;
17193 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17196 FRAME_RIF (f
)->update_window_begin_hook (w
);
17197 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17198 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17199 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17203 /* Shift current matrix down by nrows_scrolled lines. */
17204 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17205 rotate_matrix (w
->current_matrix
,
17207 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17210 /* Disable lines that must be updated. */
17211 for (i
= 0; i
< nrows_scrolled
; ++i
)
17212 (start_row
+ i
)->enabled_p
= false;
17214 /* Re-compute Y positions. */
17215 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17216 max_y
= it
.last_visible_y
;
17217 for (row
= start_row
+ nrows_scrolled
;
17221 row
->y
= it
.current_y
;
17222 row
->visible_height
= row
->height
;
17224 if (row
->y
< min_y
)
17225 row
->visible_height
-= min_y
- row
->y
;
17226 if (row
->y
+ row
->height
> max_y
)
17227 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17228 if (row
->fringe_bitmap_periodic_p
)
17229 row
->redraw_fringe_bitmaps_p
= 1;
17231 it
.current_y
+= row
->height
;
17233 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17234 last_reused_text_row
= row
;
17235 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17239 /* Disable lines in the current matrix which are now
17240 below the window. */
17241 for (++row
; row
< bottom_row
; ++row
)
17242 row
->enabled_p
= row
->mode_line_p
= 0;
17245 /* Update window_end_pos etc.; last_reused_text_row is the last
17246 reused row from the current matrix containing text, if any.
17247 The value of last_text_row is the last displayed line
17248 containing text. */
17249 if (last_reused_text_row
)
17250 adjust_window_ends (w
, last_reused_text_row
, 1);
17251 else if (last_text_row
)
17252 adjust_window_ends (w
, last_text_row
, 0);
17255 /* This window must be completely empty. */
17256 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17257 w
->window_end_pos
= Z
- ZV
;
17258 w
->window_end_vpos
= 0;
17260 w
->window_end_valid
= 0;
17262 /* Update hint: don't try scrolling again in update_window. */
17263 w
->desired_matrix
->no_scrolling_p
= 1;
17266 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17270 else if (CHARPOS (new_start
) > CHARPOS (start
))
17272 struct glyph_row
*pt_row
, *row
;
17273 struct glyph_row
*first_reusable_row
;
17274 struct glyph_row
*first_row_to_display
;
17276 int yb
= window_text_bottom_y (w
);
17278 /* Find the row starting at new_start, if there is one. Don't
17279 reuse a partially visible line at the end. */
17280 first_reusable_row
= start_row
;
17281 while (first_reusable_row
->enabled_p
17282 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17283 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17284 < CHARPOS (new_start
)))
17285 ++first_reusable_row
;
17287 /* Give up if there is no row to reuse. */
17288 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17289 || !first_reusable_row
->enabled_p
17290 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17291 != CHARPOS (new_start
)))
17294 /* We can reuse fully visible rows beginning with
17295 first_reusable_row to the end of the window. Set
17296 first_row_to_display to the first row that cannot be reused.
17297 Set pt_row to the row containing point, if there is any. */
17299 for (first_row_to_display
= first_reusable_row
;
17300 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17301 ++first_row_to_display
)
17303 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17304 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17305 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17306 && first_row_to_display
->ends_at_zv_p
17307 && pt_row
== NULL
)))
17308 pt_row
= first_row_to_display
;
17311 /* Start displaying at the start of first_row_to_display. */
17312 eassert (first_row_to_display
->y
< yb
);
17313 init_to_row_start (&it
, w
, first_row_to_display
);
17315 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17317 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17319 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17320 + WINDOW_HEADER_LINE_HEIGHT (w
));
17322 /* Display lines beginning with first_row_to_display in the
17323 desired matrix. Set last_text_row to the last row displayed
17324 that displays text. */
17325 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17326 if (pt_row
== NULL
)
17327 w
->cursor
.vpos
= -1;
17328 last_text_row
= NULL
;
17329 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17330 if (display_line (&it
))
17331 last_text_row
= it
.glyph_row
- 1;
17333 /* If point is in a reused row, adjust y and vpos of the cursor
17337 w
->cursor
.vpos
-= nrows_scrolled
;
17338 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17341 /* Give up if point isn't in a row displayed or reused. (This
17342 also handles the case where w->cursor.vpos < nrows_scrolled
17343 after the calls to display_line, which can happen with scroll
17344 margins. See bug#1295.) */
17345 if (w
->cursor
.vpos
< 0)
17347 clear_glyph_matrix (w
->desired_matrix
);
17351 /* Scroll the display. */
17352 run
.current_y
= first_reusable_row
->y
;
17353 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17354 run
.height
= it
.last_visible_y
- run
.current_y
;
17355 dy
= run
.current_y
- run
.desired_y
;
17360 FRAME_RIF (f
)->update_window_begin_hook (w
);
17361 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17362 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17363 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17367 /* Adjust Y positions of reused rows. */
17368 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17369 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17370 max_y
= it
.last_visible_y
;
17371 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17374 row
->visible_height
= row
->height
;
17375 if (row
->y
< min_y
)
17376 row
->visible_height
-= min_y
- row
->y
;
17377 if (row
->y
+ row
->height
> max_y
)
17378 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17379 if (row
->fringe_bitmap_periodic_p
)
17380 row
->redraw_fringe_bitmaps_p
= 1;
17383 /* Scroll the current matrix. */
17384 eassert (nrows_scrolled
> 0);
17385 rotate_matrix (w
->current_matrix
,
17387 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17390 /* Disable rows not reused. */
17391 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17392 row
->enabled_p
= false;
17394 /* Point may have moved to a different line, so we cannot assume that
17395 the previous cursor position is valid; locate the correct row. */
17398 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17400 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17401 && !row
->ends_at_zv_p
;
17405 w
->cursor
.y
= row
->y
;
17407 if (row
< bottom_row
)
17409 /* Can't simply scan the row for point with
17410 bidi-reordered glyph rows. Let set_cursor_from_row
17411 figure out where to put the cursor, and if it fails,
17413 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17415 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17418 clear_glyph_matrix (w
->desired_matrix
);
17424 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17425 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17428 && (!BUFFERP (glyph
->object
)
17429 || glyph
->charpos
< PT
);
17433 w
->cursor
.x
+= glyph
->pixel_width
;
17439 /* Adjust window end. A null value of last_text_row means that
17440 the window end is in reused rows which in turn means that
17441 only its vpos can have changed. */
17443 adjust_window_ends (w
, last_text_row
, 0);
17445 w
->window_end_vpos
-= nrows_scrolled
;
17447 w
->window_end_valid
= 0;
17448 w
->desired_matrix
->no_scrolling_p
= 1;
17451 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17461 /************************************************************************
17462 Window redisplay reusing current matrix when buffer has changed
17463 ************************************************************************/
17465 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17466 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17467 ptrdiff_t *, ptrdiff_t *);
17468 static struct glyph_row
*
17469 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17470 struct glyph_row
*);
17473 /* Return the last row in MATRIX displaying text. If row START is
17474 non-null, start searching with that row. IT gives the dimensions
17475 of the display. Value is null if matrix is empty; otherwise it is
17476 a pointer to the row found. */
17478 static struct glyph_row
*
17479 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17480 struct glyph_row
*start
)
17482 struct glyph_row
*row
, *row_found
;
17484 /* Set row_found to the last row in IT->w's current matrix
17485 displaying text. The loop looks funny but think of partially
17488 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17489 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17491 eassert (row
->enabled_p
);
17493 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17502 /* Return the last row in the current matrix of W that is not affected
17503 by changes at the start of current_buffer that occurred since W's
17504 current matrix was built. Value is null if no such row exists.
17506 BEG_UNCHANGED us the number of characters unchanged at the start of
17507 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17508 first changed character in current_buffer. Characters at positions <
17509 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17510 when the current matrix was built. */
17512 static struct glyph_row
*
17513 find_last_unchanged_at_beg_row (struct window
*w
)
17515 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17516 struct glyph_row
*row
;
17517 struct glyph_row
*row_found
= NULL
;
17518 int yb
= window_text_bottom_y (w
);
17520 /* Find the last row displaying unchanged text. */
17521 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17522 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17523 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17526 if (/* If row ends before first_changed_pos, it is unchanged,
17527 except in some case. */
17528 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17529 /* When row ends in ZV and we write at ZV it is not
17531 && !row
->ends_at_zv_p
17532 /* When first_changed_pos is the end of a continued line,
17533 row is not unchanged because it may be no longer
17535 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17536 && (row
->continued_p
17537 || row
->exact_window_width_line_p
))
17538 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17539 needs to be recomputed, so don't consider this row as
17540 unchanged. This happens when the last line was
17541 bidi-reordered and was killed immediately before this
17542 redisplay cycle. In that case, ROW->end stores the
17543 buffer position of the first visual-order character of
17544 the killed text, which is now beyond ZV. */
17545 && CHARPOS (row
->end
.pos
) <= ZV
)
17548 /* Stop if last visible row. */
17549 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17557 /* Find the first glyph row in the current matrix of W that is not
17558 affected by changes at the end of current_buffer since the
17559 time W's current matrix was built.
17561 Return in *DELTA the number of chars by which buffer positions in
17562 unchanged text at the end of current_buffer must be adjusted.
17564 Return in *DELTA_BYTES the corresponding number of bytes.
17566 Value is null if no such row exists, i.e. all rows are affected by
17569 static struct glyph_row
*
17570 find_first_unchanged_at_end_row (struct window
*w
,
17571 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17573 struct glyph_row
*row
;
17574 struct glyph_row
*row_found
= NULL
;
17576 *delta
= *delta_bytes
= 0;
17578 /* Display must not have been paused, otherwise the current matrix
17579 is not up to date. */
17580 eassert (w
->window_end_valid
);
17582 /* A value of window_end_pos >= END_UNCHANGED means that the window
17583 end is in the range of changed text. If so, there is no
17584 unchanged row at the end of W's current matrix. */
17585 if (w
->window_end_pos
>= END_UNCHANGED
)
17588 /* Set row to the last row in W's current matrix displaying text. */
17589 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17591 /* If matrix is entirely empty, no unchanged row exists. */
17592 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17594 /* The value of row is the last glyph row in the matrix having a
17595 meaningful buffer position in it. The end position of row
17596 corresponds to window_end_pos. This allows us to translate
17597 buffer positions in the current matrix to current buffer
17598 positions for characters not in changed text. */
17600 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17601 ptrdiff_t Z_BYTE_old
=
17602 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17603 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17604 struct glyph_row
*first_text_row
17605 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17607 *delta
= Z
- Z_old
;
17608 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17610 /* Set last_unchanged_pos to the buffer position of the last
17611 character in the buffer that has not been changed. Z is the
17612 index + 1 of the last character in current_buffer, i.e. by
17613 subtracting END_UNCHANGED we get the index of the last
17614 unchanged character, and we have to add BEG to get its buffer
17616 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17617 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17619 /* Search backward from ROW for a row displaying a line that
17620 starts at a minimum position >= last_unchanged_pos_old. */
17621 for (; row
> first_text_row
; --row
)
17623 /* This used to abort, but it can happen.
17624 It is ok to just stop the search instead here. KFS. */
17625 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17628 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17633 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17639 /* Make sure that glyph rows in the current matrix of window W
17640 reference the same glyph memory as corresponding rows in the
17641 frame's frame matrix. This function is called after scrolling W's
17642 current matrix on a terminal frame in try_window_id and
17643 try_window_reusing_current_matrix. */
17646 sync_frame_with_window_matrix_rows (struct window
*w
)
17648 struct frame
*f
= XFRAME (w
->frame
);
17649 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17651 /* Preconditions: W must be a leaf window and full-width. Its frame
17652 must have a frame matrix. */
17653 eassert (BUFFERP (w
->contents
));
17654 eassert (WINDOW_FULL_WIDTH_P (w
));
17655 eassert (!FRAME_WINDOW_P (f
));
17657 /* If W is a full-width window, glyph pointers in W's current matrix
17658 have, by definition, to be the same as glyph pointers in the
17659 corresponding frame matrix. Note that frame matrices have no
17660 marginal areas (see build_frame_matrix). */
17661 window_row
= w
->current_matrix
->rows
;
17662 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17663 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17664 while (window_row
< window_row_end
)
17666 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17667 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17669 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17670 frame_row
->glyphs
[TEXT_AREA
] = start
;
17671 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17672 frame_row
->glyphs
[LAST_AREA
] = end
;
17674 /* Disable frame rows whose corresponding window rows have
17675 been disabled in try_window_id. */
17676 if (!window_row
->enabled_p
)
17677 frame_row
->enabled_p
= false;
17679 ++window_row
, ++frame_row
;
17684 /* Find the glyph row in window W containing CHARPOS. Consider all
17685 rows between START and END (not inclusive). END null means search
17686 all rows to the end of the display area of W. Value is the row
17687 containing CHARPOS or null. */
17690 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17691 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17693 struct glyph_row
*row
= start
;
17694 struct glyph_row
*best_row
= NULL
;
17695 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17698 /* If we happen to start on a header-line, skip that. */
17699 if (row
->mode_line_p
)
17702 if ((end
&& row
>= end
) || !row
->enabled_p
)
17705 last_y
= window_text_bottom_y (w
) - dy
;
17709 /* Give up if we have gone too far. */
17710 if (end
&& row
>= end
)
17712 /* This formerly returned if they were equal.
17713 I think that both quantities are of a "last plus one" type;
17714 if so, when they are equal, the row is within the screen. -- rms. */
17715 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17718 /* If it is in this row, return this row. */
17719 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17720 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17721 /* The end position of a row equals the start
17722 position of the next row. If CHARPOS is there, we
17723 would rather consider it displayed in the next
17724 line, except when this line ends in ZV. */
17725 && !row_for_charpos_p (row
, charpos
)))
17726 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17730 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17731 || (!best_row
&& !row
->continued_p
))
17733 /* In bidi-reordered rows, there could be several rows whose
17734 edges surround CHARPOS, all of these rows belonging to
17735 the same continued line. We need to find the row which
17736 fits CHARPOS the best. */
17737 for (g
= row
->glyphs
[TEXT_AREA
];
17738 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17741 if (!STRINGP (g
->object
))
17743 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17745 mindif
= eabs (g
->charpos
- charpos
);
17747 /* Exact match always wins. */
17754 else if (best_row
&& !row
->continued_p
)
17761 /* Try to redisplay window W by reusing its existing display. W's
17762 current matrix must be up to date when this function is called,
17763 i.e. window_end_valid must be nonzero.
17767 >= 1 if successful, i.e. display has been updated
17769 1 means the changes were in front of a newline that precedes
17770 the window start, and the whole current matrix was reused
17771 2 means the changes were after the last position displayed
17772 in the window, and the whole current matrix was reused
17773 3 means portions of the current matrix were reused, while
17774 some of the screen lines were redrawn
17775 -1 if redisplay with same window start is known not to succeed
17776 0 if otherwise unsuccessful
17778 The following steps are performed:
17780 1. Find the last row in the current matrix of W that is not
17781 affected by changes at the start of current_buffer. If no such row
17784 2. Find the first row in W's current matrix that is not affected by
17785 changes at the end of current_buffer. Maybe there is no such row.
17787 3. Display lines beginning with the row + 1 found in step 1 to the
17788 row found in step 2 or, if step 2 didn't find a row, to the end of
17791 4. If cursor is not known to appear on the window, give up.
17793 5. If display stopped at the row found in step 2, scroll the
17794 display and current matrix as needed.
17796 6. Maybe display some lines at the end of W, if we must. This can
17797 happen under various circumstances, like a partially visible line
17798 becoming fully visible, or because newly displayed lines are displayed
17799 in smaller font sizes.
17801 7. Update W's window end information. */
17804 try_window_id (struct window
*w
)
17806 struct frame
*f
= XFRAME (w
->frame
);
17807 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17808 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17809 struct glyph_row
*last_unchanged_at_beg_row
;
17810 struct glyph_row
*first_unchanged_at_end_row
;
17811 struct glyph_row
*row
;
17812 struct glyph_row
*bottom_row
;
17815 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17817 struct text_pos start_pos
;
17819 int first_unchanged_at_end_vpos
= 0;
17820 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17821 struct text_pos start
;
17822 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17825 if (inhibit_try_window_id
)
17829 /* This is handy for debugging. */
17831 #define GIVE_UP(X) \
17833 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17837 #define GIVE_UP(X) return 0
17840 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17842 /* Don't use this for mini-windows because these can show
17843 messages and mini-buffers, and we don't handle that here. */
17844 if (MINI_WINDOW_P (w
))
17847 /* This flag is used to prevent redisplay optimizations. */
17848 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17851 /* This function's optimizations cannot be used if overlays have
17852 changed in the buffer displayed by the window, so give up if they
17854 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17857 /* Verify that narrowing has not changed.
17858 Also verify that we were not told to prevent redisplay optimizations.
17859 It would be nice to further
17860 reduce the number of cases where this prevents try_window_id. */
17861 if (current_buffer
->clip_changed
17862 || current_buffer
->prevent_redisplay_optimizations_p
)
17865 /* Window must either use window-based redisplay or be full width. */
17866 if (!FRAME_WINDOW_P (f
)
17867 && (!FRAME_LINE_INS_DEL_OK (f
)
17868 || !WINDOW_FULL_WIDTH_P (w
)))
17871 /* Give up if point is known NOT to appear in W. */
17872 if (PT
< CHARPOS (start
))
17875 /* Another way to prevent redisplay optimizations. */
17876 if (w
->last_modified
== 0)
17879 /* Verify that window is not hscrolled. */
17880 if (w
->hscroll
!= 0)
17883 /* Verify that display wasn't paused. */
17884 if (!w
->window_end_valid
)
17887 /* Likewise if highlighting trailing whitespace. */
17888 if (!NILP (Vshow_trailing_whitespace
))
17891 /* Can't use this if overlay arrow position and/or string have
17893 if (overlay_arrows_changed_p ())
17896 /* When word-wrap is on, adding a space to the first word of a
17897 wrapped line can change the wrap position, altering the line
17898 above it. It might be worthwhile to handle this more
17899 intelligently, but for now just redisplay from scratch. */
17900 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17903 /* Under bidi reordering, adding or deleting a character in the
17904 beginning of a paragraph, before the first strong directional
17905 character, can change the base direction of the paragraph (unless
17906 the buffer specifies a fixed paragraph direction), which will
17907 require to redisplay the whole paragraph. It might be worthwhile
17908 to find the paragraph limits and widen the range of redisplayed
17909 lines to that, but for now just give up this optimization and
17910 redisplay from scratch. */
17911 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17912 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17915 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17916 only if buffer has really changed. The reason is that the gap is
17917 initially at Z for freshly visited files. The code below would
17918 set end_unchanged to 0 in that case. */
17919 if (MODIFF
> SAVE_MODIFF
17920 /* This seems to happen sometimes after saving a buffer. */
17921 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17923 if (GPT
- BEG
< BEG_UNCHANGED
)
17924 BEG_UNCHANGED
= GPT
- BEG
;
17925 if (Z
- GPT
< END_UNCHANGED
)
17926 END_UNCHANGED
= Z
- GPT
;
17929 /* The position of the first and last character that has been changed. */
17930 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17931 last_changed_charpos
= Z
- END_UNCHANGED
;
17933 /* If window starts after a line end, and the last change is in
17934 front of that newline, then changes don't affect the display.
17935 This case happens with stealth-fontification. Note that although
17936 the display is unchanged, glyph positions in the matrix have to
17937 be adjusted, of course. */
17938 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17939 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17940 && ((last_changed_charpos
< CHARPOS (start
)
17941 && CHARPOS (start
) == BEGV
)
17942 || (last_changed_charpos
< CHARPOS (start
) - 1
17943 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17945 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17946 struct glyph_row
*r0
;
17948 /* Compute how many chars/bytes have been added to or removed
17949 from the buffer. */
17950 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17951 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17952 Z_delta
= Z
- Z_old
;
17953 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17955 /* Give up if PT is not in the window. Note that it already has
17956 been checked at the start of try_window_id that PT is not in
17957 front of the window start. */
17958 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17961 /* If window start is unchanged, we can reuse the whole matrix
17962 as is, after adjusting glyph positions. No need to compute
17963 the window end again, since its offset from Z hasn't changed. */
17964 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17965 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17966 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17967 /* PT must not be in a partially visible line. */
17968 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17969 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17971 /* Adjust positions in the glyph matrix. */
17972 if (Z_delta
|| Z_delta_bytes
)
17974 struct glyph_row
*r1
17975 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17976 increment_matrix_positions (w
->current_matrix
,
17977 MATRIX_ROW_VPOS (r0
, current_matrix
),
17978 MATRIX_ROW_VPOS (r1
, current_matrix
),
17979 Z_delta
, Z_delta_bytes
);
17982 /* Set the cursor. */
17983 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17985 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17990 /* Handle the case that changes are all below what is displayed in
17991 the window, and that PT is in the window. This shortcut cannot
17992 be taken if ZV is visible in the window, and text has been added
17993 there that is visible in the window. */
17994 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17995 /* ZV is not visible in the window, or there are no
17996 changes at ZV, actually. */
17997 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17998 || first_changed_charpos
== last_changed_charpos
))
18000 struct glyph_row
*r0
;
18002 /* Give up if PT is not in the window. Note that it already has
18003 been checked at the start of try_window_id that PT is not in
18004 front of the window start. */
18005 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18008 /* If window start is unchanged, we can reuse the whole matrix
18009 as is, without changing glyph positions since no text has
18010 been added/removed in front of the window end. */
18011 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18012 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18013 /* PT must not be in a partially visible line. */
18014 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18015 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18017 /* We have to compute the window end anew since text
18018 could have been added/removed after it. */
18019 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18020 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18022 /* Set the cursor. */
18023 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18025 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18030 /* Give up if window start is in the changed area.
18032 The condition used to read
18034 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18036 but why that was tested escapes me at the moment. */
18037 if (CHARPOS (start
) >= first_changed_charpos
18038 && CHARPOS (start
) <= last_changed_charpos
)
18041 /* Check that window start agrees with the start of the first glyph
18042 row in its current matrix. Check this after we know the window
18043 start is not in changed text, otherwise positions would not be
18045 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18046 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18049 /* Give up if the window ends in strings. Overlay strings
18050 at the end are difficult to handle, so don't try. */
18051 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18052 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18055 /* Compute the position at which we have to start displaying new
18056 lines. Some of the lines at the top of the window might be
18057 reusable because they are not displaying changed text. Find the
18058 last row in W's current matrix not affected by changes at the
18059 start of current_buffer. Value is null if changes start in the
18060 first line of window. */
18061 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18062 if (last_unchanged_at_beg_row
)
18064 /* Avoid starting to display in the middle of a character, a TAB
18065 for instance. This is easier than to set up the iterator
18066 exactly, and it's not a frequent case, so the additional
18067 effort wouldn't really pay off. */
18068 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18069 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18070 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18071 --last_unchanged_at_beg_row
;
18073 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18076 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18078 start_pos
= it
.current
.pos
;
18080 /* Start displaying new lines in the desired matrix at the same
18081 vpos we would use in the current matrix, i.e. below
18082 last_unchanged_at_beg_row. */
18083 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18085 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18086 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18088 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18092 /* There are no reusable lines at the start of the window.
18093 Start displaying in the first text line. */
18094 start_display (&it
, w
, start
);
18095 it
.vpos
= it
.first_vpos
;
18096 start_pos
= it
.current
.pos
;
18099 /* Find the first row that is not affected by changes at the end of
18100 the buffer. Value will be null if there is no unchanged row, in
18101 which case we must redisplay to the end of the window. delta
18102 will be set to the value by which buffer positions beginning with
18103 first_unchanged_at_end_row have to be adjusted due to text
18105 first_unchanged_at_end_row
18106 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18107 IF_DEBUG (debug_delta
= delta
);
18108 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18110 /* Set stop_pos to the buffer position up to which we will have to
18111 display new lines. If first_unchanged_at_end_row != NULL, this
18112 is the buffer position of the start of the line displayed in that
18113 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18114 that we don't stop at a buffer position. */
18116 if (first_unchanged_at_end_row
)
18118 eassert (last_unchanged_at_beg_row
== NULL
18119 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18121 /* If this is a continuation line, move forward to the next one
18122 that isn't. Changes in lines above affect this line.
18123 Caution: this may move first_unchanged_at_end_row to a row
18124 not displaying text. */
18125 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18126 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18127 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18128 < it
.last_visible_y
))
18129 ++first_unchanged_at_end_row
;
18131 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18132 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18133 >= it
.last_visible_y
))
18134 first_unchanged_at_end_row
= NULL
;
18137 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18139 first_unchanged_at_end_vpos
18140 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18141 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18144 else if (last_unchanged_at_beg_row
== NULL
)
18150 /* Either there is no unchanged row at the end, or the one we have
18151 now displays text. This is a necessary condition for the window
18152 end pos calculation at the end of this function. */
18153 eassert (first_unchanged_at_end_row
== NULL
18154 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18156 debug_last_unchanged_at_beg_vpos
18157 = (last_unchanged_at_beg_row
18158 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18160 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18162 #endif /* GLYPH_DEBUG */
18165 /* Display new lines. Set last_text_row to the last new line
18166 displayed which has text on it, i.e. might end up as being the
18167 line where the window_end_vpos is. */
18168 w
->cursor
.vpos
= -1;
18169 last_text_row
= NULL
;
18170 overlay_arrow_seen
= 0;
18171 if (it
.current_y
< it
.last_visible_y
18172 && !f
->fonts_changed
18173 && (first_unchanged_at_end_row
== NULL
18174 || IT_CHARPOS (it
) < stop_pos
))
18175 it
.glyph_row
->reversed_p
= false;
18176 while (it
.current_y
< it
.last_visible_y
18177 && !f
->fonts_changed
18178 && (first_unchanged_at_end_row
== NULL
18179 || IT_CHARPOS (it
) < stop_pos
))
18181 if (display_line (&it
))
18182 last_text_row
= it
.glyph_row
- 1;
18185 if (f
->fonts_changed
)
18188 /* The redisplay iterations in display_line above could have
18189 triggered font-lock, which could have done something that
18190 invalidates IT->w window's end-point information, on which we
18191 rely below. E.g., one package, which will remain unnamed, used
18192 to install a font-lock-fontify-region-function that called
18193 bury-buffer, whose side effect is to switch the buffer displayed
18194 by IT->w, and that predictably resets IT->w's window_end_valid
18195 flag, which we already tested at the entry to this function.
18196 Amply punish such packages/modes by giving up on this
18197 optimization in those cases. */
18198 if (!w
->window_end_valid
)
18200 clear_glyph_matrix (w
->desired_matrix
);
18204 /* Compute differences in buffer positions, y-positions etc. for
18205 lines reused at the bottom of the window. Compute what we can
18207 if (first_unchanged_at_end_row
18208 /* No lines reused because we displayed everything up to the
18209 bottom of the window. */
18210 && it
.current_y
< it
.last_visible_y
)
18213 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18215 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18216 run
.current_y
= first_unchanged_at_end_row
->y
;
18217 run
.desired_y
= run
.current_y
+ dy
;
18218 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18222 delta
= delta_bytes
= dvpos
= dy
18223 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18224 first_unchanged_at_end_row
= NULL
;
18226 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18229 /* Find the cursor if not already found. We have to decide whether
18230 PT will appear on this window (it sometimes doesn't, but this is
18231 not a very frequent case.) This decision has to be made before
18232 the current matrix is altered. A value of cursor.vpos < 0 means
18233 that PT is either in one of the lines beginning at
18234 first_unchanged_at_end_row or below the window. Don't care for
18235 lines that might be displayed later at the window end; as
18236 mentioned, this is not a frequent case. */
18237 if (w
->cursor
.vpos
< 0)
18239 /* Cursor in unchanged rows at the top? */
18240 if (PT
< CHARPOS (start_pos
)
18241 && last_unchanged_at_beg_row
)
18243 row
= row_containing_pos (w
, PT
,
18244 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18245 last_unchanged_at_beg_row
+ 1, 0);
18247 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18250 /* Start from first_unchanged_at_end_row looking for PT. */
18251 else if (first_unchanged_at_end_row
)
18253 row
= row_containing_pos (w
, PT
- delta
,
18254 first_unchanged_at_end_row
, NULL
, 0);
18256 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18257 delta_bytes
, dy
, dvpos
);
18260 /* Give up if cursor was not found. */
18261 if (w
->cursor
.vpos
< 0)
18263 clear_glyph_matrix (w
->desired_matrix
);
18268 /* Don't let the cursor end in the scroll margins. */
18270 int this_scroll_margin
, cursor_height
;
18271 int frame_line_height
= default_line_pixel_height (w
);
18272 int window_total_lines
18273 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18275 this_scroll_margin
=
18276 max (0, min (scroll_margin
, window_total_lines
/ 4));
18277 this_scroll_margin
*= frame_line_height
;
18278 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18280 if ((w
->cursor
.y
< this_scroll_margin
18281 && CHARPOS (start
) > BEGV
)
18282 /* Old redisplay didn't take scroll margin into account at the bottom,
18283 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18284 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18285 ? cursor_height
+ this_scroll_margin
18286 : 1)) > it
.last_visible_y
)
18288 w
->cursor
.vpos
= -1;
18289 clear_glyph_matrix (w
->desired_matrix
);
18294 /* Scroll the display. Do it before changing the current matrix so
18295 that xterm.c doesn't get confused about where the cursor glyph is
18297 if (dy
&& run
.height
)
18301 if (FRAME_WINDOW_P (f
))
18303 FRAME_RIF (f
)->update_window_begin_hook (w
);
18304 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18305 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18306 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18310 /* Terminal frame. In this case, dvpos gives the number of
18311 lines to scroll by; dvpos < 0 means scroll up. */
18313 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18314 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18315 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18316 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18317 + window_internal_height (w
));
18319 #if defined (HAVE_GPM) || defined (MSDOS)
18320 x_clear_window_mouse_face (w
);
18322 /* Perform the operation on the screen. */
18325 /* Scroll last_unchanged_at_beg_row to the end of the
18326 window down dvpos lines. */
18327 set_terminal_window (f
, end
);
18329 /* On dumb terminals delete dvpos lines at the end
18330 before inserting dvpos empty lines. */
18331 if (!FRAME_SCROLL_REGION_OK (f
))
18332 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18334 /* Insert dvpos empty lines in front of
18335 last_unchanged_at_beg_row. */
18336 ins_del_lines (f
, from
, dvpos
);
18338 else if (dvpos
< 0)
18340 /* Scroll up last_unchanged_at_beg_vpos to the end of
18341 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18342 set_terminal_window (f
, end
);
18344 /* Delete dvpos lines in front of
18345 last_unchanged_at_beg_vpos. ins_del_lines will set
18346 the cursor to the given vpos and emit |dvpos| delete
18348 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18350 /* On a dumb terminal insert dvpos empty lines at the
18352 if (!FRAME_SCROLL_REGION_OK (f
))
18353 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18356 set_terminal_window (f
, 0);
18362 /* Shift reused rows of the current matrix to the right position.
18363 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18365 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18366 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18369 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18370 bottom_vpos
, dvpos
);
18371 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18374 else if (dvpos
> 0)
18376 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18377 bottom_vpos
, dvpos
);
18378 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18379 first_unchanged_at_end_vpos
+ dvpos
);
18382 /* For frame-based redisplay, make sure that current frame and window
18383 matrix are in sync with respect to glyph memory. */
18384 if (!FRAME_WINDOW_P (f
))
18385 sync_frame_with_window_matrix_rows (w
);
18387 /* Adjust buffer positions in reused rows. */
18388 if (delta
|| delta_bytes
)
18389 increment_matrix_positions (current_matrix
,
18390 first_unchanged_at_end_vpos
+ dvpos
,
18391 bottom_vpos
, delta
, delta_bytes
);
18393 /* Adjust Y positions. */
18395 shift_glyph_matrix (w
, current_matrix
,
18396 first_unchanged_at_end_vpos
+ dvpos
,
18399 if (first_unchanged_at_end_row
)
18401 first_unchanged_at_end_row
+= dvpos
;
18402 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18403 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18404 first_unchanged_at_end_row
= NULL
;
18407 /* If scrolling up, there may be some lines to display at the end of
18409 last_text_row_at_end
= NULL
;
18412 /* Scrolling up can leave for example a partially visible line
18413 at the end of the window to be redisplayed. */
18414 /* Set last_row to the glyph row in the current matrix where the
18415 window end line is found. It has been moved up or down in
18416 the matrix by dvpos. */
18417 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18418 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18420 /* If last_row is the window end line, it should display text. */
18421 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18423 /* If window end line was partially visible before, begin
18424 displaying at that line. Otherwise begin displaying with the
18425 line following it. */
18426 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18428 init_to_row_start (&it
, w
, last_row
);
18429 it
.vpos
= last_vpos
;
18430 it
.current_y
= last_row
->y
;
18434 init_to_row_end (&it
, w
, last_row
);
18435 it
.vpos
= 1 + last_vpos
;
18436 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18440 /* We may start in a continuation line. If so, we have to
18441 get the right continuation_lines_width and current_x. */
18442 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18443 it
.hpos
= it
.current_x
= 0;
18445 /* Display the rest of the lines at the window end. */
18446 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18447 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18449 /* Is it always sure that the display agrees with lines in
18450 the current matrix? I don't think so, so we mark rows
18451 displayed invalid in the current matrix by setting their
18452 enabled_p flag to zero. */
18453 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18454 if (display_line (&it
))
18455 last_text_row_at_end
= it
.glyph_row
- 1;
18459 /* Update window_end_pos and window_end_vpos. */
18460 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18462 /* Window end line if one of the preserved rows from the current
18463 matrix. Set row to the last row displaying text in current
18464 matrix starting at first_unchanged_at_end_row, after
18466 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18467 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18468 first_unchanged_at_end_row
);
18469 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18470 adjust_window_ends (w
, row
, 1);
18471 eassert (w
->window_end_bytepos
>= 0);
18472 IF_DEBUG (debug_method_add (w
, "A"));
18474 else if (last_text_row_at_end
)
18476 adjust_window_ends (w
, last_text_row_at_end
, 0);
18477 eassert (w
->window_end_bytepos
>= 0);
18478 IF_DEBUG (debug_method_add (w
, "B"));
18480 else if (last_text_row
)
18482 /* We have displayed either to the end of the window or at the
18483 end of the window, i.e. the last row with text is to be found
18484 in the desired matrix. */
18485 adjust_window_ends (w
, last_text_row
, 0);
18486 eassert (w
->window_end_bytepos
>= 0);
18488 else if (first_unchanged_at_end_row
== NULL
18489 && last_text_row
== NULL
18490 && last_text_row_at_end
== NULL
)
18492 /* Displayed to end of window, but no line containing text was
18493 displayed. Lines were deleted at the end of the window. */
18494 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18495 int vpos
= w
->window_end_vpos
;
18496 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18497 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18500 row
== NULL
&& vpos
>= first_vpos
;
18501 --vpos
, --current_row
, --desired_row
)
18503 if (desired_row
->enabled_p
)
18505 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18508 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18512 eassert (row
!= NULL
);
18513 w
->window_end_vpos
= vpos
+ 1;
18514 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18515 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18516 eassert (w
->window_end_bytepos
>= 0);
18517 IF_DEBUG (debug_method_add (w
, "C"));
18522 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18523 debug_end_vpos
= w
->window_end_vpos
));
18525 /* Record that display has not been completed. */
18526 w
->window_end_valid
= 0;
18527 w
->desired_matrix
->no_scrolling_p
= 1;
18535 /***********************************************************************
18536 More debugging support
18537 ***********************************************************************/
18541 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18542 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18543 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18546 /* Dump the contents of glyph matrix MATRIX on stderr.
18548 GLYPHS 0 means don't show glyph contents.
18549 GLYPHS 1 means show glyphs in short form
18550 GLYPHS > 1 means show glyphs in long form. */
18553 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18556 for (i
= 0; i
< matrix
->nrows
; ++i
)
18557 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18561 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18562 the glyph row and area where the glyph comes from. */
18565 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18567 if (glyph
->type
== CHAR_GLYPH
18568 || glyph
->type
== GLYPHLESS_GLYPH
)
18571 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18572 glyph
- row
->glyphs
[TEXT_AREA
],
18573 (glyph
->type
== CHAR_GLYPH
18577 (BUFFERP (glyph
->object
)
18579 : (STRINGP (glyph
->object
)
18581 : (NILP (glyph
->object
)
18584 glyph
->pixel_width
,
18586 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18590 glyph
->left_box_line_p
,
18591 glyph
->right_box_line_p
);
18593 else if (glyph
->type
== STRETCH_GLYPH
)
18596 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18597 glyph
- row
->glyphs
[TEXT_AREA
],
18600 (BUFFERP (glyph
->object
)
18602 : (STRINGP (glyph
->object
)
18604 : (NILP (glyph
->object
)
18607 glyph
->pixel_width
,
18611 glyph
->left_box_line_p
,
18612 glyph
->right_box_line_p
);
18614 else if (glyph
->type
== IMAGE_GLYPH
)
18617 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18618 glyph
- row
->glyphs
[TEXT_AREA
],
18621 (BUFFERP (glyph
->object
)
18623 : (STRINGP (glyph
->object
)
18625 : (NILP (glyph
->object
)
18628 glyph
->pixel_width
,
18632 glyph
->left_box_line_p
,
18633 glyph
->right_box_line_p
);
18635 else if (glyph
->type
== COMPOSITE_GLYPH
)
18638 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18639 glyph
- row
->glyphs
[TEXT_AREA
],
18642 (BUFFERP (glyph
->object
)
18644 : (STRINGP (glyph
->object
)
18646 : (NILP (glyph
->object
)
18649 glyph
->pixel_width
,
18651 if (glyph
->u
.cmp
.automatic
)
18654 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18655 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18657 glyph
->left_box_line_p
,
18658 glyph
->right_box_line_p
);
18660 #ifdef HAVE_XWIDGETS
18661 else if (glyph
->type
== XWIDGET_GLYPH
)
18664 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18665 glyph
- row
->glyphs
[TEXT_AREA
],
18668 (BUFFERP (glyph
->object
)
18670 : (STRINGP (glyph
->object
)
18673 glyph
->pixel_width
,
18677 glyph
->left_box_line_p
,
18678 glyph
->right_box_line_p
);
18685 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18686 GLYPHS 0 means don't show glyph contents.
18687 GLYPHS 1 means show glyphs in short form
18688 GLYPHS > 1 means show glyphs in long form. */
18691 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18695 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18696 fprintf (stderr
, "==============================================================================\n");
18698 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18699 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18701 MATRIX_ROW_START_CHARPOS (row
),
18702 MATRIX_ROW_END_CHARPOS (row
),
18703 row
->used
[TEXT_AREA
],
18704 row
->contains_overlapping_glyphs_p
,
18706 row
->truncated_on_left_p
,
18707 row
->truncated_on_right_p
,
18709 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18710 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18713 row
->ends_in_middle_of_char_p
,
18714 row
->starts_in_middle_of_char_p
,
18720 row
->visible_height
,
18723 /* The next 3 lines should align to "Start" in the header. */
18724 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18725 row
->end
.overlay_string_index
,
18726 row
->continuation_lines_width
);
18727 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18728 CHARPOS (row
->start
.string_pos
),
18729 CHARPOS (row
->end
.string_pos
));
18730 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18731 row
->end
.dpvec_index
);
18738 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18740 struct glyph
*glyph
= row
->glyphs
[area
];
18741 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18743 /* Glyph for a line end in text. */
18744 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18747 if (glyph
< glyph_end
)
18748 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18750 for (; glyph
< glyph_end
; ++glyph
)
18751 dump_glyph (row
, glyph
, area
);
18754 else if (glyphs
== 1)
18757 char s
[SHRT_MAX
+ 4];
18759 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18763 for (i
= 0; i
< row
->used
[area
]; ++i
)
18765 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18766 if (i
== row
->used
[area
] - 1
18767 && area
== TEXT_AREA
18768 && NILP (glyph
->object
)
18769 && glyph
->type
== CHAR_GLYPH
18770 && glyph
->u
.ch
== ' ')
18772 strcpy (&s
[i
], "[\\n]");
18775 else if (glyph
->type
== CHAR_GLYPH
18776 && glyph
->u
.ch
< 0x80
18777 && glyph
->u
.ch
>= ' ')
18778 s
[i
] = glyph
->u
.ch
;
18784 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18790 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18791 Sdump_glyph_matrix
, 0, 1, "p",
18792 doc
: /* Dump the current matrix of the selected window to stderr.
18793 Shows contents of glyph row structures. With non-nil
18794 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18795 glyphs in short form, otherwise show glyphs in long form.
18797 Interactively, no argument means show glyphs in short form;
18798 with numeric argument, its value is passed as the GLYPHS flag. */)
18799 (Lisp_Object glyphs
)
18801 struct window
*w
= XWINDOW (selected_window
);
18802 struct buffer
*buffer
= XBUFFER (w
->contents
);
18804 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18805 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18806 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18807 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18808 fprintf (stderr
, "=============================================\n");
18809 dump_glyph_matrix (w
->current_matrix
,
18810 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18815 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18816 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18817 Only text-mode frames have frame glyph matrices. */)
18820 struct frame
*f
= XFRAME (selected_frame
);
18822 if (f
->current_matrix
)
18823 dump_glyph_matrix (f
->current_matrix
, 1);
18825 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18830 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18831 doc
: /* Dump glyph row ROW to stderr.
18832 GLYPH 0 means don't dump glyphs.
18833 GLYPH 1 means dump glyphs in short form.
18834 GLYPH > 1 or omitted means dump glyphs in long form. */)
18835 (Lisp_Object row
, Lisp_Object glyphs
)
18837 struct glyph_matrix
*matrix
;
18840 CHECK_NUMBER (row
);
18841 matrix
= XWINDOW (selected_window
)->current_matrix
;
18843 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18844 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18846 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18851 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18852 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18853 GLYPH 0 means don't dump glyphs.
18854 GLYPH 1 means dump glyphs in short form.
18855 GLYPH > 1 or omitted means dump glyphs in long form.
18857 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18859 (Lisp_Object row
, Lisp_Object glyphs
)
18861 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18862 struct frame
*sf
= SELECTED_FRAME ();
18863 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18866 CHECK_NUMBER (row
);
18868 if (vpos
>= 0 && vpos
< m
->nrows
)
18869 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18870 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18876 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18877 doc
: /* Toggle tracing of redisplay.
18878 With ARG, turn tracing on if and only if ARG is positive. */)
18882 trace_redisplay_p
= !trace_redisplay_p
;
18885 arg
= Fprefix_numeric_value (arg
);
18886 trace_redisplay_p
= XINT (arg
) > 0;
18893 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18894 doc
: /* Like `format', but print result to stderr.
18895 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18896 (ptrdiff_t nargs
, Lisp_Object
*args
)
18898 Lisp_Object s
= Fformat (nargs
, args
);
18899 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18903 #endif /* GLYPH_DEBUG */
18907 /***********************************************************************
18908 Building Desired Matrix Rows
18909 ***********************************************************************/
18911 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18912 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18914 static struct glyph_row
*
18915 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18917 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18918 struct buffer
*buffer
= XBUFFER (w
->contents
);
18919 struct buffer
*old
= current_buffer
;
18920 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18921 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18922 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18923 const unsigned char *p
;
18926 int n_glyphs_before
;
18928 set_buffer_temp (buffer
);
18929 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18930 scratch_glyph_row
.reversed_p
= false;
18931 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18932 SET_TEXT_POS (it
.position
, 0, 0);
18934 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18936 while (p
< arrow_end
)
18938 Lisp_Object face
, ilisp
;
18940 /* Get the next character. */
18942 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18945 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18946 if (! ASCII_CHAR_P (it
.c
))
18947 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18951 /* Get its face. */
18952 ilisp
= make_number (p
- arrow_string
);
18953 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18954 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18956 /* Compute its width, get its glyphs. */
18957 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18958 SET_TEXT_POS (it
.position
, -1, -1);
18959 PRODUCE_GLYPHS (&it
);
18961 /* If this character doesn't fit any more in the line, we have
18962 to remove some glyphs. */
18963 if (it
.current_x
> it
.last_visible_x
)
18965 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18970 set_buffer_temp (old
);
18971 return it
.glyph_row
;
18975 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18976 glyphs to insert is determined by produce_special_glyphs. */
18979 insert_left_trunc_glyphs (struct it
*it
)
18981 struct it truncate_it
;
18982 struct glyph
*from
, *end
, *to
, *toend
;
18984 eassert (!FRAME_WINDOW_P (it
->f
)
18985 || (!it
->glyph_row
->reversed_p
18986 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18987 || (it
->glyph_row
->reversed_p
18988 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18990 /* Get the truncation glyphs. */
18992 truncate_it
.current_x
= 0;
18993 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18994 truncate_it
.glyph_row
= &scratch_glyph_row
;
18995 truncate_it
.area
= TEXT_AREA
;
18996 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18997 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18998 truncate_it
.object
= Qnil
;
18999 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19001 /* Overwrite glyphs from IT with truncation glyphs. */
19002 if (!it
->glyph_row
->reversed_p
)
19004 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19006 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19007 end
= from
+ tused
;
19008 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19009 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19010 if (FRAME_WINDOW_P (it
->f
))
19012 /* On GUI frames, when variable-size fonts are displayed,
19013 the truncation glyphs may need more pixels than the row's
19014 glyphs they overwrite. We overwrite more glyphs to free
19015 enough screen real estate, and enlarge the stretch glyph
19016 on the right (see display_line), if there is one, to
19017 preserve the screen position of the truncation glyphs on
19020 struct glyph
*g
= to
;
19023 /* The first glyph could be partially visible, in which case
19024 it->glyph_row->x will be negative. But we want the left
19025 truncation glyphs to be aligned at the left margin of the
19026 window, so we override the x coordinate at which the row
19028 it
->glyph_row
->x
= 0;
19029 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19031 w
+= g
->pixel_width
;
19034 if (g
- to
- tused
> 0)
19036 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19037 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19039 used
= it
->glyph_row
->used
[TEXT_AREA
];
19040 if (it
->glyph_row
->truncated_on_right_p
19041 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19042 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19045 int extra
= w
- it
->truncation_pixel_width
;
19047 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19054 /* There may be padding glyphs left over. Overwrite them too. */
19055 if (!FRAME_WINDOW_P (it
->f
))
19057 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19059 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19066 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19070 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19072 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19073 that back to front. */
19074 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19075 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19076 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19077 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19078 if (FRAME_WINDOW_P (it
->f
))
19081 struct glyph
*g
= to
;
19083 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19085 w
+= g
->pixel_width
;
19088 if (to
- g
- tused
> 0)
19090 if (it
->glyph_row
->truncated_on_right_p
19091 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19092 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19094 int extra
= w
- it
->truncation_pixel_width
;
19096 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19100 while (from
>= end
&& to
>= toend
)
19102 if (!FRAME_WINDOW_P (it
->f
))
19104 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19107 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19108 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19109 while (from
>= end
&& to
>= toend
)
19115 /* Need to free some room before prepending additional
19117 int move_by
= from
- end
+ 1;
19118 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19119 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19121 for ( ; g
>= g0
; g
--)
19123 while (from
>= end
)
19125 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19130 /* Compute the hash code for ROW. */
19132 row_hash (struct glyph_row
*row
)
19135 unsigned hashval
= 0;
19137 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19138 for (k
= 0; k
< row
->used
[area
]; ++k
)
19139 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19140 + row
->glyphs
[area
][k
].u
.val
19141 + row
->glyphs
[area
][k
].face_id
19142 + row
->glyphs
[area
][k
].padding_p
19143 + (row
->glyphs
[area
][k
].type
<< 2));
19148 /* Compute the pixel height and width of IT->glyph_row.
19150 Most of the time, ascent and height of a display line will be equal
19151 to the max_ascent and max_height values of the display iterator
19152 structure. This is not the case if
19154 1. We hit ZV without displaying anything. In this case, max_ascent
19155 and max_height will be zero.
19157 2. We have some glyphs that don't contribute to the line height.
19158 (The glyph row flag contributes_to_line_height_p is for future
19159 pixmap extensions).
19161 The first case is easily covered by using default values because in
19162 these cases, the line height does not really matter, except that it
19163 must not be zero. */
19166 compute_line_metrics (struct it
*it
)
19168 struct glyph_row
*row
= it
->glyph_row
;
19170 if (FRAME_WINDOW_P (it
->f
))
19172 int i
, min_y
, max_y
;
19174 /* The line may consist of one space only, that was added to
19175 place the cursor on it. If so, the row's height hasn't been
19177 if (row
->height
== 0)
19179 if (it
->max_ascent
+ it
->max_descent
== 0)
19180 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19181 row
->ascent
= it
->max_ascent
;
19182 row
->height
= it
->max_ascent
+ it
->max_descent
;
19183 row
->phys_ascent
= it
->max_phys_ascent
;
19184 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19185 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19188 /* Compute the width of this line. */
19189 row
->pixel_width
= row
->x
;
19190 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19191 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19193 eassert (row
->pixel_width
>= 0);
19194 eassert (row
->ascent
>= 0 && row
->height
> 0);
19196 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19197 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19199 /* If first line's physical ascent is larger than its logical
19200 ascent, use the physical ascent, and make the row taller.
19201 This makes accented characters fully visible. */
19202 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19203 && row
->phys_ascent
> row
->ascent
)
19205 row
->height
+= row
->phys_ascent
- row
->ascent
;
19206 row
->ascent
= row
->phys_ascent
;
19209 /* Compute how much of the line is visible. */
19210 row
->visible_height
= row
->height
;
19212 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19213 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19215 if (row
->y
< min_y
)
19216 row
->visible_height
-= min_y
- row
->y
;
19217 if (row
->y
+ row
->height
> max_y
)
19218 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19222 row
->pixel_width
= row
->used
[TEXT_AREA
];
19223 if (row
->continued_p
)
19224 row
->pixel_width
-= it
->continuation_pixel_width
;
19225 else if (row
->truncated_on_right_p
)
19226 row
->pixel_width
-= it
->truncation_pixel_width
;
19227 row
->ascent
= row
->phys_ascent
= 0;
19228 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19229 row
->extra_line_spacing
= 0;
19232 /* Compute a hash code for this row. */
19233 row
->hash
= row_hash (row
);
19235 it
->max_ascent
= it
->max_descent
= 0;
19236 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19240 /* Append one space to the glyph row of iterator IT if doing a
19241 window-based redisplay. The space has the same face as
19242 IT->face_id. Value is non-zero if a space was added.
19244 This function is called to make sure that there is always one glyph
19245 at the end of a glyph row that the cursor can be set on under
19246 window-systems. (If there weren't such a glyph we would not know
19247 how wide and tall a box cursor should be displayed).
19249 At the same time this space let's a nicely handle clearing to the
19250 end of the line if the row ends in italic text. */
19253 append_space_for_newline (struct it
*it
, int default_face_p
)
19255 if (FRAME_WINDOW_P (it
->f
))
19257 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19259 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19260 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19262 /* Save some values that must not be changed.
19263 Must save IT->c and IT->len because otherwise
19264 ITERATOR_AT_END_P wouldn't work anymore after
19265 append_space_for_newline has been called. */
19266 enum display_element_type saved_what
= it
->what
;
19267 int saved_c
= it
->c
, saved_len
= it
->len
;
19268 int saved_char_to_display
= it
->char_to_display
;
19269 int saved_x
= it
->current_x
;
19270 int saved_face_id
= it
->face_id
;
19271 int saved_box_end
= it
->end_of_box_run_p
;
19272 struct text_pos saved_pos
;
19273 Lisp_Object saved_object
;
19276 saved_object
= it
->object
;
19277 saved_pos
= it
->position
;
19279 it
->what
= IT_CHARACTER
;
19280 memset (&it
->position
, 0, sizeof it
->position
);
19282 it
->c
= it
->char_to_display
= ' ';
19285 /* If the default face was remapped, be sure to use the
19286 remapped face for the appended newline. */
19287 if (default_face_p
)
19288 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19289 else if (it
->face_before_selective_p
)
19290 it
->face_id
= it
->saved_face_id
;
19291 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19292 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19293 /* In R2L rows, we will prepend a stretch glyph that will
19294 have the end_of_box_run_p flag set for it, so there's no
19295 need for the appended newline glyph to have that flag
19297 if (it
->glyph_row
->reversed_p
19298 /* But if the appended newline glyph goes all the way to
19299 the end of the row, there will be no stretch glyph,
19300 so leave the box flag set. */
19301 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19302 it
->end_of_box_run_p
= 0;
19304 PRODUCE_GLYPHS (it
);
19306 it
->override_ascent
= -1;
19307 it
->constrain_row_ascent_descent_p
= 0;
19308 it
->current_x
= saved_x
;
19309 it
->object
= saved_object
;
19310 it
->position
= saved_pos
;
19311 it
->what
= saved_what
;
19312 it
->face_id
= saved_face_id
;
19313 it
->len
= saved_len
;
19315 it
->char_to_display
= saved_char_to_display
;
19316 it
->end_of_box_run_p
= saved_box_end
;
19325 /* Extend the face of the last glyph in the text area of IT->glyph_row
19326 to the end of the display line. Called from display_line. If the
19327 glyph row is empty, add a space glyph to it so that we know the
19328 face to draw. Set the glyph row flag fill_line_p. If the glyph
19329 row is R2L, prepend a stretch glyph to cover the empty space to the
19330 left of the leftmost glyph. */
19333 extend_face_to_end_of_line (struct it
*it
)
19335 struct face
*face
, *default_face
;
19336 struct frame
*f
= it
->f
;
19338 /* If line is already filled, do nothing. Non window-system frames
19339 get a grace of one more ``pixel'' because their characters are
19340 1-``pixel'' wide, so they hit the equality too early. This grace
19341 is needed only for R2L rows that are not continued, to produce
19342 one extra blank where we could display the cursor. */
19343 if ((it
->current_x
>= it
->last_visible_x
19344 + (!FRAME_WINDOW_P (f
)
19345 && it
->glyph_row
->reversed_p
19346 && !it
->glyph_row
->continued_p
))
19347 /* If the window has display margins, we will need to extend
19348 their face even if the text area is filled. */
19349 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19350 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19353 /* The default face, possibly remapped. */
19354 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19356 /* Face extension extends the background and box of IT->face_id
19357 to the end of the line. If the background equals the background
19358 of the frame, we don't have to do anything. */
19359 if (it
->face_before_selective_p
)
19360 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19362 face
= FACE_FROM_ID (f
, it
->face_id
);
19364 if (FRAME_WINDOW_P (f
)
19365 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19366 && face
->box
== FACE_NO_BOX
19367 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19368 #ifdef HAVE_WINDOW_SYSTEM
19371 && !it
->glyph_row
->reversed_p
)
19374 /* Set the glyph row flag indicating that the face of the last glyph
19375 in the text area has to be drawn to the end of the text area. */
19376 it
->glyph_row
->fill_line_p
= 1;
19378 /* If current character of IT is not ASCII, make sure we have the
19379 ASCII face. This will be automatically undone the next time
19380 get_next_display_element returns a multibyte character. Note
19381 that the character will always be single byte in unibyte
19383 if (!ASCII_CHAR_P (it
->c
))
19385 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19388 if (FRAME_WINDOW_P (f
))
19390 /* If the row is empty, add a space with the current face of IT,
19391 so that we know which face to draw. */
19392 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19394 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19395 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19396 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19398 /* Mode line and the header line don't have margins, and
19399 likewise the frame's tool-bar window, if there is any. */
19400 if (!(it
->glyph_row
->mode_line_p
19401 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19402 || (WINDOWP (f
->tool_bar_window
)
19403 && it
->w
== XWINDOW (f
->tool_bar_window
))
19407 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19408 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19410 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19411 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19413 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19415 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19416 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19418 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19419 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19421 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19424 #ifdef HAVE_WINDOW_SYSTEM
19425 if (it
->glyph_row
->reversed_p
)
19427 /* Prepend a stretch glyph to the row, such that the
19428 rightmost glyph will be drawn flushed all the way to the
19429 right margin of the window. The stretch glyph that will
19430 occupy the empty space, if any, to the left of the
19432 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19433 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19434 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19436 int row_width
, stretch_ascent
, stretch_width
;
19437 struct text_pos saved_pos
;
19438 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19440 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19441 row_width
+= g
->pixel_width
;
19443 /* FIXME: There are various minor display glitches in R2L
19444 rows when only one of the fringes is missing. The
19445 strange condition below produces the least bad effect. */
19446 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19447 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19448 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19449 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19451 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19452 stretch_width
-= row_width
;
19454 if (stretch_width
> 0)
19457 (((it
->ascent
+ it
->descent
)
19458 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19459 saved_pos
= it
->position
;
19460 memset (&it
->position
, 0, sizeof it
->position
);
19461 saved_avoid_cursor
= it
->avoid_cursor_p
;
19462 it
->avoid_cursor_p
= 1;
19463 saved_face_id
= it
->face_id
;
19464 saved_box_start
= it
->start_of_box_run_p
;
19465 /* The last row's stretch glyph should get the default
19466 face, to avoid painting the rest of the window with
19467 the region face, if the region ends at ZV. */
19468 if (it
->glyph_row
->ends_at_zv_p
)
19469 it
->face_id
= default_face
->id
;
19471 it
->face_id
= face
->id
;
19472 it
->start_of_box_run_p
= 0;
19473 append_stretch_glyph (it
, Qnil
, stretch_width
,
19474 it
->ascent
+ it
->descent
, stretch_ascent
);
19475 it
->position
= saved_pos
;
19476 it
->avoid_cursor_p
= saved_avoid_cursor
;
19477 it
->face_id
= saved_face_id
;
19478 it
->start_of_box_run_p
= saved_box_start
;
19480 /* If stretch_width comes out negative, it means that the
19481 last glyph is only partially visible. In R2L rows, we
19482 want the leftmost glyph to be partially visible, so we
19483 need to give the row the corresponding left offset. */
19484 if (stretch_width
< 0)
19485 it
->glyph_row
->x
= stretch_width
;
19487 #endif /* HAVE_WINDOW_SYSTEM */
19491 /* Save some values that must not be changed. */
19492 int saved_x
= it
->current_x
;
19493 struct text_pos saved_pos
;
19494 Lisp_Object saved_object
;
19495 enum display_element_type saved_what
= it
->what
;
19496 int saved_face_id
= it
->face_id
;
19498 saved_object
= it
->object
;
19499 saved_pos
= it
->position
;
19501 it
->what
= IT_CHARACTER
;
19502 memset (&it
->position
, 0, sizeof it
->position
);
19504 it
->c
= it
->char_to_display
= ' ';
19507 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19508 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19509 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19510 && !it
->glyph_row
->mode_line_p
19511 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19513 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19514 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19516 for (it
->current_x
= 0; g
< e
; g
++)
19517 it
->current_x
+= g
->pixel_width
;
19519 it
->area
= LEFT_MARGIN_AREA
;
19520 it
->face_id
= default_face
->id
;
19521 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19522 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19524 PRODUCE_GLYPHS (it
);
19525 /* term.c:produce_glyphs advances it->current_x only for
19527 it
->current_x
+= it
->pixel_width
;
19530 it
->current_x
= saved_x
;
19531 it
->area
= TEXT_AREA
;
19534 /* The last row's blank glyphs should get the default face, to
19535 avoid painting the rest of the window with the region face,
19536 if the region ends at ZV. */
19537 if (it
->glyph_row
->ends_at_zv_p
)
19538 it
->face_id
= default_face
->id
;
19540 it
->face_id
= face
->id
;
19541 PRODUCE_GLYPHS (it
);
19543 while (it
->current_x
<= it
->last_visible_x
)
19544 PRODUCE_GLYPHS (it
);
19546 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19547 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19548 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19549 && !it
->glyph_row
->mode_line_p
19550 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19552 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19553 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19555 for ( ; g
< e
; g
++)
19556 it
->current_x
+= g
->pixel_width
;
19558 it
->area
= RIGHT_MARGIN_AREA
;
19559 it
->face_id
= default_face
->id
;
19560 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19561 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19563 PRODUCE_GLYPHS (it
);
19564 it
->current_x
+= it
->pixel_width
;
19567 it
->area
= TEXT_AREA
;
19570 /* Don't count these blanks really. It would let us insert a left
19571 truncation glyph below and make us set the cursor on them, maybe. */
19572 it
->current_x
= saved_x
;
19573 it
->object
= saved_object
;
19574 it
->position
= saved_pos
;
19575 it
->what
= saved_what
;
19576 it
->face_id
= saved_face_id
;
19581 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19582 trailing whitespace. */
19585 trailing_whitespace_p (ptrdiff_t charpos
)
19587 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19590 while (bytepos
< ZV_BYTE
19591 && (c
= FETCH_CHAR (bytepos
),
19592 c
== ' ' || c
== '\t'))
19595 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19597 if (bytepos
!= PT_BYTE
)
19604 /* Highlight trailing whitespace, if any, in ROW. */
19607 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19609 int used
= row
->used
[TEXT_AREA
];
19613 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19614 struct glyph
*glyph
= start
+ used
- 1;
19616 if (row
->reversed_p
)
19618 /* Right-to-left rows need to be processed in the opposite
19619 direction, so swap the edge pointers. */
19621 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19624 /* Skip over glyphs inserted to display the cursor at the
19625 end of a line, for extending the face of the last glyph
19626 to the end of the line on terminals, and for truncation
19627 and continuation glyphs. */
19628 if (!row
->reversed_p
)
19630 while (glyph
>= start
19631 && glyph
->type
== CHAR_GLYPH
19632 && NILP (glyph
->object
))
19637 while (glyph
<= start
19638 && glyph
->type
== CHAR_GLYPH
19639 && NILP (glyph
->object
))
19643 /* If last glyph is a space or stretch, and it's trailing
19644 whitespace, set the face of all trailing whitespace glyphs in
19645 IT->glyph_row to `trailing-whitespace'. */
19646 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19647 && BUFFERP (glyph
->object
)
19648 && (glyph
->type
== STRETCH_GLYPH
19649 || (glyph
->type
== CHAR_GLYPH
19650 && glyph
->u
.ch
== ' '))
19651 && trailing_whitespace_p (glyph
->charpos
))
19653 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19657 if (!row
->reversed_p
)
19659 while (glyph
>= start
19660 && BUFFERP (glyph
->object
)
19661 && (glyph
->type
== STRETCH_GLYPH
19662 || (glyph
->type
== CHAR_GLYPH
19663 && glyph
->u
.ch
== ' ')))
19664 (glyph
--)->face_id
= face_id
;
19668 while (glyph
<= start
19669 && BUFFERP (glyph
->object
)
19670 && (glyph
->type
== STRETCH_GLYPH
19671 || (glyph
->type
== CHAR_GLYPH
19672 && glyph
->u
.ch
== ' ')))
19673 (glyph
++)->face_id
= face_id
;
19680 /* Value is non-zero if glyph row ROW should be
19681 considered to hold the buffer position CHARPOS. */
19684 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19688 if (charpos
== CHARPOS (row
->end
.pos
)
19689 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19691 /* Suppose the row ends on a string.
19692 Unless the row is continued, that means it ends on a newline
19693 in the string. If it's anything other than a display string
19694 (e.g., a before-string from an overlay), we don't want the
19695 cursor there. (This heuristic seems to give the optimal
19696 behavior for the various types of multi-line strings.)
19697 One exception: if the string has `cursor' property on one of
19698 its characters, we _do_ want the cursor there. */
19699 if (CHARPOS (row
->end
.string_pos
) >= 0)
19701 if (row
->continued_p
)
19705 /* Check for `display' property. */
19706 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19707 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19708 struct glyph
*glyph
;
19711 for (glyph
= end
; glyph
>= beg
; --glyph
)
19712 if (STRINGP (glyph
->object
))
19715 = Fget_char_property (make_number (charpos
),
19719 && display_prop_string_p (prop
, glyph
->object
));
19720 /* If there's a `cursor' property on one of the
19721 string's characters, this row is a cursor row,
19722 even though this is not a display string. */
19725 Lisp_Object s
= glyph
->object
;
19727 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19729 ptrdiff_t gpos
= glyph
->charpos
;
19731 if (!NILP (Fget_char_property (make_number (gpos
),
19743 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19745 /* If the row ends in middle of a real character,
19746 and the line is continued, we want the cursor here.
19747 That's because CHARPOS (ROW->end.pos) would equal
19748 PT if PT is before the character. */
19749 if (!row
->ends_in_ellipsis_p
)
19750 result
= row
->continued_p
;
19752 /* If the row ends in an ellipsis, then
19753 CHARPOS (ROW->end.pos) will equal point after the
19754 invisible text. We want that position to be displayed
19755 after the ellipsis. */
19758 /* If the row ends at ZV, display the cursor at the end of that
19759 row instead of at the start of the row below. */
19760 else if (row
->ends_at_zv_p
)
19769 /* Value is non-zero if glyph row ROW should be
19770 used to hold the cursor. */
19773 cursor_row_p (struct glyph_row
*row
)
19775 return row_for_charpos_p (row
, PT
);
19780 /* Push the property PROP so that it will be rendered at the current
19781 position in IT. Return 1 if PROP was successfully pushed, 0
19782 otherwise. Called from handle_line_prefix to handle the
19783 `line-prefix' and `wrap-prefix' properties. */
19786 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19788 struct text_pos pos
=
19789 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19791 eassert (it
->method
== GET_FROM_BUFFER
19792 || it
->method
== GET_FROM_DISPLAY_VECTOR
19793 || it
->method
== GET_FROM_STRING
);
19795 /* We need to save the current buffer/string position, so it will be
19796 restored by pop_it, because iterate_out_of_display_property
19797 depends on that being set correctly, but some situations leave
19798 it->position not yet set when this function is called. */
19799 push_it (it
, &pos
);
19801 if (STRINGP (prop
))
19803 if (SCHARS (prop
) == 0)
19810 it
->string_from_prefix_prop_p
= 1;
19811 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19812 it
->current
.overlay_string_index
= -1;
19813 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19814 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19815 it
->method
= GET_FROM_STRING
;
19816 it
->stop_charpos
= 0;
19818 it
->base_level_stop
= 0;
19820 /* Force paragraph direction to be that of the parent
19822 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19823 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19825 it
->paragraph_embedding
= L2R
;
19827 /* Set up the bidi iterator for this display string. */
19830 it
->bidi_it
.string
.lstring
= it
->string
;
19831 it
->bidi_it
.string
.s
= NULL
;
19832 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19833 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19834 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19835 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19836 it
->bidi_it
.w
= it
->w
;
19837 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19840 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19842 it
->method
= GET_FROM_STRETCH
;
19845 #ifdef HAVE_WINDOW_SYSTEM
19846 else if (IMAGEP (prop
))
19848 it
->what
= IT_IMAGE
;
19849 it
->image_id
= lookup_image (it
->f
, prop
);
19850 it
->method
= GET_FROM_IMAGE
;
19852 #endif /* HAVE_WINDOW_SYSTEM */
19855 pop_it (it
); /* bogus display property, give up */
19862 /* Return the character-property PROP at the current position in IT. */
19865 get_it_property (struct it
*it
, Lisp_Object prop
)
19867 Lisp_Object position
, object
= it
->object
;
19869 if (STRINGP (object
))
19870 position
= make_number (IT_STRING_CHARPOS (*it
));
19871 else if (BUFFERP (object
))
19873 position
= make_number (IT_CHARPOS (*it
));
19874 object
= it
->window
;
19879 return Fget_char_property (position
, prop
, object
);
19882 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19885 handle_line_prefix (struct it
*it
)
19887 Lisp_Object prefix
;
19889 if (it
->continuation_lines_width
> 0)
19891 prefix
= get_it_property (it
, Qwrap_prefix
);
19893 prefix
= Vwrap_prefix
;
19897 prefix
= get_it_property (it
, Qline_prefix
);
19899 prefix
= Vline_prefix
;
19901 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19903 /* If the prefix is wider than the window, and we try to wrap
19904 it, it would acquire its own wrap prefix, and so on till the
19905 iterator stack overflows. So, don't wrap the prefix. */
19906 it
->line_wrap
= TRUNCATE
;
19907 it
->avoid_cursor_p
= 1;
19913 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19914 only for R2L lines from display_line and display_string, when they
19915 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19916 the line/string needs to be continued on the next glyph row. */
19918 unproduce_glyphs (struct it
*it
, int n
)
19920 struct glyph
*glyph
, *end
;
19922 eassert (it
->glyph_row
);
19923 eassert (it
->glyph_row
->reversed_p
);
19924 eassert (it
->area
== TEXT_AREA
);
19925 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19927 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19928 n
= it
->glyph_row
->used
[TEXT_AREA
];
19929 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19930 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19931 for ( ; glyph
< end
; glyph
++)
19932 glyph
[-n
] = *glyph
;
19935 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19936 and ROW->maxpos. */
19938 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19939 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19940 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19942 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19943 lines' rows is implemented for bidi-reordered rows. */
19945 /* ROW->minpos is the value of min_pos, the minimal buffer position
19946 we have in ROW, or ROW->start.pos if that is smaller. */
19947 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19948 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19950 /* We didn't find buffer positions smaller than ROW->start, or
19951 didn't find _any_ valid buffer positions in any of the glyphs,
19952 so we must trust the iterator's computed positions. */
19953 row
->minpos
= row
->start
.pos
;
19956 max_pos
= CHARPOS (it
->current
.pos
);
19957 max_bpos
= BYTEPOS (it
->current
.pos
);
19960 /* Here are the various use-cases for ending the row, and the
19961 corresponding values for ROW->maxpos:
19963 Line ends in a newline from buffer eol_pos + 1
19964 Line is continued from buffer max_pos + 1
19965 Line is truncated on right it->current.pos
19966 Line ends in a newline from string max_pos + 1(*)
19967 (*) + 1 only when line ends in a forward scan
19968 Line is continued from string max_pos
19969 Line is continued from display vector max_pos
19970 Line is entirely from a string min_pos == max_pos
19971 Line is entirely from a display vector min_pos == max_pos
19972 Line that ends at ZV ZV
19974 If you discover other use-cases, please add them here as
19976 if (row
->ends_at_zv_p
)
19977 row
->maxpos
= it
->current
.pos
;
19978 else if (row
->used
[TEXT_AREA
])
19980 int seen_this_string
= 0;
19981 struct glyph_row
*r1
= row
- 1;
19983 /* Did we see the same display string on the previous row? */
19984 if (STRINGP (it
->object
)
19985 /* this is not the first row */
19986 && row
> it
->w
->desired_matrix
->rows
19987 /* previous row is not the header line */
19988 && !r1
->mode_line_p
19989 /* previous row also ends in a newline from a string */
19990 && r1
->ends_in_newline_from_string_p
)
19992 struct glyph
*start
, *end
;
19994 /* Search for the last glyph of the previous row that came
19995 from buffer or string. Depending on whether the row is
19996 L2R or R2L, we need to process it front to back or the
19997 other way round. */
19998 if (!r1
->reversed_p
)
20000 start
= r1
->glyphs
[TEXT_AREA
];
20001 end
= start
+ r1
->used
[TEXT_AREA
];
20002 /* Glyphs inserted by redisplay have nil as their object. */
20004 && NILP ((end
- 1)->object
)
20005 && (end
- 1)->charpos
<= 0)
20009 if (EQ ((end
- 1)->object
, it
->object
))
20010 seen_this_string
= 1;
20013 /* If all the glyphs of the previous row were inserted
20014 by redisplay, it means the previous row was
20015 produced from a single newline, which is only
20016 possible if that newline came from the same string
20017 as the one which produced this ROW. */
20018 seen_this_string
= 1;
20022 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20023 start
= end
+ r1
->used
[TEXT_AREA
];
20025 && NILP ((end
+ 1)->object
)
20026 && (end
+ 1)->charpos
<= 0)
20030 if (EQ ((end
+ 1)->object
, it
->object
))
20031 seen_this_string
= 1;
20034 seen_this_string
= 1;
20037 /* Take note of each display string that covers a newline only
20038 once, the first time we see it. This is for when a display
20039 string includes more than one newline in it. */
20040 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20042 /* If we were scanning the buffer forward when we displayed
20043 the string, we want to account for at least one buffer
20044 position that belongs to this row (position covered by
20045 the display string), so that cursor positioning will
20046 consider this row as a candidate when point is at the end
20047 of the visual line represented by this row. This is not
20048 required when scanning back, because max_pos will already
20049 have a much larger value. */
20050 if (CHARPOS (row
->end
.pos
) > max_pos
)
20051 INC_BOTH (max_pos
, max_bpos
);
20052 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20054 else if (CHARPOS (it
->eol_pos
) > 0)
20055 SET_TEXT_POS (row
->maxpos
,
20056 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20057 else if (row
->continued_p
)
20059 /* If max_pos is different from IT's current position, it
20060 means IT->method does not belong to the display element
20061 at max_pos. However, it also means that the display
20062 element at max_pos was displayed in its entirety on this
20063 line, which is equivalent to saying that the next line
20064 starts at the next buffer position. */
20065 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20066 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20069 INC_BOTH (max_pos
, max_bpos
);
20070 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20073 else if (row
->truncated_on_right_p
)
20074 /* display_line already called reseat_at_next_visible_line_start,
20075 which puts the iterator at the beginning of the next line, in
20076 the logical order. */
20077 row
->maxpos
= it
->current
.pos
;
20078 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20079 /* A line that is entirely from a string/image/stretch... */
20080 row
->maxpos
= row
->minpos
;
20085 row
->maxpos
= it
->current
.pos
;
20088 /* Construct the glyph row IT->glyph_row in the desired matrix of
20089 IT->w from text at the current position of IT. See dispextern.h
20090 for an overview of struct it. Value is non-zero if
20091 IT->glyph_row displays text, as opposed to a line displaying ZV
20095 display_line (struct it
*it
)
20097 struct glyph_row
*row
= it
->glyph_row
;
20098 Lisp_Object overlay_arrow_string
;
20100 void *wrap_data
= NULL
;
20101 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20102 int wrap_row_used
= -1;
20103 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20104 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20105 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20106 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20107 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20109 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20110 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20111 bool pending_handle_line_prefix
= false;
20113 /* We always start displaying at hpos zero even if hscrolled. */
20114 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20116 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20117 >= it
->w
->desired_matrix
->nrows
)
20119 it
->w
->nrows_scale_factor
++;
20120 it
->f
->fonts_changed
= 1;
20124 /* Clear the result glyph row and enable it. */
20125 prepare_desired_row (it
->w
, row
, false);
20127 row
->y
= it
->current_y
;
20128 row
->start
= it
->start
;
20129 row
->continuation_lines_width
= it
->continuation_lines_width
;
20130 row
->displays_text_p
= 1;
20131 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20132 it
->starts_in_middle_of_char_p
= 0;
20134 /* Arrange the overlays nicely for our purposes. Usually, we call
20135 display_line on only one line at a time, in which case this
20136 can't really hurt too much, or we call it on lines which appear
20137 one after another in the buffer, in which case all calls to
20138 recenter_overlay_lists but the first will be pretty cheap. */
20139 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20141 /* Move over display elements that are not visible because we are
20142 hscrolled. This may stop at an x-position < IT->first_visible_x
20143 if the first glyph is partially visible or if we hit a line end. */
20144 if (it
->current_x
< it
->first_visible_x
)
20146 enum move_it_result move_result
;
20148 this_line_min_pos
= row
->start
.pos
;
20149 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20150 MOVE_TO_POS
| MOVE_TO_X
);
20151 /* If we are under a large hscroll, move_it_in_display_line_to
20152 could hit the end of the line without reaching
20153 it->first_visible_x. Pretend that we did reach it. This is
20154 especially important on a TTY, where we will call
20155 extend_face_to_end_of_line, which needs to know how many
20156 blank glyphs to produce. */
20157 if (it
->current_x
< it
->first_visible_x
20158 && (move_result
== MOVE_NEWLINE_OR_CR
20159 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20160 it
->current_x
= it
->first_visible_x
;
20162 /* Record the smallest positions seen while we moved over
20163 display elements that are not visible. This is needed by
20164 redisplay_internal for optimizing the case where the cursor
20165 stays inside the same line. The rest of this function only
20166 considers positions that are actually displayed, so
20167 RECORD_MAX_MIN_POS will not otherwise record positions that
20168 are hscrolled to the left of the left edge of the window. */
20169 min_pos
= CHARPOS (this_line_min_pos
);
20170 min_bpos
= BYTEPOS (this_line_min_pos
);
20172 else if (it
->area
== TEXT_AREA
)
20174 /* We only do this when not calling move_it_in_display_line_to
20175 above, because that function calls itself handle_line_prefix. */
20176 handle_line_prefix (it
);
20180 /* Line-prefix and wrap-prefix are always displayed in the text
20181 area. But if this is the first call to display_line after
20182 init_iterator, the iterator might have been set up to write
20183 into a marginal area, e.g. if the line begins with some
20184 display property that writes to the margins. So we need to
20185 wait with the call to handle_line_prefix until whatever
20186 writes to the margin has done its job. */
20187 pending_handle_line_prefix
= true;
20190 /* Get the initial row height. This is either the height of the
20191 text hscrolled, if there is any, or zero. */
20192 row
->ascent
= it
->max_ascent
;
20193 row
->height
= it
->max_ascent
+ it
->max_descent
;
20194 row
->phys_ascent
= it
->max_phys_ascent
;
20195 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20196 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20198 /* Utility macro to record max and min buffer positions seen until now. */
20199 #define RECORD_MAX_MIN_POS(IT) \
20202 int composition_p = !STRINGP ((IT)->string) \
20203 && ((IT)->what == IT_COMPOSITION); \
20204 ptrdiff_t current_pos = \
20205 composition_p ? (IT)->cmp_it.charpos \
20206 : IT_CHARPOS (*(IT)); \
20207 ptrdiff_t current_bpos = \
20208 composition_p ? CHAR_TO_BYTE (current_pos) \
20209 : IT_BYTEPOS (*(IT)); \
20210 if (current_pos < min_pos) \
20212 min_pos = current_pos; \
20213 min_bpos = current_bpos; \
20215 if (IT_CHARPOS (*it) > max_pos) \
20217 max_pos = IT_CHARPOS (*it); \
20218 max_bpos = IT_BYTEPOS (*it); \
20223 /* Loop generating characters. The loop is left with IT on the next
20224 character to display. */
20227 int n_glyphs_before
, hpos_before
, x_before
;
20229 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20231 /* Retrieve the next thing to display. Value is zero if end of
20233 if (!get_next_display_element (it
))
20235 /* Maybe add a space at the end of this line that is used to
20236 display the cursor there under X. Set the charpos of the
20237 first glyph of blank lines not corresponding to any text
20239 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20240 row
->exact_window_width_line_p
= 1;
20241 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20242 || row
->used
[TEXT_AREA
] == 0)
20244 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20245 row
->displays_text_p
= 0;
20247 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20248 && (!MINI_WINDOW_P (it
->w
)
20249 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20250 row
->indicate_empty_line_p
= 1;
20253 it
->continuation_lines_width
= 0;
20254 row
->ends_at_zv_p
= 1;
20255 /* A row that displays right-to-left text must always have
20256 its last face extended all the way to the end of line,
20257 even if this row ends in ZV, because we still write to
20258 the screen left to right. We also need to extend the
20259 last face if the default face is remapped to some
20260 different face, otherwise the functions that clear
20261 portions of the screen will clear with the default face's
20262 background color. */
20263 if (row
->reversed_p
20264 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20265 extend_face_to_end_of_line (it
);
20269 /* Now, get the metrics of what we want to display. This also
20270 generates glyphs in `row' (which is IT->glyph_row). */
20271 n_glyphs_before
= row
->used
[TEXT_AREA
];
20274 /* Remember the line height so far in case the next element doesn't
20275 fit on the line. */
20276 if (it
->line_wrap
!= TRUNCATE
)
20278 ascent
= it
->max_ascent
;
20279 descent
= it
->max_descent
;
20280 phys_ascent
= it
->max_phys_ascent
;
20281 phys_descent
= it
->max_phys_descent
;
20283 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20285 if (IT_DISPLAYING_WHITESPACE (it
))
20289 SAVE_IT (wrap_it
, *it
, wrap_data
);
20291 wrap_row_used
= row
->used
[TEXT_AREA
];
20292 wrap_row_ascent
= row
->ascent
;
20293 wrap_row_height
= row
->height
;
20294 wrap_row_phys_ascent
= row
->phys_ascent
;
20295 wrap_row_phys_height
= row
->phys_height
;
20296 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20297 wrap_row_min_pos
= min_pos
;
20298 wrap_row_min_bpos
= min_bpos
;
20299 wrap_row_max_pos
= max_pos
;
20300 wrap_row_max_bpos
= max_bpos
;
20306 PRODUCE_GLYPHS (it
);
20308 /* If this display element was in marginal areas, continue with
20310 if (it
->area
!= TEXT_AREA
)
20312 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20313 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20314 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20315 row
->phys_height
= max (row
->phys_height
,
20316 it
->max_phys_ascent
+ it
->max_phys_descent
);
20317 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20318 it
->max_extra_line_spacing
);
20319 set_iterator_to_next (it
, 1);
20320 /* If we didn't handle the line/wrap prefix above, and the
20321 call to set_iterator_to_next just switched to TEXT_AREA,
20322 process the prefix now. */
20323 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20325 pending_handle_line_prefix
= false;
20326 handle_line_prefix (it
);
20331 /* Does the display element fit on the line? If we truncate
20332 lines, we should draw past the right edge of the window. If
20333 we don't truncate, we want to stop so that we can display the
20334 continuation glyph before the right margin. If lines are
20335 continued, there are two possible strategies for characters
20336 resulting in more than 1 glyph (e.g. tabs): Display as many
20337 glyphs as possible in this line and leave the rest for the
20338 continuation line, or display the whole element in the next
20339 line. Original redisplay did the former, so we do it also. */
20340 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20341 hpos_before
= it
->hpos
;
20344 if (/* Not a newline. */
20346 /* Glyphs produced fit entirely in the line. */
20347 && it
->current_x
< it
->last_visible_x
)
20349 it
->hpos
+= nglyphs
;
20350 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20351 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20352 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20353 row
->phys_height
= max (row
->phys_height
,
20354 it
->max_phys_ascent
+ it
->max_phys_descent
);
20355 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20356 it
->max_extra_line_spacing
);
20357 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20358 /* In R2L rows, we arrange in extend_face_to_end_of_line
20359 to add a right offset to the line, by a suitable
20360 change to the stretch glyph that is the leftmost
20361 glyph of the line. */
20362 && !row
->reversed_p
)
20363 row
->x
= x
- it
->first_visible_x
;
20364 /* Record the maximum and minimum buffer positions seen so
20365 far in glyphs that will be displayed by this row. */
20367 RECORD_MAX_MIN_POS (it
);
20372 struct glyph
*glyph
;
20374 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20376 /* Identify the glyphs added by the last call to
20377 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20378 the previous glyphs. */
20379 if (!row
->reversed_p
)
20380 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20382 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20383 new_x
= x
+ glyph
->pixel_width
;
20385 if (/* Lines are continued. */
20386 it
->line_wrap
!= TRUNCATE
20387 && (/* Glyph doesn't fit on the line. */
20388 new_x
> it
->last_visible_x
20389 /* Or it fits exactly on a window system frame. */
20390 || (new_x
== it
->last_visible_x
20391 && FRAME_WINDOW_P (it
->f
)
20392 && (row
->reversed_p
20393 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20394 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20396 /* End of a continued line. */
20399 || (new_x
== it
->last_visible_x
20400 && FRAME_WINDOW_P (it
->f
)
20401 && (row
->reversed_p
20402 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20403 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20405 /* Current glyph is the only one on the line or
20406 fits exactly on the line. We must continue
20407 the line because we can't draw the cursor
20408 after the glyph. */
20409 row
->continued_p
= 1;
20410 it
->current_x
= new_x
;
20411 it
->continuation_lines_width
+= new_x
;
20413 if (i
== nglyphs
- 1)
20415 /* If line-wrap is on, check if a previous
20416 wrap point was found. */
20417 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20418 && wrap_row_used
> 0
20419 /* Even if there is a previous wrap
20420 point, continue the line here as
20421 usual, if (i) the previous character
20422 was a space or tab AND (ii) the
20423 current character is not. */
20425 || IT_DISPLAYING_WHITESPACE (it
)))
20428 /* Record the maximum and minimum buffer
20429 positions seen so far in glyphs that will be
20430 displayed by this row. */
20432 RECORD_MAX_MIN_POS (it
);
20433 set_iterator_to_next (it
, 1);
20434 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20436 if (!get_next_display_element (it
))
20438 row
->exact_window_width_line_p
= 1;
20439 it
->continuation_lines_width
= 0;
20440 row
->continued_p
= 0;
20441 row
->ends_at_zv_p
= 1;
20443 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20445 row
->continued_p
= 0;
20446 row
->exact_window_width_line_p
= 1;
20448 /* If line-wrap is on, check if a
20449 previous wrap point was found. */
20450 else if (wrap_row_used
> 0
20451 /* Even if there is a previous wrap
20452 point, continue the line here as
20453 usual, if (i) the previous character
20454 was a space or tab AND (ii) the
20455 current character is not. */
20457 || IT_DISPLAYING_WHITESPACE (it
)))
20462 else if (it
->bidi_p
)
20463 RECORD_MAX_MIN_POS (it
);
20464 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20465 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20466 extend_face_to_end_of_line (it
);
20468 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20469 && !FRAME_WINDOW_P (it
->f
))
20471 /* A padding glyph that doesn't fit on this line.
20472 This means the whole character doesn't fit
20474 if (row
->reversed_p
)
20475 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20476 - n_glyphs_before
);
20477 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20479 /* Fill the rest of the row with continuation
20480 glyphs like in 20.x. */
20481 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20482 < row
->glyphs
[1 + TEXT_AREA
])
20483 produce_special_glyphs (it
, IT_CONTINUATION
);
20485 row
->continued_p
= 1;
20486 it
->current_x
= x_before
;
20487 it
->continuation_lines_width
+= x_before
;
20489 /* Restore the height to what it was before the
20490 element not fitting on the line. */
20491 it
->max_ascent
= ascent
;
20492 it
->max_descent
= descent
;
20493 it
->max_phys_ascent
= phys_ascent
;
20494 it
->max_phys_descent
= phys_descent
;
20495 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20496 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20497 extend_face_to_end_of_line (it
);
20499 else if (wrap_row_used
> 0)
20502 if (row
->reversed_p
)
20503 unproduce_glyphs (it
,
20504 row
->used
[TEXT_AREA
] - wrap_row_used
);
20505 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20506 it
->continuation_lines_width
+= wrap_x
;
20507 row
->used
[TEXT_AREA
] = wrap_row_used
;
20508 row
->ascent
= wrap_row_ascent
;
20509 row
->height
= wrap_row_height
;
20510 row
->phys_ascent
= wrap_row_phys_ascent
;
20511 row
->phys_height
= wrap_row_phys_height
;
20512 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20513 min_pos
= wrap_row_min_pos
;
20514 min_bpos
= wrap_row_min_bpos
;
20515 max_pos
= wrap_row_max_pos
;
20516 max_bpos
= wrap_row_max_bpos
;
20517 row
->continued_p
= 1;
20518 row
->ends_at_zv_p
= 0;
20519 row
->exact_window_width_line_p
= 0;
20520 it
->continuation_lines_width
+= x
;
20522 /* Make sure that a non-default face is extended
20523 up to the right margin of the window. */
20524 extend_face_to_end_of_line (it
);
20526 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20528 /* A TAB that extends past the right edge of the
20529 window. This produces a single glyph on
20530 window system frames. We leave the glyph in
20531 this row and let it fill the row, but don't
20532 consume the TAB. */
20533 if ((row
->reversed_p
20534 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20535 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20536 produce_special_glyphs (it
, IT_CONTINUATION
);
20537 it
->continuation_lines_width
+= it
->last_visible_x
;
20538 row
->ends_in_middle_of_char_p
= 1;
20539 row
->continued_p
= 1;
20540 glyph
->pixel_width
= it
->last_visible_x
- x
;
20541 it
->starts_in_middle_of_char_p
= 1;
20542 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20543 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20544 extend_face_to_end_of_line (it
);
20548 /* Something other than a TAB that draws past
20549 the right edge of the window. Restore
20550 positions to values before the element. */
20551 if (row
->reversed_p
)
20552 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20553 - (n_glyphs_before
+ i
));
20554 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20556 /* Display continuation glyphs. */
20557 it
->current_x
= x_before
;
20558 it
->continuation_lines_width
+= x
;
20559 if (!FRAME_WINDOW_P (it
->f
)
20560 || (row
->reversed_p
20561 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20562 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20563 produce_special_glyphs (it
, IT_CONTINUATION
);
20564 row
->continued_p
= 1;
20566 extend_face_to_end_of_line (it
);
20568 if (nglyphs
> 1 && i
> 0)
20570 row
->ends_in_middle_of_char_p
= 1;
20571 it
->starts_in_middle_of_char_p
= 1;
20574 /* Restore the height to what it was before the
20575 element not fitting on the line. */
20576 it
->max_ascent
= ascent
;
20577 it
->max_descent
= descent
;
20578 it
->max_phys_ascent
= phys_ascent
;
20579 it
->max_phys_descent
= phys_descent
;
20584 else if (new_x
> it
->first_visible_x
)
20586 /* Increment number of glyphs actually displayed. */
20589 /* Record the maximum and minimum buffer positions
20590 seen so far in glyphs that will be displayed by
20593 RECORD_MAX_MIN_POS (it
);
20595 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20596 /* Glyph is partially visible, i.e. row starts at
20597 negative X position. Don't do that in R2L
20598 rows, where we arrange to add a right offset to
20599 the line in extend_face_to_end_of_line, by a
20600 suitable change to the stretch glyph that is
20601 the leftmost glyph of the line. */
20602 row
->x
= x
- it
->first_visible_x
;
20603 /* When the last glyph of an R2L row only fits
20604 partially on the line, we need to set row->x to a
20605 negative offset, so that the leftmost glyph is
20606 the one that is partially visible. But if we are
20607 going to produce the truncation glyph, this will
20608 be taken care of in produce_special_glyphs. */
20609 if (row
->reversed_p
20610 && new_x
> it
->last_visible_x
20611 && !(it
->line_wrap
== TRUNCATE
20612 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20614 eassert (FRAME_WINDOW_P (it
->f
));
20615 row
->x
= it
->last_visible_x
- new_x
;
20620 /* Glyph is completely off the left margin of the
20621 window. This should not happen because of the
20622 move_it_in_display_line at the start of this
20623 function, unless the text display area of the
20624 window is empty. */
20625 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20628 /* Even if this display element produced no glyphs at all,
20629 we want to record its position. */
20630 if (it
->bidi_p
&& nglyphs
== 0)
20631 RECORD_MAX_MIN_POS (it
);
20633 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20634 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20635 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20636 row
->phys_height
= max (row
->phys_height
,
20637 it
->max_phys_ascent
+ it
->max_phys_descent
);
20638 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20639 it
->max_extra_line_spacing
);
20641 /* End of this display line if row is continued. */
20642 if (row
->continued_p
|| row
->ends_at_zv_p
)
20647 /* Is this a line end? If yes, we're also done, after making
20648 sure that a non-default face is extended up to the right
20649 margin of the window. */
20650 if (ITERATOR_AT_END_OF_LINE_P (it
))
20652 int used_before
= row
->used
[TEXT_AREA
];
20654 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20656 /* Add a space at the end of the line that is used to
20657 display the cursor there. */
20658 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20659 append_space_for_newline (it
, 0);
20661 /* Extend the face to the end of the line. */
20662 extend_face_to_end_of_line (it
);
20664 /* Make sure we have the position. */
20665 if (used_before
== 0)
20666 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20668 /* Record the position of the newline, for use in
20670 it
->eol_pos
= it
->current
.pos
;
20672 /* Consume the line end. This skips over invisible lines. */
20673 set_iterator_to_next (it
, 1);
20674 it
->continuation_lines_width
= 0;
20678 /* Proceed with next display element. Note that this skips
20679 over lines invisible because of selective display. */
20680 set_iterator_to_next (it
, 1);
20682 /* If we truncate lines, we are done when the last displayed
20683 glyphs reach past the right margin of the window. */
20684 if (it
->line_wrap
== TRUNCATE
20685 && ((FRAME_WINDOW_P (it
->f
)
20686 /* Images are preprocessed in produce_image_glyph such
20687 that they are cropped at the right edge of the
20688 window, so an image glyph will always end exactly at
20689 last_visible_x, even if there's no right fringe. */
20690 && ((row
->reversed_p
20691 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20692 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20693 || it
->what
== IT_IMAGE
))
20694 ? (it
->current_x
>= it
->last_visible_x
)
20695 : (it
->current_x
> it
->last_visible_x
)))
20697 /* Maybe add truncation glyphs. */
20698 if (!FRAME_WINDOW_P (it
->f
)
20699 || (row
->reversed_p
20700 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20701 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20705 if (!row
->reversed_p
)
20707 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20708 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20713 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20714 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20716 /* Remove any padding glyphs at the front of ROW, to
20717 make room for the truncation glyphs we will be
20718 adding below. The loop below always inserts at
20719 least one truncation glyph, so also remove the
20720 last glyph added to ROW. */
20721 unproduce_glyphs (it
, i
+ 1);
20722 /* Adjust i for the loop below. */
20723 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20726 /* produce_special_glyphs overwrites the last glyph, so
20727 we don't want that if we want to keep that last
20728 glyph, which means it's an image. */
20729 if (it
->current_x
> it
->last_visible_x
)
20731 it
->current_x
= x_before
;
20732 if (!FRAME_WINDOW_P (it
->f
))
20734 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20736 row
->used
[TEXT_AREA
] = i
;
20737 produce_special_glyphs (it
, IT_TRUNCATION
);
20742 row
->used
[TEXT_AREA
] = i
;
20743 produce_special_glyphs (it
, IT_TRUNCATION
);
20745 it
->hpos
= hpos_before
;
20748 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20750 /* Don't truncate if we can overflow newline into fringe. */
20751 if (!get_next_display_element (it
))
20753 it
->continuation_lines_width
= 0;
20754 row
->ends_at_zv_p
= 1;
20755 row
->exact_window_width_line_p
= 1;
20758 if (ITERATOR_AT_END_OF_LINE_P (it
))
20760 row
->exact_window_width_line_p
= 1;
20761 goto at_end_of_line
;
20763 it
->current_x
= x_before
;
20764 it
->hpos
= hpos_before
;
20767 row
->truncated_on_right_p
= 1;
20768 it
->continuation_lines_width
= 0;
20769 reseat_at_next_visible_line_start (it
, 0);
20770 /* We insist below that IT's position be at ZV because in
20771 bidi-reordered lines the character at visible line start
20772 might not be the character that follows the newline in
20773 the logical order. */
20774 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20775 row
->ends_at_zv_p
=
20776 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20778 row
->ends_at_zv_p
= false;
20784 bidi_unshelve_cache (wrap_data
, 1);
20786 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20787 at the left window margin. */
20788 if (it
->first_visible_x
20789 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20791 if (!FRAME_WINDOW_P (it
->f
)
20792 || (((row
->reversed_p
20793 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20794 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20795 /* Don't let insert_left_trunc_glyphs overwrite the
20796 first glyph of the row if it is an image. */
20797 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20798 insert_left_trunc_glyphs (it
);
20799 row
->truncated_on_left_p
= 1;
20802 /* Remember the position at which this line ends.
20804 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20805 cannot be before the call to find_row_edges below, since that is
20806 where these positions are determined. */
20807 row
->end
= it
->current
;
20810 row
->minpos
= row
->start
.pos
;
20811 row
->maxpos
= row
->end
.pos
;
20815 /* ROW->minpos and ROW->maxpos must be the smallest and
20816 `1 + the largest' buffer positions in ROW. But if ROW was
20817 bidi-reordered, these two positions can be anywhere in the
20818 row, so we must determine them now. */
20819 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20822 /* If the start of this line is the overlay arrow-position, then
20823 mark this glyph row as the one containing the overlay arrow.
20824 This is clearly a mess with variable size fonts. It would be
20825 better to let it be displayed like cursors under X. */
20826 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20827 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20828 !NILP (overlay_arrow_string
)))
20830 /* Overlay arrow in window redisplay is a fringe bitmap. */
20831 if (STRINGP (overlay_arrow_string
))
20833 struct glyph_row
*arrow_row
20834 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20835 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20836 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20837 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20838 struct glyph
*p2
, *end
;
20840 /* Copy the arrow glyphs. */
20841 while (glyph
< arrow_end
)
20844 /* Throw away padding glyphs. */
20846 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20847 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20853 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20858 eassert (INTEGERP (overlay_arrow_string
));
20859 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20861 overlay_arrow_seen
= 1;
20864 /* Highlight trailing whitespace. */
20865 if (!NILP (Vshow_trailing_whitespace
))
20866 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20868 /* Compute pixel dimensions of this line. */
20869 compute_line_metrics (it
);
20871 /* Implementation note: No changes in the glyphs of ROW or in their
20872 faces can be done past this point, because compute_line_metrics
20873 computes ROW's hash value and stores it within the glyph_row
20876 /* Record whether this row ends inside an ellipsis. */
20877 row
->ends_in_ellipsis_p
20878 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20879 && it
->ellipsis_p
);
20881 /* Save fringe bitmaps in this row. */
20882 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20883 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20884 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20885 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20887 it
->left_user_fringe_bitmap
= 0;
20888 it
->left_user_fringe_face_id
= 0;
20889 it
->right_user_fringe_bitmap
= 0;
20890 it
->right_user_fringe_face_id
= 0;
20892 /* Maybe set the cursor. */
20893 cvpos
= it
->w
->cursor
.vpos
;
20895 /* In bidi-reordered rows, keep checking for proper cursor
20896 position even if one has been found already, because buffer
20897 positions in such rows change non-linearly with ROW->VPOS,
20898 when a line is continued. One exception: when we are at ZV,
20899 display cursor on the first suitable glyph row, since all
20900 the empty rows after that also have their position set to ZV. */
20901 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20902 lines' rows is implemented for bidi-reordered rows. */
20904 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20905 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20906 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20907 && cursor_row_p (row
))
20908 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20910 /* Prepare for the next line. This line starts horizontally at (X
20911 HPOS) = (0 0). Vertical positions are incremented. As a
20912 convenience for the caller, IT->glyph_row is set to the next
20914 it
->current_x
= it
->hpos
= 0;
20915 it
->current_y
+= row
->height
;
20916 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20919 /* The next row should by default use the same value of the
20920 reversed_p flag as this one. set_iterator_to_next decides when
20921 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20922 the flag accordingly. */
20923 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20924 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20925 it
->start
= row
->end
;
20926 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20928 #undef RECORD_MAX_MIN_POS
20931 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20932 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20933 doc
: /* Return paragraph direction at point in BUFFER.
20934 Value is either `left-to-right' or `right-to-left'.
20935 If BUFFER is omitted or nil, it defaults to the current buffer.
20937 Paragraph direction determines how the text in the paragraph is displayed.
20938 In left-to-right paragraphs, text begins at the left margin of the window
20939 and the reading direction is generally left to right. In right-to-left
20940 paragraphs, text begins at the right margin and is read from right to left.
20942 See also `bidi-paragraph-direction'. */)
20943 (Lisp_Object buffer
)
20945 struct buffer
*buf
= current_buffer
;
20946 struct buffer
*old
= buf
;
20948 if (! NILP (buffer
))
20950 CHECK_BUFFER (buffer
);
20951 buf
= XBUFFER (buffer
);
20954 if (NILP (BVAR (buf
, bidi_display_reordering
))
20955 || NILP (BVAR (buf
, enable_multibyte_characters
))
20956 /* When we are loading loadup.el, the character property tables
20957 needed for bidi iteration are not yet available. */
20958 || !NILP (Vpurify_flag
))
20959 return Qleft_to_right
;
20960 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20961 return BVAR (buf
, bidi_paragraph_direction
);
20964 /* Determine the direction from buffer text. We could try to
20965 use current_matrix if it is up to date, but this seems fast
20966 enough as it is. */
20967 struct bidi_it itb
;
20968 ptrdiff_t pos
= BUF_PT (buf
);
20969 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20971 void *itb_data
= bidi_shelve_cache ();
20973 set_buffer_temp (buf
);
20974 /* bidi_paragraph_init finds the base direction of the paragraph
20975 by searching forward from paragraph start. We need the base
20976 direction of the current or _previous_ paragraph, so we need
20977 to make sure we are within that paragraph. To that end, find
20978 the previous non-empty line. */
20979 if (pos
>= ZV
&& pos
> BEGV
)
20980 DEC_BOTH (pos
, bytepos
);
20981 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
20982 if (fast_looking_at (trailing_white_space
,
20983 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20985 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20986 || c
== ' ' || c
== '\t' || c
== '\f')
20988 if (bytepos
<= BEGV_BYTE
)
20993 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20996 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20997 itb
.paragraph_dir
= NEUTRAL_DIR
;
20998 itb
.string
.s
= NULL
;
20999 itb
.string
.lstring
= Qnil
;
21000 itb
.string
.bufpos
= 0;
21001 itb
.string
.from_disp_str
= 0;
21002 itb
.string
.unibyte
= 0;
21003 /* We have no window to use here for ignoring window-specific
21004 overlays. Using NULL for window pointer will cause
21005 compute_display_string_pos to use the current buffer. */
21007 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
21008 bidi_unshelve_cache (itb_data
, 0);
21009 set_buffer_temp (old
);
21010 switch (itb
.paragraph_dir
)
21013 return Qleft_to_right
;
21016 return Qright_to_left
;
21024 DEFUN ("bidi-find-overridden-directionality",
21025 Fbidi_find_overridden_directionality
,
21026 Sbidi_find_overridden_directionality
, 2, 3, 0,
21027 doc
: /* Return position between FROM and TO where directionality was overridden.
21029 This function returns the first character position in the specified
21030 region of OBJECT where there is a character whose `bidi-class' property
21031 is `L', but which was forced to display as `R' by a directional
21032 override, and likewise with characters whose `bidi-class' is `R'
21033 or `AL' that were forced to display as `L'.
21035 If no such character is found, the function returns nil.
21037 OBJECT is a Lisp string or buffer to search for overridden
21038 directionality, and defaults to the current buffer if nil or omitted.
21039 OBJECT can also be a window, in which case the function will search
21040 the buffer displayed in that window. Passing the window instead of
21041 a buffer is preferable when the buffer is displayed in some window,
21042 because this function will then be able to correctly account for
21043 window-specific overlays, which can affect the results.
21045 Strong directional characters `L', `R', and `AL' can have their
21046 intrinsic directionality overridden by directional override
21047 control characters RLO \(u+202e) and LRO \(u+202d). See the
21048 function `get-char-code-property' for a way to inquire about
21049 the `bidi-class' property of a character. */)
21050 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21052 struct buffer
*buf
= current_buffer
;
21053 struct buffer
*old
= buf
;
21054 struct window
*w
= NULL
;
21055 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21056 struct bidi_it itb
;
21057 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21060 if (!NILP (object
))
21062 if (BUFFERP (object
))
21063 buf
= XBUFFER (object
);
21064 else if (WINDOWP (object
))
21066 w
= decode_live_window (object
);
21067 buf
= XBUFFER (w
->contents
);
21068 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21071 CHECK_STRING (object
);
21074 if (STRINGP (object
))
21076 /* Characters in unibyte strings are always treated by bidi.c as
21078 if (!STRING_MULTIBYTE (object
)
21079 /* When we are loading loadup.el, the character property
21080 tables needed for bidi iteration are not yet
21082 || !NILP (Vpurify_flag
))
21085 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21086 if (from_pos
>= SCHARS (object
))
21089 /* Set up the bidi iterator. */
21090 itb_data
= bidi_shelve_cache ();
21091 itb
.paragraph_dir
= NEUTRAL_DIR
;
21092 itb
.string
.lstring
= object
;
21093 itb
.string
.s
= NULL
;
21094 itb
.string
.schars
= SCHARS (object
);
21095 itb
.string
.bufpos
= 0;
21096 itb
.string
.from_disp_str
= 0;
21097 itb
.string
.unibyte
= 0;
21099 bidi_init_it (0, 0, frame_window_p
, &itb
);
21103 /* Nothing this fancy can happen in unibyte buffers, or in a
21104 buffer that disabled reordering, or if FROM is at EOB. */
21105 if (NILP (BVAR (buf
, bidi_display_reordering
))
21106 || NILP (BVAR (buf
, enable_multibyte_characters
))
21107 /* When we are loading loadup.el, the character property
21108 tables needed for bidi iteration are not yet
21110 || !NILP (Vpurify_flag
))
21113 set_buffer_temp (buf
);
21114 validate_region (&from
, &to
);
21115 from_pos
= XINT (from
);
21116 to_pos
= XINT (to
);
21117 if (from_pos
>= ZV
)
21120 /* Set up the bidi iterator. */
21121 itb_data
= bidi_shelve_cache ();
21122 from_bpos
= CHAR_TO_BYTE (from_pos
);
21123 if (from_pos
== BEGV
)
21125 itb
.charpos
= BEGV
;
21126 itb
.bytepos
= BEGV_BYTE
;
21128 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21130 itb
.charpos
= from_pos
;
21131 itb
.bytepos
= from_bpos
;
21134 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21136 itb
.paragraph_dir
= NEUTRAL_DIR
;
21137 itb
.string
.s
= NULL
;
21138 itb
.string
.lstring
= Qnil
;
21139 itb
.string
.bufpos
= 0;
21140 itb
.string
.from_disp_str
= 0;
21141 itb
.string
.unibyte
= 0;
21143 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21148 /* For the purposes of this function, the actual base direction of
21149 the paragraph doesn't matter, so just set it to L2R. */
21150 bidi_paragraph_init (L2R
, &itb
, 0);
21151 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21153 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21155 bidi_unshelve_cache (itb_data
, 0);
21156 set_buffer_temp (old
);
21158 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21161 DEFUN ("move-point-visually", Fmove_point_visually
,
21162 Smove_point_visually
, 1, 1, 0,
21163 doc
: /* Move point in the visual order in the specified DIRECTION.
21164 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21167 Value is the new character position of point. */)
21168 (Lisp_Object direction
)
21170 struct window
*w
= XWINDOW (selected_window
);
21171 struct buffer
*b
= XBUFFER (w
->contents
);
21172 struct glyph_row
*row
;
21174 Lisp_Object paragraph_dir
;
21176 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21177 (!(ROW)->continued_p \
21178 && NILP ((GLYPH)->object) \
21179 && (GLYPH)->type == CHAR_GLYPH \
21180 && (GLYPH)->u.ch == ' ' \
21181 && (GLYPH)->charpos >= 0 \
21182 && !(GLYPH)->avoid_cursor_p)
21184 CHECK_NUMBER (direction
);
21185 dir
= XINT (direction
);
21191 /* If current matrix is up-to-date, we can use the information
21192 recorded in the glyphs, at least as long as the goal is on the
21194 if (w
->window_end_valid
21195 && !windows_or_buffers_changed
21197 && !b
->clip_changed
21198 && !b
->prevent_redisplay_optimizations_p
21199 && !window_outdated (w
)
21200 /* We rely below on the cursor coordinates to be up to date, but
21201 we cannot trust them if some command moved point since the
21202 last complete redisplay. */
21203 && w
->last_point
== BUF_PT (b
)
21204 && w
->cursor
.vpos
>= 0
21205 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21206 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21208 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21209 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21210 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21212 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21214 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21216 SET_PT (g
->charpos
);
21217 w
->cursor
.vpos
= -1;
21218 return make_number (PT
);
21220 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21224 if (BUFFERP (gpt
->object
))
21227 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21228 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21230 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21232 else if (BUFFERP (g
->object
))
21233 new_pos
= g
->charpos
;
21237 w
->cursor
.vpos
= -1;
21238 return make_number (PT
);
21240 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21242 /* Glyphs inserted at the end of a non-empty line for
21243 positioning the cursor have zero charpos, so we must
21244 deduce the value of point by other means. */
21245 if (g
->charpos
> 0)
21246 SET_PT (g
->charpos
);
21247 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21249 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21250 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21253 w
->cursor
.vpos
= -1;
21254 return make_number (PT
);
21257 if (g
== e
|| NILP (g
->object
))
21259 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21260 goto simulate_display
;
21261 if (!row
->reversed_p
)
21265 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21266 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21267 goto simulate_display
;
21271 if (row
->reversed_p
&& !row
->continued_p
)
21273 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21274 w
->cursor
.vpos
= -1;
21275 return make_number (PT
);
21277 g
= row
->glyphs
[TEXT_AREA
];
21278 e
= g
+ row
->used
[TEXT_AREA
];
21279 for ( ; g
< e
; g
++)
21281 if (BUFFERP (g
->object
)
21282 /* Empty lines have only one glyph, which stands
21283 for the newline, and whose charpos is the
21284 buffer position of the newline. */
21285 || ROW_GLYPH_NEWLINE_P (row
, g
)
21286 /* When the buffer ends in a newline, the line at
21287 EOB also has one glyph, but its charpos is -1. */
21288 || (row
->ends_at_zv_p
21289 && !row
->reversed_p
21290 && NILP (g
->object
)
21291 && g
->type
== CHAR_GLYPH
21292 && g
->u
.ch
== ' '))
21294 if (g
->charpos
> 0)
21295 SET_PT (g
->charpos
);
21296 else if (!row
->reversed_p
21297 && row
->ends_at_zv_p
21302 w
->cursor
.vpos
= -1;
21303 return make_number (PT
);
21309 if (!row
->reversed_p
&& !row
->continued_p
)
21311 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21312 w
->cursor
.vpos
= -1;
21313 return make_number (PT
);
21315 e
= row
->glyphs
[TEXT_AREA
];
21316 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21317 for ( ; g
>= e
; g
--)
21319 if (BUFFERP (g
->object
)
21320 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21322 /* Empty R2L lines on GUI frames have the buffer
21323 position of the newline stored in the stretch
21325 || g
->type
== STRETCH_GLYPH
21326 || (row
->ends_at_zv_p
21328 && NILP (g
->object
)
21329 && g
->type
== CHAR_GLYPH
21330 && g
->u
.ch
== ' '))
21332 if (g
->charpos
> 0)
21333 SET_PT (g
->charpos
);
21334 else if (row
->reversed_p
21335 && row
->ends_at_zv_p
21340 w
->cursor
.vpos
= -1;
21341 return make_number (PT
);
21350 /* If we wind up here, we failed to move by using the glyphs, so we
21351 need to simulate display instead. */
21354 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21356 paragraph_dir
= Qleft_to_right
;
21357 if (EQ (paragraph_dir
, Qright_to_left
))
21359 if (PT
<= BEGV
&& dir
< 0)
21360 xsignal0 (Qbeginning_of_buffer
);
21361 else if (PT
>= ZV
&& dir
> 0)
21362 xsignal0 (Qend_of_buffer
);
21365 struct text_pos pt
;
21367 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21369 bool overshoot_expected
= false;
21370 bool target_is_eol_p
= false;
21372 /* Setup the arena. */
21373 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21374 start_display (&it
, w
, pt
);
21376 if (it
.cmp_it
.id
< 0
21377 && it
.method
== GET_FROM_STRING
21378 && it
.area
== TEXT_AREA
21379 && it
.string_from_display_prop_p
21380 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21381 overshoot_expected
= true;
21383 /* Find the X coordinate of point. We start from the beginning
21384 of this or previous line to make sure we are before point in
21385 the logical order (since the move_it_* functions can only
21388 reseat_at_previous_visible_line_start (&it
);
21389 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21390 if (IT_CHARPOS (it
) != PT
)
21392 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21393 -1, -1, -1, MOVE_TO_POS
);
21394 /* If we missed point because the character there is
21395 displayed out of a display vector that has more than one
21396 glyph, retry expecting overshoot. */
21397 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21398 && it
.current
.dpvec_index
> 0
21399 && !overshoot_expected
)
21401 overshoot_expected
= true;
21404 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21405 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21407 pt_x
= it
.current_x
;
21409 if (dir
> 0 || overshoot_expected
)
21411 struct glyph_row
*row
= it
.glyph_row
;
21413 /* When point is at beginning of line, we don't have
21414 information about the glyph there loaded into struct
21415 it. Calling get_next_display_element fixes that. */
21417 get_next_display_element (&it
);
21418 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21419 it
.glyph_row
= NULL
;
21420 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21421 it
.glyph_row
= row
;
21422 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21423 it, lest it will become out of sync with it's buffer
21425 it
.current_x
= pt_x
;
21428 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21429 pixel_width
= it
.pixel_width
;
21430 if (overshoot_expected
&& at_eol_p
)
21432 else if (pixel_width
<= 0)
21435 /* If there's a display string (or something similar) at point,
21436 we are actually at the glyph to the left of point, so we need
21437 to correct the X coordinate. */
21438 if (overshoot_expected
)
21441 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21443 pt_x
+= pixel_width
;
21446 /* Compute target X coordinate, either to the left or to the
21447 right of point. On TTY frames, all characters have the same
21448 pixel width of 1, so we can use that. On GUI frames we don't
21449 have an easy way of getting at the pixel width of the
21450 character to the left of point, so we use a different method
21451 of getting to that place. */
21453 target_x
= pt_x
+ pixel_width
;
21455 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21457 /* Target X coordinate could be one line above or below the line
21458 of point, in which case we need to adjust the target X
21459 coordinate. Also, if moving to the left, we need to begin at
21460 the left edge of the point's screen line. */
21465 start_display (&it
, w
, pt
);
21466 reseat_at_previous_visible_line_start (&it
);
21467 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21469 move_it_by_lines (&it
, pt_vpos
);
21473 move_it_by_lines (&it
, -1);
21474 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21475 target_is_eol_p
= true;
21476 /* Under word-wrap, we don't know the x coordinate of
21477 the last character displayed on the previous line,
21478 which immediately precedes the wrap point. To find
21479 out its x coordinate, we try moving to the right
21480 margin of the window, which will stop at the wrap
21481 point, and then reset target_x to point at the
21482 character that precedes the wrap point. This is not
21483 needed on GUI frames, because (see below) there we
21484 move from the left margin one grapheme cluster at a
21485 time, and stop when we hit the wrap point. */
21486 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21488 void *it_data
= NULL
;
21491 SAVE_IT (it2
, it
, it_data
);
21492 move_it_in_display_line_to (&it
, ZV
, target_x
,
21493 MOVE_TO_POS
| MOVE_TO_X
);
21494 /* If we arrived at target_x, that _is_ the last
21495 character on the previous line. */
21496 if (it
.current_x
!= target_x
)
21497 target_x
= it
.current_x
- 1;
21498 RESTORE_IT (&it
, &it2
, it_data
);
21505 || (target_x
>= it
.last_visible_x
21506 && it
.line_wrap
!= TRUNCATE
))
21509 move_it_by_lines (&it
, 0);
21510 move_it_by_lines (&it
, 1);
21515 /* Move to the target X coordinate. */
21516 #ifdef HAVE_WINDOW_SYSTEM
21517 /* On GUI frames, as we don't know the X coordinate of the
21518 character to the left of point, moving point to the left
21519 requires walking, one grapheme cluster at a time, until we
21520 find ourself at a place immediately to the left of the
21521 character at point. */
21522 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21524 struct text_pos new_pos
;
21525 enum move_it_result rc
= MOVE_X_REACHED
;
21527 if (it
.current_x
== 0)
21528 get_next_display_element (&it
);
21529 if (it
.what
== IT_COMPOSITION
)
21531 new_pos
.charpos
= it
.cmp_it
.charpos
;
21532 new_pos
.bytepos
= -1;
21535 new_pos
= it
.current
.pos
;
21537 while (it
.current_x
+ it
.pixel_width
<= target_x
21538 && (rc
== MOVE_X_REACHED
21539 /* Under word-wrap, move_it_in_display_line_to
21540 stops at correct coordinates, but sometimes
21541 returns MOVE_POS_MATCH_OR_ZV. */
21542 || (it
.line_wrap
== WORD_WRAP
21543 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21545 int new_x
= it
.current_x
+ it
.pixel_width
;
21547 /* For composed characters, we want the position of the
21548 first character in the grapheme cluster (usually, the
21549 composition's base character), whereas it.current
21550 might give us the position of the _last_ one, e.g. if
21551 the composition is rendered in reverse due to bidi
21553 if (it
.what
== IT_COMPOSITION
)
21555 new_pos
.charpos
= it
.cmp_it
.charpos
;
21556 new_pos
.bytepos
= -1;
21559 new_pos
= it
.current
.pos
;
21560 if (new_x
== it
.current_x
)
21562 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21563 MOVE_TO_POS
| MOVE_TO_X
);
21564 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21567 /* The previous position we saw in the loop is the one we
21569 if (new_pos
.bytepos
== -1)
21570 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21571 it
.current
.pos
= new_pos
;
21575 if (it
.current_x
!= target_x
)
21576 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21578 /* When lines are truncated, the above loop will stop at the
21579 window edge. But we want to get to the end of line, even if
21580 it is beyond the window edge; automatic hscroll will then
21581 scroll the window to show point as appropriate. */
21582 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21583 && get_next_display_element (&it
))
21585 struct text_pos new_pos
= it
.current
.pos
;
21587 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21589 set_iterator_to_next (&it
, 0);
21590 if (it
.method
== GET_FROM_BUFFER
)
21591 new_pos
= it
.current
.pos
;
21592 if (!get_next_display_element (&it
))
21596 it
.current
.pos
= new_pos
;
21599 /* If we ended up in a display string that covers point, move to
21600 buffer position to the right in the visual order. */
21603 while (IT_CHARPOS (it
) == PT
)
21605 set_iterator_to_next (&it
, 0);
21606 if (!get_next_display_element (&it
))
21611 /* Move point to that position. */
21612 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21615 return make_number (PT
);
21617 #undef ROW_GLYPH_NEWLINE_P
21620 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21621 Sbidi_resolved_levels
, 0, 1, 0,
21622 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21624 The resolved levels are produced by the Emacs bidi reordering engine
21625 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21626 read the Unicode Standard Annex 9 (UAX#9) for background information
21627 about these levels.
21629 VPOS is the zero-based number of the current window's screen line
21630 for which to produce the resolved levels. If VPOS is nil or omitted,
21631 it defaults to the screen line of point. If the window displays a
21632 header line, VPOS of zero will report on the header line, and first
21633 line of text in the window will have VPOS of 1.
21635 Value is an array of resolved levels, indexed by glyph number.
21636 Glyphs are numbered from zero starting from the beginning of the
21637 screen line, i.e. the left edge of the window for left-to-right lines
21638 and from the right edge for right-to-left lines. The resolved levels
21639 are produced only for the window's text area; text in display margins
21642 If the selected window's display is not up-to-date, or if the specified
21643 screen line does not display text, this function returns nil. It is
21644 highly recommended to bind this function to some simple key, like F8,
21645 in order to avoid these problems.
21647 This function exists mainly for testing the correctness of the
21648 Emacs UBA implementation, in particular with the test suite. */)
21651 struct window
*w
= XWINDOW (selected_window
);
21652 struct buffer
*b
= XBUFFER (w
->contents
);
21654 struct glyph_row
*row
;
21658 int d1
, d2
, d3
, d4
, d5
;
21660 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21664 CHECK_NUMBER_COERCE_MARKER (vpos
);
21665 nrow
= XINT (vpos
);
21668 /* We require up-to-date glyph matrix for this window. */
21669 if (w
->window_end_valid
21670 && !windows_or_buffers_changed
21672 && !b
->clip_changed
21673 && !b
->prevent_redisplay_optimizations_p
21674 && !window_outdated (w
)
21676 && nrow
< w
->current_matrix
->nrows
21677 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21678 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21680 struct glyph
*g
, *e
, *g1
;
21682 Lisp_Object levels
;
21684 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21686 g
= g1
= row
->glyphs
[TEXT_AREA
];
21687 e
= g
+ row
->used
[TEXT_AREA
];
21689 /* Skip over glyphs at the start of the row that was
21690 generated by redisplay for its own needs. */
21692 && NILP (g
->object
)
21697 /* Count the "interesting" glyphs in this row. */
21698 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21701 /* Create and fill the array. */
21702 levels
= make_uninit_vector (nglyphs
);
21703 for (i
= 0; g1
< g
; i
++, g1
++)
21704 ASET (levels
, i
, make_number (g1
->resolved_level
));
21706 else /* Right-to-left glyph row. */
21708 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21709 e
= row
->glyphs
[TEXT_AREA
] - 1;
21711 && NILP (g
->object
)
21715 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21717 levels
= make_uninit_vector (nglyphs
);
21718 for (i
= 0; g1
> g
; i
++, g1
--)
21719 ASET (levels
, i
, make_number (g1
->resolved_level
));
21729 /***********************************************************************
21731 ***********************************************************************/
21733 /* Redisplay the menu bar in the frame for window W.
21735 The menu bar of X frames that don't have X toolkit support is
21736 displayed in a special window W->frame->menu_bar_window.
21738 The menu bar of terminal frames is treated specially as far as
21739 glyph matrices are concerned. Menu bar lines are not part of
21740 windows, so the update is done directly on the frame matrix rows
21741 for the menu bar. */
21744 display_menu_bar (struct window
*w
)
21746 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21751 /* Don't do all this for graphical frames. */
21753 if (FRAME_W32_P (f
))
21756 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21762 if (FRAME_NS_P (f
))
21764 #endif /* HAVE_NS */
21766 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21767 eassert (!FRAME_WINDOW_P (f
));
21768 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21769 it
.first_visible_x
= 0;
21770 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21771 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21772 if (FRAME_WINDOW_P (f
))
21774 /* Menu bar lines are displayed in the desired matrix of the
21775 dummy window menu_bar_window. */
21776 struct window
*menu_w
;
21777 menu_w
= XWINDOW (f
->menu_bar_window
);
21778 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21780 it
.first_visible_x
= 0;
21781 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21784 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21786 /* This is a TTY frame, i.e. character hpos/vpos are used as
21788 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21790 it
.first_visible_x
= 0;
21791 it
.last_visible_x
= FRAME_COLS (f
);
21794 /* FIXME: This should be controlled by a user option. See the
21795 comments in redisplay_tool_bar and display_mode_line about
21797 it
.paragraph_embedding
= L2R
;
21799 /* Clear all rows of the menu bar. */
21800 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21802 struct glyph_row
*row
= it
.glyph_row
+ i
;
21803 clear_glyph_row (row
);
21804 row
->enabled_p
= true;
21805 row
->full_width_p
= 1;
21806 row
->reversed_p
= false;
21809 /* Display all items of the menu bar. */
21810 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21811 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21813 Lisp_Object string
;
21815 /* Stop at nil string. */
21816 string
= AREF (items
, i
+ 1);
21820 /* Remember where item was displayed. */
21821 ASET (items
, i
+ 3, make_number (it
.hpos
));
21823 /* Display the item, pad with one space. */
21824 if (it
.current_x
< it
.last_visible_x
)
21825 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21826 SCHARS (string
) + 1, 0, 0, -1);
21829 /* Fill out the line with spaces. */
21830 if (it
.current_x
< it
.last_visible_x
)
21831 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21833 /* Compute the total height of the lines. */
21834 compute_line_metrics (&it
);
21837 /* Deep copy of a glyph row, including the glyphs. */
21839 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21841 struct glyph
*pointers
[1 + LAST_AREA
];
21842 int to_used
= to
->used
[TEXT_AREA
];
21844 /* Save glyph pointers of TO. */
21845 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21847 /* Do a structure assignment. */
21850 /* Restore original glyph pointers of TO. */
21851 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21853 /* Copy the glyphs. */
21854 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21855 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21857 /* If we filled only part of the TO row, fill the rest with
21858 space_glyph (which will display as empty space). */
21859 if (to_used
> from
->used
[TEXT_AREA
])
21860 fill_up_frame_row_with_spaces (to
, to_used
);
21863 /* Display one menu item on a TTY, by overwriting the glyphs in the
21864 frame F's desired glyph matrix with glyphs produced from the menu
21865 item text. Called from term.c to display TTY drop-down menus one
21868 ITEM_TEXT is the menu item text as a C string.
21870 FACE_ID is the face ID to be used for this menu item. FACE_ID
21871 could specify one of 3 faces: a face for an enabled item, a face
21872 for a disabled item, or a face for a selected item.
21874 X and Y are coordinates of the first glyph in the frame's desired
21875 matrix to be overwritten by the menu item. Since this is a TTY, Y
21876 is the zero-based number of the glyph row and X is the zero-based
21877 glyph number in the row, starting from left, where to start
21878 displaying the item.
21880 SUBMENU non-zero means this menu item drops down a submenu, which
21881 should be indicated by displaying a proper visual cue after the
21885 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21886 int x
, int y
, int submenu
)
21889 struct frame
*f
= SELECTED_FRAME ();
21890 struct window
*w
= XWINDOW (f
->selected_window
);
21891 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21892 struct glyph_row
*row
;
21893 size_t item_len
= strlen (item_text
);
21895 eassert (FRAME_TERMCAP_P (f
));
21897 /* Don't write beyond the matrix's last row. This can happen for
21898 TTY screens that are not high enough to show the entire menu.
21899 (This is actually a bit of defensive programming, as
21900 tty_menu_display already limits the number of menu items to one
21901 less than the number of screen lines.) */
21902 if (y
>= f
->desired_matrix
->nrows
)
21905 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21906 it
.first_visible_x
= 0;
21907 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21908 row
= it
.glyph_row
;
21909 /* Start with the row contents from the current matrix. */
21910 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21911 saved_width
= row
->full_width_p
;
21912 row
->full_width_p
= 1;
21913 saved_reversed
= row
->reversed_p
;
21914 row
->reversed_p
= 0;
21915 row
->enabled_p
= true;
21917 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21919 eassert (x
< f
->desired_matrix
->matrix_w
);
21920 it
.current_x
= it
.hpos
= x
;
21921 it
.current_y
= it
.vpos
= y
;
21922 saved_used
= row
->used
[TEXT_AREA
];
21923 saved_truncated
= row
->truncated_on_right_p
;
21924 row
->used
[TEXT_AREA
] = x
;
21925 it
.face_id
= face_id
;
21926 it
.line_wrap
= TRUNCATE
;
21928 /* FIXME: This should be controlled by a user option. See the
21929 comments in redisplay_tool_bar and display_mode_line about this.
21930 Also, if paragraph_embedding could ever be R2L, changes will be
21931 needed to avoid shifting to the right the row characters in
21932 term.c:append_glyph. */
21933 it
.paragraph_embedding
= L2R
;
21935 /* Pad with a space on the left. */
21936 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21938 /* Display the menu item, pad with spaces to WIDTH. */
21941 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21942 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21944 /* Indicate with " >" that there's a submenu. */
21945 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21946 FRAME_COLS (f
) - 1, -1);
21949 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21950 width
, 0, FRAME_COLS (f
) - 1, -1);
21952 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21953 row
->truncated_on_right_p
= saved_truncated
;
21954 row
->hash
= row_hash (row
);
21955 row
->full_width_p
= saved_width
;
21956 row
->reversed_p
= saved_reversed
;
21959 /***********************************************************************
21961 ***********************************************************************/
21963 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21964 FORCE is non-zero, redisplay mode lines unconditionally.
21965 Otherwise, redisplay only mode lines that are garbaged. Value is
21966 the number of windows whose mode lines were redisplayed. */
21969 redisplay_mode_lines (Lisp_Object window
, bool force
)
21973 while (!NILP (window
))
21975 struct window
*w
= XWINDOW (window
);
21977 if (WINDOWP (w
->contents
))
21978 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21980 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21981 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21983 struct text_pos lpoint
;
21984 struct buffer
*old
= current_buffer
;
21986 /* Set the window's buffer for the mode line display. */
21987 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21988 set_buffer_internal_1 (XBUFFER (w
->contents
));
21990 /* Point refers normally to the selected window. For any
21991 other window, set up appropriate value. */
21992 if (!EQ (window
, selected_window
))
21994 struct text_pos pt
;
21996 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21997 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22000 /* Display mode lines. */
22001 clear_glyph_matrix (w
->desired_matrix
);
22002 if (display_mode_lines (w
))
22005 /* Restore old settings. */
22006 set_buffer_internal_1 (old
);
22007 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22017 /* Display the mode and/or header line of window W. Value is the
22018 sum number of mode lines and header lines displayed. */
22021 display_mode_lines (struct window
*w
)
22023 Lisp_Object old_selected_window
= selected_window
;
22024 Lisp_Object old_selected_frame
= selected_frame
;
22025 Lisp_Object new_frame
= w
->frame
;
22026 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22029 selected_frame
= new_frame
;
22030 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22031 or window's point, then we'd need select_window_1 here as well. */
22032 XSETWINDOW (selected_window
, w
);
22033 XFRAME (new_frame
)->selected_window
= selected_window
;
22035 /* These will be set while the mode line specs are processed. */
22036 line_number_displayed
= 0;
22037 w
->column_number_displayed
= -1;
22039 if (WINDOW_WANTS_MODELINE_P (w
))
22041 struct window
*sel_w
= XWINDOW (old_selected_window
);
22043 /* Select mode line face based on the real selected window. */
22044 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22045 BVAR (current_buffer
, mode_line_format
));
22049 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22051 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22052 BVAR (current_buffer
, header_line_format
));
22056 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22057 selected_frame
= old_selected_frame
;
22058 selected_window
= old_selected_window
;
22060 w
->must_be_updated_p
= true;
22065 /* Display mode or header line of window W. FACE_ID specifies which
22066 line to display; it is either MODE_LINE_FACE_ID or
22067 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22068 display. Value is the pixel height of the mode/header line
22072 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22076 ptrdiff_t count
= SPECPDL_INDEX ();
22078 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22079 /* Don't extend on a previously drawn mode-line.
22080 This may happen if called from pos_visible_p. */
22081 it
.glyph_row
->enabled_p
= false;
22082 prepare_desired_row (w
, it
.glyph_row
, true);
22084 it
.glyph_row
->mode_line_p
= 1;
22086 /* FIXME: This should be controlled by a user option. But
22087 supporting such an option is not trivial, since the mode line is
22088 made up of many separate strings. */
22089 it
.paragraph_embedding
= L2R
;
22091 record_unwind_protect (unwind_format_mode_line
,
22092 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
22094 mode_line_target
= MODE_LINE_DISPLAY
;
22096 /* Temporarily make frame's keyboard the current kboard so that
22097 kboard-local variables in the mode_line_format will get the right
22099 push_kboard (FRAME_KBOARD (it
.f
));
22100 record_unwind_save_match_data ();
22101 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22104 unbind_to (count
, Qnil
);
22106 /* Fill up with spaces. */
22107 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22109 compute_line_metrics (&it
);
22110 it
.glyph_row
->full_width_p
= 1;
22111 it
.glyph_row
->continued_p
= 0;
22112 it
.glyph_row
->truncated_on_left_p
= 0;
22113 it
.glyph_row
->truncated_on_right_p
= 0;
22115 /* Make a 3D mode-line have a shadow at its right end. */
22116 face
= FACE_FROM_ID (it
.f
, face_id
);
22117 extend_face_to_end_of_line (&it
);
22118 if (face
->box
!= FACE_NO_BOX
)
22120 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22121 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22122 last
->right_box_line_p
= 1;
22125 return it
.glyph_row
->height
;
22128 /* Move element ELT in LIST to the front of LIST.
22129 Return the updated list. */
22132 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22134 register Lisp_Object tail
, prev
;
22135 register Lisp_Object tem
;
22139 while (CONSP (tail
))
22145 /* Splice out the link TAIL. */
22147 list
= XCDR (tail
);
22149 Fsetcdr (prev
, XCDR (tail
));
22151 /* Now make it the first. */
22152 Fsetcdr (tail
, list
);
22157 tail
= XCDR (tail
);
22161 /* Not found--return unchanged LIST. */
22165 /* Contribute ELT to the mode line for window IT->w. How it
22166 translates into text depends on its data type.
22168 IT describes the display environment in which we display, as usual.
22170 DEPTH is the depth in recursion. It is used to prevent
22171 infinite recursion here.
22173 FIELD_WIDTH is the number of characters the display of ELT should
22174 occupy in the mode line, and PRECISION is the maximum number of
22175 characters to display from ELT's representation. See
22176 display_string for details.
22178 Returns the hpos of the end of the text generated by ELT.
22180 PROPS is a property list to add to any string we encounter.
22182 If RISKY is nonzero, remove (disregard) any properties in any string
22183 we encounter, and ignore :eval and :propertize.
22185 The global variable `mode_line_target' determines whether the
22186 output is passed to `store_mode_line_noprop',
22187 `store_mode_line_string', or `display_string'. */
22190 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22191 Lisp_Object elt
, Lisp_Object props
, int risky
)
22193 int n
= 0, field
, prec
;
22198 elt
= build_string ("*too-deep*");
22202 switch (XTYPE (elt
))
22206 /* A string: output it and check for %-constructs within it. */
22208 ptrdiff_t offset
= 0;
22210 if (SCHARS (elt
) > 0
22211 && (!NILP (props
) || risky
))
22213 Lisp_Object oprops
, aelt
;
22214 oprops
= Ftext_properties_at (make_number (0), elt
);
22216 /* If the starting string's properties are not what
22217 we want, translate the string. Also, if the string
22218 is risky, do that anyway. */
22220 if (NILP (Fequal (props
, oprops
)) || risky
)
22222 /* If the starting string has properties,
22223 merge the specified ones onto the existing ones. */
22224 if (! NILP (oprops
) && !risky
)
22228 oprops
= Fcopy_sequence (oprops
);
22230 while (CONSP (tem
))
22232 oprops
= Fplist_put (oprops
, XCAR (tem
),
22233 XCAR (XCDR (tem
)));
22234 tem
= XCDR (XCDR (tem
));
22239 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22240 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22242 /* AELT is what we want. Move it to the front
22243 without consing. */
22245 mode_line_proptrans_alist
22246 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22252 /* If AELT has the wrong props, it is useless.
22253 so get rid of it. */
22255 mode_line_proptrans_alist
22256 = Fdelq (aelt
, mode_line_proptrans_alist
);
22258 elt
= Fcopy_sequence (elt
);
22259 Fset_text_properties (make_number (0), Flength (elt
),
22261 /* Add this item to mode_line_proptrans_alist. */
22262 mode_line_proptrans_alist
22263 = Fcons (Fcons (elt
, props
),
22264 mode_line_proptrans_alist
);
22265 /* Truncate mode_line_proptrans_alist
22266 to at most 50 elements. */
22267 tem
= Fnthcdr (make_number (50),
22268 mode_line_proptrans_alist
);
22270 XSETCDR (tem
, Qnil
);
22279 prec
= precision
- n
;
22280 switch (mode_line_target
)
22282 case MODE_LINE_NOPROP
:
22283 case MODE_LINE_TITLE
:
22284 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22286 case MODE_LINE_STRING
:
22287 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
22289 case MODE_LINE_DISPLAY
:
22290 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22291 0, prec
, 0, STRING_MULTIBYTE (elt
));
22298 /* Handle the non-literal case. */
22300 while ((precision
<= 0 || n
< precision
)
22301 && SREF (elt
, offset
) != 0
22302 && (mode_line_target
!= MODE_LINE_DISPLAY
22303 || it
->current_x
< it
->last_visible_x
))
22305 ptrdiff_t last_offset
= offset
;
22307 /* Advance to end of string or next format specifier. */
22308 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22311 if (offset
- 1 != last_offset
)
22313 ptrdiff_t nchars
, nbytes
;
22315 /* Output to end of string or up to '%'. Field width
22316 is length of string. Don't output more than
22317 PRECISION allows us. */
22320 prec
= c_string_width (SDATA (elt
) + last_offset
,
22321 offset
- last_offset
, precision
- n
,
22324 switch (mode_line_target
)
22326 case MODE_LINE_NOPROP
:
22327 case MODE_LINE_TITLE
:
22328 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22330 case MODE_LINE_STRING
:
22332 ptrdiff_t bytepos
= last_offset
;
22333 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22334 ptrdiff_t endpos
= (precision
<= 0
22335 ? string_byte_to_char (elt
, offset
)
22336 : charpos
+ nchars
);
22338 n
+= store_mode_line_string (NULL
,
22339 Fsubstring (elt
, make_number (charpos
),
22340 make_number (endpos
)),
22344 case MODE_LINE_DISPLAY
:
22346 ptrdiff_t bytepos
= last_offset
;
22347 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22349 if (precision
<= 0)
22350 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22351 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22353 STRING_MULTIBYTE (elt
));
22358 else /* c == '%' */
22360 ptrdiff_t percent_position
= offset
;
22362 /* Get the specified minimum width. Zero means
22365 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22366 field
= field
* 10 + c
- '0';
22368 /* Don't pad beyond the total padding allowed. */
22369 if (field_width
- n
> 0 && field
> field_width
- n
)
22370 field
= field_width
- n
;
22372 /* Note that either PRECISION <= 0 or N < PRECISION. */
22373 prec
= precision
- n
;
22376 n
+= display_mode_element (it
, depth
, field
, prec
,
22377 Vglobal_mode_string
, props
,
22382 ptrdiff_t bytepos
, charpos
;
22384 Lisp_Object string
;
22386 bytepos
= percent_position
;
22387 charpos
= (STRING_MULTIBYTE (elt
)
22388 ? string_byte_to_char (elt
, bytepos
)
22390 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22391 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22393 switch (mode_line_target
)
22395 case MODE_LINE_NOPROP
:
22396 case MODE_LINE_TITLE
:
22397 n
+= store_mode_line_noprop (spec
, field
, prec
);
22399 case MODE_LINE_STRING
:
22401 Lisp_Object tem
= build_string (spec
);
22402 props
= Ftext_properties_at (make_number (charpos
), elt
);
22403 /* Should only keep face property in props */
22404 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22407 case MODE_LINE_DISPLAY
:
22409 int nglyphs_before
, nwritten
;
22411 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22412 nwritten
= display_string (spec
, string
, elt
,
22417 /* Assign to the glyphs written above the
22418 string where the `%x' came from, position
22422 struct glyph
*glyph
22423 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22427 for (i
= 0; i
< nwritten
; ++i
)
22429 glyph
[i
].object
= elt
;
22430 glyph
[i
].charpos
= charpos
;
22447 /* A symbol: process the value of the symbol recursively
22448 as if it appeared here directly. Avoid error if symbol void.
22449 Special case: if value of symbol is a string, output the string
22452 register Lisp_Object tem
;
22454 /* If the variable is not marked as risky to set
22455 then its contents are risky to use. */
22456 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22459 tem
= Fboundp (elt
);
22462 tem
= Fsymbol_value (elt
);
22463 /* If value is a string, output that string literally:
22464 don't check for % within it. */
22468 if (!EQ (tem
, elt
))
22470 /* Give up right away for nil or t. */
22480 register Lisp_Object car
, tem
;
22482 /* A cons cell: five distinct cases.
22483 If first element is :eval or :propertize, do something special.
22484 If first element is a string or a cons, process all the elements
22485 and effectively concatenate them.
22486 If first element is a negative number, truncate displaying cdr to
22487 at most that many characters. If positive, pad (with spaces)
22488 to at least that many characters.
22489 If first element is a symbol, process the cadr or caddr recursively
22490 according to whether the symbol's value is non-nil or nil. */
22492 if (EQ (car
, QCeval
))
22494 /* An element of the form (:eval FORM) means evaluate FORM
22495 and use the result as mode line elements. */
22500 if (CONSP (XCDR (elt
)))
22503 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22504 n
+= display_mode_element (it
, depth
, field_width
- n
,
22505 precision
- n
, spec
, props
,
22509 else if (EQ (car
, QCpropertize
))
22511 /* An element of the form (:propertize ELT PROPS...)
22512 means display ELT but applying properties PROPS. */
22517 if (CONSP (XCDR (elt
)))
22518 n
+= display_mode_element (it
, depth
, field_width
- n
,
22519 precision
- n
, XCAR (XCDR (elt
)),
22520 XCDR (XCDR (elt
)), risky
);
22522 else if (SYMBOLP (car
))
22524 tem
= Fboundp (car
);
22528 /* elt is now the cdr, and we know it is a cons cell.
22529 Use its car if CAR has a non-nil value. */
22532 tem
= Fsymbol_value (car
);
22539 /* Symbol's value is nil (or symbol is unbound)
22540 Get the cddr of the original list
22541 and if possible find the caddr and use that. */
22545 else if (!CONSP (elt
))
22550 else if (INTEGERP (car
))
22552 register int lim
= XINT (car
);
22556 /* Negative int means reduce maximum width. */
22557 if (precision
<= 0)
22560 precision
= min (precision
, -lim
);
22564 /* Padding specified. Don't let it be more than
22565 current maximum. */
22567 lim
= min (precision
, lim
);
22569 /* If that's more padding than already wanted, queue it.
22570 But don't reduce padding already specified even if
22571 that is beyond the current truncation point. */
22572 field_width
= max (lim
, field_width
);
22576 else if (STRINGP (car
) || CONSP (car
))
22578 Lisp_Object halftail
= elt
;
22582 && (precision
<= 0 || n
< precision
))
22584 n
+= display_mode_element (it
, depth
,
22585 /* Do padding only after the last
22586 element in the list. */
22587 (! CONSP (XCDR (elt
))
22590 precision
- n
, XCAR (elt
),
22594 if ((len
& 1) == 0)
22595 halftail
= XCDR (halftail
);
22596 /* Check for cycle. */
22597 if (EQ (halftail
, elt
))
22606 elt
= build_string ("*invalid*");
22610 /* Pad to FIELD_WIDTH. */
22611 if (field_width
> 0 && n
< field_width
)
22613 switch (mode_line_target
)
22615 case MODE_LINE_NOPROP
:
22616 case MODE_LINE_TITLE
:
22617 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22619 case MODE_LINE_STRING
:
22620 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22622 case MODE_LINE_DISPLAY
:
22623 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22632 /* Store a mode-line string element in mode_line_string_list.
22634 If STRING is non-null, display that C string. Otherwise, the Lisp
22635 string LISP_STRING is displayed.
22637 FIELD_WIDTH is the minimum number of output glyphs to produce.
22638 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22639 with spaces. FIELD_WIDTH <= 0 means don't pad.
22641 PRECISION is the maximum number of characters to output from
22642 STRING. PRECISION <= 0 means don't truncate the string.
22644 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22645 properties to the string.
22647 PROPS are the properties to add to the string.
22648 The mode_line_string_face face property is always added to the string.
22652 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22653 int field_width
, int precision
, Lisp_Object props
)
22658 if (string
!= NULL
)
22660 len
= strlen (string
);
22661 if (precision
> 0 && len
> precision
)
22663 lisp_string
= make_string (string
, len
);
22665 props
= mode_line_string_face_prop
;
22666 else if (!NILP (mode_line_string_face
))
22668 Lisp_Object face
= Fplist_get (props
, Qface
);
22669 props
= Fcopy_sequence (props
);
22671 face
= mode_line_string_face
;
22673 face
= list2 (face
, mode_line_string_face
);
22674 props
= Fplist_put (props
, Qface
, face
);
22676 Fadd_text_properties (make_number (0), make_number (len
),
22677 props
, lisp_string
);
22681 len
= XFASTINT (Flength (lisp_string
));
22682 if (precision
> 0 && len
> precision
)
22685 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22688 if (!NILP (mode_line_string_face
))
22692 props
= Ftext_properties_at (make_number (0), lisp_string
);
22693 face
= Fplist_get (props
, Qface
);
22695 face
= mode_line_string_face
;
22697 face
= list2 (face
, mode_line_string_face
);
22698 props
= list2 (Qface
, face
);
22700 lisp_string
= Fcopy_sequence (lisp_string
);
22703 Fadd_text_properties (make_number (0), make_number (len
),
22704 props
, lisp_string
);
22709 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22713 if (field_width
> len
)
22715 field_width
-= len
;
22716 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22718 Fadd_text_properties (make_number (0), make_number (field_width
),
22719 props
, lisp_string
);
22720 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22728 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22730 doc
: /* Format a string out of a mode line format specification.
22731 First arg FORMAT specifies the mode line format (see `mode-line-format'
22732 for details) to use.
22734 By default, the format is evaluated for the currently selected window.
22736 Optional second arg FACE specifies the face property to put on all
22737 characters for which no face is specified. The value nil means the
22738 default face. The value t means whatever face the window's mode line
22739 currently uses (either `mode-line' or `mode-line-inactive',
22740 depending on whether the window is the selected window or not).
22741 An integer value means the value string has no text
22744 Optional third and fourth args WINDOW and BUFFER specify the window
22745 and buffer to use as the context for the formatting (defaults
22746 are the selected window and the WINDOW's buffer). */)
22747 (Lisp_Object format
, Lisp_Object face
,
22748 Lisp_Object window
, Lisp_Object buffer
)
22753 struct buffer
*old_buffer
= NULL
;
22755 int no_props
= INTEGERP (face
);
22756 ptrdiff_t count
= SPECPDL_INDEX ();
22758 int string_start
= 0;
22760 w
= decode_any_window (window
);
22761 XSETWINDOW (window
, w
);
22764 buffer
= w
->contents
;
22765 CHECK_BUFFER (buffer
);
22767 /* Make formatting the modeline a non-op when noninteractive, otherwise
22768 there will be problems later caused by a partially initialized frame. */
22769 if (NILP (format
) || noninteractive
)
22770 return empty_unibyte_string
;
22775 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22776 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22777 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22778 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22779 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22780 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22781 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22784 old_buffer
= current_buffer
;
22786 /* Save things including mode_line_proptrans_alist,
22787 and set that to nil so that we don't alter the outer value. */
22788 record_unwind_protect (unwind_format_mode_line
,
22789 format_mode_line_unwind_data
22790 (XFRAME (WINDOW_FRAME (w
)),
22791 old_buffer
, selected_window
, 1));
22792 mode_line_proptrans_alist
= Qnil
;
22794 Fselect_window (window
, Qt
);
22795 set_buffer_internal_1 (XBUFFER (buffer
));
22797 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22801 mode_line_target
= MODE_LINE_NOPROP
;
22802 mode_line_string_face_prop
= Qnil
;
22803 mode_line_string_list
= Qnil
;
22804 string_start
= MODE_LINE_NOPROP_LEN (0);
22808 mode_line_target
= MODE_LINE_STRING
;
22809 mode_line_string_list
= Qnil
;
22810 mode_line_string_face
= face
;
22811 mode_line_string_face_prop
22812 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22815 push_kboard (FRAME_KBOARD (it
.f
));
22816 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22821 len
= MODE_LINE_NOPROP_LEN (string_start
);
22822 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22826 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22827 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22828 empty_unibyte_string
);
22831 unbind_to (count
, Qnil
);
22835 /* Write a null-terminated, right justified decimal representation of
22836 the positive integer D to BUF using a minimal field width WIDTH. */
22839 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22841 register char *p
= buf
;
22849 *p
++ = d
% 10 + '0';
22854 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22865 /* Write a null-terminated, right justified decimal and "human
22866 readable" representation of the nonnegative integer D to BUF using
22867 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22869 static const char power_letter
[] =
22883 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22885 /* We aim to represent the nonnegative integer D as
22886 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22887 ptrdiff_t quotient
= d
;
22889 /* -1 means: do not use TENTHS. */
22893 /* Length of QUOTIENT.TENTHS as a string. */
22899 if (quotient
>= 1000)
22901 /* Scale to the appropriate EXPONENT. */
22904 remainder
= quotient
% 1000;
22908 while (quotient
>= 1000);
22910 /* Round to nearest and decide whether to use TENTHS or not. */
22913 tenths
= remainder
/ 100;
22914 if (remainder
% 100 >= 50)
22921 if (quotient
== 10)
22929 if (remainder
>= 500)
22931 if (quotient
< 999)
22942 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22943 if (tenths
== -1 && quotient
<= 99)
22950 p
= psuffix
= buf
+ max (width
, length
);
22952 /* Print EXPONENT. */
22953 *psuffix
++ = power_letter
[exponent
];
22956 /* Print TENTHS. */
22959 *--p
= '0' + tenths
;
22963 /* Print QUOTIENT. */
22966 int digit
= quotient
% 10;
22967 *--p
= '0' + digit
;
22969 while ((quotient
/= 10) != 0);
22971 /* Print leading spaces. */
22976 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22977 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22978 type of CODING_SYSTEM. Return updated pointer into BUF. */
22980 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22983 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22986 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22987 const unsigned char *eol_str
;
22989 /* The EOL conversion we are using. */
22990 Lisp_Object eoltype
;
22992 val
= CODING_SYSTEM_SPEC (coding_system
);
22995 if (!VECTORP (val
)) /* Not yet decided. */
22997 *buf
++ = multibyte
? '-' : ' ';
22999 eoltype
= eol_mnemonic_undecided
;
23000 /* Don't mention EOL conversion if it isn't decided. */
23005 Lisp_Object eolvalue
;
23007 attrs
= AREF (val
, 0);
23008 eolvalue
= AREF (val
, 2);
23011 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23016 /* The EOL conversion that is normal on this system. */
23018 if (NILP (eolvalue
)) /* Not yet decided. */
23019 eoltype
= eol_mnemonic_undecided
;
23020 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23021 eoltype
= eol_mnemonic_undecided
;
23022 else /* eolvalue is Qunix, Qdos, or Qmac. */
23023 eoltype
= (EQ (eolvalue
, Qunix
)
23024 ? eol_mnemonic_unix
23025 : (EQ (eolvalue
, Qdos
) == 1
23026 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
23032 /* Mention the EOL conversion if it is not the usual one. */
23033 if (STRINGP (eoltype
))
23035 eol_str
= SDATA (eoltype
);
23036 eol_str_len
= SBYTES (eoltype
);
23038 else if (CHARACTERP (eoltype
))
23040 int c
= XFASTINT (eoltype
);
23041 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23045 eol_str
= invalid_eol_type
;
23046 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23048 memcpy (buf
, eol_str
, eol_str_len
);
23049 buf
+= eol_str_len
;
23055 /* Return a string for the output of a mode line %-spec for window W,
23056 generated by character C. FIELD_WIDTH > 0 means pad the string
23057 returned with spaces to that value. Return a Lisp string in
23058 *STRING if the resulting string is taken from that Lisp string.
23060 Note we operate on the current buffer for most purposes. */
23062 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23064 static const char *
23065 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23066 Lisp_Object
*string
)
23069 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23070 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23071 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23072 produce strings from numerical values, so limit preposterously
23073 large values of FIELD_WIDTH to avoid overrunning the buffer's
23074 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23075 bytes plus the terminating null. */
23076 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23077 struct buffer
*b
= current_buffer
;
23085 if (!NILP (BVAR (b
, read_only
)))
23087 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23092 /* This differs from %* only for a modified read-only buffer. */
23093 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23095 if (!NILP (BVAR (b
, read_only
)))
23100 /* This differs from %* in ignoring read-only-ness. */
23101 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23113 if (command_loop_level
> 5)
23115 p
= decode_mode_spec_buf
;
23116 for (i
= 0; i
< command_loop_level
; i
++)
23119 return decode_mode_spec_buf
;
23127 if (command_loop_level
> 5)
23129 p
= decode_mode_spec_buf
;
23130 for (i
= 0; i
< command_loop_level
; i
++)
23133 return decode_mode_spec_buf
;
23140 /* Let lots_of_dashes be a string of infinite length. */
23141 if (mode_line_target
== MODE_LINE_NOPROP
23142 || mode_line_target
== MODE_LINE_STRING
)
23144 if (field_width
<= 0
23145 || field_width
> sizeof (lots_of_dashes
))
23147 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23148 decode_mode_spec_buf
[i
] = '-';
23149 decode_mode_spec_buf
[i
] = '\0';
23150 return decode_mode_spec_buf
;
23153 return lots_of_dashes
;
23157 obj
= BVAR (b
, name
);
23161 /* %c and %l are ignored in `frame-title-format'.
23162 (In redisplay_internal, the frame title is drawn _before_ the
23163 windows are updated, so the stuff which depends on actual
23164 window contents (such as %l) may fail to render properly, or
23165 even crash emacs.) */
23166 if (mode_line_target
== MODE_LINE_TITLE
)
23170 ptrdiff_t col
= current_column ();
23171 w
->column_number_displayed
= col
;
23172 pint2str (decode_mode_spec_buf
, width
, col
);
23173 return decode_mode_spec_buf
;
23177 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23179 if (NILP (Vmemory_full
))
23182 return "!MEM FULL! ";
23189 /* %F displays the frame name. */
23190 if (!NILP (f
->title
))
23191 return SSDATA (f
->title
);
23192 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23193 return SSDATA (f
->name
);
23197 obj
= BVAR (b
, filename
);
23202 ptrdiff_t size
= ZV
- BEGV
;
23203 pint2str (decode_mode_spec_buf
, width
, size
);
23204 return decode_mode_spec_buf
;
23209 ptrdiff_t size
= ZV
- BEGV
;
23210 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23211 return decode_mode_spec_buf
;
23216 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23217 ptrdiff_t topline
, nlines
, height
;
23220 /* %c and %l are ignored in `frame-title-format'. */
23221 if (mode_line_target
== MODE_LINE_TITLE
)
23224 startpos
= marker_position (w
->start
);
23225 startpos_byte
= marker_byte_position (w
->start
);
23226 height
= WINDOW_TOTAL_LINES (w
);
23228 /* If we decided that this buffer isn't suitable for line numbers,
23229 don't forget that too fast. */
23230 if (w
->base_line_pos
== -1)
23233 /* If the buffer is very big, don't waste time. */
23234 if (INTEGERP (Vline_number_display_limit
)
23235 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23237 w
->base_line_pos
= 0;
23238 w
->base_line_number
= 0;
23242 if (w
->base_line_number
> 0
23243 && w
->base_line_pos
> 0
23244 && w
->base_line_pos
<= startpos
)
23246 line
= w
->base_line_number
;
23247 linepos
= w
->base_line_pos
;
23248 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23253 linepos
= BUF_BEGV (b
);
23254 linepos_byte
= BUF_BEGV_BYTE (b
);
23257 /* Count lines from base line to window start position. */
23258 nlines
= display_count_lines (linepos_byte
,
23262 topline
= nlines
+ line
;
23264 /* Determine a new base line, if the old one is too close
23265 or too far away, or if we did not have one.
23266 "Too close" means it's plausible a scroll-down would
23267 go back past it. */
23268 if (startpos
== BUF_BEGV (b
))
23270 w
->base_line_number
= topline
;
23271 w
->base_line_pos
= BUF_BEGV (b
);
23273 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23274 || linepos
== BUF_BEGV (b
))
23276 ptrdiff_t limit
= BUF_BEGV (b
);
23277 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23278 ptrdiff_t position
;
23279 ptrdiff_t distance
=
23280 (height
* 2 + 30) * line_number_display_limit_width
;
23282 if (startpos
- distance
> limit
)
23284 limit
= startpos
- distance
;
23285 limit_byte
= CHAR_TO_BYTE (limit
);
23288 nlines
= display_count_lines (startpos_byte
,
23290 - (height
* 2 + 30),
23292 /* If we couldn't find the lines we wanted within
23293 line_number_display_limit_width chars per line,
23294 give up on line numbers for this window. */
23295 if (position
== limit_byte
&& limit
== startpos
- distance
)
23297 w
->base_line_pos
= -1;
23298 w
->base_line_number
= 0;
23302 w
->base_line_number
= topline
- nlines
;
23303 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23306 /* Now count lines from the start pos to point. */
23307 nlines
= display_count_lines (startpos_byte
,
23308 PT_BYTE
, PT
, &junk
);
23310 /* Record that we did display the line number. */
23311 line_number_displayed
= 1;
23313 /* Make the string to show. */
23314 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23315 return decode_mode_spec_buf
;
23318 char *p
= decode_mode_spec_buf
;
23319 int pad
= width
- 2;
23325 return decode_mode_spec_buf
;
23331 obj
= BVAR (b
, mode_name
);
23335 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23341 ptrdiff_t pos
= marker_position (w
->start
);
23342 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23344 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23346 if (pos
<= BUF_BEGV (b
))
23351 else if (pos
<= BUF_BEGV (b
))
23355 if (total
> 1000000)
23356 /* Do it differently for a large value, to avoid overflow. */
23357 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23359 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23360 /* We can't normally display a 3-digit number,
23361 so get us a 2-digit number that is close. */
23364 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23365 return decode_mode_spec_buf
;
23369 /* Display percentage of size above the bottom of the screen. */
23372 ptrdiff_t toppos
= marker_position (w
->start
);
23373 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23374 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23376 if (botpos
>= BUF_ZV (b
))
23378 if (toppos
<= BUF_BEGV (b
))
23385 if (total
> 1000000)
23386 /* Do it differently for a large value, to avoid overflow. */
23387 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23389 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23390 /* We can't normally display a 3-digit number,
23391 so get us a 2-digit number that is close. */
23394 if (toppos
<= BUF_BEGV (b
))
23395 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23397 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23398 return decode_mode_spec_buf
;
23403 /* status of process */
23404 obj
= Fget_buffer_process (Fcurrent_buffer ());
23406 return "no process";
23408 obj
= Fsymbol_name (Fprocess_status (obj
));
23414 ptrdiff_t count
= inhibit_garbage_collection ();
23415 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23416 Lisp_Object val
= Qnil
;
23418 if (STRINGP (curdir
))
23419 val
= call1 (intern ("file-remote-p"), curdir
);
23421 unbind_to (count
, Qnil
);
23430 /* coding-system (not including end-of-line format) */
23432 /* coding-system (including end-of-line type) */
23434 int eol_flag
= (c
== 'Z');
23435 char *p
= decode_mode_spec_buf
;
23437 if (! FRAME_WINDOW_P (f
))
23439 /* No need to mention EOL here--the terminal never needs
23440 to do EOL conversion. */
23441 p
= decode_mode_spec_coding (CODING_ID_NAME
23442 (FRAME_KEYBOARD_CODING (f
)->id
),
23444 p
= decode_mode_spec_coding (CODING_ID_NAME
23445 (FRAME_TERMINAL_CODING (f
)->id
),
23448 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23451 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23452 #ifdef subprocesses
23453 obj
= Fget_buffer_process (Fcurrent_buffer ());
23454 if (PROCESSP (obj
))
23456 p
= decode_mode_spec_coding
23457 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23458 p
= decode_mode_spec_coding
23459 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23461 #endif /* subprocesses */
23464 return decode_mode_spec_buf
;
23471 return SSDATA (obj
);
23478 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23479 means count lines back from START_BYTE. But don't go beyond
23480 LIMIT_BYTE. Return the number of lines thus found (always
23483 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23484 either the position COUNT lines after/before START_BYTE, if we
23485 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23489 display_count_lines (ptrdiff_t start_byte
,
23490 ptrdiff_t limit_byte
, ptrdiff_t count
,
23491 ptrdiff_t *byte_pos_ptr
)
23493 register unsigned char *cursor
;
23494 unsigned char *base
;
23496 register ptrdiff_t ceiling
;
23497 register unsigned char *ceiling_addr
;
23498 ptrdiff_t orig_count
= count
;
23500 /* If we are not in selective display mode,
23501 check only for newlines. */
23502 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23503 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23507 while (start_byte
< limit_byte
)
23509 ceiling
= BUFFER_CEILING_OF (start_byte
);
23510 ceiling
= min (limit_byte
- 1, ceiling
);
23511 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23512 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23516 if (selective_display
)
23518 while (*cursor
!= '\n' && *cursor
!= 015
23519 && ++cursor
!= ceiling_addr
)
23521 if (cursor
== ceiling_addr
)
23526 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23535 start_byte
+= cursor
- base
;
23536 *byte_pos_ptr
= start_byte
;
23540 while (cursor
< ceiling_addr
);
23542 start_byte
+= ceiling_addr
- base
;
23547 while (start_byte
> limit_byte
)
23549 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23550 ceiling
= max (limit_byte
, ceiling
);
23551 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23552 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23555 if (selective_display
)
23557 while (--cursor
>= ceiling_addr
23558 && *cursor
!= '\n' && *cursor
!= 015)
23560 if (cursor
< ceiling_addr
)
23565 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23572 start_byte
+= cursor
- base
+ 1;
23573 *byte_pos_ptr
= start_byte
;
23574 /* When scanning backwards, we should
23575 not count the newline posterior to which we stop. */
23576 return - orig_count
- 1;
23579 start_byte
+= ceiling_addr
- base
;
23583 *byte_pos_ptr
= limit_byte
;
23586 return - orig_count
+ count
;
23587 return orig_count
- count
;
23593 /***********************************************************************
23595 ***********************************************************************/
23597 /* Display a NUL-terminated string, starting with index START.
23599 If STRING is non-null, display that C string. Otherwise, the Lisp
23600 string LISP_STRING is displayed. There's a case that STRING is
23601 non-null and LISP_STRING is not nil. It means STRING is a string
23602 data of LISP_STRING. In that case, we display LISP_STRING while
23603 ignoring its text properties.
23605 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23606 FACE_STRING. Display STRING or LISP_STRING with the face at
23607 FACE_STRING_POS in FACE_STRING:
23609 Display the string in the environment given by IT, but use the
23610 standard display table, temporarily.
23612 FIELD_WIDTH is the minimum number of output glyphs to produce.
23613 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23614 with spaces. If STRING has more characters, more than FIELD_WIDTH
23615 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23617 PRECISION is the maximum number of characters to output from
23618 STRING. PRECISION < 0 means don't truncate the string.
23620 This is roughly equivalent to printf format specifiers:
23622 FIELD_WIDTH PRECISION PRINTF
23623 ----------------------------------------
23629 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23630 display them, and < 0 means obey the current buffer's value of
23631 enable_multibyte_characters.
23633 Value is the number of columns displayed. */
23636 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23637 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23638 int field_width
, int precision
, int max_x
, int multibyte
)
23640 int hpos_at_start
= it
->hpos
;
23641 int saved_face_id
= it
->face_id
;
23642 struct glyph_row
*row
= it
->glyph_row
;
23643 ptrdiff_t it_charpos
;
23645 /* Initialize the iterator IT for iteration over STRING beginning
23646 with index START. */
23647 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23648 precision
, field_width
, multibyte
);
23649 if (string
&& STRINGP (lisp_string
))
23650 /* LISP_STRING is the one returned by decode_mode_spec. We should
23651 ignore its text properties. */
23652 it
->stop_charpos
= it
->end_charpos
;
23654 /* If displaying STRING, set up the face of the iterator from
23655 FACE_STRING, if that's given. */
23656 if (STRINGP (face_string
))
23662 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23663 0, &endptr
, it
->base_face_id
, false);
23664 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23665 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23668 /* Set max_x to the maximum allowed X position. Don't let it go
23669 beyond the right edge of the window. */
23671 max_x
= it
->last_visible_x
;
23673 max_x
= min (max_x
, it
->last_visible_x
);
23675 /* Skip over display elements that are not visible. because IT->w is
23677 if (it
->current_x
< it
->first_visible_x
)
23678 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23679 MOVE_TO_POS
| MOVE_TO_X
);
23681 row
->ascent
= it
->max_ascent
;
23682 row
->height
= it
->max_ascent
+ it
->max_descent
;
23683 row
->phys_ascent
= it
->max_phys_ascent
;
23684 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23685 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23687 if (STRINGP (it
->string
))
23688 it_charpos
= IT_STRING_CHARPOS (*it
);
23690 it_charpos
= IT_CHARPOS (*it
);
23692 /* This condition is for the case that we are called with current_x
23693 past last_visible_x. */
23694 while (it
->current_x
< max_x
)
23696 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23698 /* Get the next display element. */
23699 if (!get_next_display_element (it
))
23702 /* Produce glyphs. */
23703 x_before
= it
->current_x
;
23704 n_glyphs_before
= row
->used
[TEXT_AREA
];
23705 PRODUCE_GLYPHS (it
);
23707 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23710 while (i
< nglyphs
)
23712 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23714 if (it
->line_wrap
!= TRUNCATE
23715 && x
+ glyph
->pixel_width
> max_x
)
23717 /* End of continued line or max_x reached. */
23718 if (CHAR_GLYPH_PADDING_P (*glyph
))
23720 /* A wide character is unbreakable. */
23721 if (row
->reversed_p
)
23722 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23723 - n_glyphs_before
);
23724 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23725 it
->current_x
= x_before
;
23729 if (row
->reversed_p
)
23730 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23731 - (n_glyphs_before
+ i
));
23732 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23737 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23739 /* Glyph is at least partially visible. */
23741 if (x
< it
->first_visible_x
)
23742 row
->x
= x
- it
->first_visible_x
;
23746 /* Glyph is off the left margin of the display area.
23747 Should not happen. */
23751 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23752 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23753 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23754 row
->phys_height
= max (row
->phys_height
,
23755 it
->max_phys_ascent
+ it
->max_phys_descent
);
23756 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23757 it
->max_extra_line_spacing
);
23758 x
+= glyph
->pixel_width
;
23762 /* Stop if max_x reached. */
23766 /* Stop at line ends. */
23767 if (ITERATOR_AT_END_OF_LINE_P (it
))
23769 it
->continuation_lines_width
= 0;
23773 set_iterator_to_next (it
, 1);
23774 if (STRINGP (it
->string
))
23775 it_charpos
= IT_STRING_CHARPOS (*it
);
23777 it_charpos
= IT_CHARPOS (*it
);
23779 /* Stop if truncating at the right edge. */
23780 if (it
->line_wrap
== TRUNCATE
23781 && it
->current_x
>= it
->last_visible_x
)
23783 /* Add truncation mark, but don't do it if the line is
23784 truncated at a padding space. */
23785 if (it_charpos
< it
->string_nchars
)
23787 if (!FRAME_WINDOW_P (it
->f
))
23791 if (it
->current_x
> it
->last_visible_x
)
23793 if (!row
->reversed_p
)
23795 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23796 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23801 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23802 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23804 unproduce_glyphs (it
, ii
+ 1);
23805 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23807 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23809 row
->used
[TEXT_AREA
] = ii
;
23810 produce_special_glyphs (it
, IT_TRUNCATION
);
23813 produce_special_glyphs (it
, IT_TRUNCATION
);
23815 row
->truncated_on_right_p
= 1;
23821 /* Maybe insert a truncation at the left. */
23822 if (it
->first_visible_x
23825 if (!FRAME_WINDOW_P (it
->f
)
23826 || (row
->reversed_p
23827 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23828 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23829 insert_left_trunc_glyphs (it
);
23830 row
->truncated_on_left_p
= 1;
23833 it
->face_id
= saved_face_id
;
23835 /* Value is number of columns displayed. */
23836 return it
->hpos
- hpos_at_start
;
23841 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23842 appears as an element of LIST or as the car of an element of LIST.
23843 If PROPVAL is a list, compare each element against LIST in that
23844 way, and return 1/2 if any element of PROPVAL is found in LIST.
23845 Otherwise return 0. This function cannot quit.
23846 The return value is 2 if the text is invisible but with an ellipsis
23847 and 1 if it's invisible and without an ellipsis. */
23850 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23852 register Lisp_Object tail
, proptail
;
23854 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23856 register Lisp_Object tem
;
23858 if (EQ (propval
, tem
))
23860 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23861 return NILP (XCDR (tem
)) ? 1 : 2;
23864 if (CONSP (propval
))
23866 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23868 Lisp_Object propelt
;
23869 propelt
= XCAR (proptail
);
23870 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23872 register Lisp_Object tem
;
23874 if (EQ (propelt
, tem
))
23876 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23877 return NILP (XCDR (tem
)) ? 1 : 2;
23885 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23886 doc
: /* Non-nil if the property makes the text invisible.
23887 POS-OR-PROP can be a marker or number, in which case it is taken to be
23888 a position in the current buffer and the value of the `invisible' property
23889 is checked; or it can be some other value, which is then presumed to be the
23890 value of the `invisible' property of the text of interest.
23891 The non-nil value returned can be t for truly invisible text or something
23892 else if the text is replaced by an ellipsis. */)
23893 (Lisp_Object pos_or_prop
)
23896 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23897 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23899 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23900 return (invis
== 0 ? Qnil
23902 : make_number (invis
));
23905 /* Calculate a width or height in pixels from a specification using
23906 the following elements:
23909 NUM - a (fractional) multiple of the default font width/height
23910 (NUM) - specifies exactly NUM pixels
23911 UNIT - a fixed number of pixels, see below.
23912 ELEMENT - size of a display element in pixels, see below.
23913 (NUM . SPEC) - equals NUM * SPEC
23914 (+ SPEC SPEC ...) - add pixel values
23915 (- SPEC SPEC ...) - subtract pixel values
23916 (- SPEC) - negate pixel value
23919 INT or FLOAT - a number constant
23920 SYMBOL - use symbol's (buffer local) variable binding.
23923 in - pixels per inch *)
23924 mm - pixels per 1/1000 meter *)
23925 cm - pixels per 1/100 meter *)
23926 width - width of current font in pixels.
23927 height - height of current font in pixels.
23929 *) using the ratio(s) defined in display-pixels-per-inch.
23933 left-fringe - left fringe width in pixels
23934 right-fringe - right fringe width in pixels
23936 left-margin - left margin width in pixels
23937 right-margin - right margin width in pixels
23939 scroll-bar - scroll-bar area width in pixels
23943 Pixels corresponding to 5 inches:
23946 Total width of non-text areas on left side of window (if scroll-bar is on left):
23947 '(space :width (+ left-fringe left-margin scroll-bar))
23949 Align to first text column (in header line):
23950 '(space :align-to 0)
23952 Align to middle of text area minus half the width of variable `my-image'
23953 containing a loaded image:
23954 '(space :align-to (0.5 . (- text my-image)))
23956 Width of left margin minus width of 1 character in the default font:
23957 '(space :width (- left-margin 1))
23959 Width of left margin minus width of 2 characters in the current font:
23960 '(space :width (- left-margin (2 . width)))
23962 Center 1 character over left-margin (in header line):
23963 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23965 Different ways to express width of left fringe plus left margin minus one pixel:
23966 '(space :width (- (+ left-fringe left-margin) (1)))
23967 '(space :width (+ left-fringe left-margin (- (1))))
23968 '(space :width (+ left-fringe left-margin (-1)))
23973 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23974 struct font
*font
, int width_p
, int *align_to
)
23978 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23979 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23982 return OK_PIXELS (0);
23984 eassert (FRAME_LIVE_P (it
->f
));
23986 if (SYMBOLP (prop
))
23988 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23990 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23992 if (unit
[0] == 'i' && unit
[1] == 'n')
23994 else if (unit
[0] == 'm' && unit
[1] == 'm')
23996 else if (unit
[0] == 'c' && unit
[1] == 'm')
24002 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24003 : FRAME_RES_Y (it
->f
));
24006 return OK_PIXELS (ppi
/ pixels
);
24011 #ifdef HAVE_WINDOW_SYSTEM
24012 if (EQ (prop
, Qheight
))
24013 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
24014 if (EQ (prop
, Qwidth
))
24015 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
24017 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24018 return OK_PIXELS (1);
24021 if (EQ (prop
, Qtext
))
24022 return OK_PIXELS (width_p
24023 ? window_box_width (it
->w
, TEXT_AREA
)
24024 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24026 if (align_to
&& *align_to
< 0)
24029 if (EQ (prop
, Qleft
))
24030 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24031 if (EQ (prop
, Qright
))
24032 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24033 if (EQ (prop
, Qcenter
))
24034 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24035 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24036 if (EQ (prop
, Qleft_fringe
))
24037 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24038 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24039 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24040 if (EQ (prop
, Qright_fringe
))
24041 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24042 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24043 : window_box_right_offset (it
->w
, TEXT_AREA
));
24044 if (EQ (prop
, Qleft_margin
))
24045 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24046 if (EQ (prop
, Qright_margin
))
24047 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24048 if (EQ (prop
, Qscroll_bar
))
24049 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24051 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24052 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24053 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24058 if (EQ (prop
, Qleft_fringe
))
24059 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24060 if (EQ (prop
, Qright_fringe
))
24061 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24062 if (EQ (prop
, Qleft_margin
))
24063 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24064 if (EQ (prop
, Qright_margin
))
24065 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24066 if (EQ (prop
, Qscroll_bar
))
24067 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24070 prop
= buffer_local_value (prop
, it
->w
->contents
);
24071 if (EQ (prop
, Qunbound
))
24075 if (INTEGERP (prop
) || FLOATP (prop
))
24077 int base_unit
= (width_p
24078 ? FRAME_COLUMN_WIDTH (it
->f
)
24079 : FRAME_LINE_HEIGHT (it
->f
));
24080 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24085 Lisp_Object car
= XCAR (prop
);
24086 Lisp_Object cdr
= XCDR (prop
);
24090 #ifdef HAVE_WINDOW_SYSTEM
24091 if (FRAME_WINDOW_P (it
->f
)
24092 && valid_image_p (prop
))
24094 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24095 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24097 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24099 #ifdef HAVE_XWIDGETS
24100 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24102 //TODO dont return dummy size
24103 return OK_PIXELS (width_p
? 100 : 100);
24107 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24113 while (CONSP (cdr
))
24115 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24116 font
, width_p
, align_to
))
24119 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
24124 if (EQ (car
, Qminus
))
24126 return OK_PIXELS (pixels
);
24129 car
= buffer_local_value (car
, it
->w
->contents
);
24130 if (EQ (car
, Qunbound
))
24134 if (INTEGERP (car
) || FLOATP (car
))
24137 pixels
= XFLOATINT (car
);
24139 return OK_PIXELS (pixels
);
24140 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24141 font
, width_p
, align_to
))
24142 return OK_PIXELS (pixels
* fact
);
24153 /***********************************************************************
24155 ***********************************************************************/
24157 #ifdef HAVE_WINDOW_SYSTEM
24162 dump_glyph_string (struct glyph_string
*s
)
24164 fprintf (stderr
, "glyph string\n");
24165 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24166 s
->x
, s
->y
, s
->width
, s
->height
);
24167 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24168 fprintf (stderr
, " hl = %d\n", s
->hl
);
24169 fprintf (stderr
, " left overhang = %d, right = %d\n",
24170 s
->left_overhang
, s
->right_overhang
);
24171 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24172 fprintf (stderr
, " extends to end of line = %d\n",
24173 s
->extends_to_end_of_line_p
);
24174 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24175 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24178 #endif /* GLYPH_DEBUG */
24180 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24181 of XChar2b structures for S; it can't be allocated in
24182 init_glyph_string because it must be allocated via `alloca'. W
24183 is the window on which S is drawn. ROW and AREA are the glyph row
24184 and area within the row from which S is constructed. START is the
24185 index of the first glyph structure covered by S. HL is a
24186 face-override for drawing S. */
24189 #define OPTIONAL_HDC(hdc) HDC hdc,
24190 #define DECLARE_HDC(hdc) HDC hdc;
24191 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24192 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24195 #ifndef OPTIONAL_HDC
24196 #define OPTIONAL_HDC(hdc)
24197 #define DECLARE_HDC(hdc)
24198 #define ALLOCATE_HDC(hdc, f)
24199 #define RELEASE_HDC(hdc, f)
24203 init_glyph_string (struct glyph_string
*s
,
24205 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24206 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24208 memset (s
, 0, sizeof *s
);
24210 s
->f
= XFRAME (w
->frame
);
24214 s
->display
= FRAME_X_DISPLAY (s
->f
);
24215 s
->window
= FRAME_X_WINDOW (s
->f
);
24216 s
->char2b
= char2b
;
24220 s
->first_glyph
= row
->glyphs
[area
] + start
;
24221 s
->height
= row
->height
;
24222 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24223 s
->ybase
= s
->y
+ row
->ascent
;
24227 /* Append the list of glyph strings with head H and tail T to the list
24228 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24231 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24232 struct glyph_string
*h
, struct glyph_string
*t
)
24246 /* Prepend the list of glyph strings with head H and tail T to the
24247 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24251 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24252 struct glyph_string
*h
, struct glyph_string
*t
)
24266 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24267 Set *HEAD and *TAIL to the resulting list. */
24270 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24271 struct glyph_string
*s
)
24273 s
->next
= s
->prev
= NULL
;
24274 append_glyph_string_lists (head
, tail
, s
, s
);
24278 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24279 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
24280 make sure that X resources for the face returned are allocated.
24281 Value is a pointer to a realized face that is ready for display if
24282 DISPLAY_P is non-zero. */
24284 static struct face
*
24285 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24286 XChar2b
*char2b
, int display_p
)
24288 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24293 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24295 if (code
== FONT_INVALID_CODE
)
24298 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24300 /* Make sure X resources of the face are allocated. */
24301 #ifdef HAVE_X_WINDOWS
24305 eassert (face
!= NULL
);
24306 prepare_face_for_display (f
, face
);
24313 /* Get face and two-byte form of character glyph GLYPH on frame F.
24314 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24315 a pointer to a realized face that is ready for display. */
24317 static struct face
*
24318 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24319 XChar2b
*char2b
, int *two_byte_p
)
24324 eassert (glyph
->type
== CHAR_GLYPH
);
24325 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24327 /* Make sure X resources of the face are allocated. */
24328 eassert (face
!= NULL
);
24329 prepare_face_for_display (f
, face
);
24336 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24337 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24339 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24341 if (code
== FONT_INVALID_CODE
)
24345 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24350 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24351 Return 1 if FONT has a glyph for C, otherwise return 0. */
24354 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24358 if (CHAR_BYTE8_P (c
))
24359 code
= CHAR_TO_BYTE8 (c
);
24361 code
= font
->driver
->encode_char (font
, c
);
24363 if (code
== FONT_INVALID_CODE
)
24365 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24370 /* Fill glyph string S with composition components specified by S->cmp.
24372 BASE_FACE is the base face of the composition.
24373 S->cmp_from is the index of the first component for S.
24375 OVERLAPS non-zero means S should draw the foreground only, and use
24376 its physical height for clipping. See also draw_glyphs.
24378 Value is the index of a component not in S. */
24381 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24385 /* For all glyphs of this composition, starting at the offset
24386 S->cmp_from, until we reach the end of the definition or encounter a
24387 glyph that requires the different face, add it to S. */
24392 s
->for_overlaps
= overlaps
;
24395 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24397 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24399 /* TAB in a composition means display glyphs with padding space
24400 on the left or right. */
24403 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24406 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24413 s
->font
= s
->face
->font
;
24415 else if (s
->face
!= face
)
24423 if (s
->face
== NULL
)
24425 s
->face
= base_face
->ascii_face
;
24426 s
->font
= s
->face
->font
;
24429 /* All glyph strings for the same composition has the same width,
24430 i.e. the width set for the first component of the composition. */
24431 s
->width
= s
->first_glyph
->pixel_width
;
24433 /* If the specified font could not be loaded, use the frame's
24434 default font, but record the fact that we couldn't load it in
24435 the glyph string so that we can draw rectangles for the
24436 characters of the glyph string. */
24437 if (s
->font
== NULL
)
24439 s
->font_not_found_p
= 1;
24440 s
->font
= FRAME_FONT (s
->f
);
24443 /* Adjust base line for subscript/superscript text. */
24444 s
->ybase
+= s
->first_glyph
->voffset
;
24446 /* This glyph string must always be drawn with 16-bit functions. */
24453 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24454 int start
, int end
, int overlaps
)
24456 struct glyph
*glyph
, *last
;
24457 Lisp_Object lgstring
;
24460 s
->for_overlaps
= overlaps
;
24461 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24462 last
= s
->row
->glyphs
[s
->area
] + end
;
24463 s
->cmp_id
= glyph
->u
.cmp
.id
;
24464 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24465 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24466 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24467 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24468 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24470 while (glyph
< last
24471 && glyph
->u
.cmp
.automatic
24472 && glyph
->u
.cmp
.id
== s
->cmp_id
24473 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24474 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24476 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24478 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24479 unsigned code
= LGLYPH_CODE (lglyph
);
24481 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24483 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24484 return glyph
- s
->row
->glyphs
[s
->area
];
24488 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24489 See the comment of fill_glyph_string for arguments.
24490 Value is the index of the first glyph not in S. */
24494 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24495 int start
, int end
, int overlaps
)
24497 struct glyph
*glyph
, *last
;
24500 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24501 s
->for_overlaps
= overlaps
;
24502 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24503 last
= s
->row
->glyphs
[s
->area
] + end
;
24504 voffset
= glyph
->voffset
;
24505 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24506 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24508 s
->width
= glyph
->pixel_width
;
24510 while (glyph
< last
24511 && glyph
->type
== GLYPHLESS_GLYPH
24512 && glyph
->voffset
== voffset
24513 && glyph
->face_id
== face_id
)
24516 s
->width
+= glyph
->pixel_width
;
24519 s
->ybase
+= voffset
;
24520 return glyph
- s
->row
->glyphs
[s
->area
];
24524 /* Fill glyph string S from a sequence of character glyphs.
24526 FACE_ID is the face id of the string. START is the index of the
24527 first glyph to consider, END is the index of the last + 1.
24528 OVERLAPS non-zero means S should draw the foreground only, and use
24529 its physical height for clipping. See also draw_glyphs.
24531 Value is the index of the first glyph not in S. */
24534 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24535 int start
, int end
, int overlaps
)
24537 struct glyph
*glyph
, *last
;
24539 int glyph_not_available_p
;
24541 eassert (s
->f
== XFRAME (s
->w
->frame
));
24542 eassert (s
->nchars
== 0);
24543 eassert (start
>= 0 && end
> start
);
24545 s
->for_overlaps
= overlaps
;
24546 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24547 last
= s
->row
->glyphs
[s
->area
] + end
;
24548 voffset
= glyph
->voffset
;
24549 s
->padding_p
= glyph
->padding_p
;
24550 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24552 while (glyph
< last
24553 && glyph
->type
== CHAR_GLYPH
24554 && glyph
->voffset
== voffset
24555 /* Same face id implies same font, nowadays. */
24556 && glyph
->face_id
== face_id
24557 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24561 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24562 s
->char2b
+ s
->nchars
,
24564 s
->two_byte_p
= two_byte_p
;
24566 eassert (s
->nchars
<= end
- start
);
24567 s
->width
+= glyph
->pixel_width
;
24568 if (glyph
++->padding_p
!= s
->padding_p
)
24572 s
->font
= s
->face
->font
;
24574 /* If the specified font could not be loaded, use the frame's font,
24575 but record the fact that we couldn't load it in
24576 S->font_not_found_p so that we can draw rectangles for the
24577 characters of the glyph string. */
24578 if (s
->font
== NULL
|| glyph_not_available_p
)
24580 s
->font_not_found_p
= 1;
24581 s
->font
= FRAME_FONT (s
->f
);
24584 /* Adjust base line for subscript/superscript text. */
24585 s
->ybase
+= voffset
;
24587 eassert (s
->face
&& s
->face
->gc
);
24588 return glyph
- s
->row
->glyphs
[s
->area
];
24592 /* Fill glyph string S from image glyph S->first_glyph. */
24595 fill_image_glyph_string (struct glyph_string
*s
)
24597 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24598 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24600 s
->slice
= s
->first_glyph
->slice
.img
;
24601 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24602 s
->font
= s
->face
->font
;
24603 s
->width
= s
->first_glyph
->pixel_width
;
24605 /* Adjust base line for subscript/superscript text. */
24606 s
->ybase
+= s
->first_glyph
->voffset
;
24610 #ifdef HAVE_XWIDGETS
24612 fill_xwidget_glyph_string (struct glyph_string
*s
)
24614 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24615 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24616 s
->font
= s
->face
->font
;
24617 s
->width
= s
->first_glyph
->pixel_width
;
24618 s
->ybase
+= s
->first_glyph
->voffset
;
24619 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24622 /* Fill glyph string S from a sequence of stretch glyphs.
24624 START is the index of the first glyph to consider,
24625 END is the index of the last + 1.
24627 Value is the index of the first glyph not in S. */
24630 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24632 struct glyph
*glyph
, *last
;
24633 int voffset
, face_id
;
24635 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24637 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24638 last
= s
->row
->glyphs
[s
->area
] + end
;
24639 face_id
= glyph
->face_id
;
24640 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24641 s
->font
= s
->face
->font
;
24642 s
->width
= glyph
->pixel_width
;
24644 voffset
= glyph
->voffset
;
24648 && glyph
->type
== STRETCH_GLYPH
24649 && glyph
->voffset
== voffset
24650 && glyph
->face_id
== face_id
);
24652 s
->width
+= glyph
->pixel_width
;
24654 /* Adjust base line for subscript/superscript text. */
24655 s
->ybase
+= voffset
;
24657 /* The case that face->gc == 0 is handled when drawing the glyph
24658 string by calling prepare_face_for_display. */
24660 return glyph
- s
->row
->glyphs
[s
->area
];
24663 static struct font_metrics
*
24664 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24666 static struct font_metrics metrics
;
24671 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24672 if (code
== FONT_INVALID_CODE
)
24674 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24679 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24680 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24681 assumed to be zero. */
24684 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24686 *left
= *right
= 0;
24688 if (glyph
->type
== CHAR_GLYPH
)
24692 struct font_metrics
*pcm
;
24694 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24695 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24697 if (pcm
->rbearing
> pcm
->width
)
24698 *right
= pcm
->rbearing
- pcm
->width
;
24699 if (pcm
->lbearing
< 0)
24700 *left
= -pcm
->lbearing
;
24703 else if (glyph
->type
== COMPOSITE_GLYPH
)
24705 if (! glyph
->u
.cmp
.automatic
)
24707 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24709 if (cmp
->rbearing
> cmp
->pixel_width
)
24710 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24711 if (cmp
->lbearing
< 0)
24712 *left
= - cmp
->lbearing
;
24716 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24717 struct font_metrics metrics
;
24719 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24720 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24721 if (metrics
.rbearing
> metrics
.width
)
24722 *right
= metrics
.rbearing
- metrics
.width
;
24723 if (metrics
.lbearing
< 0)
24724 *left
= - metrics
.lbearing
;
24730 /* Return the index of the first glyph preceding glyph string S that
24731 is overwritten by S because of S's left overhang. Value is -1
24732 if no glyphs are overwritten. */
24735 left_overwritten (struct glyph_string
*s
)
24739 if (s
->left_overhang
)
24742 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24743 int first
= s
->first_glyph
- glyphs
;
24745 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24746 x
-= glyphs
[i
].pixel_width
;
24757 /* Return the index of the first glyph preceding glyph string S that
24758 is overwriting S because of its right overhang. Value is -1 if no
24759 glyph in front of S overwrites S. */
24762 left_overwriting (struct glyph_string
*s
)
24765 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24766 int first
= s
->first_glyph
- glyphs
;
24770 for (i
= first
- 1; i
>= 0; --i
)
24773 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24776 x
-= glyphs
[i
].pixel_width
;
24783 /* Return the index of the last glyph following glyph string S that is
24784 overwritten by S because of S's right overhang. Value is -1 if
24785 no such glyph is found. */
24788 right_overwritten (struct glyph_string
*s
)
24792 if (s
->right_overhang
)
24795 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24796 int first
= (s
->first_glyph
- glyphs
24797 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24798 int end
= s
->row
->used
[s
->area
];
24800 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24801 x
+= glyphs
[i
].pixel_width
;
24810 /* Return the index of the last glyph following glyph string S that
24811 overwrites S because of its left overhang. Value is negative
24812 if no such glyph is found. */
24815 right_overwriting (struct glyph_string
*s
)
24818 int end
= s
->row
->used
[s
->area
];
24819 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24820 int first
= (s
->first_glyph
- glyphs
24821 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24825 for (i
= first
; i
< end
; ++i
)
24828 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24831 x
+= glyphs
[i
].pixel_width
;
24838 /* Set background width of glyph string S. START is the index of the
24839 first glyph following S. LAST_X is the right-most x-position + 1
24840 in the drawing area. */
24843 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24845 /* If the face of this glyph string has to be drawn to the end of
24846 the drawing area, set S->extends_to_end_of_line_p. */
24848 if (start
== s
->row
->used
[s
->area
]
24849 && ((s
->row
->fill_line_p
24850 && (s
->hl
== DRAW_NORMAL_TEXT
24851 || s
->hl
== DRAW_IMAGE_RAISED
24852 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24853 || s
->hl
== DRAW_MOUSE_FACE
))
24854 s
->extends_to_end_of_line_p
= 1;
24856 /* If S extends its face to the end of the line, set its
24857 background_width to the distance to the right edge of the drawing
24859 if (s
->extends_to_end_of_line_p
)
24860 s
->background_width
= last_x
- s
->x
+ 1;
24862 s
->background_width
= s
->width
;
24866 /* Compute overhangs and x-positions for glyph string S and its
24867 predecessors, or successors. X is the starting x-position for S.
24868 BACKWARD_P non-zero means process predecessors. */
24871 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24877 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24878 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24888 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24889 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24899 /* The following macros are only called from draw_glyphs below.
24900 They reference the following parameters of that function directly:
24901 `w', `row', `area', and `overlap_p'
24902 as well as the following local variables:
24903 `s', `f', and `hdc' (in W32) */
24906 /* On W32, silently add local `hdc' variable to argument list of
24907 init_glyph_string. */
24908 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24909 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24911 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24912 init_glyph_string (s, char2b, w, row, area, start, hl)
24915 /* Add a glyph string for a stretch glyph to the list of strings
24916 between HEAD and TAIL. START is the index of the stretch glyph in
24917 row area AREA of glyph row ROW. END is the index of the last glyph
24918 in that glyph row area. X is the current output position assigned
24919 to the new glyph string constructed. HL overrides that face of the
24920 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24921 is the right-most x-position of the drawing area. */
24923 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24924 and below -- keep them on one line. */
24925 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24928 s = alloca (sizeof *s); \
24929 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24930 START = fill_stretch_glyph_string (s, START, END); \
24931 append_glyph_string (&HEAD, &TAIL, s); \
24937 /* Add a glyph string for an image glyph to the list of strings
24938 between HEAD and TAIL. START is the index of the image glyph in
24939 row area AREA of glyph row ROW. END is the index of the last glyph
24940 in that glyph row area. X is the current output position assigned
24941 to the new glyph string constructed. HL overrides that face of the
24942 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24943 is the right-most x-position of the drawing area. */
24945 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24948 s = alloca (sizeof *s); \
24949 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24950 fill_image_glyph_string (s); \
24951 append_glyph_string (&HEAD, &TAIL, s); \
24957 #ifdef HAVE_XWIDGETS
24958 #define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24961 s = (struct glyph_string *) alloca (sizeof *s); \
24962 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24963 fill_xwidget_glyph_string (s); \
24964 append_glyph_string (&HEAD, &TAIL, s); \
24972 /* Add a glyph string for a sequence of character glyphs to the list
24973 of strings between HEAD and TAIL. START is the index of the first
24974 glyph in row area AREA of glyph row ROW that is part of the new
24975 glyph string. END is the index of the last glyph in that glyph row
24976 area. X is the current output position assigned to the new glyph
24977 string constructed. HL overrides that face of the glyph; e.g. it
24978 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24979 right-most x-position of the drawing area. */
24981 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24987 face_id = (row)->glyphs[area][START].face_id; \
24989 s = alloca (sizeof *s); \
24990 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
24991 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24992 append_glyph_string (&HEAD, &TAIL, s); \
24994 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24999 /* Add a glyph string for a composite sequence to the list of strings
25000 between HEAD and TAIL. START is the index of the first glyph in
25001 row area AREA of glyph row ROW that is part of the new glyph
25002 string. END is the index of the last glyph in that glyph row area.
25003 X is the current output position assigned to the new glyph string
25004 constructed. HL overrides that face of the glyph; e.g. it is
25005 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25006 x-position of the drawing area. */
25008 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25010 int face_id = (row)->glyphs[area][START].face_id; \
25011 struct face *base_face = FACE_FROM_ID (f, face_id); \
25012 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25013 struct composition *cmp = composition_table[cmp_id]; \
25015 struct glyph_string *first_s = NULL; \
25018 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25020 /* Make glyph_strings for each glyph sequence that is drawable by \
25021 the same face, and append them to HEAD/TAIL. */ \
25022 for (n = 0; n < cmp->glyph_len;) \
25024 s = alloca (sizeof *s); \
25025 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25026 append_glyph_string (&(HEAD), &(TAIL), s); \
25032 n = fill_composite_glyph_string (s, base_face, overlaps); \
25040 /* Add a glyph string for a glyph-string sequence to the list of strings
25041 between HEAD and TAIL. */
25043 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25047 Lisp_Object gstring; \
25049 face_id = (row)->glyphs[area][START].face_id; \
25050 gstring = (composition_gstring_from_id \
25051 ((row)->glyphs[area][START].u.cmp.id)); \
25052 s = alloca (sizeof *s); \
25053 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25054 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25055 append_glyph_string (&(HEAD), &(TAIL), s); \
25057 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25061 /* Add a glyph string for a sequence of glyphless character's glyphs
25062 to the list of strings between HEAD and TAIL. The meanings of
25063 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25065 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25070 face_id = (row)->glyphs[area][START].face_id; \
25072 s = alloca (sizeof *s); \
25073 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25074 append_glyph_string (&HEAD, &TAIL, s); \
25076 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25082 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25083 of AREA of glyph row ROW on window W between indices START and END.
25084 HL overrides the face for drawing glyph strings, e.g. it is
25085 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25086 x-positions of the drawing area.
25088 This is an ugly monster macro construct because we must use alloca
25089 to allocate glyph strings (because draw_glyphs can be called
25090 asynchronously). */
25092 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25095 HEAD = TAIL = NULL; \
25096 while (START < END) \
25098 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25099 switch (first_glyph->type) \
25102 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25106 case COMPOSITE_GLYPH: \
25107 if (first_glyph->u.cmp.automatic) \
25108 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25111 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25115 case STRETCH_GLYPH: \
25116 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25120 case IMAGE_GLYPH: \
25121 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25125 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25126 case XWIDGET_GLYPH: \
25127 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25131 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25132 case GLYPHLESS_GLYPH: \
25133 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25143 set_glyph_string_background_width (s, START, LAST_X); \
25150 #ifdef HAVE_XWIDGETS
25151 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25152 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25153 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25154 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25156 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25157 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25158 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25162 /* Draw glyphs between START and END in AREA of ROW on window W,
25163 starting at x-position X. X is relative to AREA in W. HL is a
25164 face-override with the following meaning:
25166 DRAW_NORMAL_TEXT draw normally
25167 DRAW_CURSOR draw in cursor face
25168 DRAW_MOUSE_FACE draw in mouse face.
25169 DRAW_INVERSE_VIDEO draw in mode line face
25170 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25171 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25173 If OVERLAPS is non-zero, draw only the foreground of characters and
25174 clip to the physical height of ROW. Non-zero value also defines
25175 the overlapping part to be drawn:
25177 OVERLAPS_PRED overlap with preceding rows
25178 OVERLAPS_SUCC overlap with succeeding rows
25179 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25180 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25182 Value is the x-position reached, relative to AREA of W. */
25185 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25186 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25187 enum draw_glyphs_face hl
, int overlaps
)
25189 struct glyph_string
*head
, *tail
;
25190 struct glyph_string
*s
;
25191 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25192 int i
, j
, x_reached
, last_x
, area_left
= 0;
25193 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25196 ALLOCATE_HDC (hdc
, f
);
25198 /* Let's rather be paranoid than getting a SEGV. */
25199 end
= min (end
, row
->used
[area
]);
25200 start
= clip_to_bounds (0, start
, end
);
25202 /* Translate X to frame coordinates. Set last_x to the right
25203 end of the drawing area. */
25204 if (row
->full_width_p
)
25206 /* X is relative to the left edge of W, without scroll bars
25208 area_left
= WINDOW_LEFT_EDGE_X (w
);
25209 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25210 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25214 area_left
= window_box_left (w
, area
);
25215 last_x
= area_left
+ window_box_width (w
, area
);
25219 /* Build a doubly-linked list of glyph_string structures between
25220 head and tail from what we have to draw. Note that the macro
25221 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25222 the reason we use a separate variable `i'. */
25225 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25227 x_reached
= tail
->x
+ tail
->background_width
;
25231 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25232 the row, redraw some glyphs in front or following the glyph
25233 strings built above. */
25234 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25236 struct glyph_string
*h
, *t
;
25237 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25238 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25239 int check_mouse_face
= 0;
25242 /* If mouse highlighting is on, we may need to draw adjacent
25243 glyphs using mouse-face highlighting. */
25244 if (area
== TEXT_AREA
&& row
->mouse_face_p
25245 && hlinfo
->mouse_face_beg_row
>= 0
25246 && hlinfo
->mouse_face_end_row
>= 0)
25248 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25250 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25251 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25253 check_mouse_face
= 1;
25254 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25255 ? hlinfo
->mouse_face_beg_col
: 0;
25256 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25257 ? hlinfo
->mouse_face_end_col
25258 : row
->used
[TEXT_AREA
];
25262 /* Compute overhangs for all glyph strings. */
25263 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25264 for (s
= head
; s
; s
= s
->next
)
25265 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25267 /* Prepend glyph strings for glyphs in front of the first glyph
25268 string that are overwritten because of the first glyph
25269 string's left overhang. The background of all strings
25270 prepended must be drawn because the first glyph string
25272 i
= left_overwritten (head
);
25275 enum draw_glyphs_face overlap_hl
;
25277 /* If this row contains mouse highlighting, attempt to draw
25278 the overlapped glyphs with the correct highlight. This
25279 code fails if the overlap encompasses more than one glyph
25280 and mouse-highlight spans only some of these glyphs.
25281 However, making it work perfectly involves a lot more
25282 code, and I don't know if the pathological case occurs in
25283 practice, so we'll stick to this for now. --- cyd */
25284 if (check_mouse_face
25285 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25286 overlap_hl
= DRAW_MOUSE_FACE
;
25288 overlap_hl
= DRAW_NORMAL_TEXT
;
25290 if (hl
!= overlap_hl
)
25293 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25294 overlap_hl
, dummy_x
, last_x
);
25296 compute_overhangs_and_x (t
, head
->x
, 1);
25297 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25298 if (clip_head
== NULL
)
25302 /* Prepend glyph strings for glyphs in front of the first glyph
25303 string that overwrite that glyph string because of their
25304 right overhang. For these strings, only the foreground must
25305 be drawn, because it draws over the glyph string at `head'.
25306 The background must not be drawn because this would overwrite
25307 right overhangs of preceding glyphs for which no glyph
25309 i
= left_overwriting (head
);
25312 enum draw_glyphs_face overlap_hl
;
25314 if (check_mouse_face
25315 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25316 overlap_hl
= DRAW_MOUSE_FACE
;
25318 overlap_hl
= DRAW_NORMAL_TEXT
;
25320 if (hl
== overlap_hl
|| clip_head
== NULL
)
25322 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25323 overlap_hl
, dummy_x
, last_x
);
25324 for (s
= h
; s
; s
= s
->next
)
25325 s
->background_filled_p
= 1;
25326 compute_overhangs_and_x (t
, head
->x
, 1);
25327 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25330 /* Append glyphs strings for glyphs following the last glyph
25331 string tail that are overwritten by tail. The background of
25332 these strings has to be drawn because tail's foreground draws
25334 i
= right_overwritten (tail
);
25337 enum draw_glyphs_face overlap_hl
;
25339 if (check_mouse_face
25340 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25341 overlap_hl
= DRAW_MOUSE_FACE
;
25343 overlap_hl
= DRAW_NORMAL_TEXT
;
25345 if (hl
!= overlap_hl
)
25347 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25348 overlap_hl
, x
, last_x
);
25349 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25350 we don't have `end = i;' here. */
25351 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25352 append_glyph_string_lists (&head
, &tail
, h
, t
);
25353 if (clip_tail
== NULL
)
25357 /* Append glyph strings for glyphs following the last glyph
25358 string tail that overwrite tail. The foreground of such
25359 glyphs has to be drawn because it writes into the background
25360 of tail. The background must not be drawn because it could
25361 paint over the foreground of following glyphs. */
25362 i
= right_overwriting (tail
);
25365 enum draw_glyphs_face overlap_hl
;
25366 if (check_mouse_face
25367 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25368 overlap_hl
= DRAW_MOUSE_FACE
;
25370 overlap_hl
= DRAW_NORMAL_TEXT
;
25372 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25374 i
++; /* We must include the Ith glyph. */
25375 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25376 overlap_hl
, x
, last_x
);
25377 for (s
= h
; s
; s
= s
->next
)
25378 s
->background_filled_p
= 1;
25379 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25380 append_glyph_string_lists (&head
, &tail
, h
, t
);
25382 if (clip_head
|| clip_tail
)
25383 for (s
= head
; s
; s
= s
->next
)
25385 s
->clip_head
= clip_head
;
25386 s
->clip_tail
= clip_tail
;
25390 /* Draw all strings. */
25391 for (s
= head
; s
; s
= s
->next
)
25392 FRAME_RIF (f
)->draw_glyph_string (s
);
25395 /* When focus a sole frame and move horizontally, this sets on_p to 0
25396 causing a failure to erase prev cursor position. */
25397 if (area
== TEXT_AREA
25398 && !row
->full_width_p
25399 /* When drawing overlapping rows, only the glyph strings'
25400 foreground is drawn, which doesn't erase a cursor
25404 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25405 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25406 : (tail
? tail
->x
+ tail
->background_width
: x
));
25410 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25411 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25415 /* Value is the x-position up to which drawn, relative to AREA of W.
25416 This doesn't include parts drawn because of overhangs. */
25417 if (row
->full_width_p
)
25418 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25420 x_reached
-= area_left
;
25422 RELEASE_HDC (hdc
, f
);
25428 /* Expand row matrix if too narrow. Don't expand if area
25431 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25433 if (!it->f->fonts_changed \
25434 && (it->glyph_row->glyphs[area] \
25435 < it->glyph_row->glyphs[area + 1])) \
25437 it->w->ncols_scale_factor++; \
25438 it->f->fonts_changed = 1; \
25442 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25443 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25446 append_glyph (struct it
*it
)
25448 struct glyph
*glyph
;
25449 enum glyph_row_area area
= it
->area
;
25451 eassert (it
->glyph_row
);
25452 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25454 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25455 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25457 /* If the glyph row is reversed, we need to prepend the glyph
25458 rather than append it. */
25459 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25463 /* Make room for the additional glyph. */
25464 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25466 glyph
= it
->glyph_row
->glyphs
[area
];
25468 glyph
->charpos
= CHARPOS (it
->position
);
25469 glyph
->object
= it
->object
;
25470 if (it
->pixel_width
> 0)
25472 glyph
->pixel_width
= it
->pixel_width
;
25473 glyph
->padding_p
= 0;
25477 /* Assure at least 1-pixel width. Otherwise, cursor can't
25478 be displayed correctly. */
25479 glyph
->pixel_width
= 1;
25480 glyph
->padding_p
= 1;
25482 glyph
->ascent
= it
->ascent
;
25483 glyph
->descent
= it
->descent
;
25484 glyph
->voffset
= it
->voffset
;
25485 glyph
->type
= CHAR_GLYPH
;
25486 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25487 glyph
->multibyte_p
= it
->multibyte_p
;
25488 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25490 /* In R2L rows, the left and the right box edges need to be
25491 drawn in reverse direction. */
25492 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25493 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25497 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25498 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25500 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25501 || it
->phys_descent
> it
->descent
);
25502 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25503 glyph
->face_id
= it
->face_id
;
25504 glyph
->u
.ch
= it
->char_to_display
;
25505 glyph
->slice
.img
= null_glyph_slice
;
25506 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25509 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25510 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25511 glyph
->bidi_type
= it
->bidi_it
.type
;
25515 glyph
->resolved_level
= 0;
25516 glyph
->bidi_type
= UNKNOWN_BT
;
25518 ++it
->glyph_row
->used
[area
];
25521 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25524 /* Store one glyph for the composition IT->cmp_it.id in
25525 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25529 append_composite_glyph (struct it
*it
)
25531 struct glyph
*glyph
;
25532 enum glyph_row_area area
= it
->area
;
25534 eassert (it
->glyph_row
);
25536 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25537 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25539 /* If the glyph row is reversed, we need to prepend the glyph
25540 rather than append it. */
25541 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25545 /* Make room for the new glyph. */
25546 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25548 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25550 glyph
->charpos
= it
->cmp_it
.charpos
;
25551 glyph
->object
= it
->object
;
25552 glyph
->pixel_width
= it
->pixel_width
;
25553 glyph
->ascent
= it
->ascent
;
25554 glyph
->descent
= it
->descent
;
25555 glyph
->voffset
= it
->voffset
;
25556 glyph
->type
= COMPOSITE_GLYPH
;
25557 if (it
->cmp_it
.ch
< 0)
25559 glyph
->u
.cmp
.automatic
= 0;
25560 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25561 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25565 glyph
->u
.cmp
.automatic
= 1;
25566 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25567 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25568 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25570 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25571 glyph
->multibyte_p
= it
->multibyte_p
;
25572 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25574 /* In R2L rows, the left and the right box edges need to be
25575 drawn in reverse direction. */
25576 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25577 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25581 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25582 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25584 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25585 || it
->phys_descent
> it
->descent
);
25586 glyph
->padding_p
= 0;
25587 glyph
->glyph_not_available_p
= 0;
25588 glyph
->face_id
= it
->face_id
;
25589 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25592 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25593 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25594 glyph
->bidi_type
= it
->bidi_it
.type
;
25596 ++it
->glyph_row
->used
[area
];
25599 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25603 /* Change IT->ascent and IT->height according to the setting of
25607 take_vertical_position_into_account (struct it
*it
)
25611 if (it
->voffset
< 0)
25612 /* Increase the ascent so that we can display the text higher
25614 it
->ascent
-= it
->voffset
;
25616 /* Increase the descent so that we can display the text lower
25618 it
->descent
+= it
->voffset
;
25623 /* Produce glyphs/get display metrics for the image IT is loaded with.
25624 See the description of struct display_iterator in dispextern.h for
25625 an overview of struct display_iterator. */
25628 produce_image_glyph (struct it
*it
)
25632 int glyph_ascent
, crop
;
25633 struct glyph_slice slice
;
25635 eassert (it
->what
== IT_IMAGE
);
25637 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25639 /* Make sure X resources of the face is loaded. */
25640 prepare_face_for_display (it
->f
, face
);
25642 if (it
->image_id
< 0)
25644 /* Fringe bitmap. */
25645 it
->ascent
= it
->phys_ascent
= 0;
25646 it
->descent
= it
->phys_descent
= 0;
25647 it
->pixel_width
= 0;
25652 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25654 /* Make sure X resources of the image is loaded. */
25655 prepare_image_for_display (it
->f
, img
);
25657 slice
.x
= slice
.y
= 0;
25658 slice
.width
= img
->width
;
25659 slice
.height
= img
->height
;
25661 if (INTEGERP (it
->slice
.x
))
25662 slice
.x
= XINT (it
->slice
.x
);
25663 else if (FLOATP (it
->slice
.x
))
25664 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25666 if (INTEGERP (it
->slice
.y
))
25667 slice
.y
= XINT (it
->slice
.y
);
25668 else if (FLOATP (it
->slice
.y
))
25669 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25671 if (INTEGERP (it
->slice
.width
))
25672 slice
.width
= XINT (it
->slice
.width
);
25673 else if (FLOATP (it
->slice
.width
))
25674 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25676 if (INTEGERP (it
->slice
.height
))
25677 slice
.height
= XINT (it
->slice
.height
);
25678 else if (FLOATP (it
->slice
.height
))
25679 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25681 if (slice
.x
>= img
->width
)
25682 slice
.x
= img
->width
;
25683 if (slice
.y
>= img
->height
)
25684 slice
.y
= img
->height
;
25685 if (slice
.x
+ slice
.width
>= img
->width
)
25686 slice
.width
= img
->width
- slice
.x
;
25687 if (slice
.y
+ slice
.height
> img
->height
)
25688 slice
.height
= img
->height
- slice
.y
;
25690 if (slice
.width
== 0 || slice
.height
== 0)
25693 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25695 it
->descent
= slice
.height
- glyph_ascent
;
25697 it
->descent
+= img
->vmargin
;
25698 if (slice
.y
+ slice
.height
== img
->height
)
25699 it
->descent
+= img
->vmargin
;
25700 it
->phys_descent
= it
->descent
;
25702 it
->pixel_width
= slice
.width
;
25704 it
->pixel_width
+= img
->hmargin
;
25705 if (slice
.x
+ slice
.width
== img
->width
)
25706 it
->pixel_width
+= img
->hmargin
;
25708 /* It's quite possible for images to have an ascent greater than
25709 their height, so don't get confused in that case. */
25710 if (it
->descent
< 0)
25715 if (face
->box
!= FACE_NO_BOX
)
25717 if (face
->box_line_width
> 0)
25720 it
->ascent
+= face
->box_line_width
;
25721 if (slice
.y
+ slice
.height
== img
->height
)
25722 it
->descent
+= face
->box_line_width
;
25725 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25726 it
->pixel_width
+= eabs (face
->box_line_width
);
25727 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25728 it
->pixel_width
+= eabs (face
->box_line_width
);
25731 take_vertical_position_into_account (it
);
25733 /* Automatically crop wide image glyphs at right edge so we can
25734 draw the cursor on same display row. */
25735 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25736 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25738 it
->pixel_width
-= crop
;
25739 slice
.width
-= crop
;
25744 struct glyph
*glyph
;
25745 enum glyph_row_area area
= it
->area
;
25747 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25748 if (it
->glyph_row
->reversed_p
)
25752 /* Make room for the new glyph. */
25753 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25755 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25757 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25759 glyph
->charpos
= CHARPOS (it
->position
);
25760 glyph
->object
= it
->object
;
25761 glyph
->pixel_width
= it
->pixel_width
;
25762 glyph
->ascent
= glyph_ascent
;
25763 glyph
->descent
= it
->descent
;
25764 glyph
->voffset
= it
->voffset
;
25765 glyph
->type
= IMAGE_GLYPH
;
25766 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25767 glyph
->multibyte_p
= it
->multibyte_p
;
25768 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25770 /* In R2L rows, the left and the right box edges need to be
25771 drawn in reverse direction. */
25772 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25773 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25777 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25778 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25780 glyph
->overlaps_vertically_p
= 0;
25781 glyph
->padding_p
= 0;
25782 glyph
->glyph_not_available_p
= 0;
25783 glyph
->face_id
= it
->face_id
;
25784 glyph
->u
.img_id
= img
->id
;
25785 glyph
->slice
.img
= slice
;
25786 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25789 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25790 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25791 glyph
->bidi_type
= it
->bidi_it
.type
;
25793 ++it
->glyph_row
->used
[area
];
25796 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25800 #ifdef HAVE_XWIDGETS
25802 produce_xwidget_glyph (struct it
*it
)
25804 struct xwidget
* xw
;
25806 int glyph_ascent
, crop
;
25807 eassert (it
->what
== IT_XWIDGET
);
25809 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25811 /* Make sure X resources of the face is loaded. */
25812 prepare_face_for_display (it
->f
, face
);
25815 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
25816 it
->descent
= xw
->height
/2;
25817 it
->phys_descent
= it
->descent
;
25818 it
->pixel_width
= xw
->width
;
25819 /* It's quite possible for images to have an ascent greater than
25820 their height, so don't get confused in that case. */
25821 if (it
->descent
< 0)
25826 if (face
->box
!= FACE_NO_BOX
)
25828 if (face
->box_line_width
> 0)
25830 it
->ascent
+= face
->box_line_width
;
25831 it
->descent
+= face
->box_line_width
;
25834 if (it
->start_of_box_run_p
)
25835 it
->pixel_width
+= eabs (face
->box_line_width
);
25836 it
->pixel_width
+= eabs (face
->box_line_width
);
25839 take_vertical_position_into_account (it
);
25841 /* Automatically crop wide image glyphs at right edge so we can
25842 draw the cursor on same display row. */
25843 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25844 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25846 it
->pixel_width
-= crop
;
25851 struct glyph
*glyph
;
25852 enum glyph_row_area area
= it
->area
;
25854 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25855 if (it
->glyph_row
->reversed_p
)
25859 /* Make room for the new glyph. */
25860 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25862 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25864 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25866 glyph
->charpos
= CHARPOS (it
->position
);
25867 glyph
->object
= it
->object
;
25868 glyph
->pixel_width
= it
->pixel_width
;
25869 glyph
->ascent
= glyph_ascent
;
25870 glyph
->descent
= it
->descent
;
25871 glyph
->voffset
= it
->voffset
;
25872 glyph
->type
= XWIDGET_GLYPH
;
25873 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25874 glyph
->multibyte_p
= it
->multibyte_p
;
25875 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25877 /* In R2L rows, the left and the right box edges need to be
25878 drawn in reverse direction. */
25879 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25880 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25884 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25885 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25887 glyph
->overlaps_vertically_p
= 0;
25888 glyph
->padding_p
= 0;
25889 glyph
->glyph_not_available_p
= 0;
25890 glyph
->face_id
= it
->face_id
;
25891 glyph
->u
.xwidget
= it
->xwidget
;
25892 //assert_valid_xwidget_id(glyph->u.xwidget_id,"produce_xwidget_glyph");
25893 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25896 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25897 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25898 glyph
->bidi_type
= it
->bidi_it
.type
;
25900 ++it
->glyph_row
->used
[area
];
25903 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25908 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25909 of the glyph, WIDTH and HEIGHT are the width and height of the
25910 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25913 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25914 int width
, int height
, int ascent
)
25916 struct glyph
*glyph
;
25917 enum glyph_row_area area
= it
->area
;
25919 eassert (ascent
>= 0 && ascent
<= height
);
25921 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25922 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25924 /* If the glyph row is reversed, we need to prepend the glyph
25925 rather than append it. */
25926 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25930 /* Make room for the additional glyph. */
25931 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25933 glyph
= it
->glyph_row
->glyphs
[area
];
25935 /* Decrease the width of the first glyph of the row that
25936 begins before first_visible_x (e.g., due to hscroll).
25937 This is so the overall width of the row becomes smaller
25938 by the scroll amount, and the stretch glyph appended by
25939 extend_face_to_end_of_line will be wider, to shift the
25940 row glyphs to the right. (In L2R rows, the corresponding
25941 left-shift effect is accomplished by setting row->x to a
25942 negative value, which won't work with R2L rows.)
25944 This must leave us with a positive value of WIDTH, since
25945 otherwise the call to move_it_in_display_line_to at the
25946 beginning of display_line would have got past the entire
25947 first glyph, and then it->current_x would have been
25948 greater or equal to it->first_visible_x. */
25949 if (it
->current_x
< it
->first_visible_x
)
25950 width
-= it
->first_visible_x
- it
->current_x
;
25951 eassert (width
> 0);
25953 glyph
->charpos
= CHARPOS (it
->position
);
25954 glyph
->object
= object
;
25955 glyph
->pixel_width
= width
;
25956 glyph
->ascent
= ascent
;
25957 glyph
->descent
= height
- ascent
;
25958 glyph
->voffset
= it
->voffset
;
25959 glyph
->type
= STRETCH_GLYPH
;
25960 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25961 glyph
->multibyte_p
= it
->multibyte_p
;
25962 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25964 /* In R2L rows, the left and the right box edges need to be
25965 drawn in reverse direction. */
25966 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25967 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25971 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25972 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25974 glyph
->overlaps_vertically_p
= 0;
25975 glyph
->padding_p
= 0;
25976 glyph
->glyph_not_available_p
= 0;
25977 glyph
->face_id
= it
->face_id
;
25978 glyph
->u
.stretch
.ascent
= ascent
;
25979 glyph
->u
.stretch
.height
= height
;
25980 glyph
->slice
.img
= null_glyph_slice
;
25981 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25984 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25985 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25986 glyph
->bidi_type
= it
->bidi_it
.type
;
25990 glyph
->resolved_level
= 0;
25991 glyph
->bidi_type
= UNKNOWN_BT
;
25993 ++it
->glyph_row
->used
[area
];
25996 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25999 #endif /* HAVE_WINDOW_SYSTEM */
26001 /* Produce a stretch glyph for iterator IT. IT->object is the value
26002 of the glyph property displayed. The value must be a list
26003 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26006 1. `:width WIDTH' specifies that the space should be WIDTH *
26007 canonical char width wide. WIDTH may be an integer or floating
26010 2. `:relative-width FACTOR' specifies that the width of the stretch
26011 should be computed from the width of the first character having the
26012 `glyph' property, and should be FACTOR times that width.
26014 3. `:align-to HPOS' specifies that the space should be wide enough
26015 to reach HPOS, a value in canonical character units.
26017 Exactly one of the above pairs must be present.
26019 4. `:height HEIGHT' specifies that the height of the stretch produced
26020 should be HEIGHT, measured in canonical character units.
26022 5. `:relative-height FACTOR' specifies that the height of the
26023 stretch should be FACTOR times the height of the characters having
26024 the glyph property.
26026 Either none or exactly one of 4 or 5 must be present.
26028 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26029 of the stretch should be used for the ascent of the stretch.
26030 ASCENT must be in the range 0 <= ASCENT <= 100. */
26033 produce_stretch_glyph (struct it
*it
)
26035 /* (space :width WIDTH :height HEIGHT ...) */
26036 Lisp_Object prop
, plist
;
26037 int width
= 0, height
= 0, align_to
= -1;
26038 int zero_width_ok_p
= 0;
26040 struct font
*font
= NULL
;
26042 #ifdef HAVE_WINDOW_SYSTEM
26044 int zero_height_ok_p
= 0;
26046 if (FRAME_WINDOW_P (it
->f
))
26048 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26049 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26050 prepare_face_for_display (it
->f
, face
);
26054 /* List should start with `space'. */
26055 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26056 plist
= XCDR (it
->object
);
26058 /* Compute the width of the stretch. */
26059 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26060 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
26062 /* Absolute width `:width WIDTH' specified and valid. */
26063 zero_width_ok_p
= 1;
26066 #ifdef HAVE_WINDOW_SYSTEM
26067 else if (FRAME_WINDOW_P (it
->f
)
26068 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
26070 /* Relative width `:relative-width FACTOR' specified and valid.
26071 Compute the width of the characters having the `glyph'
26074 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26077 if (it
->multibyte_p
)
26078 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26081 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26082 if (! ASCII_CHAR_P (it2
.c
))
26083 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26086 it2
.glyph_row
= NULL
;
26087 it2
.what
= IT_CHARACTER
;
26088 x_produce_glyphs (&it2
);
26089 width
= NUMVAL (prop
) * it2
.pixel_width
;
26091 #endif /* HAVE_WINDOW_SYSTEM */
26092 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26093 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
26095 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26096 align_to
= (align_to
< 0
26098 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26099 else if (align_to
< 0)
26100 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26101 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26102 zero_width_ok_p
= 1;
26105 /* Nothing specified -> width defaults to canonical char width. */
26106 width
= FRAME_COLUMN_WIDTH (it
->f
);
26108 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26111 #ifdef HAVE_WINDOW_SYSTEM
26112 /* Compute height. */
26113 if (FRAME_WINDOW_P (it
->f
))
26115 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26116 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
26119 zero_height_ok_p
= 1;
26121 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26123 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
26125 height
= FONT_HEIGHT (font
);
26127 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26130 /* Compute percentage of height used for ascent. If
26131 `:ascent ASCENT' is present and valid, use that. Otherwise,
26132 derive the ascent from the font in use. */
26133 if (prop
= Fplist_get (plist
, QCascent
),
26134 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26135 ascent
= height
* NUMVAL (prop
) / 100.0;
26136 else if (!NILP (prop
)
26137 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
26138 ascent
= min (max (0, (int)tem
), height
);
26140 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26143 #endif /* HAVE_WINDOW_SYSTEM */
26146 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26147 && it
->current_x
+ width
> it
->last_visible_x
)
26149 width
= it
->last_visible_x
- it
->current_x
;
26150 #ifdef HAVE_WINDOW_SYSTEM
26151 /* Subtract one more pixel from the stretch width, but only on
26152 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26153 width
-= FRAME_WINDOW_P (it
->f
);
26157 if (width
> 0 && height
> 0 && it
->glyph_row
)
26159 Lisp_Object o_object
= it
->object
;
26160 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26163 if (!STRINGP (object
))
26164 object
= it
->w
->contents
;
26165 #ifdef HAVE_WINDOW_SYSTEM
26166 if (FRAME_WINDOW_P (it
->f
))
26167 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26171 it
->object
= object
;
26172 it
->char_to_display
= ' ';
26173 it
->pixel_width
= it
->len
= 1;
26175 tty_append_glyph (it
);
26176 it
->object
= o_object
;
26180 it
->pixel_width
= width
;
26181 #ifdef HAVE_WINDOW_SYSTEM
26182 if (FRAME_WINDOW_P (it
->f
))
26184 it
->ascent
= it
->phys_ascent
= ascent
;
26185 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26186 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
26187 take_vertical_position_into_account (it
);
26191 it
->nglyphs
= width
;
26194 /* Get information about special display element WHAT in an
26195 environment described by IT. WHAT is one of IT_TRUNCATION or
26196 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26197 non-null glyph_row member. This function ensures that fields like
26198 face_id, c, len of IT are left untouched. */
26201 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26208 temp_it
.object
= Qnil
;
26209 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26211 if (what
== IT_CONTINUATION
)
26213 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26214 if (it
->bidi_it
.paragraph_dir
== R2L
)
26215 SET_GLYPH_FROM_CHAR (glyph
, '/');
26217 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26219 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26221 /* FIXME: Should we mirror GC for R2L lines? */
26222 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26223 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26226 else if (what
== IT_TRUNCATION
)
26228 /* Truncation glyph. */
26229 SET_GLYPH_FROM_CHAR (glyph
, '$');
26231 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26233 /* FIXME: Should we mirror GC for R2L lines? */
26234 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26235 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26241 #ifdef HAVE_WINDOW_SYSTEM
26242 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26243 is turned off, we precede the truncation/continuation glyphs by a
26244 stretch glyph whose width is computed such that these special
26245 glyphs are aligned at the window margin, even when very different
26246 fonts are used in different glyph rows. */
26247 if (FRAME_WINDOW_P (temp_it
.f
)
26248 /* init_iterator calls this with it->glyph_row == NULL, and it
26249 wants only the pixel width of the truncation/continuation
26251 && temp_it
.glyph_row
26252 /* insert_left_trunc_glyphs calls us at the beginning of the
26253 row, and it has its own calculation of the stretch glyph
26255 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26256 && (temp_it
.glyph_row
->reversed_p
26257 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26258 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26260 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26262 if (stretch_width
> 0)
26264 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26265 struct font
*font
=
26266 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26267 int stretch_ascent
=
26268 (((temp_it
.ascent
+ temp_it
.descent
)
26269 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26271 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26272 temp_it
.ascent
+ temp_it
.descent
,
26279 temp_it
.what
= IT_CHARACTER
;
26280 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26281 temp_it
.face_id
= GLYPH_FACE (glyph
);
26282 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26284 PRODUCE_GLYPHS (&temp_it
);
26285 it
->pixel_width
= temp_it
.pixel_width
;
26286 it
->nglyphs
= temp_it
.nglyphs
;
26289 #ifdef HAVE_WINDOW_SYSTEM
26291 /* Calculate line-height and line-spacing properties.
26292 An integer value specifies explicit pixel value.
26293 A float value specifies relative value to current face height.
26294 A cons (float . face-name) specifies relative value to
26295 height of specified face font.
26297 Returns height in pixels, or nil. */
26301 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26302 int boff
, int override
)
26304 Lisp_Object face_name
= Qnil
;
26305 int ascent
, descent
, height
;
26307 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26312 face_name
= XCAR (val
);
26314 if (!NUMBERP (val
))
26315 val
= make_number (1);
26316 if (NILP (face_name
))
26318 height
= it
->ascent
+ it
->descent
;
26323 if (NILP (face_name
))
26325 font
= FRAME_FONT (it
->f
);
26326 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26328 else if (EQ (face_name
, Qt
))
26337 face_id
= lookup_named_face (it
->f
, face_name
, false);
26339 return make_number (-1);
26341 face
= FACE_FROM_ID (it
->f
, face_id
);
26344 return make_number (-1);
26345 boff
= font
->baseline_offset
;
26346 if (font
->vertical_centering
)
26347 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26350 ascent
= FONT_BASE (font
) + boff
;
26351 descent
= FONT_DESCENT (font
) - boff
;
26355 it
->override_ascent
= ascent
;
26356 it
->override_descent
= descent
;
26357 it
->override_boff
= boff
;
26360 height
= ascent
+ descent
;
26364 height
= (int)(XFLOAT_DATA (val
) * height
);
26365 else if (INTEGERP (val
))
26366 height
*= XINT (val
);
26368 return make_number (height
);
26372 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26373 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
26374 and only if this is for a character for which no font was found.
26376 If the display method (it->glyphless_method) is
26377 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26378 length of the acronym or the hexadecimal string, UPPER_XOFF and
26379 UPPER_YOFF are pixel offsets for the upper part of the string,
26380 LOWER_XOFF and LOWER_YOFF are for the lower part.
26382 For the other display methods, LEN through LOWER_YOFF are zero. */
26385 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
26386 short upper_xoff
, short upper_yoff
,
26387 short lower_xoff
, short lower_yoff
)
26389 struct glyph
*glyph
;
26390 enum glyph_row_area area
= it
->area
;
26392 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26393 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26395 /* If the glyph row is reversed, we need to prepend the glyph
26396 rather than append it. */
26397 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26401 /* Make room for the additional glyph. */
26402 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26404 glyph
= it
->glyph_row
->glyphs
[area
];
26406 glyph
->charpos
= CHARPOS (it
->position
);
26407 glyph
->object
= it
->object
;
26408 glyph
->pixel_width
= it
->pixel_width
;
26409 glyph
->ascent
= it
->ascent
;
26410 glyph
->descent
= it
->descent
;
26411 glyph
->voffset
= it
->voffset
;
26412 glyph
->type
= GLYPHLESS_GLYPH
;
26413 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26414 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26415 glyph
->u
.glyphless
.len
= len
;
26416 glyph
->u
.glyphless
.ch
= it
->c
;
26417 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26418 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26419 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26420 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26421 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26422 glyph
->multibyte_p
= it
->multibyte_p
;
26423 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26425 /* In R2L rows, the left and the right box edges need to be
26426 drawn in reverse direction. */
26427 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26428 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26432 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26433 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26435 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26436 || it
->phys_descent
> it
->descent
);
26437 glyph
->padding_p
= 0;
26438 glyph
->glyph_not_available_p
= 0;
26439 glyph
->face_id
= face_id
;
26440 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26443 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26444 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26445 glyph
->bidi_type
= it
->bidi_it
.type
;
26447 ++it
->glyph_row
->used
[area
];
26450 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26454 /* Produce a glyph for a glyphless character for iterator IT.
26455 IT->glyphless_method specifies which method to use for displaying
26456 the character. See the description of enum
26457 glyphless_display_method in dispextern.h for the detail.
26459 FOR_NO_FONT is nonzero if and only if this is for a character for
26460 which no font was found. ACRONYM, if non-nil, is an acronym string
26461 for the character. */
26464 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
26469 int base_width
, base_height
, width
, height
;
26470 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26473 /* Get the metrics of the base font. We always refer to the current
26475 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26476 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26477 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
26478 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
26479 base_height
= it
->ascent
+ it
->descent
;
26480 base_width
= font
->average_width
;
26482 face_id
= merge_glyphless_glyph_face (it
);
26484 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26486 it
->pixel_width
= THIN_SPACE_WIDTH
;
26488 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26490 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26492 width
= CHAR_WIDTH (it
->c
);
26495 else if (width
> 4)
26497 it
->pixel_width
= base_width
* width
;
26499 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26505 unsigned int code
[6];
26507 int ascent
, descent
;
26508 struct font_metrics metrics_upper
, metrics_lower
;
26510 face
= FACE_FROM_ID (it
->f
, face_id
);
26511 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26512 prepare_face_for_display (it
->f
, face
);
26514 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26516 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26517 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26518 if (CONSP (acronym
))
26519 acronym
= XCAR (acronym
);
26520 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26524 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26525 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26528 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26529 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26530 upper_len
= (len
+ 1) / 2;
26531 font
->driver
->text_extents (font
, code
, upper_len
,
26533 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26538 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26539 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26540 upper_xoff
= upper_yoff
= 2; /* the typical case */
26541 if (base_width
>= width
)
26543 /* Align the upper to the left, the lower to the right. */
26544 it
->pixel_width
= base_width
;
26545 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26549 /* Center the shorter one. */
26550 it
->pixel_width
= width
;
26551 if (metrics_upper
.width
>= metrics_lower
.width
)
26552 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26555 /* FIXME: This code doesn't look right. It formerly was
26556 missing the "lower_xoff = 0;", which couldn't have
26557 been right since it left lower_xoff uninitialized. */
26559 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26563 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26564 top, bottom, and between upper and lower strings. */
26565 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26566 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26567 /* Center vertically.
26568 H:base_height, D:base_descent
26569 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26571 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26572 descent = D - H/2 + h/2;
26573 lower_yoff = descent - 2 - ld;
26574 upper_yoff = lower_yoff - la - 1 - ud; */
26575 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26576 descent
= it
->descent
- (base_height
- height
) / 2;
26577 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26578 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26579 - metrics_upper
.descent
);
26580 /* Don't make the height shorter than the base height. */
26581 if (height
> base_height
)
26583 it
->ascent
= ascent
;
26584 it
->descent
= descent
;
26588 it
->phys_ascent
= it
->ascent
;
26589 it
->phys_descent
= it
->descent
;
26591 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26592 upper_xoff
, upper_yoff
,
26593 lower_xoff
, lower_yoff
);
26595 take_vertical_position_into_account (it
);
26600 Produce glyphs/get display metrics for the display element IT is
26601 loaded with. See the description of struct it in dispextern.h
26602 for an overview of struct it. */
26605 x_produce_glyphs (struct it
*it
)
26607 int extra_line_spacing
= it
->extra_line_spacing
;
26609 it
->glyph_not_available_p
= 0;
26611 if (it
->what
== IT_CHARACTER
)
26614 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26615 struct font
*font
= face
->font
;
26616 struct font_metrics
*pcm
= NULL
;
26617 int boff
; /* Baseline offset. */
26621 /* When no suitable font is found, display this character by
26622 the method specified in the first extra slot of
26623 Vglyphless_char_display. */
26624 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26626 eassert (it
->what
== IT_GLYPHLESS
);
26627 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26631 boff
= font
->baseline_offset
;
26632 if (font
->vertical_centering
)
26633 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26635 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26641 if (it
->override_ascent
>= 0)
26643 it
->ascent
= it
->override_ascent
;
26644 it
->descent
= it
->override_descent
;
26645 boff
= it
->override_boff
;
26649 it
->ascent
= FONT_BASE (font
) + boff
;
26650 it
->descent
= FONT_DESCENT (font
) - boff
;
26653 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26655 pcm
= get_per_char_metric (font
, &char2b
);
26656 if (pcm
->width
== 0
26657 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26663 it
->phys_ascent
= pcm
->ascent
+ boff
;
26664 it
->phys_descent
= pcm
->descent
- boff
;
26665 it
->pixel_width
= pcm
->width
;
26669 it
->glyph_not_available_p
= 1;
26670 it
->phys_ascent
= it
->ascent
;
26671 it
->phys_descent
= it
->descent
;
26672 it
->pixel_width
= font
->space_width
;
26675 if (it
->constrain_row_ascent_descent_p
)
26677 if (it
->descent
> it
->max_descent
)
26679 it
->ascent
+= it
->descent
- it
->max_descent
;
26680 it
->descent
= it
->max_descent
;
26682 if (it
->ascent
> it
->max_ascent
)
26684 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26685 it
->ascent
= it
->max_ascent
;
26687 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26688 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26689 extra_line_spacing
= 0;
26692 /* If this is a space inside a region of text with
26693 `space-width' property, change its width. */
26694 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26696 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26698 /* If face has a box, add the box thickness to the character
26699 height. If character has a box line to the left and/or
26700 right, add the box line width to the character's width. */
26701 if (face
->box
!= FACE_NO_BOX
)
26703 int thick
= face
->box_line_width
;
26707 it
->ascent
+= thick
;
26708 it
->descent
+= thick
;
26713 if (it
->start_of_box_run_p
)
26714 it
->pixel_width
+= thick
;
26715 if (it
->end_of_box_run_p
)
26716 it
->pixel_width
+= thick
;
26719 /* If face has an overline, add the height of the overline
26720 (1 pixel) and a 1 pixel margin to the character height. */
26721 if (face
->overline_p
)
26722 it
->ascent
+= overline_margin
;
26724 if (it
->constrain_row_ascent_descent_p
)
26726 if (it
->ascent
> it
->max_ascent
)
26727 it
->ascent
= it
->max_ascent
;
26728 if (it
->descent
> it
->max_descent
)
26729 it
->descent
= it
->max_descent
;
26732 take_vertical_position_into_account (it
);
26734 /* If we have to actually produce glyphs, do it. */
26739 /* Translate a space with a `space-width' property
26740 into a stretch glyph. */
26741 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26742 / FONT_HEIGHT (font
));
26743 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26744 it
->ascent
+ it
->descent
, ascent
);
26749 /* If characters with lbearing or rbearing are displayed
26750 in this line, record that fact in a flag of the
26751 glyph row. This is used to optimize X output code. */
26752 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26753 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26755 if (! stretched_p
&& it
->pixel_width
== 0)
26756 /* We assure that all visible glyphs have at least 1-pixel
26758 it
->pixel_width
= 1;
26760 else if (it
->char_to_display
== '\n')
26762 /* A newline has no width, but we need the height of the
26763 line. But if previous part of the line sets a height,
26764 don't increase that height. */
26766 Lisp_Object height
;
26767 Lisp_Object total_height
= Qnil
;
26769 it
->override_ascent
= -1;
26770 it
->pixel_width
= 0;
26773 height
= get_it_property (it
, Qline_height
);
26774 /* Split (line-height total-height) list. */
26776 && CONSP (XCDR (height
))
26777 && NILP (XCDR (XCDR (height
))))
26779 total_height
= XCAR (XCDR (height
));
26780 height
= XCAR (height
);
26782 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26784 if (it
->override_ascent
>= 0)
26786 it
->ascent
= it
->override_ascent
;
26787 it
->descent
= it
->override_descent
;
26788 boff
= it
->override_boff
;
26792 it
->ascent
= FONT_BASE (font
) + boff
;
26793 it
->descent
= FONT_DESCENT (font
) - boff
;
26796 if (EQ (height
, Qt
))
26798 if (it
->descent
> it
->max_descent
)
26800 it
->ascent
+= it
->descent
- it
->max_descent
;
26801 it
->descent
= it
->max_descent
;
26803 if (it
->ascent
> it
->max_ascent
)
26805 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26806 it
->ascent
= it
->max_ascent
;
26808 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26809 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26810 it
->constrain_row_ascent_descent_p
= 1;
26811 extra_line_spacing
= 0;
26815 Lisp_Object spacing
;
26817 it
->phys_ascent
= it
->ascent
;
26818 it
->phys_descent
= it
->descent
;
26820 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26821 && face
->box
!= FACE_NO_BOX
26822 && face
->box_line_width
> 0)
26824 it
->ascent
+= face
->box_line_width
;
26825 it
->descent
+= face
->box_line_width
;
26828 && XINT (height
) > it
->ascent
+ it
->descent
)
26829 it
->ascent
= XINT (height
) - it
->descent
;
26831 if (!NILP (total_height
))
26832 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26835 spacing
= get_it_property (it
, Qline_spacing
);
26836 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26838 if (INTEGERP (spacing
))
26840 extra_line_spacing
= XINT (spacing
);
26841 if (!NILP (total_height
))
26842 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26846 else /* i.e. (it->char_to_display == '\t') */
26848 if (font
->space_width
> 0)
26850 int tab_width
= it
->tab_width
* font
->space_width
;
26851 int x
= it
->current_x
+ it
->continuation_lines_width
;
26852 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26854 /* If the distance from the current position to the next tab
26855 stop is less than a space character width, use the
26856 tab stop after that. */
26857 if (next_tab_x
- x
< font
->space_width
)
26858 next_tab_x
+= tab_width
;
26860 it
->pixel_width
= next_tab_x
- x
;
26862 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26863 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26867 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26868 it
->ascent
+ it
->descent
, it
->ascent
);
26873 it
->pixel_width
= 0;
26878 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26880 /* A static composition.
26882 Note: A composition is represented as one glyph in the
26883 glyph matrix. There are no padding glyphs.
26885 Important note: pixel_width, ascent, and descent are the
26886 values of what is drawn by draw_glyphs (i.e. the values of
26887 the overall glyphs composed). */
26888 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26889 int boff
; /* baseline offset */
26890 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26891 int glyph_len
= cmp
->glyph_len
;
26892 struct font
*font
= face
->font
;
26896 /* If we have not yet calculated pixel size data of glyphs of
26897 the composition for the current face font, calculate them
26898 now. Theoretically, we have to check all fonts for the
26899 glyphs, but that requires much time and memory space. So,
26900 here we check only the font of the first glyph. This may
26901 lead to incorrect display, but it's very rare, and C-l
26902 (recenter-top-bottom) can correct the display anyway. */
26903 if (! cmp
->font
|| cmp
->font
!= font
)
26905 /* Ascent and descent of the font of the first character
26906 of this composition (adjusted by baseline offset).
26907 Ascent and descent of overall glyphs should not be less
26908 than these, respectively. */
26909 int font_ascent
, font_descent
, font_height
;
26910 /* Bounding box of the overall glyphs. */
26911 int leftmost
, rightmost
, lowest
, highest
;
26912 int lbearing
, rbearing
;
26913 int i
, width
, ascent
, descent
;
26914 int left_padded
= 0, right_padded
= 0;
26915 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26917 struct font_metrics
*pcm
;
26918 int font_not_found_p
;
26921 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26922 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26924 if (glyph_len
< cmp
->glyph_len
)
26926 for (i
= 0; i
< glyph_len
; i
++)
26928 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26930 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26935 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26936 : IT_CHARPOS (*it
));
26937 /* If no suitable font is found, use the default font. */
26938 font_not_found_p
= font
== NULL
;
26939 if (font_not_found_p
)
26941 face
= face
->ascii_face
;
26944 boff
= font
->baseline_offset
;
26945 if (font
->vertical_centering
)
26946 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26947 font_ascent
= FONT_BASE (font
) + boff
;
26948 font_descent
= FONT_DESCENT (font
) - boff
;
26949 font_height
= FONT_HEIGHT (font
);
26954 if (! font_not_found_p
)
26956 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26958 pcm
= get_per_char_metric (font
, &char2b
);
26961 /* Initialize the bounding box. */
26964 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26965 ascent
= pcm
->ascent
;
26966 descent
= pcm
->descent
;
26967 lbearing
= pcm
->lbearing
;
26968 rbearing
= pcm
->rbearing
;
26972 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26973 ascent
= FONT_BASE (font
);
26974 descent
= FONT_DESCENT (font
);
26981 lowest
= - descent
+ boff
;
26982 highest
= ascent
+ boff
;
26984 if (! font_not_found_p
26985 && font
->default_ascent
26986 && CHAR_TABLE_P (Vuse_default_ascent
)
26987 && !NILP (Faref (Vuse_default_ascent
,
26988 make_number (it
->char_to_display
))))
26989 highest
= font
->default_ascent
+ boff
;
26991 /* Draw the first glyph at the normal position. It may be
26992 shifted to right later if some other glyphs are drawn
26994 cmp
->offsets
[i
* 2] = 0;
26995 cmp
->offsets
[i
* 2 + 1] = boff
;
26996 cmp
->lbearing
= lbearing
;
26997 cmp
->rbearing
= rbearing
;
26999 /* Set cmp->offsets for the remaining glyphs. */
27000 for (i
++; i
< glyph_len
; i
++)
27002 int left
, right
, btm
, top
;
27003 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27005 struct face
*this_face
;
27009 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27010 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27011 font
= this_face
->font
;
27017 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27019 pcm
= get_per_char_metric (font
, &char2b
);
27022 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27025 width
= pcm
->width
;
27026 ascent
= pcm
->ascent
;
27027 descent
= pcm
->descent
;
27028 lbearing
= pcm
->lbearing
;
27029 rbearing
= pcm
->rbearing
;
27030 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27032 /* Relative composition with or without
27033 alternate chars. */
27034 left
= (leftmost
+ rightmost
- width
) / 2;
27035 btm
= - descent
+ boff
;
27036 if (font
->relative_compose
27037 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27038 || NILP (Faref (Vignore_relative_composition
,
27039 make_number (ch
)))))
27042 if (- descent
>= font
->relative_compose
)
27043 /* One extra pixel between two glyphs. */
27045 else if (ascent
<= 0)
27046 /* One extra pixel between two glyphs. */
27047 btm
= lowest
- 1 - ascent
- descent
;
27052 /* A composition rule is specified by an integer
27053 value that encodes global and new reference
27054 points (GREF and NREF). GREF and NREF are
27055 specified by numbers as below:
27057 0---1---2 -- ascent
27061 9--10--11 -- center
27063 ---3---4---5--- baseline
27065 6---7---8 -- descent
27067 int rule
= COMPOSITION_RULE (cmp
, i
);
27068 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27070 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27071 grefx
= gref
% 3, nrefx
= nref
% 3;
27072 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27074 xoff
= font_height
* (xoff
- 128) / 256;
27076 yoff
= font_height
* (yoff
- 128) / 256;
27079 + grefx
* (rightmost
- leftmost
) / 2
27080 - nrefx
* width
/ 2
27083 btm
= ((grefy
== 0 ? highest
27085 : grefy
== 2 ? lowest
27086 : (highest
+ lowest
) / 2)
27087 - (nrefy
== 0 ? ascent
+ descent
27088 : nrefy
== 1 ? descent
- boff
27090 : (ascent
+ descent
) / 2)
27094 cmp
->offsets
[i
* 2] = left
;
27095 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27097 /* Update the bounding box of the overall glyphs. */
27100 right
= left
+ width
;
27101 if (left
< leftmost
)
27103 if (right
> rightmost
)
27106 top
= btm
+ descent
+ ascent
;
27112 if (cmp
->lbearing
> left
+ lbearing
)
27113 cmp
->lbearing
= left
+ lbearing
;
27114 if (cmp
->rbearing
< left
+ rbearing
)
27115 cmp
->rbearing
= left
+ rbearing
;
27119 /* If there are glyphs whose x-offsets are negative,
27120 shift all glyphs to the right and make all x-offsets
27124 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27125 cmp
->offsets
[i
* 2] -= leftmost
;
27126 rightmost
-= leftmost
;
27127 cmp
->lbearing
-= leftmost
;
27128 cmp
->rbearing
-= leftmost
;
27131 if (left_padded
&& cmp
->lbearing
< 0)
27133 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27134 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27135 rightmost
-= cmp
->lbearing
;
27136 cmp
->rbearing
-= cmp
->lbearing
;
27139 if (right_padded
&& rightmost
< cmp
->rbearing
)
27141 rightmost
= cmp
->rbearing
;
27144 cmp
->pixel_width
= rightmost
;
27145 cmp
->ascent
= highest
;
27146 cmp
->descent
= - lowest
;
27147 if (cmp
->ascent
< font_ascent
)
27148 cmp
->ascent
= font_ascent
;
27149 if (cmp
->descent
< font_descent
)
27150 cmp
->descent
= font_descent
;
27154 && (cmp
->lbearing
< 0
27155 || cmp
->rbearing
> cmp
->pixel_width
))
27156 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
27158 it
->pixel_width
= cmp
->pixel_width
;
27159 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27160 it
->descent
= it
->phys_descent
= cmp
->descent
;
27161 if (face
->box
!= FACE_NO_BOX
)
27163 int thick
= face
->box_line_width
;
27167 it
->ascent
+= thick
;
27168 it
->descent
+= thick
;
27173 if (it
->start_of_box_run_p
)
27174 it
->pixel_width
+= thick
;
27175 if (it
->end_of_box_run_p
)
27176 it
->pixel_width
+= thick
;
27179 /* If face has an overline, add the height of the overline
27180 (1 pixel) and a 1 pixel margin to the character height. */
27181 if (face
->overline_p
)
27182 it
->ascent
+= overline_margin
;
27184 take_vertical_position_into_account (it
);
27185 if (it
->ascent
< 0)
27187 if (it
->descent
< 0)
27190 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27191 append_composite_glyph (it
);
27193 else if (it
->what
== IT_COMPOSITION
)
27195 /* A dynamic (automatic) composition. */
27196 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27197 Lisp_Object gstring
;
27198 struct font_metrics metrics
;
27202 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27204 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27207 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27208 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
27209 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27210 it
->descent
= it
->phys_descent
= metrics
.descent
;
27211 if (face
->box
!= FACE_NO_BOX
)
27213 int thick
= face
->box_line_width
;
27217 it
->ascent
+= thick
;
27218 it
->descent
+= thick
;
27223 if (it
->start_of_box_run_p
)
27224 it
->pixel_width
+= thick
;
27225 if (it
->end_of_box_run_p
)
27226 it
->pixel_width
+= thick
;
27228 /* If face has an overline, add the height of the overline
27229 (1 pixel) and a 1 pixel margin to the character height. */
27230 if (face
->overline_p
)
27231 it
->ascent
+= overline_margin
;
27232 take_vertical_position_into_account (it
);
27233 if (it
->ascent
< 0)
27235 if (it
->descent
< 0)
27239 append_composite_glyph (it
);
27241 else if (it
->what
== IT_GLYPHLESS
)
27242 produce_glyphless_glyph (it
, 0, Qnil
);
27243 else if (it
->what
== IT_IMAGE
)
27244 produce_image_glyph (it
);
27245 else if (it
->what
== IT_STRETCH
)
27246 produce_stretch_glyph (it
);
27247 #ifdef HAVE_XWIDGETS
27248 else if (it
->what
== IT_XWIDGET
)
27249 produce_xwidget_glyph (it
);
27253 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27254 because this isn't true for images with `:ascent 100'. */
27255 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27256 if (it
->area
== TEXT_AREA
)
27257 it
->current_x
+= it
->pixel_width
;
27259 if (extra_line_spacing
> 0)
27261 it
->descent
+= extra_line_spacing
;
27262 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27263 it
->max_extra_line_spacing
= extra_line_spacing
;
27266 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27267 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27268 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27269 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27273 Output LEN glyphs starting at START at the nominal cursor position.
27274 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27275 being updated, and UPDATED_AREA is the area of that row being updated. */
27278 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27279 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27281 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27283 eassert (updated_row
);
27284 /* When the window is hscrolled, cursor hpos can legitimately be out
27285 of bounds, but we draw the cursor at the corresponding window
27286 margin in that case. */
27287 if (!updated_row
->reversed_p
&& chpos
< 0)
27289 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27290 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27294 /* Write glyphs. */
27296 hpos
= start
- updated_row
->glyphs
[updated_area
];
27297 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27298 updated_row
, updated_area
,
27300 DRAW_NORMAL_TEXT
, 0);
27302 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27303 if (updated_area
== TEXT_AREA
27304 && w
->phys_cursor_on_p
27305 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27307 && chpos
< hpos
+ len
)
27308 w
->phys_cursor_on_p
= 0;
27312 /* Advance the output cursor. */
27313 w
->output_cursor
.hpos
+= len
;
27314 w
->output_cursor
.x
= x
;
27319 Insert LEN glyphs from START at the nominal cursor position. */
27322 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27323 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27326 int line_height
, shift_by_width
, shifted_region_width
;
27327 struct glyph_row
*row
;
27328 struct glyph
*glyph
;
27329 int frame_x
, frame_y
;
27332 eassert (updated_row
);
27334 f
= XFRAME (WINDOW_FRAME (w
));
27336 /* Get the height of the line we are in. */
27338 line_height
= row
->height
;
27340 /* Get the width of the glyphs to insert. */
27341 shift_by_width
= 0;
27342 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27343 shift_by_width
+= glyph
->pixel_width
;
27345 /* Get the width of the region to shift right. */
27346 shifted_region_width
= (window_box_width (w
, updated_area
)
27347 - w
->output_cursor
.x
27351 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27352 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27354 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27355 line_height
, shift_by_width
);
27357 /* Write the glyphs. */
27358 hpos
= start
- row
->glyphs
[updated_area
];
27359 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27361 DRAW_NORMAL_TEXT
, 0);
27363 /* Advance the output cursor. */
27364 w
->output_cursor
.hpos
+= len
;
27365 w
->output_cursor
.x
+= shift_by_width
;
27371 Erase the current text line from the nominal cursor position
27372 (inclusive) to pixel column TO_X (exclusive). The idea is that
27373 everything from TO_X onward is already erased.
27375 TO_X is a pixel position relative to UPDATED_AREA of currently
27376 updated window W. TO_X == -1 means clear to the end of this area. */
27379 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27380 enum glyph_row_area updated_area
, int to_x
)
27383 int max_x
, min_y
, max_y
;
27384 int from_x
, from_y
, to_y
;
27386 eassert (updated_row
);
27387 f
= XFRAME (w
->frame
);
27389 if (updated_row
->full_width_p
)
27390 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27391 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27393 max_x
= window_box_width (w
, updated_area
);
27394 max_y
= window_text_bottom_y (w
);
27396 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27397 of window. For TO_X > 0, truncate to end of drawing area. */
27403 to_x
= min (to_x
, max_x
);
27405 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27407 /* Notice if the cursor will be cleared by this operation. */
27408 if (!updated_row
->full_width_p
)
27409 notice_overwritten_cursor (w
, updated_area
,
27410 w
->output_cursor
.x
, -1,
27412 MATRIX_ROW_BOTTOM_Y (updated_row
));
27414 from_x
= w
->output_cursor
.x
;
27416 /* Translate to frame coordinates. */
27417 if (updated_row
->full_width_p
)
27419 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27420 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27424 int area_left
= window_box_left (w
, updated_area
);
27425 from_x
+= area_left
;
27429 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27430 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27431 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27433 /* Prevent inadvertently clearing to end of the X window. */
27434 if (to_x
> from_x
&& to_y
> from_y
)
27437 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27438 to_x
- from_x
, to_y
- from_y
);
27443 #endif /* HAVE_WINDOW_SYSTEM */
27447 /***********************************************************************
27449 ***********************************************************************/
27451 /* Value is the internal representation of the specified cursor type
27452 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27453 of the bar cursor. */
27455 static enum text_cursor_kinds
27456 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27458 enum text_cursor_kinds type
;
27463 if (EQ (arg
, Qbox
))
27464 return FILLED_BOX_CURSOR
;
27466 if (EQ (arg
, Qhollow
))
27467 return HOLLOW_BOX_CURSOR
;
27469 if (EQ (arg
, Qbar
))
27476 && EQ (XCAR (arg
), Qbar
)
27477 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27479 *width
= XINT (XCDR (arg
));
27483 if (EQ (arg
, Qhbar
))
27486 return HBAR_CURSOR
;
27490 && EQ (XCAR (arg
), Qhbar
)
27491 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27493 *width
= XINT (XCDR (arg
));
27494 return HBAR_CURSOR
;
27497 /* Treat anything unknown as "hollow box cursor".
27498 It was bad to signal an error; people have trouble fixing
27499 .Xdefaults with Emacs, when it has something bad in it. */
27500 type
= HOLLOW_BOX_CURSOR
;
27505 /* Set the default cursor types for specified frame. */
27507 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27512 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27513 FRAME_CURSOR_WIDTH (f
) = width
;
27515 /* By default, set up the blink-off state depending on the on-state. */
27517 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27520 FRAME_BLINK_OFF_CURSOR (f
)
27521 = get_specified_cursor_type (XCDR (tem
), &width
);
27522 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27525 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27527 /* Make sure the cursor gets redrawn. */
27528 f
->cursor_type_changed
= 1;
27532 #ifdef HAVE_WINDOW_SYSTEM
27534 /* Return the cursor we want to be displayed in window W. Return
27535 width of bar/hbar cursor through WIDTH arg. Return with
27536 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27537 (i.e. if the `system caret' should track this cursor).
27539 In a mini-buffer window, we want the cursor only to appear if we
27540 are reading input from this window. For the selected window, we
27541 want the cursor type given by the frame parameter or buffer local
27542 setting of cursor-type. If explicitly marked off, draw no cursor.
27543 In all other cases, we want a hollow box cursor. */
27545 static enum text_cursor_kinds
27546 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27547 int *active_cursor
)
27549 struct frame
*f
= XFRAME (w
->frame
);
27550 struct buffer
*b
= XBUFFER (w
->contents
);
27551 int cursor_type
= DEFAULT_CURSOR
;
27552 Lisp_Object alt_cursor
;
27553 int non_selected
= 0;
27555 *active_cursor
= 1;
27558 if (cursor_in_echo_area
27559 && FRAME_HAS_MINIBUF_P (f
)
27560 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27562 if (w
== XWINDOW (echo_area_window
))
27564 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27566 *width
= FRAME_CURSOR_WIDTH (f
);
27567 return FRAME_DESIRED_CURSOR (f
);
27570 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27573 *active_cursor
= 0;
27577 /* Detect a nonselected window or nonselected frame. */
27578 else if (w
!= XWINDOW (f
->selected_window
)
27579 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27581 *active_cursor
= 0;
27583 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27589 /* Never display a cursor in a window in which cursor-type is nil. */
27590 if (NILP (BVAR (b
, cursor_type
)))
27593 /* Get the normal cursor type for this window. */
27594 if (EQ (BVAR (b
, cursor_type
), Qt
))
27596 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27597 *width
= FRAME_CURSOR_WIDTH (f
);
27600 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27602 /* Use cursor-in-non-selected-windows instead
27603 for non-selected window or frame. */
27606 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27607 if (!EQ (Qt
, alt_cursor
))
27608 return get_specified_cursor_type (alt_cursor
, width
);
27609 /* t means modify the normal cursor type. */
27610 if (cursor_type
== FILLED_BOX_CURSOR
)
27611 cursor_type
= HOLLOW_BOX_CURSOR
;
27612 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27614 return cursor_type
;
27617 /* Use normal cursor if not blinked off. */
27618 if (!w
->cursor_off_p
)
27621 #ifdef HAVE_XWIDGETS
27622 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
){
27626 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27628 if (cursor_type
== FILLED_BOX_CURSOR
)
27630 /* Using a block cursor on large images can be very annoying.
27631 So use a hollow cursor for "large" images.
27632 If image is not transparent (no mask), also use hollow cursor. */
27633 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27634 if (img
!= NULL
&& IMAGEP (img
->spec
))
27636 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27637 where N = size of default frame font size.
27638 This should cover most of the "tiny" icons people may use. */
27640 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27641 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27642 cursor_type
= HOLLOW_BOX_CURSOR
;
27645 else if (cursor_type
!= NO_CURSOR
)
27647 /* Display current only supports BOX and HOLLOW cursors for images.
27648 So for now, unconditionally use a HOLLOW cursor when cursor is
27649 not a solid box cursor. */
27650 cursor_type
= HOLLOW_BOX_CURSOR
;
27653 return cursor_type
;
27656 /* Cursor is blinked off, so determine how to "toggle" it. */
27658 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27659 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27660 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27662 /* Then see if frame has specified a specific blink off cursor type. */
27663 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27665 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27666 return FRAME_BLINK_OFF_CURSOR (f
);
27670 /* Some people liked having a permanently visible blinking cursor,
27671 while others had very strong opinions against it. So it was
27672 decided to remove it. KFS 2003-09-03 */
27674 /* Finally perform built-in cursor blinking:
27675 filled box <-> hollow box
27676 wide [h]bar <-> narrow [h]bar
27677 narrow [h]bar <-> no cursor
27678 other type <-> no cursor */
27680 if (cursor_type
== FILLED_BOX_CURSOR
)
27681 return HOLLOW_BOX_CURSOR
;
27683 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27686 return cursor_type
;
27694 /* Notice when the text cursor of window W has been completely
27695 overwritten by a drawing operation that outputs glyphs in AREA
27696 starting at X0 and ending at X1 in the line starting at Y0 and
27697 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27698 the rest of the line after X0 has been written. Y coordinates
27699 are window-relative. */
27702 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27703 int x0
, int x1
, int y0
, int y1
)
27705 int cx0
, cx1
, cy0
, cy1
;
27706 struct glyph_row
*row
;
27708 if (!w
->phys_cursor_on_p
)
27710 if (area
!= TEXT_AREA
)
27713 if (w
->phys_cursor
.vpos
< 0
27714 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27715 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27716 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27719 if (row
->cursor_in_fringe_p
)
27721 row
->cursor_in_fringe_p
= 0;
27722 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27723 w
->phys_cursor_on_p
= 0;
27727 cx0
= w
->phys_cursor
.x
;
27728 cx1
= cx0
+ w
->phys_cursor_width
;
27729 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27732 /* The cursor image will be completely removed from the
27733 screen if the output area intersects the cursor area in
27734 y-direction. When we draw in [y0 y1[, and some part of
27735 the cursor is at y < y0, that part must have been drawn
27736 before. When scrolling, the cursor is erased before
27737 actually scrolling, so we don't come here. When not
27738 scrolling, the rows above the old cursor row must have
27739 changed, and in this case these rows must have written
27740 over the cursor image.
27742 Likewise if part of the cursor is below y1, with the
27743 exception of the cursor being in the first blank row at
27744 the buffer and window end because update_text_area
27745 doesn't draw that row. (Except when it does, but
27746 that's handled in update_text_area.) */
27748 cy0
= w
->phys_cursor
.y
;
27749 cy1
= cy0
+ w
->phys_cursor_height
;
27750 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27753 w
->phys_cursor_on_p
= 0;
27756 #endif /* HAVE_WINDOW_SYSTEM */
27759 /************************************************************************
27761 ************************************************************************/
27763 #ifdef HAVE_WINDOW_SYSTEM
27766 Fix the display of area AREA of overlapping row ROW in window W
27767 with respect to the overlapping part OVERLAPS. */
27770 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27771 enum glyph_row_area area
, int overlaps
)
27778 for (i
= 0; i
< row
->used
[area
];)
27780 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27782 int start
= i
, start_x
= x
;
27786 x
+= row
->glyphs
[area
][i
].pixel_width
;
27789 while (i
< row
->used
[area
]
27790 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27792 draw_glyphs (w
, start_x
, row
, area
,
27794 DRAW_NORMAL_TEXT
, overlaps
);
27798 x
+= row
->glyphs
[area
][i
].pixel_width
;
27808 Draw the cursor glyph of window W in glyph row ROW. See the
27809 comment of draw_glyphs for the meaning of HL. */
27812 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27813 enum draw_glyphs_face hl
)
27815 /* If cursor hpos is out of bounds, don't draw garbage. This can
27816 happen in mini-buffer windows when switching between echo area
27817 glyphs and mini-buffer. */
27818 if ((row
->reversed_p
27819 ? (w
->phys_cursor
.hpos
>= 0)
27820 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27822 int on_p
= w
->phys_cursor_on_p
;
27824 int hpos
= w
->phys_cursor
.hpos
;
27826 /* When the window is hscrolled, cursor hpos can legitimately be
27827 out of bounds, but we draw the cursor at the corresponding
27828 window margin in that case. */
27829 if (!row
->reversed_p
&& hpos
< 0)
27831 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27832 hpos
= row
->used
[TEXT_AREA
] - 1;
27834 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27836 w
->phys_cursor_on_p
= on_p
;
27838 if (hl
== DRAW_CURSOR
)
27839 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27840 /* When we erase the cursor, and ROW is overlapped by other
27841 rows, make sure that these overlapping parts of other rows
27843 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27845 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27847 if (row
> w
->current_matrix
->rows
27848 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27849 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27850 OVERLAPS_ERASED_CURSOR
);
27852 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27853 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27854 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27855 OVERLAPS_ERASED_CURSOR
);
27861 /* Erase the image of a cursor of window W from the screen. */
27864 erase_phys_cursor (struct window
*w
)
27866 struct frame
*f
= XFRAME (w
->frame
);
27867 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27868 int hpos
= w
->phys_cursor
.hpos
;
27869 int vpos
= w
->phys_cursor
.vpos
;
27870 int mouse_face_here_p
= 0;
27871 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27872 struct glyph_row
*cursor_row
;
27873 struct glyph
*cursor_glyph
;
27874 enum draw_glyphs_face hl
;
27876 /* No cursor displayed or row invalidated => nothing to do on the
27878 if (w
->phys_cursor_type
== NO_CURSOR
)
27879 goto mark_cursor_off
;
27881 /* VPOS >= active_glyphs->nrows means that window has been resized.
27882 Don't bother to erase the cursor. */
27883 if (vpos
>= active_glyphs
->nrows
)
27884 goto mark_cursor_off
;
27886 /* If row containing cursor is marked invalid, there is nothing we
27888 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27889 if (!cursor_row
->enabled_p
)
27890 goto mark_cursor_off
;
27892 /* If line spacing is > 0, old cursor may only be partially visible in
27893 window after split-window. So adjust visible height. */
27894 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27895 window_text_bottom_y (w
) - cursor_row
->y
);
27897 /* If row is completely invisible, don't attempt to delete a cursor which
27898 isn't there. This can happen if cursor is at top of a window, and
27899 we switch to a buffer with a header line in that window. */
27900 if (cursor_row
->visible_height
<= 0)
27901 goto mark_cursor_off
;
27903 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27904 if (cursor_row
->cursor_in_fringe_p
)
27906 cursor_row
->cursor_in_fringe_p
= 0;
27907 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27908 goto mark_cursor_off
;
27911 /* This can happen when the new row is shorter than the old one.
27912 In this case, either draw_glyphs or clear_end_of_line
27913 should have cleared the cursor. Note that we wouldn't be
27914 able to erase the cursor in this case because we don't have a
27915 cursor glyph at hand. */
27916 if ((cursor_row
->reversed_p
27917 ? (w
->phys_cursor
.hpos
< 0)
27918 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27919 goto mark_cursor_off
;
27921 /* When the window is hscrolled, cursor hpos can legitimately be out
27922 of bounds, but we draw the cursor at the corresponding window
27923 margin in that case. */
27924 if (!cursor_row
->reversed_p
&& hpos
< 0)
27926 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27927 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27929 /* If the cursor is in the mouse face area, redisplay that when
27930 we clear the cursor. */
27931 if (! NILP (hlinfo
->mouse_face_window
)
27932 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27933 /* Don't redraw the cursor's spot in mouse face if it is at the
27934 end of a line (on a newline). The cursor appears there, but
27935 mouse highlighting does not. */
27936 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27937 mouse_face_here_p
= 1;
27939 /* Maybe clear the display under the cursor. */
27940 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27943 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27946 cursor_glyph
= get_phys_cursor_glyph (w
);
27947 if (cursor_glyph
== NULL
)
27948 goto mark_cursor_off
;
27950 width
= cursor_glyph
->pixel_width
;
27951 x
= w
->phys_cursor
.x
;
27957 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27958 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27959 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27962 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27965 /* Erase the cursor by redrawing the character underneath it. */
27966 if (mouse_face_here_p
)
27967 hl
= DRAW_MOUSE_FACE
;
27969 hl
= DRAW_NORMAL_TEXT
;
27970 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27973 w
->phys_cursor_on_p
= 0;
27974 w
->phys_cursor_type
= NO_CURSOR
;
27979 Display or clear cursor of window W. If ON is zero, clear the
27980 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27981 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27984 display_and_set_cursor (struct window
*w
, bool on
,
27985 int hpos
, int vpos
, int x
, int y
)
27987 struct frame
*f
= XFRAME (w
->frame
);
27988 int new_cursor_type
;
27989 int new_cursor_width
;
27991 struct glyph_row
*glyph_row
;
27992 struct glyph
*glyph
;
27994 /* This is pointless on invisible frames, and dangerous on garbaged
27995 windows and frames; in the latter case, the frame or window may
27996 be in the midst of changing its size, and x and y may be off the
27998 if (! FRAME_VISIBLE_P (f
)
27999 || FRAME_GARBAGED_P (f
)
28000 || vpos
>= w
->current_matrix
->nrows
28001 || hpos
>= w
->current_matrix
->matrix_w
)
28004 /* If cursor is off and we want it off, return quickly. */
28005 if (!on
&& !w
->phys_cursor_on_p
)
28008 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28009 /* If cursor row is not enabled, we don't really know where to
28010 display the cursor. */
28011 if (!glyph_row
->enabled_p
)
28013 w
->phys_cursor_on_p
= 0;
28018 if (!glyph_row
->exact_window_width_line_p
28019 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28020 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28022 eassert (input_blocked_p ());
28024 /* Set new_cursor_type to the cursor we want to be displayed. */
28025 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28026 &new_cursor_width
, &active_cursor
);
28028 /* If cursor is currently being shown and we don't want it to be or
28029 it is in the wrong place, or the cursor type is not what we want,
28031 if (w
->phys_cursor_on_p
28033 || w
->phys_cursor
.x
!= x
28034 || w
->phys_cursor
.y
!= y
28035 /* HPOS can be negative in R2L rows whose
28036 exact_window_width_line_p flag is set (i.e. their newline
28037 would "overflow into the fringe"). */
28039 || new_cursor_type
!= w
->phys_cursor_type
28040 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28041 && new_cursor_width
!= w
->phys_cursor_width
)))
28042 erase_phys_cursor (w
);
28044 /* Don't check phys_cursor_on_p here because that flag is only set
28045 to zero in some cases where we know that the cursor has been
28046 completely erased, to avoid the extra work of erasing the cursor
28047 twice. In other words, phys_cursor_on_p can be 1 and the cursor
28048 still not be visible, or it has only been partly erased. */
28051 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28052 w
->phys_cursor_height
= glyph_row
->height
;
28054 /* Set phys_cursor_.* before x_draw_.* is called because some
28055 of them may need the information. */
28056 w
->phys_cursor
.x
= x
;
28057 w
->phys_cursor
.y
= glyph_row
->y
;
28058 w
->phys_cursor
.hpos
= hpos
;
28059 w
->phys_cursor
.vpos
= vpos
;
28062 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28063 new_cursor_type
, new_cursor_width
,
28064 on
, active_cursor
);
28068 /* Switch the display of W's cursor on or off, according to the value
28072 update_window_cursor (struct window
*w
, bool on
)
28074 /* Don't update cursor in windows whose frame is in the process
28075 of being deleted. */
28076 if (w
->current_matrix
)
28078 int hpos
= w
->phys_cursor
.hpos
;
28079 int vpos
= w
->phys_cursor
.vpos
;
28080 struct glyph_row
*row
;
28082 if (vpos
>= w
->current_matrix
->nrows
28083 || hpos
>= w
->current_matrix
->matrix_w
)
28086 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28088 /* When the window is hscrolled, cursor hpos can legitimately be
28089 out of bounds, but we draw the cursor at the corresponding
28090 window margin in that case. */
28091 if (!row
->reversed_p
&& hpos
< 0)
28093 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28094 hpos
= row
->used
[TEXT_AREA
] - 1;
28097 display_and_set_cursor (w
, on
, hpos
, vpos
,
28098 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28104 /* Call update_window_cursor with parameter ON_P on all leaf windows
28105 in the window tree rooted at W. */
28108 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28112 if (WINDOWP (w
->contents
))
28113 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28115 update_window_cursor (w
, on_p
);
28117 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28123 Display the cursor on window W, or clear it, according to ON_P.
28124 Don't change the cursor's position. */
28127 x_update_cursor (struct frame
*f
, bool on_p
)
28129 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28134 Clear the cursor of window W to background color, and mark the
28135 cursor as not shown. This is used when the text where the cursor
28136 is about to be rewritten. */
28139 x_clear_cursor (struct window
*w
)
28141 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28142 update_window_cursor (w
, 0);
28145 #endif /* HAVE_WINDOW_SYSTEM */
28147 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28150 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28151 int start_hpos
, int end_hpos
,
28152 enum draw_glyphs_face draw
)
28154 #ifdef HAVE_WINDOW_SYSTEM
28155 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28157 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28161 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28162 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28166 /* Display the active region described by mouse_face_* according to DRAW. */
28169 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28171 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28172 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28174 if (/* If window is in the process of being destroyed, don't bother
28176 w
->current_matrix
!= NULL
28177 /* Don't update mouse highlight if hidden. */
28178 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28179 /* Recognize when we are called to operate on rows that don't exist
28180 anymore. This can happen when a window is split. */
28181 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28183 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
28184 struct glyph_row
*row
, *first
, *last
;
28186 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28187 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28189 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28191 int start_hpos
, end_hpos
, start_x
;
28193 /* For all but the first row, the highlight starts at column 0. */
28196 /* R2L rows have BEG and END in reversed order, but the
28197 screen drawing geometry is always left to right. So
28198 we need to mirror the beginning and end of the
28199 highlighted area in R2L rows. */
28200 if (!row
->reversed_p
)
28202 start_hpos
= hlinfo
->mouse_face_beg_col
;
28203 start_x
= hlinfo
->mouse_face_beg_x
;
28205 else if (row
== last
)
28207 start_hpos
= hlinfo
->mouse_face_end_col
;
28208 start_x
= hlinfo
->mouse_face_end_x
;
28216 else if (row
->reversed_p
&& row
== last
)
28218 start_hpos
= hlinfo
->mouse_face_end_col
;
28219 start_x
= hlinfo
->mouse_face_end_x
;
28229 if (!row
->reversed_p
)
28230 end_hpos
= hlinfo
->mouse_face_end_col
;
28231 else if (row
== first
)
28232 end_hpos
= hlinfo
->mouse_face_beg_col
;
28235 end_hpos
= row
->used
[TEXT_AREA
];
28236 if (draw
== DRAW_NORMAL_TEXT
)
28237 row
->fill_line_p
= 1; /* Clear to end of line */
28240 else if (row
->reversed_p
&& row
== first
)
28241 end_hpos
= hlinfo
->mouse_face_beg_col
;
28244 end_hpos
= row
->used
[TEXT_AREA
];
28245 if (draw
== DRAW_NORMAL_TEXT
)
28246 row
->fill_line_p
= 1; /* Clear to end of line */
28249 if (end_hpos
> start_hpos
)
28251 draw_row_with_mouse_face (w
, start_x
, row
,
28252 start_hpos
, end_hpos
, draw
);
28255 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28259 #ifdef HAVE_WINDOW_SYSTEM
28260 /* When we've written over the cursor, arrange for it to
28261 be displayed again. */
28262 if (FRAME_WINDOW_P (f
)
28263 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28265 int hpos
= w
->phys_cursor
.hpos
;
28267 /* When the window is hscrolled, cursor hpos can legitimately be
28268 out of bounds, but we draw the cursor at the corresponding
28269 window margin in that case. */
28270 if (!row
->reversed_p
&& hpos
< 0)
28272 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28273 hpos
= row
->used
[TEXT_AREA
] - 1;
28276 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
28277 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28280 #endif /* HAVE_WINDOW_SYSTEM */
28283 #ifdef HAVE_WINDOW_SYSTEM
28284 /* Change the mouse cursor. */
28285 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28287 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28288 if (draw
== DRAW_NORMAL_TEXT
28289 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28290 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28293 if (draw
== DRAW_MOUSE_FACE
)
28294 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28296 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28298 #endif /* HAVE_WINDOW_SYSTEM */
28302 Clear out the mouse-highlighted active region.
28303 Redraw it un-highlighted first. Value is non-zero if mouse
28304 face was actually drawn unhighlighted. */
28307 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28311 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
28313 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28317 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28318 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28319 hlinfo
->mouse_face_window
= Qnil
;
28320 hlinfo
->mouse_face_overlay
= Qnil
;
28324 /* Return true if the coordinates HPOS and VPOS on windows W are
28325 within the mouse face on that window. */
28327 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28329 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28331 /* Quickly resolve the easy cases. */
28332 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28333 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28335 if (vpos
< hlinfo
->mouse_face_beg_row
28336 || vpos
> hlinfo
->mouse_face_end_row
)
28338 if (vpos
> hlinfo
->mouse_face_beg_row
28339 && vpos
< hlinfo
->mouse_face_end_row
)
28342 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28344 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28346 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28349 else if ((vpos
== hlinfo
->mouse_face_beg_row
28350 && hpos
>= hlinfo
->mouse_face_beg_col
)
28351 || (vpos
== hlinfo
->mouse_face_end_row
28352 && hpos
< hlinfo
->mouse_face_end_col
))
28357 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28359 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28362 else if ((vpos
== hlinfo
->mouse_face_beg_row
28363 && hpos
<= hlinfo
->mouse_face_beg_col
)
28364 || (vpos
== hlinfo
->mouse_face_end_row
28365 && hpos
> hlinfo
->mouse_face_end_col
))
28373 True if physical cursor of window W is within mouse face. */
28376 cursor_in_mouse_face_p (struct window
*w
)
28378 int hpos
= w
->phys_cursor
.hpos
;
28379 int vpos
= w
->phys_cursor
.vpos
;
28380 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28382 /* When the window is hscrolled, cursor hpos can legitimately be out
28383 of bounds, but we draw the cursor at the corresponding window
28384 margin in that case. */
28385 if (!row
->reversed_p
&& hpos
< 0)
28387 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28388 hpos
= row
->used
[TEXT_AREA
] - 1;
28390 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28395 /* Find the glyph rows START_ROW and END_ROW of window W that display
28396 characters between buffer positions START_CHARPOS and END_CHARPOS
28397 (excluding END_CHARPOS). DISP_STRING is a display string that
28398 covers these buffer positions. This is similar to
28399 row_containing_pos, but is more accurate when bidi reordering makes
28400 buffer positions change non-linearly with glyph rows. */
28402 rows_from_pos_range (struct window
*w
,
28403 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28404 Lisp_Object disp_string
,
28405 struct glyph_row
**start
, struct glyph_row
**end
)
28407 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28408 int last_y
= window_text_bottom_y (w
);
28409 struct glyph_row
*row
;
28414 while (!first
->enabled_p
28415 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28418 /* Find the START row. */
28420 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28423 /* A row can potentially be the START row if the range of the
28424 characters it displays intersects the range
28425 [START_CHARPOS..END_CHARPOS). */
28426 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28427 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28428 /* See the commentary in row_containing_pos, for the
28429 explanation of the complicated way to check whether
28430 some position is beyond the end of the characters
28431 displayed by a row. */
28432 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28433 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28434 && !row
->ends_at_zv_p
28435 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28436 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28437 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28438 && !row
->ends_at_zv_p
28439 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28441 /* Found a candidate row. Now make sure at least one of the
28442 glyphs it displays has a charpos from the range
28443 [START_CHARPOS..END_CHARPOS).
28445 This is not obvious because bidi reordering could make
28446 buffer positions of a row be 1,2,3,102,101,100, and if we
28447 want to highlight characters in [50..60), we don't want
28448 this row, even though [50..60) does intersect [1..103),
28449 the range of character positions given by the row's start
28450 and end positions. */
28451 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28452 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28456 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28457 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28458 /* A glyph that comes from DISP_STRING is by
28459 definition to be highlighted. */
28460 || EQ (g
->object
, disp_string
))
28469 /* Find the END row. */
28471 /* If the last row is partially visible, start looking for END
28472 from that row, instead of starting from FIRST. */
28473 && !(row
->enabled_p
28474 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28476 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28478 struct glyph_row
*next
= row
+ 1;
28479 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28481 if (!next
->enabled_p
28482 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28483 /* The first row >= START whose range of displayed characters
28484 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28485 is the row END + 1. */
28486 || (start_charpos
< next_start
28487 && end_charpos
< next_start
)
28488 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28489 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28490 && !next
->ends_at_zv_p
28491 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28492 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28493 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28494 && !next
->ends_at_zv_p
28495 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28502 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28503 but none of the characters it displays are in the range, it is
28505 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28506 struct glyph
*s
= g
;
28507 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28511 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28512 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28513 /* If the buffer position of the first glyph in
28514 the row is equal to END_CHARPOS, it means
28515 the last character to be highlighted is the
28516 newline of ROW, and we must consider NEXT as
28518 || (((!next
->reversed_p
&& g
== s
)
28519 || (next
->reversed_p
&& g
== e
- 1))
28520 && (g
->charpos
== end_charpos
28521 /* Special case for when NEXT is an
28522 empty line at ZV. */
28523 || (g
->charpos
== -1
28524 && !row
->ends_at_zv_p
28525 && next_start
== end_charpos
)))))
28526 /* A glyph that comes from DISP_STRING is by
28527 definition to be highlighted. */
28528 || EQ (g
->object
, disp_string
))
28537 /* The first row that ends at ZV must be the last to be
28539 else if (next
->ends_at_zv_p
)
28548 /* This function sets the mouse_face_* elements of HLINFO, assuming
28549 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28550 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28551 for the overlay or run of text properties specifying the mouse
28552 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28553 before-string and after-string that must also be highlighted.
28554 DISP_STRING, if non-nil, is a display string that may cover some
28555 or all of the highlighted text. */
28558 mouse_face_from_buffer_pos (Lisp_Object window
,
28559 Mouse_HLInfo
*hlinfo
,
28560 ptrdiff_t mouse_charpos
,
28561 ptrdiff_t start_charpos
,
28562 ptrdiff_t end_charpos
,
28563 Lisp_Object before_string
,
28564 Lisp_Object after_string
,
28565 Lisp_Object disp_string
)
28567 struct window
*w
= XWINDOW (window
);
28568 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28569 struct glyph_row
*r1
, *r2
;
28570 struct glyph
*glyph
, *end
;
28571 ptrdiff_t ignore
, pos
;
28574 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28575 eassert (NILP (before_string
) || STRINGP (before_string
));
28576 eassert (NILP (after_string
) || STRINGP (after_string
));
28578 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28579 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28581 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28582 /* If the before-string or display-string contains newlines,
28583 rows_from_pos_range skips to its last row. Move back. */
28584 if (!NILP (before_string
) || !NILP (disp_string
))
28586 struct glyph_row
*prev
;
28587 while ((prev
= r1
- 1, prev
>= first
)
28588 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28589 && prev
->used
[TEXT_AREA
] > 0)
28591 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28592 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28593 while (--glyph
>= beg
&& NILP (glyph
->object
));
28595 || !(EQ (glyph
->object
, before_string
)
28596 || EQ (glyph
->object
, disp_string
)))
28603 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28604 hlinfo
->mouse_face_past_end
= 1;
28606 else if (!NILP (after_string
))
28608 /* If the after-string has newlines, advance to its last row. */
28609 struct glyph_row
*next
;
28610 struct glyph_row
*last
28611 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28613 for (next
= r2
+ 1;
28615 && next
->used
[TEXT_AREA
] > 0
28616 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28620 /* The rest of the display engine assumes that mouse_face_beg_row is
28621 either above mouse_face_end_row or identical to it. But with
28622 bidi-reordered continued lines, the row for START_CHARPOS could
28623 be below the row for END_CHARPOS. If so, swap the rows and store
28624 them in correct order. */
28627 struct glyph_row
*tem
= r2
;
28633 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28634 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28636 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28637 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28638 could be anywhere in the row and in any order. The strategy
28639 below is to find the leftmost and the rightmost glyph that
28640 belongs to either of these 3 strings, or whose position is
28641 between START_CHARPOS and END_CHARPOS, and highlight all the
28642 glyphs between those two. This may cover more than just the text
28643 between START_CHARPOS and END_CHARPOS if the range of characters
28644 strides the bidi level boundary, e.g. if the beginning is in R2L
28645 text while the end is in L2R text or vice versa. */
28646 if (!r1
->reversed_p
)
28648 /* This row is in a left to right paragraph. Scan it left to
28650 glyph
= r1
->glyphs
[TEXT_AREA
];
28651 end
= glyph
+ r1
->used
[TEXT_AREA
];
28654 /* Skip truncation glyphs at the start of the glyph row. */
28655 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28657 && NILP (glyph
->object
)
28658 && glyph
->charpos
< 0;
28660 x
+= glyph
->pixel_width
;
28662 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28663 or DISP_STRING, and the first glyph from buffer whose
28664 position is between START_CHARPOS and END_CHARPOS. */
28666 && !NILP (glyph
->object
)
28667 && !EQ (glyph
->object
, disp_string
)
28668 && !(BUFFERP (glyph
->object
)
28669 && (glyph
->charpos
>= start_charpos
28670 && glyph
->charpos
< end_charpos
));
28673 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28674 are present at buffer positions between START_CHARPOS and
28675 END_CHARPOS, or if they come from an overlay. */
28676 if (EQ (glyph
->object
, before_string
))
28678 pos
= string_buffer_position (before_string
,
28680 /* If pos == 0, it means before_string came from an
28681 overlay, not from a buffer position. */
28682 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28685 else if (EQ (glyph
->object
, after_string
))
28687 pos
= string_buffer_position (after_string
, end_charpos
);
28688 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28691 x
+= glyph
->pixel_width
;
28693 hlinfo
->mouse_face_beg_x
= x
;
28694 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28698 /* This row is in a right to left paragraph. Scan it right to
28702 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28703 glyph
= end
+ r1
->used
[TEXT_AREA
];
28705 /* Skip truncation glyphs at the start of the glyph row. */
28706 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28708 && NILP (glyph
->object
)
28709 && glyph
->charpos
< 0;
28713 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28714 or DISP_STRING, and the first glyph from buffer whose
28715 position is between START_CHARPOS and END_CHARPOS. */
28717 && !NILP (glyph
->object
)
28718 && !EQ (glyph
->object
, disp_string
)
28719 && !(BUFFERP (glyph
->object
)
28720 && (glyph
->charpos
>= start_charpos
28721 && glyph
->charpos
< end_charpos
));
28724 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28725 are present at buffer positions between START_CHARPOS and
28726 END_CHARPOS, or if they come from an overlay. */
28727 if (EQ (glyph
->object
, before_string
))
28729 pos
= string_buffer_position (before_string
, start_charpos
);
28730 /* If pos == 0, it means before_string came from an
28731 overlay, not from a buffer position. */
28732 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28735 else if (EQ (glyph
->object
, after_string
))
28737 pos
= string_buffer_position (after_string
, end_charpos
);
28738 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28743 glyph
++; /* first glyph to the right of the highlighted area */
28744 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28745 x
+= g
->pixel_width
;
28746 hlinfo
->mouse_face_beg_x
= x
;
28747 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28750 /* If the highlight ends in a different row, compute GLYPH and END
28751 for the end row. Otherwise, reuse the values computed above for
28752 the row where the highlight begins. */
28755 if (!r2
->reversed_p
)
28757 glyph
= r2
->glyphs
[TEXT_AREA
];
28758 end
= glyph
+ r2
->used
[TEXT_AREA
];
28763 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28764 glyph
= end
+ r2
->used
[TEXT_AREA
];
28768 if (!r2
->reversed_p
)
28770 /* Skip truncation and continuation glyphs near the end of the
28771 row, and also blanks and stretch glyphs inserted by
28772 extend_face_to_end_of_line. */
28774 && NILP ((end
- 1)->object
))
28776 /* Scan the rest of the glyph row from the end, looking for the
28777 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28778 DISP_STRING, or whose position is between START_CHARPOS
28782 && !NILP (end
->object
)
28783 && !EQ (end
->object
, disp_string
)
28784 && !(BUFFERP (end
->object
)
28785 && (end
->charpos
>= start_charpos
28786 && end
->charpos
< end_charpos
));
28789 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28790 are present at buffer positions between START_CHARPOS and
28791 END_CHARPOS, or if they come from an overlay. */
28792 if (EQ (end
->object
, before_string
))
28794 pos
= string_buffer_position (before_string
, start_charpos
);
28795 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28798 else if (EQ (end
->object
, after_string
))
28800 pos
= string_buffer_position (after_string
, end_charpos
);
28801 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28805 /* Find the X coordinate of the last glyph to be highlighted. */
28806 for (; glyph
<= end
; ++glyph
)
28807 x
+= glyph
->pixel_width
;
28809 hlinfo
->mouse_face_end_x
= x
;
28810 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28814 /* Skip truncation and continuation glyphs near the end of the
28815 row, and also blanks and stretch glyphs inserted by
28816 extend_face_to_end_of_line. */
28820 && NILP (end
->object
))
28822 x
+= end
->pixel_width
;
28825 /* Scan the rest of the glyph row from the end, looking for the
28826 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28827 DISP_STRING, or whose position is between START_CHARPOS
28831 && !NILP (end
->object
)
28832 && !EQ (end
->object
, disp_string
)
28833 && !(BUFFERP (end
->object
)
28834 && (end
->charpos
>= start_charpos
28835 && end
->charpos
< end_charpos
));
28838 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28839 are present at buffer positions between START_CHARPOS and
28840 END_CHARPOS, or if they come from an overlay. */
28841 if (EQ (end
->object
, before_string
))
28843 pos
= string_buffer_position (before_string
, start_charpos
);
28844 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28847 else if (EQ (end
->object
, after_string
))
28849 pos
= string_buffer_position (after_string
, end_charpos
);
28850 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28853 x
+= end
->pixel_width
;
28855 /* If we exited the above loop because we arrived at the last
28856 glyph of the row, and its buffer position is still not in
28857 range, it means the last character in range is the preceding
28858 newline. Bump the end column and x values to get past the
28861 && BUFFERP (end
->object
)
28862 && (end
->charpos
< start_charpos
28863 || end
->charpos
>= end_charpos
))
28865 x
+= end
->pixel_width
;
28868 hlinfo
->mouse_face_end_x
= x
;
28869 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28872 hlinfo
->mouse_face_window
= window
;
28873 hlinfo
->mouse_face_face_id
28874 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28876 !hlinfo
->mouse_face_hidden
, -1);
28877 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28880 /* The following function is not used anymore (replaced with
28881 mouse_face_from_string_pos), but I leave it here for the time
28882 being, in case someone would. */
28884 #if 0 /* not used */
28886 /* Find the position of the glyph for position POS in OBJECT in
28887 window W's current matrix, and return in *X, *Y the pixel
28888 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28890 RIGHT_P non-zero means return the position of the right edge of the
28891 glyph, RIGHT_P zero means return the left edge position.
28893 If no glyph for POS exists in the matrix, return the position of
28894 the glyph with the next smaller position that is in the matrix, if
28895 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28896 exists in the matrix, return the position of the glyph with the
28897 next larger position in OBJECT.
28899 Value is non-zero if a glyph was found. */
28902 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28903 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28905 int yb
= window_text_bottom_y (w
);
28906 struct glyph_row
*r
;
28907 struct glyph
*best_glyph
= NULL
;
28908 struct glyph_row
*best_row
= NULL
;
28911 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28912 r
->enabled_p
&& r
->y
< yb
;
28915 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28916 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28919 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28920 if (EQ (g
->object
, object
))
28922 if (g
->charpos
== pos
)
28929 else if (best_glyph
== NULL
28930 || ((eabs (g
->charpos
- pos
)
28931 < eabs (best_glyph
->charpos
- pos
))
28934 : g
->charpos
> pos
)))
28948 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28952 *x
+= best_glyph
->pixel_width
;
28957 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28960 return best_glyph
!= NULL
;
28962 #endif /* not used */
28964 /* Find the positions of the first and the last glyphs in window W's
28965 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28966 (assumed to be a string), and return in HLINFO's mouse_face_*
28967 members the pixel and column/row coordinates of those glyphs. */
28970 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28971 Lisp_Object object
,
28972 ptrdiff_t startpos
, ptrdiff_t endpos
)
28974 int yb
= window_text_bottom_y (w
);
28975 struct glyph_row
*r
;
28976 struct glyph
*g
, *e
;
28980 /* Find the glyph row with at least one position in the range
28981 [STARTPOS..ENDPOS), and the first glyph in that row whose
28982 position belongs to that range. */
28983 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28984 r
->enabled_p
&& r
->y
< yb
;
28987 if (!r
->reversed_p
)
28989 g
= r
->glyphs
[TEXT_AREA
];
28990 e
= g
+ r
->used
[TEXT_AREA
];
28991 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28992 if (EQ (g
->object
, object
)
28993 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28995 hlinfo
->mouse_face_beg_row
28996 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28997 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28998 hlinfo
->mouse_face_beg_x
= gx
;
29007 e
= r
->glyphs
[TEXT_AREA
];
29008 g
= e
+ r
->used
[TEXT_AREA
];
29009 for ( ; g
> e
; --g
)
29010 if (EQ ((g
-1)->object
, object
)
29011 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29013 hlinfo
->mouse_face_beg_row
29014 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29015 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29016 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29017 gx
+= g1
->pixel_width
;
29018 hlinfo
->mouse_face_beg_x
= gx
;
29030 /* Starting with the next row, look for the first row which does NOT
29031 include any glyphs whose positions are in the range. */
29032 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29034 g
= r
->glyphs
[TEXT_AREA
];
29035 e
= g
+ r
->used
[TEXT_AREA
];
29037 for ( ; g
< e
; ++g
)
29038 if (EQ (g
->object
, object
)
29039 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29048 /* The highlighted region ends on the previous row. */
29051 /* Set the end row. */
29052 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29054 /* Compute and set the end column and the end column's horizontal
29055 pixel coordinate. */
29056 if (!r
->reversed_p
)
29058 g
= r
->glyphs
[TEXT_AREA
];
29059 e
= g
+ r
->used
[TEXT_AREA
];
29060 for ( ; e
> g
; --e
)
29061 if (EQ ((e
-1)->object
, object
)
29062 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29064 hlinfo
->mouse_face_end_col
= e
- g
;
29066 for (gx
= r
->x
; g
< e
; ++g
)
29067 gx
+= g
->pixel_width
;
29068 hlinfo
->mouse_face_end_x
= gx
;
29072 e
= r
->glyphs
[TEXT_AREA
];
29073 g
= e
+ r
->used
[TEXT_AREA
];
29074 for (gx
= r
->x
; e
< g
; ++e
)
29076 if (EQ (e
->object
, object
)
29077 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29079 gx
+= e
->pixel_width
;
29081 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29082 hlinfo
->mouse_face_end_x
= gx
;
29086 #ifdef HAVE_WINDOW_SYSTEM
29088 /* See if position X, Y is within a hot-spot of an image. */
29091 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29093 if (!CONSP (hot_spot
))
29096 if (EQ (XCAR (hot_spot
), Qrect
))
29098 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29099 Lisp_Object rect
= XCDR (hot_spot
);
29103 if (!CONSP (XCAR (rect
)))
29105 if (!CONSP (XCDR (rect
)))
29107 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29109 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29111 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29113 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29117 else if (EQ (XCAR (hot_spot
), Qcircle
))
29119 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29120 Lisp_Object circ
= XCDR (hot_spot
);
29121 Lisp_Object lr
, lx0
, ly0
;
29123 && CONSP (XCAR (circ
))
29124 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
29125 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29126 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29128 double r
= XFLOATINT (lr
);
29129 double dx
= XINT (lx0
) - x
;
29130 double dy
= XINT (ly0
) - y
;
29131 return (dx
* dx
+ dy
* dy
<= r
* r
);
29134 else if (EQ (XCAR (hot_spot
), Qpoly
))
29136 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29137 if (VECTORP (XCDR (hot_spot
)))
29139 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29140 Lisp_Object
*poly
= v
->contents
;
29141 ptrdiff_t n
= v
->header
.size
;
29144 Lisp_Object lx
, ly
;
29147 /* Need an even number of coordinates, and at least 3 edges. */
29148 if (n
< 6 || n
& 1)
29151 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29152 If count is odd, we are inside polygon. Pixels on edges
29153 may or may not be included depending on actual geometry of the
29155 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29156 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29158 x0
= XINT (lx
), y0
= XINT (ly
);
29159 for (i
= 0; i
< n
; i
+= 2)
29161 int x1
= x0
, y1
= y0
;
29162 if ((lx
= poly
[i
], !INTEGERP (lx
))
29163 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29165 x0
= XINT (lx
), y0
= XINT (ly
);
29167 /* Does this segment cross the X line? */
29175 if (y
> y0
&& y
> y1
)
29177 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29187 find_hot_spot (Lisp_Object map
, int x
, int y
)
29189 while (CONSP (map
))
29191 if (CONSP (XCAR (map
))
29192 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29200 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29202 doc
: /* Lookup in image map MAP coordinates X and Y.
29203 An image map is an alist where each element has the format (AREA ID PLIST).
29204 An AREA is specified as either a rectangle, a circle, or a polygon:
29205 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29206 pixel coordinates of the upper left and bottom right corners.
29207 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29208 and the radius of the circle; r may be a float or integer.
29209 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29210 vector describes one corner in the polygon.
29211 Returns the alist element for the first matching AREA in MAP. */)
29212 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29220 return find_hot_spot (map
,
29221 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29222 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29226 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29228 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29230 /* Do not change cursor shape while dragging mouse. */
29231 if (!NILP (do_mouse_tracking
))
29234 if (!NILP (pointer
))
29236 if (EQ (pointer
, Qarrow
))
29237 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29238 else if (EQ (pointer
, Qhand
))
29239 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29240 else if (EQ (pointer
, Qtext
))
29241 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29242 else if (EQ (pointer
, intern ("hdrag")))
29243 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29244 else if (EQ (pointer
, intern ("nhdrag")))
29245 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29246 #ifdef HAVE_X_WINDOWS
29247 else if (EQ (pointer
, intern ("vdrag")))
29248 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29250 else if (EQ (pointer
, intern ("hourglass")))
29251 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29252 else if (EQ (pointer
, Qmodeline
))
29253 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29255 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29258 if (cursor
!= No_Cursor
)
29259 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29262 #endif /* HAVE_WINDOW_SYSTEM */
29264 /* Take proper action when mouse has moved to the mode or header line
29265 or marginal area AREA of window W, x-position X and y-position Y.
29266 X is relative to the start of the text display area of W, so the
29267 width of bitmap areas and scroll bars must be subtracted to get a
29268 position relative to the start of the mode line. */
29271 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29272 enum window_part area
)
29274 struct window
*w
= XWINDOW (window
);
29275 struct frame
*f
= XFRAME (w
->frame
);
29276 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29277 #ifdef HAVE_WINDOW_SYSTEM
29278 Display_Info
*dpyinfo
;
29280 Cursor cursor
= No_Cursor
;
29281 Lisp_Object pointer
= Qnil
;
29282 int dx
, dy
, width
, height
;
29284 Lisp_Object string
, object
= Qnil
;
29285 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29287 Lisp_Object mouse_face
;
29288 int original_x_pixel
= x
;
29289 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29290 struct glyph_row
*row
IF_LINT (= 0);
29292 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29297 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29298 returns them in row/column units! */
29299 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29300 &object
, &dx
, &dy
, &width
, &height
);
29302 row
= (area
== ON_MODE_LINE
29303 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29304 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29306 /* Find the glyph under the mouse pointer. */
29307 if (row
->mode_line_p
&& row
->enabled_p
)
29309 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29310 end
= glyph
+ row
->used
[TEXT_AREA
];
29312 for (x0
= original_x_pixel
;
29313 glyph
< end
&& x0
>= glyph
->pixel_width
;
29315 x0
-= glyph
->pixel_width
;
29323 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29324 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29325 returns them in row/column units! */
29326 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29327 &object
, &dx
, &dy
, &width
, &height
);
29332 #ifdef HAVE_WINDOW_SYSTEM
29333 if (IMAGEP (object
))
29335 Lisp_Object image_map
, hotspot
;
29336 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29338 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29340 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29344 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29345 If so, we could look for mouse-enter, mouse-leave
29346 properties in PLIST (and do something...). */
29347 hotspot
= XCDR (hotspot
);
29348 if (CONSP (hotspot
)
29349 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29351 pointer
= Fplist_get (plist
, Qpointer
);
29352 if (NILP (pointer
))
29354 help
= Fplist_get (plist
, Qhelp_echo
);
29357 help_echo_string
= help
;
29358 XSETWINDOW (help_echo_window
, w
);
29359 help_echo_object
= w
->contents
;
29360 help_echo_pos
= charpos
;
29364 if (NILP (pointer
))
29365 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29367 #endif /* HAVE_WINDOW_SYSTEM */
29369 if (STRINGP (string
))
29370 pos
= make_number (charpos
);
29372 /* Set the help text and mouse pointer. If the mouse is on a part
29373 of the mode line without any text (e.g. past the right edge of
29374 the mode line text), use the default help text and pointer. */
29375 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29377 /* Arrange to display the help by setting the global variables
29378 help_echo_string, help_echo_object, and help_echo_pos. */
29381 if (STRINGP (string
))
29382 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29386 help_echo_string
= help
;
29387 XSETWINDOW (help_echo_window
, w
);
29388 help_echo_object
= string
;
29389 help_echo_pos
= charpos
;
29391 else if (area
== ON_MODE_LINE
)
29393 Lisp_Object default_help
29394 = buffer_local_value (Qmode_line_default_help_echo
,
29397 if (STRINGP (default_help
))
29399 help_echo_string
= default_help
;
29400 XSETWINDOW (help_echo_window
, w
);
29401 help_echo_object
= Qnil
;
29402 help_echo_pos
= -1;
29407 #ifdef HAVE_WINDOW_SYSTEM
29408 /* Change the mouse pointer according to what is under it. */
29409 if (FRAME_WINDOW_P (f
))
29411 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29413 || NILP (Vresize_mini_windows
));
29415 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29416 if (STRINGP (string
))
29418 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29420 if (NILP (pointer
))
29421 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29423 /* Change the mouse pointer according to what is under X/Y. */
29425 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29428 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29429 if (!KEYMAPP (map
))
29430 map
= Fget_text_property (pos
, Qkeymap
, string
);
29431 if (!KEYMAPP (map
) && draggable
)
29432 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29435 else if (draggable
)
29436 /* Default mode-line pointer. */
29437 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29442 /* Change the mouse face according to what is under X/Y. */
29443 if (STRINGP (string
))
29445 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29446 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29447 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29452 struct glyph
* tmp_glyph
;
29456 int total_pixel_width
;
29457 ptrdiff_t begpos
, endpos
, ignore
;
29461 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29462 Qmouse_face
, string
, Qnil
);
29468 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29470 endpos
= SCHARS (string
);
29474 /* Calculate the glyph position GPOS of GLYPH in the
29475 displayed string, relative to the beginning of the
29476 highlighted part of the string.
29478 Note: GPOS is different from CHARPOS. CHARPOS is the
29479 position of GLYPH in the internal string object. A mode
29480 line string format has structures which are converted to
29481 a flattened string by the Emacs Lisp interpreter. The
29482 internal string is an element of those structures. The
29483 displayed string is the flattened string. */
29484 tmp_glyph
= row_start_glyph
;
29485 while (tmp_glyph
< glyph
29486 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29487 && begpos
<= tmp_glyph
->charpos
29488 && tmp_glyph
->charpos
< endpos
)))
29490 gpos
= glyph
- tmp_glyph
;
29492 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29493 the highlighted part of the displayed string to which
29494 GLYPH belongs. Note: GSEQ_LENGTH is different from
29495 SCHARS (STRING), because the latter returns the length of
29496 the internal string. */
29497 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29499 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29500 && begpos
<= tmp_glyph
->charpos
29501 && tmp_glyph
->charpos
< endpos
));
29504 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29506 /* Calculate the total pixel width of all the glyphs between
29507 the beginning of the highlighted area and GLYPH. */
29508 total_pixel_width
= 0;
29509 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29510 total_pixel_width
+= tmp_glyph
->pixel_width
;
29512 /* Pre calculation of re-rendering position. Note: X is in
29513 column units here, after the call to mode_line_string or
29514 marginal_area_string. */
29516 vpos
= (area
== ON_MODE_LINE
29517 ? (w
->current_matrix
)->nrows
- 1
29520 /* If GLYPH's position is included in the region that is
29521 already drawn in mouse face, we have nothing to do. */
29522 if ( EQ (window
, hlinfo
->mouse_face_window
)
29523 && (!row
->reversed_p
29524 ? (hlinfo
->mouse_face_beg_col
<= hpos
29525 && hpos
< hlinfo
->mouse_face_end_col
)
29526 /* In R2L rows we swap BEG and END, see below. */
29527 : (hlinfo
->mouse_face_end_col
<= hpos
29528 && hpos
< hlinfo
->mouse_face_beg_col
))
29529 && hlinfo
->mouse_face_beg_row
== vpos
)
29532 if (clear_mouse_face (hlinfo
))
29533 cursor
= No_Cursor
;
29535 if (!row
->reversed_p
)
29537 hlinfo
->mouse_face_beg_col
= hpos
;
29538 hlinfo
->mouse_face_beg_x
= original_x_pixel
29539 - (total_pixel_width
+ dx
);
29540 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29541 hlinfo
->mouse_face_end_x
= 0;
29545 /* In R2L rows, show_mouse_face expects BEG and END
29546 coordinates to be swapped. */
29547 hlinfo
->mouse_face_end_col
= hpos
;
29548 hlinfo
->mouse_face_end_x
= original_x_pixel
29549 - (total_pixel_width
+ dx
);
29550 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29551 hlinfo
->mouse_face_beg_x
= 0;
29554 hlinfo
->mouse_face_beg_row
= vpos
;
29555 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29556 hlinfo
->mouse_face_past_end
= 0;
29557 hlinfo
->mouse_face_window
= window
;
29559 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29564 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29566 if (NILP (pointer
))
29569 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29570 clear_mouse_face (hlinfo
);
29572 #ifdef HAVE_WINDOW_SYSTEM
29573 if (FRAME_WINDOW_P (f
))
29574 define_frame_cursor1 (f
, cursor
, pointer
);
29580 Take proper action when the mouse has moved to position X, Y on
29581 frame F with regards to highlighting portions of display that have
29582 mouse-face properties. Also de-highlight portions of display where
29583 the mouse was before, set the mouse pointer shape as appropriate
29584 for the mouse coordinates, and activate help echo (tooltips).
29585 X and Y can be negative or out of range. */
29588 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29590 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29591 enum window_part part
= ON_NOTHING
;
29592 Lisp_Object window
;
29594 Cursor cursor
= No_Cursor
;
29595 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29598 /* When a menu is active, don't highlight because this looks odd. */
29599 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29600 if (popup_activated ())
29604 if (!f
->glyphs_initialized_p
29605 || f
->pointer_invisible
)
29608 hlinfo
->mouse_face_mouse_x
= x
;
29609 hlinfo
->mouse_face_mouse_y
= y
;
29610 hlinfo
->mouse_face_mouse_frame
= f
;
29612 if (hlinfo
->mouse_face_defer
)
29615 /* Which window is that in? */
29616 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29618 /* If displaying active text in another window, clear that. */
29619 if (! EQ (window
, hlinfo
->mouse_face_window
)
29620 /* Also clear if we move out of text area in same window. */
29621 || (!NILP (hlinfo
->mouse_face_window
)
29624 && part
!= ON_MODE_LINE
29625 && part
!= ON_HEADER_LINE
))
29626 clear_mouse_face (hlinfo
);
29628 /* Not on a window -> return. */
29629 if (!WINDOWP (window
))
29632 /* Reset help_echo_string. It will get recomputed below. */
29633 help_echo_string
= Qnil
;
29635 /* Convert to window-relative pixel coordinates. */
29636 w
= XWINDOW (window
);
29637 frame_to_window_pixel_xy (w
, &x
, &y
);
29639 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29640 /* Handle tool-bar window differently since it doesn't display a
29642 if (EQ (window
, f
->tool_bar_window
))
29644 note_tool_bar_highlight (f
, x
, y
);
29649 /* Mouse is on the mode, header line or margin? */
29650 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29651 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29653 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29655 #ifdef HAVE_WINDOW_SYSTEM
29656 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29658 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29659 /* Show non-text cursor (Bug#16647). */
29667 #ifdef HAVE_WINDOW_SYSTEM
29668 if (part
== ON_VERTICAL_BORDER
)
29670 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29671 help_echo_string
= build_string ("drag-mouse-1: resize");
29673 else if (part
== ON_RIGHT_DIVIDER
)
29675 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29676 help_echo_string
= build_string ("drag-mouse-1: resize");
29678 else if (part
== ON_BOTTOM_DIVIDER
)
29679 if (! WINDOW_BOTTOMMOST_P (w
)
29681 || NILP (Vresize_mini_windows
))
29683 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29684 help_echo_string
= build_string ("drag-mouse-1: resize");
29687 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29688 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29689 || part
== ON_VERTICAL_SCROLL_BAR
29690 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29691 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29693 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29696 /* Are we in a window whose display is up to date?
29697 And verify the buffer's text has not changed. */
29698 b
= XBUFFER (w
->contents
);
29699 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29701 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29703 struct glyph
*glyph
;
29704 Lisp_Object object
;
29705 Lisp_Object mouse_face
= Qnil
, position
;
29706 Lisp_Object
*overlay_vec
= NULL
;
29707 ptrdiff_t i
, noverlays
;
29708 struct buffer
*obuf
;
29709 ptrdiff_t obegv
, ozv
;
29712 /* Find the glyph under X/Y. */
29713 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29715 #ifdef HAVE_WINDOW_SYSTEM
29716 /* Look for :pointer property on image. */
29717 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29719 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29720 if (img
!= NULL
&& IMAGEP (img
->spec
))
29722 Lisp_Object image_map
, hotspot
;
29723 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29725 && (hotspot
= find_hot_spot (image_map
,
29726 glyph
->slice
.img
.x
+ dx
,
29727 glyph
->slice
.img
.y
+ dy
),
29729 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29733 /* Could check XCAR (hotspot) to see if we enter/leave
29735 If so, we could look for mouse-enter, mouse-leave
29736 properties in PLIST (and do something...). */
29737 hotspot
= XCDR (hotspot
);
29738 if (CONSP (hotspot
)
29739 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29741 pointer
= Fplist_get (plist
, Qpointer
);
29742 if (NILP (pointer
))
29744 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29745 if (!NILP (help_echo_string
))
29747 help_echo_window
= window
;
29748 help_echo_object
= glyph
->object
;
29749 help_echo_pos
= glyph
->charpos
;
29753 if (NILP (pointer
))
29754 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29757 #endif /* HAVE_WINDOW_SYSTEM */
29759 /* Clear mouse face if X/Y not over text. */
29761 || area
!= TEXT_AREA
29762 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29763 /* Glyph's OBJECT is nil for glyphs inserted by the
29764 display engine for its internal purposes, like truncation
29765 and continuation glyphs and blanks beyond the end of
29766 line's text on text terminals. If we are over such a
29767 glyph, we are not over any text. */
29768 || NILP (glyph
->object
)
29769 /* R2L rows have a stretch glyph at their front, which
29770 stands for no text, whereas L2R rows have no glyphs at
29771 all beyond the end of text. Treat such stretch glyphs
29772 like we do with NULL glyphs in L2R rows. */
29773 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29774 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29775 && glyph
->type
== STRETCH_GLYPH
29776 && glyph
->avoid_cursor_p
))
29778 if (clear_mouse_face (hlinfo
))
29779 cursor
= No_Cursor
;
29780 #ifdef HAVE_WINDOW_SYSTEM
29781 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29783 if (area
!= TEXT_AREA
)
29784 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29786 pointer
= Vvoid_text_area_pointer
;
29792 pos
= glyph
->charpos
;
29793 object
= glyph
->object
;
29794 if (!STRINGP (object
) && !BUFFERP (object
))
29797 /* If we get an out-of-range value, return now; avoid an error. */
29798 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29801 /* Make the window's buffer temporarily current for
29802 overlays_at and compute_char_face. */
29803 obuf
= current_buffer
;
29804 current_buffer
= b
;
29810 /* Is this char mouse-active or does it have help-echo? */
29811 position
= make_number (pos
);
29815 if (BUFFERP (object
))
29817 /* Put all the overlays we want in a vector in overlay_vec. */
29818 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29819 /* Sort overlays into increasing priority order. */
29820 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29825 if (NILP (Vmouse_highlight
))
29827 clear_mouse_face (hlinfo
);
29828 goto check_help_echo
;
29831 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29834 cursor
= No_Cursor
;
29836 /* Check mouse-face highlighting. */
29838 /* If there exists an overlay with mouse-face overlapping
29839 the one we are currently highlighting, we have to
29840 check if we enter the overlapping overlay, and then
29841 highlight only that. */
29842 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29843 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29845 /* Find the highest priority overlay with a mouse-face. */
29846 Lisp_Object overlay
= Qnil
;
29847 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29849 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29850 if (!NILP (mouse_face
))
29851 overlay
= overlay_vec
[i
];
29854 /* If we're highlighting the same overlay as before, there's
29855 no need to do that again. */
29856 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29857 goto check_help_echo
;
29858 hlinfo
->mouse_face_overlay
= overlay
;
29860 /* Clear the display of the old active region, if any. */
29861 if (clear_mouse_face (hlinfo
))
29862 cursor
= No_Cursor
;
29864 /* If no overlay applies, get a text property. */
29865 if (NILP (overlay
))
29866 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29868 /* Next, compute the bounds of the mouse highlighting and
29870 if (!NILP (mouse_face
) && STRINGP (object
))
29872 /* The mouse-highlighting comes from a display string
29873 with a mouse-face. */
29877 s
= Fprevious_single_property_change
29878 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29879 e
= Fnext_single_property_change
29880 (position
, Qmouse_face
, object
, Qnil
);
29882 s
= make_number (0);
29884 e
= make_number (SCHARS (object
));
29885 mouse_face_from_string_pos (w
, hlinfo
, object
,
29886 XINT (s
), XINT (e
));
29887 hlinfo
->mouse_face_past_end
= 0;
29888 hlinfo
->mouse_face_window
= window
;
29889 hlinfo
->mouse_face_face_id
29890 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29891 glyph
->face_id
, true);
29892 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29893 cursor
= No_Cursor
;
29897 /* The mouse-highlighting, if any, comes from an overlay
29898 or text property in the buffer. */
29899 Lisp_Object buffer
IF_LINT (= Qnil
);
29900 Lisp_Object disp_string
IF_LINT (= Qnil
);
29902 if (STRINGP (object
))
29904 /* If we are on a display string with no mouse-face,
29905 check if the text under it has one. */
29906 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29907 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29908 pos
= string_buffer_position (object
, start
);
29911 mouse_face
= get_char_property_and_overlay
29912 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29913 buffer
= w
->contents
;
29914 disp_string
= object
;
29920 disp_string
= Qnil
;
29923 if (!NILP (mouse_face
))
29925 Lisp_Object before
, after
;
29926 Lisp_Object before_string
, after_string
;
29927 /* To correctly find the limits of mouse highlight
29928 in a bidi-reordered buffer, we must not use the
29929 optimization of limiting the search in
29930 previous-single-property-change and
29931 next-single-property-change, because
29932 rows_from_pos_range needs the real start and end
29933 positions to DTRT in this case. That's because
29934 the first row visible in a window does not
29935 necessarily display the character whose position
29936 is the smallest. */
29938 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29939 ? Fmarker_position (w
->start
)
29942 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29943 ? make_number (BUF_Z (XBUFFER (buffer
))
29944 - w
->window_end_pos
)
29947 if (NILP (overlay
))
29949 /* Handle the text property case. */
29950 before
= Fprevious_single_property_change
29951 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29952 after
= Fnext_single_property_change
29953 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29954 before_string
= after_string
= Qnil
;
29958 /* Handle the overlay case. */
29959 before
= Foverlay_start (overlay
);
29960 after
= Foverlay_end (overlay
);
29961 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29962 after_string
= Foverlay_get (overlay
, Qafter_string
);
29964 if (!STRINGP (before_string
)) before_string
= Qnil
;
29965 if (!STRINGP (after_string
)) after_string
= Qnil
;
29968 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29971 : XFASTINT (before
),
29973 ? BUF_Z (XBUFFER (buffer
))
29974 : XFASTINT (after
),
29975 before_string
, after_string
,
29977 cursor
= No_Cursor
;
29984 /* Look for a `help-echo' property. */
29985 if (NILP (help_echo_string
)) {
29986 Lisp_Object help
, overlay
;
29988 /* Check overlays first. */
29989 help
= overlay
= Qnil
;
29990 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29992 overlay
= overlay_vec
[i
];
29993 help
= Foverlay_get (overlay
, Qhelp_echo
);
29998 help_echo_string
= help
;
29999 help_echo_window
= window
;
30000 help_echo_object
= overlay
;
30001 help_echo_pos
= pos
;
30005 Lisp_Object obj
= glyph
->object
;
30006 ptrdiff_t charpos
= glyph
->charpos
;
30008 /* Try text properties. */
30011 && charpos
< SCHARS (obj
))
30013 help
= Fget_text_property (make_number (charpos
),
30017 /* If the string itself doesn't specify a help-echo,
30018 see if the buffer text ``under'' it does. */
30019 struct glyph_row
*r
30020 = MATRIX_ROW (w
->current_matrix
, vpos
);
30021 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30022 ptrdiff_t p
= string_buffer_position (obj
, start
);
30025 help
= Fget_char_property (make_number (p
),
30026 Qhelp_echo
, w
->contents
);
30035 else if (BUFFERP (obj
)
30038 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30043 help_echo_string
= help
;
30044 help_echo_window
= window
;
30045 help_echo_object
= obj
;
30046 help_echo_pos
= charpos
;
30051 #ifdef HAVE_WINDOW_SYSTEM
30052 /* Look for a `pointer' property. */
30053 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30055 /* Check overlays first. */
30056 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30057 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30059 if (NILP (pointer
))
30061 Lisp_Object obj
= glyph
->object
;
30062 ptrdiff_t charpos
= glyph
->charpos
;
30064 /* Try text properties. */
30067 && charpos
< SCHARS (obj
))
30069 pointer
= Fget_text_property (make_number (charpos
),
30071 if (NILP (pointer
))
30073 /* If the string itself doesn't specify a pointer,
30074 see if the buffer text ``under'' it does. */
30075 struct glyph_row
*r
30076 = MATRIX_ROW (w
->current_matrix
, vpos
);
30077 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30078 ptrdiff_t p
= string_buffer_position (obj
, start
);
30080 pointer
= Fget_char_property (make_number (p
),
30081 Qpointer
, w
->contents
);
30084 else if (BUFFERP (obj
)
30087 pointer
= Fget_text_property (make_number (charpos
),
30091 #endif /* HAVE_WINDOW_SYSTEM */
30095 current_buffer
= obuf
;
30101 #ifdef HAVE_WINDOW_SYSTEM
30102 if (FRAME_WINDOW_P (f
))
30103 define_frame_cursor1 (f
, cursor
, pointer
);
30105 /* This is here to prevent a compiler error, about "label at end of
30106 compound statement". */
30113 Clear any mouse-face on window W. This function is part of the
30114 redisplay interface, and is called from try_window_id and similar
30115 functions to ensure the mouse-highlight is off. */
30118 x_clear_window_mouse_face (struct window
*w
)
30120 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30121 Lisp_Object window
;
30124 XSETWINDOW (window
, w
);
30125 if (EQ (window
, hlinfo
->mouse_face_window
))
30126 clear_mouse_face (hlinfo
);
30132 Just discard the mouse face information for frame F, if any.
30133 This is used when the size of F is changed. */
30136 cancel_mouse_face (struct frame
*f
)
30138 Lisp_Object window
;
30139 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30141 window
= hlinfo
->mouse_face_window
;
30142 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30143 reset_mouse_highlight (hlinfo
);
30148 /***********************************************************************
30150 ***********************************************************************/
30152 #ifdef HAVE_WINDOW_SYSTEM
30154 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30155 which intersects rectangle R. R is in window-relative coordinates. */
30158 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30159 enum glyph_row_area area
)
30161 struct glyph
*first
= row
->glyphs
[area
];
30162 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30163 struct glyph
*last
;
30164 int first_x
, start_x
, x
;
30166 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30167 /* If row extends face to end of line write the whole line. */
30168 draw_glyphs (w
, 0, row
, area
,
30169 0, row
->used
[area
],
30170 DRAW_NORMAL_TEXT
, 0);
30173 /* Set START_X to the window-relative start position for drawing glyphs of
30174 AREA. The first glyph of the text area can be partially visible.
30175 The first glyphs of other areas cannot. */
30176 start_x
= window_box_left_offset (w
, area
);
30178 if (area
== TEXT_AREA
)
30181 /* Find the first glyph that must be redrawn. */
30183 && x
+ first
->pixel_width
< r
->x
)
30185 x
+= first
->pixel_width
;
30189 /* Find the last one. */
30193 && x
< r
->x
+ r
->width
)
30195 x
+= last
->pixel_width
;
30201 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30202 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30203 DRAW_NORMAL_TEXT
, 0);
30208 /* Redraw the parts of the glyph row ROW on window W intersecting
30209 rectangle R. R is in window-relative coordinates. Value is
30210 non-zero if mouse-face was overwritten. */
30213 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30215 eassert (row
->enabled_p
);
30217 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30218 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30219 0, row
->used
[TEXT_AREA
],
30220 DRAW_NORMAL_TEXT
, 0);
30223 if (row
->used
[LEFT_MARGIN_AREA
])
30224 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30225 if (row
->used
[TEXT_AREA
])
30226 expose_area (w
, row
, r
, TEXT_AREA
);
30227 if (row
->used
[RIGHT_MARGIN_AREA
])
30228 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30229 draw_row_fringe_bitmaps (w
, row
);
30232 return row
->mouse_face_p
;
30236 /* Redraw those parts of glyphs rows during expose event handling that
30237 overlap other rows. Redrawing of an exposed line writes over parts
30238 of lines overlapping that exposed line; this function fixes that.
30240 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30241 row in W's current matrix that is exposed and overlaps other rows.
30242 LAST_OVERLAPPING_ROW is the last such row. */
30245 expose_overlaps (struct window
*w
,
30246 struct glyph_row
*first_overlapping_row
,
30247 struct glyph_row
*last_overlapping_row
,
30250 struct glyph_row
*row
;
30252 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30253 if (row
->overlapping_p
)
30255 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30258 if (row
->used
[LEFT_MARGIN_AREA
])
30259 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30261 if (row
->used
[TEXT_AREA
])
30262 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30264 if (row
->used
[RIGHT_MARGIN_AREA
])
30265 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30271 /* Return non-zero if W's cursor intersects rectangle R. */
30274 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30276 XRectangle cr
, result
;
30277 struct glyph
*cursor_glyph
;
30278 struct glyph_row
*row
;
30280 if (w
->phys_cursor
.vpos
>= 0
30281 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30282 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30284 && row
->cursor_in_fringe_p
)
30286 /* Cursor is in the fringe. */
30287 cr
.x
= window_box_right_offset (w
,
30288 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30289 ? RIGHT_MARGIN_AREA
30292 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30293 cr
.height
= row
->height
;
30294 return x_intersect_rectangles (&cr
, r
, &result
);
30297 cursor_glyph
= get_phys_cursor_glyph (w
);
30300 /* r is relative to W's box, but w->phys_cursor.x is relative
30301 to left edge of W's TEXT area. Adjust it. */
30302 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30303 cr
.y
= w
->phys_cursor
.y
;
30304 cr
.width
= cursor_glyph
->pixel_width
;
30305 cr
.height
= w
->phys_cursor_height
;
30306 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30307 I assume the effect is the same -- and this is portable. */
30308 return x_intersect_rectangles (&cr
, r
, &result
);
30310 /* If we don't understand the format, pretend we're not in the hot-spot. */
30316 Draw a vertical window border to the right of window W if W doesn't
30317 have vertical scroll bars. */
30320 x_draw_vertical_border (struct window
*w
)
30322 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30324 /* We could do better, if we knew what type of scroll-bar the adjacent
30325 windows (on either side) have... But we don't :-(
30326 However, I think this works ok. ++KFS 2003-04-25 */
30328 /* Redraw borders between horizontally adjacent windows. Don't
30329 do it for frames with vertical scroll bars because either the
30330 right scroll bar of a window, or the left scroll bar of its
30331 neighbor will suffice as a border. */
30332 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30335 /* Note: It is necessary to redraw both the left and the right
30336 borders, for when only this single window W is being
30338 if (!WINDOW_RIGHTMOST_P (w
)
30339 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30341 int x0
, x1
, y0
, y1
;
30343 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30346 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30349 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30352 if (!WINDOW_LEFTMOST_P (w
)
30353 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30355 int x0
, x1
, y0
, y1
;
30357 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30360 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30363 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30368 /* Draw window dividers for window W. */
30371 x_draw_right_divider (struct window
*w
)
30373 struct frame
*f
= WINDOW_XFRAME (w
);
30375 if (w
->mini
|| w
->pseudo_window_p
)
30377 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30379 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30380 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30381 int y0
= WINDOW_TOP_EDGE_Y (w
);
30382 /* The bottom divider prevails. */
30383 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30385 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30390 x_draw_bottom_divider (struct window
*w
)
30392 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30394 if (w
->mini
|| w
->pseudo_window_p
)
30396 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30398 int x0
= WINDOW_LEFT_EDGE_X (w
);
30399 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30400 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30401 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30403 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30407 /* Redraw the part of window W intersection rectangle FR. Pixel
30408 coordinates in FR are frame-relative. Call this function with
30409 input blocked. Value is non-zero if the exposure overwrites
30413 expose_window (struct window
*w
, XRectangle
*fr
)
30415 struct frame
*f
= XFRAME (w
->frame
);
30417 int mouse_face_overwritten_p
= 0;
30419 /* If window is not yet fully initialized, do nothing. This can
30420 happen when toolkit scroll bars are used and a window is split.
30421 Reconfiguring the scroll bar will generate an expose for a newly
30423 if (w
->current_matrix
== NULL
)
30426 /* When we're currently updating the window, display and current
30427 matrix usually don't agree. Arrange for a thorough display
30429 if (w
->must_be_updated_p
)
30431 SET_FRAME_GARBAGED (f
);
30435 /* Frame-relative pixel rectangle of W. */
30436 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30437 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30438 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30439 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30441 if (x_intersect_rectangles (fr
, &wr
, &r
))
30443 int yb
= window_text_bottom_y (w
);
30444 struct glyph_row
*row
;
30445 int cursor_cleared_p
, phys_cursor_on_p
;
30446 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30448 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30449 r
.x
, r
.y
, r
.width
, r
.height
));
30451 /* Convert to window coordinates. */
30452 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30453 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30455 /* Turn off the cursor. */
30456 if (!w
->pseudo_window_p
30457 && phys_cursor_in_rect_p (w
, &r
))
30459 x_clear_cursor (w
);
30460 cursor_cleared_p
= 1;
30463 cursor_cleared_p
= 0;
30465 /* If the row containing the cursor extends face to end of line,
30466 then expose_area might overwrite the cursor outside the
30467 rectangle and thus notice_overwritten_cursor might clear
30468 w->phys_cursor_on_p. We remember the original value and
30469 check later if it is changed. */
30470 phys_cursor_on_p
= w
->phys_cursor_on_p
;
30472 /* Update lines intersecting rectangle R. */
30473 first_overlapping_row
= last_overlapping_row
= NULL
;
30474 for (row
= w
->current_matrix
->rows
;
30479 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30481 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
30482 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
30483 || (r
.y
>= y0
&& r
.y
< y1
)
30484 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
30486 /* A header line may be overlapping, but there is no need
30487 to fix overlapping areas for them. KFS 2005-02-12 */
30488 if (row
->overlapping_p
&& !row
->mode_line_p
)
30490 if (first_overlapping_row
== NULL
)
30491 first_overlapping_row
= row
;
30492 last_overlapping_row
= row
;
30496 if (expose_line (w
, row
, &r
))
30497 mouse_face_overwritten_p
= 1;
30500 else if (row
->overlapping_p
)
30502 /* We must redraw a row overlapping the exposed area. */
30504 ? y0
+ row
->phys_height
> r
.y
30505 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30507 if (first_overlapping_row
== NULL
)
30508 first_overlapping_row
= row
;
30509 last_overlapping_row
= row
;
30517 /* Display the mode line if there is one. */
30518 if (WINDOW_WANTS_MODELINE_P (w
)
30519 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30521 && row
->y
< r
.y
+ r
.height
)
30523 if (expose_line (w
, row
, &r
))
30524 mouse_face_overwritten_p
= 1;
30527 if (!w
->pseudo_window_p
)
30529 /* Fix the display of overlapping rows. */
30530 if (first_overlapping_row
)
30531 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30534 /* Draw border between windows. */
30535 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30536 x_draw_right_divider (w
);
30538 x_draw_vertical_border (w
);
30540 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30541 x_draw_bottom_divider (w
);
30543 /* Turn the cursor on again. */
30544 if (cursor_cleared_p
30545 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30546 update_window_cursor (w
, 1);
30550 return mouse_face_overwritten_p
;
30555 /* Redraw (parts) of all windows in the window tree rooted at W that
30556 intersect R. R contains frame pixel coordinates. Value is
30557 non-zero if the exposure overwrites mouse-face. */
30560 expose_window_tree (struct window
*w
, XRectangle
*r
)
30562 struct frame
*f
= XFRAME (w
->frame
);
30563 int mouse_face_overwritten_p
= 0;
30565 while (w
&& !FRAME_GARBAGED_P (f
))
30567 if (WINDOWP (w
->contents
))
30568 mouse_face_overwritten_p
30569 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30571 mouse_face_overwritten_p
|= expose_window (w
, r
);
30573 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30576 return mouse_face_overwritten_p
;
30581 Redisplay an exposed area of frame F. X and Y are the upper-left
30582 corner of the exposed rectangle. W and H are width and height of
30583 the exposed area. All are pixel values. W or H zero means redraw
30584 the entire frame. */
30587 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30590 int mouse_face_overwritten_p
= 0;
30592 TRACE ((stderr
, "expose_frame "));
30594 /* No need to redraw if frame will be redrawn soon. */
30595 if (FRAME_GARBAGED_P (f
))
30597 TRACE ((stderr
, " garbaged\n"));
30601 /* If basic faces haven't been realized yet, there is no point in
30602 trying to redraw anything. This can happen when we get an expose
30603 event while Emacs is starting, e.g. by moving another window. */
30604 if (FRAME_FACE_CACHE (f
) == NULL
30605 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30607 TRACE ((stderr
, " no faces\n"));
30611 if (w
== 0 || h
== 0)
30614 r
.width
= FRAME_TEXT_WIDTH (f
);
30615 r
.height
= FRAME_TEXT_HEIGHT (f
);
30625 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30626 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30628 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30629 if (WINDOWP (f
->tool_bar_window
))
30630 mouse_face_overwritten_p
30631 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30634 #ifdef HAVE_X_WINDOWS
30636 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30637 if (WINDOWP (f
->menu_bar_window
))
30638 mouse_face_overwritten_p
30639 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30640 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30644 /* Some window managers support a focus-follows-mouse style with
30645 delayed raising of frames. Imagine a partially obscured frame,
30646 and moving the mouse into partially obscured mouse-face on that
30647 frame. The visible part of the mouse-face will be highlighted,
30648 then the WM raises the obscured frame. With at least one WM, KDE
30649 2.1, Emacs is not getting any event for the raising of the frame
30650 (even tried with SubstructureRedirectMask), only Expose events.
30651 These expose events will draw text normally, i.e. not
30652 highlighted. Which means we must redo the highlight here.
30653 Subsume it under ``we love X''. --gerd 2001-08-15 */
30654 /* Included in Windows version because Windows most likely does not
30655 do the right thing if any third party tool offers
30656 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30657 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30659 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30660 if (f
== hlinfo
->mouse_face_mouse_frame
)
30662 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30663 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30664 clear_mouse_face (hlinfo
);
30665 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30672 Determine the intersection of two rectangles R1 and R2. Return
30673 the intersection in *RESULT. Value is non-zero if RESULT is not
30677 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30679 XRectangle
*left
, *right
;
30680 XRectangle
*upper
, *lower
;
30681 int intersection_p
= 0;
30683 /* Rearrange so that R1 is the left-most rectangle. */
30685 left
= r1
, right
= r2
;
30687 left
= r2
, right
= r1
;
30689 /* X0 of the intersection is right.x0, if this is inside R1,
30690 otherwise there is no intersection. */
30691 if (right
->x
<= left
->x
+ left
->width
)
30693 result
->x
= right
->x
;
30695 /* The right end of the intersection is the minimum of
30696 the right ends of left and right. */
30697 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30700 /* Same game for Y. */
30702 upper
= r1
, lower
= r2
;
30704 upper
= r2
, lower
= r1
;
30706 /* The upper end of the intersection is lower.y0, if this is inside
30707 of upper. Otherwise, there is no intersection. */
30708 if (lower
->y
<= upper
->y
+ upper
->height
)
30710 result
->y
= lower
->y
;
30712 /* The lower end of the intersection is the minimum of the lower
30713 ends of upper and lower. */
30714 result
->height
= (min (lower
->y
+ lower
->height
,
30715 upper
->y
+ upper
->height
)
30717 intersection_p
= 1;
30721 return intersection_p
;
30724 #endif /* HAVE_WINDOW_SYSTEM */
30727 /***********************************************************************
30729 ***********************************************************************/
30732 syms_of_xdisp (void)
30734 Vwith_echo_area_save_vector
= Qnil
;
30735 staticpro (&Vwith_echo_area_save_vector
);
30737 Vmessage_stack
= Qnil
;
30738 staticpro (&Vmessage_stack
);
30740 /* Non-nil means don't actually do any redisplay. */
30741 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30743 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30745 message_dolog_marker1
= Fmake_marker ();
30746 staticpro (&message_dolog_marker1
);
30747 message_dolog_marker2
= Fmake_marker ();
30748 staticpro (&message_dolog_marker2
);
30749 message_dolog_marker3
= Fmake_marker ();
30750 staticpro (&message_dolog_marker3
);
30753 defsubr (&Sdump_frame_glyph_matrix
);
30754 defsubr (&Sdump_glyph_matrix
);
30755 defsubr (&Sdump_glyph_row
);
30756 defsubr (&Sdump_tool_bar_row
);
30757 defsubr (&Strace_redisplay
);
30758 defsubr (&Strace_to_stderr
);
30760 #ifdef HAVE_WINDOW_SYSTEM
30761 defsubr (&Stool_bar_height
);
30762 defsubr (&Slookup_image_map
);
30764 defsubr (&Sline_pixel_height
);
30765 defsubr (&Sformat_mode_line
);
30766 defsubr (&Sinvisible_p
);
30767 defsubr (&Scurrent_bidi_paragraph_direction
);
30768 defsubr (&Swindow_text_pixel_size
);
30769 defsubr (&Smove_point_visually
);
30770 defsubr (&Sbidi_find_overridden_directionality
);
30772 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30773 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30774 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30775 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30776 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30777 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30778 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30779 DEFSYM (Qeval
, "eval");
30780 DEFSYM (QCdata
, ":data");
30782 /* Names of text properties relevant for redisplay. */
30783 DEFSYM (Qdisplay
, "display");
30784 DEFSYM (Qspace_width
, "space-width");
30785 DEFSYM (Qraise
, "raise");
30786 DEFSYM (Qslice
, "slice");
30787 DEFSYM (Qspace
, "space");
30788 DEFSYM (Qmargin
, "margin");
30789 DEFSYM (Qpointer
, "pointer");
30790 DEFSYM (Qleft_margin
, "left-margin");
30791 DEFSYM (Qright_margin
, "right-margin");
30792 DEFSYM (Qcenter
, "center");
30793 DEFSYM (Qline_height
, "line-height");
30794 DEFSYM (QCalign_to
, ":align-to");
30795 DEFSYM (QCrelative_width
, ":relative-width");
30796 DEFSYM (QCrelative_height
, ":relative-height");
30797 DEFSYM (QCeval
, ":eval");
30798 DEFSYM (QCpropertize
, ":propertize");
30799 DEFSYM (QCfile
, ":file");
30800 DEFSYM (Qfontified
, "fontified");
30801 DEFSYM (Qfontification_functions
, "fontification-functions");
30803 /* Name of the face used to highlight trailing whitespace. */
30804 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30806 /* Name and number of the face used to highlight escape glyphs. */
30807 DEFSYM (Qescape_glyph
, "escape-glyph");
30809 /* Name and number of the face used to highlight non-breaking spaces. */
30810 DEFSYM (Qnobreak_space
, "nobreak-space");
30812 /* The symbol 'image' which is the car of the lists used to represent
30813 images in Lisp. Also a tool bar style. */
30814 DEFSYM (Qimage
, "image");
30816 /* Tool bar styles. */
30817 DEFSYM (Qtext
, "text");
30818 DEFSYM (Qboth
, "both");
30819 DEFSYM (Qboth_horiz
, "both-horiz");
30820 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30822 /* The image map types. */
30823 DEFSYM (QCmap
, ":map");
30824 DEFSYM (QCpointer
, ":pointer");
30825 DEFSYM (Qrect
, "rect");
30826 DEFSYM (Qcircle
, "circle");
30827 DEFSYM (Qpoly
, "poly");
30829 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
30830 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30831 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30833 DEFSYM (Qgrow_only
, "grow-only");
30834 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30835 DEFSYM (Qposition
, "position");
30836 DEFSYM (Qbuffer_position
, "buffer-position");
30837 DEFSYM (Qobject
, "object");
30839 /* Cursor shapes. */
30840 DEFSYM (Qbar
, "bar");
30841 DEFSYM (Qhbar
, "hbar");
30842 DEFSYM (Qbox
, "box");
30843 DEFSYM (Qhollow
, "hollow");
30845 /* Pointer shapes. */
30846 DEFSYM (Qhand
, "hand");
30847 DEFSYM (Qarrow
, "arrow");
30850 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30852 list_of_error
= list1 (list2 (intern_c_string ("error"),
30853 intern_c_string ("void-variable")));
30854 staticpro (&list_of_error
);
30856 /* Values of those variables at last redisplay are stored as
30857 properties on 'overlay-arrow-position' symbol. However, if
30858 Voverlay_arrow_position is a marker, last-arrow-position is its
30859 numerical position. */
30860 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30861 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30863 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30864 properties on a symbol in overlay-arrow-variable-list. */
30865 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30866 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30868 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30869 staticpro (&echo_buffer
[0]);
30870 staticpro (&echo_buffer
[1]);
30872 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30873 staticpro (&echo_area_buffer
[0]);
30874 staticpro (&echo_area_buffer
[1]);
30876 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30877 staticpro (&Vmessages_buffer_name
);
30879 mode_line_proptrans_alist
= Qnil
;
30880 staticpro (&mode_line_proptrans_alist
);
30881 mode_line_string_list
= Qnil
;
30882 staticpro (&mode_line_string_list
);
30883 mode_line_string_face
= Qnil
;
30884 staticpro (&mode_line_string_face
);
30885 mode_line_string_face_prop
= Qnil
;
30886 staticpro (&mode_line_string_face_prop
);
30887 Vmode_line_unwind_vector
= Qnil
;
30888 staticpro (&Vmode_line_unwind_vector
);
30890 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30892 help_echo_string
= Qnil
;
30893 staticpro (&help_echo_string
);
30894 help_echo_object
= Qnil
;
30895 staticpro (&help_echo_object
);
30896 help_echo_window
= Qnil
;
30897 staticpro (&help_echo_window
);
30898 previous_help_echo_string
= Qnil
;
30899 staticpro (&previous_help_echo_string
);
30900 help_echo_pos
= -1;
30902 DEFSYM (Qright_to_left
, "right-to-left");
30903 DEFSYM (Qleft_to_right
, "left-to-right");
30904 defsubr (&Sbidi_resolved_levels
);
30906 #ifdef HAVE_WINDOW_SYSTEM
30907 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30908 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30909 For example, if a block cursor is over a tab, it will be drawn as
30910 wide as that tab on the display. */);
30911 x_stretch_cursor_p
= 0;
30914 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30915 doc
: /* Non-nil means highlight trailing whitespace.
30916 The face used for trailing whitespace is `trailing-whitespace'. */);
30917 Vshow_trailing_whitespace
= Qnil
;
30919 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30920 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30921 If the value is t, Emacs highlights non-ASCII chars which have the
30922 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30923 or `escape-glyph' face respectively.
30925 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30926 U+2011 (non-breaking hyphen) are affected.
30928 Any other non-nil value means to display these characters as a escape
30929 glyph followed by an ordinary space or hyphen.
30931 A value of nil means no special handling of these characters. */);
30932 Vnobreak_char_display
= Qt
;
30934 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30935 doc
: /* The pointer shape to show in void text areas.
30936 A value of nil means to show the text pointer. Other options are
30937 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30939 Vvoid_text_area_pointer
= Qarrow
;
30941 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30942 doc
: /* Non-nil means don't actually do any redisplay.
30943 This is used for internal purposes. */);
30944 Vinhibit_redisplay
= Qnil
;
30946 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30947 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30948 Vglobal_mode_string
= Qnil
;
30950 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30951 doc
: /* Marker for where to display an arrow on top of the buffer text.
30952 This must be the beginning of a line in order to work.
30953 See also `overlay-arrow-string'. */);
30954 Voverlay_arrow_position
= Qnil
;
30956 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30957 doc
: /* String to display as an arrow in non-window frames.
30958 See also `overlay-arrow-position'. */);
30959 Voverlay_arrow_string
= build_pure_c_string ("=>");
30961 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30962 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30963 The symbols on this list are examined during redisplay to determine
30964 where to display overlay arrows. */);
30965 Voverlay_arrow_variable_list
30966 = list1 (intern_c_string ("overlay-arrow-position"));
30968 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30969 doc
: /* The number of lines to try scrolling a window by when point moves out.
30970 If that fails to bring point back on frame, point is centered instead.
30971 If this is zero, point is always centered after it moves off frame.
30972 If you want scrolling to always be a line at a time, you should set
30973 `scroll-conservatively' to a large value rather than set this to 1. */);
30975 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30976 doc
: /* Scroll up to this many lines, to bring point back on screen.
30977 If point moves off-screen, redisplay will scroll by up to
30978 `scroll-conservatively' lines in order to bring point just barely
30979 onto the screen again. If that cannot be done, then redisplay
30980 recenters point as usual.
30982 If the value is greater than 100, redisplay will never recenter point,
30983 but will always scroll just enough text to bring point into view, even
30984 if you move far away.
30986 A value of zero means always recenter point if it moves off screen. */);
30987 scroll_conservatively
= 0;
30989 DEFVAR_INT ("scroll-margin", scroll_margin
,
30990 doc
: /* Number of lines of margin at the top and bottom of a window.
30991 Recenter the window whenever point gets within this many lines
30992 of the top or bottom of the window. */);
30995 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30996 doc
: /* Pixels per inch value for non-window system displays.
30997 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30998 Vdisplay_pixels_per_inch
= make_float (72.0);
31001 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31004 DEFVAR_LISP ("truncate-partial-width-windows",
31005 Vtruncate_partial_width_windows
,
31006 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31007 For an integer value, truncate lines in each window narrower than the
31008 full frame width, provided the window width is less than that integer;
31009 otherwise, respect the value of `truncate-lines'.
31011 For any other non-nil value, truncate lines in all windows that do
31012 not span the full frame width.
31014 A value of nil means to respect the value of `truncate-lines'.
31016 If `word-wrap' is enabled, you might want to reduce this. */);
31017 Vtruncate_partial_width_windows
= make_number (50);
31019 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31020 doc
: /* Maximum buffer size for which line number should be displayed.
31021 If the buffer is bigger than this, the line number does not appear
31022 in the mode line. A value of nil means no limit. */);
31023 Vline_number_display_limit
= Qnil
;
31025 DEFVAR_INT ("line-number-display-limit-width",
31026 line_number_display_limit_width
,
31027 doc
: /* Maximum line width (in characters) for line number display.
31028 If the average length of the lines near point is bigger than this, then the
31029 line number may be omitted from the mode line. */);
31030 line_number_display_limit_width
= 200;
31032 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31033 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31034 highlight_nonselected_windows
= 0;
31036 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31037 doc
: /* Non-nil if more than one frame is visible on this display.
31038 Minibuffer-only frames don't count, but iconified frames do.
31039 This variable is not guaranteed to be accurate except while processing
31040 `frame-title-format' and `icon-title-format'. */);
31042 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31043 doc
: /* Template for displaying the title bar of visible frames.
31044 \(Assuming the window manager supports this feature.)
31046 This variable has the same structure as `mode-line-format', except that
31047 the %c and %l constructs are ignored. It is used only on frames for
31048 which no explicit name has been set \(see `modify-frame-parameters'). */);
31050 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31051 doc
: /* Template for displaying the title bar of an iconified frame.
31052 \(Assuming the window manager supports this feature.)
31053 This variable has the same structure as `mode-line-format' (which see),
31054 and is used only on frames for which no explicit name has been set
31055 \(see `modify-frame-parameters'). */);
31057 = Vframe_title_format
31058 = listn (CONSTYPE_PURE
, 3,
31059 intern_c_string ("multiple-frames"),
31060 build_pure_c_string ("%b"),
31061 listn (CONSTYPE_PURE
, 4,
31062 empty_unibyte_string
,
31063 intern_c_string ("invocation-name"),
31064 build_pure_c_string ("@"),
31065 intern_c_string ("system-name")));
31067 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31068 doc
: /* Maximum number of lines to keep in the message log buffer.
31069 If nil, disable message logging. If t, log messages but don't truncate
31070 the buffer when it becomes large. */);
31071 Vmessage_log_max
= make_number (1000);
31073 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31074 doc
: /* Functions called before redisplay, if window sizes have changed.
31075 The value should be a list of functions that take one argument.
31076 Just before redisplay, for each frame, if any of its windows have changed
31077 size since the last redisplay, or have been split or deleted,
31078 all the functions in the list are called, with the frame as argument. */);
31079 Vwindow_size_change_functions
= Qnil
;
31081 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31082 doc
: /* List of functions to call before redisplaying a window with scrolling.
31083 Each function is called with two arguments, the window and its new
31084 display-start position.
31085 These functions are called whenever the `window-start' marker is modified,
31086 either to point into another buffer (e.g. via `set-window-buffer') or another
31087 place in the same buffer.
31088 Note that the value of `window-end' is not valid when these functions are
31091 Warning: Do not use this feature to alter the way the window
31092 is scrolled. It is not designed for that, and such use probably won't
31094 Vwindow_scroll_functions
= Qnil
;
31096 DEFVAR_LISP ("window-text-change-functions",
31097 Vwindow_text_change_functions
,
31098 doc
: /* Functions to call in redisplay when text in the window might change. */);
31099 Vwindow_text_change_functions
= Qnil
;
31101 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31102 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31103 Each function is called with two arguments, the window and the end trigger value.
31104 See `set-window-redisplay-end-trigger'. */);
31105 Vredisplay_end_trigger_functions
= Qnil
;
31107 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31108 doc
: /* Non-nil means autoselect window with mouse pointer.
31109 If nil, do not autoselect windows.
31110 A positive number means delay autoselection by that many seconds: a
31111 window is autoselected only after the mouse has remained in that
31112 window for the duration of the delay.
31113 A negative number has a similar effect, but causes windows to be
31114 autoselected only after the mouse has stopped moving. \(Because of
31115 the way Emacs compares mouse events, you will occasionally wait twice
31116 that time before the window gets selected.\)
31117 Any other value means to autoselect window instantaneously when the
31118 mouse pointer enters it.
31120 Autoselection selects the minibuffer only if it is active, and never
31121 unselects the minibuffer if it is active.
31123 When customizing this variable make sure that the actual value of
31124 `focus-follows-mouse' matches the behavior of your window manager. */);
31125 Vmouse_autoselect_window
= Qnil
;
31127 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31128 doc
: /* Non-nil means automatically resize tool-bars.
31129 This dynamically changes the tool-bar's height to the minimum height
31130 that is needed to make all tool-bar items visible.
31131 If value is `grow-only', the tool-bar's height is only increased
31132 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31133 Vauto_resize_tool_bars
= Qt
;
31135 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31136 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31137 auto_raise_tool_bar_buttons_p
= 1;
31139 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31140 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31141 make_cursor_line_fully_visible_p
= 1;
31143 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31144 doc
: /* Border below tool-bar in pixels.
31145 If an integer, use it as the height of the border.
31146 If it is one of `internal-border-width' or `border-width', use the
31147 value of the corresponding frame parameter.
31148 Otherwise, no border is added below the tool-bar. */);
31149 Vtool_bar_border
= Qinternal_border_width
;
31151 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31152 doc
: /* Margin around tool-bar buttons in pixels.
31153 If an integer, use that for both horizontal and vertical margins.
31154 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31155 HORZ specifying the horizontal margin, and VERT specifying the
31156 vertical margin. */);
31157 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31159 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31160 doc
: /* Relief thickness of tool-bar buttons. */);
31161 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31163 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31164 doc
: /* Tool bar style to use.
31166 image - show images only
31167 text - show text only
31168 both - show both, text below image
31169 both-horiz - show text to the right of the image
31170 text-image-horiz - show text to the left of the image
31171 any other - use system default or image if no system default.
31173 This variable only affects the GTK+ toolkit version of Emacs. */);
31174 Vtool_bar_style
= Qnil
;
31176 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31177 doc
: /* Maximum number of characters a label can have to be shown.
31178 The tool bar style must also show labels for this to have any effect, see
31179 `tool-bar-style'. */);
31180 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31182 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31183 doc
: /* List of functions to call to fontify regions of text.
31184 Each function is called with one argument POS. Functions must
31185 fontify a region starting at POS in the current buffer, and give
31186 fontified regions the property `fontified'. */);
31187 Vfontification_functions
= Qnil
;
31188 Fmake_variable_buffer_local (Qfontification_functions
);
31190 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31191 unibyte_display_via_language_environment
,
31192 doc
: /* Non-nil means display unibyte text according to language environment.
31193 Specifically, this means that raw bytes in the range 160-255 decimal
31194 are displayed by converting them to the equivalent multibyte characters
31195 according to the current language environment. As a result, they are
31196 displayed according to the current fontset.
31198 Note that this variable affects only how these bytes are displayed,
31199 but does not change the fact they are interpreted as raw bytes. */);
31200 unibyte_display_via_language_environment
= 0;
31202 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31203 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31204 If a float, it specifies a fraction of the mini-window frame's height.
31205 If an integer, it specifies a number of lines. */);
31206 Vmax_mini_window_height
= make_float (0.25);
31208 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31209 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31210 A value of nil means don't automatically resize mini-windows.
31211 A value of t means resize them to fit the text displayed in them.
31212 A value of `grow-only', the default, means let mini-windows grow only;
31213 they return to their normal size when the minibuffer is closed, or the
31214 echo area becomes empty. */);
31215 Vresize_mini_windows
= Qgrow_only
;
31217 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31218 doc
: /* Alist specifying how to blink the cursor off.
31219 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31220 `cursor-type' frame-parameter or variable equals ON-STATE,
31221 comparing using `equal', Emacs uses OFF-STATE to specify
31222 how to blink it off. ON-STATE and OFF-STATE are values for
31223 the `cursor-type' frame parameter.
31225 If a frame's ON-STATE has no entry in this list,
31226 the frame's other specifications determine how to blink the cursor off. */);
31227 Vblink_cursor_alist
= Qnil
;
31229 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31230 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31231 If non-nil, windows are automatically scrolled horizontally to make
31232 point visible. */);
31233 automatic_hscrolling_p
= 1;
31234 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31236 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31237 doc
: /* How many columns away from the window edge point is allowed to get
31238 before automatic hscrolling will horizontally scroll the window. */);
31239 hscroll_margin
= 5;
31241 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31242 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31243 When point is less than `hscroll-margin' columns from the window
31244 edge, automatic hscrolling will scroll the window by the amount of columns
31245 determined by this variable. If its value is a positive integer, scroll that
31246 many columns. If it's a positive floating-point number, it specifies the
31247 fraction of the window's width to scroll. If it's nil or zero, point will be
31248 centered horizontally after the scroll. Any other value, including negative
31249 numbers, are treated as if the value were zero.
31251 Automatic hscrolling always moves point outside the scroll margin, so if
31252 point was more than scroll step columns inside the margin, the window will
31253 scroll more than the value given by the scroll step.
31255 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31256 and `scroll-right' overrides this variable's effect. */);
31257 Vhscroll_step
= make_number (0);
31259 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31260 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31261 Bind this around calls to `message' to let it take effect. */);
31262 message_truncate_lines
= 0;
31264 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31265 doc
: /* Normal hook run to update the menu bar definitions.
31266 Redisplay runs this hook before it redisplays the menu bar.
31267 This is used to update menus such as Buffers, whose contents depend on
31269 Vmenu_bar_update_hook
= Qnil
;
31271 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31272 doc
: /* Frame for which we are updating a menu.
31273 The enable predicate for a menu binding should check this variable. */);
31274 Vmenu_updating_frame
= Qnil
;
31276 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31277 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31278 inhibit_menubar_update
= 0;
31280 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31281 doc
: /* Prefix prepended to all continuation lines at display time.
31282 The value may be a string, an image, or a stretch-glyph; it is
31283 interpreted in the same way as the value of a `display' text property.
31285 This variable is overridden by any `wrap-prefix' text or overlay
31288 To add a prefix to non-continuation lines, use `line-prefix'. */);
31289 Vwrap_prefix
= Qnil
;
31290 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31291 Fmake_variable_buffer_local (Qwrap_prefix
);
31293 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31294 doc
: /* Prefix prepended to all non-continuation lines at display time.
31295 The value may be a string, an image, or a stretch-glyph; it is
31296 interpreted in the same way as the value of a `display' text property.
31298 This variable is overridden by any `line-prefix' text or overlay
31301 To add a prefix to continuation lines, use `wrap-prefix'. */);
31302 Vline_prefix
= Qnil
;
31303 DEFSYM (Qline_prefix
, "line-prefix");
31304 Fmake_variable_buffer_local (Qline_prefix
);
31306 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31307 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31308 inhibit_eval_during_redisplay
= 0;
31310 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31311 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31312 inhibit_free_realized_faces
= 0;
31314 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31315 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31316 Intended for use during debugging and for testing bidi display;
31317 see biditest.el in the test suite. */);
31318 inhibit_bidi_mirroring
= 0;
31321 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31322 doc
: /* Inhibit try_window_id display optimization. */);
31323 inhibit_try_window_id
= 0;
31325 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31326 doc
: /* Inhibit try_window_reusing display optimization. */);
31327 inhibit_try_window_reusing
= 0;
31329 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31330 doc
: /* Inhibit try_cursor_movement display optimization. */);
31331 inhibit_try_cursor_movement
= 0;
31332 #endif /* GLYPH_DEBUG */
31334 DEFVAR_INT ("overline-margin", overline_margin
,
31335 doc
: /* Space between overline and text, in pixels.
31336 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31337 margin to the character height. */);
31338 overline_margin
= 2;
31340 DEFVAR_INT ("underline-minimum-offset",
31341 underline_minimum_offset
,
31342 doc
: /* Minimum distance between baseline and underline.
31343 This can improve legibility of underlined text at small font sizes,
31344 particularly when using variable `x-use-underline-position-properties'
31345 with fonts that specify an UNDERLINE_POSITION relatively close to the
31346 baseline. The default value is 1. */);
31347 underline_minimum_offset
= 1;
31349 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31350 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31351 This feature only works when on a window system that can change
31352 cursor shapes. */);
31353 display_hourglass_p
= 1;
31355 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31356 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31357 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31359 #ifdef HAVE_WINDOW_SYSTEM
31360 hourglass_atimer
= NULL
;
31361 hourglass_shown_p
= 0;
31362 #endif /* HAVE_WINDOW_SYSTEM */
31364 /* Name of the face used to display glyphless characters. */
31365 DEFSYM (Qglyphless_char
, "glyphless-char");
31367 /* Method symbols for Vglyphless_char_display. */
31368 DEFSYM (Qhex_code
, "hex-code");
31369 DEFSYM (Qempty_box
, "empty-box");
31370 DEFSYM (Qthin_space
, "thin-space");
31371 DEFSYM (Qzero_width
, "zero-width");
31373 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31374 doc
: /* Function run just before redisplay.
31375 It is called with one argument, which is the set of windows that are to
31376 be redisplayed. This set can be nil (meaning, only the selected window),
31377 or t (meaning all windows). */);
31378 Vpre_redisplay_function
= intern ("ignore");
31380 /* Symbol for the purpose of Vglyphless_char_display. */
31381 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31382 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31384 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31385 doc
: /* Char-table defining glyphless characters.
31386 Each element, if non-nil, should be one of the following:
31387 an ASCII acronym string: display this string in a box
31388 `hex-code': display the hexadecimal code of a character in a box
31389 `empty-box': display as an empty box
31390 `thin-space': display as 1-pixel width space
31391 `zero-width': don't display
31392 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31393 display method for graphical terminals and text terminals respectively.
31394 GRAPHICAL and TEXT should each have one of the values listed above.
31396 The char-table has one extra slot to control the display of a character for
31397 which no font is found. This slot only takes effect on graphical terminals.
31398 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31399 `thin-space'. The default is `empty-box'.
31401 If a character has a non-nil entry in an active display table, the
31402 display table takes effect; in this case, Emacs does not consult
31403 `glyphless-char-display' at all. */);
31404 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31405 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31408 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31409 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31410 Vdebug_on_message
= Qnil
;
31412 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31414 Vredisplay__all_windows_cause
31415 = Fmake_vector (make_number (100), make_number (0));
31417 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31419 Vredisplay__mode_lines_cause
31420 = Fmake_vector (make_number (100), make_number (0));
31424 /* Initialize this module when Emacs starts. */
31429 CHARPOS (this_line_start_pos
) = 0;
31431 if (!noninteractive
)
31433 struct window
*m
= XWINDOW (minibuf_window
);
31434 Lisp_Object frame
= m
->frame
;
31435 struct frame
*f
= XFRAME (frame
);
31436 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31437 struct window
*r
= XWINDOW (root
);
31440 echo_area_window
= minibuf_window
;
31442 r
->top_line
= FRAME_TOP_MARGIN (f
);
31443 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31444 r
->total_cols
= FRAME_COLS (f
);
31445 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31446 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31447 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31449 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31450 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31451 m
->total_cols
= FRAME_COLS (f
);
31452 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31453 m
->total_lines
= 1;
31454 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31456 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31457 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31458 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31460 /* The default ellipsis glyphs `...'. */
31461 for (i
= 0; i
< 3; ++i
)
31462 default_invis_vector
[i
] = make_number ('.');
31466 /* Allocate the buffer for frame titles.
31467 Also used for `format-mode-line'. */
31469 mode_line_noprop_buf
= xmalloc (size
);
31470 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31471 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31472 mode_line_target
= MODE_LINE_DISPLAY
;
31475 help_echo_showing_p
= 0;
31478 #ifdef HAVE_WINDOW_SYSTEM
31480 /* Platform-independent portion of hourglass implementation. */
31482 /* Timer function of hourglass_atimer. */
31485 show_hourglass (struct atimer
*timer
)
31487 /* The timer implementation will cancel this timer automatically
31488 after this function has run. Set hourglass_atimer to null
31489 so that we know the timer doesn't have to be canceled. */
31490 hourglass_atimer
= NULL
;
31492 if (!hourglass_shown_p
)
31494 Lisp_Object tail
, frame
;
31498 FOR_EACH_FRAME (tail
, frame
)
31500 struct frame
*f
= XFRAME (frame
);
31502 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31503 && FRAME_RIF (f
)->show_hourglass
)
31504 FRAME_RIF (f
)->show_hourglass (f
);
31507 hourglass_shown_p
= 1;
31512 /* Cancel a currently active hourglass timer, and start a new one. */
31515 start_hourglass (void)
31517 struct timespec delay
;
31519 cancel_hourglass ();
31521 if (INTEGERP (Vhourglass_delay
)
31522 && XINT (Vhourglass_delay
) > 0)
31523 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31524 TYPE_MAXIMUM (time_t)),
31526 else if (FLOATP (Vhourglass_delay
)
31527 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31528 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31530 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31532 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31533 show_hourglass
, NULL
);
31536 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31540 cancel_hourglass (void)
31542 if (hourglass_atimer
)
31544 cancel_atimer (hourglass_atimer
);
31545 hourglass_atimer
= NULL
;
31548 if (hourglass_shown_p
)
31550 Lisp_Object tail
, frame
;
31554 FOR_EACH_FRAME (tail
, frame
)
31556 struct frame
*f
= XFRAME (frame
);
31558 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31559 && FRAME_RIF (f
)->hide_hourglass
)
31560 FRAME_RIF (f
)->hide_hourglass (f
);
31562 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31563 else if (!FRAME_W32_P (f
))
31564 w32_arrow_cursor ();
31568 hourglass_shown_p
= 0;
31573 #endif /* HAVE_WINDOW_SYSTEM */