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_count
&& !inhibit_free_realized_faces
)
2735 face_change_count
= 0;
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 0, 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
),
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
,
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 || valid_xwidget_spec_p(value
)
5142 if (valid_p
&& !display_replaced_p
)
5148 /* Callers need to know whether the display spec is any kind
5149 of `(space ...)' spec that is about to affect text-area
5151 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5156 /* Save current settings of IT so that we can restore them
5157 when we are finished with the glyph property value. */
5158 push_it (it
, position
);
5159 it
->from_overlay
= overlay
;
5160 it
->from_disp_prop_p
= true;
5162 if (NILP (location
))
5163 it
->area
= TEXT_AREA
;
5164 else if (EQ (location
, Qleft_margin
))
5165 it
->area
= LEFT_MARGIN_AREA
;
5167 it
->area
= RIGHT_MARGIN_AREA
;
5169 if (STRINGP (value
))
5172 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5173 it
->current
.overlay_string_index
= -1;
5174 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5175 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5176 it
->method
= GET_FROM_STRING
;
5177 it
->stop_charpos
= 0;
5179 it
->base_level_stop
= 0;
5180 it
->string_from_display_prop_p
= true;
5181 /* Say that we haven't consumed the characters with
5182 `display' property yet. The call to pop_it in
5183 set_iterator_to_next will clean this up. */
5184 if (BUFFERP (object
))
5185 *position
= start_pos
;
5187 /* Force paragraph direction to be that of the parent
5188 object. If the parent object's paragraph direction is
5189 not yet determined, default to L2R. */
5190 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5191 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5193 it
->paragraph_embedding
= L2R
;
5195 /* Set up the bidi iterator for this display string. */
5198 it
->bidi_it
.string
.lstring
= it
->string
;
5199 it
->bidi_it
.string
.s
= NULL
;
5200 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5201 it
->bidi_it
.string
.bufpos
= bufpos
;
5202 it
->bidi_it
.string
.from_disp_str
= 1;
5203 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5204 it
->bidi_it
.w
= it
->w
;
5205 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5208 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5210 it
->method
= GET_FROM_STRETCH
;
5212 *position
= it
->position
= start_pos
;
5213 retval
= 1 + (it
->area
== TEXT_AREA
);
5215 #ifdef HAVE_XWIDGETS
5216 else if (valid_xwidget_spec_p(value
))
5218 it
->what
= IT_XWIDGET
;
5219 it
->method
= GET_FROM_XWIDGET
;
5220 it
->position
= start_pos
;
5221 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5222 *position
= start_pos
;
5224 it
->xwidget
= lookup_xwidget(value
);
5227 #ifdef HAVE_WINDOW_SYSTEM
5230 it
->what
= IT_IMAGE
;
5231 it
->image_id
= lookup_image (it
->f
, value
);
5232 it
->position
= start_pos
;
5233 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5234 it
->method
= GET_FROM_IMAGE
;
5236 /* Say that we haven't consumed the characters with
5237 `display' property yet. The call to pop_it in
5238 set_iterator_to_next will clean this up. */
5239 *position
= start_pos
;
5241 #endif /* HAVE_WINDOW_SYSTEM */
5246 /* Invalid property or property not supported. Restore
5247 POSITION to what it was before. */
5248 *position
= start_pos
;
5252 /* Check if PROP is a display property value whose text should be
5253 treated as intangible. OVERLAY is the overlay from which PROP
5254 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5255 specify the buffer position covered by PROP. */
5258 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5259 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5261 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5262 struct text_pos position
;
5264 SET_TEXT_POS (position
, charpos
, bytepos
);
5265 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5266 &position
, charpos
, frame_window_p
);
5270 /* Return 1 if PROP is a display sub-property value containing STRING.
5272 Implementation note: this and the following function are really
5273 special cases of handle_display_spec and
5274 handle_single_display_spec, and should ideally use the same code.
5275 Until they do, these two pairs must be consistent and must be
5276 modified in sync. */
5279 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5281 if (EQ (string
, prop
))
5284 /* Skip over `when FORM'. */
5285 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5290 /* Actually, the condition following `when' should be eval'ed,
5291 like handle_single_display_spec does, and we should return
5292 zero if it evaluates to nil. However, this function is
5293 called only when the buffer was already displayed and some
5294 glyph in the glyph matrix was found to come from a display
5295 string. Therefore, the condition was already evaluated, and
5296 the result was non-nil, otherwise the display string wouldn't
5297 have been displayed and we would have never been called for
5298 this property. Thus, we can skip the evaluation and assume
5299 its result is non-nil. */
5304 /* Skip over `margin LOCATION'. */
5305 if (EQ (XCAR (prop
), Qmargin
))
5316 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5320 /* Return 1 if STRING appears in the `display' property PROP. */
5323 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5326 && !EQ (XCAR (prop
), Qwhen
)
5327 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5329 /* A list of sub-properties. */
5330 while (CONSP (prop
))
5332 if (single_display_spec_string_p (XCAR (prop
), string
))
5337 else if (VECTORP (prop
))
5339 /* A vector of sub-properties. */
5341 for (i
= 0; i
< ASIZE (prop
); ++i
)
5342 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5346 return single_display_spec_string_p (prop
, string
);
5351 /* Look for STRING in overlays and text properties in the current
5352 buffer, between character positions FROM and TO (excluding TO).
5353 BACK_P non-zero means look back (in this case, TO is supposed to be
5355 Value is the first character position where STRING was found, or
5356 zero if it wasn't found before hitting TO.
5358 This function may only use code that doesn't eval because it is
5359 called asynchronously from note_mouse_highlight. */
5362 string_buffer_position_lim (Lisp_Object string
,
5363 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5365 Lisp_Object limit
, prop
, pos
;
5368 pos
= make_number (max (from
, BEGV
));
5370 if (!back_p
) /* looking forward */
5372 limit
= make_number (min (to
, ZV
));
5373 while (!found
&& !EQ (pos
, limit
))
5375 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5376 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5379 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5383 else /* looking back */
5385 limit
= make_number (max (to
, BEGV
));
5386 while (!found
&& !EQ (pos
, limit
))
5388 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5389 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5392 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5397 return found
? XINT (pos
) : 0;
5400 /* Determine which buffer position in current buffer STRING comes from.
5401 AROUND_CHARPOS is an approximate position where it could come from.
5402 Value is the buffer position or 0 if it couldn't be determined.
5404 This function is necessary because we don't record buffer positions
5405 in glyphs generated from strings (to keep struct glyph small).
5406 This function may only use code that doesn't eval because it is
5407 called asynchronously from note_mouse_highlight. */
5410 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5412 const int MAX_DISTANCE
= 1000;
5413 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5414 around_charpos
+ MAX_DISTANCE
,
5418 found
= string_buffer_position_lim (string
, around_charpos
,
5419 around_charpos
- MAX_DISTANCE
, 1);
5425 /***********************************************************************
5426 `composition' property
5427 ***********************************************************************/
5429 /* Set up iterator IT from `composition' property at its current
5430 position. Called from handle_stop. */
5432 static enum prop_handled
5433 handle_composition_prop (struct it
*it
)
5435 Lisp_Object prop
, string
;
5436 ptrdiff_t pos
, pos_byte
, start
, end
;
5438 if (STRINGP (it
->string
))
5442 pos
= IT_STRING_CHARPOS (*it
);
5443 pos_byte
= IT_STRING_BYTEPOS (*it
);
5444 string
= it
->string
;
5445 s
= SDATA (string
) + pos_byte
;
5446 it
->c
= STRING_CHAR (s
);
5450 pos
= IT_CHARPOS (*it
);
5451 pos_byte
= IT_BYTEPOS (*it
);
5453 it
->c
= FETCH_CHAR (pos_byte
);
5456 /* If there's a valid composition and point is not inside of the
5457 composition (in the case that the composition is from the current
5458 buffer), draw a glyph composed from the composition components. */
5459 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5460 && composition_valid_p (start
, end
, prop
)
5461 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5464 /* As we can't handle this situation (perhaps font-lock added
5465 a new composition), we just return here hoping that next
5466 redisplay will detect this composition much earlier. */
5467 return HANDLED_NORMALLY
;
5470 if (STRINGP (it
->string
))
5471 pos_byte
= string_char_to_byte (it
->string
, start
);
5473 pos_byte
= CHAR_TO_BYTE (start
);
5475 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5478 if (it
->cmp_it
.id
>= 0)
5481 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5482 it
->cmp_it
.nglyphs
= -1;
5486 return HANDLED_NORMALLY
;
5491 /***********************************************************************
5493 ***********************************************************************/
5495 /* The following structure is used to record overlay strings for
5496 later sorting in load_overlay_strings. */
5498 struct overlay_entry
5500 Lisp_Object overlay
;
5507 /* Set up iterator IT from overlay strings at its current position.
5508 Called from handle_stop. */
5510 static enum prop_handled
5511 handle_overlay_change (struct it
*it
)
5513 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5514 return HANDLED_RECOMPUTE_PROPS
;
5516 return HANDLED_NORMALLY
;
5520 /* Set up the next overlay string for delivery by IT, if there is an
5521 overlay string to deliver. Called by set_iterator_to_next when the
5522 end of the current overlay string is reached. If there are more
5523 overlay strings to display, IT->string and
5524 IT->current.overlay_string_index are set appropriately here.
5525 Otherwise IT->string is set to nil. */
5528 next_overlay_string (struct it
*it
)
5530 ++it
->current
.overlay_string_index
;
5531 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5533 /* No more overlay strings. Restore IT's settings to what
5534 they were before overlay strings were processed, and
5535 continue to deliver from current_buffer. */
5537 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5540 || (NILP (it
->string
)
5541 && it
->method
== GET_FROM_BUFFER
5542 && it
->stop_charpos
>= BEGV
5543 && it
->stop_charpos
<= it
->end_charpos
));
5544 it
->current
.overlay_string_index
= -1;
5545 it
->n_overlay_strings
= 0;
5546 it
->overlay_strings_charpos
= -1;
5547 /* If there's an empty display string on the stack, pop the
5548 stack, to resync the bidi iterator with IT's position. Such
5549 empty strings are pushed onto the stack in
5550 get_overlay_strings_1. */
5551 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5554 /* If we're at the end of the buffer, record that we have
5555 processed the overlay strings there already, so that
5556 next_element_from_buffer doesn't try it again. */
5557 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5558 it
->overlay_strings_at_end_processed_p
= true;
5562 /* There are more overlay strings to process. If
5563 IT->current.overlay_string_index has advanced to a position
5564 where we must load IT->overlay_strings with more strings, do
5565 it. We must load at the IT->overlay_strings_charpos where
5566 IT->n_overlay_strings was originally computed; when invisible
5567 text is present, this might not be IT_CHARPOS (Bug#7016). */
5568 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5570 if (it
->current
.overlay_string_index
&& i
== 0)
5571 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5573 /* Initialize IT to deliver display elements from the overlay
5575 it
->string
= it
->overlay_strings
[i
];
5576 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5577 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5578 it
->method
= GET_FROM_STRING
;
5579 it
->stop_charpos
= 0;
5580 it
->end_charpos
= SCHARS (it
->string
);
5581 if (it
->cmp_it
.stop_pos
>= 0)
5582 it
->cmp_it
.stop_pos
= 0;
5584 it
->base_level_stop
= 0;
5586 /* Set up the bidi iterator for this overlay string. */
5589 it
->bidi_it
.string
.lstring
= it
->string
;
5590 it
->bidi_it
.string
.s
= NULL
;
5591 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5592 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5593 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5594 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5595 it
->bidi_it
.w
= it
->w
;
5596 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5604 /* Compare two overlay_entry structures E1 and E2. Used as a
5605 comparison function for qsort in load_overlay_strings. Overlay
5606 strings for the same position are sorted so that
5608 1. All after-strings come in front of before-strings, except
5609 when they come from the same overlay.
5611 2. Within after-strings, strings are sorted so that overlay strings
5612 from overlays with higher priorities come first.
5614 2. Within before-strings, strings are sorted so that overlay
5615 strings from overlays with higher priorities come last.
5617 Value is analogous to strcmp. */
5621 compare_overlay_entries (const void *e1
, const void *e2
)
5623 struct overlay_entry
const *entry1
= e1
;
5624 struct overlay_entry
const *entry2
= e2
;
5627 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5629 /* Let after-strings appear in front of before-strings if
5630 they come from different overlays. */
5631 if (EQ (entry1
->overlay
, entry2
->overlay
))
5632 result
= entry1
->after_string_p
? 1 : -1;
5634 result
= entry1
->after_string_p
? -1 : 1;
5636 else if (entry1
->priority
!= entry2
->priority
)
5638 if (entry1
->after_string_p
)
5639 /* After-strings sorted in order of decreasing priority. */
5640 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5642 /* Before-strings sorted in order of increasing priority. */
5643 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5652 /* Load the vector IT->overlay_strings with overlay strings from IT's
5653 current buffer position, or from CHARPOS if that is > 0. Set
5654 IT->n_overlays to the total number of overlay strings found.
5656 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5657 a time. On entry into load_overlay_strings,
5658 IT->current.overlay_string_index gives the number of overlay
5659 strings that have already been loaded by previous calls to this
5662 IT->add_overlay_start contains an additional overlay start
5663 position to consider for taking overlay strings from, if non-zero.
5664 This position comes into play when the overlay has an `invisible'
5665 property, and both before and after-strings. When we've skipped to
5666 the end of the overlay, because of its `invisible' property, we
5667 nevertheless want its before-string to appear.
5668 IT->add_overlay_start will contain the overlay start position
5671 Overlay strings are sorted so that after-string strings come in
5672 front of before-string strings. Within before and after-strings,
5673 strings are sorted by overlay priority. See also function
5674 compare_overlay_entries. */
5677 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5679 Lisp_Object overlay
, window
, str
, invisible
;
5680 struct Lisp_Overlay
*ov
;
5681 ptrdiff_t start
, end
;
5682 ptrdiff_t n
= 0, i
, j
;
5684 struct overlay_entry entriesbuf
[20];
5685 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5686 struct overlay_entry
*entries
= entriesbuf
;
5690 charpos
= IT_CHARPOS (*it
);
5692 /* Append the overlay string STRING of overlay OVERLAY to vector
5693 `entries' which has size `size' and currently contains `n'
5694 elements. AFTER_P non-zero means STRING is an after-string of
5696 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5699 Lisp_Object priority; \
5703 struct overlay_entry *old = entries; \
5704 SAFE_NALLOCA (entries, 2, size); \
5705 memcpy (entries, old, size * sizeof *entries); \
5709 entries[n].string = (STRING); \
5710 entries[n].overlay = (OVERLAY); \
5711 priority = Foverlay_get ((OVERLAY), Qpriority); \
5712 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5713 entries[n].after_string_p = (AFTER_P); \
5718 /* Process overlay before the overlay center. */
5719 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5721 XSETMISC (overlay
, ov
);
5722 eassert (OVERLAYP (overlay
));
5723 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5724 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5729 /* Skip this overlay if it doesn't start or end at IT's current
5731 if (end
!= charpos
&& start
!= charpos
)
5734 /* Skip this overlay if it doesn't apply to IT->w. */
5735 window
= Foverlay_get (overlay
, Qwindow
);
5736 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5739 /* If the text ``under'' the overlay is invisible, both before-
5740 and after-strings from this overlay are visible; start and
5741 end position are indistinguishable. */
5742 invisible
= Foverlay_get (overlay
, Qinvisible
);
5743 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5745 /* If overlay has a non-empty before-string, record it. */
5746 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5747 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5749 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5751 /* If overlay has a non-empty after-string, record it. */
5752 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5753 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5755 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5758 /* Process overlays after the overlay center. */
5759 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5761 XSETMISC (overlay
, ov
);
5762 eassert (OVERLAYP (overlay
));
5763 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5764 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5766 if (start
> charpos
)
5769 /* Skip this overlay if it doesn't start or end at IT's current
5771 if (end
!= charpos
&& start
!= charpos
)
5774 /* Skip this overlay if it doesn't apply to IT->w. */
5775 window
= Foverlay_get (overlay
, Qwindow
);
5776 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5779 /* If the text ``under'' the overlay is invisible, it has a zero
5780 dimension, and both before- and after-strings apply. */
5781 invisible
= Foverlay_get (overlay
, Qinvisible
);
5782 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5784 /* If overlay has a non-empty before-string, record it. */
5785 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5786 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5788 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5790 /* If overlay has a non-empty after-string, record it. */
5791 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5792 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5794 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5797 #undef RECORD_OVERLAY_STRING
5801 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5803 /* Record number of overlay strings, and where we computed it. */
5804 it
->n_overlay_strings
= n
;
5805 it
->overlay_strings_charpos
= charpos
;
5807 /* IT->current.overlay_string_index is the number of overlay strings
5808 that have already been consumed by IT. Copy some of the
5809 remaining overlay strings to IT->overlay_strings. */
5811 j
= it
->current
.overlay_string_index
;
5812 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5814 it
->overlay_strings
[i
] = entries
[j
].string
;
5815 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5823 /* Get the first chunk of overlay strings at IT's current buffer
5824 position, or at CHARPOS if that is > 0. Value is non-zero if at
5825 least one overlay string was found. */
5828 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5830 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5831 process. This fills IT->overlay_strings with strings, and sets
5832 IT->n_overlay_strings to the total number of strings to process.
5833 IT->pos.overlay_string_index has to be set temporarily to zero
5834 because load_overlay_strings needs this; it must be set to -1
5835 when no overlay strings are found because a zero value would
5836 indicate a position in the first overlay string. */
5837 it
->current
.overlay_string_index
= 0;
5838 load_overlay_strings (it
, charpos
);
5840 /* If we found overlay strings, set up IT to deliver display
5841 elements from the first one. Otherwise set up IT to deliver
5842 from current_buffer. */
5843 if (it
->n_overlay_strings
)
5845 /* Make sure we know settings in current_buffer, so that we can
5846 restore meaningful values when we're done with the overlay
5849 compute_stop_pos (it
);
5850 eassert (it
->face_id
>= 0);
5852 /* Save IT's settings. They are restored after all overlay
5853 strings have been processed. */
5854 eassert (!compute_stop_p
|| it
->sp
== 0);
5856 /* When called from handle_stop, there might be an empty display
5857 string loaded. In that case, don't bother saving it. But
5858 don't use this optimization with the bidi iterator, since we
5859 need the corresponding pop_it call to resync the bidi
5860 iterator's position with IT's position, after we are done
5861 with the overlay strings. (The corresponding call to pop_it
5862 in case of an empty display string is in
5863 next_overlay_string.) */
5865 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5868 /* Set up IT to deliver display elements from the first overlay
5870 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5871 it
->string
= it
->overlay_strings
[0];
5872 it
->from_overlay
= Qnil
;
5873 it
->stop_charpos
= 0;
5874 eassert (STRINGP (it
->string
));
5875 it
->end_charpos
= SCHARS (it
->string
);
5877 it
->base_level_stop
= 0;
5878 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5879 it
->method
= GET_FROM_STRING
;
5880 it
->from_disp_prop_p
= 0;
5882 /* Force paragraph direction to be that of the parent
5884 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5885 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5887 it
->paragraph_embedding
= L2R
;
5889 /* Set up the bidi iterator for this overlay string. */
5892 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5894 it
->bidi_it
.string
.lstring
= it
->string
;
5895 it
->bidi_it
.string
.s
= NULL
;
5896 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5897 it
->bidi_it
.string
.bufpos
= pos
;
5898 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5899 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5900 it
->bidi_it
.w
= it
->w
;
5901 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5906 it
->current
.overlay_string_index
= -1;
5911 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5914 it
->method
= GET_FROM_BUFFER
;
5916 (void) get_overlay_strings_1 (it
, charpos
, 1);
5920 /* Value is non-zero if we found at least one overlay string. */
5921 return STRINGP (it
->string
);
5926 /***********************************************************************
5927 Saving and restoring state
5928 ***********************************************************************/
5930 /* Save current settings of IT on IT->stack. Called, for example,
5931 before setting up IT for an overlay string, to be able to restore
5932 IT's settings to what they were after the overlay string has been
5933 processed. If POSITION is non-NULL, it is the position to save on
5934 the stack instead of IT->position. */
5937 push_it (struct it
*it
, struct text_pos
*position
)
5939 struct iterator_stack_entry
*p
;
5941 eassert (it
->sp
< IT_STACK_SIZE
);
5942 p
= it
->stack
+ it
->sp
;
5944 p
->stop_charpos
= it
->stop_charpos
;
5945 p
->prev_stop
= it
->prev_stop
;
5946 p
->base_level_stop
= it
->base_level_stop
;
5947 p
->cmp_it
= it
->cmp_it
;
5948 eassert (it
->face_id
>= 0);
5949 p
->face_id
= it
->face_id
;
5950 p
->string
= it
->string
;
5951 p
->method
= it
->method
;
5952 p
->from_overlay
= it
->from_overlay
;
5955 case GET_FROM_IMAGE
:
5956 p
->u
.image
.object
= it
->object
;
5957 p
->u
.image
.image_id
= it
->image_id
;
5958 p
->u
.image
.slice
= it
->slice
;
5960 case GET_FROM_STRETCH
:
5961 p
->u
.stretch
.object
= it
->object
;
5963 #ifdef HAVE_XWIDGETS
5964 case GET_FROM_XWIDGET
:
5965 p
->u
.xwidget
.object
= it
->object
;
5969 p
->position
= position
? *position
: it
->position
;
5970 p
->current
= it
->current
;
5971 p
->end_charpos
= it
->end_charpos
;
5972 p
->string_nchars
= it
->string_nchars
;
5974 p
->multibyte_p
= it
->multibyte_p
;
5975 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5976 p
->space_width
= it
->space_width
;
5977 p
->font_height
= it
->font_height
;
5978 p
->voffset
= it
->voffset
;
5979 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5980 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5981 p
->display_ellipsis_p
= 0;
5982 p
->line_wrap
= it
->line_wrap
;
5983 p
->bidi_p
= it
->bidi_p
;
5984 p
->paragraph_embedding
= it
->paragraph_embedding
;
5985 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5988 /* Save the state of the bidi iterator as well. */
5990 bidi_push_it (&it
->bidi_it
);
5994 iterate_out_of_display_property (struct it
*it
)
5996 int buffer_p
= !STRINGP (it
->string
);
5997 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5998 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6000 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6002 /* Maybe initialize paragraph direction. If we are at the beginning
6003 of a new paragraph, next_element_from_buffer may not have a
6004 chance to do that. */
6005 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6006 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6007 /* prev_stop can be zero, so check against BEGV as well. */
6008 while (it
->bidi_it
.charpos
>= bob
6009 && it
->prev_stop
<= it
->bidi_it
.charpos
6010 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6011 && it
->bidi_it
.charpos
< eob
)
6012 bidi_move_to_visually_next (&it
->bidi_it
);
6013 /* Record the stop_pos we just crossed, for when we cross it
6015 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6016 it
->prev_stop
= CHARPOS (it
->position
);
6017 /* If we ended up not where pop_it put us, resync IT's
6018 positional members with the bidi iterator. */
6019 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6020 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6022 it
->current
.pos
= it
->position
;
6024 it
->current
.string_pos
= it
->position
;
6027 /* Restore IT's settings from IT->stack. Called, for example, when no
6028 more overlay strings must be processed, and we return to delivering
6029 display elements from a buffer, or when the end of a string from a
6030 `display' property is reached and we return to delivering display
6031 elements from an overlay string, or from a buffer. */
6034 pop_it (struct it
*it
)
6036 struct iterator_stack_entry
*p
;
6037 int from_display_prop
= it
->from_disp_prop_p
;
6039 eassert (it
->sp
> 0);
6041 p
= it
->stack
+ it
->sp
;
6042 it
->stop_charpos
= p
->stop_charpos
;
6043 it
->prev_stop
= p
->prev_stop
;
6044 it
->base_level_stop
= p
->base_level_stop
;
6045 it
->cmp_it
= p
->cmp_it
;
6046 it
->face_id
= p
->face_id
;
6047 it
->current
= p
->current
;
6048 it
->position
= p
->position
;
6049 it
->string
= p
->string
;
6050 it
->from_overlay
= p
->from_overlay
;
6051 if (NILP (it
->string
))
6052 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6053 it
->method
= p
->method
;
6056 case GET_FROM_IMAGE
:
6057 it
->image_id
= p
->u
.image
.image_id
;
6058 it
->object
= p
->u
.image
.object
;
6059 it
->slice
= p
->u
.image
.slice
;
6061 #ifdef HAVE_XWIDGETS
6062 case GET_FROM_XWIDGET
:
6063 it
->object
= p
->u
.xwidget
.object
;
6066 case GET_FROM_STRETCH
:
6067 it
->object
= p
->u
.stretch
.object
;
6069 case GET_FROM_BUFFER
:
6070 it
->object
= it
->w
->contents
;
6072 case GET_FROM_STRING
:
6074 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6076 /* Restore the face_box_p flag, since it could have been
6077 overwritten by the face of the object that we just finished
6080 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6081 it
->object
= it
->string
;
6084 case GET_FROM_DISPLAY_VECTOR
:
6086 it
->method
= GET_FROM_C_STRING
;
6087 else if (STRINGP (it
->string
))
6088 it
->method
= GET_FROM_STRING
;
6091 it
->method
= GET_FROM_BUFFER
;
6092 it
->object
= it
->w
->contents
;
6095 it
->end_charpos
= p
->end_charpos
;
6096 it
->string_nchars
= p
->string_nchars
;
6098 it
->multibyte_p
= p
->multibyte_p
;
6099 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6100 it
->space_width
= p
->space_width
;
6101 it
->font_height
= p
->font_height
;
6102 it
->voffset
= p
->voffset
;
6103 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6104 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6105 it
->line_wrap
= p
->line_wrap
;
6106 it
->bidi_p
= p
->bidi_p
;
6107 it
->paragraph_embedding
= p
->paragraph_embedding
;
6108 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6111 bidi_pop_it (&it
->bidi_it
);
6112 /* Bidi-iterate until we get out of the portion of text, if any,
6113 covered by a `display' text property or by an overlay with
6114 `display' property. (We cannot just jump there, because the
6115 internal coherency of the bidi iterator state can not be
6116 preserved across such jumps.) We also must determine the
6117 paragraph base direction if the overlay we just processed is
6118 at the beginning of a new paragraph. */
6119 if (from_display_prop
6120 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6121 iterate_out_of_display_property (it
);
6123 eassert ((BUFFERP (it
->object
)
6124 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6125 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6126 || (STRINGP (it
->object
)
6127 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6128 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6129 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6135 /***********************************************************************
6137 ***********************************************************************/
6139 /* Set IT's current position to the previous line start. */
6142 back_to_previous_line_start (struct it
*it
)
6144 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6147 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6151 /* Move IT to the next line start.
6153 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6154 we skipped over part of the text (as opposed to moving the iterator
6155 continuously over the text). Otherwise, don't change the value
6158 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6159 iterator on the newline, if it was found.
6161 Newlines may come from buffer text, overlay strings, or strings
6162 displayed via the `display' property. That's the reason we can't
6163 simply use find_newline_no_quit.
6165 Note that this function may not skip over invisible text that is so
6166 because of text properties and immediately follows a newline. If
6167 it would, function reseat_at_next_visible_line_start, when called
6168 from set_iterator_to_next, would effectively make invisible
6169 characters following a newline part of the wrong glyph row, which
6170 leads to wrong cursor motion. */
6173 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6174 struct bidi_it
*bidi_it_prev
)
6176 ptrdiff_t old_selective
;
6177 int newline_found_p
, n
;
6178 const int MAX_NEWLINE_DISTANCE
= 500;
6180 /* If already on a newline, just consume it to avoid unintended
6181 skipping over invisible text below. */
6182 if (it
->what
== IT_CHARACTER
6184 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6186 if (it
->bidi_p
&& bidi_it_prev
)
6187 *bidi_it_prev
= it
->bidi_it
;
6188 set_iterator_to_next (it
, 0);
6193 /* Don't handle selective display in the following. It's (a)
6194 unnecessary because it's done by the caller, and (b) leads to an
6195 infinite recursion because next_element_from_ellipsis indirectly
6196 calls this function. */
6197 old_selective
= it
->selective
;
6200 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6201 from buffer text. */
6202 for (n
= newline_found_p
= 0;
6203 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6204 n
+= STRINGP (it
->string
) ? 0 : 1)
6206 if (!get_next_display_element (it
))
6208 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6209 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6210 *bidi_it_prev
= it
->bidi_it
;
6211 set_iterator_to_next (it
, 0);
6214 /* If we didn't find a newline near enough, see if we can use a
6216 if (!newline_found_p
)
6218 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6219 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6223 eassert (!STRINGP (it
->string
));
6225 /* If there isn't any `display' property in sight, and no
6226 overlays, we can just use the position of the newline in
6228 if (it
->stop_charpos
>= limit
6229 || ((pos
= Fnext_single_property_change (make_number (start
),
6231 make_number (limit
)),
6233 && next_overlay_change (start
) == ZV
))
6237 IT_CHARPOS (*it
) = limit
;
6238 IT_BYTEPOS (*it
) = bytepos
;
6242 struct bidi_it bprev
;
6244 /* Help bidi.c avoid expensive searches for display
6245 properties and overlays, by telling it that there are
6246 none up to `limit'. */
6247 if (it
->bidi_it
.disp_pos
< limit
)
6249 it
->bidi_it
.disp_pos
= limit
;
6250 it
->bidi_it
.disp_prop
= 0;
6253 bprev
= it
->bidi_it
;
6254 bidi_move_to_visually_next (&it
->bidi_it
);
6255 } while (it
->bidi_it
.charpos
!= limit
);
6256 IT_CHARPOS (*it
) = limit
;
6257 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6259 *bidi_it_prev
= bprev
;
6261 *skipped_p
= newline_found_p
= true;
6265 while (get_next_display_element (it
)
6266 && !newline_found_p
)
6268 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6269 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6270 *bidi_it_prev
= it
->bidi_it
;
6271 set_iterator_to_next (it
, 0);
6276 it
->selective
= old_selective
;
6277 return newline_found_p
;
6281 /* Set IT's current position to the previous visible line start. Skip
6282 invisible text that is so either due to text properties or due to
6283 selective display. Caution: this does not change IT->current_x and
6287 back_to_previous_visible_line_start (struct it
*it
)
6289 while (IT_CHARPOS (*it
) > BEGV
)
6291 back_to_previous_line_start (it
);
6293 if (IT_CHARPOS (*it
) <= BEGV
)
6296 /* If selective > 0, then lines indented more than its value are
6298 if (it
->selective
> 0
6299 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6303 /* Check the newline before point for invisibility. */
6306 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6307 Qinvisible
, it
->window
);
6308 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6312 if (IT_CHARPOS (*it
) <= BEGV
)
6317 void *it2data
= NULL
;
6320 Lisp_Object val
, overlay
;
6322 SAVE_IT (it2
, *it
, it2data
);
6324 /* If newline is part of a composition, continue from start of composition */
6325 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6326 && beg
< IT_CHARPOS (*it
))
6329 /* If newline is replaced by a display property, find start of overlay
6330 or interval and continue search from that point. */
6331 pos
= --IT_CHARPOS (it2
);
6334 bidi_unshelve_cache (NULL
, 0);
6335 it2
.string_from_display_prop_p
= 0;
6336 it2
.from_disp_prop_p
= 0;
6337 if (handle_display_prop (&it2
) == HANDLED_RETURN
6338 && !NILP (val
= get_char_property_and_overlay
6339 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6340 && (OVERLAYP (overlay
)
6341 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6342 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6344 RESTORE_IT (it
, it
, it2data
);
6348 /* Newline is not replaced by anything -- so we are done. */
6349 RESTORE_IT (it
, it
, it2data
);
6355 IT_CHARPOS (*it
) = beg
;
6356 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6360 it
->continuation_lines_width
= 0;
6362 eassert (IT_CHARPOS (*it
) >= BEGV
);
6363 eassert (IT_CHARPOS (*it
) == BEGV
6364 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6369 /* Reseat iterator IT at the previous visible line start. Skip
6370 invisible text that is so either due to text properties or due to
6371 selective display. At the end, update IT's overlay information,
6372 face information etc. */
6375 reseat_at_previous_visible_line_start (struct it
*it
)
6377 back_to_previous_visible_line_start (it
);
6378 reseat (it
, it
->current
.pos
, 1);
6383 /* Reseat iterator IT on the next visible line start in the current
6384 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6385 preceding the line start. Skip over invisible text that is so
6386 because of selective display. Compute faces, overlays etc at the
6387 new position. Note that this function does not skip over text that
6388 is invisible because of text properties. */
6391 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6393 int newline_found_p
, skipped_p
= 0;
6394 struct bidi_it bidi_it_prev
;
6396 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6398 /* Skip over lines that are invisible because they are indented
6399 more than the value of IT->selective. */
6400 if (it
->selective
> 0)
6401 while (IT_CHARPOS (*it
) < ZV
6402 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6405 eassert (IT_BYTEPOS (*it
) == BEGV
6406 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6408 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6411 /* Position on the newline if that's what's requested. */
6412 if (on_newline_p
&& newline_found_p
)
6414 if (STRINGP (it
->string
))
6416 if (IT_STRING_CHARPOS (*it
) > 0)
6420 --IT_STRING_CHARPOS (*it
);
6421 --IT_STRING_BYTEPOS (*it
);
6425 /* We need to restore the bidi iterator to the state
6426 it had on the newline, and resync the IT's
6427 position with that. */
6428 it
->bidi_it
= bidi_it_prev
;
6429 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6430 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6434 else if (IT_CHARPOS (*it
) > BEGV
)
6443 /* We need to restore the bidi iterator to the state it
6444 had on the newline and resync IT with that. */
6445 it
->bidi_it
= bidi_it_prev
;
6446 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6447 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6449 reseat (it
, it
->current
.pos
, 0);
6453 reseat (it
, it
->current
.pos
, 0);
6460 /***********************************************************************
6461 Changing an iterator's position
6462 ***********************************************************************/
6464 /* Change IT's current position to POS in current_buffer. If FORCE_P
6465 is non-zero, always check for text properties at the new position.
6466 Otherwise, text properties are only looked up if POS >=
6467 IT->check_charpos of a property. */
6470 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6472 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6474 reseat_1 (it
, pos
, 0);
6476 /* Determine where to check text properties. Avoid doing it
6477 where possible because text property lookup is very expensive. */
6479 || CHARPOS (pos
) > it
->stop_charpos
6480 || CHARPOS (pos
) < original_pos
)
6484 /* For bidi iteration, we need to prime prev_stop and
6485 base_level_stop with our best estimations. */
6486 /* Implementation note: Of course, POS is not necessarily a
6487 stop position, so assigning prev_pos to it is a lie; we
6488 should have called compute_stop_backwards. However, if
6489 the current buffer does not include any R2L characters,
6490 that call would be a waste of cycles, because the
6491 iterator will never move back, and thus never cross this
6492 "fake" stop position. So we delay that backward search
6493 until the time we really need it, in next_element_from_buffer. */
6494 if (CHARPOS (pos
) != it
->prev_stop
)
6495 it
->prev_stop
= CHARPOS (pos
);
6496 if (CHARPOS (pos
) < it
->base_level_stop
)
6497 it
->base_level_stop
= 0; /* meaning it's unknown */
6503 it
->prev_stop
= it
->base_level_stop
= 0;
6512 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6513 IT->stop_pos to POS, also. */
6516 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6518 /* Don't call this function when scanning a C string. */
6519 eassert (it
->s
== NULL
);
6521 /* POS must be a reasonable value. */
6522 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6524 it
->current
.pos
= it
->position
= pos
;
6525 it
->end_charpos
= ZV
;
6527 it
->current
.dpvec_index
= -1;
6528 it
->current
.overlay_string_index
= -1;
6529 IT_STRING_CHARPOS (*it
) = -1;
6530 IT_STRING_BYTEPOS (*it
) = -1;
6532 it
->method
= GET_FROM_BUFFER
;
6533 it
->object
= it
->w
->contents
;
6534 it
->area
= TEXT_AREA
;
6535 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6537 it
->string_from_display_prop_p
= 0;
6538 it
->string_from_prefix_prop_p
= 0;
6540 it
->from_disp_prop_p
= 0;
6541 it
->face_before_selective_p
= 0;
6544 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6546 bidi_unshelve_cache (NULL
, 0);
6547 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6548 it
->bidi_it
.string
.s
= NULL
;
6549 it
->bidi_it
.string
.lstring
= Qnil
;
6550 it
->bidi_it
.string
.bufpos
= 0;
6551 it
->bidi_it
.string
.from_disp_str
= 0;
6552 it
->bidi_it
.string
.unibyte
= 0;
6553 it
->bidi_it
.w
= it
->w
;
6558 it
->stop_charpos
= CHARPOS (pos
);
6559 it
->base_level_stop
= CHARPOS (pos
);
6561 /* This make the information stored in it->cmp_it invalidate. */
6566 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6567 If S is non-null, it is a C string to iterate over. Otherwise,
6568 STRING gives a Lisp string to iterate over.
6570 If PRECISION > 0, don't return more then PRECISION number of
6571 characters from the string.
6573 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6574 characters have been returned. FIELD_WIDTH < 0 means an infinite
6577 MULTIBYTE = 0 means disable processing of multibyte characters,
6578 MULTIBYTE > 0 means enable it,
6579 MULTIBYTE < 0 means use IT->multibyte_p.
6581 IT must be initialized via a prior call to init_iterator before
6582 calling this function. */
6585 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6586 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6589 /* No text property checks performed by default, but see below. */
6590 it
->stop_charpos
= -1;
6592 /* Set iterator position and end position. */
6593 memset (&it
->current
, 0, sizeof it
->current
);
6594 it
->current
.overlay_string_index
= -1;
6595 it
->current
.dpvec_index
= -1;
6596 eassert (charpos
>= 0);
6598 /* If STRING is specified, use its multibyteness, otherwise use the
6599 setting of MULTIBYTE, if specified. */
6601 it
->multibyte_p
= multibyte
> 0;
6603 /* Bidirectional reordering of strings is controlled by the default
6604 value of bidi-display-reordering. Don't try to reorder while
6605 loading loadup.el, as the necessary character property tables are
6606 not yet available. */
6609 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6613 eassert (STRINGP (string
));
6614 it
->string
= string
;
6616 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6617 it
->method
= GET_FROM_STRING
;
6618 it
->current
.string_pos
= string_pos (charpos
, string
);
6622 it
->bidi_it
.string
.lstring
= string
;
6623 it
->bidi_it
.string
.s
= NULL
;
6624 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6625 it
->bidi_it
.string
.bufpos
= 0;
6626 it
->bidi_it
.string
.from_disp_str
= 0;
6627 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6628 it
->bidi_it
.w
= it
->w
;
6629 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6630 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6635 it
->s
= (const unsigned char *) s
;
6638 /* Note that we use IT->current.pos, not it->current.string_pos,
6639 for displaying C strings. */
6640 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6641 if (it
->multibyte_p
)
6643 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6644 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6648 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6649 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6654 it
->bidi_it
.string
.lstring
= Qnil
;
6655 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6656 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6657 it
->bidi_it
.string
.bufpos
= 0;
6658 it
->bidi_it
.string
.from_disp_str
= 0;
6659 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6660 it
->bidi_it
.w
= it
->w
;
6661 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6664 it
->method
= GET_FROM_C_STRING
;
6667 /* PRECISION > 0 means don't return more than PRECISION characters
6669 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6671 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6673 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6676 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6677 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6678 FIELD_WIDTH < 0 means infinite field width. This is useful for
6679 padding with `-' at the end of a mode line. */
6680 if (field_width
< 0)
6681 field_width
= INFINITY
;
6682 /* Implementation note: We deliberately don't enlarge
6683 it->bidi_it.string.schars here to fit it->end_charpos, because
6684 the bidi iterator cannot produce characters out of thin air. */
6685 if (field_width
> it
->end_charpos
- charpos
)
6686 it
->end_charpos
= charpos
+ field_width
;
6688 /* Use the standard display table for displaying strings. */
6689 if (DISP_TABLE_P (Vstandard_display_table
))
6690 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6692 it
->stop_charpos
= charpos
;
6693 it
->prev_stop
= charpos
;
6694 it
->base_level_stop
= 0;
6697 it
->bidi_it
.first_elt
= 1;
6698 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6699 it
->bidi_it
.disp_pos
= -1;
6701 if (s
== NULL
&& it
->multibyte_p
)
6703 ptrdiff_t endpos
= SCHARS (it
->string
);
6704 if (endpos
> it
->end_charpos
)
6705 endpos
= it
->end_charpos
;
6706 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6714 /***********************************************************************
6716 ***********************************************************************/
6718 /* Map enum it_method value to corresponding next_element_from_* function. */
6720 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6722 next_element_from_buffer
,
6723 next_element_from_display_vector
,
6724 next_element_from_string
,
6725 next_element_from_c_string
,
6726 next_element_from_image
,
6727 next_element_from_stretch
6728 #ifdef HAVE_XWIDGETS
6729 ,next_element_from_xwidget
6733 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6736 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6737 (possibly with the following characters). */
6739 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6740 ((IT)->cmp_it.id >= 0 \
6741 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6742 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6743 END_CHARPOS, (IT)->w, \
6744 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6748 /* Lookup the char-table Vglyphless_char_display for character C (-1
6749 if we want information for no-font case), and return the display
6750 method symbol. By side-effect, update it->what and
6751 it->glyphless_method. This function is called from
6752 get_next_display_element for each character element, and from
6753 x_produce_glyphs when no suitable font was found. */
6756 lookup_glyphless_char_display (int c
, struct it
*it
)
6758 Lisp_Object glyphless_method
= Qnil
;
6760 if (CHAR_TABLE_P (Vglyphless_char_display
)
6761 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6765 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6766 if (CONSP (glyphless_method
))
6767 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6768 ? XCAR (glyphless_method
)
6769 : XCDR (glyphless_method
);
6772 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6776 if (NILP (glyphless_method
))
6779 /* The default is to display the character by a proper font. */
6781 /* The default for the no-font case is to display an empty box. */
6782 glyphless_method
= Qempty_box
;
6784 if (EQ (glyphless_method
, Qzero_width
))
6787 return glyphless_method
;
6788 /* This method can't be used for the no-font case. */
6789 glyphless_method
= Qempty_box
;
6791 if (EQ (glyphless_method
, Qthin_space
))
6792 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6793 else if (EQ (glyphless_method
, Qempty_box
))
6794 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6795 else if (EQ (glyphless_method
, Qhex_code
))
6796 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6797 else if (STRINGP (glyphless_method
))
6798 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6801 /* Invalid value. We use the default method. */
6802 glyphless_method
= Qnil
;
6805 it
->what
= IT_GLYPHLESS
;
6806 return glyphless_method
;
6809 /* Merge escape glyph face and cache the result. */
6811 static struct frame
*last_escape_glyph_frame
= NULL
;
6812 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6813 static int last_escape_glyph_merged_face_id
= 0;
6816 merge_escape_glyph_face (struct it
*it
)
6820 if (it
->f
== last_escape_glyph_frame
6821 && it
->face_id
== last_escape_glyph_face_id
)
6822 face_id
= last_escape_glyph_merged_face_id
;
6825 /* Merge the `escape-glyph' face into the current face. */
6826 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6827 last_escape_glyph_frame
= it
->f
;
6828 last_escape_glyph_face_id
= it
->face_id
;
6829 last_escape_glyph_merged_face_id
= face_id
;
6834 /* Likewise for glyphless glyph face. */
6836 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6837 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6838 static int last_glyphless_glyph_merged_face_id
= 0;
6841 merge_glyphless_glyph_face (struct it
*it
)
6845 if (it
->f
== last_glyphless_glyph_frame
6846 && it
->face_id
== last_glyphless_glyph_face_id
)
6847 face_id
= last_glyphless_glyph_merged_face_id
;
6850 /* Merge the `glyphless-char' face into the current face. */
6851 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6852 last_glyphless_glyph_frame
= it
->f
;
6853 last_glyphless_glyph_face_id
= it
->face_id
;
6854 last_glyphless_glyph_merged_face_id
= face_id
;
6859 /* Load IT's display element fields with information about the next
6860 display element from the current position of IT. Value is zero if
6861 end of buffer (or C string) is reached. */
6864 get_next_display_element (struct it
*it
)
6866 /* Non-zero means that we found a display element. Zero means that
6867 we hit the end of what we iterate over. Performance note: the
6868 function pointer `method' used here turns out to be faster than
6869 using a sequence of if-statements. */
6873 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6875 if (it
->what
== IT_CHARACTER
)
6877 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6878 and only if (a) the resolved directionality of that character
6880 /* FIXME: Do we need an exception for characters from display
6882 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6883 && !inhibit_bidi_mirroring
)
6884 it
->c
= bidi_mirror_char (it
->c
);
6885 /* Map via display table or translate control characters.
6886 IT->c, IT->len etc. have been set to the next character by
6887 the function call above. If we have a display table, and it
6888 contains an entry for IT->c, translate it. Don't do this if
6889 IT->c itself comes from a display table, otherwise we could
6890 end up in an infinite recursion. (An alternative could be to
6891 count the recursion depth of this function and signal an
6892 error when a certain maximum depth is reached.) Is it worth
6894 if (success_p
&& it
->dpvec
== NULL
)
6897 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6898 int nonascii_space_p
= 0;
6899 int nonascii_hyphen_p
= 0;
6900 int c
= it
->c
; /* This is the character to display. */
6902 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6904 eassert (SINGLE_BYTE_CHAR_P (c
));
6905 if (unibyte_display_via_language_environment
)
6907 c
= DECODE_CHAR (unibyte
, c
);
6909 c
= BYTE8_TO_CHAR (it
->c
);
6912 c
= BYTE8_TO_CHAR (it
->c
);
6916 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6919 struct Lisp_Vector
*v
= XVECTOR (dv
);
6921 /* Return the first character from the display table
6922 entry, if not empty. If empty, don't display the
6923 current character. */
6926 it
->dpvec_char_len
= it
->len
;
6927 it
->dpvec
= v
->contents
;
6928 it
->dpend
= v
->contents
+ v
->header
.size
;
6929 it
->current
.dpvec_index
= 0;
6930 it
->dpvec_face_id
= -1;
6931 it
->saved_face_id
= it
->face_id
;
6932 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6937 set_iterator_to_next (it
, 0);
6942 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6944 if (it
->what
== IT_GLYPHLESS
)
6946 /* Don't display this character. */
6947 set_iterator_to_next (it
, 0);
6951 /* If `nobreak-char-display' is non-nil, we display
6952 non-ASCII spaces and hyphens specially. */
6953 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6956 nonascii_space_p
= true;
6957 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6958 nonascii_hyphen_p
= true;
6961 /* Translate control characters into `\003' or `^C' form.
6962 Control characters coming from a display table entry are
6963 currently not translated because we use IT->dpvec to hold
6964 the translation. This could easily be changed but I
6965 don't believe that it is worth doing.
6967 The characters handled by `nobreak-char-display' must be
6970 Non-printable characters and raw-byte characters are also
6971 translated to octal form. */
6972 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6973 ? (it
->area
!= TEXT_AREA
6974 /* In mode line, treat \n, \t like other crl chars. */
6977 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6978 || (c
!= '\n' && c
!= '\t'))
6980 || nonascii_hyphen_p
6982 || ! CHAR_PRINTABLE_P (c
))))
6984 /* C is a control character, non-ASCII space/hyphen,
6985 raw-byte, or a non-printable character which must be
6986 displayed either as '\003' or as `^C' where the '\\'
6987 and '^' can be defined in the display table. Fill
6988 IT->ctl_chars with glyphs for what we have to
6989 display. Then, set IT->dpvec to these glyphs. */
6996 /* Handle control characters with ^. */
6998 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7002 g
= '^'; /* default glyph for Control */
7003 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7005 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7007 g
= GLYPH_CODE_CHAR (gc
);
7008 lface_id
= GLYPH_CODE_FACE (gc
);
7012 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7013 : merge_escape_glyph_face (it
));
7015 XSETINT (it
->ctl_chars
[0], g
);
7016 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7018 goto display_control
;
7021 /* Handle non-ascii space in the mode where it only gets
7024 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7026 /* Merge `nobreak-space' into the current face. */
7027 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7029 XSETINT (it
->ctl_chars
[0], ' ');
7031 goto display_control
;
7034 /* Handle sequences that start with the "escape glyph". */
7036 /* the default escape glyph is \. */
7037 escape_glyph
= '\\';
7040 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7042 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7043 lface_id
= GLYPH_CODE_FACE (gc
);
7047 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7048 : merge_escape_glyph_face (it
));
7050 /* Draw non-ASCII hyphen with just highlighting: */
7052 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7054 XSETINT (it
->ctl_chars
[0], '-');
7056 goto display_control
;
7059 /* Draw non-ASCII space/hyphen with escape glyph: */
7061 if (nonascii_space_p
|| nonascii_hyphen_p
)
7063 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7064 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7066 goto display_control
;
7073 if (CHAR_BYTE8_P (c
))
7074 /* Display \200 instead of \17777600. */
7075 c
= CHAR_TO_BYTE8 (c
);
7076 len
= sprintf (str
, "%03o", c
);
7078 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7079 for (i
= 0; i
< len
; i
++)
7080 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7085 /* Set up IT->dpvec and return first character from it. */
7086 it
->dpvec_char_len
= it
->len
;
7087 it
->dpvec
= it
->ctl_chars
;
7088 it
->dpend
= it
->dpvec
+ ctl_len
;
7089 it
->current
.dpvec_index
= 0;
7090 it
->dpvec_face_id
= face_id
;
7091 it
->saved_face_id
= it
->face_id
;
7092 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7096 it
->char_to_display
= c
;
7100 it
->char_to_display
= it
->c
;
7104 #ifdef HAVE_WINDOW_SYSTEM
7105 /* Adjust face id for a multibyte character. There are no multibyte
7106 character in unibyte text. */
7107 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7110 && FRAME_WINDOW_P (it
->f
))
7112 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7114 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7116 /* Automatic composition with glyph-string. */
7117 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7119 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7123 ptrdiff_t pos
= (it
->s
? -1
7124 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7125 : IT_CHARPOS (*it
));
7128 if (it
->what
== IT_CHARACTER
)
7129 c
= it
->char_to_display
;
7132 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7136 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7137 /* TAB in a composition means display glyphs with
7138 padding space on the left or right. */
7139 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7142 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7145 #endif /* HAVE_WINDOW_SYSTEM */
7148 /* Is this character the last one of a run of characters with
7149 box? If yes, set IT->end_of_box_run_p to 1. */
7153 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7155 int face_id
= underlying_face_id (it
);
7156 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7160 if (face
->box
== FACE_NO_BOX
)
7162 /* If the box comes from face properties in a
7163 display string, check faces in that string. */
7164 int string_face_id
= face_after_it_pos (it
);
7165 it
->end_of_box_run_p
7166 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7169 /* Otherwise, the box comes from the underlying face.
7170 If this is the last string character displayed, check
7171 the next buffer location. */
7172 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7173 /* n_overlay_strings is unreliable unless
7174 overlay_string_index is non-negative. */
7175 && ((it
->current
.overlay_string_index
>= 0
7176 && (it
->current
.overlay_string_index
7177 == it
->n_overlay_strings
- 1))
7178 /* A string from display property. */
7179 || it
->from_disp_prop_p
))
7183 struct text_pos pos
= it
->current
.pos
;
7185 /* For a string from a display property, the next
7186 buffer position is stored in the 'position'
7187 member of the iteration stack slot below the
7188 current one, see handle_single_display_spec. By
7189 contrast, it->current.pos was is not yet updated
7190 to point to that buffer position; that will
7191 happen in pop_it, after we finish displaying the
7192 current string. Note that we already checked
7193 above that it->sp is positive, so subtracting one
7195 if (it
->from_disp_prop_p
)
7196 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7198 INC_TEXT_POS (pos
, it
->multibyte_p
);
7200 if (CHARPOS (pos
) >= ZV
)
7201 it
->end_of_box_run_p
= true;
7204 next_face_id
= face_at_buffer_position
7205 (it
->w
, CHARPOS (pos
), &ignore
,
7206 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7207 it
->end_of_box_run_p
7208 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7214 /* next_element_from_display_vector sets this flag according to
7215 faces of the display vector glyphs, see there. */
7216 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7218 int face_id
= face_after_it_pos (it
);
7219 it
->end_of_box_run_p
7220 = (face_id
!= it
->face_id
7221 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7224 /* If we reached the end of the object we've been iterating (e.g., a
7225 display string or an overlay string), and there's something on
7226 IT->stack, proceed with what's on the stack. It doesn't make
7227 sense to return zero if there's unprocessed stuff on the stack,
7228 because otherwise that stuff will never be displayed. */
7229 if (!success_p
&& it
->sp
> 0)
7231 set_iterator_to_next (it
, 0);
7232 success_p
= get_next_display_element (it
);
7235 /* Value is 0 if end of buffer or string reached. */
7240 /* Move IT to the next display element.
7242 RESEAT_P non-zero means if called on a newline in buffer text,
7243 skip to the next visible line start.
7245 Functions get_next_display_element and set_iterator_to_next are
7246 separate because I find this arrangement easier to handle than a
7247 get_next_display_element function that also increments IT's
7248 position. The way it is we can first look at an iterator's current
7249 display element, decide whether it fits on a line, and if it does,
7250 increment the iterator position. The other way around we probably
7251 would either need a flag indicating whether the iterator has to be
7252 incremented the next time, or we would have to implement a
7253 decrement position function which would not be easy to write. */
7256 set_iterator_to_next (struct it
*it
, int reseat_p
)
7258 /* Reset flags indicating start and end of a sequence of characters
7259 with box. Reset them at the start of this function because
7260 moving the iterator to a new position might set them. */
7261 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7265 case GET_FROM_BUFFER
:
7266 /* The current display element of IT is a character from
7267 current_buffer. Advance in the buffer, and maybe skip over
7268 invisible lines that are so because of selective display. */
7269 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7270 reseat_at_next_visible_line_start (it
, 0);
7271 else if (it
->cmp_it
.id
>= 0)
7273 /* We are currently getting glyphs from a composition. */
7276 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7277 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7283 /* Update IT's char/byte positions to point to the first
7284 character of the next grapheme cluster, or to the
7285 character visually after the current composition. */
7286 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7287 bidi_move_to_visually_next (&it
->bidi_it
);
7288 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7289 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7292 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7293 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7295 /* Composition created while scanning forward. Proceed
7296 to the next grapheme cluster. */
7297 it
->cmp_it
.from
= it
->cmp_it
.to
;
7299 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7300 && it
->cmp_it
.from
> 0)
7302 /* Composition created while scanning backward. Proceed
7303 to the previous grapheme cluster. */
7304 it
->cmp_it
.to
= it
->cmp_it
.from
;
7308 /* No more grapheme clusters in this composition.
7309 Find the next stop position. */
7310 ptrdiff_t stop
= it
->end_charpos
;
7312 if (it
->bidi_it
.scan_dir
< 0)
7313 /* Now we are scanning backward and don't know
7316 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7317 IT_BYTEPOS (*it
), stop
, Qnil
);
7322 eassert (it
->len
!= 0);
7326 IT_BYTEPOS (*it
) += it
->len
;
7327 IT_CHARPOS (*it
) += 1;
7331 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7332 /* If this is a new paragraph, determine its base
7333 direction (a.k.a. its base embedding level). */
7334 if (it
->bidi_it
.new_paragraph
)
7335 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7336 bidi_move_to_visually_next (&it
->bidi_it
);
7337 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7338 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7339 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7341 /* As the scan direction was changed, we must
7342 re-compute the stop position for composition. */
7343 ptrdiff_t stop
= it
->end_charpos
;
7344 if (it
->bidi_it
.scan_dir
< 0)
7346 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7347 IT_BYTEPOS (*it
), stop
, Qnil
);
7350 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7354 case GET_FROM_C_STRING
:
7355 /* Current display element of IT is from a C string. */
7357 /* If the string position is beyond string's end, it means
7358 next_element_from_c_string is padding the string with
7359 blanks, in which case we bypass the bidi iterator,
7360 because it cannot deal with such virtual characters. */
7361 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7363 IT_BYTEPOS (*it
) += it
->len
;
7364 IT_CHARPOS (*it
) += 1;
7368 bidi_move_to_visually_next (&it
->bidi_it
);
7369 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7370 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7374 case GET_FROM_DISPLAY_VECTOR
:
7375 /* Current display element of IT is from a display table entry.
7376 Advance in the display table definition. Reset it to null if
7377 end reached, and continue with characters from buffers/
7379 ++it
->current
.dpvec_index
;
7381 /* Restore face of the iterator to what they were before the
7382 display vector entry (these entries may contain faces). */
7383 it
->face_id
= it
->saved_face_id
;
7385 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7387 int recheck_faces
= it
->ellipsis_p
;
7390 it
->method
= GET_FROM_C_STRING
;
7391 else if (STRINGP (it
->string
))
7392 it
->method
= GET_FROM_STRING
;
7395 it
->method
= GET_FROM_BUFFER
;
7396 it
->object
= it
->w
->contents
;
7400 it
->current
.dpvec_index
= -1;
7402 /* Skip over characters which were displayed via IT->dpvec. */
7403 if (it
->dpvec_char_len
< 0)
7404 reseat_at_next_visible_line_start (it
, 1);
7405 else if (it
->dpvec_char_len
> 0)
7407 if (it
->method
== GET_FROM_STRING
7408 && it
->current
.overlay_string_index
>= 0
7409 && it
->n_overlay_strings
> 0)
7410 it
->ignore_overlay_strings_at_pos_p
= true;
7411 it
->len
= it
->dpvec_char_len
;
7412 set_iterator_to_next (it
, reseat_p
);
7415 /* Maybe recheck faces after display vector. */
7417 it
->stop_charpos
= IT_CHARPOS (*it
);
7421 case GET_FROM_STRING
:
7422 /* Current display element is a character from a Lisp string. */
7423 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7424 /* Don't advance past string end. These conditions are true
7425 when set_iterator_to_next is called at the end of
7426 get_next_display_element, in which case the Lisp string is
7427 already exhausted, and all we want is pop the iterator
7429 if (it
->current
.overlay_string_index
>= 0)
7431 /* This is an overlay string, so there's no padding with
7432 spaces, and the number of characters in the string is
7433 where the string ends. */
7434 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7435 goto consider_string_end
;
7439 /* Not an overlay string. There could be padding, so test
7440 against it->end_charpos. */
7441 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7442 goto consider_string_end
;
7444 if (it
->cmp_it
.id
>= 0)
7446 /* We are delivering display elements from a composition.
7447 Update the string position past the grapheme cluster
7448 we've just processed. */
7451 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7452 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7458 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7459 bidi_move_to_visually_next (&it
->bidi_it
);
7460 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7461 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7464 /* Did we exhaust all the grapheme clusters of this
7466 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7467 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7469 /* Not all the grapheme clusters were processed yet;
7470 advance to the next cluster. */
7471 it
->cmp_it
.from
= it
->cmp_it
.to
;
7473 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7474 && it
->cmp_it
.from
> 0)
7476 /* Likewise: advance to the next cluster, but going in
7477 the reverse direction. */
7478 it
->cmp_it
.to
= it
->cmp_it
.from
;
7482 /* This composition was fully processed; find the next
7483 candidate place for checking for composed
7485 /* Always limit string searches to the string length;
7486 any padding spaces are not part of the string, and
7487 there cannot be any compositions in that padding. */
7488 ptrdiff_t stop
= SCHARS (it
->string
);
7490 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7492 else if (it
->end_charpos
< stop
)
7494 /* Cf. PRECISION in reseat_to_string: we might be
7495 limited in how many of the string characters we
7497 stop
= it
->end_charpos
;
7499 composition_compute_stop_pos (&it
->cmp_it
,
7500 IT_STRING_CHARPOS (*it
),
7501 IT_STRING_BYTEPOS (*it
), stop
,
7508 /* If the string position is beyond string's end, it
7509 means next_element_from_string is padding the string
7510 with blanks, in which case we bypass the bidi
7511 iterator, because it cannot deal with such virtual
7513 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7515 IT_STRING_BYTEPOS (*it
) += it
->len
;
7516 IT_STRING_CHARPOS (*it
) += 1;
7520 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7522 bidi_move_to_visually_next (&it
->bidi_it
);
7523 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7524 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7525 /* If the scan direction changes, we may need to update
7526 the place where to check for composed characters. */
7527 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7529 ptrdiff_t stop
= SCHARS (it
->string
);
7531 if (it
->bidi_it
.scan_dir
< 0)
7533 else if (it
->end_charpos
< stop
)
7534 stop
= it
->end_charpos
;
7536 composition_compute_stop_pos (&it
->cmp_it
,
7537 IT_STRING_CHARPOS (*it
),
7538 IT_STRING_BYTEPOS (*it
), stop
,
7544 consider_string_end
:
7546 if (it
->current
.overlay_string_index
>= 0)
7548 /* IT->string is an overlay string. Advance to the
7549 next, if there is one. */
7550 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7553 next_overlay_string (it
);
7555 setup_for_ellipsis (it
, 0);
7560 /* IT->string is not an overlay string. If we reached
7561 its end, and there is something on IT->stack, proceed
7562 with what is on the stack. This can be either another
7563 string, this time an overlay string, or a buffer. */
7564 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7568 if (it
->method
== GET_FROM_STRING
)
7569 goto consider_string_end
;
7574 case GET_FROM_IMAGE
:
7575 case GET_FROM_STRETCH
:
7576 #ifdef HAVE_XWIDGETS
7577 case GET_FROM_XWIDGET
:
7580 /* The position etc with which we have to proceed are on
7581 the stack. The position may be at the end of a string,
7582 if the `display' property takes up the whole string. */
7583 eassert (it
->sp
> 0);
7585 if (it
->method
== GET_FROM_STRING
)
7586 goto consider_string_end
;
7590 /* There are no other methods defined, so this should be a bug. */
7594 eassert (it
->method
!= GET_FROM_STRING
7595 || (STRINGP (it
->string
)
7596 && IT_STRING_CHARPOS (*it
) >= 0));
7599 /* Load IT's display element fields with information about the next
7600 display element which comes from a display table entry or from the
7601 result of translating a control character to one of the forms `^C'
7604 IT->dpvec holds the glyphs to return as characters.
7605 IT->saved_face_id holds the face id before the display vector--it
7606 is restored into IT->face_id in set_iterator_to_next. */
7609 next_element_from_display_vector (struct it
*it
)
7612 int prev_face_id
= it
->face_id
;
7616 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7618 it
->face_id
= it
->saved_face_id
;
7620 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7621 That seemed totally bogus - so I changed it... */
7622 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7624 if (GLYPH_CODE_P (gc
))
7626 struct face
*this_face
, *prev_face
, *next_face
;
7628 it
->c
= GLYPH_CODE_CHAR (gc
);
7629 it
->len
= CHAR_BYTES (it
->c
);
7631 /* The entry may contain a face id to use. Such a face id is
7632 the id of a Lisp face, not a realized face. A face id of
7633 zero means no face is specified. */
7634 if (it
->dpvec_face_id
>= 0)
7635 it
->face_id
= it
->dpvec_face_id
;
7638 int lface_id
= GLYPH_CODE_FACE (gc
);
7640 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7644 /* Glyphs in the display vector could have the box face, so we
7645 need to set the related flags in the iterator, as
7647 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7648 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7650 /* Is this character the first character of a box-face run? */
7651 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7653 || prev_face
->box
== FACE_NO_BOX
));
7655 /* For the last character of the box-face run, we need to look
7656 either at the next glyph from the display vector, or at the
7657 face we saw before the display vector. */
7658 next_face_id
= it
->saved_face_id
;
7659 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7661 if (it
->dpvec_face_id
>= 0)
7662 next_face_id
= it
->dpvec_face_id
;
7666 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7669 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7673 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7674 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7676 || next_face
->box
== FACE_NO_BOX
));
7677 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7680 /* Display table entry is invalid. Return a space. */
7681 it
->c
= ' ', it
->len
= 1;
7683 /* Don't change position and object of the iterator here. They are
7684 still the values of the character that had this display table
7685 entry or was translated, and that's what we want. */
7686 it
->what
= IT_CHARACTER
;
7690 /* Get the first element of string/buffer in the visual order, after
7691 being reseated to a new position in a string or a buffer. */
7693 get_visually_first_element (struct it
*it
)
7695 int string_p
= STRINGP (it
->string
) || it
->s
;
7696 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7697 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7699 if (STRINGP (it
->string
))
7701 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7702 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7706 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7707 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7710 if (it
->bidi_it
.charpos
== eob
)
7712 /* Nothing to do, but reset the FIRST_ELT flag, like
7713 bidi_paragraph_init does, because we are not going to
7715 it
->bidi_it
.first_elt
= 0;
7717 else if (it
->bidi_it
.charpos
== bob
7719 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7720 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7722 /* If we are at the beginning of a line/string, we can produce
7723 the next element right away. */
7724 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7725 bidi_move_to_visually_next (&it
->bidi_it
);
7729 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7731 /* We need to prime the bidi iterator starting at the line's or
7732 string's beginning, before we will be able to produce the
7735 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7737 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7738 IT_BYTEPOS (*it
), -1,
7739 &it
->bidi_it
.bytepos
);
7740 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7743 /* Now return to buffer/string position where we were asked
7744 to get the next display element, and produce that. */
7745 bidi_move_to_visually_next (&it
->bidi_it
);
7747 while (it
->bidi_it
.bytepos
!= orig_bytepos
7748 && it
->bidi_it
.charpos
< eob
);
7751 /* Adjust IT's position information to where we ended up. */
7752 if (STRINGP (it
->string
))
7754 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7755 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7759 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7760 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7763 if (STRINGP (it
->string
) || !it
->s
)
7765 ptrdiff_t stop
, charpos
, bytepos
;
7767 if (STRINGP (it
->string
))
7770 stop
= SCHARS (it
->string
);
7771 if (stop
> it
->end_charpos
)
7772 stop
= it
->end_charpos
;
7773 charpos
= IT_STRING_CHARPOS (*it
);
7774 bytepos
= IT_STRING_BYTEPOS (*it
);
7778 stop
= it
->end_charpos
;
7779 charpos
= IT_CHARPOS (*it
);
7780 bytepos
= IT_BYTEPOS (*it
);
7782 if (it
->bidi_it
.scan_dir
< 0)
7784 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7789 /* Load IT with the next display element from Lisp string IT->string.
7790 IT->current.string_pos is the current position within the string.
7791 If IT->current.overlay_string_index >= 0, the Lisp string is an
7795 next_element_from_string (struct it
*it
)
7797 struct text_pos position
;
7799 eassert (STRINGP (it
->string
));
7800 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7801 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7802 position
= it
->current
.string_pos
;
7804 /* With bidi reordering, the character to display might not be the
7805 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7806 that we were reseat()ed to a new string, whose paragraph
7807 direction is not known. */
7808 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7810 get_visually_first_element (it
);
7811 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7814 /* Time to check for invisible text? */
7815 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7817 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7820 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7821 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7823 /* With bidi non-linear iteration, we could find
7824 ourselves far beyond the last computed stop_charpos,
7825 with several other stop positions in between that we
7826 missed. Scan them all now, in buffer's logical
7827 order, until we find and handle the last stop_charpos
7828 that precedes our current position. */
7829 handle_stop_backwards (it
, it
->stop_charpos
);
7830 return GET_NEXT_DISPLAY_ELEMENT (it
);
7836 /* Take note of the stop position we just moved
7837 across, for when we will move back across it. */
7838 it
->prev_stop
= it
->stop_charpos
;
7839 /* If we are at base paragraph embedding level, take
7840 note of the last stop position seen at this
7842 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7843 it
->base_level_stop
= it
->stop_charpos
;
7847 /* Since a handler may have changed IT->method, we must
7849 return GET_NEXT_DISPLAY_ELEMENT (it
);
7853 /* If we are before prev_stop, we may have overstepped
7854 on our way backwards a stop_pos, and if so, we need
7855 to handle that stop_pos. */
7856 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7857 /* We can sometimes back up for reasons that have nothing
7858 to do with bidi reordering. E.g., compositions. The
7859 code below is only needed when we are above the base
7860 embedding level, so test for that explicitly. */
7861 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7863 /* If we lost track of base_level_stop, we have no better
7864 place for handle_stop_backwards to start from than string
7865 beginning. This happens, e.g., when we were reseated to
7866 the previous screenful of text by vertical-motion. */
7867 if (it
->base_level_stop
<= 0
7868 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7869 it
->base_level_stop
= 0;
7870 handle_stop_backwards (it
, it
->base_level_stop
);
7871 return GET_NEXT_DISPLAY_ELEMENT (it
);
7875 if (it
->current
.overlay_string_index
>= 0)
7877 /* Get the next character from an overlay string. In overlay
7878 strings, there is no field width or padding with spaces to
7880 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7885 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7886 IT_STRING_BYTEPOS (*it
),
7887 it
->bidi_it
.scan_dir
< 0
7889 : SCHARS (it
->string
))
7890 && next_element_from_composition (it
))
7894 else if (STRING_MULTIBYTE (it
->string
))
7896 const unsigned char *s
= (SDATA (it
->string
)
7897 + IT_STRING_BYTEPOS (*it
));
7898 it
->c
= string_char_and_length (s
, &it
->len
);
7902 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7908 /* Get the next character from a Lisp string that is not an
7909 overlay string. Such strings come from the mode line, for
7910 example. We may have to pad with spaces, or truncate the
7911 string. See also next_element_from_c_string. */
7912 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7917 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7919 /* Pad with spaces. */
7920 it
->c
= ' ', it
->len
= 1;
7921 CHARPOS (position
) = BYTEPOS (position
) = -1;
7923 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7924 IT_STRING_BYTEPOS (*it
),
7925 it
->bidi_it
.scan_dir
< 0
7927 : it
->string_nchars
)
7928 && next_element_from_composition (it
))
7932 else if (STRING_MULTIBYTE (it
->string
))
7934 const unsigned char *s
= (SDATA (it
->string
)
7935 + IT_STRING_BYTEPOS (*it
));
7936 it
->c
= string_char_and_length (s
, &it
->len
);
7940 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7945 /* Record what we have and where it came from. */
7946 it
->what
= IT_CHARACTER
;
7947 it
->object
= it
->string
;
7948 it
->position
= position
;
7953 /* Load IT with next display element from C string IT->s.
7954 IT->string_nchars is the maximum number of characters to return
7955 from the string. IT->end_charpos may be greater than
7956 IT->string_nchars when this function is called, in which case we
7957 may have to return padding spaces. Value is zero if end of string
7958 reached, including padding spaces. */
7961 next_element_from_c_string (struct it
*it
)
7963 bool success_p
= true;
7966 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7967 it
->what
= IT_CHARACTER
;
7968 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7969 it
->object
= make_number (0);
7971 /* With bidi reordering, the character to display might not be the
7972 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7973 we were reseated to a new string, whose paragraph direction is
7975 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7976 get_visually_first_element (it
);
7978 /* IT's position can be greater than IT->string_nchars in case a
7979 field width or precision has been specified when the iterator was
7981 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7983 /* End of the game. */
7987 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7989 /* Pad with spaces. */
7990 it
->c
= ' ', it
->len
= 1;
7991 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7993 else if (it
->multibyte_p
)
7994 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7996 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8002 /* Set up IT to return characters from an ellipsis, if appropriate.
8003 The definition of the ellipsis glyphs may come from a display table
8004 entry. This function fills IT with the first glyph from the
8005 ellipsis if an ellipsis is to be displayed. */
8008 next_element_from_ellipsis (struct it
*it
)
8010 if (it
->selective_display_ellipsis_p
)
8011 setup_for_ellipsis (it
, it
->len
);
8014 /* The face at the current position may be different from the
8015 face we find after the invisible text. Remember what it
8016 was in IT->saved_face_id, and signal that it's there by
8017 setting face_before_selective_p. */
8018 it
->saved_face_id
= it
->face_id
;
8019 it
->method
= GET_FROM_BUFFER
;
8020 it
->object
= it
->w
->contents
;
8021 reseat_at_next_visible_line_start (it
, 1);
8022 it
->face_before_selective_p
= true;
8025 return GET_NEXT_DISPLAY_ELEMENT (it
);
8029 /* Deliver an image display element. The iterator IT is already
8030 filled with image information (done in handle_display_prop). Value
8035 next_element_from_image (struct it
*it
)
8037 it
->what
= IT_IMAGE
;
8038 it
->ignore_overlay_strings_at_pos_p
= 0;
8042 #ifdef HAVE_XWIDGETS
8043 /* im not sure about this FIXME JAVE*/
8045 next_element_from_xwidget (struct it
*it
)
8047 it
->what
= IT_XWIDGET
;
8053 /* Fill iterator IT with next display element from a stretch glyph
8054 property. IT->object is the value of the text property. Value is
8058 next_element_from_stretch (struct it
*it
)
8060 it
->what
= IT_STRETCH
;
8064 /* Scan backwards from IT's current position until we find a stop
8065 position, or until BEGV. This is called when we find ourself
8066 before both the last known prev_stop and base_level_stop while
8067 reordering bidirectional text. */
8070 compute_stop_pos_backwards (struct it
*it
)
8072 const int SCAN_BACK_LIMIT
= 1000;
8073 struct text_pos pos
;
8074 struct display_pos save_current
= it
->current
;
8075 struct text_pos save_position
= it
->position
;
8076 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8077 ptrdiff_t where_we_are
= charpos
;
8078 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8079 ptrdiff_t save_end_pos
= it
->end_charpos
;
8081 eassert (NILP (it
->string
) && !it
->s
);
8082 eassert (it
->bidi_p
);
8086 it
->end_charpos
= min (charpos
+ 1, ZV
);
8087 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8088 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8089 reseat_1 (it
, pos
, 0);
8090 compute_stop_pos (it
);
8091 /* We must advance forward, right? */
8092 if (it
->stop_charpos
<= charpos
)
8095 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8097 if (it
->stop_charpos
<= where_we_are
)
8098 it
->prev_stop
= it
->stop_charpos
;
8100 it
->prev_stop
= BEGV
;
8102 it
->current
= save_current
;
8103 it
->position
= save_position
;
8104 it
->stop_charpos
= save_stop_pos
;
8105 it
->end_charpos
= save_end_pos
;
8108 /* Scan forward from CHARPOS in the current buffer/string, until we
8109 find a stop position > current IT's position. Then handle the stop
8110 position before that. This is called when we bump into a stop
8111 position while reordering bidirectional text. CHARPOS should be
8112 the last previously processed stop_pos (or BEGV/0, if none were
8113 processed yet) whose position is less that IT's current
8117 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8119 int bufp
= !STRINGP (it
->string
);
8120 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8121 struct display_pos save_current
= it
->current
;
8122 struct text_pos save_position
= it
->position
;
8123 struct text_pos pos1
;
8124 ptrdiff_t next_stop
;
8126 /* Scan in strict logical order. */
8127 eassert (it
->bidi_p
);
8131 it
->prev_stop
= charpos
;
8134 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8135 reseat_1 (it
, pos1
, 0);
8138 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8139 compute_stop_pos (it
);
8140 /* We must advance forward, right? */
8141 if (it
->stop_charpos
<= it
->prev_stop
)
8143 charpos
= it
->stop_charpos
;
8145 while (charpos
<= where_we_are
);
8148 it
->current
= save_current
;
8149 it
->position
= save_position
;
8150 next_stop
= it
->stop_charpos
;
8151 it
->stop_charpos
= it
->prev_stop
;
8153 it
->stop_charpos
= next_stop
;
8156 /* Load IT with the next display element from current_buffer. Value
8157 is zero if end of buffer reached. IT->stop_charpos is the next
8158 position at which to stop and check for text properties or buffer
8162 next_element_from_buffer (struct it
*it
)
8164 bool success_p
= true;
8166 eassert (IT_CHARPOS (*it
) >= BEGV
);
8167 eassert (NILP (it
->string
) && !it
->s
);
8168 eassert (!it
->bidi_p
8169 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8170 && it
->bidi_it
.string
.s
== NULL
));
8172 /* With bidi reordering, the character to display might not be the
8173 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8174 we were reseat()ed to a new buffer position, which is potentially
8175 a different paragraph. */
8176 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8178 get_visually_first_element (it
);
8179 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8182 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8184 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8186 int overlay_strings_follow_p
;
8188 /* End of the game, except when overlay strings follow that
8189 haven't been returned yet. */
8190 if (it
->overlay_strings_at_end_processed_p
)
8191 overlay_strings_follow_p
= 0;
8194 it
->overlay_strings_at_end_processed_p
= true;
8195 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8198 if (overlay_strings_follow_p
)
8199 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8203 it
->position
= it
->current
.pos
;
8207 else if (!(!it
->bidi_p
8208 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8209 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8211 /* With bidi non-linear iteration, we could find ourselves
8212 far beyond the last computed stop_charpos, with several
8213 other stop positions in between that we missed. Scan
8214 them all now, in buffer's logical order, until we find
8215 and handle the last stop_charpos that precedes our
8216 current position. */
8217 handle_stop_backwards (it
, it
->stop_charpos
);
8218 return GET_NEXT_DISPLAY_ELEMENT (it
);
8224 /* Take note of the stop position we just moved across,
8225 for when we will move back across it. */
8226 it
->prev_stop
= it
->stop_charpos
;
8227 /* If we are at base paragraph embedding level, take
8228 note of the last stop position seen at this
8230 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8231 it
->base_level_stop
= it
->stop_charpos
;
8234 return GET_NEXT_DISPLAY_ELEMENT (it
);
8238 /* If we are before prev_stop, we may have overstepped on
8239 our way backwards a stop_pos, and if so, we need to
8240 handle that stop_pos. */
8241 && IT_CHARPOS (*it
) < it
->prev_stop
8242 /* We can sometimes back up for reasons that have nothing
8243 to do with bidi reordering. E.g., compositions. The
8244 code below is only needed when we are above the base
8245 embedding level, so test for that explicitly. */
8246 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8248 if (it
->base_level_stop
<= 0
8249 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8251 /* If we lost track of base_level_stop, we need to find
8252 prev_stop by looking backwards. This happens, e.g., when
8253 we were reseated to the previous screenful of text by
8255 it
->base_level_stop
= BEGV
;
8256 compute_stop_pos_backwards (it
);
8257 handle_stop_backwards (it
, it
->prev_stop
);
8260 handle_stop_backwards (it
, it
->base_level_stop
);
8261 return GET_NEXT_DISPLAY_ELEMENT (it
);
8265 /* No face changes, overlays etc. in sight, so just return a
8266 character from current_buffer. */
8270 /* We moved to the next buffer position, so any info about
8271 previously seen overlays is no longer valid. */
8272 it
->ignore_overlay_strings_at_pos_p
= 0;
8274 /* Maybe run the redisplay end trigger hook. Performance note:
8275 This doesn't seem to cost measurable time. */
8276 if (it
->redisplay_end_trigger_charpos
8278 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8279 run_redisplay_end_trigger_hook (it
);
8281 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8282 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8284 && next_element_from_composition (it
))
8289 /* Get the next character, maybe multibyte. */
8290 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8291 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8292 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8294 it
->c
= *p
, it
->len
= 1;
8296 /* Record what we have and where it came from. */
8297 it
->what
= IT_CHARACTER
;
8298 it
->object
= it
->w
->contents
;
8299 it
->position
= it
->current
.pos
;
8301 /* Normally we return the character found above, except when we
8302 really want to return an ellipsis for selective display. */
8307 /* A value of selective > 0 means hide lines indented more
8308 than that number of columns. */
8309 if (it
->selective
> 0
8310 && IT_CHARPOS (*it
) + 1 < ZV
8311 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8312 IT_BYTEPOS (*it
) + 1,
8315 success_p
= next_element_from_ellipsis (it
);
8316 it
->dpvec_char_len
= -1;
8319 else if (it
->c
== '\r' && it
->selective
== -1)
8321 /* A value of selective == -1 means that everything from the
8322 CR to the end of the line is invisible, with maybe an
8323 ellipsis displayed for it. */
8324 success_p
= next_element_from_ellipsis (it
);
8325 it
->dpvec_char_len
= -1;
8330 /* Value is zero if end of buffer reached. */
8331 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8336 /* Run the redisplay end trigger hook for IT. */
8339 run_redisplay_end_trigger_hook (struct it
*it
)
8341 /* IT->glyph_row should be non-null, i.e. we should be actually
8342 displaying something, or otherwise we should not run the hook. */
8343 eassert (it
->glyph_row
);
8345 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8346 it
->redisplay_end_trigger_charpos
= 0;
8348 /* Since we are *trying* to run these functions, don't try to run
8349 them again, even if they get an error. */
8350 wset_redisplay_end_trigger (it
->w
, Qnil
);
8351 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8352 make_number (charpos
));
8354 /* Notice if it changed the face of the character we are on. */
8355 handle_face_prop (it
);
8359 /* Deliver a composition display element. Unlike the other
8360 next_element_from_XXX, this function is not registered in the array
8361 get_next_element[]. It is called from next_element_from_buffer and
8362 next_element_from_string when necessary. */
8365 next_element_from_composition (struct it
*it
)
8367 it
->what
= IT_COMPOSITION
;
8368 it
->len
= it
->cmp_it
.nbytes
;
8369 if (STRINGP (it
->string
))
8373 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8374 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8377 it
->position
= it
->current
.string_pos
;
8378 it
->object
= it
->string
;
8379 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8380 IT_STRING_BYTEPOS (*it
), it
->string
);
8386 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8387 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8390 if (it
->bidi_it
.new_paragraph
)
8391 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8392 /* Resync the bidi iterator with IT's new position.
8393 FIXME: this doesn't support bidirectional text. */
8394 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8395 bidi_move_to_visually_next (&it
->bidi_it
);
8399 it
->position
= it
->current
.pos
;
8400 it
->object
= it
->w
->contents
;
8401 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8402 IT_BYTEPOS (*it
), Qnil
);
8409 /***********************************************************************
8410 Moving an iterator without producing glyphs
8411 ***********************************************************************/
8413 /* Check if iterator is at a position corresponding to a valid buffer
8414 position after some move_it_ call. */
8416 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8417 ((it)->method == GET_FROM_STRING \
8418 ? IT_STRING_CHARPOS (*it) == 0 \
8422 /* Move iterator IT to a specified buffer or X position within one
8423 line on the display without producing glyphs.
8425 OP should be a bit mask including some or all of these bits:
8426 MOVE_TO_X: Stop upon reaching x-position TO_X.
8427 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8428 Regardless of OP's value, stop upon reaching the end of the display line.
8430 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8431 This means, in particular, that TO_X includes window's horizontal
8434 The return value has several possible values that
8435 say what condition caused the scan to stop:
8437 MOVE_POS_MATCH_OR_ZV
8438 - when TO_POS or ZV was reached.
8441 -when TO_X was reached before TO_POS or ZV were reached.
8444 - when we reached the end of the display area and the line must
8448 - when we reached the end of the display area and the line is
8452 - when we stopped at a line end, i.e. a newline or a CR and selective
8455 static enum move_it_result
8456 move_it_in_display_line_to (struct it
*it
,
8457 ptrdiff_t to_charpos
, int to_x
,
8458 enum move_operation_enum op
)
8460 enum move_it_result result
= MOVE_UNDEFINED
;
8461 struct glyph_row
*saved_glyph_row
;
8462 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8463 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8464 void *ppos_data
= NULL
;
8466 enum it_method prev_method
= it
->method
;
8467 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8468 int saw_smaller_pos
= prev_pos
< to_charpos
;
8470 /* Don't produce glyphs in produce_glyphs. */
8471 saved_glyph_row
= it
->glyph_row
;
8472 it
->glyph_row
= NULL
;
8474 /* Use wrap_it to save a copy of IT wherever a word wrap could
8475 occur. Use atpos_it to save a copy of IT at the desired buffer
8476 position, if found, so that we can scan ahead and check if the
8477 word later overshoots the window edge. Use atx_it similarly, for
8483 /* Use ppos_it under bidi reordering to save a copy of IT for the
8484 initial position. We restore that position in IT when we have
8485 scanned the entire display line without finding a match for
8486 TO_CHARPOS and all the character positions are greater than
8487 TO_CHARPOS. We then restart the scan from the initial position,
8488 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8489 the closest to TO_CHARPOS. */
8492 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8494 SAVE_IT (ppos_it
, *it
, ppos_data
);
8495 closest_pos
= IT_CHARPOS (*it
);
8501 #define BUFFER_POS_REACHED_P() \
8502 ((op & MOVE_TO_POS) != 0 \
8503 && BUFFERP (it->object) \
8504 && (IT_CHARPOS (*it) == to_charpos \
8506 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8507 && IT_CHARPOS (*it) > to_charpos) \
8508 || (it->what == IT_COMPOSITION \
8509 && ((IT_CHARPOS (*it) > to_charpos \
8510 && to_charpos >= it->cmp_it.charpos) \
8511 || (IT_CHARPOS (*it) < to_charpos \
8512 && to_charpos <= it->cmp_it.charpos)))) \
8513 && (it->method == GET_FROM_BUFFER \
8514 || (it->method == GET_FROM_DISPLAY_VECTOR \
8515 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8517 /* If there's a line-/wrap-prefix, handle it. */
8518 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8519 && it
->current_y
< it
->last_visible_y
)
8520 handle_line_prefix (it
);
8522 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8523 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8527 int x
, i
, ascent
= 0, descent
= 0;
8529 /* Utility macro to reset an iterator with x, ascent, and descent. */
8530 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8531 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8532 (IT)->max_descent = descent)
8534 /* Stop if we move beyond TO_CHARPOS (after an image or a
8535 display string or stretch glyph). */
8536 if ((op
& MOVE_TO_POS
) != 0
8537 && BUFFERP (it
->object
)
8538 && it
->method
== GET_FROM_BUFFER
8540 /* When the iterator is at base embedding level, we
8541 are guaranteed that characters are delivered for
8542 display in strictly increasing order of their
8543 buffer positions. */
8544 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8545 && IT_CHARPOS (*it
) > to_charpos
)
8547 && (prev_method
== GET_FROM_IMAGE
8548 || prev_method
== GET_FROM_STRETCH
8549 || prev_method
== GET_FROM_STRING
)
8550 /* Passed TO_CHARPOS from left to right. */
8551 && ((prev_pos
< to_charpos
8552 && IT_CHARPOS (*it
) > to_charpos
)
8553 /* Passed TO_CHARPOS from right to left. */
8554 || (prev_pos
> to_charpos
8555 && IT_CHARPOS (*it
) < to_charpos
)))))
8557 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8559 result
= MOVE_POS_MATCH_OR_ZV
;
8562 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8563 /* If wrap_it is valid, the current position might be in a
8564 word that is wrapped. So, save the iterator in
8565 atpos_it and continue to see if wrapping happens. */
8566 SAVE_IT (atpos_it
, *it
, atpos_data
);
8569 /* Stop when ZV reached.
8570 We used to stop here when TO_CHARPOS reached as well, but that is
8571 too soon if this glyph does not fit on this line. So we handle it
8572 explicitly below. */
8573 if (!get_next_display_element (it
))
8575 result
= MOVE_POS_MATCH_OR_ZV
;
8579 if (it
->line_wrap
== TRUNCATE
)
8581 if (BUFFER_POS_REACHED_P ())
8583 result
= MOVE_POS_MATCH_OR_ZV
;
8589 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8591 if (IT_DISPLAYING_WHITESPACE (it
))
8595 /* We have reached a glyph that follows one or more
8596 whitespace characters. If the position is
8597 already found, we are done. */
8598 if (atpos_it
.sp
>= 0)
8600 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8601 result
= MOVE_POS_MATCH_OR_ZV
;
8606 RESTORE_IT (it
, &atx_it
, atx_data
);
8607 result
= MOVE_X_REACHED
;
8610 /* Otherwise, we can wrap here. */
8611 SAVE_IT (wrap_it
, *it
, wrap_data
);
8617 /* Remember the line height for the current line, in case
8618 the next element doesn't fit on the line. */
8619 ascent
= it
->max_ascent
;
8620 descent
= it
->max_descent
;
8622 /* The call to produce_glyphs will get the metrics of the
8623 display element IT is loaded with. Record the x-position
8624 before this display element, in case it doesn't fit on the
8628 PRODUCE_GLYPHS (it
);
8630 if (it
->area
!= TEXT_AREA
)
8632 prev_method
= it
->method
;
8633 if (it
->method
== GET_FROM_BUFFER
)
8634 prev_pos
= IT_CHARPOS (*it
);
8635 set_iterator_to_next (it
, 1);
8636 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8637 SET_TEXT_POS (this_line_min_pos
,
8638 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8640 && (op
& MOVE_TO_POS
)
8641 && IT_CHARPOS (*it
) > to_charpos
8642 && IT_CHARPOS (*it
) < closest_pos
)
8643 closest_pos
= IT_CHARPOS (*it
);
8647 /* The number of glyphs we get back in IT->nglyphs will normally
8648 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8649 character on a terminal frame, or (iii) a line end. For the
8650 second case, IT->nglyphs - 1 padding glyphs will be present.
8651 (On X frames, there is only one glyph produced for a
8652 composite character.)
8654 The behavior implemented below means, for continuation lines,
8655 that as many spaces of a TAB as fit on the current line are
8656 displayed there. For terminal frames, as many glyphs of a
8657 multi-glyph character are displayed in the current line, too.
8658 This is what the old redisplay code did, and we keep it that
8659 way. Under X, the whole shape of a complex character must
8660 fit on the line or it will be completely displayed in the
8663 Note that both for tabs and padding glyphs, all glyphs have
8667 /* More than one glyph or glyph doesn't fit on line. All
8668 glyphs have the same width. */
8669 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8671 int x_before_this_char
= x
;
8672 int hpos_before_this_char
= it
->hpos
;
8674 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8676 new_x
= x
+ single_glyph_width
;
8678 /* We want to leave anything reaching TO_X to the caller. */
8679 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8681 if (BUFFER_POS_REACHED_P ())
8683 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8684 goto buffer_pos_reached
;
8685 if (atpos_it
.sp
< 0)
8687 SAVE_IT (atpos_it
, *it
, atpos_data
);
8688 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8693 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8696 result
= MOVE_X_REACHED
;
8701 SAVE_IT (atx_it
, *it
, atx_data
);
8702 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8707 if (/* Lines are continued. */
8708 it
->line_wrap
!= TRUNCATE
8709 && (/* And glyph doesn't fit on the line. */
8710 new_x
> it
->last_visible_x
8711 /* Or it fits exactly and we're on a window
8713 || (new_x
== it
->last_visible_x
8714 && FRAME_WINDOW_P (it
->f
)
8715 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8716 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8717 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8719 if (/* IT->hpos == 0 means the very first glyph
8720 doesn't fit on the line, e.g. a wide image. */
8722 || (new_x
== it
->last_visible_x
8723 && FRAME_WINDOW_P (it
->f
)))
8726 it
->current_x
= new_x
;
8728 /* The character's last glyph just barely fits
8730 if (i
== it
->nglyphs
- 1)
8732 /* If this is the destination position,
8733 return a position *before* it in this row,
8734 now that we know it fits in this row. */
8735 if (BUFFER_POS_REACHED_P ())
8737 if (it
->line_wrap
!= WORD_WRAP
8740 it
->hpos
= hpos_before_this_char
;
8741 it
->current_x
= x_before_this_char
;
8742 result
= MOVE_POS_MATCH_OR_ZV
;
8745 if (it
->line_wrap
== WORD_WRAP
8748 SAVE_IT (atpos_it
, *it
, atpos_data
);
8749 atpos_it
.current_x
= x_before_this_char
;
8750 atpos_it
.hpos
= hpos_before_this_char
;
8754 prev_method
= it
->method
;
8755 if (it
->method
== GET_FROM_BUFFER
)
8756 prev_pos
= IT_CHARPOS (*it
);
8757 set_iterator_to_next (it
, 1);
8758 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8759 SET_TEXT_POS (this_line_min_pos
,
8760 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8761 /* On graphical terminals, newlines may
8762 "overflow" into the fringe if
8763 overflow-newline-into-fringe is non-nil.
8764 On text terminals, and on graphical
8765 terminals with no right margin, newlines
8766 may overflow into the last glyph on the
8768 if (!FRAME_WINDOW_P (it
->f
)
8770 && it
->bidi_it
.paragraph_dir
== R2L
)
8771 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8772 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8773 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8775 if (!get_next_display_element (it
))
8777 result
= MOVE_POS_MATCH_OR_ZV
;
8780 if (BUFFER_POS_REACHED_P ())
8782 if (ITERATOR_AT_END_OF_LINE_P (it
))
8783 result
= MOVE_POS_MATCH_OR_ZV
;
8785 result
= MOVE_LINE_CONTINUED
;
8788 if (ITERATOR_AT_END_OF_LINE_P (it
)
8789 && (it
->line_wrap
!= WORD_WRAP
8791 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8793 result
= MOVE_NEWLINE_OR_CR
;
8800 IT_RESET_X_ASCENT_DESCENT (it
);
8802 if (wrap_it
.sp
>= 0)
8804 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8809 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8811 result
= MOVE_LINE_CONTINUED
;
8815 if (BUFFER_POS_REACHED_P ())
8817 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8818 goto buffer_pos_reached
;
8819 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8821 SAVE_IT (atpos_it
, *it
, atpos_data
);
8822 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8826 if (new_x
> it
->first_visible_x
)
8828 /* Glyph is visible. Increment number of glyphs that
8829 would be displayed. */
8834 if (result
!= MOVE_UNDEFINED
)
8837 else if (BUFFER_POS_REACHED_P ())
8840 IT_RESET_X_ASCENT_DESCENT (it
);
8841 result
= MOVE_POS_MATCH_OR_ZV
;
8844 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8846 /* Stop when TO_X specified and reached. This check is
8847 necessary here because of lines consisting of a line end,
8848 only. The line end will not produce any glyphs and we
8849 would never get MOVE_X_REACHED. */
8850 eassert (it
->nglyphs
== 0);
8851 result
= MOVE_X_REACHED
;
8855 /* Is this a line end? If yes, we're done. */
8856 if (ITERATOR_AT_END_OF_LINE_P (it
))
8858 /* If we are past TO_CHARPOS, but never saw any character
8859 positions smaller than TO_CHARPOS, return
8860 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8862 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8864 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8866 if (closest_pos
< ZV
)
8868 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8869 /* Don't recurse if closest_pos is equal to
8870 to_charpos, since we have just tried that. */
8871 if (closest_pos
!= to_charpos
)
8872 move_it_in_display_line_to (it
, closest_pos
, -1,
8874 result
= MOVE_POS_MATCH_OR_ZV
;
8877 goto buffer_pos_reached
;
8879 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8880 && IT_CHARPOS (*it
) > to_charpos
)
8881 goto buffer_pos_reached
;
8883 result
= MOVE_NEWLINE_OR_CR
;
8886 result
= MOVE_NEWLINE_OR_CR
;
8890 prev_method
= it
->method
;
8891 if (it
->method
== GET_FROM_BUFFER
)
8892 prev_pos
= IT_CHARPOS (*it
);
8893 /* The current display element has been consumed. Advance
8895 set_iterator_to_next (it
, 1);
8896 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8897 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8898 if (IT_CHARPOS (*it
) < to_charpos
)
8899 saw_smaller_pos
= 1;
8901 && (op
& MOVE_TO_POS
)
8902 && IT_CHARPOS (*it
) >= to_charpos
8903 && IT_CHARPOS (*it
) < closest_pos
)
8904 closest_pos
= IT_CHARPOS (*it
);
8906 /* Stop if lines are truncated and IT's current x-position is
8907 past the right edge of the window now. */
8908 if (it
->line_wrap
== TRUNCATE
8909 && it
->current_x
>= it
->last_visible_x
)
8911 if (!FRAME_WINDOW_P (it
->f
)
8912 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8913 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8914 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8915 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8919 if ((at_eob_p
= !get_next_display_element (it
))
8920 || BUFFER_POS_REACHED_P ()
8921 /* If we are past TO_CHARPOS, but never saw any
8922 character positions smaller than TO_CHARPOS,
8923 return MOVE_POS_MATCH_OR_ZV, like the
8924 unidirectional display did. */
8925 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8927 && IT_CHARPOS (*it
) > to_charpos
))
8930 && !BUFFER_POS_REACHED_P ()
8931 && !at_eob_p
&& closest_pos
< ZV
)
8933 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8934 if (closest_pos
!= to_charpos
)
8935 move_it_in_display_line_to (it
, closest_pos
, -1,
8938 result
= MOVE_POS_MATCH_OR_ZV
;
8941 if (ITERATOR_AT_END_OF_LINE_P (it
))
8943 result
= MOVE_NEWLINE_OR_CR
;
8947 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8949 && IT_CHARPOS (*it
) > to_charpos
)
8951 if (closest_pos
< ZV
)
8953 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8954 if (closest_pos
!= to_charpos
)
8955 move_it_in_display_line_to (it
, closest_pos
, -1,
8958 result
= MOVE_POS_MATCH_OR_ZV
;
8961 result
= MOVE_LINE_TRUNCATED
;
8964 #undef IT_RESET_X_ASCENT_DESCENT
8967 #undef BUFFER_POS_REACHED_P
8969 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8970 restore the saved iterator. */
8971 if (atpos_it
.sp
>= 0)
8972 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8973 else if (atx_it
.sp
>= 0)
8974 RESTORE_IT (it
, &atx_it
, atx_data
);
8979 bidi_unshelve_cache (atpos_data
, 1);
8981 bidi_unshelve_cache (atx_data
, 1);
8983 bidi_unshelve_cache (wrap_data
, 1);
8985 bidi_unshelve_cache (ppos_data
, 1);
8987 /* Restore the iterator settings altered at the beginning of this
8989 it
->glyph_row
= saved_glyph_row
;
8993 /* For external use. */
8995 move_it_in_display_line (struct it
*it
,
8996 ptrdiff_t to_charpos
, int to_x
,
8997 enum move_operation_enum op
)
8999 if (it
->line_wrap
== WORD_WRAP
9000 && (op
& MOVE_TO_X
))
9003 void *save_data
= NULL
;
9006 SAVE_IT (save_it
, *it
, save_data
);
9007 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9008 /* When word-wrap is on, TO_X may lie past the end
9009 of a wrapped line. Then it->current is the
9010 character on the next line, so backtrack to the
9011 space before the wrap point. */
9012 if (skip
== MOVE_LINE_CONTINUED
)
9014 int prev_x
= max (it
->current_x
- 1, 0);
9015 RESTORE_IT (it
, &save_it
, save_data
);
9016 move_it_in_display_line_to
9017 (it
, -1, prev_x
, MOVE_TO_X
);
9020 bidi_unshelve_cache (save_data
, 1);
9023 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9027 /* Move IT forward until it satisfies one or more of the criteria in
9028 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9030 OP is a bit-mask that specifies where to stop, and in particular,
9031 which of those four position arguments makes a difference. See the
9032 description of enum move_operation_enum.
9034 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9035 screen line, this function will set IT to the next position that is
9036 displayed to the right of TO_CHARPOS on the screen.
9038 Return the maximum pixel length of any line scanned but never more
9039 than it.last_visible_x. */
9042 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9044 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9045 int line_height
, line_start_x
= 0, reached
= 0;
9046 int max_current_x
= 0;
9047 void *backup_data
= NULL
;
9051 if (op
& MOVE_TO_VPOS
)
9053 /* If no TO_CHARPOS and no TO_X specified, stop at the
9054 start of the line TO_VPOS. */
9055 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9057 if (it
->vpos
== to_vpos
)
9063 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9067 /* TO_VPOS >= 0 means stop at TO_X in the line at
9068 TO_VPOS, or at TO_POS, whichever comes first. */
9069 if (it
->vpos
== to_vpos
)
9075 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9077 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9082 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9084 /* We have reached TO_X but not in the line we want. */
9085 skip
= move_it_in_display_line_to (it
, to_charpos
,
9087 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9095 else if (op
& MOVE_TO_Y
)
9097 struct it it_backup
;
9099 if (it
->line_wrap
== WORD_WRAP
)
9100 SAVE_IT (it_backup
, *it
, backup_data
);
9102 /* TO_Y specified means stop at TO_X in the line containing
9103 TO_Y---or at TO_CHARPOS if this is reached first. The
9104 problem is that we can't really tell whether the line
9105 contains TO_Y before we have completely scanned it, and
9106 this may skip past TO_X. What we do is to first scan to
9109 If TO_X is not specified, use a TO_X of zero. The reason
9110 is to make the outcome of this function more predictable.
9111 If we didn't use TO_X == 0, we would stop at the end of
9112 the line which is probably not what a caller would expect
9114 skip
= move_it_in_display_line_to
9115 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9116 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9118 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9119 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9121 else if (skip
== MOVE_X_REACHED
)
9123 /* If TO_X was reached, we want to know whether TO_Y is
9124 in the line. We know this is the case if the already
9125 scanned glyphs make the line tall enough. Otherwise,
9126 we must check by scanning the rest of the line. */
9127 line_height
= it
->max_ascent
+ it
->max_descent
;
9128 if (to_y
>= it
->current_y
9129 && to_y
< it
->current_y
+ line_height
)
9134 SAVE_IT (it_backup
, *it
, backup_data
);
9135 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9136 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9138 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9139 line_height
= it
->max_ascent
+ it
->max_descent
;
9140 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9142 if (to_y
>= it
->current_y
9143 && to_y
< it
->current_y
+ line_height
)
9145 /* If TO_Y is in this line and TO_X was reached
9146 above, we scanned too far. We have to restore
9147 IT's settings to the ones before skipping. But
9148 keep the more accurate values of max_ascent and
9149 max_descent we've found while skipping the rest
9150 of the line, for the sake of callers, such as
9151 pos_visible_p, that need to know the line
9153 int max_ascent
= it
->max_ascent
;
9154 int max_descent
= it
->max_descent
;
9156 RESTORE_IT (it
, &it_backup
, backup_data
);
9157 it
->max_ascent
= max_ascent
;
9158 it
->max_descent
= max_descent
;
9164 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9170 /* Check whether TO_Y is in this line. */
9171 line_height
= it
->max_ascent
+ it
->max_descent
;
9172 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9174 if (to_y
>= it
->current_y
9175 && to_y
< it
->current_y
+ line_height
)
9177 if (to_y
> it
->current_y
)
9178 max_current_x
= max (it
->current_x
, max_current_x
);
9180 /* When word-wrap is on, TO_X may lie past the end
9181 of a wrapped line. Then it->current is the
9182 character on the next line, so backtrack to the
9183 space before the wrap point. */
9184 if (skip
== MOVE_LINE_CONTINUED
9185 && it
->line_wrap
== WORD_WRAP
)
9187 int prev_x
= max (it
->current_x
- 1, 0);
9188 RESTORE_IT (it
, &it_backup
, backup_data
);
9189 skip
= move_it_in_display_line_to
9190 (it
, -1, prev_x
, MOVE_TO_X
);
9199 max_current_x
= max (it
->current_x
, max_current_x
);
9203 else if (BUFFERP (it
->object
)
9204 && (it
->method
== GET_FROM_BUFFER
9205 || it
->method
== GET_FROM_STRETCH
)
9206 && IT_CHARPOS (*it
) >= to_charpos
9207 /* Under bidi iteration, a call to set_iterator_to_next
9208 can scan far beyond to_charpos if the initial
9209 portion of the next line needs to be reordered. In
9210 that case, give move_it_in_display_line_to another
9213 && it
->bidi_it
.scan_dir
== -1))
9214 skip
= MOVE_POS_MATCH_OR_ZV
;
9216 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9220 case MOVE_POS_MATCH_OR_ZV
:
9221 max_current_x
= max (it
->current_x
, max_current_x
);
9225 case MOVE_NEWLINE_OR_CR
:
9226 max_current_x
= max (it
->current_x
, max_current_x
);
9227 set_iterator_to_next (it
, 1);
9228 it
->continuation_lines_width
= 0;
9231 case MOVE_LINE_TRUNCATED
:
9232 max_current_x
= it
->last_visible_x
;
9233 it
->continuation_lines_width
= 0;
9234 reseat_at_next_visible_line_start (it
, 0);
9235 if ((op
& MOVE_TO_POS
) != 0
9236 && IT_CHARPOS (*it
) > to_charpos
)
9243 case MOVE_LINE_CONTINUED
:
9244 max_current_x
= it
->last_visible_x
;
9245 /* For continued lines ending in a tab, some of the glyphs
9246 associated with the tab are displayed on the current
9247 line. Since it->current_x does not include these glyphs,
9248 we use it->last_visible_x instead. */
9251 it
->continuation_lines_width
+= it
->last_visible_x
;
9252 /* When moving by vpos, ensure that the iterator really
9253 advances to the next line (bug#847, bug#969). Fixme:
9254 do we need to do this in other circumstances? */
9255 if (it
->current_x
!= it
->last_visible_x
9256 && (op
& MOVE_TO_VPOS
)
9257 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9259 line_start_x
= it
->current_x
+ it
->pixel_width
9260 - it
->last_visible_x
;
9261 if (FRAME_WINDOW_P (it
->f
))
9263 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9264 struct font
*face_font
= face
->font
;
9266 /* When display_line produces a continued line
9267 that ends in a TAB, it skips a tab stop that
9268 is closer than the font's space character
9269 width (see x_produce_glyphs where it produces
9270 the stretch glyph which represents a TAB).
9271 We need to reproduce the same logic here. */
9272 eassert (face_font
);
9275 if (line_start_x
< face_font
->space_width
)
9277 += it
->tab_width
* face_font
->space_width
;
9280 set_iterator_to_next (it
, 0);
9284 it
->continuation_lines_width
+= it
->current_x
;
9291 /* Reset/increment for the next run. */
9292 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9293 it
->current_x
= line_start_x
;
9296 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9298 last_height
= it
->max_ascent
+ it
->max_descent
;
9299 it
->max_ascent
= it
->max_descent
= 0;
9304 /* On text terminals, we may stop at the end of a line in the middle
9305 of a multi-character glyph. If the glyph itself is continued,
9306 i.e. it is actually displayed on the next line, don't treat this
9307 stopping point as valid; move to the next line instead (unless
9308 that brings us offscreen). */
9309 if (!FRAME_WINDOW_P (it
->f
)
9311 && IT_CHARPOS (*it
) == to_charpos
9312 && it
->what
== IT_CHARACTER
9314 && it
->line_wrap
== WINDOW_WRAP
9315 && it
->current_x
== it
->last_visible_x
- 1
9318 && it
->vpos
< it
->w
->window_end_vpos
)
9320 it
->continuation_lines_width
+= it
->current_x
;
9321 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9322 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9324 last_height
= it
->max_ascent
+ it
->max_descent
;
9328 bidi_unshelve_cache (backup_data
, 1);
9330 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9332 return max_current_x
;
9336 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9338 If DY > 0, move IT backward at least that many pixels. DY = 0
9339 means move IT backward to the preceding line start or BEGV. This
9340 function may move over more than DY pixels if IT->current_y - DY
9341 ends up in the middle of a line; in this case IT->current_y will be
9342 set to the top of the line moved to. */
9345 move_it_vertically_backward (struct it
*it
, int dy
)
9349 void *it2data
= NULL
, *it3data
= NULL
;
9350 ptrdiff_t start_pos
;
9352 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9353 ptrdiff_t pos_limit
;
9358 start_pos
= IT_CHARPOS (*it
);
9360 /* Estimate how many newlines we must move back. */
9361 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9362 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9365 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9367 /* Set the iterator's position that many lines back. But don't go
9368 back more than NLINES full screen lines -- this wins a day with
9369 buffers which have very long lines. */
9370 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9371 back_to_previous_visible_line_start (it
);
9373 /* Reseat the iterator here. When moving backward, we don't want
9374 reseat to skip forward over invisible text, set up the iterator
9375 to deliver from overlay strings at the new position etc. So,
9376 use reseat_1 here. */
9377 reseat_1 (it
, it
->current
.pos
, 1);
9379 /* We are now surely at a line start. */
9380 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9381 reordering is in effect. */
9382 it
->continuation_lines_width
= 0;
9384 /* Move forward and see what y-distance we moved. First move to the
9385 start of the next line so that we get its height. We need this
9386 height to be able to tell whether we reached the specified
9388 SAVE_IT (it2
, *it
, it2data
);
9389 it2
.max_ascent
= it2
.max_descent
= 0;
9392 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9393 MOVE_TO_POS
| MOVE_TO_VPOS
);
9395 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9396 /* If we are in a display string which starts at START_POS,
9397 and that display string includes a newline, and we are
9398 right after that newline (i.e. at the beginning of a
9399 display line), exit the loop, because otherwise we will
9400 infloop, since move_it_to will see that it is already at
9401 START_POS and will not move. */
9402 || (it2
.method
== GET_FROM_STRING
9403 && IT_CHARPOS (it2
) == start_pos
9404 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9405 eassert (IT_CHARPOS (*it
) >= BEGV
);
9406 SAVE_IT (it3
, it2
, it3data
);
9408 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9409 eassert (IT_CHARPOS (*it
) >= BEGV
);
9410 /* H is the actual vertical distance from the position in *IT
9411 and the starting position. */
9412 h
= it2
.current_y
- it
->current_y
;
9413 /* NLINES is the distance in number of lines. */
9414 nlines
= it2
.vpos
- it
->vpos
;
9416 /* Correct IT's y and vpos position
9417 so that they are relative to the starting point. */
9423 /* DY == 0 means move to the start of the screen line. The
9424 value of nlines is > 0 if continuation lines were involved,
9425 or if the original IT position was at start of a line. */
9426 RESTORE_IT (it
, it
, it2data
);
9428 move_it_by_lines (it
, nlines
);
9429 /* The above code moves us to some position NLINES down,
9430 usually to its first glyph (leftmost in an L2R line), but
9431 that's not necessarily the start of the line, under bidi
9432 reordering. We want to get to the character position
9433 that is immediately after the newline of the previous
9436 && !it
->continuation_lines_width
9437 && !STRINGP (it
->string
)
9438 && IT_CHARPOS (*it
) > BEGV
9439 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9441 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9444 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9445 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9447 bidi_unshelve_cache (it3data
, 1);
9451 /* The y-position we try to reach, relative to *IT.
9452 Note that H has been subtracted in front of the if-statement. */
9453 int target_y
= it
->current_y
+ h
- dy
;
9454 int y0
= it3
.current_y
;
9458 RESTORE_IT (&it3
, &it3
, it3data
);
9459 y1
= line_bottom_y (&it3
);
9460 line_height
= y1
- y0
;
9461 RESTORE_IT (it
, it
, it2data
);
9462 /* If we did not reach target_y, try to move further backward if
9463 we can. If we moved too far backward, try to move forward. */
9464 if (target_y
< it
->current_y
9465 /* This is heuristic. In a window that's 3 lines high, with
9466 a line height of 13 pixels each, recentering with point
9467 on the bottom line will try to move -39/2 = 19 pixels
9468 backward. Try to avoid moving into the first line. */
9469 && (it
->current_y
- target_y
9470 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9471 && IT_CHARPOS (*it
) > BEGV
)
9473 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9474 target_y
- it
->current_y
));
9475 dy
= it
->current_y
- target_y
;
9476 goto move_further_back
;
9478 else if (target_y
>= it
->current_y
+ line_height
9479 && IT_CHARPOS (*it
) < ZV
)
9481 /* Should move forward by at least one line, maybe more.
9483 Note: Calling move_it_by_lines can be expensive on
9484 terminal frames, where compute_motion is used (via
9485 vmotion) to do the job, when there are very long lines
9486 and truncate-lines is nil. That's the reason for
9487 treating terminal frames specially here. */
9489 if (!FRAME_WINDOW_P (it
->f
))
9490 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9495 move_it_by_lines (it
, 1);
9497 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9504 /* Move IT by a specified amount of pixel lines DY. DY negative means
9505 move backwards. DY = 0 means move to start of screen line. At the
9506 end, IT will be on the start of a screen line. */
9509 move_it_vertically (struct it
*it
, int dy
)
9512 move_it_vertically_backward (it
, -dy
);
9515 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9516 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9517 MOVE_TO_POS
| MOVE_TO_Y
);
9518 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9520 /* If buffer ends in ZV without a newline, move to the start of
9521 the line to satisfy the post-condition. */
9522 if (IT_CHARPOS (*it
) == ZV
9524 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9525 move_it_by_lines (it
, 0);
9530 /* Move iterator IT past the end of the text line it is in. */
9533 move_it_past_eol (struct it
*it
)
9535 enum move_it_result rc
;
9537 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9538 if (rc
== MOVE_NEWLINE_OR_CR
)
9539 set_iterator_to_next (it
, 0);
9543 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9544 negative means move up. DVPOS == 0 means move to the start of the
9547 Optimization idea: If we would know that IT->f doesn't use
9548 a face with proportional font, we could be faster for
9549 truncate-lines nil. */
9552 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9555 /* The commented-out optimization uses vmotion on terminals. This
9556 gives bad results, because elements like it->what, on which
9557 callers such as pos_visible_p rely, aren't updated. */
9558 /* struct position pos;
9559 if (!FRAME_WINDOW_P (it->f))
9561 struct text_pos textpos;
9563 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9564 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9565 reseat (it, textpos, 1);
9566 it->vpos += pos.vpos;
9567 it->current_y += pos.vpos;
9573 /* DVPOS == 0 means move to the start of the screen line. */
9574 move_it_vertically_backward (it
, 0);
9575 /* Let next call to line_bottom_y calculate real line height. */
9580 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9581 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9583 /* Only move to the next buffer position if we ended up in a
9584 string from display property, not in an overlay string
9585 (before-string or after-string). That is because the
9586 latter don't conceal the underlying buffer position, so
9587 we can ask to move the iterator to the exact position we
9588 are interested in. Note that, even if we are already at
9589 IT_CHARPOS (*it), the call below is not a no-op, as it
9590 will detect that we are at the end of the string, pop the
9591 iterator, and compute it->current_x and it->hpos
9593 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9594 -1, -1, -1, MOVE_TO_POS
);
9600 void *it2data
= NULL
;
9601 ptrdiff_t start_charpos
, i
;
9603 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9604 bool hit_pos_limit
= false;
9605 ptrdiff_t pos_limit
;
9607 /* Start at the beginning of the screen line containing IT's
9608 position. This may actually move vertically backwards,
9609 in case of overlays, so adjust dvpos accordingly. */
9611 move_it_vertically_backward (it
, 0);
9614 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9615 screen lines, and reseat the iterator there. */
9616 start_charpos
= IT_CHARPOS (*it
);
9617 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9620 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9622 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9623 back_to_previous_visible_line_start (it
);
9624 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9625 hit_pos_limit
= true;
9626 reseat (it
, it
->current
.pos
, 1);
9628 /* Move further back if we end up in a string or an image. */
9629 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9631 /* First try to move to start of display line. */
9633 move_it_vertically_backward (it
, 0);
9635 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9637 /* If start of line is still in string or image,
9638 move further back. */
9639 back_to_previous_visible_line_start (it
);
9640 reseat (it
, it
->current
.pos
, 1);
9644 it
->current_x
= it
->hpos
= 0;
9646 /* Above call may have moved too far if continuation lines
9647 are involved. Scan forward and see if it did. */
9648 SAVE_IT (it2
, *it
, it2data
);
9649 it2
.vpos
= it2
.current_y
= 0;
9650 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9651 it
->vpos
-= it2
.vpos
;
9652 it
->current_y
-= it2
.current_y
;
9653 it
->current_x
= it
->hpos
= 0;
9655 /* If we moved too far back, move IT some lines forward. */
9656 if (it2
.vpos
> -dvpos
)
9658 int delta
= it2
.vpos
+ dvpos
;
9660 RESTORE_IT (&it2
, &it2
, it2data
);
9661 SAVE_IT (it2
, *it
, it2data
);
9662 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9663 /* Move back again if we got too far ahead. */
9664 if (IT_CHARPOS (*it
) >= start_charpos
)
9665 RESTORE_IT (it
, &it2
, it2data
);
9667 bidi_unshelve_cache (it2data
, 1);
9669 else if (hit_pos_limit
&& pos_limit
> BEGV
9670 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9672 /* If we hit the limit, but still didn't make it far enough
9673 back, that means there's a display string with a newline
9674 covering a large chunk of text, and that caused
9675 back_to_previous_visible_line_start try to go too far.
9676 Punish those who commit such atrocities by going back
9677 until we've reached DVPOS, after lifting the limit, which
9678 could make it slow for very long lines. "If it hurts,
9681 RESTORE_IT (it
, it
, it2data
);
9682 for (i
= -dvpos
; i
> 0; --i
)
9684 back_to_previous_visible_line_start (it
);
9687 reseat_1 (it
, it
->current
.pos
, 1);
9690 RESTORE_IT (it
, it
, it2data
);
9694 /* Return true if IT points into the middle of a display vector. */
9697 in_display_vector_p (struct it
*it
)
9699 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9700 && it
->current
.dpvec_index
> 0
9701 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9704 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9705 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9706 WINDOW must be a live window and defaults to the selected one. The
9707 return value is a cons of the maximum pixel-width of any text line and
9708 the maximum pixel-height of all text lines.
9710 The optional argument FROM, if non-nil, specifies the first text
9711 position and defaults to the minimum accessible position of the buffer.
9712 If FROM is t, use the minimum accessible position that is not a newline
9713 character. TO, if non-nil, specifies the last text position and
9714 defaults to the maximum accessible position of the buffer. If TO is t,
9715 use the maximum accessible position that is not a newline character.
9717 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9718 width that can be returned. X-LIMIT nil or omitted, means to use the
9719 pixel-width of WINDOW's body; use this if you do not intend to change
9720 the width of WINDOW. Use the maximum width WINDOW may assume if you
9721 intend to change WINDOW's width. In any case, text whose x-coordinate
9722 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9723 can take some time, it's always a good idea to make this argument as
9724 small as possible; in particular, if the buffer contains long lines that
9725 shall be truncated anyway.
9727 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9728 height that can be returned. Text lines whose y-coordinate is beyond
9729 Y-LIMIT are ignored. Since calculating the text height of a large
9730 buffer can take some time, it makes sense to specify this argument if
9731 the size of the buffer is unknown.
9733 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9734 include the height of the mode- or header-line of WINDOW in the return
9735 value. If it is either the symbol `mode-line' or `header-line', include
9736 only the height of that line, if present, in the return value. If t,
9737 include the height of both, if present, in the return value. */)
9738 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9739 Lisp_Object mode_and_header_line
)
9741 struct window
*w
= decode_live_window (window
);
9745 struct buffer
*old_buffer
= NULL
;
9746 ptrdiff_t start
, end
, pos
;
9747 struct text_pos startp
;
9748 void *itdata
= NULL
;
9749 int c
, max_y
= -1, x
= 0, y
= 0;
9755 if (b
!= current_buffer
)
9757 old_buffer
= current_buffer
;
9758 set_buffer_internal (b
);
9763 else if (EQ (from
, Qt
))
9766 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9767 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9769 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9774 CHECK_NUMBER_COERCE_MARKER (from
);
9775 start
= min (max (XINT (from
), BEGV
), ZV
);
9780 else if (EQ (to
, Qt
))
9783 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9784 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9786 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9791 CHECK_NUMBER_COERCE_MARKER (to
);
9792 end
= max (start
, min (XINT (to
), ZV
));
9795 if (!NILP (y_limit
))
9797 CHECK_NUMBER (y_limit
);
9798 max_y
= min (XINT (y_limit
), INT_MAX
);
9801 itdata
= bidi_shelve_cache ();
9802 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9803 start_display (&it
, w
, startp
);
9806 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9809 CHECK_NUMBER (x_limit
);
9810 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9811 /* Actually, we never want move_it_to stop at to_x. But to make
9812 sure that move_it_in_display_line_to always moves far enough,
9813 we set it to INT_MAX and specify MOVE_TO_X. */
9814 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9815 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9818 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9820 if (!EQ (mode_and_header_line
, Qheader_line
)
9821 && !EQ (mode_and_header_line
, Qt
))
9822 /* Do not count the header-line which was counted automatically by
9824 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9826 if (EQ (mode_and_header_line
, Qmode_line
)
9827 || EQ (mode_and_header_line
, Qt
))
9828 /* Do count the mode-line which is not included automatically by
9830 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9832 bidi_unshelve_cache (itdata
, 0);
9835 set_buffer_internal (old_buffer
);
9837 return Fcons (make_number (x
), make_number (y
));
9840 /***********************************************************************
9842 ***********************************************************************/
9845 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9849 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9851 Lisp_Object msg
, fmt
;
9854 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9858 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9860 fmt
= build_string (format
);
9861 msg
= CALLN (Fformat
, fmt
, arg1
, arg2
);
9863 len
= SBYTES (msg
) + 1;
9864 buffer
= SAFE_ALLOCA (len
);
9865 memcpy (buffer
, SDATA (msg
), len
);
9867 message_dolog (buffer
, len
- 1, 1, 0);
9874 /* Output a newline in the *Messages* buffer if "needs" one. */
9877 message_log_maybe_newline (void)
9879 if (message_log_need_newline
)
9880 message_dolog ("", 0, 1, 0);
9884 /* Add a string M of length NBYTES to the message log, optionally
9885 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9886 true, means interpret the contents of M as multibyte. This
9887 function calls low-level routines in order to bypass text property
9888 hooks, etc. which might not be safe to run.
9890 This may GC (insert may run before/after change hooks),
9891 so the buffer M must NOT point to a Lisp string. */
9894 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9896 const unsigned char *msg
= (const unsigned char *) m
;
9898 if (!NILP (Vmemory_full
))
9901 if (!NILP (Vmessage_log_max
))
9903 struct buffer
*oldbuf
;
9904 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9905 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9906 ptrdiff_t point_at_end
= 0;
9907 ptrdiff_t zv_at_end
= 0;
9908 Lisp_Object old_deactivate_mark
;
9909 struct gcpro gcpro1
;
9911 old_deactivate_mark
= Vdeactivate_mark
;
9912 oldbuf
= current_buffer
;
9914 /* Ensure the Messages buffer exists, and switch to it.
9915 If we created it, set the major-mode. */
9918 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9920 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9923 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9924 call0 (intern ("messages-buffer-mode"));
9927 bset_undo_list (current_buffer
, Qt
);
9928 bset_cache_long_scans (current_buffer
, Qnil
);
9930 oldpoint
= message_dolog_marker1
;
9931 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9932 oldbegv
= message_dolog_marker2
;
9933 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9934 oldzv
= message_dolog_marker3
;
9935 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9936 GCPRO1 (old_deactivate_mark
);
9944 BEGV_BYTE
= BEG_BYTE
;
9947 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9949 /* Insert the string--maybe converting multibyte to single byte
9950 or vice versa, so that all the text fits the buffer. */
9952 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9958 /* Convert a multibyte string to single-byte
9959 for the *Message* buffer. */
9960 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9962 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9963 work
[0] = CHAR_TO_BYTE8 (c
);
9964 insert_1_both (work
, 1, 1, 1, 0, 0);
9967 else if (! multibyte
9968 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9972 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9973 /* Convert a single-byte string to multibyte
9974 for the *Message* buffer. */
9975 for (i
= 0; i
< nbytes
; i
++)
9978 MAKE_CHAR_MULTIBYTE (c
);
9979 char_bytes
= CHAR_STRING (c
, str
);
9980 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9984 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9988 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9991 insert_1_both ("\n", 1, 1, 1, 0, 0);
9993 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9995 this_bol_byte
= PT_BYTE
;
9997 /* See if this line duplicates the previous one.
9998 If so, combine duplicates. */
10001 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10003 prev_bol_byte
= PT_BYTE
;
10005 dups
= message_log_check_duplicate (prev_bol_byte
,
10009 del_range_both (prev_bol
, prev_bol_byte
,
10010 this_bol
, this_bol_byte
, 0);
10013 char dupstr
[sizeof " [ times]"
10014 + INT_STRLEN_BOUND (printmax_t
)];
10016 /* If you change this format, don't forget to also
10017 change message_log_check_duplicate. */
10018 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10019 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10020 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10025 /* If we have more than the desired maximum number of lines
10026 in the *Messages* buffer now, delete the oldest ones.
10027 This is safe because we don't have undo in this buffer. */
10029 if (NATNUMP (Vmessage_log_max
))
10031 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10032 -XFASTINT (Vmessage_log_max
) - 1, 0);
10033 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10036 BEGV
= marker_position (oldbegv
);
10037 BEGV_BYTE
= marker_byte_position (oldbegv
);
10046 ZV
= marker_position (oldzv
);
10047 ZV_BYTE
= marker_byte_position (oldzv
);
10051 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10053 /* We can't do Fgoto_char (oldpoint) because it will run some
10055 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10056 marker_byte_position (oldpoint
));
10059 unchain_marker (XMARKER (oldpoint
));
10060 unchain_marker (XMARKER (oldbegv
));
10061 unchain_marker (XMARKER (oldzv
));
10063 /* We called insert_1_both above with its 5th argument (PREPARE)
10064 zero, which prevents insert_1_both from calling
10065 prepare_to_modify_buffer, which in turns prevents us from
10066 incrementing windows_or_buffers_changed even if *Messages* is
10067 shown in some window. So we must manually set
10068 windows_or_buffers_changed here to make up for that. */
10069 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10070 bset_redisplay (current_buffer
);
10072 set_buffer_internal (oldbuf
);
10074 message_log_need_newline
= !nlflag
;
10075 Vdeactivate_mark
= old_deactivate_mark
;
10080 /* We are at the end of the buffer after just having inserted a newline.
10081 (Note: We depend on the fact we won't be crossing the gap.)
10082 Check to see if the most recent message looks a lot like the previous one.
10083 Return 0 if different, 1 if the new one should just replace it, or a
10084 value N > 1 if we should also append " [N times]". */
10087 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10090 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10092 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10093 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10095 for (i
= 0; i
< len
; i
++)
10097 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10099 if (p1
[i
] != p2
[i
])
10105 if (*p1
++ == ' ' && *p1
++ == '[')
10108 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10109 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10116 /* Display an echo area message M with a specified length of NBYTES
10117 bytes. The string may include null characters. If M is not a
10118 string, clear out any existing message, and let the mini-buffer
10121 This function cancels echoing. */
10124 message3 (Lisp_Object m
)
10126 struct gcpro gcpro1
;
10129 clear_message (true, true);
10132 /* First flush out any partial line written with print. */
10133 message_log_maybe_newline ();
10136 ptrdiff_t nbytes
= SBYTES (m
);
10137 bool multibyte
= STRING_MULTIBYTE (m
);
10140 SAFE_ALLOCA_STRING (buffer
, m
);
10141 message_dolog (buffer
, nbytes
, 1, multibyte
);
10144 message3_nolog (m
);
10150 /* The non-logging version of message3.
10151 This does not cancel echoing, because it is used for echoing.
10152 Perhaps we need to make a separate function for echoing
10153 and make this cancel echoing. */
10156 message3_nolog (Lisp_Object m
)
10158 struct frame
*sf
= SELECTED_FRAME ();
10160 if (FRAME_INITIAL_P (sf
))
10162 if (noninteractive_need_newline
)
10163 putc ('\n', stderr
);
10164 noninteractive_need_newline
= 0;
10167 Lisp_Object s
= ENCODE_SYSTEM (m
);
10169 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10171 if (cursor_in_echo_area
== 0)
10172 fprintf (stderr
, "\n");
10175 /* Error messages get reported properly by cmd_error, so this must be just an
10176 informative message; if the frame hasn't really been initialized yet, just
10178 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10180 /* Get the frame containing the mini-buffer
10181 that the selected frame is using. */
10182 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10183 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10184 struct frame
*f
= XFRAME (frame
);
10186 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10187 Fmake_frame_visible (frame
);
10189 if (STRINGP (m
) && SCHARS (m
) > 0)
10192 if (minibuffer_auto_raise
)
10193 Fraise_frame (frame
);
10194 /* Assume we are not echoing.
10195 (If we are, echo_now will override this.) */
10196 echo_message_buffer
= Qnil
;
10199 clear_message (true, true);
10201 do_pending_window_change (false);
10202 echo_area_display (true);
10203 do_pending_window_change (false);
10204 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10205 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10210 /* Display a null-terminated echo area message M. If M is 0, clear
10211 out any existing message, and let the mini-buffer text show through.
10213 The buffer M must continue to exist until after the echo area gets
10214 cleared or some other message gets displayed there. Do not pass
10215 text that is stored in a Lisp string. Do not pass text in a buffer
10216 that was alloca'd. */
10219 message1 (const char *m
)
10221 message3 (m
? build_unibyte_string (m
) : Qnil
);
10225 /* The non-logging counterpart of message1. */
10228 message1_nolog (const char *m
)
10230 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10233 /* Display a message M which contains a single %s
10234 which gets replaced with STRING. */
10237 message_with_string (const char *m
, Lisp_Object string
, int log
)
10239 CHECK_STRING (string
);
10241 if (noninteractive
)
10245 /* ENCODE_SYSTEM below can GC and/or relocate the
10246 Lisp data, so make sure we don't use it here. */
10247 eassert (relocatable_string_data_p (m
) != 1);
10249 if (noninteractive_need_newline
)
10250 putc ('\n', stderr
);
10251 noninteractive_need_newline
= 0;
10252 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10253 if (!cursor_in_echo_area
)
10254 fprintf (stderr
, "\n");
10258 else if (INTERACTIVE
)
10260 /* The frame whose minibuffer we're going to display the message on.
10261 It may be larger than the selected frame, so we need
10262 to use its buffer, not the selected frame's buffer. */
10263 Lisp_Object mini_window
;
10264 struct frame
*f
, *sf
= SELECTED_FRAME ();
10266 /* Get the frame containing the minibuffer
10267 that the selected frame is using. */
10268 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10269 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10271 /* Error messages get reported properly by cmd_error, so this must be
10272 just an informative message; if the frame hasn't really been
10273 initialized yet, just toss it. */
10274 if (f
->glyphs_initialized_p
)
10276 struct gcpro gcpro1
, gcpro2
;
10278 Lisp_Object fmt
= build_string (m
);
10279 Lisp_Object msg
= string
;
10282 msg
= CALLN (Fformat
, fmt
, msg
);
10287 message3_nolog (msg
);
10291 /* Print should start at the beginning of the message
10292 buffer next time. */
10293 message_buf_print
= 0;
10299 /* Dump an informative message to the minibuf. If M is 0, clear out
10300 any existing message, and let the mini-buffer text show through. */
10303 vmessage (const char *m
, va_list ap
)
10305 if (noninteractive
)
10309 if (noninteractive_need_newline
)
10310 putc ('\n', stderr
);
10311 noninteractive_need_newline
= 0;
10312 vfprintf (stderr
, m
, ap
);
10313 if (cursor_in_echo_area
== 0)
10314 fprintf (stderr
, "\n");
10318 else if (INTERACTIVE
)
10320 /* The frame whose mini-buffer we're going to display the message
10321 on. It may be larger than the selected frame, so we need to
10322 use its buffer, not the selected frame's buffer. */
10323 Lisp_Object mini_window
;
10324 struct frame
*f
, *sf
= SELECTED_FRAME ();
10326 /* Get the frame containing the mini-buffer
10327 that the selected frame is using. */
10328 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10329 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10331 /* Error messages get reported properly by cmd_error, so this must be
10332 just an informative message; if the frame hasn't really been
10333 initialized yet, just toss it. */
10334 if (f
->glyphs_initialized_p
)
10339 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10341 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10343 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10345 message3 (make_string (message_buf
, len
));
10351 /* Print should start at the beginning of the message
10352 buffer next time. */
10353 message_buf_print
= 0;
10359 message (const char *m
, ...)
10369 /* The non-logging version of message. */
10372 message_nolog (const char *m
, ...)
10374 Lisp_Object old_log_max
;
10377 old_log_max
= Vmessage_log_max
;
10378 Vmessage_log_max
= Qnil
;
10380 Vmessage_log_max
= old_log_max
;
10386 /* Display the current message in the current mini-buffer. This is
10387 only called from error handlers in process.c, and is not time
10391 update_echo_area (void)
10393 if (!NILP (echo_area_buffer
[0]))
10395 Lisp_Object string
;
10396 string
= Fcurrent_message ();
10402 /* Make sure echo area buffers in `echo_buffers' are live.
10403 If they aren't, make new ones. */
10406 ensure_echo_area_buffers (void)
10410 for (i
= 0; i
< 2; ++i
)
10411 if (!BUFFERP (echo_buffer
[i
])
10412 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10415 Lisp_Object old_buffer
;
10418 old_buffer
= echo_buffer
[i
];
10419 echo_buffer
[i
] = Fget_buffer_create
10420 (make_formatted_string (name
, " *Echo Area %d*", i
));
10421 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10422 /* to force word wrap in echo area -
10423 it was decided to postpone this*/
10424 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10426 for (j
= 0; j
< 2; ++j
)
10427 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10428 echo_area_buffer
[j
] = echo_buffer
[i
];
10433 /* Call FN with args A1..A2 with either the current or last displayed
10434 echo_area_buffer as current buffer.
10436 WHICH zero means use the current message buffer
10437 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10438 from echo_buffer[] and clear it.
10440 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10441 suitable buffer from echo_buffer[] and clear it.
10443 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10444 that the current message becomes the last displayed one, make
10445 choose a suitable buffer for echo_area_buffer[0], and clear it.
10447 Value is what FN returns. */
10450 with_echo_area_buffer (struct window
*w
, int which
,
10451 int (*fn
) (ptrdiff_t, Lisp_Object
),
10452 ptrdiff_t a1
, Lisp_Object a2
)
10454 Lisp_Object buffer
;
10455 int this_one
, the_other
, clear_buffer_p
, rc
;
10456 ptrdiff_t count
= SPECPDL_INDEX ();
10458 /* If buffers aren't live, make new ones. */
10459 ensure_echo_area_buffers ();
10461 clear_buffer_p
= 0;
10464 this_one
= 0, the_other
= 1;
10465 else if (which
> 0)
10466 this_one
= 1, the_other
= 0;
10469 this_one
= 0, the_other
= 1;
10470 clear_buffer_p
= true;
10472 /* We need a fresh one in case the current echo buffer equals
10473 the one containing the last displayed echo area message. */
10474 if (!NILP (echo_area_buffer
[this_one
])
10475 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10476 echo_area_buffer
[this_one
] = Qnil
;
10479 /* Choose a suitable buffer from echo_buffer[] is we don't
10481 if (NILP (echo_area_buffer
[this_one
]))
10483 echo_area_buffer
[this_one
]
10484 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10485 ? echo_buffer
[the_other
]
10486 : echo_buffer
[this_one
]);
10487 clear_buffer_p
= true;
10490 buffer
= echo_area_buffer
[this_one
];
10492 /* Don't get confused by reusing the buffer used for echoing
10493 for a different purpose. */
10494 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10497 record_unwind_protect (unwind_with_echo_area_buffer
,
10498 with_echo_area_buffer_unwind_data (w
));
10500 /* Make the echo area buffer current. Note that for display
10501 purposes, it is not necessary that the displayed window's buffer
10502 == current_buffer, except for text property lookup. So, let's
10503 only set that buffer temporarily here without doing a full
10504 Fset_window_buffer. We must also change w->pointm, though,
10505 because otherwise an assertions in unshow_buffer fails, and Emacs
10507 set_buffer_internal_1 (XBUFFER (buffer
));
10510 wset_buffer (w
, buffer
);
10511 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10512 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10515 bset_undo_list (current_buffer
, Qt
);
10516 bset_read_only (current_buffer
, Qnil
);
10517 specbind (Qinhibit_read_only
, Qt
);
10518 specbind (Qinhibit_modification_hooks
, Qt
);
10520 if (clear_buffer_p
&& Z
> BEG
)
10521 del_range (BEG
, Z
);
10523 eassert (BEGV
>= BEG
);
10524 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10528 eassert (BEGV
>= BEG
);
10529 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10531 unbind_to (count
, Qnil
);
10536 /* Save state that should be preserved around the call to the function
10537 FN called in with_echo_area_buffer. */
10540 with_echo_area_buffer_unwind_data (struct window
*w
)
10543 Lisp_Object vector
, tmp
;
10545 /* Reduce consing by keeping one vector in
10546 Vwith_echo_area_save_vector. */
10547 vector
= Vwith_echo_area_save_vector
;
10548 Vwith_echo_area_save_vector
= Qnil
;
10551 vector
= Fmake_vector (make_number (11), Qnil
);
10553 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10554 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10555 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10559 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10560 ASET (vector
, i
, w
->contents
); ++i
;
10561 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10562 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10563 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10564 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10565 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10566 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10571 for (; i
< end
; ++i
)
10572 ASET (vector
, i
, Qnil
);
10575 eassert (i
== ASIZE (vector
));
10580 /* Restore global state from VECTOR which was created by
10581 with_echo_area_buffer_unwind_data. */
10584 unwind_with_echo_area_buffer (Lisp_Object vector
)
10586 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10587 Vdeactivate_mark
= AREF (vector
, 1);
10588 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10590 if (WINDOWP (AREF (vector
, 3)))
10593 Lisp_Object buffer
;
10595 w
= XWINDOW (AREF (vector
, 3));
10596 buffer
= AREF (vector
, 4);
10598 wset_buffer (w
, buffer
);
10599 set_marker_both (w
->pointm
, buffer
,
10600 XFASTINT (AREF (vector
, 5)),
10601 XFASTINT (AREF (vector
, 6)));
10602 set_marker_both (w
->old_pointm
, buffer
,
10603 XFASTINT (AREF (vector
, 7)),
10604 XFASTINT (AREF (vector
, 8)));
10605 set_marker_both (w
->start
, buffer
,
10606 XFASTINT (AREF (vector
, 9)),
10607 XFASTINT (AREF (vector
, 10)));
10610 Vwith_echo_area_save_vector
= vector
;
10614 /* Set up the echo area for use by print functions. MULTIBYTE_P
10615 non-zero means we will print multibyte. */
10618 setup_echo_area_for_printing (int multibyte_p
)
10620 /* If we can't find an echo area any more, exit. */
10621 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10622 Fkill_emacs (Qnil
);
10624 ensure_echo_area_buffers ();
10626 if (!message_buf_print
)
10628 /* A message has been output since the last time we printed.
10629 Choose a fresh echo area buffer. */
10630 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10631 echo_area_buffer
[0] = echo_buffer
[1];
10633 echo_area_buffer
[0] = echo_buffer
[0];
10635 /* Switch to that buffer and clear it. */
10636 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10637 bset_truncate_lines (current_buffer
, Qnil
);
10641 ptrdiff_t count
= SPECPDL_INDEX ();
10642 specbind (Qinhibit_read_only
, Qt
);
10643 /* Note that undo recording is always disabled. */
10644 del_range (BEG
, Z
);
10645 unbind_to (count
, Qnil
);
10647 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10649 /* Set up the buffer for the multibyteness we need. */
10651 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10652 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10654 /* Raise the frame containing the echo area. */
10655 if (minibuffer_auto_raise
)
10657 struct frame
*sf
= SELECTED_FRAME ();
10658 Lisp_Object mini_window
;
10659 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10660 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10663 message_log_maybe_newline ();
10664 message_buf_print
= 1;
10668 if (NILP (echo_area_buffer
[0]))
10670 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10671 echo_area_buffer
[0] = echo_buffer
[1];
10673 echo_area_buffer
[0] = echo_buffer
[0];
10676 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10678 /* Someone switched buffers between print requests. */
10679 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10680 bset_truncate_lines (current_buffer
, Qnil
);
10686 /* Display an echo area message in window W. Value is non-zero if W's
10687 height is changed. If display_last_displayed_message_p is
10688 non-zero, display the message that was last displayed, otherwise
10689 display the current message. */
10692 display_echo_area (struct window
*w
)
10694 int i
, no_message_p
, window_height_changed_p
;
10696 /* Temporarily disable garbage collections while displaying the echo
10697 area. This is done because a GC can print a message itself.
10698 That message would modify the echo area buffer's contents while a
10699 redisplay of the buffer is going on, and seriously confuse
10701 ptrdiff_t count
= inhibit_garbage_collection ();
10703 /* If there is no message, we must call display_echo_area_1
10704 nevertheless because it resizes the window. But we will have to
10705 reset the echo_area_buffer in question to nil at the end because
10706 with_echo_area_buffer will sets it to an empty buffer. */
10707 i
= display_last_displayed_message_p
? 1 : 0;
10708 no_message_p
= NILP (echo_area_buffer
[i
]);
10710 window_height_changed_p
10711 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10712 display_echo_area_1
,
10713 (intptr_t) w
, Qnil
);
10716 echo_area_buffer
[i
] = Qnil
;
10718 unbind_to (count
, Qnil
);
10719 return window_height_changed_p
;
10723 /* Helper for display_echo_area. Display the current buffer which
10724 contains the current echo area message in window W, a mini-window,
10725 a pointer to which is passed in A1. A2..A4 are currently not used.
10726 Change the height of W so that all of the message is displayed.
10727 Value is non-zero if height of W was changed. */
10730 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10733 struct window
*w
= (struct window
*) i1
;
10734 Lisp_Object window
;
10735 struct text_pos start
;
10736 int window_height_changed_p
= 0;
10738 /* Do this before displaying, so that we have a large enough glyph
10739 matrix for the display. If we can't get enough space for the
10740 whole text, display the last N lines. That works by setting w->start. */
10741 window_height_changed_p
= resize_mini_window (w
, 0);
10743 /* Use the starting position chosen by resize_mini_window. */
10744 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10747 clear_glyph_matrix (w
->desired_matrix
);
10748 XSETWINDOW (window
, w
);
10749 try_window (window
, start
, 0);
10751 return window_height_changed_p
;
10755 /* Resize the echo area window to exactly the size needed for the
10756 currently displayed message, if there is one. If a mini-buffer
10757 is active, don't shrink it. */
10760 resize_echo_area_exactly (void)
10762 if (BUFFERP (echo_area_buffer
[0])
10763 && WINDOWP (echo_area_window
))
10765 struct window
*w
= XWINDOW (echo_area_window
);
10766 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10767 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10768 (intptr_t) w
, resize_exactly
);
10771 windows_or_buffers_changed
= 42;
10772 update_mode_lines
= 30;
10773 redisplay_internal ();
10779 /* Callback function for with_echo_area_buffer, when used from
10780 resize_echo_area_exactly. A1 contains a pointer to the window to
10781 resize, EXACTLY non-nil means resize the mini-window exactly to the
10782 size of the text displayed. A3 and A4 are not used. Value is what
10783 resize_mini_window returns. */
10786 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10789 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10793 /* Resize mini-window W to fit the size of its contents. EXACT_P
10794 means size the window exactly to the size needed. Otherwise, it's
10795 only enlarged until W's buffer is empty.
10797 Set W->start to the right place to begin display. If the whole
10798 contents fit, start at the beginning. Otherwise, start so as
10799 to make the end of the contents appear. This is particularly
10800 important for y-or-n-p, but seems desirable generally.
10802 Value is non-zero if the window height has been changed. */
10805 resize_mini_window (struct window
*w
, int exact_p
)
10807 struct frame
*f
= XFRAME (w
->frame
);
10808 int window_height_changed_p
= 0;
10810 eassert (MINI_WINDOW_P (w
));
10812 /* By default, start display at the beginning. */
10813 set_marker_both (w
->start
, w
->contents
,
10814 BUF_BEGV (XBUFFER (w
->contents
)),
10815 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10817 /* Don't resize windows while redisplaying a window; it would
10818 confuse redisplay functions when the size of the window they are
10819 displaying changes from under them. Such a resizing can happen,
10820 for instance, when which-func prints a long message while
10821 we are running fontification-functions. We're running these
10822 functions with safe_call which binds inhibit-redisplay to t. */
10823 if (!NILP (Vinhibit_redisplay
))
10826 /* Nil means don't try to resize. */
10827 if (NILP (Vresize_mini_windows
)
10828 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10831 if (!FRAME_MINIBUF_ONLY_P (f
))
10834 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10835 + WINDOW_PIXEL_HEIGHT (w
));
10836 int unit
= FRAME_LINE_HEIGHT (f
);
10837 int height
, max_height
;
10838 struct text_pos start
;
10839 struct buffer
*old_current_buffer
= NULL
;
10841 if (current_buffer
!= XBUFFER (w
->contents
))
10843 old_current_buffer
= current_buffer
;
10844 set_buffer_internal (XBUFFER (w
->contents
));
10847 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10849 /* Compute the max. number of lines specified by the user. */
10850 if (FLOATP (Vmax_mini_window_height
))
10851 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10852 else if (INTEGERP (Vmax_mini_window_height
))
10853 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10855 max_height
= total_height
/ 4;
10857 /* Correct that max. height if it's bogus. */
10858 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10860 /* Find out the height of the text in the window. */
10861 if (it
.line_wrap
== TRUNCATE
)
10866 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10867 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10868 height
= it
.current_y
+ last_height
;
10870 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10871 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10874 /* Compute a suitable window start. */
10875 if (height
> max_height
)
10877 height
= (max_height
/ unit
) * unit
;
10878 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10879 move_it_vertically_backward (&it
, height
- unit
);
10880 start
= it
.current
.pos
;
10883 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10884 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10886 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10888 /* Let it grow only, until we display an empty message, in which
10889 case the window shrinks again. */
10890 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10892 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10894 FRAME_WINDOWS_FROZEN (f
) = 1;
10895 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10896 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10898 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10899 && (exact_p
|| BEGV
== ZV
))
10901 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10903 FRAME_WINDOWS_FROZEN (f
) = 0;
10904 shrink_mini_window (w
, 1);
10905 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10910 /* Always resize to exact size needed. */
10911 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10913 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10915 FRAME_WINDOWS_FROZEN (f
) = 1;
10916 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10917 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10919 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10921 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10923 FRAME_WINDOWS_FROZEN (f
) = 0;
10924 shrink_mini_window (w
, 1);
10928 FRAME_WINDOWS_FROZEN (f
) = 1;
10929 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10932 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10936 if (old_current_buffer
)
10937 set_buffer_internal (old_current_buffer
);
10940 return window_height_changed_p
;
10944 /* Value is the current message, a string, or nil if there is no
10945 current message. */
10948 current_message (void)
10952 if (!BUFFERP (echo_area_buffer
[0]))
10956 with_echo_area_buffer (0, 0, current_message_1
,
10957 (intptr_t) &msg
, Qnil
);
10959 echo_area_buffer
[0] = Qnil
;
10967 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10970 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10973 *msg
= make_buffer_string (BEG
, Z
, 1);
10980 /* Push the current message on Vmessage_stack for later restoration
10981 by restore_message. Value is non-zero if the current message isn't
10982 empty. This is a relatively infrequent operation, so it's not
10983 worth optimizing. */
10986 push_message (void)
10988 Lisp_Object msg
= current_message ();
10989 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10990 return STRINGP (msg
);
10994 /* Restore message display from the top of Vmessage_stack. */
10997 restore_message (void)
10999 eassert (CONSP (Vmessage_stack
));
11000 message3_nolog (XCAR (Vmessage_stack
));
11004 /* Handler for unwind-protect calling pop_message. */
11007 pop_message_unwind (void)
11009 /* Pop the top-most entry off Vmessage_stack. */
11010 eassert (CONSP (Vmessage_stack
));
11011 Vmessage_stack
= XCDR (Vmessage_stack
);
11015 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11016 exits. If the stack is not empty, we have a missing pop_message
11020 check_message_stack (void)
11022 if (!NILP (Vmessage_stack
))
11027 /* Truncate to NCHARS what will be displayed in the echo area the next
11028 time we display it---but don't redisplay it now. */
11031 truncate_echo_area (ptrdiff_t nchars
)
11034 echo_area_buffer
[0] = Qnil
;
11035 else if (!noninteractive
11037 && !NILP (echo_area_buffer
[0]))
11039 struct frame
*sf
= SELECTED_FRAME ();
11040 /* Error messages get reported properly by cmd_error, so this must be
11041 just an informative message; if the frame hasn't really been
11042 initialized yet, just toss it. */
11043 if (sf
->glyphs_initialized_p
)
11044 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11049 /* Helper function for truncate_echo_area. Truncate the current
11050 message to at most NCHARS characters. */
11053 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11055 if (BEG
+ nchars
< Z
)
11056 del_range (BEG
+ nchars
, Z
);
11058 echo_area_buffer
[0] = Qnil
;
11062 /* Set the current message to STRING. */
11065 set_message (Lisp_Object string
)
11067 eassert (STRINGP (string
));
11069 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11071 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11072 message_buf_print
= 0;
11073 help_echo_showing_p
= 0;
11075 if (STRINGP (Vdebug_on_message
)
11076 && STRINGP (string
)
11077 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11078 call_debugger (list2 (Qerror
, string
));
11082 /* Helper function for set_message. First argument is ignored and second
11083 argument has the same meaning as for set_message.
11084 This function is called with the echo area buffer being current. */
11087 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11089 eassert (STRINGP (string
));
11091 /* Change multibyteness of the echo buffer appropriately. */
11092 if (message_enable_multibyte
11093 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11094 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11096 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11097 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11098 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11100 /* Insert new message at BEG. */
11101 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11103 /* This function takes care of single/multibyte conversion.
11104 We just have to ensure that the echo area buffer has the right
11105 setting of enable_multibyte_characters. */
11106 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11112 /* Clear messages. CURRENT_P non-zero means clear the current
11113 message. LAST_DISPLAYED_P non-zero means clear the message
11117 clear_message (bool current_p
, bool last_displayed_p
)
11121 echo_area_buffer
[0] = Qnil
;
11122 message_cleared_p
= true;
11125 if (last_displayed_p
)
11126 echo_area_buffer
[1] = Qnil
;
11128 message_buf_print
= 0;
11131 /* Clear garbaged frames.
11133 This function is used where the old redisplay called
11134 redraw_garbaged_frames which in turn called redraw_frame which in
11135 turn called clear_frame. The call to clear_frame was a source of
11136 flickering. I believe a clear_frame is not necessary. It should
11137 suffice in the new redisplay to invalidate all current matrices,
11138 and ensure a complete redisplay of all windows. */
11141 clear_garbaged_frames (void)
11143 if (frame_garbaged
)
11145 Lisp_Object tail
, frame
;
11147 FOR_EACH_FRAME (tail
, frame
)
11149 struct frame
*f
= XFRAME (frame
);
11151 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11156 clear_current_matrices (f
);
11157 fset_redisplay (f
);
11158 f
->garbaged
= false;
11159 f
->resized_p
= false;
11163 frame_garbaged
= false;
11168 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11169 is non-zero update selected_frame. Value is non-zero if the
11170 mini-windows height has been changed. */
11173 echo_area_display (bool update_frame_p
)
11175 Lisp_Object mini_window
;
11178 bool window_height_changed_p
= false;
11179 struct frame
*sf
= SELECTED_FRAME ();
11181 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11182 w
= XWINDOW (mini_window
);
11183 f
= XFRAME (WINDOW_FRAME (w
));
11185 /* Don't display if frame is invisible or not yet initialized. */
11186 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11189 #ifdef HAVE_WINDOW_SYSTEM
11190 /* When Emacs starts, selected_frame may be the initial terminal
11191 frame. If we let this through, a message would be displayed on
11193 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11195 #endif /* HAVE_WINDOW_SYSTEM */
11197 /* Redraw garbaged frames. */
11198 clear_garbaged_frames ();
11200 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11202 echo_area_window
= mini_window
;
11203 window_height_changed_p
= display_echo_area (w
);
11204 w
->must_be_updated_p
= true;
11206 /* Update the display, unless called from redisplay_internal.
11207 Also don't update the screen during redisplay itself. The
11208 update will happen at the end of redisplay, and an update
11209 here could cause confusion. */
11210 if (update_frame_p
&& !redisplaying_p
)
11214 /* If the display update has been interrupted by pending
11215 input, update mode lines in the frame. Due to the
11216 pending input, it might have been that redisplay hasn't
11217 been called, so that mode lines above the echo area are
11218 garbaged. This looks odd, so we prevent it here. */
11219 if (!display_completed
)
11220 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11222 if (window_height_changed_p
11223 /* Don't do this if Emacs is shutting down. Redisplay
11224 needs to run hooks. */
11225 && !NILP (Vrun_hooks
))
11227 /* Must update other windows. Likewise as in other
11228 cases, don't let this update be interrupted by
11230 ptrdiff_t count
= SPECPDL_INDEX ();
11231 specbind (Qredisplay_dont_pause
, Qt
);
11232 windows_or_buffers_changed
= 44;
11233 redisplay_internal ();
11234 unbind_to (count
, Qnil
);
11236 else if (FRAME_WINDOW_P (f
) && n
== 0)
11238 /* Window configuration is the same as before.
11239 Can do with a display update of the echo area,
11240 unless we displayed some mode lines. */
11241 update_single_window (w
);
11245 update_frame (f
, true, true);
11247 /* If cursor is in the echo area, make sure that the next
11248 redisplay displays the minibuffer, so that the cursor will
11249 be replaced with what the minibuffer wants. */
11250 if (cursor_in_echo_area
)
11251 wset_redisplay (XWINDOW (mini_window
));
11254 else if (!EQ (mini_window
, selected_window
))
11255 wset_redisplay (XWINDOW (mini_window
));
11257 /* Last displayed message is now the current message. */
11258 echo_area_buffer
[1] = echo_area_buffer
[0];
11259 /* Inform read_char that we're not echoing. */
11260 echo_message_buffer
= Qnil
;
11262 /* Prevent redisplay optimization in redisplay_internal by resetting
11263 this_line_start_pos. This is done because the mini-buffer now
11264 displays the message instead of its buffer text. */
11265 if (EQ (mini_window
, selected_window
))
11266 CHARPOS (this_line_start_pos
) = 0;
11268 return window_height_changed_p
;
11271 /* Nonzero if W's buffer was changed but not saved. */
11274 window_buffer_changed (struct window
*w
)
11276 struct buffer
*b
= XBUFFER (w
->contents
);
11278 eassert (BUFFER_LIVE_P (b
));
11280 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11283 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11286 mode_line_update_needed (struct window
*w
)
11288 return (w
->column_number_displayed
!= -1
11289 && !(PT
== w
->last_point
&& !window_outdated (w
))
11290 && (w
->column_number_displayed
!= current_column ()));
11293 /* Nonzero if window start of W is frozen and may not be changed during
11297 window_frozen_p (struct window
*w
)
11299 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11301 Lisp_Object window
;
11303 XSETWINDOW (window
, w
);
11304 if (MINI_WINDOW_P (w
))
11306 else if (EQ (window
, selected_window
))
11308 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11309 && EQ (window
, Vminibuf_scroll_window
))
11310 /* This special window can't be frozen too. */
11318 /***********************************************************************
11319 Mode Lines and Frame Titles
11320 ***********************************************************************/
11322 /* A buffer for constructing non-propertized mode-line strings and
11323 frame titles in it; allocated from the heap in init_xdisp and
11324 resized as needed in store_mode_line_noprop_char. */
11326 static char *mode_line_noprop_buf
;
11328 /* The buffer's end, and a current output position in it. */
11330 static char *mode_line_noprop_buf_end
;
11331 static char *mode_line_noprop_ptr
;
11333 #define MODE_LINE_NOPROP_LEN(start) \
11334 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11337 MODE_LINE_DISPLAY
= 0,
11341 } mode_line_target
;
11343 /* Alist that caches the results of :propertize.
11344 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11345 static Lisp_Object mode_line_proptrans_alist
;
11347 /* List of strings making up the mode-line. */
11348 static Lisp_Object mode_line_string_list
;
11350 /* Base face property when building propertized mode line string. */
11351 static Lisp_Object mode_line_string_face
;
11352 static Lisp_Object mode_line_string_face_prop
;
11355 /* Unwind data for mode line strings */
11357 static Lisp_Object Vmode_line_unwind_vector
;
11360 format_mode_line_unwind_data (struct frame
*target_frame
,
11361 struct buffer
*obuf
,
11363 int save_proptrans
)
11365 Lisp_Object vector
, tmp
;
11367 /* Reduce consing by keeping one vector in
11368 Vwith_echo_area_save_vector. */
11369 vector
= Vmode_line_unwind_vector
;
11370 Vmode_line_unwind_vector
= Qnil
;
11373 vector
= Fmake_vector (make_number (10), Qnil
);
11375 ASET (vector
, 0, make_number (mode_line_target
));
11376 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11377 ASET (vector
, 2, mode_line_string_list
);
11378 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11379 ASET (vector
, 4, mode_line_string_face
);
11380 ASET (vector
, 5, mode_line_string_face_prop
);
11383 XSETBUFFER (tmp
, obuf
);
11386 ASET (vector
, 6, tmp
);
11387 ASET (vector
, 7, owin
);
11390 /* Similarly to `with-selected-window', if the operation selects
11391 a window on another frame, we must restore that frame's
11392 selected window, and (for a tty) the top-frame. */
11393 ASET (vector
, 8, target_frame
->selected_window
);
11394 if (FRAME_TERMCAP_P (target_frame
))
11395 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11402 unwind_format_mode_line (Lisp_Object vector
)
11404 Lisp_Object old_window
= AREF (vector
, 7);
11405 Lisp_Object target_frame_window
= AREF (vector
, 8);
11406 Lisp_Object old_top_frame
= AREF (vector
, 9);
11408 mode_line_target
= XINT (AREF (vector
, 0));
11409 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11410 mode_line_string_list
= AREF (vector
, 2);
11411 if (! EQ (AREF (vector
, 3), Qt
))
11412 mode_line_proptrans_alist
= AREF (vector
, 3);
11413 mode_line_string_face
= AREF (vector
, 4);
11414 mode_line_string_face_prop
= AREF (vector
, 5);
11416 /* Select window before buffer, since it may change the buffer. */
11417 if (!NILP (old_window
))
11419 /* If the operation that we are unwinding had selected a window
11420 on a different frame, reset its frame-selected-window. For a
11421 text terminal, reset its top-frame if necessary. */
11422 if (!NILP (target_frame_window
))
11425 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11427 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11428 Fselect_window (target_frame_window
, Qt
);
11430 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11431 Fselect_frame (old_top_frame
, Qt
);
11434 Fselect_window (old_window
, Qt
);
11437 if (!NILP (AREF (vector
, 6)))
11439 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11440 ASET (vector
, 6, Qnil
);
11443 Vmode_line_unwind_vector
= vector
;
11447 /* Store a single character C for the frame title in mode_line_noprop_buf.
11448 Re-allocate mode_line_noprop_buf if necessary. */
11451 store_mode_line_noprop_char (char c
)
11453 /* If output position has reached the end of the allocated buffer,
11454 increase the buffer's size. */
11455 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11457 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11458 ptrdiff_t size
= len
;
11459 mode_line_noprop_buf
=
11460 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11461 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11462 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11465 *mode_line_noprop_ptr
++ = c
;
11469 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11470 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11471 characters that yield more columns than PRECISION; PRECISION <= 0
11472 means copy the whole string. Pad with spaces until FIELD_WIDTH
11473 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11474 pad. Called from display_mode_element when it is used to build a
11478 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11480 const unsigned char *str
= (const unsigned char *) string
;
11482 ptrdiff_t dummy
, nbytes
;
11484 /* Copy at most PRECISION chars from STR. */
11485 nbytes
= strlen (string
);
11486 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11488 store_mode_line_noprop_char (*str
++);
11490 /* Fill up with spaces until FIELD_WIDTH reached. */
11491 while (field_width
> 0
11492 && n
< field_width
)
11494 store_mode_line_noprop_char (' ');
11501 /***********************************************************************
11503 ***********************************************************************/
11505 #ifdef HAVE_WINDOW_SYSTEM
11507 /* Set the title of FRAME, if it has changed. The title format is
11508 Vicon_title_format if FRAME is iconified, otherwise it is
11509 frame_title_format. */
11512 x_consider_frame_title (Lisp_Object frame
)
11514 struct frame
*f
= XFRAME (frame
);
11516 if (FRAME_WINDOW_P (f
)
11517 || FRAME_MINIBUF_ONLY_P (f
)
11518 || f
->explicit_name
)
11520 /* Do we have more than one visible frame on this X display? */
11521 Lisp_Object tail
, other_frame
, fmt
;
11522 ptrdiff_t title_start
;
11526 ptrdiff_t count
= SPECPDL_INDEX ();
11528 FOR_EACH_FRAME (tail
, other_frame
)
11530 struct frame
*tf
= XFRAME (other_frame
);
11533 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11534 && !FRAME_MINIBUF_ONLY_P (tf
)
11535 && !EQ (other_frame
, tip_frame
)
11536 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11540 /* Set global variable indicating that multiple frames exist. */
11541 multiple_frames
= CONSP (tail
);
11543 /* Switch to the buffer of selected window of the frame. Set up
11544 mode_line_target so that display_mode_element will output into
11545 mode_line_noprop_buf; then display the title. */
11546 record_unwind_protect (unwind_format_mode_line
,
11547 format_mode_line_unwind_data
11548 (f
, current_buffer
, selected_window
, 0));
11550 Fselect_window (f
->selected_window
, Qt
);
11551 set_buffer_internal_1
11552 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11553 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11555 mode_line_target
= MODE_LINE_TITLE
;
11556 title_start
= MODE_LINE_NOPROP_LEN (0);
11557 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11558 NULL
, DEFAULT_FACE_ID
);
11559 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11560 len
= MODE_LINE_NOPROP_LEN (title_start
);
11561 title
= mode_line_noprop_buf
+ title_start
;
11562 unbind_to (count
, Qnil
);
11564 /* Set the title only if it's changed. This avoids consing in
11565 the common case where it hasn't. (If it turns out that we've
11566 already wasted too much time by walking through the list with
11567 display_mode_element, then we might need to optimize at a
11568 higher level than this.) */
11569 if (! STRINGP (f
->name
)
11570 || SBYTES (f
->name
) != len
11571 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11572 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11576 #endif /* not HAVE_WINDOW_SYSTEM */
11579 /***********************************************************************
11581 ***********************************************************************/
11583 /* Non-zero if we will not redisplay all visible windows. */
11584 #define REDISPLAY_SOME_P() \
11585 ((windows_or_buffers_changed == 0 \
11586 || windows_or_buffers_changed == REDISPLAY_SOME) \
11587 && (update_mode_lines == 0 \
11588 || update_mode_lines == REDISPLAY_SOME))
11590 /* Prepare for redisplay by updating menu-bar item lists when
11591 appropriate. This can call eval. */
11594 prepare_menu_bars (void)
11596 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11597 bool some_windows
= REDISPLAY_SOME_P ();
11598 struct gcpro gcpro1
, gcpro2
;
11599 Lisp_Object tooltip_frame
;
11601 #ifdef HAVE_WINDOW_SYSTEM
11602 tooltip_frame
= tip_frame
;
11604 tooltip_frame
= Qnil
;
11607 if (FUNCTIONP (Vpre_redisplay_function
))
11609 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11610 if (all_windows
&& some_windows
)
11612 Lisp_Object ws
= window_list ();
11613 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11615 Lisp_Object
this = XCAR (ws
);
11616 struct window
*w
= XWINDOW (this);
11618 || XFRAME (w
->frame
)->redisplay
11619 || XBUFFER (w
->contents
)->text
->redisplay
)
11621 windows
= Fcons (this, windows
);
11625 safe__call1 (true, Vpre_redisplay_function
, windows
);
11628 /* Update all frame titles based on their buffer names, etc. We do
11629 this before the menu bars so that the buffer-menu will show the
11630 up-to-date frame titles. */
11631 #ifdef HAVE_WINDOW_SYSTEM
11634 Lisp_Object tail
, frame
;
11636 FOR_EACH_FRAME (tail
, frame
)
11638 struct frame
*f
= XFRAME (frame
);
11639 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11643 && !XBUFFER (w
->contents
)->text
->redisplay
)
11646 if (!EQ (frame
, tooltip_frame
)
11647 && (FRAME_ICONIFIED_P (f
)
11648 || FRAME_VISIBLE_P (f
) == 1
11649 /* Exclude TTY frames that are obscured because they
11650 are not the top frame on their console. This is
11651 because x_consider_frame_title actually switches
11652 to the frame, which for TTY frames means it is
11653 marked as garbaged, and will be completely
11654 redrawn on the next redisplay cycle. This causes
11655 TTY frames to be completely redrawn, when there
11656 are more than one of them, even though nothing
11657 should be changed on display. */
11658 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11659 x_consider_frame_title (frame
);
11662 #endif /* HAVE_WINDOW_SYSTEM */
11664 /* Update the menu bar item lists, if appropriate. This has to be
11665 done before any actual redisplay or generation of display lines. */
11669 Lisp_Object tail
, frame
;
11670 ptrdiff_t count
= SPECPDL_INDEX ();
11671 /* 1 means that update_menu_bar has run its hooks
11672 so any further calls to update_menu_bar shouldn't do so again. */
11673 int menu_bar_hooks_run
= 0;
11675 record_unwind_save_match_data ();
11677 FOR_EACH_FRAME (tail
, frame
)
11679 struct frame
*f
= XFRAME (frame
);
11680 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11682 /* Ignore tooltip frame. */
11683 if (EQ (frame
, tooltip_frame
))
11689 && !XBUFFER (w
->contents
)->text
->redisplay
)
11692 /* If a window on this frame changed size, report that to
11693 the user and clear the size-change flag. */
11694 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11696 Lisp_Object functions
;
11698 /* Clear flag first in case we get an error below. */
11699 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11700 functions
= Vwindow_size_change_functions
;
11701 GCPRO2 (tail
, functions
);
11703 while (CONSP (functions
))
11705 if (!EQ (XCAR (functions
), Qt
))
11706 call1 (XCAR (functions
), frame
);
11707 functions
= XCDR (functions
);
11713 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11714 #ifdef HAVE_WINDOW_SYSTEM
11715 update_tool_bar (f
, 0);
11720 unbind_to (count
, Qnil
);
11724 struct frame
*sf
= SELECTED_FRAME ();
11725 update_menu_bar (sf
, 1, 0);
11726 #ifdef HAVE_WINDOW_SYSTEM
11727 update_tool_bar (sf
, 1);
11733 /* Update the menu bar item list for frame F. This has to be done
11734 before we start to fill in any display lines, because it can call
11737 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11739 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11740 already ran the menu bar hooks for this redisplay, so there
11741 is no need to run them again. The return value is the
11742 updated value of this flag, to pass to the next call. */
11745 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11747 Lisp_Object window
;
11748 register struct window
*w
;
11750 /* If called recursively during a menu update, do nothing. This can
11751 happen when, for instance, an activate-menubar-hook causes a
11753 if (inhibit_menubar_update
)
11756 window
= FRAME_SELECTED_WINDOW (f
);
11757 w
= XWINDOW (window
);
11759 if (FRAME_WINDOW_P (f
)
11761 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11762 || defined (HAVE_NS) || defined (USE_GTK)
11763 FRAME_EXTERNAL_MENU_BAR (f
)
11765 FRAME_MENU_BAR_LINES (f
) > 0
11767 : FRAME_MENU_BAR_LINES (f
) > 0)
11769 /* If the user has switched buffers or windows, we need to
11770 recompute to reflect the new bindings. But we'll
11771 recompute when update_mode_lines is set too; that means
11772 that people can use force-mode-line-update to request
11773 that the menu bar be recomputed. The adverse effect on
11774 the rest of the redisplay algorithm is about the same as
11775 windows_or_buffers_changed anyway. */
11776 if (windows_or_buffers_changed
11777 /* This used to test w->update_mode_line, but we believe
11778 there is no need to recompute the menu in that case. */
11779 || update_mode_lines
11780 || window_buffer_changed (w
))
11782 struct buffer
*prev
= current_buffer
;
11783 ptrdiff_t count
= SPECPDL_INDEX ();
11785 specbind (Qinhibit_menubar_update
, Qt
);
11787 set_buffer_internal_1 (XBUFFER (w
->contents
));
11788 if (save_match_data
)
11789 record_unwind_save_match_data ();
11790 if (NILP (Voverriding_local_map_menu_flag
))
11792 specbind (Qoverriding_terminal_local_map
, Qnil
);
11793 specbind (Qoverriding_local_map
, Qnil
);
11798 /* Run the Lucid hook. */
11799 safe_run_hooks (Qactivate_menubar_hook
);
11801 /* If it has changed current-menubar from previous value,
11802 really recompute the menu-bar from the value. */
11803 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11804 call0 (Qrecompute_lucid_menubar
);
11806 safe_run_hooks (Qmenu_bar_update_hook
);
11811 XSETFRAME (Vmenu_updating_frame
, f
);
11812 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11814 /* Redisplay the menu bar in case we changed it. */
11815 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11816 || defined (HAVE_NS) || defined (USE_GTK)
11817 if (FRAME_WINDOW_P (f
))
11819 #if defined (HAVE_NS)
11820 /* All frames on Mac OS share the same menubar. So only
11821 the selected frame should be allowed to set it. */
11822 if (f
== SELECTED_FRAME ())
11824 set_frame_menubar (f
, 0, 0);
11827 /* On a terminal screen, the menu bar is an ordinary screen
11828 line, and this makes it get updated. */
11829 w
->update_mode_line
= 1;
11830 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11831 /* In the non-toolkit version, the menu bar is an ordinary screen
11832 line, and this makes it get updated. */
11833 w
->update_mode_line
= 1;
11834 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11836 unbind_to (count
, Qnil
);
11837 set_buffer_internal_1 (prev
);
11844 /***********************************************************************
11846 ***********************************************************************/
11848 #ifdef HAVE_WINDOW_SYSTEM
11850 /* Select `frame' temporarily without running all the code in
11852 FIXME: Maybe do_switch_frame should be trimmed down similarly
11853 when `norecord' is set. */
11855 fast_set_selected_frame (Lisp_Object frame
)
11857 if (!EQ (selected_frame
, frame
))
11859 selected_frame
= frame
;
11860 selected_window
= XFRAME (frame
)->selected_window
;
11864 /* Update the tool-bar item list for frame F. This has to be done
11865 before we start to fill in any display lines. Called from
11866 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11867 and restore it here. */
11870 update_tool_bar (struct frame
*f
, int save_match_data
)
11872 #if defined (USE_GTK) || defined (HAVE_NS)
11873 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11875 int do_update
= (WINDOWP (f
->tool_bar_window
)
11876 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11881 Lisp_Object window
;
11884 window
= FRAME_SELECTED_WINDOW (f
);
11885 w
= XWINDOW (window
);
11887 /* If the user has switched buffers or windows, we need to
11888 recompute to reflect the new bindings. But we'll
11889 recompute when update_mode_lines is set too; that means
11890 that people can use force-mode-line-update to request
11891 that the menu bar be recomputed. The adverse effect on
11892 the rest of the redisplay algorithm is about the same as
11893 windows_or_buffers_changed anyway. */
11894 if (windows_or_buffers_changed
11895 || w
->update_mode_line
11896 || update_mode_lines
11897 || window_buffer_changed (w
))
11899 struct buffer
*prev
= current_buffer
;
11900 ptrdiff_t count
= SPECPDL_INDEX ();
11901 Lisp_Object frame
, new_tool_bar
;
11902 int new_n_tool_bar
;
11903 struct gcpro gcpro1
;
11905 /* Set current_buffer to the buffer of the selected
11906 window of the frame, so that we get the right local
11908 set_buffer_internal_1 (XBUFFER (w
->contents
));
11910 /* Save match data, if we must. */
11911 if (save_match_data
)
11912 record_unwind_save_match_data ();
11914 /* Make sure that we don't accidentally use bogus keymaps. */
11915 if (NILP (Voverriding_local_map_menu_flag
))
11917 specbind (Qoverriding_terminal_local_map
, Qnil
);
11918 specbind (Qoverriding_local_map
, Qnil
);
11921 GCPRO1 (new_tool_bar
);
11923 /* We must temporarily set the selected frame to this frame
11924 before calling tool_bar_items, because the calculation of
11925 the tool-bar keymap uses the selected frame (see
11926 `tool-bar-make-keymap' in tool-bar.el). */
11927 eassert (EQ (selected_window
,
11928 /* Since we only explicitly preserve selected_frame,
11929 check that selected_window would be redundant. */
11930 XFRAME (selected_frame
)->selected_window
));
11931 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11932 XSETFRAME (frame
, f
);
11933 fast_set_selected_frame (frame
);
11935 /* Build desired tool-bar items from keymaps. */
11937 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11940 /* Redisplay the tool-bar if we changed it. */
11941 if (new_n_tool_bar
!= f
->n_tool_bar_items
11942 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11944 /* Redisplay that happens asynchronously due to an expose event
11945 may access f->tool_bar_items. Make sure we update both
11946 variables within BLOCK_INPUT so no such event interrupts. */
11948 fset_tool_bar_items (f
, new_tool_bar
);
11949 f
->n_tool_bar_items
= new_n_tool_bar
;
11950 w
->update_mode_line
= 1;
11956 unbind_to (count
, Qnil
);
11957 set_buffer_internal_1 (prev
);
11962 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11964 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11965 F's desired tool-bar contents. F->tool_bar_items must have
11966 been set up previously by calling prepare_menu_bars. */
11969 build_desired_tool_bar_string (struct frame
*f
)
11971 int i
, size
, size_needed
;
11972 struct gcpro gcpro1
, gcpro2
;
11973 Lisp_Object image
, plist
;
11975 image
= plist
= Qnil
;
11976 GCPRO2 (image
, plist
);
11978 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11979 Otherwise, make a new string. */
11981 /* The size of the string we might be able to reuse. */
11982 size
= (STRINGP (f
->desired_tool_bar_string
)
11983 ? SCHARS (f
->desired_tool_bar_string
)
11986 /* We need one space in the string for each image. */
11987 size_needed
= f
->n_tool_bar_items
;
11989 /* Reuse f->desired_tool_bar_string, if possible. */
11990 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11991 fset_desired_tool_bar_string
11992 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11995 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11996 struct gcpro gcpro1
;
11998 Fremove_text_properties (make_number (0), make_number (size
),
11999 props
, f
->desired_tool_bar_string
);
12003 /* Put a `display' property on the string for the images to display,
12004 put a `menu_item' property on tool-bar items with a value that
12005 is the index of the item in F's tool-bar item vector. */
12006 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12008 #define PROP(IDX) \
12009 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12011 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12012 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12013 int hmargin
, vmargin
, relief
, idx
, end
;
12015 /* If image is a vector, choose the image according to the
12017 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12018 if (VECTORP (image
))
12022 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12023 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12026 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12027 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12029 eassert (ASIZE (image
) >= idx
);
12030 image
= AREF (image
, idx
);
12035 /* Ignore invalid image specifications. */
12036 if (!valid_image_p (image
))
12039 /* Display the tool-bar button pressed, or depressed. */
12040 plist
= Fcopy_sequence (XCDR (image
));
12042 /* Compute margin and relief to draw. */
12043 relief
= (tool_bar_button_relief
>= 0
12044 ? tool_bar_button_relief
12045 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12046 hmargin
= vmargin
= relief
;
12048 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12049 INT_MAX
- max (hmargin
, vmargin
)))
12051 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12052 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12054 else if (CONSP (Vtool_bar_button_margin
))
12056 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12057 INT_MAX
- hmargin
))
12058 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12060 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12061 INT_MAX
- vmargin
))
12062 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12065 if (auto_raise_tool_bar_buttons_p
)
12067 /* Add a `:relief' property to the image spec if the item is
12071 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12078 /* If image is selected, display it pressed, i.e. with a
12079 negative relief. If it's not selected, display it with a
12081 plist
= Fplist_put (plist
, QCrelief
,
12083 ? make_number (-relief
)
12084 : make_number (relief
)));
12089 /* Put a margin around the image. */
12090 if (hmargin
|| vmargin
)
12092 if (hmargin
== vmargin
)
12093 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12095 plist
= Fplist_put (plist
, QCmargin
,
12096 Fcons (make_number (hmargin
),
12097 make_number (vmargin
)));
12100 /* If button is not enabled, and we don't have special images
12101 for the disabled state, make the image appear disabled by
12102 applying an appropriate algorithm to it. */
12103 if (!enabled_p
&& idx
< 0)
12104 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12106 /* Put a `display' text property on the string for the image to
12107 display. Put a `menu-item' property on the string that gives
12108 the start of this item's properties in the tool-bar items
12110 image
= Fcons (Qimage
, plist
);
12111 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12112 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12113 struct gcpro gcpro1
;
12116 /* Let the last image hide all remaining spaces in the tool bar
12117 string. The string can be longer than needed when we reuse a
12118 previous string. */
12119 if (i
+ 1 == f
->n_tool_bar_items
)
12120 end
= SCHARS (f
->desired_tool_bar_string
);
12123 Fadd_text_properties (make_number (i
), make_number (end
),
12124 props
, f
->desired_tool_bar_string
);
12133 /* Display one line of the tool-bar of frame IT->f.
12135 HEIGHT specifies the desired height of the tool-bar line.
12136 If the actual height of the glyph row is less than HEIGHT, the
12137 row's height is increased to HEIGHT, and the icons are centered
12138 vertically in the new height.
12140 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12141 count a final empty row in case the tool-bar width exactly matches
12146 display_tool_bar_line (struct it
*it
, int height
)
12148 struct glyph_row
*row
= it
->glyph_row
;
12149 int max_x
= it
->last_visible_x
;
12150 struct glyph
*last
;
12152 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12153 clear_glyph_row (row
);
12154 row
->enabled_p
= true;
12155 row
->y
= it
->current_y
;
12157 /* Note that this isn't made use of if the face hasn't a box,
12158 so there's no need to check the face here. */
12159 it
->start_of_box_run_p
= 1;
12161 while (it
->current_x
< max_x
)
12163 int x
, n_glyphs_before
, i
, nglyphs
;
12164 struct it it_before
;
12166 /* Get the next display element. */
12167 if (!get_next_display_element (it
))
12169 /* Don't count empty row if we are counting needed tool-bar lines. */
12170 if (height
< 0 && !it
->hpos
)
12175 /* Produce glyphs. */
12176 n_glyphs_before
= row
->used
[TEXT_AREA
];
12179 PRODUCE_GLYPHS (it
);
12181 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12183 x
= it_before
.current_x
;
12184 while (i
< nglyphs
)
12186 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12188 if (x
+ glyph
->pixel_width
> max_x
)
12190 /* Glyph doesn't fit on line. Backtrack. */
12191 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12193 /* If this is the only glyph on this line, it will never fit on the
12194 tool-bar, so skip it. But ensure there is at least one glyph,
12195 so we don't accidentally disable the tool-bar. */
12196 if (n_glyphs_before
== 0
12197 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12203 x
+= glyph
->pixel_width
;
12207 /* Stop at line end. */
12208 if (ITERATOR_AT_END_OF_LINE_P (it
))
12211 set_iterator_to_next (it
, 1);
12216 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12218 /* Use default face for the border below the tool bar.
12220 FIXME: When auto-resize-tool-bars is grow-only, there is
12221 no additional border below the possibly empty tool-bar lines.
12222 So to make the extra empty lines look "normal", we have to
12223 use the tool-bar face for the border too. */
12224 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12225 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12226 it
->face_id
= DEFAULT_FACE_ID
;
12228 extend_face_to_end_of_line (it
);
12229 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12230 last
->right_box_line_p
= 1;
12231 if (last
== row
->glyphs
[TEXT_AREA
])
12232 last
->left_box_line_p
= 1;
12234 /* Make line the desired height and center it vertically. */
12235 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12237 /* Don't add more than one line height. */
12238 height
%= FRAME_LINE_HEIGHT (it
->f
);
12239 it
->max_ascent
+= height
/ 2;
12240 it
->max_descent
+= (height
+ 1) / 2;
12243 compute_line_metrics (it
);
12245 /* If line is empty, make it occupy the rest of the tool-bar. */
12246 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12248 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12249 row
->visible_height
= row
->height
;
12250 row
->ascent
= row
->phys_ascent
= 0;
12251 row
->extra_line_spacing
= 0;
12254 row
->full_width_p
= 1;
12255 row
->continued_p
= 0;
12256 row
->truncated_on_left_p
= 0;
12257 row
->truncated_on_right_p
= 0;
12259 it
->current_x
= it
->hpos
= 0;
12260 it
->current_y
+= row
->height
;
12266 /* Value is the number of pixels needed to make all tool-bar items of
12267 frame F visible. The actual number of glyph rows needed is
12268 returned in *N_ROWS if non-NULL. */
12270 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12272 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12274 /* tool_bar_height is called from redisplay_tool_bar after building
12275 the desired matrix, so use (unused) mode-line row as temporary row to
12276 avoid destroying the first tool-bar row. */
12277 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12279 /* Initialize an iterator for iteration over
12280 F->desired_tool_bar_string in the tool-bar window of frame F. */
12281 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12282 temp_row
->reversed_p
= false;
12283 it
.first_visible_x
= 0;
12284 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12285 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12286 it
.paragraph_embedding
= L2R
;
12288 while (!ITERATOR_AT_END_P (&it
))
12290 clear_glyph_row (temp_row
);
12291 it
.glyph_row
= temp_row
;
12292 display_tool_bar_line (&it
, -1);
12294 clear_glyph_row (temp_row
);
12296 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12298 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12301 return it
.current_y
;
12303 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12306 #endif /* !USE_GTK && !HAVE_NS */
12308 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12310 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12311 If FRAME is nil or omitted, use the selected frame. Optional argument
12312 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12313 (Lisp_Object frame
, Lisp_Object pixelwise
)
12317 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12318 struct frame
*f
= decode_any_frame (frame
);
12320 if (WINDOWP (f
->tool_bar_window
)
12321 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12323 update_tool_bar (f
, 1);
12324 if (f
->n_tool_bar_items
)
12326 build_desired_tool_bar_string (f
);
12327 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12332 return make_number (height
);
12336 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12337 height should be changed. */
12339 redisplay_tool_bar (struct frame
*f
)
12341 #if defined (USE_GTK) || defined (HAVE_NS)
12343 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12344 update_frame_tool_bar (f
);
12347 #else /* !USE_GTK && !HAVE_NS */
12351 struct glyph_row
*row
;
12353 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12354 do anything. This means you must start with tool-bar-lines
12355 non-zero to get the auto-sizing effect. Or in other words, you
12356 can turn off tool-bars by specifying tool-bar-lines zero. */
12357 if (!WINDOWP (f
->tool_bar_window
)
12358 || (w
= XWINDOW (f
->tool_bar_window
),
12359 WINDOW_TOTAL_LINES (w
) == 0))
12362 /* Set up an iterator for the tool-bar window. */
12363 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12364 it
.first_visible_x
= 0;
12365 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12366 row
= it
.glyph_row
;
12367 row
->reversed_p
= false;
12369 /* Build a string that represents the contents of the tool-bar. */
12370 build_desired_tool_bar_string (f
);
12371 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12372 /* FIXME: This should be controlled by a user option. But it
12373 doesn't make sense to have an R2L tool bar if the menu bar cannot
12374 be drawn also R2L, and making the menu bar R2L is tricky due
12375 toolkit-specific code that implements it. If an R2L tool bar is
12376 ever supported, display_tool_bar_line should also be augmented to
12377 call unproduce_glyphs like display_line and display_string
12379 it
.paragraph_embedding
= L2R
;
12381 if (f
->n_tool_bar_rows
== 0)
12383 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12385 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12387 x_change_tool_bar_height (f
, new_height
);
12388 frame_default_tool_bar_height
= new_height
;
12389 /* Always do that now. */
12390 clear_glyph_matrix (w
->desired_matrix
);
12391 f
->fonts_changed
= 1;
12396 /* Display as many lines as needed to display all tool-bar items. */
12398 if (f
->n_tool_bar_rows
> 0)
12400 int border
, rows
, height
, extra
;
12402 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12403 border
= XINT (Vtool_bar_border
);
12404 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12405 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12406 else if (EQ (Vtool_bar_border
, Qborder_width
))
12407 border
= f
->border_width
;
12413 rows
= f
->n_tool_bar_rows
;
12414 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12415 extra
= it
.last_visible_y
- border
- height
* rows
;
12417 while (it
.current_y
< it
.last_visible_y
)
12420 if (extra
> 0 && rows
-- > 0)
12422 h
= (extra
+ rows
- 1) / rows
;
12425 display_tool_bar_line (&it
, height
+ h
);
12430 while (it
.current_y
< it
.last_visible_y
)
12431 display_tool_bar_line (&it
, 0);
12434 /* It doesn't make much sense to try scrolling in the tool-bar
12435 window, so don't do it. */
12436 w
->desired_matrix
->no_scrolling_p
= 1;
12437 w
->must_be_updated_p
= 1;
12439 if (!NILP (Vauto_resize_tool_bars
))
12441 int change_height_p
= 0;
12443 /* If we couldn't display everything, change the tool-bar's
12444 height if there is room for more. */
12445 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12446 change_height_p
= 1;
12448 /* We subtract 1 because display_tool_bar_line advances the
12449 glyph_row pointer before returning to its caller. We want to
12450 examine the last glyph row produced by
12451 display_tool_bar_line. */
12452 row
= it
.glyph_row
- 1;
12454 /* If there are blank lines at the end, except for a partially
12455 visible blank line at the end that is smaller than
12456 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12457 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12458 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12459 change_height_p
= 1;
12461 /* If row displays tool-bar items, but is partially visible,
12462 change the tool-bar's height. */
12463 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12464 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12465 change_height_p
= 1;
12467 /* Resize windows as needed by changing the `tool-bar-lines'
12468 frame parameter. */
12469 if (change_height_p
)
12472 int new_height
= tool_bar_height (f
, &nrows
, 1);
12474 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12475 && !f
->minimize_tool_bar_window_p
)
12476 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12477 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12478 f
->minimize_tool_bar_window_p
= 0;
12480 if (change_height_p
)
12482 x_change_tool_bar_height (f
, new_height
);
12483 frame_default_tool_bar_height
= new_height
;
12484 clear_glyph_matrix (w
->desired_matrix
);
12485 f
->n_tool_bar_rows
= nrows
;
12486 f
->fonts_changed
= 1;
12493 f
->minimize_tool_bar_window_p
= 0;
12496 #endif /* USE_GTK || HAVE_NS */
12499 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12501 /* Get information about the tool-bar item which is displayed in GLYPH
12502 on frame F. Return in *PROP_IDX the index where tool-bar item
12503 properties start in F->tool_bar_items. Value is zero if
12504 GLYPH doesn't display a tool-bar item. */
12507 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12513 /* This function can be called asynchronously, which means we must
12514 exclude any possibility that Fget_text_property signals an
12516 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12517 charpos
= max (0, charpos
);
12519 /* Get the text property `menu-item' at pos. The value of that
12520 property is the start index of this item's properties in
12521 F->tool_bar_items. */
12522 prop
= Fget_text_property (make_number (charpos
),
12523 Qmenu_item
, f
->current_tool_bar_string
);
12524 if (INTEGERP (prop
))
12526 *prop_idx
= XINT (prop
);
12536 /* Get information about the tool-bar item at position X/Y on frame F.
12537 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12538 the current matrix of the tool-bar window of F, or NULL if not
12539 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12540 item in F->tool_bar_items. Value is
12542 -1 if X/Y is not on a tool-bar item
12543 0 if X/Y is on the same item that was highlighted before.
12547 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12548 int *hpos
, int *vpos
, int *prop_idx
)
12550 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12551 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12554 /* Find the glyph under X/Y. */
12555 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12556 if (*glyph
== NULL
)
12559 /* Get the start of this tool-bar item's properties in
12560 f->tool_bar_items. */
12561 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12564 /* Is mouse on the highlighted item? */
12565 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12566 && *vpos
>= hlinfo
->mouse_face_beg_row
12567 && *vpos
<= hlinfo
->mouse_face_end_row
12568 && (*vpos
> hlinfo
->mouse_face_beg_row
12569 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12570 && (*vpos
< hlinfo
->mouse_face_end_row
12571 || *hpos
< hlinfo
->mouse_face_end_col
12572 || hlinfo
->mouse_face_past_end
))
12580 Handle mouse button event on the tool-bar of frame F, at
12581 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12582 0 for button release. MODIFIERS is event modifiers for button
12586 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12589 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12590 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12591 int hpos
, vpos
, prop_idx
;
12592 struct glyph
*glyph
;
12593 Lisp_Object enabled_p
;
12596 /* If not on the highlighted tool-bar item, and mouse-highlight is
12597 non-nil, return. This is so we generate the tool-bar button
12598 click only when the mouse button is released on the same item as
12599 where it was pressed. However, when mouse-highlight is disabled,
12600 generate the click when the button is released regardless of the
12601 highlight, since tool-bar items are not highlighted in that
12603 frame_to_window_pixel_xy (w
, &x
, &y
);
12604 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12606 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12609 /* When mouse-highlight is off, generate the click for the item
12610 where the button was pressed, disregarding where it was
12612 if (NILP (Vmouse_highlight
) && !down_p
)
12613 prop_idx
= f
->last_tool_bar_item
;
12615 /* If item is disabled, do nothing. */
12616 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12617 if (NILP (enabled_p
))
12622 /* Show item in pressed state. */
12623 if (!NILP (Vmouse_highlight
))
12624 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12625 f
->last_tool_bar_item
= prop_idx
;
12629 Lisp_Object key
, frame
;
12630 struct input_event event
;
12631 EVENT_INIT (event
);
12633 /* Show item in released state. */
12634 if (!NILP (Vmouse_highlight
))
12635 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12637 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12639 XSETFRAME (frame
, f
);
12640 event
.kind
= TOOL_BAR_EVENT
;
12641 event
.frame_or_window
= frame
;
12643 kbd_buffer_store_event (&event
);
12645 event
.kind
= TOOL_BAR_EVENT
;
12646 event
.frame_or_window
= frame
;
12648 event
.modifiers
= modifiers
;
12649 kbd_buffer_store_event (&event
);
12650 f
->last_tool_bar_item
= -1;
12655 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12656 tool-bar window-relative coordinates X/Y. Called from
12657 note_mouse_highlight. */
12660 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12662 Lisp_Object window
= f
->tool_bar_window
;
12663 struct window
*w
= XWINDOW (window
);
12664 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12665 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12667 struct glyph
*glyph
;
12668 struct glyph_row
*row
;
12670 Lisp_Object enabled_p
;
12672 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12673 int mouse_down_p
, rc
;
12675 /* Function note_mouse_highlight is called with negative X/Y
12676 values when mouse moves outside of the frame. */
12677 if (x
<= 0 || y
<= 0)
12679 clear_mouse_face (hlinfo
);
12683 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12686 /* Not on tool-bar item. */
12687 clear_mouse_face (hlinfo
);
12691 /* On same tool-bar item as before. */
12692 goto set_help_echo
;
12694 clear_mouse_face (hlinfo
);
12696 /* Mouse is down, but on different tool-bar item? */
12697 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12698 && f
== dpyinfo
->last_mouse_frame
);
12700 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12703 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12705 /* If tool-bar item is not enabled, don't highlight it. */
12706 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12707 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12709 /* Compute the x-position of the glyph. In front and past the
12710 image is a space. We include this in the highlighted area. */
12711 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12712 for (i
= x
= 0; i
< hpos
; ++i
)
12713 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12715 /* Record this as the current active region. */
12716 hlinfo
->mouse_face_beg_col
= hpos
;
12717 hlinfo
->mouse_face_beg_row
= vpos
;
12718 hlinfo
->mouse_face_beg_x
= x
;
12719 hlinfo
->mouse_face_past_end
= 0;
12721 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12722 hlinfo
->mouse_face_end_row
= vpos
;
12723 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12724 hlinfo
->mouse_face_window
= window
;
12725 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12727 /* Display it as active. */
12728 show_mouse_face (hlinfo
, draw
);
12733 /* Set help_echo_string to a help string to display for this tool-bar item.
12734 XTread_socket does the rest. */
12735 help_echo_object
= help_echo_window
= Qnil
;
12736 help_echo_pos
= -1;
12737 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12738 if (NILP (help_echo_string
))
12739 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12742 #endif /* !USE_GTK && !HAVE_NS */
12744 #endif /* HAVE_WINDOW_SYSTEM */
12748 /************************************************************************
12749 Horizontal scrolling
12750 ************************************************************************/
12752 static int hscroll_window_tree (Lisp_Object
);
12753 static int hscroll_windows (Lisp_Object
);
12755 /* For all leaf windows in the window tree rooted at WINDOW, set their
12756 hscroll value so that PT is (i) visible in the window, and (ii) so
12757 that it is not within a certain margin at the window's left and
12758 right border. Value is non-zero if any window's hscroll has been
12762 hscroll_window_tree (Lisp_Object window
)
12764 int hscrolled_p
= 0;
12765 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12766 int hscroll_step_abs
= 0;
12767 double hscroll_step_rel
= 0;
12769 if (hscroll_relative_p
)
12771 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12772 if (hscroll_step_rel
< 0)
12774 hscroll_relative_p
= 0;
12775 hscroll_step_abs
= 0;
12778 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12780 hscroll_step_abs
= XINT (Vhscroll_step
);
12781 if (hscroll_step_abs
< 0)
12782 hscroll_step_abs
= 0;
12785 hscroll_step_abs
= 0;
12787 while (WINDOWP (window
))
12789 struct window
*w
= XWINDOW (window
);
12791 if (WINDOWP (w
->contents
))
12792 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12793 else if (w
->cursor
.vpos
>= 0)
12796 int text_area_width
;
12797 struct glyph_row
*cursor_row
;
12798 struct glyph_row
*bottom_row
;
12801 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12802 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12803 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12805 cursor_row
= bottom_row
- 1;
12807 if (!cursor_row
->enabled_p
)
12809 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12810 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12811 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12813 cursor_row
= bottom_row
- 1;
12815 row_r2l_p
= cursor_row
->reversed_p
;
12817 text_area_width
= window_box_width (w
, TEXT_AREA
);
12819 /* Scroll when cursor is inside this scroll margin. */
12820 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12822 /* If the position of this window's point has explicitly
12823 changed, no more suspend auto hscrolling. */
12824 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12825 w
->suspend_auto_hscroll
= 0;
12827 /* Remember window point. */
12828 Fset_marker (w
->old_pointm
,
12829 ((w
== XWINDOW (selected_window
))
12830 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12831 : Fmarker_position (w
->pointm
)),
12834 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12835 && w
->suspend_auto_hscroll
== 0
12836 /* In some pathological cases, like restoring a window
12837 configuration into a frame that is much smaller than
12838 the one from which the configuration was saved, we
12839 get glyph rows whose start and end have zero buffer
12840 positions, which we cannot handle below. Just skip
12842 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12843 /* For left-to-right rows, hscroll when cursor is either
12844 (i) inside the right hscroll margin, or (ii) if it is
12845 inside the left margin and the window is already
12848 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12849 || (cursor_row
->enabled_p
12850 && cursor_row
->truncated_on_right_p
12851 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12852 /* For right-to-left rows, the logic is similar,
12853 except that rules for scrolling to left and right
12854 are reversed. E.g., if cursor.x <= h_margin, we
12855 need to hscroll "to the right" unconditionally,
12856 and that will scroll the screen to the left so as
12857 to reveal the next portion of the row. */
12859 && ((cursor_row
->enabled_p
12860 /* FIXME: It is confusing to set the
12861 truncated_on_right_p flag when R2L rows
12862 are actually truncated on the left. */
12863 && cursor_row
->truncated_on_right_p
12864 && w
->cursor
.x
<= h_margin
)
12866 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12870 struct buffer
*saved_current_buffer
;
12874 /* Find point in a display of infinite width. */
12875 saved_current_buffer
= current_buffer
;
12876 current_buffer
= XBUFFER (w
->contents
);
12878 if (w
== XWINDOW (selected_window
))
12881 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12883 /* Move iterator to pt starting at cursor_row->start in
12884 a line with infinite width. */
12885 init_to_row_start (&it
, w
, cursor_row
);
12886 it
.last_visible_x
= INFINITY
;
12887 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12888 current_buffer
= saved_current_buffer
;
12890 /* Position cursor in window. */
12891 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12892 hscroll
= max (0, (it
.current_x
12893 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12894 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12895 : (text_area_width
/ 2))))
12896 / FRAME_COLUMN_WIDTH (it
.f
);
12897 else if ((!row_r2l_p
12898 && w
->cursor
.x
>= text_area_width
- h_margin
)
12899 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12901 if (hscroll_relative_p
)
12902 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12905 wanted_x
= text_area_width
12906 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12909 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12913 if (hscroll_relative_p
)
12914 wanted_x
= text_area_width
* hscroll_step_rel
12917 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12920 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12922 hscroll
= max (hscroll
, w
->min_hscroll
);
12924 /* Don't prevent redisplay optimizations if hscroll
12925 hasn't changed, as it will unnecessarily slow down
12927 if (w
->hscroll
!= hscroll
)
12929 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12930 w
->hscroll
= hscroll
;
12939 /* Value is non-zero if hscroll of any leaf window has been changed. */
12940 return hscrolled_p
;
12944 /* Set hscroll so that cursor is visible and not inside horizontal
12945 scroll margins for all windows in the tree rooted at WINDOW. See
12946 also hscroll_window_tree above. Value is non-zero if any window's
12947 hscroll has been changed. If it has, desired matrices on the frame
12948 of WINDOW are cleared. */
12951 hscroll_windows (Lisp_Object window
)
12953 int hscrolled_p
= hscroll_window_tree (window
);
12955 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12956 return hscrolled_p
;
12961 /************************************************************************
12963 ************************************************************************/
12965 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12966 to a non-zero value. This is sometimes handy to have in a debugger
12971 /* First and last unchanged row for try_window_id. */
12973 static int debug_first_unchanged_at_end_vpos
;
12974 static int debug_last_unchanged_at_beg_vpos
;
12976 /* Delta vpos and y. */
12978 static int debug_dvpos
, debug_dy
;
12980 /* Delta in characters and bytes for try_window_id. */
12982 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12984 /* Values of window_end_pos and window_end_vpos at the end of
12987 static ptrdiff_t debug_end_vpos
;
12989 /* Append a string to W->desired_matrix->method. FMT is a printf
12990 format string. If trace_redisplay_p is true also printf the
12991 resulting string to stderr. */
12993 static void debug_method_add (struct window
*, char const *, ...)
12994 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12997 debug_method_add (struct window
*w
, char const *fmt
, ...)
13000 char *method
= w
->desired_matrix
->method
;
13001 int len
= strlen (method
);
13002 int size
= sizeof w
->desired_matrix
->method
;
13003 int remaining
= size
- len
- 1;
13006 if (len
&& remaining
)
13009 --remaining
, ++len
;
13012 va_start (ap
, fmt
);
13013 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13016 if (trace_redisplay_p
)
13017 fprintf (stderr
, "%p (%s): %s\n",
13019 ((BUFFERP (w
->contents
)
13020 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13021 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13026 #endif /* GLYPH_DEBUG */
13029 /* Value is non-zero if all changes in window W, which displays
13030 current_buffer, are in the text between START and END. START is a
13031 buffer position, END is given as a distance from Z. Used in
13032 redisplay_internal for display optimization. */
13035 text_outside_line_unchanged_p (struct window
*w
,
13036 ptrdiff_t start
, ptrdiff_t end
)
13038 int unchanged_p
= 1;
13040 /* If text or overlays have changed, see where. */
13041 if (window_outdated (w
))
13043 /* Gap in the line? */
13044 if (GPT
< start
|| Z
- GPT
< end
)
13047 /* Changes start in front of the line, or end after it? */
13049 && (BEG_UNCHANGED
< start
- 1
13050 || END_UNCHANGED
< end
))
13053 /* If selective display, can't optimize if changes start at the
13054 beginning of the line. */
13056 && INTEGERP (BVAR (current_buffer
, selective_display
))
13057 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13058 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13061 /* If there are overlays at the start or end of the line, these
13062 may have overlay strings with newlines in them. A change at
13063 START, for instance, may actually concern the display of such
13064 overlay strings as well, and they are displayed on different
13065 lines. So, quickly rule out this case. (For the future, it
13066 might be desirable to implement something more telling than
13067 just BEG/END_UNCHANGED.) */
13070 if (BEG
+ BEG_UNCHANGED
== start
13071 && overlay_touches_p (start
))
13073 if (END_UNCHANGED
== end
13074 && overlay_touches_p (Z
- end
))
13078 /* Under bidi reordering, adding or deleting a character in the
13079 beginning of a paragraph, before the first strong directional
13080 character, can change the base direction of the paragraph (unless
13081 the buffer specifies a fixed paragraph direction), which will
13082 require to redisplay the whole paragraph. It might be worthwhile
13083 to find the paragraph limits and widen the range of redisplayed
13084 lines to that, but for now just give up this optimization. */
13085 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13086 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13090 return unchanged_p
;
13094 /* Do a frame update, taking possible shortcuts into account. This is
13095 the main external entry point for redisplay.
13097 If the last redisplay displayed an echo area message and that message
13098 is no longer requested, we clear the echo area or bring back the
13099 mini-buffer if that is in use. */
13104 redisplay_internal ();
13109 overlay_arrow_string_or_property (Lisp_Object var
)
13113 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13116 return Voverlay_arrow_string
;
13119 /* Return 1 if there are any overlay-arrows in current_buffer. */
13121 overlay_arrow_in_current_buffer_p (void)
13125 for (vlist
= Voverlay_arrow_variable_list
;
13127 vlist
= XCDR (vlist
))
13129 Lisp_Object var
= XCAR (vlist
);
13132 if (!SYMBOLP (var
))
13134 val
= find_symbol_value (var
);
13136 && current_buffer
== XMARKER (val
)->buffer
)
13143 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13147 overlay_arrows_changed_p (void)
13151 for (vlist
= Voverlay_arrow_variable_list
;
13153 vlist
= XCDR (vlist
))
13155 Lisp_Object var
= XCAR (vlist
);
13156 Lisp_Object val
, pstr
;
13158 if (!SYMBOLP (var
))
13160 val
= find_symbol_value (var
);
13161 if (!MARKERP (val
))
13163 if (! EQ (COERCE_MARKER (val
),
13164 Fget (var
, Qlast_arrow_position
))
13165 || ! (pstr
= overlay_arrow_string_or_property (var
),
13166 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13172 /* Mark overlay arrows to be updated on next redisplay. */
13175 update_overlay_arrows (int up_to_date
)
13179 for (vlist
= Voverlay_arrow_variable_list
;
13181 vlist
= XCDR (vlist
))
13183 Lisp_Object var
= XCAR (vlist
);
13185 if (!SYMBOLP (var
))
13188 if (up_to_date
> 0)
13190 Lisp_Object val
= find_symbol_value (var
);
13191 Fput (var
, Qlast_arrow_position
,
13192 COERCE_MARKER (val
));
13193 Fput (var
, Qlast_arrow_string
,
13194 overlay_arrow_string_or_property (var
));
13196 else if (up_to_date
< 0
13197 || !NILP (Fget (var
, Qlast_arrow_position
)))
13199 Fput (var
, Qlast_arrow_position
, Qt
);
13200 Fput (var
, Qlast_arrow_string
, Qt
);
13206 /* Return overlay arrow string to display at row.
13207 Return integer (bitmap number) for arrow bitmap in left fringe.
13208 Return nil if no overlay arrow. */
13211 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13215 for (vlist
= Voverlay_arrow_variable_list
;
13217 vlist
= XCDR (vlist
))
13219 Lisp_Object var
= XCAR (vlist
);
13222 if (!SYMBOLP (var
))
13225 val
= find_symbol_value (var
);
13228 && current_buffer
== XMARKER (val
)->buffer
13229 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13231 if (FRAME_WINDOW_P (it
->f
)
13232 /* FIXME: if ROW->reversed_p is set, this should test
13233 the right fringe, not the left one. */
13234 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13236 #ifdef HAVE_WINDOW_SYSTEM
13237 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13240 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13241 return make_number (fringe_bitmap
);
13244 return make_number (-1); /* Use default arrow bitmap. */
13246 return overlay_arrow_string_or_property (var
);
13253 /* Return 1 if point moved out of or into a composition. Otherwise
13254 return 0. PREV_BUF and PREV_PT are the last point buffer and
13255 position. BUF and PT are the current point buffer and position. */
13258 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13259 struct buffer
*buf
, ptrdiff_t pt
)
13261 ptrdiff_t start
, end
;
13263 Lisp_Object buffer
;
13265 XSETBUFFER (buffer
, buf
);
13266 /* Check a composition at the last point if point moved within the
13268 if (prev_buf
== buf
)
13271 /* Point didn't move. */
13274 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13275 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13276 && composition_valid_p (start
, end
, prop
)
13277 && start
< prev_pt
&& end
> prev_pt
)
13278 /* The last point was within the composition. Return 1 iff
13279 point moved out of the composition. */
13280 return (pt
<= start
|| pt
>= end
);
13283 /* Check a composition at the current point. */
13284 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13285 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13286 && composition_valid_p (start
, end
, prop
)
13287 && start
< pt
&& end
> pt
);
13290 /* Reconsider the clip changes of buffer which is displayed in W. */
13293 reconsider_clip_changes (struct window
*w
)
13295 struct buffer
*b
= XBUFFER (w
->contents
);
13297 if (b
->clip_changed
13298 && w
->window_end_valid
13299 && w
->current_matrix
->buffer
== b
13300 && w
->current_matrix
->zv
== BUF_ZV (b
)
13301 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13302 b
->clip_changed
= 0;
13304 /* If display wasn't paused, and W is not a tool bar window, see if
13305 point has been moved into or out of a composition. In that case,
13306 we set b->clip_changed to 1 to force updating the screen. If
13307 b->clip_changed has already been set to 1, we can skip this
13309 if (!b
->clip_changed
&& w
->window_end_valid
)
13311 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13312 ? PT
: marker_position (w
->pointm
));
13314 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13315 && check_point_in_composition (w
->current_matrix
->buffer
,
13316 w
->last_point
, b
, pt
))
13317 b
->clip_changed
= 1;
13322 propagate_buffer_redisplay (void)
13323 { /* Resetting b->text->redisplay is problematic!
13324 We can't just reset it in the case that some window that displays
13325 it has not been redisplayed; and such a window can stay
13326 unredisplayed for a long time if it's currently invisible.
13327 But we do want to reset it at the end of redisplay otherwise
13328 its displayed windows will keep being redisplayed over and over
13330 So we copy all b->text->redisplay flags up to their windows here,
13331 such that mark_window_display_accurate can safely reset
13332 b->text->redisplay. */
13333 Lisp_Object ws
= window_list ();
13334 for (; CONSP (ws
); ws
= XCDR (ws
))
13336 struct window
*thisw
= XWINDOW (XCAR (ws
));
13337 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13338 if (thisb
->text
->redisplay
)
13339 thisw
->redisplay
= true;
13343 #define STOP_POLLING \
13344 do { if (! polling_stopped_here) stop_polling (); \
13345 polling_stopped_here = 1; } while (0)
13347 #define RESUME_POLLING \
13348 do { if (polling_stopped_here) start_polling (); \
13349 polling_stopped_here = 0; } while (0)
13352 /* Perhaps in the future avoid recentering windows if it
13353 is not necessary; currently that causes some problems. */
13356 redisplay_internal (void)
13358 struct window
*w
= XWINDOW (selected_window
);
13362 bool must_finish
= 0, match_p
;
13363 struct text_pos tlbufpos
, tlendpos
;
13364 int number_of_visible_frames
;
13367 int polling_stopped_here
= 0;
13368 Lisp_Object tail
, frame
;
13370 /* True means redisplay has to consider all windows on all
13371 frames. False, only selected_window is considered. */
13372 bool consider_all_windows_p
;
13374 /* True means redisplay has to redisplay the miniwindow. */
13375 bool update_miniwindow_p
= false;
13377 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13379 /* No redisplay if running in batch mode or frame is not yet fully
13380 initialized, or redisplay is explicitly turned off by setting
13381 Vinhibit_redisplay. */
13382 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13383 || !NILP (Vinhibit_redisplay
))
13386 /* Don't examine these until after testing Vinhibit_redisplay.
13387 When Emacs is shutting down, perhaps because its connection to
13388 X has dropped, we should not look at them at all. */
13389 fr
= XFRAME (w
->frame
);
13390 sf
= SELECTED_FRAME ();
13392 if (!fr
->glyphs_initialized_p
)
13395 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13396 if (popup_activated ())
13400 /* I don't think this happens but let's be paranoid. */
13401 if (redisplaying_p
)
13404 /* Record a function that clears redisplaying_p
13405 when we leave this function. */
13406 count
= SPECPDL_INDEX ();
13407 record_unwind_protect_void (unwind_redisplay
);
13408 redisplaying_p
= 1;
13409 specbind (Qinhibit_free_realized_faces
, Qnil
);
13411 /* Record this function, so it appears on the profiler's backtraces. */
13412 record_in_backtrace (Qredisplay_internal
, 0, 0);
13414 FOR_EACH_FRAME (tail
, frame
)
13415 XFRAME (frame
)->already_hscrolled_p
= 0;
13418 /* Remember the currently selected window. */
13422 last_escape_glyph_frame
= NULL
;
13423 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13424 last_glyphless_glyph_frame
= NULL
;
13425 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13427 /* If face_change_count is non-zero, init_iterator will free all
13428 realized faces, which includes the faces referenced from current
13429 matrices. So, we can't reuse current matrices in this case. */
13430 if (face_change_count
)
13431 windows_or_buffers_changed
= 47;
13433 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13434 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13436 /* Since frames on a single ASCII terminal share the same
13437 display area, displaying a different frame means redisplay
13438 the whole thing. */
13439 SET_FRAME_GARBAGED (sf
);
13441 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13443 FRAME_TTY (sf
)->previous_frame
= sf
;
13446 /* Set the visible flags for all frames. Do this before checking for
13447 resized or garbaged frames; they want to know if their frames are
13448 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13449 number_of_visible_frames
= 0;
13451 FOR_EACH_FRAME (tail
, frame
)
13453 struct frame
*f
= XFRAME (frame
);
13455 if (FRAME_VISIBLE_P (f
))
13457 ++number_of_visible_frames
;
13458 /* Adjust matrices for visible frames only. */
13459 if (f
->fonts_changed
)
13461 adjust_frame_glyphs (f
);
13462 f
->fonts_changed
= 0;
13464 /* If cursor type has been changed on the frame
13465 other than selected, consider all frames. */
13466 if (f
!= sf
&& f
->cursor_type_changed
)
13467 update_mode_lines
= 31;
13469 clear_desired_matrices (f
);
13472 /* Notice any pending interrupt request to change frame size. */
13473 do_pending_window_change (true);
13475 /* do_pending_window_change could change the selected_window due to
13476 frame resizing which makes the selected window too small. */
13477 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13480 /* Clear frames marked as garbaged. */
13481 clear_garbaged_frames ();
13483 /* Build menubar and tool-bar items. */
13484 if (NILP (Vmemory_full
))
13485 prepare_menu_bars ();
13487 reconsider_clip_changes (w
);
13489 /* In most cases selected window displays current buffer. */
13490 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13493 /* Detect case that we need to write or remove a star in the mode line. */
13494 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13495 w
->update_mode_line
= 1;
13497 if (mode_line_update_needed (w
))
13498 w
->update_mode_line
= 1;
13500 /* If reconsider_clip_changes above decided that the narrowing
13501 in the current buffer changed, make sure all other windows
13502 showing that buffer will be redisplayed. */
13503 if (current_buffer
->clip_changed
)
13504 bset_update_mode_line (current_buffer
);
13507 /* Normally the message* functions will have already displayed and
13508 updated the echo area, but the frame may have been trashed, or
13509 the update may have been preempted, so display the echo area
13510 again here. Checking message_cleared_p captures the case that
13511 the echo area should be cleared. */
13512 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13513 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13514 || (message_cleared_p
13515 && minibuf_level
== 0
13516 /* If the mini-window is currently selected, this means the
13517 echo-area doesn't show through. */
13518 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13520 int window_height_changed_p
= echo_area_display (false);
13522 if (message_cleared_p
)
13523 update_miniwindow_p
= true;
13527 /* If we don't display the current message, don't clear the
13528 message_cleared_p flag, because, if we did, we wouldn't clear
13529 the echo area in the next redisplay which doesn't preserve
13531 if (!display_last_displayed_message_p
)
13532 message_cleared_p
= 0;
13534 if (window_height_changed_p
)
13536 windows_or_buffers_changed
= 50;
13538 /* If window configuration was changed, frames may have been
13539 marked garbaged. Clear them or we will experience
13540 surprises wrt scrolling. */
13541 clear_garbaged_frames ();
13544 else if (EQ (selected_window
, minibuf_window
)
13545 && (current_buffer
->clip_changed
|| window_outdated (w
))
13546 && resize_mini_window (w
, 0))
13548 /* Resized active mini-window to fit the size of what it is
13549 showing if its contents might have changed. */
13552 /* If window configuration was changed, frames may have been
13553 marked garbaged. Clear them or we will experience
13554 surprises wrt scrolling. */
13555 clear_garbaged_frames ();
13558 if (windows_or_buffers_changed
&& !update_mode_lines
)
13559 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13560 only the windows's contents needs to be refreshed, or whether the
13561 mode-lines also need a refresh. */
13562 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13563 ? REDISPLAY_SOME
: 32);
13565 /* If specs for an arrow have changed, do thorough redisplay
13566 to ensure we remove any arrow that should no longer exist. */
13567 if (overlay_arrows_changed_p ())
13568 /* Apparently, this is the only case where we update other windows,
13569 without updating other mode-lines. */
13570 windows_or_buffers_changed
= 49;
13572 consider_all_windows_p
= (update_mode_lines
13573 || windows_or_buffers_changed
);
13575 #define AINC(a,i) \
13576 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13577 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13579 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13580 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13582 /* Optimize the case that only the line containing the cursor in the
13583 selected window has changed. Variables starting with this_ are
13584 set in display_line and record information about the line
13585 containing the cursor. */
13586 tlbufpos
= this_line_start_pos
;
13587 tlendpos
= this_line_end_pos
;
13588 if (!consider_all_windows_p
13589 && CHARPOS (tlbufpos
) > 0
13590 && !w
->update_mode_line
13591 && !current_buffer
->clip_changed
13592 && !current_buffer
->prevent_redisplay_optimizations_p
13593 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13594 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13595 && !XFRAME (w
->frame
)->cursor_type_changed
13596 /* Make sure recorded data applies to current buffer, etc. */
13597 && this_line_buffer
== current_buffer
13600 && !w
->optional_new_start
13601 /* Point must be on the line that we have info recorded about. */
13602 && PT
>= CHARPOS (tlbufpos
)
13603 && PT
<= Z
- CHARPOS (tlendpos
)
13604 /* All text outside that line, including its final newline,
13605 must be unchanged. */
13606 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13607 CHARPOS (tlendpos
)))
13609 if (CHARPOS (tlbufpos
) > BEGV
13610 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13611 && (CHARPOS (tlbufpos
) == ZV
13612 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13613 /* Former continuation line has disappeared by becoming empty. */
13615 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13617 /* We have to handle the case of continuation around a
13618 wide-column character (see the comment in indent.c around
13621 For instance, in the following case:
13623 -------- Insert --------
13624 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13625 J_I_ ==> J_I_ `^^' are cursors.
13629 As we have to redraw the line above, we cannot use this
13633 int line_height_before
= this_line_pixel_height
;
13635 /* Note that start_display will handle the case that the
13636 line starting at tlbufpos is a continuation line. */
13637 start_display (&it
, w
, tlbufpos
);
13639 /* Implementation note: It this still necessary? */
13640 if (it
.current_x
!= this_line_start_x
)
13643 TRACE ((stderr
, "trying display optimization 1\n"));
13644 w
->cursor
.vpos
= -1;
13645 overlay_arrow_seen
= 0;
13646 it
.vpos
= this_line_vpos
;
13647 it
.current_y
= this_line_y
;
13648 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13649 display_line (&it
);
13651 /* If line contains point, is not continued,
13652 and ends at same distance from eob as before, we win. */
13653 if (w
->cursor
.vpos
>= 0
13654 /* Line is not continued, otherwise this_line_start_pos
13655 would have been set to 0 in display_line. */
13656 && CHARPOS (this_line_start_pos
)
13657 /* Line ends as before. */
13658 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13659 /* Line has same height as before. Otherwise other lines
13660 would have to be shifted up or down. */
13661 && this_line_pixel_height
== line_height_before
)
13663 /* If this is not the window's last line, we must adjust
13664 the charstarts of the lines below. */
13665 if (it
.current_y
< it
.last_visible_y
)
13667 struct glyph_row
*row
13668 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13669 ptrdiff_t delta
, delta_bytes
;
13671 /* We used to distinguish between two cases here,
13672 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13673 when the line ends in a newline or the end of the
13674 buffer's accessible portion. But both cases did
13675 the same, so they were collapsed. */
13677 - CHARPOS (tlendpos
)
13678 - MATRIX_ROW_START_CHARPOS (row
));
13679 delta_bytes
= (Z_BYTE
13680 - BYTEPOS (tlendpos
)
13681 - MATRIX_ROW_START_BYTEPOS (row
));
13683 increment_matrix_positions (w
->current_matrix
,
13684 this_line_vpos
+ 1,
13685 w
->current_matrix
->nrows
,
13686 delta
, delta_bytes
);
13689 /* If this row displays text now but previously didn't,
13690 or vice versa, w->window_end_vpos may have to be
13692 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13694 if (w
->window_end_vpos
< this_line_vpos
)
13695 w
->window_end_vpos
= this_line_vpos
;
13697 else if (w
->window_end_vpos
== this_line_vpos
13698 && this_line_vpos
> 0)
13699 w
->window_end_vpos
= this_line_vpos
- 1;
13700 w
->window_end_valid
= 0;
13702 /* Update hint: No need to try to scroll in update_window. */
13703 w
->desired_matrix
->no_scrolling_p
= 1;
13706 *w
->desired_matrix
->method
= 0;
13707 debug_method_add (w
, "optimization 1");
13709 #ifdef HAVE_WINDOW_SYSTEM
13710 update_window_fringes (w
, 0);
13717 else if (/* Cursor position hasn't changed. */
13718 PT
== w
->last_point
13719 /* Make sure the cursor was last displayed
13720 in this window. Otherwise we have to reposition it. */
13722 /* PXW: Must be converted to pixels, probably. */
13723 && 0 <= w
->cursor
.vpos
13724 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13728 do_pending_window_change (true);
13729 /* If selected_window changed, redisplay again. */
13730 if (WINDOWP (selected_window
)
13731 && (w
= XWINDOW (selected_window
)) != sw
)
13734 /* We used to always goto end_of_redisplay here, but this
13735 isn't enough if we have a blinking cursor. */
13736 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13737 goto end_of_redisplay
;
13741 /* If highlighting the region, or if the cursor is in the echo area,
13742 then we can't just move the cursor. */
13743 else if (NILP (Vshow_trailing_whitespace
)
13744 && !cursor_in_echo_area
)
13747 struct glyph_row
*row
;
13749 /* Skip from tlbufpos to PT and see where it is. Note that
13750 PT may be in invisible text. If so, we will end at the
13751 next visible position. */
13752 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13753 NULL
, DEFAULT_FACE_ID
);
13754 it
.current_x
= this_line_start_x
;
13755 it
.current_y
= this_line_y
;
13756 it
.vpos
= this_line_vpos
;
13758 /* The call to move_it_to stops in front of PT, but
13759 moves over before-strings. */
13760 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13762 if (it
.vpos
== this_line_vpos
13763 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13766 eassert (this_line_vpos
== it
.vpos
);
13767 eassert (this_line_y
== it
.current_y
);
13768 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13770 *w
->desired_matrix
->method
= 0;
13771 debug_method_add (w
, "optimization 3");
13780 /* Text changed drastically or point moved off of line. */
13781 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13784 CHARPOS (this_line_start_pos
) = 0;
13785 ++clear_face_cache_count
;
13786 #ifdef HAVE_WINDOW_SYSTEM
13787 ++clear_image_cache_count
;
13790 /* Build desired matrices, and update the display. If
13791 consider_all_windows_p is non-zero, do it for all windows on all
13792 frames. Otherwise do it for selected_window, only. */
13794 if (consider_all_windows_p
)
13796 FOR_EACH_FRAME (tail
, frame
)
13797 XFRAME (frame
)->updated_p
= 0;
13799 propagate_buffer_redisplay ();
13801 FOR_EACH_FRAME (tail
, frame
)
13803 struct frame
*f
= XFRAME (frame
);
13805 /* We don't have to do anything for unselected terminal
13807 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13808 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13813 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_GTK) && !defined (HAVE_NS)
13814 /* Redisplay internal tool bar if this is the first time so we
13815 can adjust the frame height right now, if necessary. */
13816 if (!f
->tool_bar_redisplayed_once
)
13818 if (redisplay_tool_bar (f
))
13819 adjust_frame_glyphs (f
);
13820 f
->tool_bar_redisplayed_once
= true;
13824 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13827 /* Only GC scrollbars when we redisplay the whole frame. */
13828 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13829 /* Mark all the scroll bars to be removed; we'll redeem
13830 the ones we want when we redisplay their windows. */
13831 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13832 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13834 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13835 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13836 /* Remember that the invisible frames need to be redisplayed next
13837 time they're visible. */
13838 else if (!REDISPLAY_SOME_P ())
13839 f
->redisplay
= true;
13841 /* The X error handler may have deleted that frame. */
13842 if (!FRAME_LIVE_P (f
))
13845 /* Any scroll bars which redisplay_windows should have
13846 nuked should now go away. */
13847 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13848 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13850 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13852 /* If fonts changed on visible frame, display again. */
13853 if (f
->fonts_changed
)
13855 adjust_frame_glyphs (f
);
13856 f
->fonts_changed
= false;
13860 /* See if we have to hscroll. */
13861 if (!f
->already_hscrolled_p
)
13863 f
->already_hscrolled_p
= true;
13864 if (hscroll_windows (f
->root_window
))
13868 /* Prevent various kinds of signals during display
13869 update. stdio is not robust about handling
13870 signals, which can cause an apparent I/O error. */
13871 if (interrupt_input
)
13872 unrequest_sigio ();
13875 pending
|= update_frame (f
, false, false);
13876 f
->cursor_type_changed
= false;
13877 f
->updated_p
= true;
13882 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13886 /* Do the mark_window_display_accurate after all windows have
13887 been redisplayed because this call resets flags in buffers
13888 which are needed for proper redisplay. */
13889 FOR_EACH_FRAME (tail
, frame
)
13891 struct frame
*f
= XFRAME (frame
);
13894 f
->redisplay
= false;
13895 mark_window_display_accurate (f
->root_window
, 1);
13896 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13897 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13902 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13904 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13905 struct frame
*mini_frame
;
13907 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13908 /* Use list_of_error, not Qerror, so that
13909 we catch only errors and don't run the debugger. */
13910 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13912 redisplay_window_error
);
13913 if (update_miniwindow_p
)
13914 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13916 redisplay_window_error
);
13918 /* Compare desired and current matrices, perform output. */
13921 /* If fonts changed, display again. */
13922 if (sf
->fonts_changed
)
13925 /* Prevent various kinds of signals during display update.
13926 stdio is not robust about handling signals,
13927 which can cause an apparent I/O error. */
13928 if (interrupt_input
)
13929 unrequest_sigio ();
13932 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13934 if (hscroll_windows (selected_window
))
13937 XWINDOW (selected_window
)->must_be_updated_p
= true;
13938 pending
= update_frame (sf
, false, false);
13939 sf
->cursor_type_changed
= false;
13942 /* We may have called echo_area_display at the top of this
13943 function. If the echo area is on another frame, that may
13944 have put text on a frame other than the selected one, so the
13945 above call to update_frame would not have caught it. Catch
13947 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13948 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13950 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13952 XWINDOW (mini_window
)->must_be_updated_p
= true;
13953 pending
|= update_frame (mini_frame
, false, false);
13954 mini_frame
->cursor_type_changed
= false;
13955 if (!pending
&& hscroll_windows (mini_window
))
13960 /* If display was paused because of pending input, make sure we do a
13961 thorough update the next time. */
13964 /* Prevent the optimization at the beginning of
13965 redisplay_internal that tries a single-line update of the
13966 line containing the cursor in the selected window. */
13967 CHARPOS (this_line_start_pos
) = 0;
13969 /* Let the overlay arrow be updated the next time. */
13970 update_overlay_arrows (0);
13972 /* If we pause after scrolling, some rows in the current
13973 matrices of some windows are not valid. */
13974 if (!WINDOW_FULL_WIDTH_P (w
)
13975 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13976 update_mode_lines
= 36;
13980 if (!consider_all_windows_p
)
13982 /* This has already been done above if
13983 consider_all_windows_p is set. */
13984 if (XBUFFER (w
->contents
)->text
->redisplay
13985 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13986 /* This can happen if b->text->redisplay was set during
13988 propagate_buffer_redisplay ();
13989 mark_window_display_accurate_1 (w
, 1);
13991 /* Say overlay arrows are up to date. */
13992 update_overlay_arrows (1);
13994 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13995 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13998 update_mode_lines
= 0;
13999 windows_or_buffers_changed
= 0;
14002 /* Start SIGIO interrupts coming again. Having them off during the
14003 code above makes it less likely one will discard output, but not
14004 impossible, since there might be stuff in the system buffer here.
14005 But it is much hairier to try to do anything about that. */
14006 if (interrupt_input
)
14010 /* If a frame has become visible which was not before, redisplay
14011 again, so that we display it. Expose events for such a frame
14012 (which it gets when becoming visible) don't call the parts of
14013 redisplay constructing glyphs, so simply exposing a frame won't
14014 display anything in this case. So, we have to display these
14015 frames here explicitly. */
14020 FOR_EACH_FRAME (tail
, frame
)
14022 if (XFRAME (frame
)->visible
)
14026 if (new_count
!= number_of_visible_frames
)
14027 windows_or_buffers_changed
= 52;
14030 /* Change frame size now if a change is pending. */
14031 do_pending_window_change (true);
14033 /* If we just did a pending size change, or have additional
14034 visible frames, or selected_window changed, redisplay again. */
14035 if ((windows_or_buffers_changed
&& !pending
)
14036 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14039 /* Clear the face and image caches.
14041 We used to do this only if consider_all_windows_p. But the cache
14042 needs to be cleared if a timer creates images in the current
14043 buffer (e.g. the test case in Bug#6230). */
14045 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14047 clear_face_cache (false);
14048 clear_face_cache_count
= 0;
14051 #ifdef HAVE_WINDOW_SYSTEM
14052 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14054 clear_image_caches (Qnil
);
14055 clear_image_cache_count
= 0;
14057 #endif /* HAVE_WINDOW_SYSTEM */
14061 ns_set_doc_edited ();
14063 if (interrupt_input
&& interrupts_deferred
)
14066 unbind_to (count
, Qnil
);
14071 /* Redisplay, but leave alone any recent echo area message unless
14072 another message has been requested in its place.
14074 This is useful in situations where you need to redisplay but no
14075 user action has occurred, making it inappropriate for the message
14076 area to be cleared. See tracking_off and
14077 wait_reading_process_output for examples of these situations.
14079 FROM_WHERE is an integer saying from where this function was
14080 called. This is useful for debugging. */
14083 redisplay_preserve_echo_area (int from_where
)
14085 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14087 if (!NILP (echo_area_buffer
[1]))
14089 /* We have a previously displayed message, but no current
14090 message. Redisplay the previous message. */
14091 display_last_displayed_message_p
= true;
14092 redisplay_internal ();
14093 display_last_displayed_message_p
= false;
14096 redisplay_internal ();
14098 flush_frame (SELECTED_FRAME ());
14102 /* Function registered with record_unwind_protect in redisplay_internal. */
14105 unwind_redisplay (void)
14107 redisplaying_p
= 0;
14111 /* Mark the display of leaf window W as accurate or inaccurate.
14112 If ACCURATE_P is non-zero mark display of W as accurate. If
14113 ACCURATE_P is zero, arrange for W to be redisplayed the next
14114 time redisplay_internal is called. */
14117 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14119 struct buffer
*b
= XBUFFER (w
->contents
);
14121 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14122 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14123 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14127 b
->clip_changed
= false;
14128 b
->prevent_redisplay_optimizations_p
= false;
14129 eassert (buffer_window_count (b
) > 0);
14130 /* Resetting b->text->redisplay is problematic!
14131 In order to make it safer to do it here, redisplay_internal must
14132 have copied all b->text->redisplay to their respective windows. */
14133 b
->text
->redisplay
= false;
14135 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14136 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14137 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14138 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14140 w
->current_matrix
->buffer
= b
;
14141 w
->current_matrix
->begv
= BUF_BEGV (b
);
14142 w
->current_matrix
->zv
= BUF_ZV (b
);
14144 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14145 w
->last_cursor_off_p
= w
->cursor_off_p
;
14147 if (w
== XWINDOW (selected_window
))
14148 w
->last_point
= BUF_PT (b
);
14150 w
->last_point
= marker_position (w
->pointm
);
14152 w
->window_end_valid
= true;
14153 w
->update_mode_line
= false;
14156 w
->redisplay
= !accurate_p
;
14160 /* Mark the display of windows in the window tree rooted at WINDOW as
14161 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14162 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14163 be redisplayed the next time redisplay_internal is called. */
14166 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14170 for (; !NILP (window
); window
= w
->next
)
14172 w
= XWINDOW (window
);
14173 if (WINDOWP (w
->contents
))
14174 mark_window_display_accurate (w
->contents
, accurate_p
);
14176 mark_window_display_accurate_1 (w
, accurate_p
);
14180 update_overlay_arrows (1);
14182 /* Force a thorough redisplay the next time by setting
14183 last_arrow_position and last_arrow_string to t, which is
14184 unequal to any useful value of Voverlay_arrow_... */
14185 update_overlay_arrows (-1);
14189 /* Return value in display table DP (Lisp_Char_Table *) for character
14190 C. Since a display table doesn't have any parent, we don't have to
14191 follow parent. Do not call this function directly but use the
14192 macro DISP_CHAR_VECTOR. */
14195 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14199 if (ASCII_CHAR_P (c
))
14202 if (SUB_CHAR_TABLE_P (val
))
14203 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14209 XSETCHAR_TABLE (table
, dp
);
14210 val
= char_table_ref (table
, c
);
14219 /***********************************************************************
14221 ***********************************************************************/
14223 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14226 redisplay_windows (Lisp_Object window
)
14228 while (!NILP (window
))
14230 struct window
*w
= XWINDOW (window
);
14232 if (WINDOWP (w
->contents
))
14233 redisplay_windows (w
->contents
);
14234 else if (BUFFERP (w
->contents
))
14236 displayed_buffer
= XBUFFER (w
->contents
);
14237 /* Use list_of_error, not Qerror, so that
14238 we catch only errors and don't run the debugger. */
14239 internal_condition_case_1 (redisplay_window_0
, window
,
14241 redisplay_window_error
);
14249 redisplay_window_error (Lisp_Object ignore
)
14251 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14256 redisplay_window_0 (Lisp_Object window
)
14258 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14259 redisplay_window (window
, false);
14264 redisplay_window_1 (Lisp_Object window
)
14266 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14267 redisplay_window (window
, true);
14272 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14273 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14274 which positions recorded in ROW differ from current buffer
14277 Return 0 if cursor is not on this row, 1 otherwise. */
14280 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14281 struct glyph_matrix
*matrix
,
14282 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14285 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14286 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14287 struct glyph
*cursor
= NULL
;
14288 /* The last known character position in row. */
14289 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14291 ptrdiff_t pt_old
= PT
- delta
;
14292 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14293 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14294 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14295 /* A glyph beyond the edge of TEXT_AREA which we should never
14297 struct glyph
*glyphs_end
= end
;
14298 /* Non-zero means we've found a match for cursor position, but that
14299 glyph has the avoid_cursor_p flag set. */
14300 int match_with_avoid_cursor
= 0;
14301 /* Non-zero means we've seen at least one glyph that came from a
14303 int string_seen
= 0;
14304 /* Largest and smallest buffer positions seen so far during scan of
14306 ptrdiff_t bpos_max
= pos_before
;
14307 ptrdiff_t bpos_min
= pos_after
;
14308 /* Last buffer position covered by an overlay string with an integer
14309 `cursor' property. */
14310 ptrdiff_t bpos_covered
= 0;
14311 /* Non-zero means the display string on which to display the cursor
14312 comes from a text property, not from an overlay. */
14313 int string_from_text_prop
= 0;
14315 /* Don't even try doing anything if called for a mode-line or
14316 header-line row, since the rest of the code isn't prepared to
14317 deal with such calamities. */
14318 eassert (!row
->mode_line_p
);
14319 if (row
->mode_line_p
)
14322 /* Skip over glyphs not having an object at the start and the end of
14323 the row. These are special glyphs like truncation marks on
14324 terminal frames. */
14325 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14327 if (!row
->reversed_p
)
14330 && NILP (glyph
->object
)
14331 && glyph
->charpos
< 0)
14333 x
+= glyph
->pixel_width
;
14337 && NILP ((end
- 1)->object
)
14338 /* CHARPOS is zero for blanks and stretch glyphs
14339 inserted by extend_face_to_end_of_line. */
14340 && (end
- 1)->charpos
<= 0)
14342 glyph_before
= glyph
- 1;
14349 /* If the glyph row is reversed, we need to process it from back
14350 to front, so swap the edge pointers. */
14351 glyphs_end
= end
= glyph
- 1;
14352 glyph
+= row
->used
[TEXT_AREA
] - 1;
14354 while (glyph
> end
+ 1
14355 && NILP (glyph
->object
)
14356 && glyph
->charpos
< 0)
14359 x
-= glyph
->pixel_width
;
14361 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14363 /* By default, in reversed rows we put the cursor on the
14364 rightmost (first in the reading order) glyph. */
14365 for (g
= end
+ 1; g
< glyph
; g
++)
14366 x
+= g
->pixel_width
;
14368 && NILP ((end
+ 1)->object
)
14369 && (end
+ 1)->charpos
<= 0)
14371 glyph_before
= glyph
+ 1;
14375 else if (row
->reversed_p
)
14377 /* In R2L rows that don't display text, put the cursor on the
14378 rightmost glyph. Case in point: an empty last line that is
14379 part of an R2L paragraph. */
14381 /* Avoid placing the cursor on the last glyph of the row, where
14382 on terminal frames we hold the vertical border between
14383 adjacent windows. */
14384 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14385 && !WINDOW_RIGHTMOST_P (w
)
14386 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14388 x
= -1; /* will be computed below, at label compute_x */
14391 /* Step 1: Try to find the glyph whose character position
14392 corresponds to point. If that's not possible, find 2 glyphs
14393 whose character positions are the closest to point, one before
14394 point, the other after it. */
14395 if (!row
->reversed_p
)
14396 while (/* not marched to end of glyph row */
14398 /* glyph was not inserted by redisplay for internal purposes */
14399 && !NILP (glyph
->object
))
14401 if (BUFFERP (glyph
->object
))
14403 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14405 if (glyph
->charpos
> bpos_max
)
14406 bpos_max
= glyph
->charpos
;
14407 if (glyph
->charpos
< bpos_min
)
14408 bpos_min
= glyph
->charpos
;
14409 if (!glyph
->avoid_cursor_p
)
14411 /* If we hit point, we've found the glyph on which to
14412 display the cursor. */
14415 match_with_avoid_cursor
= 0;
14418 /* See if we've found a better approximation to
14419 POS_BEFORE or to POS_AFTER. */
14420 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14422 pos_before
= glyph
->charpos
;
14423 glyph_before
= glyph
;
14425 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14427 pos_after
= glyph
->charpos
;
14428 glyph_after
= glyph
;
14431 else if (dpos
== 0)
14432 match_with_avoid_cursor
= 1;
14434 else if (STRINGP (glyph
->object
))
14436 Lisp_Object chprop
;
14437 ptrdiff_t glyph_pos
= glyph
->charpos
;
14439 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14441 if (!NILP (chprop
))
14443 /* If the string came from a `display' text property,
14444 look up the buffer position of that property and
14445 use that position to update bpos_max, as if we
14446 actually saw such a position in one of the row's
14447 glyphs. This helps with supporting integer values
14448 of `cursor' property on the display string in
14449 situations where most or all of the row's buffer
14450 text is completely covered by display properties,
14451 so that no glyph with valid buffer positions is
14452 ever seen in the row. */
14453 ptrdiff_t prop_pos
=
14454 string_buffer_position_lim (glyph
->object
, pos_before
,
14457 if (prop_pos
>= pos_before
)
14458 bpos_max
= prop_pos
;
14460 if (INTEGERP (chprop
))
14462 bpos_covered
= bpos_max
+ XINT (chprop
);
14463 /* If the `cursor' property covers buffer positions up
14464 to and including point, we should display cursor on
14465 this glyph. Note that, if a `cursor' property on one
14466 of the string's characters has an integer value, we
14467 will break out of the loop below _before_ we get to
14468 the position match above. IOW, integer values of
14469 the `cursor' property override the "exact match for
14470 point" strategy of positioning the cursor. */
14471 /* Implementation note: bpos_max == pt_old when, e.g.,
14472 we are in an empty line, where bpos_max is set to
14473 MATRIX_ROW_START_CHARPOS, see above. */
14474 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14483 x
+= glyph
->pixel_width
;
14486 else if (glyph
> end
) /* row is reversed */
14487 while (!NILP (glyph
->object
))
14489 if (BUFFERP (glyph
->object
))
14491 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14493 if (glyph
->charpos
> bpos_max
)
14494 bpos_max
= glyph
->charpos
;
14495 if (glyph
->charpos
< bpos_min
)
14496 bpos_min
= glyph
->charpos
;
14497 if (!glyph
->avoid_cursor_p
)
14501 match_with_avoid_cursor
= 0;
14504 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14506 pos_before
= glyph
->charpos
;
14507 glyph_before
= glyph
;
14509 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14511 pos_after
= glyph
->charpos
;
14512 glyph_after
= glyph
;
14515 else if (dpos
== 0)
14516 match_with_avoid_cursor
= 1;
14518 else if (STRINGP (glyph
->object
))
14520 Lisp_Object chprop
;
14521 ptrdiff_t glyph_pos
= glyph
->charpos
;
14523 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14525 if (!NILP (chprop
))
14527 ptrdiff_t prop_pos
=
14528 string_buffer_position_lim (glyph
->object
, pos_before
,
14531 if (prop_pos
>= pos_before
)
14532 bpos_max
= prop_pos
;
14534 if (INTEGERP (chprop
))
14536 bpos_covered
= bpos_max
+ XINT (chprop
);
14537 /* If the `cursor' property covers buffer positions up
14538 to and including point, we should display cursor on
14540 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14549 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14551 x
--; /* can't use any pixel_width */
14554 x
-= glyph
->pixel_width
;
14557 /* Step 2: If we didn't find an exact match for point, we need to
14558 look for a proper place to put the cursor among glyphs between
14559 GLYPH_BEFORE and GLYPH_AFTER. */
14560 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14561 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14562 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14564 /* An empty line has a single glyph whose OBJECT is nil and
14565 whose CHARPOS is the position of a newline on that line.
14566 Note that on a TTY, there are more glyphs after that, which
14567 were produced by extend_face_to_end_of_line, but their
14568 CHARPOS is zero or negative. */
14570 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14571 && NILP (glyph
->object
) && glyph
->charpos
> 0
14572 /* On a TTY, continued and truncated rows also have a glyph at
14573 their end whose OBJECT is nil and whose CHARPOS is
14574 positive (the continuation and truncation glyphs), but such
14575 rows are obviously not "empty". */
14576 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14578 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14580 ptrdiff_t ellipsis_pos
;
14582 /* Scan back over the ellipsis glyphs. */
14583 if (!row
->reversed_p
)
14585 ellipsis_pos
= (glyph
- 1)->charpos
;
14586 while (glyph
> row
->glyphs
[TEXT_AREA
]
14587 && (glyph
- 1)->charpos
== ellipsis_pos
)
14588 glyph
--, x
-= glyph
->pixel_width
;
14589 /* That loop always goes one position too far, including
14590 the glyph before the ellipsis. So scan forward over
14592 x
+= glyph
->pixel_width
;
14595 else /* row is reversed */
14597 ellipsis_pos
= (glyph
+ 1)->charpos
;
14598 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14599 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14600 glyph
++, x
+= glyph
->pixel_width
;
14601 x
-= glyph
->pixel_width
;
14605 else if (match_with_avoid_cursor
)
14607 cursor
= glyph_after
;
14610 else if (string_seen
)
14612 int incr
= row
->reversed_p
? -1 : +1;
14614 /* Need to find the glyph that came out of a string which is
14615 present at point. That glyph is somewhere between
14616 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14617 positioned between POS_BEFORE and POS_AFTER in the
14619 struct glyph
*start
, *stop
;
14620 ptrdiff_t pos
= pos_before
;
14624 /* If the row ends in a newline from a display string,
14625 reordering could have moved the glyphs belonging to the
14626 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14627 in this case we extend the search to the last glyph in
14628 the row that was not inserted by redisplay. */
14629 if (row
->ends_in_newline_from_string_p
)
14632 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14635 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14636 correspond to POS_BEFORE and POS_AFTER, respectively. We
14637 need START and STOP in the order that corresponds to the
14638 row's direction as given by its reversed_p flag. If the
14639 directionality of characters between POS_BEFORE and
14640 POS_AFTER is the opposite of the row's base direction,
14641 these characters will have been reordered for display,
14642 and we need to reverse START and STOP. */
14643 if (!row
->reversed_p
)
14645 start
= min (glyph_before
, glyph_after
);
14646 stop
= max (glyph_before
, glyph_after
);
14650 start
= max (glyph_before
, glyph_after
);
14651 stop
= min (glyph_before
, glyph_after
);
14653 for (glyph
= start
+ incr
;
14654 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14657 /* Any glyphs that come from the buffer are here because
14658 of bidi reordering. Skip them, and only pay
14659 attention to glyphs that came from some string. */
14660 if (STRINGP (glyph
->object
))
14664 /* If the display property covers the newline, we
14665 need to search for it one position farther. */
14666 ptrdiff_t lim
= pos_after
14667 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14669 string_from_text_prop
= 0;
14670 str
= glyph
->object
;
14671 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14672 if (tem
== 0 /* from overlay */
14675 /* If the string from which this glyph came is
14676 found in the buffer at point, or at position
14677 that is closer to point than pos_after, then
14678 we've found the glyph we've been looking for.
14679 If it comes from an overlay (tem == 0), and
14680 it has the `cursor' property on one of its
14681 glyphs, record that glyph as a candidate for
14682 displaying the cursor. (As in the
14683 unidirectional version, we will display the
14684 cursor on the last candidate we find.) */
14687 || (tem
- pt_old
> 0 && tem
< pos_after
))
14689 /* The glyphs from this string could have
14690 been reordered. Find the one with the
14691 smallest string position. Or there could
14692 be a character in the string with the
14693 `cursor' property, which means display
14694 cursor on that character's glyph. */
14695 ptrdiff_t strpos
= glyph
->charpos
;
14700 string_from_text_prop
= 1;
14703 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14704 && EQ (glyph
->object
, str
);
14708 ptrdiff_t gpos
= glyph
->charpos
;
14710 cprop
= Fget_char_property (make_number (gpos
),
14718 if (tem
&& glyph
->charpos
< strpos
)
14720 strpos
= glyph
->charpos
;
14726 || (tem
- pt_old
> 0 && tem
< pos_after
))
14730 pos
= tem
+ 1; /* don't find previous instances */
14732 /* This string is not what we want; skip all of the
14733 glyphs that came from it. */
14734 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14735 && EQ (glyph
->object
, str
))
14742 /* If we reached the end of the line, and END was from a string,
14743 the cursor is not on this line. */
14745 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14746 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14747 && STRINGP (end
->object
)
14748 && row
->continued_p
)
14751 /* A truncated row may not include PT among its character positions.
14752 Setting the cursor inside the scroll margin will trigger
14753 recalculation of hscroll in hscroll_window_tree. But if a
14754 display string covers point, defer to the string-handling
14755 code below to figure this out. */
14756 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14758 cursor
= glyph_before
;
14761 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14762 /* Zero-width characters produce no glyphs. */
14764 && (row
->reversed_p
14765 ? glyph_after
> glyphs_end
14766 : glyph_after
< glyphs_end
)))
14768 cursor
= glyph_after
;
14774 if (cursor
!= NULL
)
14776 else if (glyph
== glyphs_end
14777 && pos_before
== pos_after
14778 && STRINGP ((row
->reversed_p
14779 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14780 : row
->glyphs
[TEXT_AREA
])->object
))
14782 /* If all the glyphs of this row came from strings, put the
14783 cursor on the first glyph of the row. This avoids having the
14784 cursor outside of the text area in this very rare and hard
14788 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14789 : row
->glyphs
[TEXT_AREA
];
14795 /* Need to compute x that corresponds to GLYPH. */
14796 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14798 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14800 x
+= g
->pixel_width
;
14804 /* ROW could be part of a continued line, which, under bidi
14805 reordering, might have other rows whose start and end charpos
14806 occlude point. Only set w->cursor if we found a better
14807 approximation to the cursor position than we have from previously
14808 examined candidate rows belonging to the same continued line. */
14809 if (/* We already have a candidate row. */
14810 w
->cursor
.vpos
>= 0
14811 /* That candidate is not the row we are processing. */
14812 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14813 /* Make sure cursor.vpos specifies a row whose start and end
14814 charpos occlude point, and it is valid candidate for being a
14815 cursor-row. This is because some callers of this function
14816 leave cursor.vpos at the row where the cursor was displayed
14817 during the last redisplay cycle. */
14818 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14819 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14820 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14823 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14825 /* Don't consider glyphs that are outside TEXT_AREA. */
14826 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14828 /* Keep the candidate whose buffer position is the closest to
14829 point or has the `cursor' property. */
14830 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14831 w
->cursor
.hpos
>= 0
14832 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14833 && ((BUFFERP (g1
->object
)
14834 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14835 || (BUFFERP (glyph
->object
)
14836 && eabs (g1
->charpos
- pt_old
)
14837 < eabs (glyph
->charpos
- pt_old
))))
14838 /* Previous candidate is a glyph from a string that has
14839 a non-nil `cursor' property. */
14840 || (STRINGP (g1
->object
)
14841 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14842 Qcursor
, g1
->object
))
14843 /* Previous candidate is from the same display
14844 string as this one, and the display string
14845 came from a text property. */
14846 || (EQ (g1
->object
, glyph
->object
)
14847 && string_from_text_prop
)
14848 /* this candidate is from newline and its
14849 position is not an exact match */
14850 || (NILP (glyph
->object
)
14851 && glyph
->charpos
!= pt_old
)))))
14853 /* If this candidate gives an exact match, use that. */
14854 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14855 /* If this candidate is a glyph created for the
14856 terminating newline of a line, and point is on that
14857 newline, it wins because it's an exact match. */
14858 || (!row
->continued_p
14859 && NILP (glyph
->object
)
14860 && glyph
->charpos
== 0
14861 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14862 /* Otherwise, keep the candidate that comes from a row
14863 spanning less buffer positions. This may win when one or
14864 both candidate positions are on glyphs that came from
14865 display strings, for which we cannot compare buffer
14867 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14868 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14869 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14872 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14874 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14875 w
->cursor
.y
= row
->y
+ dy
;
14877 if (w
== XWINDOW (selected_window
))
14879 if (!row
->continued_p
14880 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14883 this_line_buffer
= XBUFFER (w
->contents
);
14885 CHARPOS (this_line_start_pos
)
14886 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14887 BYTEPOS (this_line_start_pos
)
14888 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14890 CHARPOS (this_line_end_pos
)
14891 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14892 BYTEPOS (this_line_end_pos
)
14893 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14895 this_line_y
= w
->cursor
.y
;
14896 this_line_pixel_height
= row
->height
;
14897 this_line_vpos
= w
->cursor
.vpos
;
14898 this_line_start_x
= row
->x
;
14901 CHARPOS (this_line_start_pos
) = 0;
14908 /* Run window scroll functions, if any, for WINDOW with new window
14909 start STARTP. Sets the window start of WINDOW to that position.
14911 We assume that the window's buffer is really current. */
14913 static struct text_pos
14914 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14916 struct window
*w
= XWINDOW (window
);
14917 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14919 eassert (current_buffer
== XBUFFER (w
->contents
));
14921 if (!NILP (Vwindow_scroll_functions
))
14923 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14924 make_number (CHARPOS (startp
)));
14925 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14926 /* In case the hook functions switch buffers. */
14927 set_buffer_internal (XBUFFER (w
->contents
));
14934 /* Make sure the line containing the cursor is fully visible.
14935 A value of 1 means there is nothing to be done.
14936 (Either the line is fully visible, or it cannot be made so,
14937 or we cannot tell.)
14939 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14940 is higher than window.
14942 If CURRENT_MATRIX_P is non-zero, use the information from the
14943 window's current glyph matrix; otherwise use the desired glyph
14946 A value of 0 means the caller should do scrolling
14947 as if point had gone off the screen. */
14950 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14952 struct glyph_matrix
*matrix
;
14953 struct glyph_row
*row
;
14956 if (!make_cursor_line_fully_visible_p
)
14959 /* It's not always possible to find the cursor, e.g, when a window
14960 is full of overlay strings. Don't do anything in that case. */
14961 if (w
->cursor
.vpos
< 0)
14964 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14965 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14967 /* If the cursor row is not partially visible, there's nothing to do. */
14968 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14971 /* If the row the cursor is in is taller than the window's height,
14972 it's not clear what to do, so do nothing. */
14973 window_height
= window_box_height (w
);
14974 if (row
->height
>= window_height
)
14976 if (!force_p
|| MINI_WINDOW_P (w
)
14977 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14984 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14985 non-zero means only WINDOW is redisplayed in redisplay_internal.
14986 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14987 in redisplay_window to bring a partially visible line into view in
14988 the case that only the cursor has moved.
14990 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14991 last screen line's vertical height extends past the end of the screen.
14995 1 if scrolling succeeded
14997 0 if scrolling didn't find point.
14999 -1 if new fonts have been loaded so that we must interrupt
15000 redisplay, adjust glyph matrices, and try again. */
15006 SCROLLING_NEED_LARGER_MATRICES
15009 /* If scroll-conservatively is more than this, never recenter.
15011 If you change this, don't forget to update the doc string of
15012 `scroll-conservatively' and the Emacs manual. */
15013 #define SCROLL_LIMIT 100
15016 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15017 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15018 int temp_scroll_step
, int last_line_misfit
)
15020 struct window
*w
= XWINDOW (window
);
15021 struct frame
*f
= XFRAME (w
->frame
);
15022 struct text_pos pos
, startp
;
15024 int this_scroll_margin
, scroll_max
, rc
, height
;
15025 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15026 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15027 Lisp_Object aggressive
;
15028 /* We will never try scrolling more than this number of lines. */
15029 int scroll_limit
= SCROLL_LIMIT
;
15030 int frame_line_height
= default_line_pixel_height (w
);
15031 int window_total_lines
15032 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15035 debug_method_add (w
, "try_scrolling");
15038 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15040 /* Compute scroll margin height in pixels. We scroll when point is
15041 within this distance from the top or bottom of the window. */
15042 if (scroll_margin
> 0)
15043 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15044 * frame_line_height
;
15046 this_scroll_margin
= 0;
15048 /* Force arg_scroll_conservatively to have a reasonable value, to
15049 avoid scrolling too far away with slow move_it_* functions. Note
15050 that the user can supply scroll-conservatively equal to
15051 `most-positive-fixnum', which can be larger than INT_MAX. */
15052 if (arg_scroll_conservatively
> scroll_limit
)
15054 arg_scroll_conservatively
= scroll_limit
+ 1;
15055 scroll_max
= scroll_limit
* frame_line_height
;
15057 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15058 /* Compute how much we should try to scroll maximally to bring
15059 point into view. */
15060 scroll_max
= (max (scroll_step
,
15061 max (arg_scroll_conservatively
, temp_scroll_step
))
15062 * frame_line_height
);
15063 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15064 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15065 /* We're trying to scroll because of aggressive scrolling but no
15066 scroll_step is set. Choose an arbitrary one. */
15067 scroll_max
= 10 * frame_line_height
;
15073 /* Decide whether to scroll down. */
15074 if (PT
> CHARPOS (startp
))
15076 int scroll_margin_y
;
15078 /* Compute the pixel ypos of the scroll margin, then move IT to
15079 either that ypos or PT, whichever comes first. */
15080 start_display (&it
, w
, startp
);
15081 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15082 - frame_line_height
* extra_scroll_margin_lines
;
15083 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15084 (MOVE_TO_POS
| MOVE_TO_Y
));
15086 if (PT
> CHARPOS (it
.current
.pos
))
15088 int y0
= line_bottom_y (&it
);
15089 /* Compute how many pixels below window bottom to stop searching
15090 for PT. This avoids costly search for PT that is far away if
15091 the user limited scrolling by a small number of lines, but
15092 always finds PT if scroll_conservatively is set to a large
15093 number, such as most-positive-fixnum. */
15094 int slack
= max (scroll_max
, 10 * frame_line_height
);
15095 int y_to_move
= it
.last_visible_y
+ slack
;
15097 /* Compute the distance from the scroll margin to PT or to
15098 the scroll limit, whichever comes first. This should
15099 include the height of the cursor line, to make that line
15101 move_it_to (&it
, PT
, -1, y_to_move
,
15102 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15103 dy
= line_bottom_y (&it
) - y0
;
15105 if (dy
> scroll_max
)
15106 return SCROLLING_FAILED
;
15115 /* Point is in or below the bottom scroll margin, so move the
15116 window start down. If scrolling conservatively, move it just
15117 enough down to make point visible. If scroll_step is set,
15118 move it down by scroll_step. */
15119 if (arg_scroll_conservatively
)
15121 = min (max (dy
, frame_line_height
),
15122 frame_line_height
* arg_scroll_conservatively
);
15123 else if (scroll_step
|| temp_scroll_step
)
15124 amount_to_scroll
= scroll_max
;
15127 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15128 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15129 if (NUMBERP (aggressive
))
15131 double float_amount
= XFLOATINT (aggressive
) * height
;
15132 int aggressive_scroll
= float_amount
;
15133 if (aggressive_scroll
== 0 && float_amount
> 0)
15134 aggressive_scroll
= 1;
15135 /* Don't let point enter the scroll margin near top of
15136 the window. This could happen if the value of
15137 scroll_up_aggressively is too large and there are
15138 non-zero margins, because scroll_up_aggressively
15139 means put point that fraction of window height
15140 _from_the_bottom_margin_. */
15141 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15142 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15143 amount_to_scroll
= dy
+ aggressive_scroll
;
15147 if (amount_to_scroll
<= 0)
15148 return SCROLLING_FAILED
;
15150 start_display (&it
, w
, startp
);
15151 if (arg_scroll_conservatively
<= scroll_limit
)
15152 move_it_vertically (&it
, amount_to_scroll
);
15155 /* Extra precision for users who set scroll-conservatively
15156 to a large number: make sure the amount we scroll
15157 the window start is never less than amount_to_scroll,
15158 which was computed as distance from window bottom to
15159 point. This matters when lines at window top and lines
15160 below window bottom have different height. */
15162 void *it1data
= NULL
;
15163 /* We use a temporary it1 because line_bottom_y can modify
15164 its argument, if it moves one line down; see there. */
15167 SAVE_IT (it1
, it
, it1data
);
15168 start_y
= line_bottom_y (&it1
);
15170 RESTORE_IT (&it
, &it
, it1data
);
15171 move_it_by_lines (&it
, 1);
15172 SAVE_IT (it1
, it
, it1data
);
15173 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15176 /* If STARTP is unchanged, move it down another screen line. */
15177 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15178 move_it_by_lines (&it
, 1);
15179 startp
= it
.current
.pos
;
15183 struct text_pos scroll_margin_pos
= startp
;
15186 /* See if point is inside the scroll margin at the top of the
15188 if (this_scroll_margin
)
15192 start_display (&it
, w
, startp
);
15193 y_start
= it
.current_y
;
15194 move_it_vertically (&it
, this_scroll_margin
);
15195 scroll_margin_pos
= it
.current
.pos
;
15196 /* If we didn't move enough before hitting ZV, request
15197 additional amount of scroll, to move point out of the
15199 if (IT_CHARPOS (it
) == ZV
15200 && it
.current_y
- y_start
< this_scroll_margin
)
15201 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15204 if (PT
< CHARPOS (scroll_margin_pos
))
15206 /* Point is in the scroll margin at the top of the window or
15207 above what is displayed in the window. */
15210 /* Compute the vertical distance from PT to the scroll
15211 margin position. Move as far as scroll_max allows, or
15212 one screenful, or 10 screen lines, whichever is largest.
15213 Give up if distance is greater than scroll_max or if we
15214 didn't reach the scroll margin position. */
15215 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15216 start_display (&it
, w
, pos
);
15218 y_to_move
= max (it
.last_visible_y
,
15219 max (scroll_max
, 10 * frame_line_height
));
15220 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15222 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15223 dy
= it
.current_y
- y0
;
15224 if (dy
> scroll_max
15225 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15226 return SCROLLING_FAILED
;
15228 /* Additional scroll for when ZV was too close to point. */
15231 /* Compute new window start. */
15232 start_display (&it
, w
, startp
);
15234 if (arg_scroll_conservatively
)
15235 amount_to_scroll
= max (dy
, frame_line_height
15236 * max (scroll_step
, temp_scroll_step
));
15237 else if (scroll_step
|| temp_scroll_step
)
15238 amount_to_scroll
= scroll_max
;
15241 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15242 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15243 if (NUMBERP (aggressive
))
15245 double float_amount
= XFLOATINT (aggressive
) * height
;
15246 int aggressive_scroll
= float_amount
;
15247 if (aggressive_scroll
== 0 && float_amount
> 0)
15248 aggressive_scroll
= 1;
15249 /* Don't let point enter the scroll margin near
15250 bottom of the window, if the value of
15251 scroll_down_aggressively happens to be too
15253 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15254 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15255 amount_to_scroll
= dy
+ aggressive_scroll
;
15259 if (amount_to_scroll
<= 0)
15260 return SCROLLING_FAILED
;
15262 move_it_vertically_backward (&it
, amount_to_scroll
);
15263 startp
= it
.current
.pos
;
15267 /* Run window scroll functions. */
15268 startp
= run_window_scroll_functions (window
, startp
);
15270 /* Display the window. Give up if new fonts are loaded, or if point
15272 if (!try_window (window
, startp
, 0))
15273 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15274 else if (w
->cursor
.vpos
< 0)
15276 clear_glyph_matrix (w
->desired_matrix
);
15277 rc
= SCROLLING_FAILED
;
15281 /* Maybe forget recorded base line for line number display. */
15282 if (!just_this_one_p
15283 || current_buffer
->clip_changed
15284 || BEG_UNCHANGED
< CHARPOS (startp
))
15285 w
->base_line_number
= 0;
15287 /* If cursor ends up on a partially visible line,
15288 treat that as being off the bottom of the screen. */
15289 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15290 /* It's possible that the cursor is on the first line of the
15291 buffer, which is partially obscured due to a vscroll
15292 (Bug#7537). In that case, avoid looping forever. */
15293 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15295 clear_glyph_matrix (w
->desired_matrix
);
15296 ++extra_scroll_margin_lines
;
15299 rc
= SCROLLING_SUCCESS
;
15306 /* Compute a suitable window start for window W if display of W starts
15307 on a continuation line. Value is non-zero if a new window start
15310 The new window start will be computed, based on W's width, starting
15311 from the start of the continued line. It is the start of the
15312 screen line with the minimum distance from the old start W->start. */
15315 compute_window_start_on_continuation_line (struct window
*w
)
15317 struct text_pos pos
, start_pos
;
15318 int window_start_changed_p
= 0;
15320 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15322 /* If window start is on a continuation line... Window start may be
15323 < BEGV in case there's invisible text at the start of the
15324 buffer (M-x rmail, for example). */
15325 if (CHARPOS (start_pos
) > BEGV
15326 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15329 struct glyph_row
*row
;
15331 /* Handle the case that the window start is out of range. */
15332 if (CHARPOS (start_pos
) < BEGV
)
15333 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15334 else if (CHARPOS (start_pos
) > ZV
)
15335 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15337 /* Find the start of the continued line. This should be fast
15338 because find_newline is fast (newline cache). */
15339 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15340 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15341 row
, DEFAULT_FACE_ID
);
15342 reseat_at_previous_visible_line_start (&it
);
15344 /* If the line start is "too far" away from the window start,
15345 say it takes too much time to compute a new window start. */
15346 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15347 /* PXW: Do we need upper bounds here? */
15348 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15350 int min_distance
, distance
;
15352 /* Move forward by display lines to find the new window
15353 start. If window width was enlarged, the new start can
15354 be expected to be > the old start. If window width was
15355 decreased, the new window start will be < the old start.
15356 So, we're looking for the display line start with the
15357 minimum distance from the old window start. */
15358 pos
= it
.current
.pos
;
15359 min_distance
= INFINITY
;
15360 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15361 distance
< min_distance
)
15363 min_distance
= distance
;
15364 pos
= it
.current
.pos
;
15365 if (it
.line_wrap
== WORD_WRAP
)
15367 /* Under WORD_WRAP, move_it_by_lines is likely to
15368 overshoot and stop not at the first, but the
15369 second character from the left margin. So in
15370 that case, we need a more tight control on the X
15371 coordinate of the iterator than move_it_by_lines
15372 promises in its contract. The method is to first
15373 go to the last (rightmost) visible character of a
15374 line, then move to the leftmost character on the
15375 next line in a separate call. */
15376 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15377 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15378 move_it_to (&it
, ZV
, 0,
15379 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15380 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15383 move_it_by_lines (&it
, 1);
15386 /* Set the window start there. */
15387 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15388 window_start_changed_p
= 1;
15392 return window_start_changed_p
;
15396 /* Try cursor movement in case text has not changed in window WINDOW,
15397 with window start STARTP. Value is
15399 CURSOR_MOVEMENT_SUCCESS if successful
15401 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15403 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15404 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15405 we want to scroll as if scroll-step were set to 1. See the code.
15407 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15408 which case we have to abort this redisplay, and adjust matrices
15413 CURSOR_MOVEMENT_SUCCESS
,
15414 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15415 CURSOR_MOVEMENT_MUST_SCROLL
,
15416 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15420 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15422 struct window
*w
= XWINDOW (window
);
15423 struct frame
*f
= XFRAME (w
->frame
);
15424 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15427 if (inhibit_try_cursor_movement
)
15431 /* Previously, there was a check for Lisp integer in the
15432 if-statement below. Now, this field is converted to
15433 ptrdiff_t, thus zero means invalid position in a buffer. */
15434 eassert (w
->last_point
> 0);
15435 /* Likewise there was a check whether window_end_vpos is nil or larger
15436 than the window. Now window_end_vpos is int and so never nil, but
15437 let's leave eassert to check whether it fits in the window. */
15438 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15440 /* Handle case where text has not changed, only point, and it has
15441 not moved off the frame. */
15442 if (/* Point may be in this window. */
15443 PT
>= CHARPOS (startp
)
15444 /* Selective display hasn't changed. */
15445 && !current_buffer
->clip_changed
15446 /* Function force-mode-line-update is used to force a thorough
15447 redisplay. It sets either windows_or_buffers_changed or
15448 update_mode_lines. So don't take a shortcut here for these
15450 && !update_mode_lines
15451 && !windows_or_buffers_changed
15452 && !f
->cursor_type_changed
15453 && NILP (Vshow_trailing_whitespace
)
15454 /* This code is not used for mini-buffer for the sake of the case
15455 of redisplaying to replace an echo area message; since in
15456 that case the mini-buffer contents per se are usually
15457 unchanged. This code is of no real use in the mini-buffer
15458 since the handling of this_line_start_pos, etc., in redisplay
15459 handles the same cases. */
15460 && !EQ (window
, minibuf_window
)
15461 && (FRAME_WINDOW_P (f
)
15462 || !overlay_arrow_in_current_buffer_p ()))
15464 int this_scroll_margin
, top_scroll_margin
;
15465 struct glyph_row
*row
= NULL
;
15466 int frame_line_height
= default_line_pixel_height (w
);
15467 int window_total_lines
15468 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15471 debug_method_add (w
, "cursor movement");
15474 /* Scroll if point within this distance from the top or bottom
15475 of the window. This is a pixel value. */
15476 if (scroll_margin
> 0)
15478 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15479 this_scroll_margin
*= frame_line_height
;
15482 this_scroll_margin
= 0;
15484 top_scroll_margin
= this_scroll_margin
;
15485 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15486 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15488 /* Start with the row the cursor was displayed during the last
15489 not paused redisplay. Give up if that row is not valid. */
15490 if (w
->last_cursor_vpos
< 0
15491 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15492 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15495 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15496 if (row
->mode_line_p
)
15498 if (!row
->enabled_p
)
15499 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15502 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15504 int scroll_p
= 0, must_scroll
= 0;
15505 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15507 if (PT
> w
->last_point
)
15509 /* Point has moved forward. */
15510 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15511 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15513 eassert (row
->enabled_p
);
15517 /* If the end position of a row equals the start
15518 position of the next row, and PT is at that position,
15519 we would rather display cursor in the next line. */
15520 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15521 && MATRIX_ROW_END_CHARPOS (row
) == PT
15522 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15523 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15524 && !cursor_row_p (row
))
15527 /* If within the scroll margin, scroll. Note that
15528 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15529 the next line would be drawn, and that
15530 this_scroll_margin can be zero. */
15531 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15532 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15533 /* Line is completely visible last line in window
15534 and PT is to be set in the next line. */
15535 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15536 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15537 && !row
->ends_at_zv_p
15538 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15541 else if (PT
< w
->last_point
)
15543 /* Cursor has to be moved backward. Note that PT >=
15544 CHARPOS (startp) because of the outer if-statement. */
15545 while (!row
->mode_line_p
15546 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15547 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15548 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15549 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15550 row
> w
->current_matrix
->rows
15551 && (row
-1)->ends_in_newline_from_string_p
))))
15552 && (row
->y
> top_scroll_margin
15553 || CHARPOS (startp
) == BEGV
))
15555 eassert (row
->enabled_p
);
15559 /* Consider the following case: Window starts at BEGV,
15560 there is invisible, intangible text at BEGV, so that
15561 display starts at some point START > BEGV. It can
15562 happen that we are called with PT somewhere between
15563 BEGV and START. Try to handle that case. */
15564 if (row
< w
->current_matrix
->rows
15565 || row
->mode_line_p
)
15567 row
= w
->current_matrix
->rows
;
15568 if (row
->mode_line_p
)
15572 /* Due to newlines in overlay strings, we may have to
15573 skip forward over overlay strings. */
15574 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15575 && MATRIX_ROW_END_CHARPOS (row
) == PT
15576 && !cursor_row_p (row
))
15579 /* If within the scroll margin, scroll. */
15580 if (row
->y
< top_scroll_margin
15581 && CHARPOS (startp
) != BEGV
)
15586 /* Cursor did not move. So don't scroll even if cursor line
15587 is partially visible, as it was so before. */
15588 rc
= CURSOR_MOVEMENT_SUCCESS
;
15591 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15592 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15594 /* if PT is not in the glyph row, give up. */
15595 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15598 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15599 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15601 struct glyph_row
*row1
;
15603 /* If rows are bidi-reordered and point moved, back up
15604 until we find a row that does not belong to a
15605 continuation line. This is because we must consider
15606 all rows of a continued line as candidates for the
15607 new cursor positioning, since row start and end
15608 positions change non-linearly with vertical position
15610 /* FIXME: Revisit this when glyph ``spilling'' in
15611 continuation lines' rows is implemented for
15612 bidi-reordered rows. */
15613 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15614 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15617 /* If we hit the beginning of the displayed portion
15618 without finding the first row of a continued
15622 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15625 eassert (row
->enabled_p
);
15630 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15631 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15632 /* Make sure this isn't a header line by any chance, since
15633 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15634 && !row
->mode_line_p
15635 && make_cursor_line_fully_visible_p
)
15637 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15638 && !row
->ends_at_zv_p
15639 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15640 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15641 else if (row
->height
> window_box_height (w
))
15643 /* If we end up in a partially visible line, let's
15644 make it fully visible, except when it's taller
15645 than the window, in which case we can't do much
15648 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15652 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15653 if (!cursor_row_fully_visible_p (w
, 0, 1))
15654 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15656 rc
= CURSOR_MOVEMENT_SUCCESS
;
15660 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15661 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15662 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15664 /* With bidi-reordered rows, there could be more than
15665 one candidate row whose start and end positions
15666 occlude point. We need to let set_cursor_from_row
15667 find the best candidate. */
15668 /* FIXME: Revisit this when glyph ``spilling'' in
15669 continuation lines' rows is implemented for
15670 bidi-reordered rows. */
15675 int at_zv_p
= 0, exact_match_p
= 0;
15677 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15678 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15679 && cursor_row_p (row
))
15680 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15682 /* As soon as we've found the exact match for point,
15683 or the first suitable row whose ends_at_zv_p flag
15684 is set, we are done. */
15687 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15688 w
->cursor
.vpos
)->ends_at_zv_p
;
15690 && w
->cursor
.hpos
>= 0
15691 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15694 struct glyph_row
*candidate
=
15695 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15697 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15698 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15701 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15702 || (NILP (g
->object
)
15703 && (g
->charpos
== PT
15704 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15706 if (at_zv_p
|| exact_match_p
)
15708 rc
= CURSOR_MOVEMENT_SUCCESS
;
15712 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15716 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15717 || row
->continued_p
)
15718 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15719 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15720 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15721 /* If we didn't find any candidate rows, or exited the
15722 loop before all the candidates were examined, signal
15723 to the caller that this method failed. */
15724 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15726 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15727 && !row
->continued_p
))
15728 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15730 rc
= CURSOR_MOVEMENT_SUCCESS
;
15736 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15738 rc
= CURSOR_MOVEMENT_SUCCESS
;
15743 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15744 && MATRIX_ROW_START_CHARPOS (row
) == PT
15745 && cursor_row_p (row
));
15755 set_vertical_scroll_bar (struct window
*w
)
15757 ptrdiff_t start
, end
, whole
;
15759 /* Calculate the start and end positions for the current window.
15760 At some point, it would be nice to choose between scrollbars
15761 which reflect the whole buffer size, with special markers
15762 indicating narrowing, and scrollbars which reflect only the
15765 Note that mini-buffers sometimes aren't displaying any text. */
15766 if (!MINI_WINDOW_P (w
)
15767 || (w
== XWINDOW (minibuf_window
)
15768 && NILP (echo_area_buffer
[0])))
15770 struct buffer
*buf
= XBUFFER (w
->contents
);
15771 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15772 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15773 /* I don't think this is guaranteed to be right. For the
15774 moment, we'll pretend it is. */
15775 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15779 if (whole
< (end
- start
))
15780 whole
= end
- start
;
15783 start
= end
= whole
= 0;
15785 /* Indicate what this scroll bar ought to be displaying now. */
15786 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15787 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15788 (w
, end
- start
, whole
, start
);
15793 set_horizontal_scroll_bar (struct window
*w
)
15795 int start
, end
, whole
, portion
;
15797 if (!MINI_WINDOW_P (w
)
15798 || (w
== XWINDOW (minibuf_window
)
15799 && NILP (echo_area_buffer
[0])))
15801 struct buffer
*b
= XBUFFER (w
->contents
);
15802 struct buffer
*old_buffer
= NULL
;
15804 struct text_pos startp
;
15806 if (b
!= current_buffer
)
15808 old_buffer
= current_buffer
;
15809 set_buffer_internal (b
);
15812 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15813 start_display (&it
, w
, startp
);
15814 it
.last_visible_x
= INT_MAX
;
15815 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15816 MOVE_TO_X
| MOVE_TO_Y
);
15817 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15818 window_box_height (w), -1,
15819 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15821 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15822 end
= start
+ window_box_width (w
, TEXT_AREA
);
15823 portion
= end
- start
;
15824 /* After enlarging a horizontally scrolled window such that it
15825 gets at least as wide as the text it contains, make sure that
15826 the thumb doesn't fill the entire scroll bar so we can still
15827 drag it back to see the entire text. */
15828 whole
= max (whole
, end
);
15834 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15835 if (EQ (pdir
, Qright_to_left
))
15837 start
= whole
- end
;
15838 end
= start
+ portion
;
15843 set_buffer_internal (old_buffer
);
15846 start
= end
= whole
= portion
= 0;
15848 w
->hscroll_whole
= whole
;
15850 /* Indicate what this scroll bar ought to be displaying now. */
15851 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15852 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15853 (w
, portion
, whole
, start
);
15857 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15858 selected_window is redisplayed.
15860 We can return without actually redisplaying the window if fonts has been
15861 changed on window's frame. In that case, redisplay_internal will retry.
15863 As one of the important parts of redisplaying a window, we need to
15864 decide whether the previous window-start position (stored in the
15865 window's w->start marker position) is still valid, and if it isn't,
15866 recompute it. Some details about that:
15868 . The previous window-start could be in a continuation line, in
15869 which case we need to recompute it when the window width
15870 changes. See compute_window_start_on_continuation_line and its
15873 . The text that changed since last redisplay could include the
15874 previous window-start position. In that case, we try to salvage
15875 what we can from the current glyph matrix by calling
15876 try_scrolling, which see.
15878 . Some Emacs command could force us to use a specific window-start
15879 position by setting the window's force_start flag, or gently
15880 propose doing that by setting the window's optional_new_start
15881 flag. In these cases, we try using the specified start point if
15882 that succeeds (i.e. the window desired matrix is successfully
15883 recomputed, and point location is within the window). In case
15884 of optional_new_start, we first check if the specified start
15885 position is feasible, i.e. if it will allow point to be
15886 displayed in the window. If using the specified start point
15887 fails, e.g., if new fonts are needed to be loaded, we abort the
15888 redisplay cycle and leave it up to the next cycle to figure out
15891 . Note that the window's force_start flag is sometimes set by
15892 redisplay itself, when it decides that the previous window start
15893 point is fine and should be kept. Search for "goto force_start"
15894 below to see the details. Like the values of window-start
15895 specified outside of redisplay, these internally-deduced values
15896 are tested for feasibility, and ignored if found to be
15899 . Note that the function try_window, used to completely redisplay
15900 a window, accepts the window's start point as its argument.
15901 This is used several times in the redisplay code to control
15902 where the window start will be, according to user options such
15903 as scroll-conservatively, and also to ensure the screen line
15904 showing point will be fully (as opposed to partially) visible on
15908 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15910 struct window
*w
= XWINDOW (window
);
15911 struct frame
*f
= XFRAME (w
->frame
);
15912 struct buffer
*buffer
= XBUFFER (w
->contents
);
15913 struct buffer
*old
= current_buffer
;
15914 struct text_pos lpoint
, opoint
, startp
;
15915 int update_mode_line
;
15918 /* Record it now because it's overwritten. */
15919 bool current_matrix_up_to_date_p
= false;
15920 bool used_current_matrix_p
= false;
15921 /* This is less strict than current_matrix_up_to_date_p.
15922 It indicates that the buffer contents and narrowing are unchanged. */
15923 bool buffer_unchanged_p
= false;
15924 int temp_scroll_step
= 0;
15925 ptrdiff_t count
= SPECPDL_INDEX ();
15927 int centering_position
= -1;
15928 int last_line_misfit
= 0;
15929 ptrdiff_t beg_unchanged
, end_unchanged
;
15930 int frame_line_height
;
15932 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15936 *w
->desired_matrix
->method
= 0;
15939 if (!just_this_one_p
15940 && REDISPLAY_SOME_P ()
15943 && !buffer
->text
->redisplay
15944 && BUF_PT (buffer
) == w
->last_point
)
15947 /* Make sure that both W's markers are valid. */
15948 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15949 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15951 /* We come here again if we need to run window-text-change-functions
15954 reconsider_clip_changes (w
);
15955 frame_line_height
= default_line_pixel_height (w
);
15957 /* Has the mode line to be updated? */
15958 update_mode_line
= (w
->update_mode_line
15959 || update_mode_lines
15960 || buffer
->clip_changed
15961 || buffer
->prevent_redisplay_optimizations_p
);
15963 if (!just_this_one_p
)
15964 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15965 cleverly elsewhere. */
15966 w
->must_be_updated_p
= true;
15968 if (MINI_WINDOW_P (w
))
15970 if (w
== XWINDOW (echo_area_window
)
15971 && !NILP (echo_area_buffer
[0]))
15973 if (update_mode_line
)
15974 /* We may have to update a tty frame's menu bar or a
15975 tool-bar. Example `M-x C-h C-h C-g'. */
15976 goto finish_menu_bars
;
15978 /* We've already displayed the echo area glyphs in this window. */
15979 goto finish_scroll_bars
;
15981 else if ((w
!= XWINDOW (minibuf_window
)
15982 || minibuf_level
== 0)
15983 /* When buffer is nonempty, redisplay window normally. */
15984 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15985 /* Quail displays non-mini buffers in minibuffer window.
15986 In that case, redisplay the window normally. */
15987 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15989 /* W is a mini-buffer window, but it's not active, so clear
15991 int yb
= window_text_bottom_y (w
);
15992 struct glyph_row
*row
;
15995 for (y
= 0, row
= w
->desired_matrix
->rows
;
15997 y
+= row
->height
, ++row
)
15998 blank_row (w
, row
, y
);
15999 goto finish_scroll_bars
;
16002 clear_glyph_matrix (w
->desired_matrix
);
16005 /* Otherwise set up data on this window; select its buffer and point
16007 /* Really select the buffer, for the sake of buffer-local
16009 set_buffer_internal_1 (XBUFFER (w
->contents
));
16011 current_matrix_up_to_date_p
16012 = (w
->window_end_valid
16013 && !current_buffer
->clip_changed
16014 && !current_buffer
->prevent_redisplay_optimizations_p
16015 && !window_outdated (w
));
16017 /* Run the window-text-change-functions
16018 if it is possible that the text on the screen has changed
16019 (either due to modification of the text, or any other reason). */
16020 if (!current_matrix_up_to_date_p
16021 && !NILP (Vwindow_text_change_functions
))
16023 safe_run_hooks (Qwindow_text_change_functions
);
16027 beg_unchanged
= BEG_UNCHANGED
;
16028 end_unchanged
= END_UNCHANGED
;
16030 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16032 specbind (Qinhibit_point_motion_hooks
, Qt
);
16035 = (w
->window_end_valid
16036 && !current_buffer
->clip_changed
16037 && !window_outdated (w
));
16039 /* When windows_or_buffers_changed is non-zero, we can't rely
16040 on the window end being valid, so set it to zero there. */
16041 if (windows_or_buffers_changed
)
16043 /* If window starts on a continuation line, maybe adjust the
16044 window start in case the window's width changed. */
16045 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16046 compute_window_start_on_continuation_line (w
);
16048 w
->window_end_valid
= false;
16049 /* If so, we also can't rely on current matrix
16050 and should not fool try_cursor_movement below. */
16051 current_matrix_up_to_date_p
= false;
16054 /* Some sanity checks. */
16055 CHECK_WINDOW_END (w
);
16056 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16058 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16061 if (mode_line_update_needed (w
))
16062 update_mode_line
= 1;
16064 /* Point refers normally to the selected window. For any other
16065 window, set up appropriate value. */
16066 if (!EQ (window
, selected_window
))
16068 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16069 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16074 new_pt_byte
= BEGV_BYTE
;
16075 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16077 else if (new_pt
> (ZV
- 1))
16080 new_pt_byte
= ZV_BYTE
;
16081 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16084 /* We don't use SET_PT so that the point-motion hooks don't run. */
16085 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16088 /* If any of the character widths specified in the display table
16089 have changed, invalidate the width run cache. It's true that
16090 this may be a bit late to catch such changes, but the rest of
16091 redisplay goes (non-fatally) haywire when the display table is
16092 changed, so why should we worry about doing any better? */
16093 if (current_buffer
->width_run_cache
16094 || (current_buffer
->base_buffer
16095 && current_buffer
->base_buffer
->width_run_cache
))
16097 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16099 if (! disptab_matches_widthtab
16100 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16102 struct buffer
*buf
= current_buffer
;
16104 if (buf
->base_buffer
)
16105 buf
= buf
->base_buffer
;
16106 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16107 recompute_width_table (current_buffer
, disptab
);
16111 /* If window-start is screwed up, choose a new one. */
16112 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16115 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16117 /* If someone specified a new starting point but did not insist,
16118 check whether it can be used. */
16119 if ((w
->optional_new_start
|| window_frozen_p (w
))
16120 && CHARPOS (startp
) >= BEGV
16121 && CHARPOS (startp
) <= ZV
)
16123 ptrdiff_t it_charpos
;
16125 w
->optional_new_start
= 0;
16126 start_display (&it
, w
, startp
);
16127 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16128 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16129 /* Record IT's position now, since line_bottom_y might change
16131 it_charpos
= IT_CHARPOS (it
);
16132 /* Make sure we set the force_start flag only if the cursor row
16133 will be fully visible. Otherwise, the code under force_start
16134 label below will try to move point back into view, which is
16135 not what the code which sets optional_new_start wants. */
16136 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16137 && !w
->force_start
)
16139 if (it_charpos
== PT
)
16140 w
->force_start
= 1;
16141 /* IT may overshoot PT if text at PT is invisible. */
16142 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16143 w
->force_start
= 1;
16145 if (w
->force_start
)
16147 if (window_frozen_p (w
))
16148 debug_method_add (w
, "set force_start from frozen window start");
16150 debug_method_add (w
, "set force_start from optional_new_start");
16158 /* Handle case where place to start displaying has been specified,
16159 unless the specified location is outside the accessible range. */
16160 if (w
->force_start
)
16162 /* We set this later on if we have to adjust point. */
16165 w
->force_start
= 0;
16167 w
->window_end_valid
= 0;
16169 /* Forget any recorded base line for line number display. */
16170 if (!buffer_unchanged_p
)
16171 w
->base_line_number
= 0;
16173 /* Redisplay the mode line. Select the buffer properly for that.
16174 Also, run the hook window-scroll-functions
16175 because we have scrolled. */
16176 /* Note, we do this after clearing force_start because
16177 if there's an error, it is better to forget about force_start
16178 than to get into an infinite loop calling the hook functions
16179 and having them get more errors. */
16180 if (!update_mode_line
16181 || ! NILP (Vwindow_scroll_functions
))
16183 update_mode_line
= 1;
16184 w
->update_mode_line
= 1;
16185 startp
= run_window_scroll_functions (window
, startp
);
16188 if (CHARPOS (startp
) < BEGV
)
16189 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16190 else if (CHARPOS (startp
) > ZV
)
16191 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16193 /* Redisplay, then check if cursor has been set during the
16194 redisplay. Give up if new fonts were loaded. */
16195 /* We used to issue a CHECK_MARGINS argument to try_window here,
16196 but this causes scrolling to fail when point begins inside
16197 the scroll margin (bug#148) -- cyd */
16198 if (!try_window (window
, startp
, 0))
16200 w
->force_start
= 1;
16201 clear_glyph_matrix (w
->desired_matrix
);
16202 goto need_larger_matrices
;
16205 if (w
->cursor
.vpos
< 0)
16207 /* If point does not appear, try to move point so it does
16208 appear. The desired matrix has been built above, so we
16209 can use it here. */
16210 new_vpos
= window_box_height (w
) / 2;
16213 if (!cursor_row_fully_visible_p (w
, 0, 0))
16215 /* Point does appear, but on a line partly visible at end of window.
16216 Move it back to a fully-visible line. */
16217 new_vpos
= window_box_height (w
);
16218 /* But if window_box_height suggests a Y coordinate that is
16219 not less than we already have, that line will clearly not
16220 be fully visible, so give up and scroll the display.
16221 This can happen when the default face uses a font whose
16222 dimensions are different from the frame's default
16224 if (new_vpos
>= w
->cursor
.y
)
16226 w
->cursor
.vpos
= -1;
16227 clear_glyph_matrix (w
->desired_matrix
);
16228 goto try_to_scroll
;
16231 else if (w
->cursor
.vpos
>= 0)
16233 /* Some people insist on not letting point enter the scroll
16234 margin, even though this part handles windows that didn't
16236 int window_total_lines
16237 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16238 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16239 int pixel_margin
= margin
* frame_line_height
;
16240 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16242 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16243 below, which finds the row to move point to, advances by
16244 the Y coordinate of the _next_ row, see the definition of
16245 MATRIX_ROW_BOTTOM_Y. */
16246 if (w
->cursor
.vpos
< margin
+ header_line
)
16248 w
->cursor
.vpos
= -1;
16249 clear_glyph_matrix (w
->desired_matrix
);
16250 goto try_to_scroll
;
16254 int window_height
= window_box_height (w
);
16257 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16258 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16260 w
->cursor
.vpos
= -1;
16261 clear_glyph_matrix (w
->desired_matrix
);
16262 goto try_to_scroll
;
16267 /* If we need to move point for either of the above reasons,
16268 now actually do it. */
16271 struct glyph_row
*row
;
16273 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16274 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16277 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16278 MATRIX_ROW_START_BYTEPOS (row
));
16280 if (w
!= XWINDOW (selected_window
))
16281 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16282 else if (current_buffer
== old
)
16283 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16285 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16287 /* Re-run pre-redisplay-function so it can update the region
16288 according to the new position of point. */
16289 /* Other than the cursor, w's redisplay is done so we can set its
16290 redisplay to false. Also the buffer's redisplay can be set to
16291 false, since propagate_buffer_redisplay should have already
16292 propagated its info to `w' anyway. */
16293 w
->redisplay
= false;
16294 XBUFFER (w
->contents
)->text
->redisplay
= false;
16295 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16297 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16299 /* pre-redisplay-function made changes (e.g. move the region)
16300 that require another round of redisplay. */
16301 clear_glyph_matrix (w
->desired_matrix
);
16302 if (!try_window (window
, startp
, 0))
16303 goto need_larger_matrices
;
16306 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, 0, 0))
16308 clear_glyph_matrix (w
->desired_matrix
);
16309 goto try_to_scroll
;
16313 debug_method_add (w
, "forced window start");
16318 /* Handle case where text has not changed, only point, and it has
16319 not moved off the frame, and we are not retrying after hscroll.
16320 (current_matrix_up_to_date_p is nonzero when retrying.) */
16321 if (current_matrix_up_to_date_p
16322 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16323 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16327 case CURSOR_MOVEMENT_SUCCESS
:
16328 used_current_matrix_p
= 1;
16331 case CURSOR_MOVEMENT_MUST_SCROLL
:
16332 goto try_to_scroll
;
16338 /* If current starting point was originally the beginning of a line
16339 but no longer is, find a new starting point. */
16340 else if (w
->start_at_line_beg
16341 && !(CHARPOS (startp
) <= BEGV
16342 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16345 debug_method_add (w
, "recenter 1");
16350 /* Try scrolling with try_window_id. Value is > 0 if update has
16351 been done, it is -1 if we know that the same window start will
16352 not work. It is 0 if unsuccessful for some other reason. */
16353 else if ((tem
= try_window_id (w
)) != 0)
16356 debug_method_add (w
, "try_window_id %d", tem
);
16359 if (f
->fonts_changed
)
16360 goto need_larger_matrices
;
16364 /* Otherwise try_window_id has returned -1 which means that we
16365 don't want the alternative below this comment to execute. */
16367 else if (CHARPOS (startp
) >= BEGV
16368 && CHARPOS (startp
) <= ZV
16369 && PT
>= CHARPOS (startp
)
16370 && (CHARPOS (startp
) < ZV
16371 /* Avoid starting at end of buffer. */
16372 || CHARPOS (startp
) == BEGV
16373 || !window_outdated (w
)))
16375 int d1
, d2
, d5
, d6
;
16378 /* If first window line is a continuation line, and window start
16379 is inside the modified region, but the first change is before
16380 current window start, we must select a new window start.
16382 However, if this is the result of a down-mouse event (e.g. by
16383 extending the mouse-drag-overlay), we don't want to select a
16384 new window start, since that would change the position under
16385 the mouse, resulting in an unwanted mouse-movement rather
16386 than a simple mouse-click. */
16387 if (!w
->start_at_line_beg
16388 && NILP (do_mouse_tracking
)
16389 && CHARPOS (startp
) > BEGV
16390 && CHARPOS (startp
) > BEG
+ beg_unchanged
16391 && CHARPOS (startp
) <= Z
- end_unchanged
16392 /* Even if w->start_at_line_beg is nil, a new window may
16393 start at a line_beg, since that's how set_buffer_window
16394 sets it. So, we need to check the return value of
16395 compute_window_start_on_continuation_line. (See also
16397 && XMARKER (w
->start
)->buffer
== current_buffer
16398 && compute_window_start_on_continuation_line (w
)
16399 /* It doesn't make sense to force the window start like we
16400 do at label force_start if it is already known that point
16401 will not be fully visible in the resulting window, because
16402 doing so will move point from its correct position
16403 instead of scrolling the window to bring point into view.
16405 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16406 /* A very tall row could need more than the window height,
16407 in which case we accept that it is partially visible. */
16408 && (rtop
!= 0) == (rbot
!= 0))
16410 w
->force_start
= 1;
16411 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16413 debug_method_add (w
, "recomputed window start in continuation line");
16419 debug_method_add (w
, "same window start");
16422 /* Try to redisplay starting at same place as before.
16423 If point has not moved off frame, accept the results. */
16424 if (!current_matrix_up_to_date_p
16425 /* Don't use try_window_reusing_current_matrix in this case
16426 because a window scroll function can have changed the
16428 || !NILP (Vwindow_scroll_functions
)
16429 || MINI_WINDOW_P (w
)
16430 || !(used_current_matrix_p
16431 = try_window_reusing_current_matrix (w
)))
16433 IF_DEBUG (debug_method_add (w
, "1"));
16434 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16435 /* -1 means we need to scroll.
16436 0 means we need new matrices, but fonts_changed
16437 is set in that case, so we will detect it below. */
16438 goto try_to_scroll
;
16441 if (f
->fonts_changed
)
16442 goto need_larger_matrices
;
16444 if (w
->cursor
.vpos
>= 0)
16446 if (!just_this_one_p
16447 || current_buffer
->clip_changed
16448 || BEG_UNCHANGED
< CHARPOS (startp
))
16449 /* Forget any recorded base line for line number display. */
16450 w
->base_line_number
= 0;
16452 if (!cursor_row_fully_visible_p (w
, 1, 0))
16454 clear_glyph_matrix (w
->desired_matrix
);
16455 last_line_misfit
= 1;
16457 /* Drop through and scroll. */
16462 clear_glyph_matrix (w
->desired_matrix
);
16467 /* Redisplay the mode line. Select the buffer properly for that. */
16468 if (!update_mode_line
)
16470 update_mode_line
= 1;
16471 w
->update_mode_line
= 1;
16474 /* Try to scroll by specified few lines. */
16475 if ((scroll_conservatively
16476 || emacs_scroll_step
16477 || temp_scroll_step
16478 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16479 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16480 && CHARPOS (startp
) >= BEGV
16481 && CHARPOS (startp
) <= ZV
)
16483 /* The function returns -1 if new fonts were loaded, 1 if
16484 successful, 0 if not successful. */
16485 int ss
= try_scrolling (window
, just_this_one_p
,
16486 scroll_conservatively
,
16488 temp_scroll_step
, last_line_misfit
);
16491 case SCROLLING_SUCCESS
:
16494 case SCROLLING_NEED_LARGER_MATRICES
:
16495 goto need_larger_matrices
;
16497 case SCROLLING_FAILED
:
16505 /* Finally, just choose a place to start which positions point
16506 according to user preferences. */
16511 debug_method_add (w
, "recenter");
16514 /* Forget any previously recorded base line for line number display. */
16515 if (!buffer_unchanged_p
)
16516 w
->base_line_number
= 0;
16518 /* Determine the window start relative to point. */
16519 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16520 it
.current_y
= it
.last_visible_y
;
16521 if (centering_position
< 0)
16523 int window_total_lines
16524 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16526 = scroll_margin
> 0
16527 ? min (scroll_margin
, window_total_lines
/ 4)
16529 ptrdiff_t margin_pos
= CHARPOS (startp
);
16530 Lisp_Object aggressive
;
16533 /* If there is a scroll margin at the top of the window, find
16534 its character position. */
16536 /* Cannot call start_display if startp is not in the
16537 accessible region of the buffer. This can happen when we
16538 have just switched to a different buffer and/or changed
16539 its restriction. In that case, startp is initialized to
16540 the character position 1 (BEGV) because we did not yet
16541 have chance to display the buffer even once. */
16542 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16545 void *it1data
= NULL
;
16547 SAVE_IT (it1
, it
, it1data
);
16548 start_display (&it1
, w
, startp
);
16549 move_it_vertically (&it1
, margin
* frame_line_height
);
16550 margin_pos
= IT_CHARPOS (it1
);
16551 RESTORE_IT (&it
, &it
, it1data
);
16553 scrolling_up
= PT
> margin_pos
;
16556 ? BVAR (current_buffer
, scroll_up_aggressively
)
16557 : BVAR (current_buffer
, scroll_down_aggressively
);
16559 if (!MINI_WINDOW_P (w
)
16560 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16564 /* Setting scroll-conservatively overrides
16565 scroll-*-aggressively. */
16566 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16568 double float_amount
= XFLOATINT (aggressive
);
16570 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16571 if (pt_offset
== 0 && float_amount
> 0)
16573 if (pt_offset
&& margin
> 0)
16576 /* Compute how much to move the window start backward from
16577 point so that point will be displayed where the user
16581 centering_position
= it
.last_visible_y
;
16583 centering_position
-= pt_offset
;
16584 centering_position
-=
16585 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16586 + WINDOW_HEADER_LINE_HEIGHT (w
);
16587 /* Don't let point enter the scroll margin near top of
16589 if (centering_position
< margin
* frame_line_height
)
16590 centering_position
= margin
* frame_line_height
;
16593 centering_position
= margin
* frame_line_height
+ pt_offset
;
16596 /* Set the window start half the height of the window backward
16598 centering_position
= window_box_height (w
) / 2;
16600 move_it_vertically_backward (&it
, centering_position
);
16602 eassert (IT_CHARPOS (it
) >= BEGV
);
16604 /* The function move_it_vertically_backward may move over more
16605 than the specified y-distance. If it->w is small, e.g. a
16606 mini-buffer window, we may end up in front of the window's
16607 display area. Start displaying at the start of the line
16608 containing PT in this case. */
16609 if (it
.current_y
<= 0)
16611 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16612 move_it_vertically_backward (&it
, 0);
16616 it
.current_x
= it
.hpos
= 0;
16618 /* Set the window start position here explicitly, to avoid an
16619 infinite loop in case the functions in window-scroll-functions
16621 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16623 /* Run scroll hooks. */
16624 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16626 /* Redisplay the window. */
16627 if (!current_matrix_up_to_date_p
16628 || windows_or_buffers_changed
16629 || f
->cursor_type_changed
16630 /* Don't use try_window_reusing_current_matrix in this case
16631 because it can have changed the buffer. */
16632 || !NILP (Vwindow_scroll_functions
)
16633 || !just_this_one_p
16634 || MINI_WINDOW_P (w
)
16635 || !(used_current_matrix_p
16636 = try_window_reusing_current_matrix (w
)))
16637 try_window (window
, startp
, 0);
16639 /* If new fonts have been loaded (due to fontsets), give up. We
16640 have to start a new redisplay since we need to re-adjust glyph
16642 if (f
->fonts_changed
)
16643 goto need_larger_matrices
;
16645 /* If cursor did not appear assume that the middle of the window is
16646 in the first line of the window. Do it again with the next line.
16647 (Imagine a window of height 100, displaying two lines of height
16648 60. Moving back 50 from it->last_visible_y will end in the first
16650 if (w
->cursor
.vpos
< 0)
16652 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16654 clear_glyph_matrix (w
->desired_matrix
);
16655 move_it_by_lines (&it
, 1);
16656 try_window (window
, it
.current
.pos
, 0);
16658 else if (PT
< IT_CHARPOS (it
))
16660 clear_glyph_matrix (w
->desired_matrix
);
16661 move_it_by_lines (&it
, -1);
16662 try_window (window
, it
.current
.pos
, 0);
16666 /* Not much we can do about it. */
16670 /* Consider the following case: Window starts at BEGV, there is
16671 invisible, intangible text at BEGV, so that display starts at
16672 some point START > BEGV. It can happen that we are called with
16673 PT somewhere between BEGV and START. Try to handle that case,
16674 and similar ones. */
16675 if (w
->cursor
.vpos
< 0)
16677 /* First, try locating the proper glyph row for PT. */
16678 struct glyph_row
*row
=
16679 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16681 /* Sometimes point is at the beginning of invisible text that is
16682 before the 1st character displayed in the row. In that case,
16683 row_containing_pos fails to find the row, because no glyphs
16684 with appropriate buffer positions are present in the row.
16685 Therefore, we next try to find the row which shows the 1st
16686 position after the invisible text. */
16690 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16693 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16696 Lisp_Object invis_end
=
16697 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16700 if (NATNUMP (invis_end
))
16701 alt_pos
= XFASTINT (invis_end
);
16704 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16708 /* Finally, fall back on the first row of the window after the
16709 header line (if any). This is slightly better than not
16710 displaying the cursor at all. */
16713 row
= w
->current_matrix
->rows
;
16714 if (row
->mode_line_p
)
16717 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16720 if (!cursor_row_fully_visible_p (w
, 0, 0))
16722 /* If vscroll is enabled, disable it and try again. */
16726 clear_glyph_matrix (w
->desired_matrix
);
16730 /* Users who set scroll-conservatively to a large number want
16731 point just above/below the scroll margin. If we ended up
16732 with point's row partially visible, move the window start to
16733 make that row fully visible and out of the margin. */
16734 if (scroll_conservatively
> SCROLL_LIMIT
)
16736 int window_total_lines
16737 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16740 ? min (scroll_margin
, window_total_lines
/ 4)
16742 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16744 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16745 clear_glyph_matrix (w
->desired_matrix
);
16746 if (1 == try_window (window
, it
.current
.pos
,
16747 TRY_WINDOW_CHECK_MARGINS
))
16751 /* If centering point failed to make the whole line visible,
16752 put point at the top instead. That has to make the whole line
16753 visible, if it can be done. */
16754 if (centering_position
== 0)
16757 clear_glyph_matrix (w
->desired_matrix
);
16758 centering_position
= 0;
16764 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16765 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16766 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16768 /* Display the mode line, if we must. */
16769 if ((update_mode_line
16770 /* If window not full width, must redo its mode line
16771 if (a) the window to its side is being redone and
16772 (b) we do a frame-based redisplay. This is a consequence
16773 of how inverted lines are drawn in frame-based redisplay. */
16774 || (!just_this_one_p
16775 && !FRAME_WINDOW_P (f
)
16776 && !WINDOW_FULL_WIDTH_P (w
))
16777 /* Line number to display. */
16778 || w
->base_line_pos
> 0
16779 /* Column number is displayed and different from the one displayed. */
16780 || (w
->column_number_displayed
!= -1
16781 && (w
->column_number_displayed
!= current_column ())))
16782 /* This means that the window has a mode line. */
16783 && (WINDOW_WANTS_MODELINE_P (w
)
16784 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16787 display_mode_lines (w
);
16789 /* If mode line height has changed, arrange for a thorough
16790 immediate redisplay using the correct mode line height. */
16791 if (WINDOW_WANTS_MODELINE_P (w
)
16792 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16794 f
->fonts_changed
= 1;
16795 w
->mode_line_height
= -1;
16796 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16797 = DESIRED_MODE_LINE_HEIGHT (w
);
16800 /* If header line height has changed, arrange for a thorough
16801 immediate redisplay using the correct header line height. */
16802 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16803 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16805 f
->fonts_changed
= 1;
16806 w
->header_line_height
= -1;
16807 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16808 = DESIRED_HEADER_LINE_HEIGHT (w
);
16811 if (f
->fonts_changed
)
16812 goto need_larger_matrices
;
16815 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16817 w
->base_line_pos
= 0;
16818 w
->base_line_number
= 0;
16823 /* When we reach a frame's selected window, redo the frame's menu bar. */
16824 if (update_mode_line
16825 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16827 int redisplay_menu_p
= 0;
16829 if (FRAME_WINDOW_P (f
))
16831 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16832 || defined (HAVE_NS) || defined (USE_GTK)
16833 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16835 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16839 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16841 if (redisplay_menu_p
)
16842 display_menu_bar (w
);
16844 #ifdef HAVE_WINDOW_SYSTEM
16845 if (FRAME_WINDOW_P (f
))
16847 #if defined (USE_GTK) || defined (HAVE_NS)
16848 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16849 redisplay_tool_bar (f
);
16851 if (WINDOWP (f
->tool_bar_window
)
16852 && (FRAME_TOOL_BAR_LINES (f
) > 0
16853 || !NILP (Vauto_resize_tool_bars
))
16854 && redisplay_tool_bar (f
))
16855 ignore_mouse_drag_p
= 1;
16861 #ifdef HAVE_WINDOW_SYSTEM
16862 if (FRAME_WINDOW_P (f
)
16863 && update_window_fringes (w
, (just_this_one_p
16864 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16865 || w
->pseudo_window_p
)))
16869 if (draw_window_fringes (w
, 1))
16871 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16872 x_draw_right_divider (w
);
16874 x_draw_vertical_border (w
);
16880 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16881 x_draw_bottom_divider (w
);
16882 #endif /* HAVE_WINDOW_SYSTEM */
16884 /* We go to this label, with fonts_changed set, if it is
16885 necessary to try again using larger glyph matrices.
16886 We have to redeem the scroll bar even in this case,
16887 because the loop in redisplay_internal expects that. */
16888 need_larger_matrices
:
16890 finish_scroll_bars
:
16892 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16894 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16895 /* Set the thumb's position and size. */
16896 set_vertical_scroll_bar (w
);
16898 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16899 /* Set the thumb's position and size. */
16900 set_horizontal_scroll_bar (w
);
16902 /* Note that we actually used the scroll bar attached to this
16903 window, so it shouldn't be deleted at the end of redisplay. */
16904 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16905 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16908 /* Restore current_buffer and value of point in it. The window
16909 update may have changed the buffer, so first make sure `opoint'
16910 is still valid (Bug#6177). */
16911 if (CHARPOS (opoint
) < BEGV
)
16912 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16913 else if (CHARPOS (opoint
) > ZV
)
16914 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16916 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16918 set_buffer_internal_1 (old
);
16919 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16920 shorter. This can be caused by log truncation in *Messages*. */
16921 if (CHARPOS (lpoint
) <= ZV
)
16922 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16924 unbind_to (count
, Qnil
);
16928 /* Build the complete desired matrix of WINDOW with a window start
16929 buffer position POS.
16931 Value is 1 if successful. It is zero if fonts were loaded during
16932 redisplay which makes re-adjusting glyph matrices necessary, and -1
16933 if point would appear in the scroll margins.
16934 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16935 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16939 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16941 struct window
*w
= XWINDOW (window
);
16943 struct glyph_row
*last_text_row
= NULL
;
16944 struct frame
*f
= XFRAME (w
->frame
);
16945 int frame_line_height
= default_line_pixel_height (w
);
16947 /* Make POS the new window start. */
16948 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16950 /* Mark cursor position as unknown. No overlay arrow seen. */
16951 w
->cursor
.vpos
= -1;
16952 overlay_arrow_seen
= 0;
16954 /* Initialize iterator and info to start at POS. */
16955 start_display (&it
, w
, pos
);
16956 it
.glyph_row
->reversed_p
= false;
16958 /* Display all lines of W. */
16959 while (it
.current_y
< it
.last_visible_y
)
16961 if (display_line (&it
))
16962 last_text_row
= it
.glyph_row
- 1;
16963 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16967 /* Don't let the cursor end in the scroll margins. */
16968 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16969 && !MINI_WINDOW_P (w
))
16971 int this_scroll_margin
;
16972 int window_total_lines
16973 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16975 if (scroll_margin
> 0)
16977 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16978 this_scroll_margin
*= frame_line_height
;
16981 this_scroll_margin
= 0;
16983 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16984 && w
->cursor
.y
< this_scroll_margin
16985 && CHARPOS (pos
) > BEGV
16986 && IT_CHARPOS (it
) < ZV
)
16987 /* rms: considering make_cursor_line_fully_visible_p here
16988 seems to give wrong results. We don't want to recenter
16989 when the last line is partly visible, we want to allow
16990 that case to be handled in the usual way. */
16991 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16993 w
->cursor
.vpos
= -1;
16994 clear_glyph_matrix (w
->desired_matrix
);
16999 /* If bottom moved off end of frame, change mode line percentage. */
17000 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17001 w
->update_mode_line
= 1;
17003 /* Set window_end_pos to the offset of the last character displayed
17004 on the window from the end of current_buffer. Set
17005 window_end_vpos to its row number. */
17008 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17009 adjust_window_ends (w
, last_text_row
, 0);
17011 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17012 w
->window_end_vpos
)));
17016 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17017 w
->window_end_pos
= Z
- ZV
;
17018 w
->window_end_vpos
= 0;
17021 /* But that is not valid info until redisplay finishes. */
17022 w
->window_end_valid
= 0;
17028 /************************************************************************
17029 Window redisplay reusing current matrix when buffer has not changed
17030 ************************************************************************/
17032 /* Try redisplay of window W showing an unchanged buffer with a
17033 different window start than the last time it was displayed by
17034 reusing its current matrix. Value is non-zero if successful.
17035 W->start is the new window start. */
17038 try_window_reusing_current_matrix (struct window
*w
)
17040 struct frame
*f
= XFRAME (w
->frame
);
17041 struct glyph_row
*bottom_row
;
17044 struct text_pos start
, new_start
;
17045 int nrows_scrolled
, i
;
17046 struct glyph_row
*last_text_row
;
17047 struct glyph_row
*last_reused_text_row
;
17048 struct glyph_row
*start_row
;
17049 int start_vpos
, min_y
, max_y
;
17052 if (inhibit_try_window_reusing
)
17056 #ifdef HAVE_XWIDGETS_xxx
17057 //currently this is needed to detect xwidget movement reliably. or probably not.
17058 printf("try_window_reusing_current_matrix\n");
17063 if (/* This function doesn't handle terminal frames. */
17064 !FRAME_WINDOW_P (f
)
17065 /* Don't try to reuse the display if windows have been split
17067 || windows_or_buffers_changed
17068 || f
->cursor_type_changed
)
17071 /* Can't do this if showing trailing whitespace. */
17072 if (!NILP (Vshow_trailing_whitespace
))
17075 /* If top-line visibility has changed, give up. */
17076 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17077 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17080 /* Give up if old or new display is scrolled vertically. We could
17081 make this function handle this, but right now it doesn't. */
17082 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17083 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17086 /* The variable new_start now holds the new window start. The old
17087 start `start' can be determined from the current matrix. */
17088 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17089 start
= start_row
->minpos
;
17090 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17092 /* Clear the desired matrix for the display below. */
17093 clear_glyph_matrix (w
->desired_matrix
);
17095 if (CHARPOS (new_start
) <= CHARPOS (start
))
17097 /* Don't use this method if the display starts with an ellipsis
17098 displayed for invisible text. It's not easy to handle that case
17099 below, and it's certainly not worth the effort since this is
17100 not a frequent case. */
17101 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17104 IF_DEBUG (debug_method_add (w
, "twu1"));
17106 /* Display up to a row that can be reused. The variable
17107 last_text_row is set to the last row displayed that displays
17108 text. Note that it.vpos == 0 if or if not there is a
17109 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17110 start_display (&it
, w
, new_start
);
17111 w
->cursor
.vpos
= -1;
17112 last_text_row
= last_reused_text_row
= NULL
;
17114 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17116 /* If we have reached into the characters in the START row,
17117 that means the line boundaries have changed. So we
17118 can't start copying with the row START. Maybe it will
17119 work to start copying with the following row. */
17120 while (IT_CHARPOS (it
) > CHARPOS (start
))
17122 /* Advance to the next row as the "start". */
17124 start
= start_row
->minpos
;
17125 /* If there are no more rows to try, or just one, give up. */
17126 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17127 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17128 || CHARPOS (start
) == ZV
)
17130 clear_glyph_matrix (w
->desired_matrix
);
17134 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17136 /* If we have reached alignment, we can copy the rest of the
17138 if (IT_CHARPOS (it
) == CHARPOS (start
)
17139 /* Don't accept "alignment" inside a display vector,
17140 since start_row could have started in the middle of
17141 that same display vector (thus their character
17142 positions match), and we have no way of telling if
17143 that is the case. */
17144 && it
.current
.dpvec_index
< 0)
17147 it
.glyph_row
->reversed_p
= false;
17148 if (display_line (&it
))
17149 last_text_row
= it
.glyph_row
- 1;
17153 /* A value of current_y < last_visible_y means that we stopped
17154 at the previous window start, which in turn means that we
17155 have at least one reusable row. */
17156 if (it
.current_y
< it
.last_visible_y
)
17158 struct glyph_row
*row
;
17160 /* IT.vpos always starts from 0; it counts text lines. */
17161 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17163 /* Find PT if not already found in the lines displayed. */
17164 if (w
->cursor
.vpos
< 0)
17166 int dy
= it
.current_y
- start_row
->y
;
17168 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17169 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17171 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17172 dy
, nrows_scrolled
);
17175 clear_glyph_matrix (w
->desired_matrix
);
17180 /* Scroll the display. Do it before the current matrix is
17181 changed. The problem here is that update has not yet
17182 run, i.e. part of the current matrix is not up to date.
17183 scroll_run_hook will clear the cursor, and use the
17184 current matrix to get the height of the row the cursor is
17186 run
.current_y
= start_row
->y
;
17187 run
.desired_y
= it
.current_y
;
17188 run
.height
= it
.last_visible_y
- it
.current_y
;
17190 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17193 FRAME_RIF (f
)->update_window_begin_hook (w
);
17194 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17195 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17196 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17200 /* Shift current matrix down by nrows_scrolled lines. */
17201 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17202 rotate_matrix (w
->current_matrix
,
17204 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17207 /* Disable lines that must be updated. */
17208 for (i
= 0; i
< nrows_scrolled
; ++i
)
17209 (start_row
+ i
)->enabled_p
= false;
17211 /* Re-compute Y positions. */
17212 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17213 max_y
= it
.last_visible_y
;
17214 for (row
= start_row
+ nrows_scrolled
;
17218 row
->y
= it
.current_y
;
17219 row
->visible_height
= row
->height
;
17221 if (row
->y
< min_y
)
17222 row
->visible_height
-= min_y
- row
->y
;
17223 if (row
->y
+ row
->height
> max_y
)
17224 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17225 if (row
->fringe_bitmap_periodic_p
)
17226 row
->redraw_fringe_bitmaps_p
= 1;
17228 it
.current_y
+= row
->height
;
17230 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17231 last_reused_text_row
= row
;
17232 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17236 /* Disable lines in the current matrix which are now
17237 below the window. */
17238 for (++row
; row
< bottom_row
; ++row
)
17239 row
->enabled_p
= row
->mode_line_p
= 0;
17242 /* Update window_end_pos etc.; last_reused_text_row is the last
17243 reused row from the current matrix containing text, if any.
17244 The value of last_text_row is the last displayed line
17245 containing text. */
17246 if (last_reused_text_row
)
17247 adjust_window_ends (w
, last_reused_text_row
, 1);
17248 else if (last_text_row
)
17249 adjust_window_ends (w
, last_text_row
, 0);
17252 /* This window must be completely empty. */
17253 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17254 w
->window_end_pos
= Z
- ZV
;
17255 w
->window_end_vpos
= 0;
17257 w
->window_end_valid
= 0;
17259 /* Update hint: don't try scrolling again in update_window. */
17260 w
->desired_matrix
->no_scrolling_p
= 1;
17263 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17267 else if (CHARPOS (new_start
) > CHARPOS (start
))
17269 struct glyph_row
*pt_row
, *row
;
17270 struct glyph_row
*first_reusable_row
;
17271 struct glyph_row
*first_row_to_display
;
17273 int yb
= window_text_bottom_y (w
);
17275 /* Find the row starting at new_start, if there is one. Don't
17276 reuse a partially visible line at the end. */
17277 first_reusable_row
= start_row
;
17278 while (first_reusable_row
->enabled_p
17279 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17280 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17281 < CHARPOS (new_start
)))
17282 ++first_reusable_row
;
17284 /* Give up if there is no row to reuse. */
17285 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17286 || !first_reusable_row
->enabled_p
17287 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17288 != CHARPOS (new_start
)))
17291 /* We can reuse fully visible rows beginning with
17292 first_reusable_row to the end of the window. Set
17293 first_row_to_display to the first row that cannot be reused.
17294 Set pt_row to the row containing point, if there is any. */
17296 for (first_row_to_display
= first_reusable_row
;
17297 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17298 ++first_row_to_display
)
17300 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17301 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17302 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17303 && first_row_to_display
->ends_at_zv_p
17304 && pt_row
== NULL
)))
17305 pt_row
= first_row_to_display
;
17308 /* Start displaying at the start of first_row_to_display. */
17309 eassert (first_row_to_display
->y
< yb
);
17310 init_to_row_start (&it
, w
, first_row_to_display
);
17312 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17314 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17316 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17317 + WINDOW_HEADER_LINE_HEIGHT (w
));
17319 /* Display lines beginning with first_row_to_display in the
17320 desired matrix. Set last_text_row to the last row displayed
17321 that displays text. */
17322 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17323 if (pt_row
== NULL
)
17324 w
->cursor
.vpos
= -1;
17325 last_text_row
= NULL
;
17326 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17327 if (display_line (&it
))
17328 last_text_row
= it
.glyph_row
- 1;
17330 /* If point is in a reused row, adjust y and vpos of the cursor
17334 w
->cursor
.vpos
-= nrows_scrolled
;
17335 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17338 /* Give up if point isn't in a row displayed or reused. (This
17339 also handles the case where w->cursor.vpos < nrows_scrolled
17340 after the calls to display_line, which can happen with scroll
17341 margins. See bug#1295.) */
17342 if (w
->cursor
.vpos
< 0)
17344 clear_glyph_matrix (w
->desired_matrix
);
17348 /* Scroll the display. */
17349 run
.current_y
= first_reusable_row
->y
;
17350 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17351 run
.height
= it
.last_visible_y
- run
.current_y
;
17352 dy
= run
.current_y
- run
.desired_y
;
17357 FRAME_RIF (f
)->update_window_begin_hook (w
);
17358 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17359 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17360 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17364 /* Adjust Y positions of reused rows. */
17365 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17366 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17367 max_y
= it
.last_visible_y
;
17368 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17371 row
->visible_height
= row
->height
;
17372 if (row
->y
< min_y
)
17373 row
->visible_height
-= min_y
- row
->y
;
17374 if (row
->y
+ row
->height
> max_y
)
17375 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17376 if (row
->fringe_bitmap_periodic_p
)
17377 row
->redraw_fringe_bitmaps_p
= 1;
17380 /* Scroll the current matrix. */
17381 eassert (nrows_scrolled
> 0);
17382 rotate_matrix (w
->current_matrix
,
17384 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17387 /* Disable rows not reused. */
17388 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17389 row
->enabled_p
= false;
17391 /* Point may have moved to a different line, so we cannot assume that
17392 the previous cursor position is valid; locate the correct row. */
17395 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17397 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17398 && !row
->ends_at_zv_p
;
17402 w
->cursor
.y
= row
->y
;
17404 if (row
< bottom_row
)
17406 /* Can't simply scan the row for point with
17407 bidi-reordered glyph rows. Let set_cursor_from_row
17408 figure out where to put the cursor, and if it fails,
17410 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17412 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17415 clear_glyph_matrix (w
->desired_matrix
);
17421 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17422 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17425 && (!BUFFERP (glyph
->object
)
17426 || glyph
->charpos
< PT
);
17430 w
->cursor
.x
+= glyph
->pixel_width
;
17436 /* Adjust window end. A null value of last_text_row means that
17437 the window end is in reused rows which in turn means that
17438 only its vpos can have changed. */
17440 adjust_window_ends (w
, last_text_row
, 0);
17442 w
->window_end_vpos
-= nrows_scrolled
;
17444 w
->window_end_valid
= 0;
17445 w
->desired_matrix
->no_scrolling_p
= 1;
17448 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17458 /************************************************************************
17459 Window redisplay reusing current matrix when buffer has changed
17460 ************************************************************************/
17462 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17463 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17464 ptrdiff_t *, ptrdiff_t *);
17465 static struct glyph_row
*
17466 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17467 struct glyph_row
*);
17470 /* Return the last row in MATRIX displaying text. If row START is
17471 non-null, start searching with that row. IT gives the dimensions
17472 of the display. Value is null if matrix is empty; otherwise it is
17473 a pointer to the row found. */
17475 static struct glyph_row
*
17476 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17477 struct glyph_row
*start
)
17479 struct glyph_row
*row
, *row_found
;
17481 /* Set row_found to the last row in IT->w's current matrix
17482 displaying text. The loop looks funny but think of partially
17485 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17486 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17488 eassert (row
->enabled_p
);
17490 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17499 /* Return the last row in the current matrix of W that is not affected
17500 by changes at the start of current_buffer that occurred since W's
17501 current matrix was built. Value is null if no such row exists.
17503 BEG_UNCHANGED us the number of characters unchanged at the start of
17504 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17505 first changed character in current_buffer. Characters at positions <
17506 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17507 when the current matrix was built. */
17509 static struct glyph_row
*
17510 find_last_unchanged_at_beg_row (struct window
*w
)
17512 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17513 struct glyph_row
*row
;
17514 struct glyph_row
*row_found
= NULL
;
17515 int yb
= window_text_bottom_y (w
);
17517 /* Find the last row displaying unchanged text. */
17518 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17519 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17520 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17523 if (/* If row ends before first_changed_pos, it is unchanged,
17524 except in some case. */
17525 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17526 /* When row ends in ZV and we write at ZV it is not
17528 && !row
->ends_at_zv_p
17529 /* When first_changed_pos is the end of a continued line,
17530 row is not unchanged because it may be no longer
17532 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17533 && (row
->continued_p
17534 || row
->exact_window_width_line_p
))
17535 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17536 needs to be recomputed, so don't consider this row as
17537 unchanged. This happens when the last line was
17538 bidi-reordered and was killed immediately before this
17539 redisplay cycle. In that case, ROW->end stores the
17540 buffer position of the first visual-order character of
17541 the killed text, which is now beyond ZV. */
17542 && CHARPOS (row
->end
.pos
) <= ZV
)
17545 /* Stop if last visible row. */
17546 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17554 /* Find the first glyph row in the current matrix of W that is not
17555 affected by changes at the end of current_buffer since the
17556 time W's current matrix was built.
17558 Return in *DELTA the number of chars by which buffer positions in
17559 unchanged text at the end of current_buffer must be adjusted.
17561 Return in *DELTA_BYTES the corresponding number of bytes.
17563 Value is null if no such row exists, i.e. all rows are affected by
17566 static struct glyph_row
*
17567 find_first_unchanged_at_end_row (struct window
*w
,
17568 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17570 struct glyph_row
*row
;
17571 struct glyph_row
*row_found
= NULL
;
17573 *delta
= *delta_bytes
= 0;
17575 /* Display must not have been paused, otherwise the current matrix
17576 is not up to date. */
17577 eassert (w
->window_end_valid
);
17579 /* A value of window_end_pos >= END_UNCHANGED means that the window
17580 end is in the range of changed text. If so, there is no
17581 unchanged row at the end of W's current matrix. */
17582 if (w
->window_end_pos
>= END_UNCHANGED
)
17585 /* Set row to the last row in W's current matrix displaying text. */
17586 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17588 /* If matrix is entirely empty, no unchanged row exists. */
17589 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17591 /* The value of row is the last glyph row in the matrix having a
17592 meaningful buffer position in it. The end position of row
17593 corresponds to window_end_pos. This allows us to translate
17594 buffer positions in the current matrix to current buffer
17595 positions for characters not in changed text. */
17597 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17598 ptrdiff_t Z_BYTE_old
=
17599 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17600 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17601 struct glyph_row
*first_text_row
17602 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17604 *delta
= Z
- Z_old
;
17605 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17607 /* Set last_unchanged_pos to the buffer position of the last
17608 character in the buffer that has not been changed. Z is the
17609 index + 1 of the last character in current_buffer, i.e. by
17610 subtracting END_UNCHANGED we get the index of the last
17611 unchanged character, and we have to add BEG to get its buffer
17613 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17614 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17616 /* Search backward from ROW for a row displaying a line that
17617 starts at a minimum position >= last_unchanged_pos_old. */
17618 for (; row
> first_text_row
; --row
)
17620 /* This used to abort, but it can happen.
17621 It is ok to just stop the search instead here. KFS. */
17622 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17625 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17630 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17636 /* Make sure that glyph rows in the current matrix of window W
17637 reference the same glyph memory as corresponding rows in the
17638 frame's frame matrix. This function is called after scrolling W's
17639 current matrix on a terminal frame in try_window_id and
17640 try_window_reusing_current_matrix. */
17643 sync_frame_with_window_matrix_rows (struct window
*w
)
17645 struct frame
*f
= XFRAME (w
->frame
);
17646 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17648 /* Preconditions: W must be a leaf window and full-width. Its frame
17649 must have a frame matrix. */
17650 eassert (BUFFERP (w
->contents
));
17651 eassert (WINDOW_FULL_WIDTH_P (w
));
17652 eassert (!FRAME_WINDOW_P (f
));
17654 /* If W is a full-width window, glyph pointers in W's current matrix
17655 have, by definition, to be the same as glyph pointers in the
17656 corresponding frame matrix. Note that frame matrices have no
17657 marginal areas (see build_frame_matrix). */
17658 window_row
= w
->current_matrix
->rows
;
17659 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17660 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17661 while (window_row
< window_row_end
)
17663 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17664 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17666 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17667 frame_row
->glyphs
[TEXT_AREA
] = start
;
17668 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17669 frame_row
->glyphs
[LAST_AREA
] = end
;
17671 /* Disable frame rows whose corresponding window rows have
17672 been disabled in try_window_id. */
17673 if (!window_row
->enabled_p
)
17674 frame_row
->enabled_p
= false;
17676 ++window_row
, ++frame_row
;
17681 /* Find the glyph row in window W containing CHARPOS. Consider all
17682 rows between START and END (not inclusive). END null means search
17683 all rows to the end of the display area of W. Value is the row
17684 containing CHARPOS or null. */
17687 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17688 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17690 struct glyph_row
*row
= start
;
17691 struct glyph_row
*best_row
= NULL
;
17692 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17695 /* If we happen to start on a header-line, skip that. */
17696 if (row
->mode_line_p
)
17699 if ((end
&& row
>= end
) || !row
->enabled_p
)
17702 last_y
= window_text_bottom_y (w
) - dy
;
17706 /* Give up if we have gone too far. */
17707 if (end
&& row
>= end
)
17709 /* This formerly returned if they were equal.
17710 I think that both quantities are of a "last plus one" type;
17711 if so, when they are equal, the row is within the screen. -- rms. */
17712 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17715 /* If it is in this row, return this row. */
17716 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17717 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17718 /* The end position of a row equals the start
17719 position of the next row. If CHARPOS is there, we
17720 would rather consider it displayed in the next
17721 line, except when this line ends in ZV. */
17722 && !row_for_charpos_p (row
, charpos
)))
17723 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17727 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17728 || (!best_row
&& !row
->continued_p
))
17730 /* In bidi-reordered rows, there could be several rows whose
17731 edges surround CHARPOS, all of these rows belonging to
17732 the same continued line. We need to find the row which
17733 fits CHARPOS the best. */
17734 for (g
= row
->glyphs
[TEXT_AREA
];
17735 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17738 if (!STRINGP (g
->object
))
17740 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17742 mindif
= eabs (g
->charpos
- charpos
);
17744 /* Exact match always wins. */
17751 else if (best_row
&& !row
->continued_p
)
17758 /* Try to redisplay window W by reusing its existing display. W's
17759 current matrix must be up to date when this function is called,
17760 i.e. window_end_valid must be nonzero.
17764 >= 1 if successful, i.e. display has been updated
17766 1 means the changes were in front of a newline that precedes
17767 the window start, and the whole current matrix was reused
17768 2 means the changes were after the last position displayed
17769 in the window, and the whole current matrix was reused
17770 3 means portions of the current matrix were reused, while
17771 some of the screen lines were redrawn
17772 -1 if redisplay with same window start is known not to succeed
17773 0 if otherwise unsuccessful
17775 The following steps are performed:
17777 1. Find the last row in the current matrix of W that is not
17778 affected by changes at the start of current_buffer. If no such row
17781 2. Find the first row in W's current matrix that is not affected by
17782 changes at the end of current_buffer. Maybe there is no such row.
17784 3. Display lines beginning with the row + 1 found in step 1 to the
17785 row found in step 2 or, if step 2 didn't find a row, to the end of
17788 4. If cursor is not known to appear on the window, give up.
17790 5. If display stopped at the row found in step 2, scroll the
17791 display and current matrix as needed.
17793 6. Maybe display some lines at the end of W, if we must. This can
17794 happen under various circumstances, like a partially visible line
17795 becoming fully visible, or because newly displayed lines are displayed
17796 in smaller font sizes.
17798 7. Update W's window end information. */
17801 try_window_id (struct window
*w
)
17803 struct frame
*f
= XFRAME (w
->frame
);
17804 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17805 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17806 struct glyph_row
*last_unchanged_at_beg_row
;
17807 struct glyph_row
*first_unchanged_at_end_row
;
17808 struct glyph_row
*row
;
17809 struct glyph_row
*bottom_row
;
17812 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17814 struct text_pos start_pos
;
17816 int first_unchanged_at_end_vpos
= 0;
17817 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17818 struct text_pos start
;
17819 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17822 if (inhibit_try_window_id
)
17826 /* This is handy for debugging. */
17828 #define GIVE_UP(X) \
17830 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17834 #define GIVE_UP(X) return 0
17837 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17839 /* Don't use this for mini-windows because these can show
17840 messages and mini-buffers, and we don't handle that here. */
17841 if (MINI_WINDOW_P (w
))
17844 /* This flag is used to prevent redisplay optimizations. */
17845 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17848 /* This function's optimizations cannot be used if overlays have
17849 changed in the buffer displayed by the window, so give up if they
17851 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17854 /* Verify that narrowing has not changed.
17855 Also verify that we were not told to prevent redisplay optimizations.
17856 It would be nice to further
17857 reduce the number of cases where this prevents try_window_id. */
17858 if (current_buffer
->clip_changed
17859 || current_buffer
->prevent_redisplay_optimizations_p
)
17862 /* Window must either use window-based redisplay or be full width. */
17863 if (!FRAME_WINDOW_P (f
)
17864 && (!FRAME_LINE_INS_DEL_OK (f
)
17865 || !WINDOW_FULL_WIDTH_P (w
)))
17868 /* Give up if point is known NOT to appear in W. */
17869 if (PT
< CHARPOS (start
))
17872 /* Another way to prevent redisplay optimizations. */
17873 if (w
->last_modified
== 0)
17876 /* Verify that window is not hscrolled. */
17877 if (w
->hscroll
!= 0)
17880 /* Verify that display wasn't paused. */
17881 if (!w
->window_end_valid
)
17884 /* Likewise if highlighting trailing whitespace. */
17885 if (!NILP (Vshow_trailing_whitespace
))
17888 /* Can't use this if overlay arrow position and/or string have
17890 if (overlay_arrows_changed_p ())
17893 /* When word-wrap is on, adding a space to the first word of a
17894 wrapped line can change the wrap position, altering the line
17895 above it. It might be worthwhile to handle this more
17896 intelligently, but for now just redisplay from scratch. */
17897 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17900 /* Under bidi reordering, adding or deleting a character in the
17901 beginning of a paragraph, before the first strong directional
17902 character, can change the base direction of the paragraph (unless
17903 the buffer specifies a fixed paragraph direction), which will
17904 require to redisplay the whole paragraph. It might be worthwhile
17905 to find the paragraph limits and widen the range of redisplayed
17906 lines to that, but for now just give up this optimization and
17907 redisplay from scratch. */
17908 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17909 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17912 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17913 only if buffer has really changed. The reason is that the gap is
17914 initially at Z for freshly visited files. The code below would
17915 set end_unchanged to 0 in that case. */
17916 if (MODIFF
> SAVE_MODIFF
17917 /* This seems to happen sometimes after saving a buffer. */
17918 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17920 if (GPT
- BEG
< BEG_UNCHANGED
)
17921 BEG_UNCHANGED
= GPT
- BEG
;
17922 if (Z
- GPT
< END_UNCHANGED
)
17923 END_UNCHANGED
= Z
- GPT
;
17926 /* The position of the first and last character that has been changed. */
17927 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17928 last_changed_charpos
= Z
- END_UNCHANGED
;
17930 /* If window starts after a line end, and the last change is in
17931 front of that newline, then changes don't affect the display.
17932 This case happens with stealth-fontification. Note that although
17933 the display is unchanged, glyph positions in the matrix have to
17934 be adjusted, of course. */
17935 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17936 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17937 && ((last_changed_charpos
< CHARPOS (start
)
17938 && CHARPOS (start
) == BEGV
)
17939 || (last_changed_charpos
< CHARPOS (start
) - 1
17940 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17942 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17943 struct glyph_row
*r0
;
17945 /* Compute how many chars/bytes have been added to or removed
17946 from the buffer. */
17947 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17948 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17949 Z_delta
= Z
- Z_old
;
17950 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17952 /* Give up if PT is not in the window. Note that it already has
17953 been checked at the start of try_window_id that PT is not in
17954 front of the window start. */
17955 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17958 /* If window start is unchanged, we can reuse the whole matrix
17959 as is, after adjusting glyph positions. No need to compute
17960 the window end again, since its offset from Z hasn't changed. */
17961 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17962 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17963 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17964 /* PT must not be in a partially visible line. */
17965 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17966 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17968 /* Adjust positions in the glyph matrix. */
17969 if (Z_delta
|| Z_delta_bytes
)
17971 struct glyph_row
*r1
17972 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17973 increment_matrix_positions (w
->current_matrix
,
17974 MATRIX_ROW_VPOS (r0
, current_matrix
),
17975 MATRIX_ROW_VPOS (r1
, current_matrix
),
17976 Z_delta
, Z_delta_bytes
);
17979 /* Set the cursor. */
17980 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17982 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17987 /* Handle the case that changes are all below what is displayed in
17988 the window, and that PT is in the window. This shortcut cannot
17989 be taken if ZV is visible in the window, and text has been added
17990 there that is visible in the window. */
17991 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17992 /* ZV is not visible in the window, or there are no
17993 changes at ZV, actually. */
17994 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17995 || first_changed_charpos
== last_changed_charpos
))
17997 struct glyph_row
*r0
;
17999 /* Give up if PT is not in the window. Note that it already has
18000 been checked at the start of try_window_id that PT is not in
18001 front of the window start. */
18002 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18005 /* If window start is unchanged, we can reuse the whole matrix
18006 as is, without changing glyph positions since no text has
18007 been added/removed in front of the window end. */
18008 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18009 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18010 /* PT must not be in a partially visible line. */
18011 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18012 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18014 /* We have to compute the window end anew since text
18015 could have been added/removed after it. */
18016 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18017 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18019 /* Set the cursor. */
18020 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18022 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18027 /* Give up if window start is in the changed area.
18029 The condition used to read
18031 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18033 but why that was tested escapes me at the moment. */
18034 if (CHARPOS (start
) >= first_changed_charpos
18035 && CHARPOS (start
) <= last_changed_charpos
)
18038 /* Check that window start agrees with the start of the first glyph
18039 row in its current matrix. Check this after we know the window
18040 start is not in changed text, otherwise positions would not be
18042 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18043 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18046 /* Give up if the window ends in strings. Overlay strings
18047 at the end are difficult to handle, so don't try. */
18048 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18049 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18052 /* Compute the position at which we have to start displaying new
18053 lines. Some of the lines at the top of the window might be
18054 reusable because they are not displaying changed text. Find the
18055 last row in W's current matrix not affected by changes at the
18056 start of current_buffer. Value is null if changes start in the
18057 first line of window. */
18058 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18059 if (last_unchanged_at_beg_row
)
18061 /* Avoid starting to display in the middle of a character, a TAB
18062 for instance. This is easier than to set up the iterator
18063 exactly, and it's not a frequent case, so the additional
18064 effort wouldn't really pay off. */
18065 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18066 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18067 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18068 --last_unchanged_at_beg_row
;
18070 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18073 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18075 start_pos
= it
.current
.pos
;
18077 /* Start displaying new lines in the desired matrix at the same
18078 vpos we would use in the current matrix, i.e. below
18079 last_unchanged_at_beg_row. */
18080 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18082 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18083 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18085 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18089 /* There are no reusable lines at the start of the window.
18090 Start displaying in the first text line. */
18091 start_display (&it
, w
, start
);
18092 it
.vpos
= it
.first_vpos
;
18093 start_pos
= it
.current
.pos
;
18096 /* Find the first row that is not affected by changes at the end of
18097 the buffer. Value will be null if there is no unchanged row, in
18098 which case we must redisplay to the end of the window. delta
18099 will be set to the value by which buffer positions beginning with
18100 first_unchanged_at_end_row have to be adjusted due to text
18102 first_unchanged_at_end_row
18103 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18104 IF_DEBUG (debug_delta
= delta
);
18105 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18107 /* Set stop_pos to the buffer position up to which we will have to
18108 display new lines. If first_unchanged_at_end_row != NULL, this
18109 is the buffer position of the start of the line displayed in that
18110 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18111 that we don't stop at a buffer position. */
18113 if (first_unchanged_at_end_row
)
18115 eassert (last_unchanged_at_beg_row
== NULL
18116 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18118 /* If this is a continuation line, move forward to the next one
18119 that isn't. Changes in lines above affect this line.
18120 Caution: this may move first_unchanged_at_end_row to a row
18121 not displaying text. */
18122 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18123 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18124 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18125 < it
.last_visible_y
))
18126 ++first_unchanged_at_end_row
;
18128 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18129 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18130 >= it
.last_visible_y
))
18131 first_unchanged_at_end_row
= NULL
;
18134 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18136 first_unchanged_at_end_vpos
18137 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18138 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18141 else if (last_unchanged_at_beg_row
== NULL
)
18147 /* Either there is no unchanged row at the end, or the one we have
18148 now displays text. This is a necessary condition for the window
18149 end pos calculation at the end of this function. */
18150 eassert (first_unchanged_at_end_row
== NULL
18151 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18153 debug_last_unchanged_at_beg_vpos
18154 = (last_unchanged_at_beg_row
18155 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18157 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18159 #endif /* GLYPH_DEBUG */
18162 /* Display new lines. Set last_text_row to the last new line
18163 displayed which has text on it, i.e. might end up as being the
18164 line where the window_end_vpos is. */
18165 w
->cursor
.vpos
= -1;
18166 last_text_row
= NULL
;
18167 overlay_arrow_seen
= 0;
18168 if (it
.current_y
< it
.last_visible_y
18169 && !f
->fonts_changed
18170 && (first_unchanged_at_end_row
== NULL
18171 || IT_CHARPOS (it
) < stop_pos
))
18172 it
.glyph_row
->reversed_p
= false;
18173 while (it
.current_y
< it
.last_visible_y
18174 && !f
->fonts_changed
18175 && (first_unchanged_at_end_row
== NULL
18176 || IT_CHARPOS (it
) < stop_pos
))
18178 if (display_line (&it
))
18179 last_text_row
= it
.glyph_row
- 1;
18182 if (f
->fonts_changed
)
18186 /* Compute differences in buffer positions, y-positions etc. for
18187 lines reused at the bottom of the window. Compute what we can
18189 if (first_unchanged_at_end_row
18190 /* No lines reused because we displayed everything up to the
18191 bottom of the window. */
18192 && it
.current_y
< it
.last_visible_y
)
18195 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18197 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18198 run
.current_y
= first_unchanged_at_end_row
->y
;
18199 run
.desired_y
= run
.current_y
+ dy
;
18200 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18204 delta
= delta_bytes
= dvpos
= dy
18205 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18206 first_unchanged_at_end_row
= NULL
;
18208 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18211 /* Find the cursor if not already found. We have to decide whether
18212 PT will appear on this window (it sometimes doesn't, but this is
18213 not a very frequent case.) This decision has to be made before
18214 the current matrix is altered. A value of cursor.vpos < 0 means
18215 that PT is either in one of the lines beginning at
18216 first_unchanged_at_end_row or below the window. Don't care for
18217 lines that might be displayed later at the window end; as
18218 mentioned, this is not a frequent case. */
18219 if (w
->cursor
.vpos
< 0)
18221 /* Cursor in unchanged rows at the top? */
18222 if (PT
< CHARPOS (start_pos
)
18223 && last_unchanged_at_beg_row
)
18225 row
= row_containing_pos (w
, PT
,
18226 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18227 last_unchanged_at_beg_row
+ 1, 0);
18229 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18232 /* Start from first_unchanged_at_end_row looking for PT. */
18233 else if (first_unchanged_at_end_row
)
18235 row
= row_containing_pos (w
, PT
- delta
,
18236 first_unchanged_at_end_row
, NULL
, 0);
18238 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18239 delta_bytes
, dy
, dvpos
);
18242 /* Give up if cursor was not found. */
18243 if (w
->cursor
.vpos
< 0)
18245 clear_glyph_matrix (w
->desired_matrix
);
18250 /* Don't let the cursor end in the scroll margins. */
18252 int this_scroll_margin
, cursor_height
;
18253 int frame_line_height
= default_line_pixel_height (w
);
18254 int window_total_lines
18255 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18257 this_scroll_margin
=
18258 max (0, min (scroll_margin
, window_total_lines
/ 4));
18259 this_scroll_margin
*= frame_line_height
;
18260 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18262 if ((w
->cursor
.y
< this_scroll_margin
18263 && CHARPOS (start
) > BEGV
)
18264 /* Old redisplay didn't take scroll margin into account at the bottom,
18265 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18266 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18267 ? cursor_height
+ this_scroll_margin
18268 : 1)) > it
.last_visible_y
)
18270 w
->cursor
.vpos
= -1;
18271 clear_glyph_matrix (w
->desired_matrix
);
18276 /* Scroll the display. Do it before changing the current matrix so
18277 that xterm.c doesn't get confused about where the cursor glyph is
18279 if (dy
&& run
.height
)
18283 if (FRAME_WINDOW_P (f
))
18285 FRAME_RIF (f
)->update_window_begin_hook (w
);
18286 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18287 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18288 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18292 /* Terminal frame. In this case, dvpos gives the number of
18293 lines to scroll by; dvpos < 0 means scroll up. */
18295 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18296 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18297 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18298 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18299 + window_internal_height (w
));
18301 #if defined (HAVE_GPM) || defined (MSDOS)
18302 x_clear_window_mouse_face (w
);
18304 /* Perform the operation on the screen. */
18307 /* Scroll last_unchanged_at_beg_row to the end of the
18308 window down dvpos lines. */
18309 set_terminal_window (f
, end
);
18311 /* On dumb terminals delete dvpos lines at the end
18312 before inserting dvpos empty lines. */
18313 if (!FRAME_SCROLL_REGION_OK (f
))
18314 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18316 /* Insert dvpos empty lines in front of
18317 last_unchanged_at_beg_row. */
18318 ins_del_lines (f
, from
, dvpos
);
18320 else if (dvpos
< 0)
18322 /* Scroll up last_unchanged_at_beg_vpos to the end of
18323 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18324 set_terminal_window (f
, end
);
18326 /* Delete dvpos lines in front of
18327 last_unchanged_at_beg_vpos. ins_del_lines will set
18328 the cursor to the given vpos and emit |dvpos| delete
18330 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18332 /* On a dumb terminal insert dvpos empty lines at the
18334 if (!FRAME_SCROLL_REGION_OK (f
))
18335 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18338 set_terminal_window (f
, 0);
18344 /* Shift reused rows of the current matrix to the right position.
18345 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18347 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18348 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18351 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18352 bottom_vpos
, dvpos
);
18353 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18356 else if (dvpos
> 0)
18358 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18359 bottom_vpos
, dvpos
);
18360 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18361 first_unchanged_at_end_vpos
+ dvpos
);
18364 /* For frame-based redisplay, make sure that current frame and window
18365 matrix are in sync with respect to glyph memory. */
18366 if (!FRAME_WINDOW_P (f
))
18367 sync_frame_with_window_matrix_rows (w
);
18369 /* Adjust buffer positions in reused rows. */
18370 if (delta
|| delta_bytes
)
18371 increment_matrix_positions (current_matrix
,
18372 first_unchanged_at_end_vpos
+ dvpos
,
18373 bottom_vpos
, delta
, delta_bytes
);
18375 /* Adjust Y positions. */
18377 shift_glyph_matrix (w
, current_matrix
,
18378 first_unchanged_at_end_vpos
+ dvpos
,
18381 if (first_unchanged_at_end_row
)
18383 first_unchanged_at_end_row
+= dvpos
;
18384 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18385 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18386 first_unchanged_at_end_row
= NULL
;
18389 /* If scrolling up, there may be some lines to display at the end of
18391 last_text_row_at_end
= NULL
;
18394 /* Scrolling up can leave for example a partially visible line
18395 at the end of the window to be redisplayed. */
18396 /* Set last_row to the glyph row in the current matrix where the
18397 window end line is found. It has been moved up or down in
18398 the matrix by dvpos. */
18399 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18400 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18402 /* If last_row is the window end line, it should display text. */
18403 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18405 /* If window end line was partially visible before, begin
18406 displaying at that line. Otherwise begin displaying with the
18407 line following it. */
18408 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18410 init_to_row_start (&it
, w
, last_row
);
18411 it
.vpos
= last_vpos
;
18412 it
.current_y
= last_row
->y
;
18416 init_to_row_end (&it
, w
, last_row
);
18417 it
.vpos
= 1 + last_vpos
;
18418 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18422 /* We may start in a continuation line. If so, we have to
18423 get the right continuation_lines_width and current_x. */
18424 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18425 it
.hpos
= it
.current_x
= 0;
18427 /* Display the rest of the lines at the window end. */
18428 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18429 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18431 /* Is it always sure that the display agrees with lines in
18432 the current matrix? I don't think so, so we mark rows
18433 displayed invalid in the current matrix by setting their
18434 enabled_p flag to zero. */
18435 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18436 if (display_line (&it
))
18437 last_text_row_at_end
= it
.glyph_row
- 1;
18441 /* Update window_end_pos and window_end_vpos. */
18442 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18444 /* Window end line if one of the preserved rows from the current
18445 matrix. Set row to the last row displaying text in current
18446 matrix starting at first_unchanged_at_end_row, after
18448 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18449 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18450 first_unchanged_at_end_row
);
18451 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18452 adjust_window_ends (w
, row
, 1);
18453 eassert (w
->window_end_bytepos
>= 0);
18454 IF_DEBUG (debug_method_add (w
, "A"));
18456 else if (last_text_row_at_end
)
18458 adjust_window_ends (w
, last_text_row_at_end
, 0);
18459 eassert (w
->window_end_bytepos
>= 0);
18460 IF_DEBUG (debug_method_add (w
, "B"));
18462 else if (last_text_row
)
18464 /* We have displayed either to the end of the window or at the
18465 end of the window, i.e. the last row with text is to be found
18466 in the desired matrix. */
18467 adjust_window_ends (w
, last_text_row
, 0);
18468 eassert (w
->window_end_bytepos
>= 0);
18470 else if (first_unchanged_at_end_row
== NULL
18471 && last_text_row
== NULL
18472 && last_text_row_at_end
== NULL
)
18474 /* Displayed to end of window, but no line containing text was
18475 displayed. Lines were deleted at the end of the window. */
18476 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18477 int vpos
= w
->window_end_vpos
;
18478 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18479 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18482 row
== NULL
&& vpos
>= first_vpos
;
18483 --vpos
, --current_row
, --desired_row
)
18485 if (desired_row
->enabled_p
)
18487 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18490 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18494 eassert (row
!= NULL
);
18495 w
->window_end_vpos
= vpos
+ 1;
18496 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18497 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18498 eassert (w
->window_end_bytepos
>= 0);
18499 IF_DEBUG (debug_method_add (w
, "C"));
18504 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18505 debug_end_vpos
= w
->window_end_vpos
));
18507 /* Record that display has not been completed. */
18508 w
->window_end_valid
= 0;
18509 w
->desired_matrix
->no_scrolling_p
= 1;
18517 /***********************************************************************
18518 More debugging support
18519 ***********************************************************************/
18523 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18524 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18525 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18528 /* Dump the contents of glyph matrix MATRIX on stderr.
18530 GLYPHS 0 means don't show glyph contents.
18531 GLYPHS 1 means show glyphs in short form
18532 GLYPHS > 1 means show glyphs in long form. */
18535 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18538 for (i
= 0; i
< matrix
->nrows
; ++i
)
18539 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18543 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18544 the glyph row and area where the glyph comes from. */
18547 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18549 if (glyph
->type
== CHAR_GLYPH
18550 || glyph
->type
== GLYPHLESS_GLYPH
)
18553 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18554 glyph
- row
->glyphs
[TEXT_AREA
],
18555 (glyph
->type
== CHAR_GLYPH
18559 (BUFFERP (glyph
->object
)
18561 : (STRINGP (glyph
->object
)
18563 : (NILP (glyph
->object
)
18566 glyph
->pixel_width
,
18568 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18572 glyph
->left_box_line_p
,
18573 glyph
->right_box_line_p
);
18575 else if (glyph
->type
== STRETCH_GLYPH
)
18578 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18579 glyph
- row
->glyphs
[TEXT_AREA
],
18582 (BUFFERP (glyph
->object
)
18584 : (STRINGP (glyph
->object
)
18586 : (NILP (glyph
->object
)
18589 glyph
->pixel_width
,
18593 glyph
->left_box_line_p
,
18594 glyph
->right_box_line_p
);
18596 else if (glyph
->type
== IMAGE_GLYPH
)
18599 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18600 glyph
- row
->glyphs
[TEXT_AREA
],
18603 (BUFFERP (glyph
->object
)
18605 : (STRINGP (glyph
->object
)
18607 : (NILP (glyph
->object
)
18610 glyph
->pixel_width
,
18614 glyph
->left_box_line_p
,
18615 glyph
->right_box_line_p
);
18617 else if (glyph
->type
== COMPOSITE_GLYPH
)
18620 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18621 glyph
- row
->glyphs
[TEXT_AREA
],
18624 (BUFFERP (glyph
->object
)
18626 : (STRINGP (glyph
->object
)
18628 : (NILP (glyph
->object
)
18631 glyph
->pixel_width
,
18633 if (glyph
->u
.cmp
.automatic
)
18636 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18637 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18639 glyph
->left_box_line_p
,
18640 glyph
->right_box_line_p
);
18642 #ifdef HAVE_XWIDGETS
18643 else if (glyph
->type
== XWIDGET_GLYPH
)
18646 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18647 glyph
- row
->glyphs
[TEXT_AREA
],
18650 (BUFFERP (glyph
->object
)
18652 : (STRINGP (glyph
->object
)
18655 glyph
->pixel_width
,
18659 glyph
->left_box_line_p
,
18660 glyph
->right_box_line_p
);
18667 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18668 GLYPHS 0 means don't show glyph contents.
18669 GLYPHS 1 means show glyphs in short form
18670 GLYPHS > 1 means show glyphs in long form. */
18673 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18677 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18678 fprintf (stderr
, "==============================================================================\n");
18680 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18681 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18683 MATRIX_ROW_START_CHARPOS (row
),
18684 MATRIX_ROW_END_CHARPOS (row
),
18685 row
->used
[TEXT_AREA
],
18686 row
->contains_overlapping_glyphs_p
,
18688 row
->truncated_on_left_p
,
18689 row
->truncated_on_right_p
,
18691 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18692 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18695 row
->ends_in_middle_of_char_p
,
18696 row
->starts_in_middle_of_char_p
,
18702 row
->visible_height
,
18705 /* The next 3 lines should align to "Start" in the header. */
18706 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18707 row
->end
.overlay_string_index
,
18708 row
->continuation_lines_width
);
18709 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18710 CHARPOS (row
->start
.string_pos
),
18711 CHARPOS (row
->end
.string_pos
));
18712 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18713 row
->end
.dpvec_index
);
18720 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18722 struct glyph
*glyph
= row
->glyphs
[area
];
18723 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18725 /* Glyph for a line end in text. */
18726 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18729 if (glyph
< glyph_end
)
18730 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18732 for (; glyph
< glyph_end
; ++glyph
)
18733 dump_glyph (row
, glyph
, area
);
18736 else if (glyphs
== 1)
18739 char s
[SHRT_MAX
+ 4];
18741 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18745 for (i
= 0; i
< row
->used
[area
]; ++i
)
18747 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18748 if (i
== row
->used
[area
] - 1
18749 && area
== TEXT_AREA
18750 && NILP (glyph
->object
)
18751 && glyph
->type
== CHAR_GLYPH
18752 && glyph
->u
.ch
== ' ')
18754 strcpy (&s
[i
], "[\\n]");
18757 else if (glyph
->type
== CHAR_GLYPH
18758 && glyph
->u
.ch
< 0x80
18759 && glyph
->u
.ch
>= ' ')
18760 s
[i
] = glyph
->u
.ch
;
18766 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18772 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18773 Sdump_glyph_matrix
, 0, 1, "p",
18774 doc
: /* Dump the current matrix of the selected window to stderr.
18775 Shows contents of glyph row structures. With non-nil
18776 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18777 glyphs in short form, otherwise show glyphs in long form.
18779 Interactively, no argument means show glyphs in short form;
18780 with numeric argument, its value is passed as the GLYPHS flag. */)
18781 (Lisp_Object glyphs
)
18783 struct window
*w
= XWINDOW (selected_window
);
18784 struct buffer
*buffer
= XBUFFER (w
->contents
);
18786 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18787 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18788 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18789 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18790 fprintf (stderr
, "=============================================\n");
18791 dump_glyph_matrix (w
->current_matrix
,
18792 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18797 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18798 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18799 Only text-mode frames have frame glyph matrices. */)
18802 struct frame
*f
= XFRAME (selected_frame
);
18804 if (f
->current_matrix
)
18805 dump_glyph_matrix (f
->current_matrix
, 1);
18807 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18812 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18813 doc
: /* Dump glyph row ROW to stderr.
18814 GLYPH 0 means don't dump glyphs.
18815 GLYPH 1 means dump glyphs in short form.
18816 GLYPH > 1 or omitted means dump glyphs in long form. */)
18817 (Lisp_Object row
, Lisp_Object glyphs
)
18819 struct glyph_matrix
*matrix
;
18822 CHECK_NUMBER (row
);
18823 matrix
= XWINDOW (selected_window
)->current_matrix
;
18825 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18826 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18828 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18833 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18834 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18835 GLYPH 0 means don't dump glyphs.
18836 GLYPH 1 means dump glyphs in short form.
18837 GLYPH > 1 or omitted means dump glyphs in long form.
18839 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18841 (Lisp_Object row
, Lisp_Object glyphs
)
18843 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18844 struct frame
*sf
= SELECTED_FRAME ();
18845 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18848 CHECK_NUMBER (row
);
18850 if (vpos
>= 0 && vpos
< m
->nrows
)
18851 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18852 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18858 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18859 doc
: /* Toggle tracing of redisplay.
18860 With ARG, turn tracing on if and only if ARG is positive. */)
18864 trace_redisplay_p
= !trace_redisplay_p
;
18867 arg
= Fprefix_numeric_value (arg
);
18868 trace_redisplay_p
= XINT (arg
) > 0;
18875 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18876 doc
: /* Like `format', but print result to stderr.
18877 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18878 (ptrdiff_t nargs
, Lisp_Object
*args
)
18880 Lisp_Object s
= Fformat (nargs
, args
);
18881 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18885 #endif /* GLYPH_DEBUG */
18889 /***********************************************************************
18890 Building Desired Matrix Rows
18891 ***********************************************************************/
18893 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18894 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18896 static struct glyph_row
*
18897 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18899 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18900 struct buffer
*buffer
= XBUFFER (w
->contents
);
18901 struct buffer
*old
= current_buffer
;
18902 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18903 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18904 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18905 const unsigned char *p
;
18908 int n_glyphs_before
;
18910 set_buffer_temp (buffer
);
18911 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18912 scratch_glyph_row
.reversed_p
= false;
18913 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18914 SET_TEXT_POS (it
.position
, 0, 0);
18916 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18918 while (p
< arrow_end
)
18920 Lisp_Object face
, ilisp
;
18922 /* Get the next character. */
18924 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18927 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18928 if (! ASCII_CHAR_P (it
.c
))
18929 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18933 /* Get its face. */
18934 ilisp
= make_number (p
- arrow_string
);
18935 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18936 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18938 /* Compute its width, get its glyphs. */
18939 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18940 SET_TEXT_POS (it
.position
, -1, -1);
18941 PRODUCE_GLYPHS (&it
);
18943 /* If this character doesn't fit any more in the line, we have
18944 to remove some glyphs. */
18945 if (it
.current_x
> it
.last_visible_x
)
18947 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18952 set_buffer_temp (old
);
18953 return it
.glyph_row
;
18957 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18958 glyphs to insert is determined by produce_special_glyphs. */
18961 insert_left_trunc_glyphs (struct it
*it
)
18963 struct it truncate_it
;
18964 struct glyph
*from
, *end
, *to
, *toend
;
18966 eassert (!FRAME_WINDOW_P (it
->f
)
18967 || (!it
->glyph_row
->reversed_p
18968 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18969 || (it
->glyph_row
->reversed_p
18970 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18972 /* Get the truncation glyphs. */
18974 truncate_it
.current_x
= 0;
18975 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18976 truncate_it
.glyph_row
= &scratch_glyph_row
;
18977 truncate_it
.area
= TEXT_AREA
;
18978 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18979 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18980 truncate_it
.object
= Qnil
;
18981 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18983 /* Overwrite glyphs from IT with truncation glyphs. */
18984 if (!it
->glyph_row
->reversed_p
)
18986 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18988 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18989 end
= from
+ tused
;
18990 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18991 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18992 if (FRAME_WINDOW_P (it
->f
))
18994 /* On GUI frames, when variable-size fonts are displayed,
18995 the truncation glyphs may need more pixels than the row's
18996 glyphs they overwrite. We overwrite more glyphs to free
18997 enough screen real estate, and enlarge the stretch glyph
18998 on the right (see display_line), if there is one, to
18999 preserve the screen position of the truncation glyphs on
19002 struct glyph
*g
= to
;
19005 /* The first glyph could be partially visible, in which case
19006 it->glyph_row->x will be negative. But we want the left
19007 truncation glyphs to be aligned at the left margin of the
19008 window, so we override the x coordinate at which the row
19010 it
->glyph_row
->x
= 0;
19011 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19013 w
+= g
->pixel_width
;
19016 if (g
- to
- tused
> 0)
19018 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19019 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19021 used
= it
->glyph_row
->used
[TEXT_AREA
];
19022 if (it
->glyph_row
->truncated_on_right_p
19023 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19024 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19027 int extra
= w
- it
->truncation_pixel_width
;
19029 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19036 /* There may be padding glyphs left over. Overwrite them too. */
19037 if (!FRAME_WINDOW_P (it
->f
))
19039 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19041 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19048 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19052 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19054 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19055 that back to front. */
19056 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19057 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19058 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19059 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19060 if (FRAME_WINDOW_P (it
->f
))
19063 struct glyph
*g
= to
;
19065 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19067 w
+= g
->pixel_width
;
19070 if (to
- g
- tused
> 0)
19072 if (it
->glyph_row
->truncated_on_right_p
19073 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19074 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19076 int extra
= w
- it
->truncation_pixel_width
;
19078 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19082 while (from
>= end
&& to
>= toend
)
19084 if (!FRAME_WINDOW_P (it
->f
))
19086 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19089 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19090 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19091 while (from
>= end
&& to
>= toend
)
19097 /* Need to free some room before prepending additional
19099 int move_by
= from
- end
+ 1;
19100 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19101 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19103 for ( ; g
>= g0
; g
--)
19105 while (from
>= end
)
19107 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19112 /* Compute the hash code for ROW. */
19114 row_hash (struct glyph_row
*row
)
19117 unsigned hashval
= 0;
19119 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19120 for (k
= 0; k
< row
->used
[area
]; ++k
)
19121 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19122 + row
->glyphs
[area
][k
].u
.val
19123 + row
->glyphs
[area
][k
].face_id
19124 + row
->glyphs
[area
][k
].padding_p
19125 + (row
->glyphs
[area
][k
].type
<< 2));
19130 /* Compute the pixel height and width of IT->glyph_row.
19132 Most of the time, ascent and height of a display line will be equal
19133 to the max_ascent and max_height values of the display iterator
19134 structure. This is not the case if
19136 1. We hit ZV without displaying anything. In this case, max_ascent
19137 and max_height will be zero.
19139 2. We have some glyphs that don't contribute to the line height.
19140 (The glyph row flag contributes_to_line_height_p is for future
19141 pixmap extensions).
19143 The first case is easily covered by using default values because in
19144 these cases, the line height does not really matter, except that it
19145 must not be zero. */
19148 compute_line_metrics (struct it
*it
)
19150 struct glyph_row
*row
= it
->glyph_row
;
19152 if (FRAME_WINDOW_P (it
->f
))
19154 int i
, min_y
, max_y
;
19156 /* The line may consist of one space only, that was added to
19157 place the cursor on it. If so, the row's height hasn't been
19159 if (row
->height
== 0)
19161 if (it
->max_ascent
+ it
->max_descent
== 0)
19162 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19163 row
->ascent
= it
->max_ascent
;
19164 row
->height
= it
->max_ascent
+ it
->max_descent
;
19165 row
->phys_ascent
= it
->max_phys_ascent
;
19166 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19167 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19170 /* Compute the width of this line. */
19171 row
->pixel_width
= row
->x
;
19172 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19173 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19175 eassert (row
->pixel_width
>= 0);
19176 eassert (row
->ascent
>= 0 && row
->height
> 0);
19178 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19179 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19181 /* If first line's physical ascent is larger than its logical
19182 ascent, use the physical ascent, and make the row taller.
19183 This makes accented characters fully visible. */
19184 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19185 && row
->phys_ascent
> row
->ascent
)
19187 row
->height
+= row
->phys_ascent
- row
->ascent
;
19188 row
->ascent
= row
->phys_ascent
;
19191 /* Compute how much of the line is visible. */
19192 row
->visible_height
= row
->height
;
19194 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19195 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19197 if (row
->y
< min_y
)
19198 row
->visible_height
-= min_y
- row
->y
;
19199 if (row
->y
+ row
->height
> max_y
)
19200 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19204 row
->pixel_width
= row
->used
[TEXT_AREA
];
19205 if (row
->continued_p
)
19206 row
->pixel_width
-= it
->continuation_pixel_width
;
19207 else if (row
->truncated_on_right_p
)
19208 row
->pixel_width
-= it
->truncation_pixel_width
;
19209 row
->ascent
= row
->phys_ascent
= 0;
19210 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19211 row
->extra_line_spacing
= 0;
19214 /* Compute a hash code for this row. */
19215 row
->hash
= row_hash (row
);
19217 it
->max_ascent
= it
->max_descent
= 0;
19218 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19222 /* Append one space to the glyph row of iterator IT if doing a
19223 window-based redisplay. The space has the same face as
19224 IT->face_id. Value is non-zero if a space was added.
19226 This function is called to make sure that there is always one glyph
19227 at the end of a glyph row that the cursor can be set on under
19228 window-systems. (If there weren't such a glyph we would not know
19229 how wide and tall a box cursor should be displayed).
19231 At the same time this space let's a nicely handle clearing to the
19232 end of the line if the row ends in italic text. */
19235 append_space_for_newline (struct it
*it
, int default_face_p
)
19237 if (FRAME_WINDOW_P (it
->f
))
19239 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19241 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19242 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19244 /* Save some values that must not be changed.
19245 Must save IT->c and IT->len because otherwise
19246 ITERATOR_AT_END_P wouldn't work anymore after
19247 append_space_for_newline has been called. */
19248 enum display_element_type saved_what
= it
->what
;
19249 int saved_c
= it
->c
, saved_len
= it
->len
;
19250 int saved_char_to_display
= it
->char_to_display
;
19251 int saved_x
= it
->current_x
;
19252 int saved_face_id
= it
->face_id
;
19253 int saved_box_end
= it
->end_of_box_run_p
;
19254 struct text_pos saved_pos
;
19255 Lisp_Object saved_object
;
19258 saved_object
= it
->object
;
19259 saved_pos
= it
->position
;
19261 it
->what
= IT_CHARACTER
;
19262 memset (&it
->position
, 0, sizeof it
->position
);
19264 it
->c
= it
->char_to_display
= ' ';
19267 /* If the default face was remapped, be sure to use the
19268 remapped face for the appended newline. */
19269 if (default_face_p
)
19270 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19271 else if (it
->face_before_selective_p
)
19272 it
->face_id
= it
->saved_face_id
;
19273 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19274 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19275 /* In R2L rows, we will prepend a stretch glyph that will
19276 have the end_of_box_run_p flag set for it, so there's no
19277 need for the appended newline glyph to have that flag
19279 if (it
->glyph_row
->reversed_p
19280 /* But if the appended newline glyph goes all the way to
19281 the end of the row, there will be no stretch glyph,
19282 so leave the box flag set. */
19283 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19284 it
->end_of_box_run_p
= 0;
19286 PRODUCE_GLYPHS (it
);
19288 it
->override_ascent
= -1;
19289 it
->constrain_row_ascent_descent_p
= 0;
19290 it
->current_x
= saved_x
;
19291 it
->object
= saved_object
;
19292 it
->position
= saved_pos
;
19293 it
->what
= saved_what
;
19294 it
->face_id
= saved_face_id
;
19295 it
->len
= saved_len
;
19297 it
->char_to_display
= saved_char_to_display
;
19298 it
->end_of_box_run_p
= saved_box_end
;
19307 /* Extend the face of the last glyph in the text area of IT->glyph_row
19308 to the end of the display line. Called from display_line. If the
19309 glyph row is empty, add a space glyph to it so that we know the
19310 face to draw. Set the glyph row flag fill_line_p. If the glyph
19311 row is R2L, prepend a stretch glyph to cover the empty space to the
19312 left of the leftmost glyph. */
19315 extend_face_to_end_of_line (struct it
*it
)
19317 struct face
*face
, *default_face
;
19318 struct frame
*f
= it
->f
;
19320 /* If line is already filled, do nothing. Non window-system frames
19321 get a grace of one more ``pixel'' because their characters are
19322 1-``pixel'' wide, so they hit the equality too early. This grace
19323 is needed only for R2L rows that are not continued, to produce
19324 one extra blank where we could display the cursor. */
19325 if ((it
->current_x
>= it
->last_visible_x
19326 + (!FRAME_WINDOW_P (f
)
19327 && it
->glyph_row
->reversed_p
19328 && !it
->glyph_row
->continued_p
))
19329 /* If the window has display margins, we will need to extend
19330 their face even if the text area is filled. */
19331 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19332 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19335 /* The default face, possibly remapped. */
19336 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19338 /* Face extension extends the background and box of IT->face_id
19339 to the end of the line. If the background equals the background
19340 of the frame, we don't have to do anything. */
19341 if (it
->face_before_selective_p
)
19342 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19344 face
= FACE_FROM_ID (f
, it
->face_id
);
19346 if (FRAME_WINDOW_P (f
)
19347 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19348 && face
->box
== FACE_NO_BOX
19349 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19350 #ifdef HAVE_WINDOW_SYSTEM
19353 && !it
->glyph_row
->reversed_p
)
19356 /* Set the glyph row flag indicating that the face of the last glyph
19357 in the text area has to be drawn to the end of the text area. */
19358 it
->glyph_row
->fill_line_p
= 1;
19360 /* If current character of IT is not ASCII, make sure we have the
19361 ASCII face. This will be automatically undone the next time
19362 get_next_display_element returns a multibyte character. Note
19363 that the character will always be single byte in unibyte
19365 if (!ASCII_CHAR_P (it
->c
))
19367 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19370 if (FRAME_WINDOW_P (f
))
19372 /* If the row is empty, add a space with the current face of IT,
19373 so that we know which face to draw. */
19374 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19376 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19377 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19378 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19380 /* Mode line and the header line don't have margins, and
19381 likewise the frame's tool-bar window, if there is any. */
19382 if (!(it
->glyph_row
->mode_line_p
19383 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19384 || (WINDOWP (f
->tool_bar_window
)
19385 && it
->w
== XWINDOW (f
->tool_bar_window
))
19389 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19390 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19392 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19393 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19395 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19397 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19398 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19400 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19401 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19403 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19406 #ifdef HAVE_WINDOW_SYSTEM
19407 if (it
->glyph_row
->reversed_p
)
19409 /* Prepend a stretch glyph to the row, such that the
19410 rightmost glyph will be drawn flushed all the way to the
19411 right margin of the window. The stretch glyph that will
19412 occupy the empty space, if any, to the left of the
19414 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19415 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19416 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19418 int row_width
, stretch_ascent
, stretch_width
;
19419 struct text_pos saved_pos
;
19420 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19422 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19423 row_width
+= g
->pixel_width
;
19425 /* FIXME: There are various minor display glitches in R2L
19426 rows when only one of the fringes is missing. The
19427 strange condition below produces the least bad effect. */
19428 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19429 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19430 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19431 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19433 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19434 stretch_width
-= row_width
;
19436 if (stretch_width
> 0)
19439 (((it
->ascent
+ it
->descent
)
19440 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19441 saved_pos
= it
->position
;
19442 memset (&it
->position
, 0, sizeof it
->position
);
19443 saved_avoid_cursor
= it
->avoid_cursor_p
;
19444 it
->avoid_cursor_p
= 1;
19445 saved_face_id
= it
->face_id
;
19446 saved_box_start
= it
->start_of_box_run_p
;
19447 /* The last row's stretch glyph should get the default
19448 face, to avoid painting the rest of the window with
19449 the region face, if the region ends at ZV. */
19450 if (it
->glyph_row
->ends_at_zv_p
)
19451 it
->face_id
= default_face
->id
;
19453 it
->face_id
= face
->id
;
19454 it
->start_of_box_run_p
= 0;
19455 append_stretch_glyph (it
, Qnil
, stretch_width
,
19456 it
->ascent
+ it
->descent
, stretch_ascent
);
19457 it
->position
= saved_pos
;
19458 it
->avoid_cursor_p
= saved_avoid_cursor
;
19459 it
->face_id
= saved_face_id
;
19460 it
->start_of_box_run_p
= saved_box_start
;
19462 /* If stretch_width comes out negative, it means that the
19463 last glyph is only partially visible. In R2L rows, we
19464 want the leftmost glyph to be partially visible, so we
19465 need to give the row the corresponding left offset. */
19466 if (stretch_width
< 0)
19467 it
->glyph_row
->x
= stretch_width
;
19469 #endif /* HAVE_WINDOW_SYSTEM */
19473 /* Save some values that must not be changed. */
19474 int saved_x
= it
->current_x
;
19475 struct text_pos saved_pos
;
19476 Lisp_Object saved_object
;
19477 enum display_element_type saved_what
= it
->what
;
19478 int saved_face_id
= it
->face_id
;
19480 saved_object
= it
->object
;
19481 saved_pos
= it
->position
;
19483 it
->what
= IT_CHARACTER
;
19484 memset (&it
->position
, 0, sizeof it
->position
);
19486 it
->c
= it
->char_to_display
= ' ';
19489 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19490 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19491 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19492 && !it
->glyph_row
->mode_line_p
19493 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19495 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19496 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19498 for (it
->current_x
= 0; g
< e
; g
++)
19499 it
->current_x
+= g
->pixel_width
;
19501 it
->area
= LEFT_MARGIN_AREA
;
19502 it
->face_id
= default_face
->id
;
19503 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19504 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19506 PRODUCE_GLYPHS (it
);
19507 /* term.c:produce_glyphs advances it->current_x only for
19509 it
->current_x
+= it
->pixel_width
;
19512 it
->current_x
= saved_x
;
19513 it
->area
= TEXT_AREA
;
19516 /* The last row's blank glyphs should get the default face, to
19517 avoid painting the rest of the window with the region face,
19518 if the region ends at ZV. */
19519 if (it
->glyph_row
->ends_at_zv_p
)
19520 it
->face_id
= default_face
->id
;
19522 it
->face_id
= face
->id
;
19523 PRODUCE_GLYPHS (it
);
19525 while (it
->current_x
<= it
->last_visible_x
)
19526 PRODUCE_GLYPHS (it
);
19528 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19529 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19530 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19531 && !it
->glyph_row
->mode_line_p
19532 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19534 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19535 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19537 for ( ; g
< e
; g
++)
19538 it
->current_x
+= g
->pixel_width
;
19540 it
->area
= RIGHT_MARGIN_AREA
;
19541 it
->face_id
= default_face
->id
;
19542 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19543 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19545 PRODUCE_GLYPHS (it
);
19546 it
->current_x
+= it
->pixel_width
;
19549 it
->area
= TEXT_AREA
;
19552 /* Don't count these blanks really. It would let us insert a left
19553 truncation glyph below and make us set the cursor on them, maybe. */
19554 it
->current_x
= saved_x
;
19555 it
->object
= saved_object
;
19556 it
->position
= saved_pos
;
19557 it
->what
= saved_what
;
19558 it
->face_id
= saved_face_id
;
19563 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19564 trailing whitespace. */
19567 trailing_whitespace_p (ptrdiff_t charpos
)
19569 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19572 while (bytepos
< ZV_BYTE
19573 && (c
= FETCH_CHAR (bytepos
),
19574 c
== ' ' || c
== '\t'))
19577 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19579 if (bytepos
!= PT_BYTE
)
19586 /* Highlight trailing whitespace, if any, in ROW. */
19589 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19591 int used
= row
->used
[TEXT_AREA
];
19595 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19596 struct glyph
*glyph
= start
+ used
- 1;
19598 if (row
->reversed_p
)
19600 /* Right-to-left rows need to be processed in the opposite
19601 direction, so swap the edge pointers. */
19603 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19606 /* Skip over glyphs inserted to display the cursor at the
19607 end of a line, for extending the face of the last glyph
19608 to the end of the line on terminals, and for truncation
19609 and continuation glyphs. */
19610 if (!row
->reversed_p
)
19612 while (glyph
>= start
19613 && glyph
->type
== CHAR_GLYPH
19614 && NILP (glyph
->object
))
19619 while (glyph
<= start
19620 && glyph
->type
== CHAR_GLYPH
19621 && NILP (glyph
->object
))
19625 /* If last glyph is a space or stretch, and it's trailing
19626 whitespace, set the face of all trailing whitespace glyphs in
19627 IT->glyph_row to `trailing-whitespace'. */
19628 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19629 && BUFFERP (glyph
->object
)
19630 && (glyph
->type
== STRETCH_GLYPH
19631 || (glyph
->type
== CHAR_GLYPH
19632 && glyph
->u
.ch
== ' '))
19633 && trailing_whitespace_p (glyph
->charpos
))
19635 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19639 if (!row
->reversed_p
)
19641 while (glyph
>= start
19642 && BUFFERP (glyph
->object
)
19643 && (glyph
->type
== STRETCH_GLYPH
19644 || (glyph
->type
== CHAR_GLYPH
19645 && glyph
->u
.ch
== ' ')))
19646 (glyph
--)->face_id
= face_id
;
19650 while (glyph
<= start
19651 && BUFFERP (glyph
->object
)
19652 && (glyph
->type
== STRETCH_GLYPH
19653 || (glyph
->type
== CHAR_GLYPH
19654 && glyph
->u
.ch
== ' ')))
19655 (glyph
++)->face_id
= face_id
;
19662 /* Value is non-zero if glyph row ROW should be
19663 considered to hold the buffer position CHARPOS. */
19666 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19670 if (charpos
== CHARPOS (row
->end
.pos
)
19671 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19673 /* Suppose the row ends on a string.
19674 Unless the row is continued, that means it ends on a newline
19675 in the string. If it's anything other than a display string
19676 (e.g., a before-string from an overlay), we don't want the
19677 cursor there. (This heuristic seems to give the optimal
19678 behavior for the various types of multi-line strings.)
19679 One exception: if the string has `cursor' property on one of
19680 its characters, we _do_ want the cursor there. */
19681 if (CHARPOS (row
->end
.string_pos
) >= 0)
19683 if (row
->continued_p
)
19687 /* Check for `display' property. */
19688 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19689 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19690 struct glyph
*glyph
;
19693 for (glyph
= end
; glyph
>= beg
; --glyph
)
19694 if (STRINGP (glyph
->object
))
19697 = Fget_char_property (make_number (charpos
),
19701 && display_prop_string_p (prop
, glyph
->object
));
19702 /* If there's a `cursor' property on one of the
19703 string's characters, this row is a cursor row,
19704 even though this is not a display string. */
19707 Lisp_Object s
= glyph
->object
;
19709 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19711 ptrdiff_t gpos
= glyph
->charpos
;
19713 if (!NILP (Fget_char_property (make_number (gpos
),
19725 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19727 /* If the row ends in middle of a real character,
19728 and the line is continued, we want the cursor here.
19729 That's because CHARPOS (ROW->end.pos) would equal
19730 PT if PT is before the character. */
19731 if (!row
->ends_in_ellipsis_p
)
19732 result
= row
->continued_p
;
19734 /* If the row ends in an ellipsis, then
19735 CHARPOS (ROW->end.pos) will equal point after the
19736 invisible text. We want that position to be displayed
19737 after the ellipsis. */
19740 /* If the row ends at ZV, display the cursor at the end of that
19741 row instead of at the start of the row below. */
19742 else if (row
->ends_at_zv_p
)
19751 /* Value is non-zero if glyph row ROW should be
19752 used to hold the cursor. */
19755 cursor_row_p (struct glyph_row
*row
)
19757 return row_for_charpos_p (row
, PT
);
19762 /* Push the property PROP so that it will be rendered at the current
19763 position in IT. Return 1 if PROP was successfully pushed, 0
19764 otherwise. Called from handle_line_prefix to handle the
19765 `line-prefix' and `wrap-prefix' properties. */
19768 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19770 struct text_pos pos
=
19771 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19773 eassert (it
->method
== GET_FROM_BUFFER
19774 || it
->method
== GET_FROM_DISPLAY_VECTOR
19775 || it
->method
== GET_FROM_STRING
);
19777 /* We need to save the current buffer/string position, so it will be
19778 restored by pop_it, because iterate_out_of_display_property
19779 depends on that being set correctly, but some situations leave
19780 it->position not yet set when this function is called. */
19781 push_it (it
, &pos
);
19783 if (STRINGP (prop
))
19785 if (SCHARS (prop
) == 0)
19792 it
->string_from_prefix_prop_p
= 1;
19793 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19794 it
->current
.overlay_string_index
= -1;
19795 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19796 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19797 it
->method
= GET_FROM_STRING
;
19798 it
->stop_charpos
= 0;
19800 it
->base_level_stop
= 0;
19802 /* Force paragraph direction to be that of the parent
19804 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19805 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19807 it
->paragraph_embedding
= L2R
;
19809 /* Set up the bidi iterator for this display string. */
19812 it
->bidi_it
.string
.lstring
= it
->string
;
19813 it
->bidi_it
.string
.s
= NULL
;
19814 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19815 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19816 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19817 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19818 it
->bidi_it
.w
= it
->w
;
19819 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19822 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19824 it
->method
= GET_FROM_STRETCH
;
19827 #ifdef HAVE_WINDOW_SYSTEM
19828 else if (IMAGEP (prop
))
19830 it
->what
= IT_IMAGE
;
19831 it
->image_id
= lookup_image (it
->f
, prop
);
19832 it
->method
= GET_FROM_IMAGE
;
19834 #endif /* HAVE_WINDOW_SYSTEM */
19837 pop_it (it
); /* bogus display property, give up */
19844 /* Return the character-property PROP at the current position in IT. */
19847 get_it_property (struct it
*it
, Lisp_Object prop
)
19849 Lisp_Object position
, object
= it
->object
;
19851 if (STRINGP (object
))
19852 position
= make_number (IT_STRING_CHARPOS (*it
));
19853 else if (BUFFERP (object
))
19855 position
= make_number (IT_CHARPOS (*it
));
19856 object
= it
->window
;
19861 return Fget_char_property (position
, prop
, object
);
19864 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19867 handle_line_prefix (struct it
*it
)
19869 Lisp_Object prefix
;
19871 if (it
->continuation_lines_width
> 0)
19873 prefix
= get_it_property (it
, Qwrap_prefix
);
19875 prefix
= Vwrap_prefix
;
19879 prefix
= get_it_property (it
, Qline_prefix
);
19881 prefix
= Vline_prefix
;
19883 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19885 /* If the prefix is wider than the window, and we try to wrap
19886 it, it would acquire its own wrap prefix, and so on till the
19887 iterator stack overflows. So, don't wrap the prefix. */
19888 it
->line_wrap
= TRUNCATE
;
19889 it
->avoid_cursor_p
= 1;
19895 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19896 only for R2L lines from display_line and display_string, when they
19897 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19898 the line/string needs to be continued on the next glyph row. */
19900 unproduce_glyphs (struct it
*it
, int n
)
19902 struct glyph
*glyph
, *end
;
19904 eassert (it
->glyph_row
);
19905 eassert (it
->glyph_row
->reversed_p
);
19906 eassert (it
->area
== TEXT_AREA
);
19907 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19909 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19910 n
= it
->glyph_row
->used
[TEXT_AREA
];
19911 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19912 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19913 for ( ; glyph
< end
; glyph
++)
19914 glyph
[-n
] = *glyph
;
19917 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19918 and ROW->maxpos. */
19920 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19921 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19922 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19924 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19925 lines' rows is implemented for bidi-reordered rows. */
19927 /* ROW->minpos is the value of min_pos, the minimal buffer position
19928 we have in ROW, or ROW->start.pos if that is smaller. */
19929 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19930 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19932 /* We didn't find buffer positions smaller than ROW->start, or
19933 didn't find _any_ valid buffer positions in any of the glyphs,
19934 so we must trust the iterator's computed positions. */
19935 row
->minpos
= row
->start
.pos
;
19938 max_pos
= CHARPOS (it
->current
.pos
);
19939 max_bpos
= BYTEPOS (it
->current
.pos
);
19942 /* Here are the various use-cases for ending the row, and the
19943 corresponding values for ROW->maxpos:
19945 Line ends in a newline from buffer eol_pos + 1
19946 Line is continued from buffer max_pos + 1
19947 Line is truncated on right it->current.pos
19948 Line ends in a newline from string max_pos + 1(*)
19949 (*) + 1 only when line ends in a forward scan
19950 Line is continued from string max_pos
19951 Line is continued from display vector max_pos
19952 Line is entirely from a string min_pos == max_pos
19953 Line is entirely from a display vector min_pos == max_pos
19954 Line that ends at ZV ZV
19956 If you discover other use-cases, please add them here as
19958 if (row
->ends_at_zv_p
)
19959 row
->maxpos
= it
->current
.pos
;
19960 else if (row
->used
[TEXT_AREA
])
19962 int seen_this_string
= 0;
19963 struct glyph_row
*r1
= row
- 1;
19965 /* Did we see the same display string on the previous row? */
19966 if (STRINGP (it
->object
)
19967 /* this is not the first row */
19968 && row
> it
->w
->desired_matrix
->rows
19969 /* previous row is not the header line */
19970 && !r1
->mode_line_p
19971 /* previous row also ends in a newline from a string */
19972 && r1
->ends_in_newline_from_string_p
)
19974 struct glyph
*start
, *end
;
19976 /* Search for the last glyph of the previous row that came
19977 from buffer or string. Depending on whether the row is
19978 L2R or R2L, we need to process it front to back or the
19979 other way round. */
19980 if (!r1
->reversed_p
)
19982 start
= r1
->glyphs
[TEXT_AREA
];
19983 end
= start
+ r1
->used
[TEXT_AREA
];
19984 /* Glyphs inserted by redisplay have nil as their object. */
19986 && NILP ((end
- 1)->object
)
19987 && (end
- 1)->charpos
<= 0)
19991 if (EQ ((end
- 1)->object
, it
->object
))
19992 seen_this_string
= 1;
19995 /* If all the glyphs of the previous row were inserted
19996 by redisplay, it means the previous row was
19997 produced from a single newline, which is only
19998 possible if that newline came from the same string
19999 as the one which produced this ROW. */
20000 seen_this_string
= 1;
20004 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20005 start
= end
+ r1
->used
[TEXT_AREA
];
20007 && NILP ((end
+ 1)->object
)
20008 && (end
+ 1)->charpos
<= 0)
20012 if (EQ ((end
+ 1)->object
, it
->object
))
20013 seen_this_string
= 1;
20016 seen_this_string
= 1;
20019 /* Take note of each display string that covers a newline only
20020 once, the first time we see it. This is for when a display
20021 string includes more than one newline in it. */
20022 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20024 /* If we were scanning the buffer forward when we displayed
20025 the string, we want to account for at least one buffer
20026 position that belongs to this row (position covered by
20027 the display string), so that cursor positioning will
20028 consider this row as a candidate when point is at the end
20029 of the visual line represented by this row. This is not
20030 required when scanning back, because max_pos will already
20031 have a much larger value. */
20032 if (CHARPOS (row
->end
.pos
) > max_pos
)
20033 INC_BOTH (max_pos
, max_bpos
);
20034 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20036 else if (CHARPOS (it
->eol_pos
) > 0)
20037 SET_TEXT_POS (row
->maxpos
,
20038 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20039 else if (row
->continued_p
)
20041 /* If max_pos is different from IT's current position, it
20042 means IT->method does not belong to the display element
20043 at max_pos. However, it also means that the display
20044 element at max_pos was displayed in its entirety on this
20045 line, which is equivalent to saying that the next line
20046 starts at the next buffer position. */
20047 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20048 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20051 INC_BOTH (max_pos
, max_bpos
);
20052 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20055 else if (row
->truncated_on_right_p
)
20056 /* display_line already called reseat_at_next_visible_line_start,
20057 which puts the iterator at the beginning of the next line, in
20058 the logical order. */
20059 row
->maxpos
= it
->current
.pos
;
20060 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20061 /* A line that is entirely from a string/image/stretch... */
20062 row
->maxpos
= row
->minpos
;
20067 row
->maxpos
= it
->current
.pos
;
20070 /* Construct the glyph row IT->glyph_row in the desired matrix of
20071 IT->w from text at the current position of IT. See dispextern.h
20072 for an overview of struct it. Value is non-zero if
20073 IT->glyph_row displays text, as opposed to a line displaying ZV
20077 display_line (struct it
*it
)
20079 struct glyph_row
*row
= it
->glyph_row
;
20080 Lisp_Object overlay_arrow_string
;
20082 void *wrap_data
= NULL
;
20083 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20084 int wrap_row_used
= -1;
20085 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20086 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20087 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20088 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20089 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20091 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20092 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20093 bool pending_handle_line_prefix
= false;
20095 /* We always start displaying at hpos zero even if hscrolled. */
20096 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20098 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20099 >= it
->w
->desired_matrix
->nrows
)
20101 it
->w
->nrows_scale_factor
++;
20102 it
->f
->fonts_changed
= 1;
20106 /* Clear the result glyph row and enable it. */
20107 prepare_desired_row (it
->w
, row
, false);
20109 row
->y
= it
->current_y
;
20110 row
->start
= it
->start
;
20111 row
->continuation_lines_width
= it
->continuation_lines_width
;
20112 row
->displays_text_p
= 1;
20113 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20114 it
->starts_in_middle_of_char_p
= 0;
20116 /* Arrange the overlays nicely for our purposes. Usually, we call
20117 display_line on only one line at a time, in which case this
20118 can't really hurt too much, or we call it on lines which appear
20119 one after another in the buffer, in which case all calls to
20120 recenter_overlay_lists but the first will be pretty cheap. */
20121 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20123 /* Move over display elements that are not visible because we are
20124 hscrolled. This may stop at an x-position < IT->first_visible_x
20125 if the first glyph is partially visible or if we hit a line end. */
20126 if (it
->current_x
< it
->first_visible_x
)
20128 enum move_it_result move_result
;
20130 this_line_min_pos
= row
->start
.pos
;
20131 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20132 MOVE_TO_POS
| MOVE_TO_X
);
20133 /* If we are under a large hscroll, move_it_in_display_line_to
20134 could hit the end of the line without reaching
20135 it->first_visible_x. Pretend that we did reach it. This is
20136 especially important on a TTY, where we will call
20137 extend_face_to_end_of_line, which needs to know how many
20138 blank glyphs to produce. */
20139 if (it
->current_x
< it
->first_visible_x
20140 && (move_result
== MOVE_NEWLINE_OR_CR
20141 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20142 it
->current_x
= it
->first_visible_x
;
20144 /* Record the smallest positions seen while we moved over
20145 display elements that are not visible. This is needed by
20146 redisplay_internal for optimizing the case where the cursor
20147 stays inside the same line. The rest of this function only
20148 considers positions that are actually displayed, so
20149 RECORD_MAX_MIN_POS will not otherwise record positions that
20150 are hscrolled to the left of the left edge of the window. */
20151 min_pos
= CHARPOS (this_line_min_pos
);
20152 min_bpos
= BYTEPOS (this_line_min_pos
);
20154 else if (it
->area
== TEXT_AREA
)
20156 /* We only do this when not calling move_it_in_display_line_to
20157 above, because that function calls itself handle_line_prefix. */
20158 handle_line_prefix (it
);
20162 /* Line-prefix and wrap-prefix are always displayed in the text
20163 area. But if this is the first call to display_line after
20164 init_iterator, the iterator might have been set up to write
20165 into a marginal area, e.g. if the line begins with some
20166 display property that writes to the margins. So we need to
20167 wait with the call to handle_line_prefix until whatever
20168 writes to the margin has done its job. */
20169 pending_handle_line_prefix
= true;
20172 /* Get the initial row height. This is either the height of the
20173 text hscrolled, if there is any, or zero. */
20174 row
->ascent
= it
->max_ascent
;
20175 row
->height
= it
->max_ascent
+ it
->max_descent
;
20176 row
->phys_ascent
= it
->max_phys_ascent
;
20177 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20178 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20180 /* Utility macro to record max and min buffer positions seen until now. */
20181 #define RECORD_MAX_MIN_POS(IT) \
20184 int composition_p = !STRINGP ((IT)->string) \
20185 && ((IT)->what == IT_COMPOSITION); \
20186 ptrdiff_t current_pos = \
20187 composition_p ? (IT)->cmp_it.charpos \
20188 : IT_CHARPOS (*(IT)); \
20189 ptrdiff_t current_bpos = \
20190 composition_p ? CHAR_TO_BYTE (current_pos) \
20191 : IT_BYTEPOS (*(IT)); \
20192 if (current_pos < min_pos) \
20194 min_pos = current_pos; \
20195 min_bpos = current_bpos; \
20197 if (IT_CHARPOS (*it) > max_pos) \
20199 max_pos = IT_CHARPOS (*it); \
20200 max_bpos = IT_BYTEPOS (*it); \
20205 /* Loop generating characters. The loop is left with IT on the next
20206 character to display. */
20209 int n_glyphs_before
, hpos_before
, x_before
;
20211 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20213 /* Retrieve the next thing to display. Value is zero if end of
20215 if (!get_next_display_element (it
))
20217 /* Maybe add a space at the end of this line that is used to
20218 display the cursor there under X. Set the charpos of the
20219 first glyph of blank lines not corresponding to any text
20221 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20222 row
->exact_window_width_line_p
= 1;
20223 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20224 || row
->used
[TEXT_AREA
] == 0)
20226 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20227 row
->displays_text_p
= 0;
20229 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20230 && (!MINI_WINDOW_P (it
->w
)
20231 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20232 row
->indicate_empty_line_p
= 1;
20235 it
->continuation_lines_width
= 0;
20236 row
->ends_at_zv_p
= 1;
20237 /* A row that displays right-to-left text must always have
20238 its last face extended all the way to the end of line,
20239 even if this row ends in ZV, because we still write to
20240 the screen left to right. We also need to extend the
20241 last face if the default face is remapped to some
20242 different face, otherwise the functions that clear
20243 portions of the screen will clear with the default face's
20244 background color. */
20245 if (row
->reversed_p
20246 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20247 extend_face_to_end_of_line (it
);
20251 /* Now, get the metrics of what we want to display. This also
20252 generates glyphs in `row' (which is IT->glyph_row). */
20253 n_glyphs_before
= row
->used
[TEXT_AREA
];
20256 /* Remember the line height so far in case the next element doesn't
20257 fit on the line. */
20258 if (it
->line_wrap
!= TRUNCATE
)
20260 ascent
= it
->max_ascent
;
20261 descent
= it
->max_descent
;
20262 phys_ascent
= it
->max_phys_ascent
;
20263 phys_descent
= it
->max_phys_descent
;
20265 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20267 if (IT_DISPLAYING_WHITESPACE (it
))
20271 SAVE_IT (wrap_it
, *it
, wrap_data
);
20273 wrap_row_used
= row
->used
[TEXT_AREA
];
20274 wrap_row_ascent
= row
->ascent
;
20275 wrap_row_height
= row
->height
;
20276 wrap_row_phys_ascent
= row
->phys_ascent
;
20277 wrap_row_phys_height
= row
->phys_height
;
20278 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20279 wrap_row_min_pos
= min_pos
;
20280 wrap_row_min_bpos
= min_bpos
;
20281 wrap_row_max_pos
= max_pos
;
20282 wrap_row_max_bpos
= max_bpos
;
20288 PRODUCE_GLYPHS (it
);
20290 /* If this display element was in marginal areas, continue with
20292 if (it
->area
!= TEXT_AREA
)
20294 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20295 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20296 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20297 row
->phys_height
= max (row
->phys_height
,
20298 it
->max_phys_ascent
+ it
->max_phys_descent
);
20299 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20300 it
->max_extra_line_spacing
);
20301 set_iterator_to_next (it
, 1);
20302 /* If we didn't handle the line/wrap prefix above, and the
20303 call to set_iterator_to_next just switched to TEXT_AREA,
20304 process the prefix now. */
20305 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20307 pending_handle_line_prefix
= false;
20308 handle_line_prefix (it
);
20313 /* Does the display element fit on the line? If we truncate
20314 lines, we should draw past the right edge of the window. If
20315 we don't truncate, we want to stop so that we can display the
20316 continuation glyph before the right margin. If lines are
20317 continued, there are two possible strategies for characters
20318 resulting in more than 1 glyph (e.g. tabs): Display as many
20319 glyphs as possible in this line and leave the rest for the
20320 continuation line, or display the whole element in the next
20321 line. Original redisplay did the former, so we do it also. */
20322 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20323 hpos_before
= it
->hpos
;
20326 if (/* Not a newline. */
20328 /* Glyphs produced fit entirely in the line. */
20329 && it
->current_x
< it
->last_visible_x
)
20331 it
->hpos
+= nglyphs
;
20332 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20333 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20334 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20335 row
->phys_height
= max (row
->phys_height
,
20336 it
->max_phys_ascent
+ it
->max_phys_descent
);
20337 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20338 it
->max_extra_line_spacing
);
20339 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20340 /* In R2L rows, we arrange in extend_face_to_end_of_line
20341 to add a right offset to the line, by a suitable
20342 change to the stretch glyph that is the leftmost
20343 glyph of the line. */
20344 && !row
->reversed_p
)
20345 row
->x
= x
- it
->first_visible_x
;
20346 /* Record the maximum and minimum buffer positions seen so
20347 far in glyphs that will be displayed by this row. */
20349 RECORD_MAX_MIN_POS (it
);
20354 struct glyph
*glyph
;
20356 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20358 /* Identify the glyphs added by the last call to
20359 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20360 the previous glyphs. */
20361 if (!row
->reversed_p
)
20362 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20364 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20365 new_x
= x
+ glyph
->pixel_width
;
20367 if (/* Lines are continued. */
20368 it
->line_wrap
!= TRUNCATE
20369 && (/* Glyph doesn't fit on the line. */
20370 new_x
> it
->last_visible_x
20371 /* Or it fits exactly on a window system frame. */
20372 || (new_x
== it
->last_visible_x
20373 && FRAME_WINDOW_P (it
->f
)
20374 && (row
->reversed_p
20375 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20376 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20378 /* End of a continued line. */
20381 || (new_x
== it
->last_visible_x
20382 && FRAME_WINDOW_P (it
->f
)
20383 && (row
->reversed_p
20384 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20385 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20387 /* Current glyph is the only one on the line or
20388 fits exactly on the line. We must continue
20389 the line because we can't draw the cursor
20390 after the glyph. */
20391 row
->continued_p
= 1;
20392 it
->current_x
= new_x
;
20393 it
->continuation_lines_width
+= new_x
;
20395 if (i
== nglyphs
- 1)
20397 /* If line-wrap is on, check if a previous
20398 wrap point was found. */
20399 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20400 && wrap_row_used
> 0
20401 /* Even if there is a previous wrap
20402 point, continue the line here as
20403 usual, if (i) the previous character
20404 was a space or tab AND (ii) the
20405 current character is not. */
20407 || IT_DISPLAYING_WHITESPACE (it
)))
20410 /* Record the maximum and minimum buffer
20411 positions seen so far in glyphs that will be
20412 displayed by this row. */
20414 RECORD_MAX_MIN_POS (it
);
20415 set_iterator_to_next (it
, 1);
20416 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20418 if (!get_next_display_element (it
))
20420 row
->exact_window_width_line_p
= 1;
20421 it
->continuation_lines_width
= 0;
20422 row
->continued_p
= 0;
20423 row
->ends_at_zv_p
= 1;
20425 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20427 row
->continued_p
= 0;
20428 row
->exact_window_width_line_p
= 1;
20430 /* If line-wrap is on, check if a
20431 previous wrap point was found. */
20432 else if (wrap_row_used
> 0
20433 /* Even if there is a previous wrap
20434 point, continue the line here as
20435 usual, if (i) the previous character
20436 was a space or tab AND (ii) the
20437 current character is not. */
20439 || IT_DISPLAYING_WHITESPACE (it
)))
20444 else if (it
->bidi_p
)
20445 RECORD_MAX_MIN_POS (it
);
20446 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20447 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20448 extend_face_to_end_of_line (it
);
20450 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20451 && !FRAME_WINDOW_P (it
->f
))
20453 /* A padding glyph that doesn't fit on this line.
20454 This means the whole character doesn't fit
20456 if (row
->reversed_p
)
20457 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20458 - n_glyphs_before
);
20459 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20461 /* Fill the rest of the row with continuation
20462 glyphs like in 20.x. */
20463 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20464 < row
->glyphs
[1 + TEXT_AREA
])
20465 produce_special_glyphs (it
, IT_CONTINUATION
);
20467 row
->continued_p
= 1;
20468 it
->current_x
= x_before
;
20469 it
->continuation_lines_width
+= x_before
;
20471 /* Restore the height to what it was before the
20472 element not fitting on the line. */
20473 it
->max_ascent
= ascent
;
20474 it
->max_descent
= descent
;
20475 it
->max_phys_ascent
= phys_ascent
;
20476 it
->max_phys_descent
= phys_descent
;
20477 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20478 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20479 extend_face_to_end_of_line (it
);
20481 else if (wrap_row_used
> 0)
20484 if (row
->reversed_p
)
20485 unproduce_glyphs (it
,
20486 row
->used
[TEXT_AREA
] - wrap_row_used
);
20487 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20488 it
->continuation_lines_width
+= wrap_x
;
20489 row
->used
[TEXT_AREA
] = wrap_row_used
;
20490 row
->ascent
= wrap_row_ascent
;
20491 row
->height
= wrap_row_height
;
20492 row
->phys_ascent
= wrap_row_phys_ascent
;
20493 row
->phys_height
= wrap_row_phys_height
;
20494 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20495 min_pos
= wrap_row_min_pos
;
20496 min_bpos
= wrap_row_min_bpos
;
20497 max_pos
= wrap_row_max_pos
;
20498 max_bpos
= wrap_row_max_bpos
;
20499 row
->continued_p
= 1;
20500 row
->ends_at_zv_p
= 0;
20501 row
->exact_window_width_line_p
= 0;
20502 it
->continuation_lines_width
+= x
;
20504 /* Make sure that a non-default face is extended
20505 up to the right margin of the window. */
20506 extend_face_to_end_of_line (it
);
20508 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20510 /* A TAB that extends past the right edge of the
20511 window. This produces a single glyph on
20512 window system frames. We leave the glyph in
20513 this row and let it fill the row, but don't
20514 consume the TAB. */
20515 if ((row
->reversed_p
20516 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20517 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20518 produce_special_glyphs (it
, IT_CONTINUATION
);
20519 it
->continuation_lines_width
+= it
->last_visible_x
;
20520 row
->ends_in_middle_of_char_p
= 1;
20521 row
->continued_p
= 1;
20522 glyph
->pixel_width
= it
->last_visible_x
- x
;
20523 it
->starts_in_middle_of_char_p
= 1;
20524 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20525 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20526 extend_face_to_end_of_line (it
);
20530 /* Something other than a TAB that draws past
20531 the right edge of the window. Restore
20532 positions to values before the element. */
20533 if (row
->reversed_p
)
20534 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20535 - (n_glyphs_before
+ i
));
20536 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20538 /* Display continuation glyphs. */
20539 it
->current_x
= x_before
;
20540 it
->continuation_lines_width
+= x
;
20541 if (!FRAME_WINDOW_P (it
->f
)
20542 || (row
->reversed_p
20543 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20544 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20545 produce_special_glyphs (it
, IT_CONTINUATION
);
20546 row
->continued_p
= 1;
20548 extend_face_to_end_of_line (it
);
20550 if (nglyphs
> 1 && i
> 0)
20552 row
->ends_in_middle_of_char_p
= 1;
20553 it
->starts_in_middle_of_char_p
= 1;
20556 /* Restore the height to what it was before the
20557 element not fitting on the line. */
20558 it
->max_ascent
= ascent
;
20559 it
->max_descent
= descent
;
20560 it
->max_phys_ascent
= phys_ascent
;
20561 it
->max_phys_descent
= phys_descent
;
20566 else if (new_x
> it
->first_visible_x
)
20568 /* Increment number of glyphs actually displayed. */
20571 /* Record the maximum and minimum buffer positions
20572 seen so far in glyphs that will be displayed by
20575 RECORD_MAX_MIN_POS (it
);
20577 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20578 /* Glyph is partially visible, i.e. row starts at
20579 negative X position. Don't do that in R2L
20580 rows, where we arrange to add a right offset to
20581 the line in extend_face_to_end_of_line, by a
20582 suitable change to the stretch glyph that is
20583 the leftmost glyph of the line. */
20584 row
->x
= x
- it
->first_visible_x
;
20585 /* When the last glyph of an R2L row only fits
20586 partially on the line, we need to set row->x to a
20587 negative offset, so that the leftmost glyph is
20588 the one that is partially visible. But if we are
20589 going to produce the truncation glyph, this will
20590 be taken care of in produce_special_glyphs. */
20591 if (row
->reversed_p
20592 && new_x
> it
->last_visible_x
20593 && !(it
->line_wrap
== TRUNCATE
20594 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20596 eassert (FRAME_WINDOW_P (it
->f
));
20597 row
->x
= it
->last_visible_x
- new_x
;
20602 /* Glyph is completely off the left margin of the
20603 window. This should not happen because of the
20604 move_it_in_display_line at the start of this
20605 function, unless the text display area of the
20606 window is empty. */
20607 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20610 /* Even if this display element produced no glyphs at all,
20611 we want to record its position. */
20612 if (it
->bidi_p
&& nglyphs
== 0)
20613 RECORD_MAX_MIN_POS (it
);
20615 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20616 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20617 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20618 row
->phys_height
= max (row
->phys_height
,
20619 it
->max_phys_ascent
+ it
->max_phys_descent
);
20620 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20621 it
->max_extra_line_spacing
);
20623 /* End of this display line if row is continued. */
20624 if (row
->continued_p
|| row
->ends_at_zv_p
)
20629 /* Is this a line end? If yes, we're also done, after making
20630 sure that a non-default face is extended up to the right
20631 margin of the window. */
20632 if (ITERATOR_AT_END_OF_LINE_P (it
))
20634 int used_before
= row
->used
[TEXT_AREA
];
20636 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20638 /* Add a space at the end of the line that is used to
20639 display the cursor there. */
20640 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20641 append_space_for_newline (it
, 0);
20643 /* Extend the face to the end of the line. */
20644 extend_face_to_end_of_line (it
);
20646 /* Make sure we have the position. */
20647 if (used_before
== 0)
20648 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20650 /* Record the position of the newline, for use in
20652 it
->eol_pos
= it
->current
.pos
;
20654 /* Consume the line end. This skips over invisible lines. */
20655 set_iterator_to_next (it
, 1);
20656 it
->continuation_lines_width
= 0;
20660 /* Proceed with next display element. Note that this skips
20661 over lines invisible because of selective display. */
20662 set_iterator_to_next (it
, 1);
20664 /* If we truncate lines, we are done when the last displayed
20665 glyphs reach past the right margin of the window. */
20666 if (it
->line_wrap
== TRUNCATE
20667 && ((FRAME_WINDOW_P (it
->f
)
20668 /* Images are preprocessed in produce_image_glyph such
20669 that they are cropped at the right edge of the
20670 window, so an image glyph will always end exactly at
20671 last_visible_x, even if there's no right fringe. */
20672 && ((row
->reversed_p
20673 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20674 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20675 || it
->what
== IT_IMAGE
))
20676 ? (it
->current_x
>= it
->last_visible_x
)
20677 : (it
->current_x
> it
->last_visible_x
)))
20679 /* Maybe add truncation glyphs. */
20680 if (!FRAME_WINDOW_P (it
->f
)
20681 || (row
->reversed_p
20682 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20683 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20687 if (!row
->reversed_p
)
20689 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20690 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20695 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20696 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20698 /* Remove any padding glyphs at the front of ROW, to
20699 make room for the truncation glyphs we will be
20700 adding below. The loop below always inserts at
20701 least one truncation glyph, so also remove the
20702 last glyph added to ROW. */
20703 unproduce_glyphs (it
, i
+ 1);
20704 /* Adjust i for the loop below. */
20705 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20708 /* produce_special_glyphs overwrites the last glyph, so
20709 we don't want that if we want to keep that last
20710 glyph, which means it's an image. */
20711 if (it
->current_x
> it
->last_visible_x
)
20713 it
->current_x
= x_before
;
20714 if (!FRAME_WINDOW_P (it
->f
))
20716 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20718 row
->used
[TEXT_AREA
] = i
;
20719 produce_special_glyphs (it
, IT_TRUNCATION
);
20724 row
->used
[TEXT_AREA
] = i
;
20725 produce_special_glyphs (it
, IT_TRUNCATION
);
20727 it
->hpos
= hpos_before
;
20730 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20732 /* Don't truncate if we can overflow newline into fringe. */
20733 if (!get_next_display_element (it
))
20735 it
->continuation_lines_width
= 0;
20736 row
->ends_at_zv_p
= 1;
20737 row
->exact_window_width_line_p
= 1;
20740 if (ITERATOR_AT_END_OF_LINE_P (it
))
20742 row
->exact_window_width_line_p
= 1;
20743 goto at_end_of_line
;
20745 it
->current_x
= x_before
;
20746 it
->hpos
= hpos_before
;
20749 row
->truncated_on_right_p
= 1;
20750 it
->continuation_lines_width
= 0;
20751 reseat_at_next_visible_line_start (it
, 0);
20752 /* We insist below that IT's position be at ZV because in
20753 bidi-reordered lines the character at visible line start
20754 might not be the character that follows the newline in
20755 the logical order. */
20756 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20757 row
->ends_at_zv_p
=
20758 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20760 row
->ends_at_zv_p
= false;
20766 bidi_unshelve_cache (wrap_data
, 1);
20768 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20769 at the left window margin. */
20770 if (it
->first_visible_x
20771 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20773 if (!FRAME_WINDOW_P (it
->f
)
20774 || (((row
->reversed_p
20775 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20776 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20777 /* Don't let insert_left_trunc_glyphs overwrite the
20778 first glyph of the row if it is an image. */
20779 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20780 insert_left_trunc_glyphs (it
);
20781 row
->truncated_on_left_p
= 1;
20784 /* Remember the position at which this line ends.
20786 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20787 cannot be before the call to find_row_edges below, since that is
20788 where these positions are determined. */
20789 row
->end
= it
->current
;
20792 row
->minpos
= row
->start
.pos
;
20793 row
->maxpos
= row
->end
.pos
;
20797 /* ROW->minpos and ROW->maxpos must be the smallest and
20798 `1 + the largest' buffer positions in ROW. But if ROW was
20799 bidi-reordered, these two positions can be anywhere in the
20800 row, so we must determine them now. */
20801 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20804 /* If the start of this line is the overlay arrow-position, then
20805 mark this glyph row as the one containing the overlay arrow.
20806 This is clearly a mess with variable size fonts. It would be
20807 better to let it be displayed like cursors under X. */
20808 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20809 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20810 !NILP (overlay_arrow_string
)))
20812 /* Overlay arrow in window redisplay is a fringe bitmap. */
20813 if (STRINGP (overlay_arrow_string
))
20815 struct glyph_row
*arrow_row
20816 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20817 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20818 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20819 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20820 struct glyph
*p2
, *end
;
20822 /* Copy the arrow glyphs. */
20823 while (glyph
< arrow_end
)
20826 /* Throw away padding glyphs. */
20828 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20829 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20835 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20840 eassert (INTEGERP (overlay_arrow_string
));
20841 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20843 overlay_arrow_seen
= 1;
20846 /* Highlight trailing whitespace. */
20847 if (!NILP (Vshow_trailing_whitespace
))
20848 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20850 /* Compute pixel dimensions of this line. */
20851 compute_line_metrics (it
);
20853 /* Implementation note: No changes in the glyphs of ROW or in their
20854 faces can be done past this point, because compute_line_metrics
20855 computes ROW's hash value and stores it within the glyph_row
20858 /* Record whether this row ends inside an ellipsis. */
20859 row
->ends_in_ellipsis_p
20860 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20861 && it
->ellipsis_p
);
20863 /* Save fringe bitmaps in this row. */
20864 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20865 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20866 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20867 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20869 it
->left_user_fringe_bitmap
= 0;
20870 it
->left_user_fringe_face_id
= 0;
20871 it
->right_user_fringe_bitmap
= 0;
20872 it
->right_user_fringe_face_id
= 0;
20874 /* Maybe set the cursor. */
20875 cvpos
= it
->w
->cursor
.vpos
;
20877 /* In bidi-reordered rows, keep checking for proper cursor
20878 position even if one has been found already, because buffer
20879 positions in such rows change non-linearly with ROW->VPOS,
20880 when a line is continued. One exception: when we are at ZV,
20881 display cursor on the first suitable glyph row, since all
20882 the empty rows after that also have their position set to ZV. */
20883 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20884 lines' rows is implemented for bidi-reordered rows. */
20886 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20887 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20888 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20889 && cursor_row_p (row
))
20890 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20892 /* Prepare for the next line. This line starts horizontally at (X
20893 HPOS) = (0 0). Vertical positions are incremented. As a
20894 convenience for the caller, IT->glyph_row is set to the next
20896 it
->current_x
= it
->hpos
= 0;
20897 it
->current_y
+= row
->height
;
20898 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20901 /* The next row should by default use the same value of the
20902 reversed_p flag as this one. set_iterator_to_next decides when
20903 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20904 the flag accordingly. */
20905 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20906 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20907 it
->start
= row
->end
;
20908 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20910 #undef RECORD_MAX_MIN_POS
20913 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20914 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20915 doc
: /* Return paragraph direction at point in BUFFER.
20916 Value is either `left-to-right' or `right-to-left'.
20917 If BUFFER is omitted or nil, it defaults to the current buffer.
20919 Paragraph direction determines how the text in the paragraph is displayed.
20920 In left-to-right paragraphs, text begins at the left margin of the window
20921 and the reading direction is generally left to right. In right-to-left
20922 paragraphs, text begins at the right margin and is read from right to left.
20924 See also `bidi-paragraph-direction'. */)
20925 (Lisp_Object buffer
)
20927 struct buffer
*buf
= current_buffer
;
20928 struct buffer
*old
= buf
;
20930 if (! NILP (buffer
))
20932 CHECK_BUFFER (buffer
);
20933 buf
= XBUFFER (buffer
);
20936 if (NILP (BVAR (buf
, bidi_display_reordering
))
20937 || NILP (BVAR (buf
, enable_multibyte_characters
))
20938 /* When we are loading loadup.el, the character property tables
20939 needed for bidi iteration are not yet available. */
20940 || !NILP (Vpurify_flag
))
20941 return Qleft_to_right
;
20942 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20943 return BVAR (buf
, bidi_paragraph_direction
);
20946 /* Determine the direction from buffer text. We could try to
20947 use current_matrix if it is up to date, but this seems fast
20948 enough as it is. */
20949 struct bidi_it itb
;
20950 ptrdiff_t pos
= BUF_PT (buf
);
20951 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20953 void *itb_data
= bidi_shelve_cache ();
20955 set_buffer_temp (buf
);
20956 /* bidi_paragraph_init finds the base direction of the paragraph
20957 by searching forward from paragraph start. We need the base
20958 direction of the current or _previous_ paragraph, so we need
20959 to make sure we are within that paragraph. To that end, find
20960 the previous non-empty line. */
20961 if (pos
>= ZV
&& pos
> BEGV
)
20962 DEC_BOTH (pos
, bytepos
);
20963 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
20964 if (fast_looking_at (trailing_white_space
,
20965 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20967 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20968 || c
== ' ' || c
== '\t' || c
== '\f')
20970 if (bytepos
<= BEGV_BYTE
)
20975 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20978 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20979 itb
.paragraph_dir
= NEUTRAL_DIR
;
20980 itb
.string
.s
= NULL
;
20981 itb
.string
.lstring
= Qnil
;
20982 itb
.string
.bufpos
= 0;
20983 itb
.string
.from_disp_str
= 0;
20984 itb
.string
.unibyte
= 0;
20985 /* We have no window to use here for ignoring window-specific
20986 overlays. Using NULL for window pointer will cause
20987 compute_display_string_pos to use the current buffer. */
20989 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20990 bidi_unshelve_cache (itb_data
, 0);
20991 set_buffer_temp (old
);
20992 switch (itb
.paragraph_dir
)
20995 return Qleft_to_right
;
20998 return Qright_to_left
;
21006 DEFUN ("bidi-find-overridden-directionality",
21007 Fbidi_find_overridden_directionality
,
21008 Sbidi_find_overridden_directionality
, 2, 3, 0,
21009 doc
: /* Return position between FROM and TO where directionality was overridden.
21011 This function returns the first character position in the specified
21012 region of OBJECT where there is a character whose `bidi-class' property
21013 is `L', but which was forced to display as `R' by a directional
21014 override, and likewise with characters whose `bidi-class' is `R'
21015 or `AL' that were forced to display as `L'.
21017 If no such character is found, the function returns nil.
21019 OBJECT is a Lisp string or buffer to search for overridden
21020 directionality, and defaults to the current buffer if nil or omitted.
21021 OBJECT can also be a window, in which case the function will search
21022 the buffer displayed in that window. Passing the window instead of
21023 a buffer is preferable when the buffer is displayed in some window,
21024 because this function will then be able to correctly account for
21025 window-specific overlays, which can affect the results.
21027 Strong directional characters `L', `R', and `AL' can have their
21028 intrinsic directionality overridden by directional override
21029 control characters RLO \(u+202e) and LRO \(u+202d). See the
21030 function `get-char-code-property' for a way to inquire about
21031 the `bidi-class' property of a character. */)
21032 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21034 struct buffer
*buf
= current_buffer
;
21035 struct buffer
*old
= buf
;
21036 struct window
*w
= NULL
;
21037 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21038 struct bidi_it itb
;
21039 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21042 if (!NILP (object
))
21044 if (BUFFERP (object
))
21045 buf
= XBUFFER (object
);
21046 else if (WINDOWP (object
))
21048 w
= decode_live_window (object
);
21049 buf
= XBUFFER (w
->contents
);
21050 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21053 CHECK_STRING (object
);
21056 if (STRINGP (object
))
21058 /* Characters in unibyte strings are always treated by bidi.c as
21060 if (!STRING_MULTIBYTE (object
)
21061 /* When we are loading loadup.el, the character property
21062 tables needed for bidi iteration are not yet
21064 || !NILP (Vpurify_flag
))
21067 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21068 if (from_pos
>= SCHARS (object
))
21071 /* Set up the bidi iterator. */
21072 itb_data
= bidi_shelve_cache ();
21073 itb
.paragraph_dir
= NEUTRAL_DIR
;
21074 itb
.string
.lstring
= object
;
21075 itb
.string
.s
= NULL
;
21076 itb
.string
.schars
= SCHARS (object
);
21077 itb
.string
.bufpos
= 0;
21078 itb
.string
.from_disp_str
= 0;
21079 itb
.string
.unibyte
= 0;
21081 bidi_init_it (0, 0, frame_window_p
, &itb
);
21085 /* Nothing this fancy can happen in unibyte buffers, or in a
21086 buffer that disabled reordering, or if FROM is at EOB. */
21087 if (NILP (BVAR (buf
, bidi_display_reordering
))
21088 || NILP (BVAR (buf
, enable_multibyte_characters
))
21089 /* When we are loading loadup.el, the character property
21090 tables needed for bidi iteration are not yet
21092 || !NILP (Vpurify_flag
))
21095 set_buffer_temp (buf
);
21096 validate_region (&from
, &to
);
21097 from_pos
= XINT (from
);
21098 to_pos
= XINT (to
);
21099 if (from_pos
>= ZV
)
21102 /* Set up the bidi iterator. */
21103 itb_data
= bidi_shelve_cache ();
21104 from_bpos
= CHAR_TO_BYTE (from_pos
);
21105 if (from_pos
== BEGV
)
21107 itb
.charpos
= BEGV
;
21108 itb
.bytepos
= BEGV_BYTE
;
21110 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21112 itb
.charpos
= from_pos
;
21113 itb
.bytepos
= from_bpos
;
21116 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21118 itb
.paragraph_dir
= NEUTRAL_DIR
;
21119 itb
.string
.s
= NULL
;
21120 itb
.string
.lstring
= Qnil
;
21121 itb
.string
.bufpos
= 0;
21122 itb
.string
.from_disp_str
= 0;
21123 itb
.string
.unibyte
= 0;
21125 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21130 /* For the purposes of this function, the actual base direction of
21131 the paragraph doesn't matter, so just set it to L2R. */
21132 bidi_paragraph_init (L2R
, &itb
, 0);
21133 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21135 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21137 bidi_unshelve_cache (itb_data
, 0);
21138 set_buffer_temp (old
);
21140 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21143 DEFUN ("move-point-visually", Fmove_point_visually
,
21144 Smove_point_visually
, 1, 1, 0,
21145 doc
: /* Move point in the visual order in the specified DIRECTION.
21146 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21149 Value is the new character position of point. */)
21150 (Lisp_Object direction
)
21152 struct window
*w
= XWINDOW (selected_window
);
21153 struct buffer
*b
= XBUFFER (w
->contents
);
21154 struct glyph_row
*row
;
21156 Lisp_Object paragraph_dir
;
21158 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21159 (!(ROW)->continued_p \
21160 && NILP ((GLYPH)->object) \
21161 && (GLYPH)->type == CHAR_GLYPH \
21162 && (GLYPH)->u.ch == ' ' \
21163 && (GLYPH)->charpos >= 0 \
21164 && !(GLYPH)->avoid_cursor_p)
21166 CHECK_NUMBER (direction
);
21167 dir
= XINT (direction
);
21173 /* If current matrix is up-to-date, we can use the information
21174 recorded in the glyphs, at least as long as the goal is on the
21176 if (w
->window_end_valid
21177 && !windows_or_buffers_changed
21179 && !b
->clip_changed
21180 && !b
->prevent_redisplay_optimizations_p
21181 && !window_outdated (w
)
21182 /* We rely below on the cursor coordinates to be up to date, but
21183 we cannot trust them if some command moved point since the
21184 last complete redisplay. */
21185 && w
->last_point
== BUF_PT (b
)
21186 && w
->cursor
.vpos
>= 0
21187 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21188 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21190 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21191 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21192 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21194 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21196 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21198 SET_PT (g
->charpos
);
21199 w
->cursor
.vpos
= -1;
21200 return make_number (PT
);
21202 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21206 if (BUFFERP (gpt
->object
))
21209 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21210 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21212 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21214 else if (BUFFERP (g
->object
))
21215 new_pos
= g
->charpos
;
21219 w
->cursor
.vpos
= -1;
21220 return make_number (PT
);
21222 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21224 /* Glyphs inserted at the end of a non-empty line for
21225 positioning the cursor have zero charpos, so we must
21226 deduce the value of point by other means. */
21227 if (g
->charpos
> 0)
21228 SET_PT (g
->charpos
);
21229 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21231 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21232 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21235 w
->cursor
.vpos
= -1;
21236 return make_number (PT
);
21239 if (g
== e
|| NILP (g
->object
))
21241 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21242 goto simulate_display
;
21243 if (!row
->reversed_p
)
21247 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21248 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21249 goto simulate_display
;
21253 if (row
->reversed_p
&& !row
->continued_p
)
21255 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21256 w
->cursor
.vpos
= -1;
21257 return make_number (PT
);
21259 g
= row
->glyphs
[TEXT_AREA
];
21260 e
= g
+ row
->used
[TEXT_AREA
];
21261 for ( ; g
< e
; g
++)
21263 if (BUFFERP (g
->object
)
21264 /* Empty lines have only one glyph, which stands
21265 for the newline, and whose charpos is the
21266 buffer position of the newline. */
21267 || ROW_GLYPH_NEWLINE_P (row
, g
)
21268 /* When the buffer ends in a newline, the line at
21269 EOB also has one glyph, but its charpos is -1. */
21270 || (row
->ends_at_zv_p
21271 && !row
->reversed_p
21272 && NILP (g
->object
)
21273 && g
->type
== CHAR_GLYPH
21274 && g
->u
.ch
== ' '))
21276 if (g
->charpos
> 0)
21277 SET_PT (g
->charpos
);
21278 else if (!row
->reversed_p
21279 && row
->ends_at_zv_p
21284 w
->cursor
.vpos
= -1;
21285 return make_number (PT
);
21291 if (!row
->reversed_p
&& !row
->continued_p
)
21293 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21294 w
->cursor
.vpos
= -1;
21295 return make_number (PT
);
21297 e
= row
->glyphs
[TEXT_AREA
];
21298 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21299 for ( ; g
>= e
; g
--)
21301 if (BUFFERP (g
->object
)
21302 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21304 /* Empty R2L lines on GUI frames have the buffer
21305 position of the newline stored in the stretch
21307 || g
->type
== STRETCH_GLYPH
21308 || (row
->ends_at_zv_p
21310 && NILP (g
->object
)
21311 && g
->type
== CHAR_GLYPH
21312 && g
->u
.ch
== ' '))
21314 if (g
->charpos
> 0)
21315 SET_PT (g
->charpos
);
21316 else if (row
->reversed_p
21317 && row
->ends_at_zv_p
21322 w
->cursor
.vpos
= -1;
21323 return make_number (PT
);
21332 /* If we wind up here, we failed to move by using the glyphs, so we
21333 need to simulate display instead. */
21336 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21338 paragraph_dir
= Qleft_to_right
;
21339 if (EQ (paragraph_dir
, Qright_to_left
))
21341 if (PT
<= BEGV
&& dir
< 0)
21342 xsignal0 (Qbeginning_of_buffer
);
21343 else if (PT
>= ZV
&& dir
> 0)
21344 xsignal0 (Qend_of_buffer
);
21347 struct text_pos pt
;
21349 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21351 bool overshoot_expected
= false;
21352 bool target_is_eol_p
= false;
21354 /* Setup the arena. */
21355 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21356 start_display (&it
, w
, pt
);
21358 if (it
.cmp_it
.id
< 0
21359 && it
.method
== GET_FROM_STRING
21360 && it
.area
== TEXT_AREA
21361 && it
.string_from_display_prop_p
21362 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21363 overshoot_expected
= true;
21365 /* Find the X coordinate of point. We start from the beginning
21366 of this or previous line to make sure we are before point in
21367 the logical order (since the move_it_* functions can only
21370 reseat_at_previous_visible_line_start (&it
);
21371 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21372 if (IT_CHARPOS (it
) != PT
)
21374 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21375 -1, -1, -1, MOVE_TO_POS
);
21376 /* If we missed point because the character there is
21377 displayed out of a display vector that has more than one
21378 glyph, retry expecting overshoot. */
21379 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21380 && it
.current
.dpvec_index
> 0
21381 && !overshoot_expected
)
21383 overshoot_expected
= true;
21386 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21387 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21389 pt_x
= it
.current_x
;
21391 if (dir
> 0 || overshoot_expected
)
21393 struct glyph_row
*row
= it
.glyph_row
;
21395 /* When point is at beginning of line, we don't have
21396 information about the glyph there loaded into struct
21397 it. Calling get_next_display_element fixes that. */
21399 get_next_display_element (&it
);
21400 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21401 it
.glyph_row
= NULL
;
21402 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21403 it
.glyph_row
= row
;
21404 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21405 it, lest it will become out of sync with it's buffer
21407 it
.current_x
= pt_x
;
21410 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21411 pixel_width
= it
.pixel_width
;
21412 if (overshoot_expected
&& at_eol_p
)
21414 else if (pixel_width
<= 0)
21417 /* If there's a display string (or something similar) at point,
21418 we are actually at the glyph to the left of point, so we need
21419 to correct the X coordinate. */
21420 if (overshoot_expected
)
21423 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21425 pt_x
+= pixel_width
;
21428 /* Compute target X coordinate, either to the left or to the
21429 right of point. On TTY frames, all characters have the same
21430 pixel width of 1, so we can use that. On GUI frames we don't
21431 have an easy way of getting at the pixel width of the
21432 character to the left of point, so we use a different method
21433 of getting to that place. */
21435 target_x
= pt_x
+ pixel_width
;
21437 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21439 /* Target X coordinate could be one line above or below the line
21440 of point, in which case we need to adjust the target X
21441 coordinate. Also, if moving to the left, we need to begin at
21442 the left edge of the point's screen line. */
21447 start_display (&it
, w
, pt
);
21448 reseat_at_previous_visible_line_start (&it
);
21449 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21451 move_it_by_lines (&it
, pt_vpos
);
21455 move_it_by_lines (&it
, -1);
21456 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21457 target_is_eol_p
= true;
21458 /* Under word-wrap, we don't know the x coordinate of
21459 the last character displayed on the previous line,
21460 which immediately precedes the wrap point. To find
21461 out its x coordinate, we try moving to the right
21462 margin of the window, which will stop at the wrap
21463 point, and then reset target_x to point at the
21464 character that precedes the wrap point. This is not
21465 needed on GUI frames, because (see below) there we
21466 move from the left margin one grapheme cluster at a
21467 time, and stop when we hit the wrap point. */
21468 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21470 void *it_data
= NULL
;
21473 SAVE_IT (it2
, it
, it_data
);
21474 move_it_in_display_line_to (&it
, ZV
, target_x
,
21475 MOVE_TO_POS
| MOVE_TO_X
);
21476 /* If we arrived at target_x, that _is_ the last
21477 character on the previous line. */
21478 if (it
.current_x
!= target_x
)
21479 target_x
= it
.current_x
- 1;
21480 RESTORE_IT (&it
, &it2
, it_data
);
21487 || (target_x
>= it
.last_visible_x
21488 && it
.line_wrap
!= TRUNCATE
))
21491 move_it_by_lines (&it
, 0);
21492 move_it_by_lines (&it
, 1);
21497 /* Move to the target X coordinate. */
21498 #ifdef HAVE_WINDOW_SYSTEM
21499 /* On GUI frames, as we don't know the X coordinate of the
21500 character to the left of point, moving point to the left
21501 requires walking, one grapheme cluster at a time, until we
21502 find ourself at a place immediately to the left of the
21503 character at point. */
21504 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21506 struct text_pos new_pos
;
21507 enum move_it_result rc
= MOVE_X_REACHED
;
21509 if (it
.current_x
== 0)
21510 get_next_display_element (&it
);
21511 if (it
.what
== IT_COMPOSITION
)
21513 new_pos
.charpos
= it
.cmp_it
.charpos
;
21514 new_pos
.bytepos
= -1;
21517 new_pos
= it
.current
.pos
;
21519 while (it
.current_x
+ it
.pixel_width
<= target_x
21520 && (rc
== MOVE_X_REACHED
21521 /* Under word-wrap, move_it_in_display_line_to
21522 stops at correct coordinates, but sometimes
21523 returns MOVE_POS_MATCH_OR_ZV. */
21524 || (it
.line_wrap
== WORD_WRAP
21525 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21527 int new_x
= it
.current_x
+ it
.pixel_width
;
21529 /* For composed characters, we want the position of the
21530 first character in the grapheme cluster (usually, the
21531 composition's base character), whereas it.current
21532 might give us the position of the _last_ one, e.g. if
21533 the composition is rendered in reverse due to bidi
21535 if (it
.what
== IT_COMPOSITION
)
21537 new_pos
.charpos
= it
.cmp_it
.charpos
;
21538 new_pos
.bytepos
= -1;
21541 new_pos
= it
.current
.pos
;
21542 if (new_x
== it
.current_x
)
21544 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21545 MOVE_TO_POS
| MOVE_TO_X
);
21546 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21549 /* The previous position we saw in the loop is the one we
21551 if (new_pos
.bytepos
== -1)
21552 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21553 it
.current
.pos
= new_pos
;
21557 if (it
.current_x
!= target_x
)
21558 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21560 /* When lines are truncated, the above loop will stop at the
21561 window edge. But we want to get to the end of line, even if
21562 it is beyond the window edge; automatic hscroll will then
21563 scroll the window to show point as appropriate. */
21564 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21565 && get_next_display_element (&it
))
21567 struct text_pos new_pos
= it
.current
.pos
;
21569 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21571 set_iterator_to_next (&it
, 0);
21572 if (it
.method
== GET_FROM_BUFFER
)
21573 new_pos
= it
.current
.pos
;
21574 if (!get_next_display_element (&it
))
21578 it
.current
.pos
= new_pos
;
21581 /* If we ended up in a display string that covers point, move to
21582 buffer position to the right in the visual order. */
21585 while (IT_CHARPOS (it
) == PT
)
21587 set_iterator_to_next (&it
, 0);
21588 if (!get_next_display_element (&it
))
21593 /* Move point to that position. */
21594 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21597 return make_number (PT
);
21599 #undef ROW_GLYPH_NEWLINE_P
21602 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21603 Sbidi_resolved_levels
, 0, 1, 0,
21604 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21606 The resolved levels are produced by the Emacs bidi reordering engine
21607 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21608 read the Unicode Standard Annex 9 (UAX#9) for background information
21609 about these levels.
21611 VPOS is the zero-based number of the current window's screen line
21612 for which to produce the resolved levels. If VPOS is nil or omitted,
21613 it defaults to the screen line of point. If the window displays a
21614 header line, VPOS of zero will report on the header line, and first
21615 line of text in the window will have VPOS of 1.
21617 Value is an array of resolved levels, indexed by glyph number.
21618 Glyphs are numbered from zero starting from the beginning of the
21619 screen line, i.e. the left edge of the window for left-to-right lines
21620 and from the right edge for right-to-left lines. The resolved levels
21621 are produced only for the window's text area; text in display margins
21624 If the selected window's display is not up-to-date, or if the specified
21625 screen line does not display text, this function returns nil. It is
21626 highly recommended to bind this function to some simple key, like F8,
21627 in order to avoid these problems.
21629 This function exists mainly for testing the correctness of the
21630 Emacs UBA implementation, in particular with the test suite. */)
21633 struct window
*w
= XWINDOW (selected_window
);
21634 struct buffer
*b
= XBUFFER (w
->contents
);
21636 struct glyph_row
*row
;
21640 int d1
, d2
, d3
, d4
, d5
;
21642 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21646 CHECK_NUMBER_COERCE_MARKER (vpos
);
21647 nrow
= XINT (vpos
);
21650 /* We require up-to-date glyph matrix for this window. */
21651 if (w
->window_end_valid
21652 && !windows_or_buffers_changed
21654 && !b
->clip_changed
21655 && !b
->prevent_redisplay_optimizations_p
21656 && !window_outdated (w
)
21658 && nrow
< w
->current_matrix
->nrows
21659 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21660 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21662 struct glyph
*g
, *e
, *g1
;
21664 Lisp_Object levels
;
21666 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21668 g
= g1
= row
->glyphs
[TEXT_AREA
];
21669 e
= g
+ row
->used
[TEXT_AREA
];
21671 /* Skip over glyphs at the start of the row that was
21672 generated by redisplay for its own needs. */
21674 && NILP (g
->object
)
21679 /* Count the "interesting" glyphs in this row. */
21680 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21683 /* Create and fill the array. */
21684 levels
= make_uninit_vector (nglyphs
);
21685 for (i
= 0; g1
< g
; i
++, g1
++)
21686 ASET (levels
, i
, make_number (g1
->resolved_level
));
21688 else /* Right-to-left glyph row. */
21690 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21691 e
= row
->glyphs
[TEXT_AREA
] - 1;
21693 && NILP (g
->object
)
21697 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21699 levels
= make_uninit_vector (nglyphs
);
21700 for (i
= 0; g1
> g
; i
++, g1
--)
21701 ASET (levels
, i
, make_number (g1
->resolved_level
));
21711 /***********************************************************************
21713 ***********************************************************************/
21715 /* Redisplay the menu bar in the frame for window W.
21717 The menu bar of X frames that don't have X toolkit support is
21718 displayed in a special window W->frame->menu_bar_window.
21720 The menu bar of terminal frames is treated specially as far as
21721 glyph matrices are concerned. Menu bar lines are not part of
21722 windows, so the update is done directly on the frame matrix rows
21723 for the menu bar. */
21726 display_menu_bar (struct window
*w
)
21728 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21733 /* Don't do all this for graphical frames. */
21735 if (FRAME_W32_P (f
))
21738 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21744 if (FRAME_NS_P (f
))
21746 #endif /* HAVE_NS */
21748 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21749 eassert (!FRAME_WINDOW_P (f
));
21750 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21751 it
.first_visible_x
= 0;
21752 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21753 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21754 if (FRAME_WINDOW_P (f
))
21756 /* Menu bar lines are displayed in the desired matrix of the
21757 dummy window menu_bar_window. */
21758 struct window
*menu_w
;
21759 menu_w
= XWINDOW (f
->menu_bar_window
);
21760 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21762 it
.first_visible_x
= 0;
21763 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21766 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21768 /* This is a TTY frame, i.e. character hpos/vpos are used as
21770 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21772 it
.first_visible_x
= 0;
21773 it
.last_visible_x
= FRAME_COLS (f
);
21776 /* FIXME: This should be controlled by a user option. See the
21777 comments in redisplay_tool_bar and display_mode_line about
21779 it
.paragraph_embedding
= L2R
;
21781 /* Clear all rows of the menu bar. */
21782 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21784 struct glyph_row
*row
= it
.glyph_row
+ i
;
21785 clear_glyph_row (row
);
21786 row
->enabled_p
= true;
21787 row
->full_width_p
= 1;
21788 row
->reversed_p
= false;
21791 /* Display all items of the menu bar. */
21792 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21793 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21795 Lisp_Object string
;
21797 /* Stop at nil string. */
21798 string
= AREF (items
, i
+ 1);
21802 /* Remember where item was displayed. */
21803 ASET (items
, i
+ 3, make_number (it
.hpos
));
21805 /* Display the item, pad with one space. */
21806 if (it
.current_x
< it
.last_visible_x
)
21807 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21808 SCHARS (string
) + 1, 0, 0, -1);
21811 /* Fill out the line with spaces. */
21812 if (it
.current_x
< it
.last_visible_x
)
21813 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21815 /* Compute the total height of the lines. */
21816 compute_line_metrics (&it
);
21819 /* Deep copy of a glyph row, including the glyphs. */
21821 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21823 struct glyph
*pointers
[1 + LAST_AREA
];
21824 int to_used
= to
->used
[TEXT_AREA
];
21826 /* Save glyph pointers of TO. */
21827 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21829 /* Do a structure assignment. */
21832 /* Restore original glyph pointers of TO. */
21833 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21835 /* Copy the glyphs. */
21836 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21837 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21839 /* If we filled only part of the TO row, fill the rest with
21840 space_glyph (which will display as empty space). */
21841 if (to_used
> from
->used
[TEXT_AREA
])
21842 fill_up_frame_row_with_spaces (to
, to_used
);
21845 /* Display one menu item on a TTY, by overwriting the glyphs in the
21846 frame F's desired glyph matrix with glyphs produced from the menu
21847 item text. Called from term.c to display TTY drop-down menus one
21850 ITEM_TEXT is the menu item text as a C string.
21852 FACE_ID is the face ID to be used for this menu item. FACE_ID
21853 could specify one of 3 faces: a face for an enabled item, a face
21854 for a disabled item, or a face for a selected item.
21856 X and Y are coordinates of the first glyph in the frame's desired
21857 matrix to be overwritten by the menu item. Since this is a TTY, Y
21858 is the zero-based number of the glyph row and X is the zero-based
21859 glyph number in the row, starting from left, where to start
21860 displaying the item.
21862 SUBMENU non-zero means this menu item drops down a submenu, which
21863 should be indicated by displaying a proper visual cue after the
21867 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21868 int x
, int y
, int submenu
)
21871 struct frame
*f
= SELECTED_FRAME ();
21872 struct window
*w
= XWINDOW (f
->selected_window
);
21873 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21874 struct glyph_row
*row
;
21875 size_t item_len
= strlen (item_text
);
21877 eassert (FRAME_TERMCAP_P (f
));
21879 /* Don't write beyond the matrix's last row. This can happen for
21880 TTY screens that are not high enough to show the entire menu.
21881 (This is actually a bit of defensive programming, as
21882 tty_menu_display already limits the number of menu items to one
21883 less than the number of screen lines.) */
21884 if (y
>= f
->desired_matrix
->nrows
)
21887 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21888 it
.first_visible_x
= 0;
21889 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21890 row
= it
.glyph_row
;
21891 /* Start with the row contents from the current matrix. */
21892 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21893 saved_width
= row
->full_width_p
;
21894 row
->full_width_p
= 1;
21895 saved_reversed
= row
->reversed_p
;
21896 row
->reversed_p
= 0;
21897 row
->enabled_p
= true;
21899 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21901 eassert (x
< f
->desired_matrix
->matrix_w
);
21902 it
.current_x
= it
.hpos
= x
;
21903 it
.current_y
= it
.vpos
= y
;
21904 saved_used
= row
->used
[TEXT_AREA
];
21905 saved_truncated
= row
->truncated_on_right_p
;
21906 row
->used
[TEXT_AREA
] = x
;
21907 it
.face_id
= face_id
;
21908 it
.line_wrap
= TRUNCATE
;
21910 /* FIXME: This should be controlled by a user option. See the
21911 comments in redisplay_tool_bar and display_mode_line about this.
21912 Also, if paragraph_embedding could ever be R2L, changes will be
21913 needed to avoid shifting to the right the row characters in
21914 term.c:append_glyph. */
21915 it
.paragraph_embedding
= L2R
;
21917 /* Pad with a space on the left. */
21918 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21920 /* Display the menu item, pad with spaces to WIDTH. */
21923 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21924 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21926 /* Indicate with " >" that there's a submenu. */
21927 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21928 FRAME_COLS (f
) - 1, -1);
21931 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21932 width
, 0, FRAME_COLS (f
) - 1, -1);
21934 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21935 row
->truncated_on_right_p
= saved_truncated
;
21936 row
->hash
= row_hash (row
);
21937 row
->full_width_p
= saved_width
;
21938 row
->reversed_p
= saved_reversed
;
21941 /***********************************************************************
21943 ***********************************************************************/
21945 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21946 FORCE is non-zero, redisplay mode lines unconditionally.
21947 Otherwise, redisplay only mode lines that are garbaged. Value is
21948 the number of windows whose mode lines were redisplayed. */
21951 redisplay_mode_lines (Lisp_Object window
, bool force
)
21955 while (!NILP (window
))
21957 struct window
*w
= XWINDOW (window
);
21959 if (WINDOWP (w
->contents
))
21960 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21962 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21963 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21965 struct text_pos lpoint
;
21966 struct buffer
*old
= current_buffer
;
21968 /* Set the window's buffer for the mode line display. */
21969 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21970 set_buffer_internal_1 (XBUFFER (w
->contents
));
21972 /* Point refers normally to the selected window. For any
21973 other window, set up appropriate value. */
21974 if (!EQ (window
, selected_window
))
21976 struct text_pos pt
;
21978 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21979 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21982 /* Display mode lines. */
21983 clear_glyph_matrix (w
->desired_matrix
);
21984 if (display_mode_lines (w
))
21987 /* Restore old settings. */
21988 set_buffer_internal_1 (old
);
21989 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21999 /* Display the mode and/or header line of window W. Value is the
22000 sum number of mode lines and header lines displayed. */
22003 display_mode_lines (struct window
*w
)
22005 Lisp_Object old_selected_window
= selected_window
;
22006 Lisp_Object old_selected_frame
= selected_frame
;
22007 Lisp_Object new_frame
= w
->frame
;
22008 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22011 selected_frame
= new_frame
;
22012 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22013 or window's point, then we'd need select_window_1 here as well. */
22014 XSETWINDOW (selected_window
, w
);
22015 XFRAME (new_frame
)->selected_window
= selected_window
;
22017 /* These will be set while the mode line specs are processed. */
22018 line_number_displayed
= 0;
22019 w
->column_number_displayed
= -1;
22021 if (WINDOW_WANTS_MODELINE_P (w
))
22023 struct window
*sel_w
= XWINDOW (old_selected_window
);
22025 /* Select mode line face based on the real selected window. */
22026 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22027 BVAR (current_buffer
, mode_line_format
));
22031 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22033 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22034 BVAR (current_buffer
, header_line_format
));
22038 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22039 selected_frame
= old_selected_frame
;
22040 selected_window
= old_selected_window
;
22042 w
->must_be_updated_p
= true;
22047 /* Display mode or header line of window W. FACE_ID specifies which
22048 line to display; it is either MODE_LINE_FACE_ID or
22049 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22050 display. Value is the pixel height of the mode/header line
22054 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22058 ptrdiff_t count
= SPECPDL_INDEX ();
22060 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22061 /* Don't extend on a previously drawn mode-line.
22062 This may happen if called from pos_visible_p. */
22063 it
.glyph_row
->enabled_p
= false;
22064 prepare_desired_row (w
, it
.glyph_row
, true);
22066 it
.glyph_row
->mode_line_p
= 1;
22068 /* FIXME: This should be controlled by a user option. But
22069 supporting such an option is not trivial, since the mode line is
22070 made up of many separate strings. */
22071 it
.paragraph_embedding
= L2R
;
22073 record_unwind_protect (unwind_format_mode_line
,
22074 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
22076 mode_line_target
= MODE_LINE_DISPLAY
;
22078 /* Temporarily make frame's keyboard the current kboard so that
22079 kboard-local variables in the mode_line_format will get the right
22081 push_kboard (FRAME_KBOARD (it
.f
));
22082 record_unwind_save_match_data ();
22083 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22086 unbind_to (count
, Qnil
);
22088 /* Fill up with spaces. */
22089 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22091 compute_line_metrics (&it
);
22092 it
.glyph_row
->full_width_p
= 1;
22093 it
.glyph_row
->continued_p
= 0;
22094 it
.glyph_row
->truncated_on_left_p
= 0;
22095 it
.glyph_row
->truncated_on_right_p
= 0;
22097 /* Make a 3D mode-line have a shadow at its right end. */
22098 face
= FACE_FROM_ID (it
.f
, face_id
);
22099 extend_face_to_end_of_line (&it
);
22100 if (face
->box
!= FACE_NO_BOX
)
22102 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22103 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22104 last
->right_box_line_p
= 1;
22107 return it
.glyph_row
->height
;
22110 /* Move element ELT in LIST to the front of LIST.
22111 Return the updated list. */
22114 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22116 register Lisp_Object tail
, prev
;
22117 register Lisp_Object tem
;
22121 while (CONSP (tail
))
22127 /* Splice out the link TAIL. */
22129 list
= XCDR (tail
);
22131 Fsetcdr (prev
, XCDR (tail
));
22133 /* Now make it the first. */
22134 Fsetcdr (tail
, list
);
22139 tail
= XCDR (tail
);
22143 /* Not found--return unchanged LIST. */
22147 /* Contribute ELT to the mode line for window IT->w. How it
22148 translates into text depends on its data type.
22150 IT describes the display environment in which we display, as usual.
22152 DEPTH is the depth in recursion. It is used to prevent
22153 infinite recursion here.
22155 FIELD_WIDTH is the number of characters the display of ELT should
22156 occupy in the mode line, and PRECISION is the maximum number of
22157 characters to display from ELT's representation. See
22158 display_string for details.
22160 Returns the hpos of the end of the text generated by ELT.
22162 PROPS is a property list to add to any string we encounter.
22164 If RISKY is nonzero, remove (disregard) any properties in any string
22165 we encounter, and ignore :eval and :propertize.
22167 The global variable `mode_line_target' determines whether the
22168 output is passed to `store_mode_line_noprop',
22169 `store_mode_line_string', or `display_string'. */
22172 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22173 Lisp_Object elt
, Lisp_Object props
, int risky
)
22175 int n
= 0, field
, prec
;
22180 elt
= build_string ("*too-deep*");
22184 switch (XTYPE (elt
))
22188 /* A string: output it and check for %-constructs within it. */
22190 ptrdiff_t offset
= 0;
22192 if (SCHARS (elt
) > 0
22193 && (!NILP (props
) || risky
))
22195 Lisp_Object oprops
, aelt
;
22196 oprops
= Ftext_properties_at (make_number (0), elt
);
22198 /* If the starting string's properties are not what
22199 we want, translate the string. Also, if the string
22200 is risky, do that anyway. */
22202 if (NILP (Fequal (props
, oprops
)) || risky
)
22204 /* If the starting string has properties,
22205 merge the specified ones onto the existing ones. */
22206 if (! NILP (oprops
) && !risky
)
22210 oprops
= Fcopy_sequence (oprops
);
22212 while (CONSP (tem
))
22214 oprops
= Fplist_put (oprops
, XCAR (tem
),
22215 XCAR (XCDR (tem
)));
22216 tem
= XCDR (XCDR (tem
));
22221 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22222 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22224 /* AELT is what we want. Move it to the front
22225 without consing. */
22227 mode_line_proptrans_alist
22228 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22234 /* If AELT has the wrong props, it is useless.
22235 so get rid of it. */
22237 mode_line_proptrans_alist
22238 = Fdelq (aelt
, mode_line_proptrans_alist
);
22240 elt
= Fcopy_sequence (elt
);
22241 Fset_text_properties (make_number (0), Flength (elt
),
22243 /* Add this item to mode_line_proptrans_alist. */
22244 mode_line_proptrans_alist
22245 = Fcons (Fcons (elt
, props
),
22246 mode_line_proptrans_alist
);
22247 /* Truncate mode_line_proptrans_alist
22248 to at most 50 elements. */
22249 tem
= Fnthcdr (make_number (50),
22250 mode_line_proptrans_alist
);
22252 XSETCDR (tem
, Qnil
);
22261 prec
= precision
- n
;
22262 switch (mode_line_target
)
22264 case MODE_LINE_NOPROP
:
22265 case MODE_LINE_TITLE
:
22266 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22268 case MODE_LINE_STRING
:
22269 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
22271 case MODE_LINE_DISPLAY
:
22272 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22273 0, prec
, 0, STRING_MULTIBYTE (elt
));
22280 /* Handle the non-literal case. */
22282 while ((precision
<= 0 || n
< precision
)
22283 && SREF (elt
, offset
) != 0
22284 && (mode_line_target
!= MODE_LINE_DISPLAY
22285 || it
->current_x
< it
->last_visible_x
))
22287 ptrdiff_t last_offset
= offset
;
22289 /* Advance to end of string or next format specifier. */
22290 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22293 if (offset
- 1 != last_offset
)
22295 ptrdiff_t nchars
, nbytes
;
22297 /* Output to end of string or up to '%'. Field width
22298 is length of string. Don't output more than
22299 PRECISION allows us. */
22302 prec
= c_string_width (SDATA (elt
) + last_offset
,
22303 offset
- last_offset
, precision
- n
,
22306 switch (mode_line_target
)
22308 case MODE_LINE_NOPROP
:
22309 case MODE_LINE_TITLE
:
22310 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22312 case MODE_LINE_STRING
:
22314 ptrdiff_t bytepos
= last_offset
;
22315 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22316 ptrdiff_t endpos
= (precision
<= 0
22317 ? string_byte_to_char (elt
, offset
)
22318 : charpos
+ nchars
);
22320 n
+= store_mode_line_string (NULL
,
22321 Fsubstring (elt
, make_number (charpos
),
22322 make_number (endpos
)),
22326 case MODE_LINE_DISPLAY
:
22328 ptrdiff_t bytepos
= last_offset
;
22329 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22331 if (precision
<= 0)
22332 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22333 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22335 STRING_MULTIBYTE (elt
));
22340 else /* c == '%' */
22342 ptrdiff_t percent_position
= offset
;
22344 /* Get the specified minimum width. Zero means
22347 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22348 field
= field
* 10 + c
- '0';
22350 /* Don't pad beyond the total padding allowed. */
22351 if (field_width
- n
> 0 && field
> field_width
- n
)
22352 field
= field_width
- n
;
22354 /* Note that either PRECISION <= 0 or N < PRECISION. */
22355 prec
= precision
- n
;
22358 n
+= display_mode_element (it
, depth
, field
, prec
,
22359 Vglobal_mode_string
, props
,
22364 ptrdiff_t bytepos
, charpos
;
22366 Lisp_Object string
;
22368 bytepos
= percent_position
;
22369 charpos
= (STRING_MULTIBYTE (elt
)
22370 ? string_byte_to_char (elt
, bytepos
)
22372 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22373 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22375 switch (mode_line_target
)
22377 case MODE_LINE_NOPROP
:
22378 case MODE_LINE_TITLE
:
22379 n
+= store_mode_line_noprop (spec
, field
, prec
);
22381 case MODE_LINE_STRING
:
22383 Lisp_Object tem
= build_string (spec
);
22384 props
= Ftext_properties_at (make_number (charpos
), elt
);
22385 /* Should only keep face property in props */
22386 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22389 case MODE_LINE_DISPLAY
:
22391 int nglyphs_before
, nwritten
;
22393 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22394 nwritten
= display_string (spec
, string
, elt
,
22399 /* Assign to the glyphs written above the
22400 string where the `%x' came from, position
22404 struct glyph
*glyph
22405 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22409 for (i
= 0; i
< nwritten
; ++i
)
22411 glyph
[i
].object
= elt
;
22412 glyph
[i
].charpos
= charpos
;
22429 /* A symbol: process the value of the symbol recursively
22430 as if it appeared here directly. Avoid error if symbol void.
22431 Special case: if value of symbol is a string, output the string
22434 register Lisp_Object tem
;
22436 /* If the variable is not marked as risky to set
22437 then its contents are risky to use. */
22438 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22441 tem
= Fboundp (elt
);
22444 tem
= Fsymbol_value (elt
);
22445 /* If value is a string, output that string literally:
22446 don't check for % within it. */
22450 if (!EQ (tem
, elt
))
22452 /* Give up right away for nil or t. */
22462 register Lisp_Object car
, tem
;
22464 /* A cons cell: five distinct cases.
22465 If first element is :eval or :propertize, do something special.
22466 If first element is a string or a cons, process all the elements
22467 and effectively concatenate them.
22468 If first element is a negative number, truncate displaying cdr to
22469 at most that many characters. If positive, pad (with spaces)
22470 to at least that many characters.
22471 If first element is a symbol, process the cadr or caddr recursively
22472 according to whether the symbol's value is non-nil or nil. */
22474 if (EQ (car
, QCeval
))
22476 /* An element of the form (:eval FORM) means evaluate FORM
22477 and use the result as mode line elements. */
22482 if (CONSP (XCDR (elt
)))
22485 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22486 n
+= display_mode_element (it
, depth
, field_width
- n
,
22487 precision
- n
, spec
, props
,
22491 else if (EQ (car
, QCpropertize
))
22493 /* An element of the form (:propertize ELT PROPS...)
22494 means display ELT but applying properties PROPS. */
22499 if (CONSP (XCDR (elt
)))
22500 n
+= display_mode_element (it
, depth
, field_width
- n
,
22501 precision
- n
, XCAR (XCDR (elt
)),
22502 XCDR (XCDR (elt
)), risky
);
22504 else if (SYMBOLP (car
))
22506 tem
= Fboundp (car
);
22510 /* elt is now the cdr, and we know it is a cons cell.
22511 Use its car if CAR has a non-nil value. */
22514 tem
= Fsymbol_value (car
);
22521 /* Symbol's value is nil (or symbol is unbound)
22522 Get the cddr of the original list
22523 and if possible find the caddr and use that. */
22527 else if (!CONSP (elt
))
22532 else if (INTEGERP (car
))
22534 register int lim
= XINT (car
);
22538 /* Negative int means reduce maximum width. */
22539 if (precision
<= 0)
22542 precision
= min (precision
, -lim
);
22546 /* Padding specified. Don't let it be more than
22547 current maximum. */
22549 lim
= min (precision
, lim
);
22551 /* If that's more padding than already wanted, queue it.
22552 But don't reduce padding already specified even if
22553 that is beyond the current truncation point. */
22554 field_width
= max (lim
, field_width
);
22558 else if (STRINGP (car
) || CONSP (car
))
22560 Lisp_Object halftail
= elt
;
22564 && (precision
<= 0 || n
< precision
))
22566 n
+= display_mode_element (it
, depth
,
22567 /* Do padding only after the last
22568 element in the list. */
22569 (! CONSP (XCDR (elt
))
22572 precision
- n
, XCAR (elt
),
22576 if ((len
& 1) == 0)
22577 halftail
= XCDR (halftail
);
22578 /* Check for cycle. */
22579 if (EQ (halftail
, elt
))
22588 elt
= build_string ("*invalid*");
22592 /* Pad to FIELD_WIDTH. */
22593 if (field_width
> 0 && n
< field_width
)
22595 switch (mode_line_target
)
22597 case MODE_LINE_NOPROP
:
22598 case MODE_LINE_TITLE
:
22599 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22601 case MODE_LINE_STRING
:
22602 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22604 case MODE_LINE_DISPLAY
:
22605 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22614 /* Store a mode-line string element in mode_line_string_list.
22616 If STRING is non-null, display that C string. Otherwise, the Lisp
22617 string LISP_STRING is displayed.
22619 FIELD_WIDTH is the minimum number of output glyphs to produce.
22620 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22621 with spaces. FIELD_WIDTH <= 0 means don't pad.
22623 PRECISION is the maximum number of characters to output from
22624 STRING. PRECISION <= 0 means don't truncate the string.
22626 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22627 properties to the string.
22629 PROPS are the properties to add to the string.
22630 The mode_line_string_face face property is always added to the string.
22634 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22635 int field_width
, int precision
, Lisp_Object props
)
22640 if (string
!= NULL
)
22642 len
= strlen (string
);
22643 if (precision
> 0 && len
> precision
)
22645 lisp_string
= make_string (string
, len
);
22647 props
= mode_line_string_face_prop
;
22648 else if (!NILP (mode_line_string_face
))
22650 Lisp_Object face
= Fplist_get (props
, Qface
);
22651 props
= Fcopy_sequence (props
);
22653 face
= mode_line_string_face
;
22655 face
= list2 (face
, mode_line_string_face
);
22656 props
= Fplist_put (props
, Qface
, face
);
22658 Fadd_text_properties (make_number (0), make_number (len
),
22659 props
, lisp_string
);
22663 len
= XFASTINT (Flength (lisp_string
));
22664 if (precision
> 0 && len
> precision
)
22667 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22670 if (!NILP (mode_line_string_face
))
22674 props
= Ftext_properties_at (make_number (0), lisp_string
);
22675 face
= Fplist_get (props
, Qface
);
22677 face
= mode_line_string_face
;
22679 face
= list2 (face
, mode_line_string_face
);
22680 props
= list2 (Qface
, face
);
22682 lisp_string
= Fcopy_sequence (lisp_string
);
22685 Fadd_text_properties (make_number (0), make_number (len
),
22686 props
, lisp_string
);
22691 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22695 if (field_width
> len
)
22697 field_width
-= len
;
22698 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22700 Fadd_text_properties (make_number (0), make_number (field_width
),
22701 props
, lisp_string
);
22702 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22710 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22712 doc
: /* Format a string out of a mode line format specification.
22713 First arg FORMAT specifies the mode line format (see `mode-line-format'
22714 for details) to use.
22716 By default, the format is evaluated for the currently selected window.
22718 Optional second arg FACE specifies the face property to put on all
22719 characters for which no face is specified. The value nil means the
22720 default face. The value t means whatever face the window's mode line
22721 currently uses (either `mode-line' or `mode-line-inactive',
22722 depending on whether the window is the selected window or not).
22723 An integer value means the value string has no text
22726 Optional third and fourth args WINDOW and BUFFER specify the window
22727 and buffer to use as the context for the formatting (defaults
22728 are the selected window and the WINDOW's buffer). */)
22729 (Lisp_Object format
, Lisp_Object face
,
22730 Lisp_Object window
, Lisp_Object buffer
)
22735 struct buffer
*old_buffer
= NULL
;
22737 int no_props
= INTEGERP (face
);
22738 ptrdiff_t count
= SPECPDL_INDEX ();
22740 int string_start
= 0;
22742 w
= decode_any_window (window
);
22743 XSETWINDOW (window
, w
);
22746 buffer
= w
->contents
;
22747 CHECK_BUFFER (buffer
);
22749 /* Make formatting the modeline a non-op when noninteractive, otherwise
22750 there will be problems later caused by a partially initialized frame. */
22751 if (NILP (format
) || noninteractive
)
22752 return empty_unibyte_string
;
22757 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22758 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22759 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22760 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22761 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22762 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22763 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22766 old_buffer
= current_buffer
;
22768 /* Save things including mode_line_proptrans_alist,
22769 and set that to nil so that we don't alter the outer value. */
22770 record_unwind_protect (unwind_format_mode_line
,
22771 format_mode_line_unwind_data
22772 (XFRAME (WINDOW_FRAME (w
)),
22773 old_buffer
, selected_window
, 1));
22774 mode_line_proptrans_alist
= Qnil
;
22776 Fselect_window (window
, Qt
);
22777 set_buffer_internal_1 (XBUFFER (buffer
));
22779 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22783 mode_line_target
= MODE_LINE_NOPROP
;
22784 mode_line_string_face_prop
= Qnil
;
22785 mode_line_string_list
= Qnil
;
22786 string_start
= MODE_LINE_NOPROP_LEN (0);
22790 mode_line_target
= MODE_LINE_STRING
;
22791 mode_line_string_list
= Qnil
;
22792 mode_line_string_face
= face
;
22793 mode_line_string_face_prop
22794 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22797 push_kboard (FRAME_KBOARD (it
.f
));
22798 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22803 len
= MODE_LINE_NOPROP_LEN (string_start
);
22804 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22808 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22809 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22810 empty_unibyte_string
);
22813 unbind_to (count
, Qnil
);
22817 /* Write a null-terminated, right justified decimal representation of
22818 the positive integer D to BUF using a minimal field width WIDTH. */
22821 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22823 register char *p
= buf
;
22831 *p
++ = d
% 10 + '0';
22836 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22847 /* Write a null-terminated, right justified decimal and "human
22848 readable" representation of the nonnegative integer D to BUF using
22849 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22851 static const char power_letter
[] =
22865 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22867 /* We aim to represent the nonnegative integer D as
22868 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22869 ptrdiff_t quotient
= d
;
22871 /* -1 means: do not use TENTHS. */
22875 /* Length of QUOTIENT.TENTHS as a string. */
22881 if (quotient
>= 1000)
22883 /* Scale to the appropriate EXPONENT. */
22886 remainder
= quotient
% 1000;
22890 while (quotient
>= 1000);
22892 /* Round to nearest and decide whether to use TENTHS or not. */
22895 tenths
= remainder
/ 100;
22896 if (remainder
% 100 >= 50)
22903 if (quotient
== 10)
22911 if (remainder
>= 500)
22913 if (quotient
< 999)
22924 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22925 if (tenths
== -1 && quotient
<= 99)
22932 p
= psuffix
= buf
+ max (width
, length
);
22934 /* Print EXPONENT. */
22935 *psuffix
++ = power_letter
[exponent
];
22938 /* Print TENTHS. */
22941 *--p
= '0' + tenths
;
22945 /* Print QUOTIENT. */
22948 int digit
= quotient
% 10;
22949 *--p
= '0' + digit
;
22951 while ((quotient
/= 10) != 0);
22953 /* Print leading spaces. */
22958 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22959 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22960 type of CODING_SYSTEM. Return updated pointer into BUF. */
22962 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22965 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22968 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22969 const unsigned char *eol_str
;
22971 /* The EOL conversion we are using. */
22972 Lisp_Object eoltype
;
22974 val
= CODING_SYSTEM_SPEC (coding_system
);
22977 if (!VECTORP (val
)) /* Not yet decided. */
22979 *buf
++ = multibyte
? '-' : ' ';
22981 eoltype
= eol_mnemonic_undecided
;
22982 /* Don't mention EOL conversion if it isn't decided. */
22987 Lisp_Object eolvalue
;
22989 attrs
= AREF (val
, 0);
22990 eolvalue
= AREF (val
, 2);
22993 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22998 /* The EOL conversion that is normal on this system. */
23000 if (NILP (eolvalue
)) /* Not yet decided. */
23001 eoltype
= eol_mnemonic_undecided
;
23002 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23003 eoltype
= eol_mnemonic_undecided
;
23004 else /* eolvalue is Qunix, Qdos, or Qmac. */
23005 eoltype
= (EQ (eolvalue
, Qunix
)
23006 ? eol_mnemonic_unix
23007 : (EQ (eolvalue
, Qdos
) == 1
23008 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
23014 /* Mention the EOL conversion if it is not the usual one. */
23015 if (STRINGP (eoltype
))
23017 eol_str
= SDATA (eoltype
);
23018 eol_str_len
= SBYTES (eoltype
);
23020 else if (CHARACTERP (eoltype
))
23022 int c
= XFASTINT (eoltype
);
23023 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23027 eol_str
= invalid_eol_type
;
23028 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23030 memcpy (buf
, eol_str
, eol_str_len
);
23031 buf
+= eol_str_len
;
23037 /* Return a string for the output of a mode line %-spec for window W,
23038 generated by character C. FIELD_WIDTH > 0 means pad the string
23039 returned with spaces to that value. Return a Lisp string in
23040 *STRING if the resulting string is taken from that Lisp string.
23042 Note we operate on the current buffer for most purposes. */
23044 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23046 static const char *
23047 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23048 Lisp_Object
*string
)
23051 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23052 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23053 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23054 produce strings from numerical values, so limit preposterously
23055 large values of FIELD_WIDTH to avoid overrunning the buffer's
23056 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23057 bytes plus the terminating null. */
23058 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23059 struct buffer
*b
= current_buffer
;
23067 if (!NILP (BVAR (b
, read_only
)))
23069 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23074 /* This differs from %* only for a modified read-only buffer. */
23075 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23077 if (!NILP (BVAR (b
, read_only
)))
23082 /* This differs from %* in ignoring read-only-ness. */
23083 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23095 if (command_loop_level
> 5)
23097 p
= decode_mode_spec_buf
;
23098 for (i
= 0; i
< command_loop_level
; i
++)
23101 return decode_mode_spec_buf
;
23109 if (command_loop_level
> 5)
23111 p
= decode_mode_spec_buf
;
23112 for (i
= 0; i
< command_loop_level
; i
++)
23115 return decode_mode_spec_buf
;
23122 /* Let lots_of_dashes be a string of infinite length. */
23123 if (mode_line_target
== MODE_LINE_NOPROP
23124 || mode_line_target
== MODE_LINE_STRING
)
23126 if (field_width
<= 0
23127 || field_width
> sizeof (lots_of_dashes
))
23129 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23130 decode_mode_spec_buf
[i
] = '-';
23131 decode_mode_spec_buf
[i
] = '\0';
23132 return decode_mode_spec_buf
;
23135 return lots_of_dashes
;
23139 obj
= BVAR (b
, name
);
23143 /* %c and %l are ignored in `frame-title-format'.
23144 (In redisplay_internal, the frame title is drawn _before_ the
23145 windows are updated, so the stuff which depends on actual
23146 window contents (such as %l) may fail to render properly, or
23147 even crash emacs.) */
23148 if (mode_line_target
== MODE_LINE_TITLE
)
23152 ptrdiff_t col
= current_column ();
23153 w
->column_number_displayed
= col
;
23154 pint2str (decode_mode_spec_buf
, width
, col
);
23155 return decode_mode_spec_buf
;
23159 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23161 if (NILP (Vmemory_full
))
23164 return "!MEM FULL! ";
23171 /* %F displays the frame name. */
23172 if (!NILP (f
->title
))
23173 return SSDATA (f
->title
);
23174 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23175 return SSDATA (f
->name
);
23179 obj
= BVAR (b
, filename
);
23184 ptrdiff_t size
= ZV
- BEGV
;
23185 pint2str (decode_mode_spec_buf
, width
, size
);
23186 return decode_mode_spec_buf
;
23191 ptrdiff_t size
= ZV
- BEGV
;
23192 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23193 return decode_mode_spec_buf
;
23198 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23199 ptrdiff_t topline
, nlines
, height
;
23202 /* %c and %l are ignored in `frame-title-format'. */
23203 if (mode_line_target
== MODE_LINE_TITLE
)
23206 startpos
= marker_position (w
->start
);
23207 startpos_byte
= marker_byte_position (w
->start
);
23208 height
= WINDOW_TOTAL_LINES (w
);
23210 /* If we decided that this buffer isn't suitable for line numbers,
23211 don't forget that too fast. */
23212 if (w
->base_line_pos
== -1)
23215 /* If the buffer is very big, don't waste time. */
23216 if (INTEGERP (Vline_number_display_limit
)
23217 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23219 w
->base_line_pos
= 0;
23220 w
->base_line_number
= 0;
23224 if (w
->base_line_number
> 0
23225 && w
->base_line_pos
> 0
23226 && w
->base_line_pos
<= startpos
)
23228 line
= w
->base_line_number
;
23229 linepos
= w
->base_line_pos
;
23230 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23235 linepos
= BUF_BEGV (b
);
23236 linepos_byte
= BUF_BEGV_BYTE (b
);
23239 /* Count lines from base line to window start position. */
23240 nlines
= display_count_lines (linepos_byte
,
23244 topline
= nlines
+ line
;
23246 /* Determine a new base line, if the old one is too close
23247 or too far away, or if we did not have one.
23248 "Too close" means it's plausible a scroll-down would
23249 go back past it. */
23250 if (startpos
== BUF_BEGV (b
))
23252 w
->base_line_number
= topline
;
23253 w
->base_line_pos
= BUF_BEGV (b
);
23255 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23256 || linepos
== BUF_BEGV (b
))
23258 ptrdiff_t limit
= BUF_BEGV (b
);
23259 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23260 ptrdiff_t position
;
23261 ptrdiff_t distance
=
23262 (height
* 2 + 30) * line_number_display_limit_width
;
23264 if (startpos
- distance
> limit
)
23266 limit
= startpos
- distance
;
23267 limit_byte
= CHAR_TO_BYTE (limit
);
23270 nlines
= display_count_lines (startpos_byte
,
23272 - (height
* 2 + 30),
23274 /* If we couldn't find the lines we wanted within
23275 line_number_display_limit_width chars per line,
23276 give up on line numbers for this window. */
23277 if (position
== limit_byte
&& limit
== startpos
- distance
)
23279 w
->base_line_pos
= -1;
23280 w
->base_line_number
= 0;
23284 w
->base_line_number
= topline
- nlines
;
23285 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23288 /* Now count lines from the start pos to point. */
23289 nlines
= display_count_lines (startpos_byte
,
23290 PT_BYTE
, PT
, &junk
);
23292 /* Record that we did display the line number. */
23293 line_number_displayed
= 1;
23295 /* Make the string to show. */
23296 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23297 return decode_mode_spec_buf
;
23300 char *p
= decode_mode_spec_buf
;
23301 int pad
= width
- 2;
23307 return decode_mode_spec_buf
;
23313 obj
= BVAR (b
, mode_name
);
23317 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23323 ptrdiff_t pos
= marker_position (w
->start
);
23324 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23326 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23328 if (pos
<= BUF_BEGV (b
))
23333 else if (pos
<= BUF_BEGV (b
))
23337 if (total
> 1000000)
23338 /* Do it differently for a large value, to avoid overflow. */
23339 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23341 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23342 /* We can't normally display a 3-digit number,
23343 so get us a 2-digit number that is close. */
23346 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23347 return decode_mode_spec_buf
;
23351 /* Display percentage of size above the bottom of the screen. */
23354 ptrdiff_t toppos
= marker_position (w
->start
);
23355 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23356 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23358 if (botpos
>= BUF_ZV (b
))
23360 if (toppos
<= BUF_BEGV (b
))
23367 if (total
> 1000000)
23368 /* Do it differently for a large value, to avoid overflow. */
23369 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23371 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23372 /* We can't normally display a 3-digit number,
23373 so get us a 2-digit number that is close. */
23376 if (toppos
<= BUF_BEGV (b
))
23377 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23379 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23380 return decode_mode_spec_buf
;
23385 /* status of process */
23386 obj
= Fget_buffer_process (Fcurrent_buffer ());
23388 return "no process";
23390 obj
= Fsymbol_name (Fprocess_status (obj
));
23396 ptrdiff_t count
= inhibit_garbage_collection ();
23397 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23398 Lisp_Object val
= Qnil
;
23400 if (STRINGP (curdir
))
23401 val
= call1 (intern ("file-remote-p"), curdir
);
23403 unbind_to (count
, Qnil
);
23412 /* coding-system (not including end-of-line format) */
23414 /* coding-system (including end-of-line type) */
23416 int eol_flag
= (c
== 'Z');
23417 char *p
= decode_mode_spec_buf
;
23419 if (! FRAME_WINDOW_P (f
))
23421 /* No need to mention EOL here--the terminal never needs
23422 to do EOL conversion. */
23423 p
= decode_mode_spec_coding (CODING_ID_NAME
23424 (FRAME_KEYBOARD_CODING (f
)->id
),
23426 p
= decode_mode_spec_coding (CODING_ID_NAME
23427 (FRAME_TERMINAL_CODING (f
)->id
),
23430 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23433 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23434 #ifdef subprocesses
23435 obj
= Fget_buffer_process (Fcurrent_buffer ());
23436 if (PROCESSP (obj
))
23438 p
= decode_mode_spec_coding
23439 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23440 p
= decode_mode_spec_coding
23441 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23443 #endif /* subprocesses */
23446 return decode_mode_spec_buf
;
23453 return SSDATA (obj
);
23460 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23461 means count lines back from START_BYTE. But don't go beyond
23462 LIMIT_BYTE. Return the number of lines thus found (always
23465 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23466 either the position COUNT lines after/before START_BYTE, if we
23467 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23471 display_count_lines (ptrdiff_t start_byte
,
23472 ptrdiff_t limit_byte
, ptrdiff_t count
,
23473 ptrdiff_t *byte_pos_ptr
)
23475 register unsigned char *cursor
;
23476 unsigned char *base
;
23478 register ptrdiff_t ceiling
;
23479 register unsigned char *ceiling_addr
;
23480 ptrdiff_t orig_count
= count
;
23482 /* If we are not in selective display mode,
23483 check only for newlines. */
23484 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23485 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23489 while (start_byte
< limit_byte
)
23491 ceiling
= BUFFER_CEILING_OF (start_byte
);
23492 ceiling
= min (limit_byte
- 1, ceiling
);
23493 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23494 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23498 if (selective_display
)
23500 while (*cursor
!= '\n' && *cursor
!= 015
23501 && ++cursor
!= ceiling_addr
)
23503 if (cursor
== ceiling_addr
)
23508 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23517 start_byte
+= cursor
- base
;
23518 *byte_pos_ptr
= start_byte
;
23522 while (cursor
< ceiling_addr
);
23524 start_byte
+= ceiling_addr
- base
;
23529 while (start_byte
> limit_byte
)
23531 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23532 ceiling
= max (limit_byte
, ceiling
);
23533 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23534 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23537 if (selective_display
)
23539 while (--cursor
>= ceiling_addr
23540 && *cursor
!= '\n' && *cursor
!= 015)
23542 if (cursor
< ceiling_addr
)
23547 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23554 start_byte
+= cursor
- base
+ 1;
23555 *byte_pos_ptr
= start_byte
;
23556 /* When scanning backwards, we should
23557 not count the newline posterior to which we stop. */
23558 return - orig_count
- 1;
23561 start_byte
+= ceiling_addr
- base
;
23565 *byte_pos_ptr
= limit_byte
;
23568 return - orig_count
+ count
;
23569 return orig_count
- count
;
23575 /***********************************************************************
23577 ***********************************************************************/
23579 /* Display a NUL-terminated string, starting with index START.
23581 If STRING is non-null, display that C string. Otherwise, the Lisp
23582 string LISP_STRING is displayed. There's a case that STRING is
23583 non-null and LISP_STRING is not nil. It means STRING is a string
23584 data of LISP_STRING. In that case, we display LISP_STRING while
23585 ignoring its text properties.
23587 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23588 FACE_STRING. Display STRING or LISP_STRING with the face at
23589 FACE_STRING_POS in FACE_STRING:
23591 Display the string in the environment given by IT, but use the
23592 standard display table, temporarily.
23594 FIELD_WIDTH is the minimum number of output glyphs to produce.
23595 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23596 with spaces. If STRING has more characters, more than FIELD_WIDTH
23597 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23599 PRECISION is the maximum number of characters to output from
23600 STRING. PRECISION < 0 means don't truncate the string.
23602 This is roughly equivalent to printf format specifiers:
23604 FIELD_WIDTH PRECISION PRINTF
23605 ----------------------------------------
23611 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23612 display them, and < 0 means obey the current buffer's value of
23613 enable_multibyte_characters.
23615 Value is the number of columns displayed. */
23618 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23619 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23620 int field_width
, int precision
, int max_x
, int multibyte
)
23622 int hpos_at_start
= it
->hpos
;
23623 int saved_face_id
= it
->face_id
;
23624 struct glyph_row
*row
= it
->glyph_row
;
23625 ptrdiff_t it_charpos
;
23627 /* Initialize the iterator IT for iteration over STRING beginning
23628 with index START. */
23629 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23630 precision
, field_width
, multibyte
);
23631 if (string
&& STRINGP (lisp_string
))
23632 /* LISP_STRING is the one returned by decode_mode_spec. We should
23633 ignore its text properties. */
23634 it
->stop_charpos
= it
->end_charpos
;
23636 /* If displaying STRING, set up the face of the iterator from
23637 FACE_STRING, if that's given. */
23638 if (STRINGP (face_string
))
23644 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23645 0, &endptr
, it
->base_face_id
, 0);
23646 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23647 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23650 /* Set max_x to the maximum allowed X position. Don't let it go
23651 beyond the right edge of the window. */
23653 max_x
= it
->last_visible_x
;
23655 max_x
= min (max_x
, it
->last_visible_x
);
23657 /* Skip over display elements that are not visible. because IT->w is
23659 if (it
->current_x
< it
->first_visible_x
)
23660 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23661 MOVE_TO_POS
| MOVE_TO_X
);
23663 row
->ascent
= it
->max_ascent
;
23664 row
->height
= it
->max_ascent
+ it
->max_descent
;
23665 row
->phys_ascent
= it
->max_phys_ascent
;
23666 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23667 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23669 if (STRINGP (it
->string
))
23670 it_charpos
= IT_STRING_CHARPOS (*it
);
23672 it_charpos
= IT_CHARPOS (*it
);
23674 /* This condition is for the case that we are called with current_x
23675 past last_visible_x. */
23676 while (it
->current_x
< max_x
)
23678 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23680 /* Get the next display element. */
23681 if (!get_next_display_element (it
))
23684 /* Produce glyphs. */
23685 x_before
= it
->current_x
;
23686 n_glyphs_before
= row
->used
[TEXT_AREA
];
23687 PRODUCE_GLYPHS (it
);
23689 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23692 while (i
< nglyphs
)
23694 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23696 if (it
->line_wrap
!= TRUNCATE
23697 && x
+ glyph
->pixel_width
> max_x
)
23699 /* End of continued line or max_x reached. */
23700 if (CHAR_GLYPH_PADDING_P (*glyph
))
23702 /* A wide character is unbreakable. */
23703 if (row
->reversed_p
)
23704 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23705 - n_glyphs_before
);
23706 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23707 it
->current_x
= x_before
;
23711 if (row
->reversed_p
)
23712 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23713 - (n_glyphs_before
+ i
));
23714 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23719 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23721 /* Glyph is at least partially visible. */
23723 if (x
< it
->first_visible_x
)
23724 row
->x
= x
- it
->first_visible_x
;
23728 /* Glyph is off the left margin of the display area.
23729 Should not happen. */
23733 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23734 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23735 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23736 row
->phys_height
= max (row
->phys_height
,
23737 it
->max_phys_ascent
+ it
->max_phys_descent
);
23738 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23739 it
->max_extra_line_spacing
);
23740 x
+= glyph
->pixel_width
;
23744 /* Stop if max_x reached. */
23748 /* Stop at line ends. */
23749 if (ITERATOR_AT_END_OF_LINE_P (it
))
23751 it
->continuation_lines_width
= 0;
23755 set_iterator_to_next (it
, 1);
23756 if (STRINGP (it
->string
))
23757 it_charpos
= IT_STRING_CHARPOS (*it
);
23759 it_charpos
= IT_CHARPOS (*it
);
23761 /* Stop if truncating at the right edge. */
23762 if (it
->line_wrap
== TRUNCATE
23763 && it
->current_x
>= it
->last_visible_x
)
23765 /* Add truncation mark, but don't do it if the line is
23766 truncated at a padding space. */
23767 if (it_charpos
< it
->string_nchars
)
23769 if (!FRAME_WINDOW_P (it
->f
))
23773 if (it
->current_x
> it
->last_visible_x
)
23775 if (!row
->reversed_p
)
23777 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23778 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23783 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23784 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23786 unproduce_glyphs (it
, ii
+ 1);
23787 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23789 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23791 row
->used
[TEXT_AREA
] = ii
;
23792 produce_special_glyphs (it
, IT_TRUNCATION
);
23795 produce_special_glyphs (it
, IT_TRUNCATION
);
23797 row
->truncated_on_right_p
= 1;
23803 /* Maybe insert a truncation at the left. */
23804 if (it
->first_visible_x
23807 if (!FRAME_WINDOW_P (it
->f
)
23808 || (row
->reversed_p
23809 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23810 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23811 insert_left_trunc_glyphs (it
);
23812 row
->truncated_on_left_p
= 1;
23815 it
->face_id
= saved_face_id
;
23817 /* Value is number of columns displayed. */
23818 return it
->hpos
- hpos_at_start
;
23823 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23824 appears as an element of LIST or as the car of an element of LIST.
23825 If PROPVAL is a list, compare each element against LIST in that
23826 way, and return 1/2 if any element of PROPVAL is found in LIST.
23827 Otherwise return 0. This function cannot quit.
23828 The return value is 2 if the text is invisible but with an ellipsis
23829 and 1 if it's invisible and without an ellipsis. */
23832 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23834 register Lisp_Object tail
, proptail
;
23836 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23838 register Lisp_Object tem
;
23840 if (EQ (propval
, tem
))
23842 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23843 return NILP (XCDR (tem
)) ? 1 : 2;
23846 if (CONSP (propval
))
23848 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23850 Lisp_Object propelt
;
23851 propelt
= XCAR (proptail
);
23852 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23854 register Lisp_Object tem
;
23856 if (EQ (propelt
, tem
))
23858 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23859 return NILP (XCDR (tem
)) ? 1 : 2;
23867 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23868 doc
: /* Non-nil if the property makes the text invisible.
23869 POS-OR-PROP can be a marker or number, in which case it is taken to be
23870 a position in the current buffer and the value of the `invisible' property
23871 is checked; or it can be some other value, which is then presumed to be the
23872 value of the `invisible' property of the text of interest.
23873 The non-nil value returned can be t for truly invisible text or something
23874 else if the text is replaced by an ellipsis. */)
23875 (Lisp_Object pos_or_prop
)
23878 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23879 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23881 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23882 return (invis
== 0 ? Qnil
23884 : make_number (invis
));
23887 /* Calculate a width or height in pixels from a specification using
23888 the following elements:
23891 NUM - a (fractional) multiple of the default font width/height
23892 (NUM) - specifies exactly NUM pixels
23893 UNIT - a fixed number of pixels, see below.
23894 ELEMENT - size of a display element in pixels, see below.
23895 (NUM . SPEC) - equals NUM * SPEC
23896 (+ SPEC SPEC ...) - add pixel values
23897 (- SPEC SPEC ...) - subtract pixel values
23898 (- SPEC) - negate pixel value
23901 INT or FLOAT - a number constant
23902 SYMBOL - use symbol's (buffer local) variable binding.
23905 in - pixels per inch *)
23906 mm - pixels per 1/1000 meter *)
23907 cm - pixels per 1/100 meter *)
23908 width - width of current font in pixels.
23909 height - height of current font in pixels.
23911 *) using the ratio(s) defined in display-pixels-per-inch.
23915 left-fringe - left fringe width in pixels
23916 right-fringe - right fringe width in pixels
23918 left-margin - left margin width in pixels
23919 right-margin - right margin width in pixels
23921 scroll-bar - scroll-bar area width in pixels
23925 Pixels corresponding to 5 inches:
23928 Total width of non-text areas on left side of window (if scroll-bar is on left):
23929 '(space :width (+ left-fringe left-margin scroll-bar))
23931 Align to first text column (in header line):
23932 '(space :align-to 0)
23934 Align to middle of text area minus half the width of variable `my-image'
23935 containing a loaded image:
23936 '(space :align-to (0.5 . (- text my-image)))
23938 Width of left margin minus width of 1 character in the default font:
23939 '(space :width (- left-margin 1))
23941 Width of left margin minus width of 2 characters in the current font:
23942 '(space :width (- left-margin (2 . width)))
23944 Center 1 character over left-margin (in header line):
23945 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23947 Different ways to express width of left fringe plus left margin minus one pixel:
23948 '(space :width (- (+ left-fringe left-margin) (1)))
23949 '(space :width (+ left-fringe left-margin (- (1))))
23950 '(space :width (+ left-fringe left-margin (-1)))
23955 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23956 struct font
*font
, int width_p
, int *align_to
)
23960 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23961 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23964 return OK_PIXELS (0);
23966 eassert (FRAME_LIVE_P (it
->f
));
23968 if (SYMBOLP (prop
))
23970 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23972 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23974 if (unit
[0] == 'i' && unit
[1] == 'n')
23976 else if (unit
[0] == 'm' && unit
[1] == 'm')
23978 else if (unit
[0] == 'c' && unit
[1] == 'm')
23984 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23985 : FRAME_RES_Y (it
->f
));
23988 return OK_PIXELS (ppi
/ pixels
);
23993 #ifdef HAVE_WINDOW_SYSTEM
23994 if (EQ (prop
, Qheight
))
23995 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23996 if (EQ (prop
, Qwidth
))
23997 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23999 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24000 return OK_PIXELS (1);
24003 if (EQ (prop
, Qtext
))
24004 return OK_PIXELS (width_p
24005 ? window_box_width (it
->w
, TEXT_AREA
)
24006 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24008 if (align_to
&& *align_to
< 0)
24011 if (EQ (prop
, Qleft
))
24012 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24013 if (EQ (prop
, Qright
))
24014 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24015 if (EQ (prop
, Qcenter
))
24016 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24017 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24018 if (EQ (prop
, Qleft_fringe
))
24019 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24020 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24021 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24022 if (EQ (prop
, Qright_fringe
))
24023 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24024 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24025 : window_box_right_offset (it
->w
, TEXT_AREA
));
24026 if (EQ (prop
, Qleft_margin
))
24027 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24028 if (EQ (prop
, Qright_margin
))
24029 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24030 if (EQ (prop
, Qscroll_bar
))
24031 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24033 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24034 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24035 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24040 if (EQ (prop
, Qleft_fringe
))
24041 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24042 if (EQ (prop
, Qright_fringe
))
24043 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24044 if (EQ (prop
, Qleft_margin
))
24045 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24046 if (EQ (prop
, Qright_margin
))
24047 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24048 if (EQ (prop
, Qscroll_bar
))
24049 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24052 prop
= buffer_local_value (prop
, it
->w
->contents
);
24053 if (EQ (prop
, Qunbound
))
24057 if (INTEGERP (prop
) || FLOATP (prop
))
24059 int base_unit
= (width_p
24060 ? FRAME_COLUMN_WIDTH (it
->f
)
24061 : FRAME_LINE_HEIGHT (it
->f
));
24062 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24067 Lisp_Object car
= XCAR (prop
);
24068 Lisp_Object cdr
= XCDR (prop
);
24072 #ifdef HAVE_WINDOW_SYSTEM
24073 if (FRAME_WINDOW_P (it
->f
)
24074 && valid_image_p (prop
))
24076 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24077 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24079 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24081 #ifdef HAVE_XWIDGETS
24082 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24084 //TODO dont return dummy size
24085 return OK_PIXELS (width_p
? 100 : 100);
24089 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24095 while (CONSP (cdr
))
24097 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24098 font
, width_p
, align_to
))
24101 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
24106 if (EQ (car
, Qminus
))
24108 return OK_PIXELS (pixels
);
24111 car
= buffer_local_value (car
, it
->w
->contents
);
24112 if (EQ (car
, Qunbound
))
24116 if (INTEGERP (car
) || FLOATP (car
))
24119 pixels
= XFLOATINT (car
);
24121 return OK_PIXELS (pixels
);
24122 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24123 font
, width_p
, align_to
))
24124 return OK_PIXELS (pixels
* fact
);
24135 /***********************************************************************
24137 ***********************************************************************/
24139 #ifdef HAVE_WINDOW_SYSTEM
24144 dump_glyph_string (struct glyph_string
*s
)
24146 fprintf (stderr
, "glyph string\n");
24147 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24148 s
->x
, s
->y
, s
->width
, s
->height
);
24149 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24150 fprintf (stderr
, " hl = %d\n", s
->hl
);
24151 fprintf (stderr
, " left overhang = %d, right = %d\n",
24152 s
->left_overhang
, s
->right_overhang
);
24153 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24154 fprintf (stderr
, " extends to end of line = %d\n",
24155 s
->extends_to_end_of_line_p
);
24156 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24157 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24160 #endif /* GLYPH_DEBUG */
24162 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24163 of XChar2b structures for S; it can't be allocated in
24164 init_glyph_string because it must be allocated via `alloca'. W
24165 is the window on which S is drawn. ROW and AREA are the glyph row
24166 and area within the row from which S is constructed. START is the
24167 index of the first glyph structure covered by S. HL is a
24168 face-override for drawing S. */
24171 #define OPTIONAL_HDC(hdc) HDC hdc,
24172 #define DECLARE_HDC(hdc) HDC hdc;
24173 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24174 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24177 #ifndef OPTIONAL_HDC
24178 #define OPTIONAL_HDC(hdc)
24179 #define DECLARE_HDC(hdc)
24180 #define ALLOCATE_HDC(hdc, f)
24181 #define RELEASE_HDC(hdc, f)
24185 init_glyph_string (struct glyph_string
*s
,
24187 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24188 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24190 memset (s
, 0, sizeof *s
);
24192 s
->f
= XFRAME (w
->frame
);
24196 s
->display
= FRAME_X_DISPLAY (s
->f
);
24197 s
->window
= FRAME_X_WINDOW (s
->f
);
24198 s
->char2b
= char2b
;
24202 s
->first_glyph
= row
->glyphs
[area
] + start
;
24203 s
->height
= row
->height
;
24204 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24205 s
->ybase
= s
->y
+ row
->ascent
;
24209 /* Append the list of glyph strings with head H and tail T to the list
24210 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24213 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24214 struct glyph_string
*h
, struct glyph_string
*t
)
24228 /* Prepend the list of glyph strings with head H and tail T to the
24229 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24233 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24234 struct glyph_string
*h
, struct glyph_string
*t
)
24248 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24249 Set *HEAD and *TAIL to the resulting list. */
24252 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24253 struct glyph_string
*s
)
24255 s
->next
= s
->prev
= NULL
;
24256 append_glyph_string_lists (head
, tail
, s
, s
);
24260 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24261 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
24262 make sure that X resources for the face returned are allocated.
24263 Value is a pointer to a realized face that is ready for display if
24264 DISPLAY_P is non-zero. */
24266 static struct face
*
24267 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24268 XChar2b
*char2b
, int display_p
)
24270 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24275 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24277 if (code
== FONT_INVALID_CODE
)
24280 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24282 /* Make sure X resources of the face are allocated. */
24283 #ifdef HAVE_X_WINDOWS
24287 eassert (face
!= NULL
);
24288 prepare_face_for_display (f
, face
);
24295 /* Get face and two-byte form of character glyph GLYPH on frame F.
24296 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24297 a pointer to a realized face that is ready for display. */
24299 static struct face
*
24300 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24301 XChar2b
*char2b
, int *two_byte_p
)
24306 eassert (glyph
->type
== CHAR_GLYPH
);
24307 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24309 /* Make sure X resources of the face are allocated. */
24310 eassert (face
!= NULL
);
24311 prepare_face_for_display (f
, face
);
24318 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24319 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24321 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24323 if (code
== FONT_INVALID_CODE
)
24327 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24332 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24333 Return 1 if FONT has a glyph for C, otherwise return 0. */
24336 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24340 if (CHAR_BYTE8_P (c
))
24341 code
= CHAR_TO_BYTE8 (c
);
24343 code
= font
->driver
->encode_char (font
, c
);
24345 if (code
== FONT_INVALID_CODE
)
24347 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24352 /* Fill glyph string S with composition components specified by S->cmp.
24354 BASE_FACE is the base face of the composition.
24355 S->cmp_from is the index of the first component for S.
24357 OVERLAPS non-zero means S should draw the foreground only, and use
24358 its physical height for clipping. See also draw_glyphs.
24360 Value is the index of a component not in S. */
24363 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24367 /* For all glyphs of this composition, starting at the offset
24368 S->cmp_from, until we reach the end of the definition or encounter a
24369 glyph that requires the different face, add it to S. */
24374 s
->for_overlaps
= overlaps
;
24377 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24379 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24381 /* TAB in a composition means display glyphs with padding space
24382 on the left or right. */
24385 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24388 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24395 s
->font
= s
->face
->font
;
24397 else if (s
->face
!= face
)
24405 if (s
->face
== NULL
)
24407 s
->face
= base_face
->ascii_face
;
24408 s
->font
= s
->face
->font
;
24411 /* All glyph strings for the same composition has the same width,
24412 i.e. the width set for the first component of the composition. */
24413 s
->width
= s
->first_glyph
->pixel_width
;
24415 /* If the specified font could not be loaded, use the frame's
24416 default font, but record the fact that we couldn't load it in
24417 the glyph string so that we can draw rectangles for the
24418 characters of the glyph string. */
24419 if (s
->font
== NULL
)
24421 s
->font_not_found_p
= 1;
24422 s
->font
= FRAME_FONT (s
->f
);
24425 /* Adjust base line for subscript/superscript text. */
24426 s
->ybase
+= s
->first_glyph
->voffset
;
24428 /* This glyph string must always be drawn with 16-bit functions. */
24435 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24436 int start
, int end
, int overlaps
)
24438 struct glyph
*glyph
, *last
;
24439 Lisp_Object lgstring
;
24442 s
->for_overlaps
= overlaps
;
24443 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24444 last
= s
->row
->glyphs
[s
->area
] + end
;
24445 s
->cmp_id
= glyph
->u
.cmp
.id
;
24446 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24447 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24448 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24449 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24450 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24452 while (glyph
< last
24453 && glyph
->u
.cmp
.automatic
24454 && glyph
->u
.cmp
.id
== s
->cmp_id
24455 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24456 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24458 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24460 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24461 unsigned code
= LGLYPH_CODE (lglyph
);
24463 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24465 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24466 return glyph
- s
->row
->glyphs
[s
->area
];
24470 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24471 See the comment of fill_glyph_string for arguments.
24472 Value is the index of the first glyph not in S. */
24476 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24477 int start
, int end
, int overlaps
)
24479 struct glyph
*glyph
, *last
;
24482 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24483 s
->for_overlaps
= overlaps
;
24484 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24485 last
= s
->row
->glyphs
[s
->area
] + end
;
24486 voffset
= glyph
->voffset
;
24487 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24488 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24490 s
->width
= glyph
->pixel_width
;
24492 while (glyph
< last
24493 && glyph
->type
== GLYPHLESS_GLYPH
24494 && glyph
->voffset
== voffset
24495 && glyph
->face_id
== face_id
)
24498 s
->width
+= glyph
->pixel_width
;
24501 s
->ybase
+= voffset
;
24502 return glyph
- s
->row
->glyphs
[s
->area
];
24506 /* Fill glyph string S from a sequence of character glyphs.
24508 FACE_ID is the face id of the string. START is the index of the
24509 first glyph to consider, END is the index of the last + 1.
24510 OVERLAPS non-zero means S should draw the foreground only, and use
24511 its physical height for clipping. See also draw_glyphs.
24513 Value is the index of the first glyph not in S. */
24516 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24517 int start
, int end
, int overlaps
)
24519 struct glyph
*glyph
, *last
;
24521 int glyph_not_available_p
;
24523 eassert (s
->f
== XFRAME (s
->w
->frame
));
24524 eassert (s
->nchars
== 0);
24525 eassert (start
>= 0 && end
> start
);
24527 s
->for_overlaps
= overlaps
;
24528 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24529 last
= s
->row
->glyphs
[s
->area
] + end
;
24530 voffset
= glyph
->voffset
;
24531 s
->padding_p
= glyph
->padding_p
;
24532 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24534 while (glyph
< last
24535 && glyph
->type
== CHAR_GLYPH
24536 && glyph
->voffset
== voffset
24537 /* Same face id implies same font, nowadays. */
24538 && glyph
->face_id
== face_id
24539 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24543 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24544 s
->char2b
+ s
->nchars
,
24546 s
->two_byte_p
= two_byte_p
;
24548 eassert (s
->nchars
<= end
- start
);
24549 s
->width
+= glyph
->pixel_width
;
24550 if (glyph
++->padding_p
!= s
->padding_p
)
24554 s
->font
= s
->face
->font
;
24556 /* If the specified font could not be loaded, use the frame's font,
24557 but record the fact that we couldn't load it in
24558 S->font_not_found_p so that we can draw rectangles for the
24559 characters of the glyph string. */
24560 if (s
->font
== NULL
|| glyph_not_available_p
)
24562 s
->font_not_found_p
= 1;
24563 s
->font
= FRAME_FONT (s
->f
);
24566 /* Adjust base line for subscript/superscript text. */
24567 s
->ybase
+= voffset
;
24569 eassert (s
->face
&& s
->face
->gc
);
24570 return glyph
- s
->row
->glyphs
[s
->area
];
24574 /* Fill glyph string S from image glyph S->first_glyph. */
24577 fill_image_glyph_string (struct glyph_string
*s
)
24579 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24580 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24582 s
->slice
= s
->first_glyph
->slice
.img
;
24583 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24584 s
->font
= s
->face
->font
;
24585 s
->width
= s
->first_glyph
->pixel_width
;
24587 /* Adjust base line for subscript/superscript text. */
24588 s
->ybase
+= s
->first_glyph
->voffset
;
24592 #ifdef HAVE_XWIDGETS
24594 fill_xwidget_glyph_string (struct glyph_string
*s
)
24596 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24597 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24598 s
->font
= s
->face
->font
;
24599 s
->width
= s
->first_glyph
->pixel_width
;
24600 s
->ybase
+= s
->first_glyph
->voffset
;
24601 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24604 /* Fill glyph string S from a sequence of stretch glyphs.
24606 START is the index of the first glyph to consider,
24607 END is the index of the last + 1.
24609 Value is the index of the first glyph not in S. */
24612 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24614 struct glyph
*glyph
, *last
;
24615 int voffset
, face_id
;
24617 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24619 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24620 last
= s
->row
->glyphs
[s
->area
] + end
;
24621 face_id
= glyph
->face_id
;
24622 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24623 s
->font
= s
->face
->font
;
24624 s
->width
= glyph
->pixel_width
;
24626 voffset
= glyph
->voffset
;
24630 && glyph
->type
== STRETCH_GLYPH
24631 && glyph
->voffset
== voffset
24632 && glyph
->face_id
== face_id
);
24634 s
->width
+= glyph
->pixel_width
;
24636 /* Adjust base line for subscript/superscript text. */
24637 s
->ybase
+= voffset
;
24639 /* The case that face->gc == 0 is handled when drawing the glyph
24640 string by calling prepare_face_for_display. */
24642 return glyph
- s
->row
->glyphs
[s
->area
];
24645 static struct font_metrics
*
24646 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24648 static struct font_metrics metrics
;
24653 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24654 if (code
== FONT_INVALID_CODE
)
24656 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24661 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24662 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24663 assumed to be zero. */
24666 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24668 *left
= *right
= 0;
24670 if (glyph
->type
== CHAR_GLYPH
)
24674 struct font_metrics
*pcm
;
24676 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24677 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24679 if (pcm
->rbearing
> pcm
->width
)
24680 *right
= pcm
->rbearing
- pcm
->width
;
24681 if (pcm
->lbearing
< 0)
24682 *left
= -pcm
->lbearing
;
24685 else if (glyph
->type
== COMPOSITE_GLYPH
)
24687 if (! glyph
->u
.cmp
.automatic
)
24689 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24691 if (cmp
->rbearing
> cmp
->pixel_width
)
24692 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24693 if (cmp
->lbearing
< 0)
24694 *left
= - cmp
->lbearing
;
24698 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24699 struct font_metrics metrics
;
24701 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24702 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24703 if (metrics
.rbearing
> metrics
.width
)
24704 *right
= metrics
.rbearing
- metrics
.width
;
24705 if (metrics
.lbearing
< 0)
24706 *left
= - metrics
.lbearing
;
24712 /* Return the index of the first glyph preceding glyph string S that
24713 is overwritten by S because of S's left overhang. Value is -1
24714 if no glyphs are overwritten. */
24717 left_overwritten (struct glyph_string
*s
)
24721 if (s
->left_overhang
)
24724 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24725 int first
= s
->first_glyph
- glyphs
;
24727 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24728 x
-= glyphs
[i
].pixel_width
;
24739 /* Return the index of the first glyph preceding glyph string S that
24740 is overwriting S because of its right overhang. Value is -1 if no
24741 glyph in front of S overwrites S. */
24744 left_overwriting (struct glyph_string
*s
)
24747 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24748 int first
= s
->first_glyph
- glyphs
;
24752 for (i
= first
- 1; i
>= 0; --i
)
24755 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24758 x
-= glyphs
[i
].pixel_width
;
24765 /* Return the index of the last glyph following glyph string S that is
24766 overwritten by S because of S's right overhang. Value is -1 if
24767 no such glyph is found. */
24770 right_overwritten (struct glyph_string
*s
)
24774 if (s
->right_overhang
)
24777 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24778 int first
= (s
->first_glyph
- glyphs
24779 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24780 int end
= s
->row
->used
[s
->area
];
24782 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24783 x
+= glyphs
[i
].pixel_width
;
24792 /* Return the index of the last glyph following glyph string S that
24793 overwrites S because of its left overhang. Value is negative
24794 if no such glyph is found. */
24797 right_overwriting (struct glyph_string
*s
)
24800 int end
= s
->row
->used
[s
->area
];
24801 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24802 int first
= (s
->first_glyph
- glyphs
24803 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24807 for (i
= first
; i
< end
; ++i
)
24810 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24813 x
+= glyphs
[i
].pixel_width
;
24820 /* Set background width of glyph string S. START is the index of the
24821 first glyph following S. LAST_X is the right-most x-position + 1
24822 in the drawing area. */
24825 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24827 /* If the face of this glyph string has to be drawn to the end of
24828 the drawing area, set S->extends_to_end_of_line_p. */
24830 if (start
== s
->row
->used
[s
->area
]
24831 && ((s
->row
->fill_line_p
24832 && (s
->hl
== DRAW_NORMAL_TEXT
24833 || s
->hl
== DRAW_IMAGE_RAISED
24834 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24835 || s
->hl
== DRAW_MOUSE_FACE
))
24836 s
->extends_to_end_of_line_p
= 1;
24838 /* If S extends its face to the end of the line, set its
24839 background_width to the distance to the right edge of the drawing
24841 if (s
->extends_to_end_of_line_p
)
24842 s
->background_width
= last_x
- s
->x
+ 1;
24844 s
->background_width
= s
->width
;
24848 /* Compute overhangs and x-positions for glyph string S and its
24849 predecessors, or successors. X is the starting x-position for S.
24850 BACKWARD_P non-zero means process predecessors. */
24853 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24859 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24860 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24870 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24871 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24881 /* The following macros are only called from draw_glyphs below.
24882 They reference the following parameters of that function directly:
24883 `w', `row', `area', and `overlap_p'
24884 as well as the following local variables:
24885 `s', `f', and `hdc' (in W32) */
24888 /* On W32, silently add local `hdc' variable to argument list of
24889 init_glyph_string. */
24890 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24891 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24893 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24894 init_glyph_string (s, char2b, w, row, area, start, hl)
24897 /* Add a glyph string for a stretch glyph to the list of strings
24898 between HEAD and TAIL. START is the index of the stretch glyph in
24899 row area AREA of glyph row ROW. END is the index of the last glyph
24900 in that glyph row area. X is the current output position assigned
24901 to the new glyph string constructed. HL overrides that face of the
24902 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24903 is the right-most x-position of the drawing area. */
24905 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24906 and below -- keep them on one line. */
24907 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24910 s = alloca (sizeof *s); \
24911 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24912 START = fill_stretch_glyph_string (s, START, END); \
24913 append_glyph_string (&HEAD, &TAIL, s); \
24919 /* Add a glyph string for an image glyph to the list of strings
24920 between HEAD and TAIL. START is the index of the image glyph in
24921 row area AREA of glyph row ROW. END is the index of the last glyph
24922 in that glyph row area. X is the current output position assigned
24923 to the new glyph string constructed. HL overrides that face of the
24924 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24925 is the right-most x-position of the drawing area. */
24927 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24930 s = alloca (sizeof *s); \
24931 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24932 fill_image_glyph_string (s); \
24933 append_glyph_string (&HEAD, &TAIL, s); \
24939 #ifdef HAVE_XWIDGETS
24940 #define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24943 s = (struct glyph_string *) alloca (sizeof *s); \
24944 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24945 fill_xwidget_glyph_string (s); \
24946 append_glyph_string (&HEAD, &TAIL, s); \
24954 /* Add a glyph string for a sequence of character glyphs to the list
24955 of strings between HEAD and TAIL. START is the index of the first
24956 glyph in row area AREA of glyph row ROW that is part of the new
24957 glyph string. END is the index of the last glyph in that glyph row
24958 area. X is the current output position assigned to the new glyph
24959 string constructed. HL overrides that face of the glyph; e.g. it
24960 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24961 right-most x-position of the drawing area. */
24963 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24969 face_id = (row)->glyphs[area][START].face_id; \
24971 s = alloca (sizeof *s); \
24972 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
24973 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24974 append_glyph_string (&HEAD, &TAIL, s); \
24976 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24981 /* Add a glyph string for a composite sequence to the list of strings
24982 between HEAD and TAIL. START is the index of the first glyph in
24983 row area AREA of glyph row ROW that is part of the new glyph
24984 string. END is the index of the last glyph in that glyph row area.
24985 X is the current output position assigned to the new glyph string
24986 constructed. HL overrides that face of the glyph; e.g. it is
24987 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24988 x-position of the drawing area. */
24990 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24992 int face_id = (row)->glyphs[area][START].face_id; \
24993 struct face *base_face = FACE_FROM_ID (f, face_id); \
24994 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24995 struct composition *cmp = composition_table[cmp_id]; \
24997 struct glyph_string *first_s = NULL; \
25000 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25002 /* Make glyph_strings for each glyph sequence that is drawable by \
25003 the same face, and append them to HEAD/TAIL. */ \
25004 for (n = 0; n < cmp->glyph_len;) \
25006 s = alloca (sizeof *s); \
25007 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25008 append_glyph_string (&(HEAD), &(TAIL), s); \
25014 n = fill_composite_glyph_string (s, base_face, overlaps); \
25022 /* Add a glyph string for a glyph-string sequence to the list of strings
25023 between HEAD and TAIL. */
25025 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25029 Lisp_Object gstring; \
25031 face_id = (row)->glyphs[area][START].face_id; \
25032 gstring = (composition_gstring_from_id \
25033 ((row)->glyphs[area][START].u.cmp.id)); \
25034 s = alloca (sizeof *s); \
25035 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25036 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25037 append_glyph_string (&(HEAD), &(TAIL), s); \
25039 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25043 /* Add a glyph string for a sequence of glyphless character's glyphs
25044 to the list of strings between HEAD and TAIL. The meanings of
25045 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25047 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25052 face_id = (row)->glyphs[area][START].face_id; \
25054 s = alloca (sizeof *s); \
25055 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25056 append_glyph_string (&HEAD, &TAIL, s); \
25058 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25064 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25065 of AREA of glyph row ROW on window W between indices START and END.
25066 HL overrides the face for drawing glyph strings, e.g. it is
25067 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25068 x-positions of the drawing area.
25070 This is an ugly monster macro construct because we must use alloca
25071 to allocate glyph strings (because draw_glyphs can be called
25072 asynchronously). */
25074 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25077 HEAD = TAIL = NULL; \
25078 while (START < END) \
25080 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25081 switch (first_glyph->type) \
25084 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25088 case COMPOSITE_GLYPH: \
25089 if (first_glyph->u.cmp.automatic) \
25090 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25093 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25097 case STRETCH_GLYPH: \
25098 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25102 case IMAGE_GLYPH: \
25103 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25107 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25108 case XWIDGET_GLYPH: \
25109 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25113 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25114 case GLYPHLESS_GLYPH: \
25115 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25125 set_glyph_string_background_width (s, START, LAST_X); \
25132 #ifdef HAVE_XWIDGETS
25133 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25134 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25135 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25136 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25138 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25139 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25140 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25144 /* Draw glyphs between START and END in AREA of ROW on window W,
25145 starting at x-position X. X is relative to AREA in W. HL is a
25146 face-override with the following meaning:
25148 DRAW_NORMAL_TEXT draw normally
25149 DRAW_CURSOR draw in cursor face
25150 DRAW_MOUSE_FACE draw in mouse face.
25151 DRAW_INVERSE_VIDEO draw in mode line face
25152 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25153 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25155 If OVERLAPS is non-zero, draw only the foreground of characters and
25156 clip to the physical height of ROW. Non-zero value also defines
25157 the overlapping part to be drawn:
25159 OVERLAPS_PRED overlap with preceding rows
25160 OVERLAPS_SUCC overlap with succeeding rows
25161 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25162 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25164 Value is the x-position reached, relative to AREA of W. */
25167 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25168 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25169 enum draw_glyphs_face hl
, int overlaps
)
25171 struct glyph_string
*head
, *tail
;
25172 struct glyph_string
*s
;
25173 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25174 int i
, j
, x_reached
, last_x
, area_left
= 0;
25175 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25178 ALLOCATE_HDC (hdc
, f
);
25180 /* Let's rather be paranoid than getting a SEGV. */
25181 end
= min (end
, row
->used
[area
]);
25182 start
= clip_to_bounds (0, start
, end
);
25184 /* Translate X to frame coordinates. Set last_x to the right
25185 end of the drawing area. */
25186 if (row
->full_width_p
)
25188 /* X is relative to the left edge of W, without scroll bars
25190 area_left
= WINDOW_LEFT_EDGE_X (w
);
25191 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25192 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25196 area_left
= window_box_left (w
, area
);
25197 last_x
= area_left
+ window_box_width (w
, area
);
25201 /* Build a doubly-linked list of glyph_string structures between
25202 head and tail from what we have to draw. Note that the macro
25203 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25204 the reason we use a separate variable `i'. */
25207 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25209 x_reached
= tail
->x
+ tail
->background_width
;
25213 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25214 the row, redraw some glyphs in front or following the glyph
25215 strings built above. */
25216 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25218 struct glyph_string
*h
, *t
;
25219 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25220 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25221 int check_mouse_face
= 0;
25224 /* If mouse highlighting is on, we may need to draw adjacent
25225 glyphs using mouse-face highlighting. */
25226 if (area
== TEXT_AREA
&& row
->mouse_face_p
25227 && hlinfo
->mouse_face_beg_row
>= 0
25228 && hlinfo
->mouse_face_end_row
>= 0)
25230 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25232 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25233 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25235 check_mouse_face
= 1;
25236 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25237 ? hlinfo
->mouse_face_beg_col
: 0;
25238 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25239 ? hlinfo
->mouse_face_end_col
25240 : row
->used
[TEXT_AREA
];
25244 /* Compute overhangs for all glyph strings. */
25245 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25246 for (s
= head
; s
; s
= s
->next
)
25247 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25249 /* Prepend glyph strings for glyphs in front of the first glyph
25250 string that are overwritten because of the first glyph
25251 string's left overhang. The background of all strings
25252 prepended must be drawn because the first glyph string
25254 i
= left_overwritten (head
);
25257 enum draw_glyphs_face overlap_hl
;
25259 /* If this row contains mouse highlighting, attempt to draw
25260 the overlapped glyphs with the correct highlight. This
25261 code fails if the overlap encompasses more than one glyph
25262 and mouse-highlight spans only some of these glyphs.
25263 However, making it work perfectly involves a lot more
25264 code, and I don't know if the pathological case occurs in
25265 practice, so we'll stick to this for now. --- cyd */
25266 if (check_mouse_face
25267 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25268 overlap_hl
= DRAW_MOUSE_FACE
;
25270 overlap_hl
= DRAW_NORMAL_TEXT
;
25272 if (hl
!= overlap_hl
)
25275 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25276 overlap_hl
, dummy_x
, last_x
);
25278 compute_overhangs_and_x (t
, head
->x
, 1);
25279 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25280 if (clip_head
== NULL
)
25284 /* Prepend glyph strings for glyphs in front of the first glyph
25285 string that overwrite that glyph string because of their
25286 right overhang. For these strings, only the foreground must
25287 be drawn, because it draws over the glyph string at `head'.
25288 The background must not be drawn because this would overwrite
25289 right overhangs of preceding glyphs for which no glyph
25291 i
= left_overwriting (head
);
25294 enum draw_glyphs_face overlap_hl
;
25296 if (check_mouse_face
25297 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25298 overlap_hl
= DRAW_MOUSE_FACE
;
25300 overlap_hl
= DRAW_NORMAL_TEXT
;
25302 if (hl
== overlap_hl
|| clip_head
== NULL
)
25304 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25305 overlap_hl
, dummy_x
, last_x
);
25306 for (s
= h
; s
; s
= s
->next
)
25307 s
->background_filled_p
= 1;
25308 compute_overhangs_and_x (t
, head
->x
, 1);
25309 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25312 /* Append glyphs strings for glyphs following the last glyph
25313 string tail that are overwritten by tail. The background of
25314 these strings has to be drawn because tail's foreground draws
25316 i
= right_overwritten (tail
);
25319 enum draw_glyphs_face overlap_hl
;
25321 if (check_mouse_face
25322 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25323 overlap_hl
= DRAW_MOUSE_FACE
;
25325 overlap_hl
= DRAW_NORMAL_TEXT
;
25327 if (hl
!= overlap_hl
)
25329 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25330 overlap_hl
, x
, last_x
);
25331 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25332 we don't have `end = i;' here. */
25333 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25334 append_glyph_string_lists (&head
, &tail
, h
, t
);
25335 if (clip_tail
== NULL
)
25339 /* Append glyph strings for glyphs following the last glyph
25340 string tail that overwrite tail. The foreground of such
25341 glyphs has to be drawn because it writes into the background
25342 of tail. The background must not be drawn because it could
25343 paint over the foreground of following glyphs. */
25344 i
= right_overwriting (tail
);
25347 enum draw_glyphs_face overlap_hl
;
25348 if (check_mouse_face
25349 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25350 overlap_hl
= DRAW_MOUSE_FACE
;
25352 overlap_hl
= DRAW_NORMAL_TEXT
;
25354 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25356 i
++; /* We must include the Ith glyph. */
25357 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25358 overlap_hl
, x
, last_x
);
25359 for (s
= h
; s
; s
= s
->next
)
25360 s
->background_filled_p
= 1;
25361 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25362 append_glyph_string_lists (&head
, &tail
, h
, t
);
25364 if (clip_head
|| clip_tail
)
25365 for (s
= head
; s
; s
= s
->next
)
25367 s
->clip_head
= clip_head
;
25368 s
->clip_tail
= clip_tail
;
25372 /* Draw all strings. */
25373 for (s
= head
; s
; s
= s
->next
)
25374 FRAME_RIF (f
)->draw_glyph_string (s
);
25377 /* When focus a sole frame and move horizontally, this sets on_p to 0
25378 causing a failure to erase prev cursor position. */
25379 if (area
== TEXT_AREA
25380 && !row
->full_width_p
25381 /* When drawing overlapping rows, only the glyph strings'
25382 foreground is drawn, which doesn't erase a cursor
25386 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25387 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25388 : (tail
? tail
->x
+ tail
->background_width
: x
));
25392 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25393 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25397 /* Value is the x-position up to which drawn, relative to AREA of W.
25398 This doesn't include parts drawn because of overhangs. */
25399 if (row
->full_width_p
)
25400 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25402 x_reached
-= area_left
;
25404 RELEASE_HDC (hdc
, f
);
25410 /* Expand row matrix if too narrow. Don't expand if area
25413 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25415 if (!it->f->fonts_changed \
25416 && (it->glyph_row->glyphs[area] \
25417 < it->glyph_row->glyphs[area + 1])) \
25419 it->w->ncols_scale_factor++; \
25420 it->f->fonts_changed = 1; \
25424 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25425 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25428 append_glyph (struct it
*it
)
25430 struct glyph
*glyph
;
25431 enum glyph_row_area area
= it
->area
;
25433 eassert (it
->glyph_row
);
25434 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25436 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25437 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25439 /* If the glyph row is reversed, we need to prepend the glyph
25440 rather than append it. */
25441 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25445 /* Make room for the additional glyph. */
25446 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25448 glyph
= it
->glyph_row
->glyphs
[area
];
25450 glyph
->charpos
= CHARPOS (it
->position
);
25451 glyph
->object
= it
->object
;
25452 if (it
->pixel_width
> 0)
25454 glyph
->pixel_width
= it
->pixel_width
;
25455 glyph
->padding_p
= 0;
25459 /* Assure at least 1-pixel width. Otherwise, cursor can't
25460 be displayed correctly. */
25461 glyph
->pixel_width
= 1;
25462 glyph
->padding_p
= 1;
25464 glyph
->ascent
= it
->ascent
;
25465 glyph
->descent
= it
->descent
;
25466 glyph
->voffset
= it
->voffset
;
25467 glyph
->type
= CHAR_GLYPH
;
25468 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25469 glyph
->multibyte_p
= it
->multibyte_p
;
25470 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25472 /* In R2L rows, the left and the right box edges need to be
25473 drawn in reverse direction. */
25474 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25475 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25479 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25480 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25482 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25483 || it
->phys_descent
> it
->descent
);
25484 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25485 glyph
->face_id
= it
->face_id
;
25486 glyph
->u
.ch
= it
->char_to_display
;
25487 glyph
->slice
.img
= null_glyph_slice
;
25488 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25491 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25492 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25493 glyph
->bidi_type
= it
->bidi_it
.type
;
25497 glyph
->resolved_level
= 0;
25498 glyph
->bidi_type
= UNKNOWN_BT
;
25500 ++it
->glyph_row
->used
[area
];
25503 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25506 /* Store one glyph for the composition IT->cmp_it.id in
25507 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25511 append_composite_glyph (struct it
*it
)
25513 struct glyph
*glyph
;
25514 enum glyph_row_area area
= it
->area
;
25516 eassert (it
->glyph_row
);
25518 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25519 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25521 /* If the glyph row is reversed, we need to prepend the glyph
25522 rather than append it. */
25523 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25527 /* Make room for the new glyph. */
25528 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25530 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25532 glyph
->charpos
= it
->cmp_it
.charpos
;
25533 glyph
->object
= it
->object
;
25534 glyph
->pixel_width
= it
->pixel_width
;
25535 glyph
->ascent
= it
->ascent
;
25536 glyph
->descent
= it
->descent
;
25537 glyph
->voffset
= it
->voffset
;
25538 glyph
->type
= COMPOSITE_GLYPH
;
25539 if (it
->cmp_it
.ch
< 0)
25541 glyph
->u
.cmp
.automatic
= 0;
25542 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25543 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25547 glyph
->u
.cmp
.automatic
= 1;
25548 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25549 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25550 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25552 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25553 glyph
->multibyte_p
= it
->multibyte_p
;
25554 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25556 /* In R2L rows, the left and the right box edges need to be
25557 drawn in reverse direction. */
25558 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25559 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25563 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25564 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25566 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25567 || it
->phys_descent
> it
->descent
);
25568 glyph
->padding_p
= 0;
25569 glyph
->glyph_not_available_p
= 0;
25570 glyph
->face_id
= it
->face_id
;
25571 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25574 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25575 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25576 glyph
->bidi_type
= it
->bidi_it
.type
;
25578 ++it
->glyph_row
->used
[area
];
25581 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25585 /* Change IT->ascent and IT->height according to the setting of
25589 take_vertical_position_into_account (struct it
*it
)
25593 if (it
->voffset
< 0)
25594 /* Increase the ascent so that we can display the text higher
25596 it
->ascent
-= it
->voffset
;
25598 /* Increase the descent so that we can display the text lower
25600 it
->descent
+= it
->voffset
;
25605 /* Produce glyphs/get display metrics for the image IT is loaded with.
25606 See the description of struct display_iterator in dispextern.h for
25607 an overview of struct display_iterator. */
25610 produce_image_glyph (struct it
*it
)
25614 int glyph_ascent
, crop
;
25615 struct glyph_slice slice
;
25617 eassert (it
->what
== IT_IMAGE
);
25619 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25621 /* Make sure X resources of the face is loaded. */
25622 prepare_face_for_display (it
->f
, face
);
25624 if (it
->image_id
< 0)
25626 /* Fringe bitmap. */
25627 it
->ascent
= it
->phys_ascent
= 0;
25628 it
->descent
= it
->phys_descent
= 0;
25629 it
->pixel_width
= 0;
25634 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25636 /* Make sure X resources of the image is loaded. */
25637 prepare_image_for_display (it
->f
, img
);
25639 slice
.x
= slice
.y
= 0;
25640 slice
.width
= img
->width
;
25641 slice
.height
= img
->height
;
25643 if (INTEGERP (it
->slice
.x
))
25644 slice
.x
= XINT (it
->slice
.x
);
25645 else if (FLOATP (it
->slice
.x
))
25646 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25648 if (INTEGERP (it
->slice
.y
))
25649 slice
.y
= XINT (it
->slice
.y
);
25650 else if (FLOATP (it
->slice
.y
))
25651 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25653 if (INTEGERP (it
->slice
.width
))
25654 slice
.width
= XINT (it
->slice
.width
);
25655 else if (FLOATP (it
->slice
.width
))
25656 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25658 if (INTEGERP (it
->slice
.height
))
25659 slice
.height
= XINT (it
->slice
.height
);
25660 else if (FLOATP (it
->slice
.height
))
25661 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25663 if (slice
.x
>= img
->width
)
25664 slice
.x
= img
->width
;
25665 if (slice
.y
>= img
->height
)
25666 slice
.y
= img
->height
;
25667 if (slice
.x
+ slice
.width
>= img
->width
)
25668 slice
.width
= img
->width
- slice
.x
;
25669 if (slice
.y
+ slice
.height
> img
->height
)
25670 slice
.height
= img
->height
- slice
.y
;
25672 if (slice
.width
== 0 || slice
.height
== 0)
25675 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25677 it
->descent
= slice
.height
- glyph_ascent
;
25679 it
->descent
+= img
->vmargin
;
25680 if (slice
.y
+ slice
.height
== img
->height
)
25681 it
->descent
+= img
->vmargin
;
25682 it
->phys_descent
= it
->descent
;
25684 it
->pixel_width
= slice
.width
;
25686 it
->pixel_width
+= img
->hmargin
;
25687 if (slice
.x
+ slice
.width
== img
->width
)
25688 it
->pixel_width
+= img
->hmargin
;
25690 /* It's quite possible for images to have an ascent greater than
25691 their height, so don't get confused in that case. */
25692 if (it
->descent
< 0)
25697 if (face
->box
!= FACE_NO_BOX
)
25699 if (face
->box_line_width
> 0)
25702 it
->ascent
+= face
->box_line_width
;
25703 if (slice
.y
+ slice
.height
== img
->height
)
25704 it
->descent
+= face
->box_line_width
;
25707 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25708 it
->pixel_width
+= eabs (face
->box_line_width
);
25709 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25710 it
->pixel_width
+= eabs (face
->box_line_width
);
25713 take_vertical_position_into_account (it
);
25715 /* Automatically crop wide image glyphs at right edge so we can
25716 draw the cursor on same display row. */
25717 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25718 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25720 it
->pixel_width
-= crop
;
25721 slice
.width
-= crop
;
25726 struct glyph
*glyph
;
25727 enum glyph_row_area area
= it
->area
;
25729 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25730 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25732 glyph
->charpos
= CHARPOS (it
->position
);
25733 glyph
->object
= it
->object
;
25734 glyph
->pixel_width
= it
->pixel_width
;
25735 glyph
->ascent
= glyph_ascent
;
25736 glyph
->descent
= it
->descent
;
25737 glyph
->voffset
= it
->voffset
;
25738 glyph
->type
= IMAGE_GLYPH
;
25739 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25740 glyph
->multibyte_p
= it
->multibyte_p
;
25741 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25743 /* In R2L rows, the left and the right box edges need to be
25744 drawn in reverse direction. */
25745 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25746 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25750 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25751 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25753 glyph
->overlaps_vertically_p
= 0;
25754 glyph
->padding_p
= 0;
25755 glyph
->glyph_not_available_p
= 0;
25756 glyph
->face_id
= it
->face_id
;
25757 glyph
->u
.img_id
= img
->id
;
25758 glyph
->slice
.img
= slice
;
25759 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25762 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25763 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25764 glyph
->bidi_type
= it
->bidi_it
.type
;
25766 ++it
->glyph_row
->used
[area
];
25769 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25773 #ifdef HAVE_XWIDGETS
25775 produce_xwidget_glyph (struct it
*it
)
25777 struct xwidget
* xw
;
25779 int glyph_ascent
, crop
;
25780 eassert (it
->what
== IT_XWIDGET
);
25782 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25784 /* Make sure X resources of the face is loaded. */
25785 prepare_face_for_display (it
->f
, face
);
25788 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
25789 it
->descent
= xw
->height
/2;
25790 it
->phys_descent
= it
->descent
;
25791 it
->pixel_width
= xw
->width
;
25792 /* It's quite possible for images to have an ascent greater than
25793 their height, so don't get confused in that case. */
25794 if (it
->descent
< 0)
25799 if (face
->box
!= FACE_NO_BOX
)
25801 if (face
->box_line_width
> 0)
25803 it
->ascent
+= face
->box_line_width
;
25804 it
->descent
+= face
->box_line_width
;
25807 if (it
->start_of_box_run_p
)
25808 it
->pixel_width
+= eabs (face
->box_line_width
);
25809 it
->pixel_width
+= eabs (face
->box_line_width
);
25812 take_vertical_position_into_account (it
);
25814 /* Automatically crop wide image glyphs at right edge so we can
25815 draw the cursor on same display row. */
25816 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25817 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25819 it
->pixel_width
-= crop
;
25824 struct glyph
*glyph
;
25825 enum glyph_row_area area
= it
->area
;
25827 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25828 if (it
->glyph_row
->reversed_p
)
25832 /* Make room for the new glyph. */
25833 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25835 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25837 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25839 glyph
->charpos
= CHARPOS (it
->position
);
25840 glyph
->object
= it
->object
;
25841 glyph
->pixel_width
= it
->pixel_width
;
25842 glyph
->ascent
= glyph_ascent
;
25843 glyph
->descent
= it
->descent
;
25844 glyph
->voffset
= it
->voffset
;
25845 glyph
->type
= XWIDGET_GLYPH
;
25846 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25847 glyph
->multibyte_p
= it
->multibyte_p
;
25848 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25850 /* In R2L rows, the left and the right box edges need to be
25851 drawn in reverse direction. */
25852 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25853 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25857 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25858 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25860 glyph
->overlaps_vertically_p
= 0;
25861 glyph
->padding_p
= 0;
25862 glyph
->glyph_not_available_p
= 0;
25863 glyph
->face_id
= it
->face_id
;
25864 glyph
->u
.xwidget
= it
->xwidget
;
25865 //assert_valid_xwidget_id(glyph->u.xwidget_id,"produce_xwidget_glyph");
25866 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25869 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25870 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25871 glyph
->bidi_type
= it
->bidi_it
.type
;
25873 ++it
->glyph_row
->used
[area
];
25876 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25881 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25882 of the glyph, WIDTH and HEIGHT are the width and height of the
25883 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25886 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25887 int width
, int height
, int ascent
)
25889 struct glyph
*glyph
;
25890 enum glyph_row_area area
= it
->area
;
25892 eassert (ascent
>= 0 && ascent
<= height
);
25894 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25895 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25897 /* If the glyph row is reversed, we need to prepend the glyph
25898 rather than append it. */
25899 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25903 /* Make room for the additional glyph. */
25904 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25906 glyph
= it
->glyph_row
->glyphs
[area
];
25908 /* Decrease the width of the first glyph of the row that
25909 begins before first_visible_x (e.g., due to hscroll).
25910 This is so the overall width of the row becomes smaller
25911 by the scroll amount, and the stretch glyph appended by
25912 extend_face_to_end_of_line will be wider, to shift the
25913 row glyphs to the right. (In L2R rows, the corresponding
25914 left-shift effect is accomplished by setting row->x to a
25915 negative value, which won't work with R2L rows.)
25917 This must leave us with a positive value of WIDTH, since
25918 otherwise the call to move_it_in_display_line_to at the
25919 beginning of display_line would have got past the entire
25920 first glyph, and then it->current_x would have been
25921 greater or equal to it->first_visible_x. */
25922 if (it
->current_x
< it
->first_visible_x
)
25923 width
-= it
->first_visible_x
- it
->current_x
;
25924 eassert (width
> 0);
25926 glyph
->charpos
= CHARPOS (it
->position
);
25927 glyph
->object
= object
;
25928 glyph
->pixel_width
= width
;
25929 glyph
->ascent
= ascent
;
25930 glyph
->descent
= height
- ascent
;
25931 glyph
->voffset
= it
->voffset
;
25932 glyph
->type
= STRETCH_GLYPH
;
25933 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25934 glyph
->multibyte_p
= it
->multibyte_p
;
25935 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25937 /* In R2L rows, the left and the right box edges need to be
25938 drawn in reverse direction. */
25939 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25940 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25944 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25945 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25947 glyph
->overlaps_vertically_p
= 0;
25948 glyph
->padding_p
= 0;
25949 glyph
->glyph_not_available_p
= 0;
25950 glyph
->face_id
= it
->face_id
;
25951 glyph
->u
.stretch
.ascent
= ascent
;
25952 glyph
->u
.stretch
.height
= height
;
25953 glyph
->slice
.img
= null_glyph_slice
;
25954 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25957 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25958 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25959 glyph
->bidi_type
= it
->bidi_it
.type
;
25963 glyph
->resolved_level
= 0;
25964 glyph
->bidi_type
= UNKNOWN_BT
;
25966 ++it
->glyph_row
->used
[area
];
25969 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25972 #endif /* HAVE_WINDOW_SYSTEM */
25974 /* Produce a stretch glyph for iterator IT. IT->object is the value
25975 of the glyph property displayed. The value must be a list
25976 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25979 1. `:width WIDTH' specifies that the space should be WIDTH *
25980 canonical char width wide. WIDTH may be an integer or floating
25983 2. `:relative-width FACTOR' specifies that the width of the stretch
25984 should be computed from the width of the first character having the
25985 `glyph' property, and should be FACTOR times that width.
25987 3. `:align-to HPOS' specifies that the space should be wide enough
25988 to reach HPOS, a value in canonical character units.
25990 Exactly one of the above pairs must be present.
25992 4. `:height HEIGHT' specifies that the height of the stretch produced
25993 should be HEIGHT, measured in canonical character units.
25995 5. `:relative-height FACTOR' specifies that the height of the
25996 stretch should be FACTOR times the height of the characters having
25997 the glyph property.
25999 Either none or exactly one of 4 or 5 must be present.
26001 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26002 of the stretch should be used for the ascent of the stretch.
26003 ASCENT must be in the range 0 <= ASCENT <= 100. */
26006 produce_stretch_glyph (struct it
*it
)
26008 /* (space :width WIDTH :height HEIGHT ...) */
26009 Lisp_Object prop
, plist
;
26010 int width
= 0, height
= 0, align_to
= -1;
26011 int zero_width_ok_p
= 0;
26013 struct font
*font
= NULL
;
26015 #ifdef HAVE_WINDOW_SYSTEM
26017 int zero_height_ok_p
= 0;
26019 if (FRAME_WINDOW_P (it
->f
))
26021 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26022 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26023 prepare_face_for_display (it
->f
, face
);
26027 /* List should start with `space'. */
26028 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26029 plist
= XCDR (it
->object
);
26031 /* Compute the width of the stretch. */
26032 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26033 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
26035 /* Absolute width `:width WIDTH' specified and valid. */
26036 zero_width_ok_p
= 1;
26039 #ifdef HAVE_WINDOW_SYSTEM
26040 else if (FRAME_WINDOW_P (it
->f
)
26041 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
26043 /* Relative width `:relative-width FACTOR' specified and valid.
26044 Compute the width of the characters having the `glyph'
26047 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26050 if (it
->multibyte_p
)
26051 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26054 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26055 if (! ASCII_CHAR_P (it2
.c
))
26056 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26059 it2
.glyph_row
= NULL
;
26060 it2
.what
= IT_CHARACTER
;
26061 x_produce_glyphs (&it2
);
26062 width
= NUMVAL (prop
) * it2
.pixel_width
;
26064 #endif /* HAVE_WINDOW_SYSTEM */
26065 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26066 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
26068 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26069 align_to
= (align_to
< 0
26071 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26072 else if (align_to
< 0)
26073 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26074 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26075 zero_width_ok_p
= 1;
26078 /* Nothing specified -> width defaults to canonical char width. */
26079 width
= FRAME_COLUMN_WIDTH (it
->f
);
26081 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26084 #ifdef HAVE_WINDOW_SYSTEM
26085 /* Compute height. */
26086 if (FRAME_WINDOW_P (it
->f
))
26088 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26089 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
26092 zero_height_ok_p
= 1;
26094 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26096 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
26098 height
= FONT_HEIGHT (font
);
26100 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26103 /* Compute percentage of height used for ascent. If
26104 `:ascent ASCENT' is present and valid, use that. Otherwise,
26105 derive the ascent from the font in use. */
26106 if (prop
= Fplist_get (plist
, QCascent
),
26107 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26108 ascent
= height
* NUMVAL (prop
) / 100.0;
26109 else if (!NILP (prop
)
26110 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
26111 ascent
= min (max (0, (int)tem
), height
);
26113 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26116 #endif /* HAVE_WINDOW_SYSTEM */
26119 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26120 && it
->current_x
+ width
> it
->last_visible_x
)
26122 width
= it
->last_visible_x
- it
->current_x
;
26123 #ifdef HAVE_WINDOW_SYSTEM
26124 /* Subtract one more pixel from the stretch width, but only on
26125 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26126 width
-= FRAME_WINDOW_P (it
->f
);
26130 if (width
> 0 && height
> 0 && it
->glyph_row
)
26132 Lisp_Object o_object
= it
->object
;
26133 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26136 if (!STRINGP (object
))
26137 object
= it
->w
->contents
;
26138 #ifdef HAVE_WINDOW_SYSTEM
26139 if (FRAME_WINDOW_P (it
->f
))
26140 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26144 it
->object
= object
;
26145 it
->char_to_display
= ' ';
26146 it
->pixel_width
= it
->len
= 1;
26148 tty_append_glyph (it
);
26149 it
->object
= o_object
;
26153 it
->pixel_width
= width
;
26154 #ifdef HAVE_WINDOW_SYSTEM
26155 if (FRAME_WINDOW_P (it
->f
))
26157 it
->ascent
= it
->phys_ascent
= ascent
;
26158 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26159 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
26160 take_vertical_position_into_account (it
);
26164 it
->nglyphs
= width
;
26167 /* Get information about special display element WHAT in an
26168 environment described by IT. WHAT is one of IT_TRUNCATION or
26169 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26170 non-null glyph_row member. This function ensures that fields like
26171 face_id, c, len of IT are left untouched. */
26174 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26181 temp_it
.object
= Qnil
;
26182 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26184 if (what
== IT_CONTINUATION
)
26186 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26187 if (it
->bidi_it
.paragraph_dir
== R2L
)
26188 SET_GLYPH_FROM_CHAR (glyph
, '/');
26190 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26192 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26194 /* FIXME: Should we mirror GC for R2L lines? */
26195 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26196 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26199 else if (what
== IT_TRUNCATION
)
26201 /* Truncation glyph. */
26202 SET_GLYPH_FROM_CHAR (glyph
, '$');
26204 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26206 /* FIXME: Should we mirror GC for R2L lines? */
26207 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26208 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26214 #ifdef HAVE_WINDOW_SYSTEM
26215 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26216 is turned off, we precede the truncation/continuation glyphs by a
26217 stretch glyph whose width is computed such that these special
26218 glyphs are aligned at the window margin, even when very different
26219 fonts are used in different glyph rows. */
26220 if (FRAME_WINDOW_P (temp_it
.f
)
26221 /* init_iterator calls this with it->glyph_row == NULL, and it
26222 wants only the pixel width of the truncation/continuation
26224 && temp_it
.glyph_row
26225 /* insert_left_trunc_glyphs calls us at the beginning of the
26226 row, and it has its own calculation of the stretch glyph
26228 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26229 && (temp_it
.glyph_row
->reversed_p
26230 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26231 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26233 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26235 if (stretch_width
> 0)
26237 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26238 struct font
*font
=
26239 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26240 int stretch_ascent
=
26241 (((temp_it
.ascent
+ temp_it
.descent
)
26242 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26244 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26245 temp_it
.ascent
+ temp_it
.descent
,
26252 temp_it
.what
= IT_CHARACTER
;
26253 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26254 temp_it
.face_id
= GLYPH_FACE (glyph
);
26255 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26257 PRODUCE_GLYPHS (&temp_it
);
26258 it
->pixel_width
= temp_it
.pixel_width
;
26259 it
->nglyphs
= temp_it
.nglyphs
;
26262 #ifdef HAVE_WINDOW_SYSTEM
26264 /* Calculate line-height and line-spacing properties.
26265 An integer value specifies explicit pixel value.
26266 A float value specifies relative value to current face height.
26267 A cons (float . face-name) specifies relative value to
26268 height of specified face font.
26270 Returns height in pixels, or nil. */
26274 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26275 int boff
, int override
)
26277 Lisp_Object face_name
= Qnil
;
26278 int ascent
, descent
, height
;
26280 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26285 face_name
= XCAR (val
);
26287 if (!NUMBERP (val
))
26288 val
= make_number (1);
26289 if (NILP (face_name
))
26291 height
= it
->ascent
+ it
->descent
;
26296 if (NILP (face_name
))
26298 font
= FRAME_FONT (it
->f
);
26299 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26301 else if (EQ (face_name
, Qt
))
26310 face_id
= lookup_named_face (it
->f
, face_name
, 0);
26312 return make_number (-1);
26314 face
= FACE_FROM_ID (it
->f
, face_id
);
26317 return make_number (-1);
26318 boff
= font
->baseline_offset
;
26319 if (font
->vertical_centering
)
26320 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26323 ascent
= FONT_BASE (font
) + boff
;
26324 descent
= FONT_DESCENT (font
) - boff
;
26328 it
->override_ascent
= ascent
;
26329 it
->override_descent
= descent
;
26330 it
->override_boff
= boff
;
26333 height
= ascent
+ descent
;
26337 height
= (int)(XFLOAT_DATA (val
) * height
);
26338 else if (INTEGERP (val
))
26339 height
*= XINT (val
);
26341 return make_number (height
);
26345 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26346 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
26347 and only if this is for a character for which no font was found.
26349 If the display method (it->glyphless_method) is
26350 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26351 length of the acronym or the hexadecimal string, UPPER_XOFF and
26352 UPPER_YOFF are pixel offsets for the upper part of the string,
26353 LOWER_XOFF and LOWER_YOFF are for the lower part.
26355 For the other display methods, LEN through LOWER_YOFF are zero. */
26358 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
26359 short upper_xoff
, short upper_yoff
,
26360 short lower_xoff
, short lower_yoff
)
26362 struct glyph
*glyph
;
26363 enum glyph_row_area area
= it
->area
;
26365 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26366 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26368 /* If the glyph row is reversed, we need to prepend the glyph
26369 rather than append it. */
26370 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26374 /* Make room for the additional glyph. */
26375 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26377 glyph
= it
->glyph_row
->glyphs
[area
];
26379 glyph
->charpos
= CHARPOS (it
->position
);
26380 glyph
->object
= it
->object
;
26381 glyph
->pixel_width
= it
->pixel_width
;
26382 glyph
->ascent
= it
->ascent
;
26383 glyph
->descent
= it
->descent
;
26384 glyph
->voffset
= it
->voffset
;
26385 glyph
->type
= GLYPHLESS_GLYPH
;
26386 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26387 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26388 glyph
->u
.glyphless
.len
= len
;
26389 glyph
->u
.glyphless
.ch
= it
->c
;
26390 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26391 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26392 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26393 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26394 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26395 glyph
->multibyte_p
= it
->multibyte_p
;
26396 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26398 /* In R2L rows, the left and the right box edges need to be
26399 drawn in reverse direction. */
26400 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26401 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26405 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26406 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26408 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26409 || it
->phys_descent
> it
->descent
);
26410 glyph
->padding_p
= 0;
26411 glyph
->glyph_not_available_p
= 0;
26412 glyph
->face_id
= face_id
;
26413 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26416 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26417 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26418 glyph
->bidi_type
= it
->bidi_it
.type
;
26420 ++it
->glyph_row
->used
[area
];
26423 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26427 /* Produce a glyph for a glyphless character for iterator IT.
26428 IT->glyphless_method specifies which method to use for displaying
26429 the character. See the description of enum
26430 glyphless_display_method in dispextern.h for the detail.
26432 FOR_NO_FONT is nonzero if and only if this is for a character for
26433 which no font was found. ACRONYM, if non-nil, is an acronym string
26434 for the character. */
26437 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
26442 int base_width
, base_height
, width
, height
;
26443 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26446 /* Get the metrics of the base font. We always refer to the current
26448 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26449 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26450 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
26451 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
26452 base_height
= it
->ascent
+ it
->descent
;
26453 base_width
= font
->average_width
;
26455 face_id
= merge_glyphless_glyph_face (it
);
26457 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26459 it
->pixel_width
= THIN_SPACE_WIDTH
;
26461 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26463 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26465 width
= CHAR_WIDTH (it
->c
);
26468 else if (width
> 4)
26470 it
->pixel_width
= base_width
* width
;
26472 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26478 unsigned int code
[6];
26480 int ascent
, descent
;
26481 struct font_metrics metrics_upper
, metrics_lower
;
26483 face
= FACE_FROM_ID (it
->f
, face_id
);
26484 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26485 prepare_face_for_display (it
->f
, face
);
26487 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26489 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26490 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26491 if (CONSP (acronym
))
26492 acronym
= XCAR (acronym
);
26493 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26497 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26498 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26501 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26502 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26503 upper_len
= (len
+ 1) / 2;
26504 font
->driver
->text_extents (font
, code
, upper_len
,
26506 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26511 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26512 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26513 upper_xoff
= upper_yoff
= 2; /* the typical case */
26514 if (base_width
>= width
)
26516 /* Align the upper to the left, the lower to the right. */
26517 it
->pixel_width
= base_width
;
26518 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26522 /* Center the shorter one. */
26523 it
->pixel_width
= width
;
26524 if (metrics_upper
.width
>= metrics_lower
.width
)
26525 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26528 /* FIXME: This code doesn't look right. It formerly was
26529 missing the "lower_xoff = 0;", which couldn't have
26530 been right since it left lower_xoff uninitialized. */
26532 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26536 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26537 top, bottom, and between upper and lower strings. */
26538 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26539 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26540 /* Center vertically.
26541 H:base_height, D:base_descent
26542 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26544 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26545 descent = D - H/2 + h/2;
26546 lower_yoff = descent - 2 - ld;
26547 upper_yoff = lower_yoff - la - 1 - ud; */
26548 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26549 descent
= it
->descent
- (base_height
- height
) / 2;
26550 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26551 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26552 - metrics_upper
.descent
);
26553 /* Don't make the height shorter than the base height. */
26554 if (height
> base_height
)
26556 it
->ascent
= ascent
;
26557 it
->descent
= descent
;
26561 it
->phys_ascent
= it
->ascent
;
26562 it
->phys_descent
= it
->descent
;
26564 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26565 upper_xoff
, upper_yoff
,
26566 lower_xoff
, lower_yoff
);
26568 take_vertical_position_into_account (it
);
26573 Produce glyphs/get display metrics for the display element IT is
26574 loaded with. See the description of struct it in dispextern.h
26575 for an overview of struct it. */
26578 x_produce_glyphs (struct it
*it
)
26580 int extra_line_spacing
= it
->extra_line_spacing
;
26582 it
->glyph_not_available_p
= 0;
26584 if (it
->what
== IT_CHARACTER
)
26587 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26588 struct font
*font
= face
->font
;
26589 struct font_metrics
*pcm
= NULL
;
26590 int boff
; /* Baseline offset. */
26594 /* When no suitable font is found, display this character by
26595 the method specified in the first extra slot of
26596 Vglyphless_char_display. */
26597 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26599 eassert (it
->what
== IT_GLYPHLESS
);
26600 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26604 boff
= font
->baseline_offset
;
26605 if (font
->vertical_centering
)
26606 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26608 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26614 if (it
->override_ascent
>= 0)
26616 it
->ascent
= it
->override_ascent
;
26617 it
->descent
= it
->override_descent
;
26618 boff
= it
->override_boff
;
26622 it
->ascent
= FONT_BASE (font
) + boff
;
26623 it
->descent
= FONT_DESCENT (font
) - boff
;
26626 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26628 pcm
= get_per_char_metric (font
, &char2b
);
26629 if (pcm
->width
== 0
26630 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26636 it
->phys_ascent
= pcm
->ascent
+ boff
;
26637 it
->phys_descent
= pcm
->descent
- boff
;
26638 it
->pixel_width
= pcm
->width
;
26642 it
->glyph_not_available_p
= 1;
26643 it
->phys_ascent
= it
->ascent
;
26644 it
->phys_descent
= it
->descent
;
26645 it
->pixel_width
= font
->space_width
;
26648 if (it
->constrain_row_ascent_descent_p
)
26650 if (it
->descent
> it
->max_descent
)
26652 it
->ascent
+= it
->descent
- it
->max_descent
;
26653 it
->descent
= it
->max_descent
;
26655 if (it
->ascent
> it
->max_ascent
)
26657 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26658 it
->ascent
= it
->max_ascent
;
26660 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26661 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26662 extra_line_spacing
= 0;
26665 /* If this is a space inside a region of text with
26666 `space-width' property, change its width. */
26667 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26669 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26671 /* If face has a box, add the box thickness to the character
26672 height. If character has a box line to the left and/or
26673 right, add the box line width to the character's width. */
26674 if (face
->box
!= FACE_NO_BOX
)
26676 int thick
= face
->box_line_width
;
26680 it
->ascent
+= thick
;
26681 it
->descent
+= thick
;
26686 if (it
->start_of_box_run_p
)
26687 it
->pixel_width
+= thick
;
26688 if (it
->end_of_box_run_p
)
26689 it
->pixel_width
+= thick
;
26692 /* If face has an overline, add the height of the overline
26693 (1 pixel) and a 1 pixel margin to the character height. */
26694 if (face
->overline_p
)
26695 it
->ascent
+= overline_margin
;
26697 if (it
->constrain_row_ascent_descent_p
)
26699 if (it
->ascent
> it
->max_ascent
)
26700 it
->ascent
= it
->max_ascent
;
26701 if (it
->descent
> it
->max_descent
)
26702 it
->descent
= it
->max_descent
;
26705 take_vertical_position_into_account (it
);
26707 /* If we have to actually produce glyphs, do it. */
26712 /* Translate a space with a `space-width' property
26713 into a stretch glyph. */
26714 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26715 / FONT_HEIGHT (font
));
26716 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26717 it
->ascent
+ it
->descent
, ascent
);
26722 /* If characters with lbearing or rbearing are displayed
26723 in this line, record that fact in a flag of the
26724 glyph row. This is used to optimize X output code. */
26725 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26726 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26728 if (! stretched_p
&& it
->pixel_width
== 0)
26729 /* We assure that all visible glyphs have at least 1-pixel
26731 it
->pixel_width
= 1;
26733 else if (it
->char_to_display
== '\n')
26735 /* A newline has no width, but we need the height of the
26736 line. But if previous part of the line sets a height,
26737 don't increase that height. */
26739 Lisp_Object height
;
26740 Lisp_Object total_height
= Qnil
;
26742 it
->override_ascent
= -1;
26743 it
->pixel_width
= 0;
26746 height
= get_it_property (it
, Qline_height
);
26747 /* Split (line-height total-height) list. */
26749 && CONSP (XCDR (height
))
26750 && NILP (XCDR (XCDR (height
))))
26752 total_height
= XCAR (XCDR (height
));
26753 height
= XCAR (height
);
26755 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26757 if (it
->override_ascent
>= 0)
26759 it
->ascent
= it
->override_ascent
;
26760 it
->descent
= it
->override_descent
;
26761 boff
= it
->override_boff
;
26765 it
->ascent
= FONT_BASE (font
) + boff
;
26766 it
->descent
= FONT_DESCENT (font
) - boff
;
26769 if (EQ (height
, Qt
))
26771 if (it
->descent
> it
->max_descent
)
26773 it
->ascent
+= it
->descent
- it
->max_descent
;
26774 it
->descent
= it
->max_descent
;
26776 if (it
->ascent
> it
->max_ascent
)
26778 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26779 it
->ascent
= it
->max_ascent
;
26781 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26782 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26783 it
->constrain_row_ascent_descent_p
= 1;
26784 extra_line_spacing
= 0;
26788 Lisp_Object spacing
;
26790 it
->phys_ascent
= it
->ascent
;
26791 it
->phys_descent
= it
->descent
;
26793 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26794 && face
->box
!= FACE_NO_BOX
26795 && face
->box_line_width
> 0)
26797 it
->ascent
+= face
->box_line_width
;
26798 it
->descent
+= face
->box_line_width
;
26801 && XINT (height
) > it
->ascent
+ it
->descent
)
26802 it
->ascent
= XINT (height
) - it
->descent
;
26804 if (!NILP (total_height
))
26805 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26808 spacing
= get_it_property (it
, Qline_spacing
);
26809 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26811 if (INTEGERP (spacing
))
26813 extra_line_spacing
= XINT (spacing
);
26814 if (!NILP (total_height
))
26815 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26819 else /* i.e. (it->char_to_display == '\t') */
26821 if (font
->space_width
> 0)
26823 int tab_width
= it
->tab_width
* font
->space_width
;
26824 int x
= it
->current_x
+ it
->continuation_lines_width
;
26825 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26827 /* If the distance from the current position to the next tab
26828 stop is less than a space character width, use the
26829 tab stop after that. */
26830 if (next_tab_x
- x
< font
->space_width
)
26831 next_tab_x
+= tab_width
;
26833 it
->pixel_width
= next_tab_x
- x
;
26835 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26836 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26840 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26841 it
->ascent
+ it
->descent
, it
->ascent
);
26846 it
->pixel_width
= 0;
26851 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26853 /* A static composition.
26855 Note: A composition is represented as one glyph in the
26856 glyph matrix. There are no padding glyphs.
26858 Important note: pixel_width, ascent, and descent are the
26859 values of what is drawn by draw_glyphs (i.e. the values of
26860 the overall glyphs composed). */
26861 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26862 int boff
; /* baseline offset */
26863 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26864 int glyph_len
= cmp
->glyph_len
;
26865 struct font
*font
= face
->font
;
26869 /* If we have not yet calculated pixel size data of glyphs of
26870 the composition for the current face font, calculate them
26871 now. Theoretically, we have to check all fonts for the
26872 glyphs, but that requires much time and memory space. So,
26873 here we check only the font of the first glyph. This may
26874 lead to incorrect display, but it's very rare, and C-l
26875 (recenter-top-bottom) can correct the display anyway. */
26876 if (! cmp
->font
|| cmp
->font
!= font
)
26878 /* Ascent and descent of the font of the first character
26879 of this composition (adjusted by baseline offset).
26880 Ascent and descent of overall glyphs should not be less
26881 than these, respectively. */
26882 int font_ascent
, font_descent
, font_height
;
26883 /* Bounding box of the overall glyphs. */
26884 int leftmost
, rightmost
, lowest
, highest
;
26885 int lbearing
, rbearing
;
26886 int i
, width
, ascent
, descent
;
26887 int left_padded
= 0, right_padded
= 0;
26888 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26890 struct font_metrics
*pcm
;
26891 int font_not_found_p
;
26894 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26895 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26897 if (glyph_len
< cmp
->glyph_len
)
26899 for (i
= 0; i
< glyph_len
; i
++)
26901 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26903 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26908 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26909 : IT_CHARPOS (*it
));
26910 /* If no suitable font is found, use the default font. */
26911 font_not_found_p
= font
== NULL
;
26912 if (font_not_found_p
)
26914 face
= face
->ascii_face
;
26917 boff
= font
->baseline_offset
;
26918 if (font
->vertical_centering
)
26919 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26920 font_ascent
= FONT_BASE (font
) + boff
;
26921 font_descent
= FONT_DESCENT (font
) - boff
;
26922 font_height
= FONT_HEIGHT (font
);
26927 if (! font_not_found_p
)
26929 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26931 pcm
= get_per_char_metric (font
, &char2b
);
26934 /* Initialize the bounding box. */
26937 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26938 ascent
= pcm
->ascent
;
26939 descent
= pcm
->descent
;
26940 lbearing
= pcm
->lbearing
;
26941 rbearing
= pcm
->rbearing
;
26945 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26946 ascent
= FONT_BASE (font
);
26947 descent
= FONT_DESCENT (font
);
26954 lowest
= - descent
+ boff
;
26955 highest
= ascent
+ boff
;
26957 if (! font_not_found_p
26958 && font
->default_ascent
26959 && CHAR_TABLE_P (Vuse_default_ascent
)
26960 && !NILP (Faref (Vuse_default_ascent
,
26961 make_number (it
->char_to_display
))))
26962 highest
= font
->default_ascent
+ boff
;
26964 /* Draw the first glyph at the normal position. It may be
26965 shifted to right later if some other glyphs are drawn
26967 cmp
->offsets
[i
* 2] = 0;
26968 cmp
->offsets
[i
* 2 + 1] = boff
;
26969 cmp
->lbearing
= lbearing
;
26970 cmp
->rbearing
= rbearing
;
26972 /* Set cmp->offsets for the remaining glyphs. */
26973 for (i
++; i
< glyph_len
; i
++)
26975 int left
, right
, btm
, top
;
26976 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26978 struct face
*this_face
;
26982 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26983 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26984 font
= this_face
->font
;
26990 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26992 pcm
= get_per_char_metric (font
, &char2b
);
26995 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26998 width
= pcm
->width
;
26999 ascent
= pcm
->ascent
;
27000 descent
= pcm
->descent
;
27001 lbearing
= pcm
->lbearing
;
27002 rbearing
= pcm
->rbearing
;
27003 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27005 /* Relative composition with or without
27006 alternate chars. */
27007 left
= (leftmost
+ rightmost
- width
) / 2;
27008 btm
= - descent
+ boff
;
27009 if (font
->relative_compose
27010 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27011 || NILP (Faref (Vignore_relative_composition
,
27012 make_number (ch
)))))
27015 if (- descent
>= font
->relative_compose
)
27016 /* One extra pixel between two glyphs. */
27018 else if (ascent
<= 0)
27019 /* One extra pixel between two glyphs. */
27020 btm
= lowest
- 1 - ascent
- descent
;
27025 /* A composition rule is specified by an integer
27026 value that encodes global and new reference
27027 points (GREF and NREF). GREF and NREF are
27028 specified by numbers as below:
27030 0---1---2 -- ascent
27034 9--10--11 -- center
27036 ---3---4---5--- baseline
27038 6---7---8 -- descent
27040 int rule
= COMPOSITION_RULE (cmp
, i
);
27041 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27043 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27044 grefx
= gref
% 3, nrefx
= nref
% 3;
27045 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27047 xoff
= font_height
* (xoff
- 128) / 256;
27049 yoff
= font_height
* (yoff
- 128) / 256;
27052 + grefx
* (rightmost
- leftmost
) / 2
27053 - nrefx
* width
/ 2
27056 btm
= ((grefy
== 0 ? highest
27058 : grefy
== 2 ? lowest
27059 : (highest
+ lowest
) / 2)
27060 - (nrefy
== 0 ? ascent
+ descent
27061 : nrefy
== 1 ? descent
- boff
27063 : (ascent
+ descent
) / 2)
27067 cmp
->offsets
[i
* 2] = left
;
27068 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27070 /* Update the bounding box of the overall glyphs. */
27073 right
= left
+ width
;
27074 if (left
< leftmost
)
27076 if (right
> rightmost
)
27079 top
= btm
+ descent
+ ascent
;
27085 if (cmp
->lbearing
> left
+ lbearing
)
27086 cmp
->lbearing
= left
+ lbearing
;
27087 if (cmp
->rbearing
< left
+ rbearing
)
27088 cmp
->rbearing
= left
+ rbearing
;
27092 /* If there are glyphs whose x-offsets are negative,
27093 shift all glyphs to the right and make all x-offsets
27097 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27098 cmp
->offsets
[i
* 2] -= leftmost
;
27099 rightmost
-= leftmost
;
27100 cmp
->lbearing
-= leftmost
;
27101 cmp
->rbearing
-= leftmost
;
27104 if (left_padded
&& cmp
->lbearing
< 0)
27106 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27107 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27108 rightmost
-= cmp
->lbearing
;
27109 cmp
->rbearing
-= cmp
->lbearing
;
27112 if (right_padded
&& rightmost
< cmp
->rbearing
)
27114 rightmost
= cmp
->rbearing
;
27117 cmp
->pixel_width
= rightmost
;
27118 cmp
->ascent
= highest
;
27119 cmp
->descent
= - lowest
;
27120 if (cmp
->ascent
< font_ascent
)
27121 cmp
->ascent
= font_ascent
;
27122 if (cmp
->descent
< font_descent
)
27123 cmp
->descent
= font_descent
;
27127 && (cmp
->lbearing
< 0
27128 || cmp
->rbearing
> cmp
->pixel_width
))
27129 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
27131 it
->pixel_width
= cmp
->pixel_width
;
27132 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27133 it
->descent
= it
->phys_descent
= cmp
->descent
;
27134 if (face
->box
!= FACE_NO_BOX
)
27136 int thick
= face
->box_line_width
;
27140 it
->ascent
+= thick
;
27141 it
->descent
+= thick
;
27146 if (it
->start_of_box_run_p
)
27147 it
->pixel_width
+= thick
;
27148 if (it
->end_of_box_run_p
)
27149 it
->pixel_width
+= thick
;
27152 /* If face has an overline, add the height of the overline
27153 (1 pixel) and a 1 pixel margin to the character height. */
27154 if (face
->overline_p
)
27155 it
->ascent
+= overline_margin
;
27157 take_vertical_position_into_account (it
);
27158 if (it
->ascent
< 0)
27160 if (it
->descent
< 0)
27163 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27164 append_composite_glyph (it
);
27166 else if (it
->what
== IT_COMPOSITION
)
27168 /* A dynamic (automatic) composition. */
27169 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27170 Lisp_Object gstring
;
27171 struct font_metrics metrics
;
27175 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27177 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27180 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27181 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
27182 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27183 it
->descent
= it
->phys_descent
= metrics
.descent
;
27184 if (face
->box
!= FACE_NO_BOX
)
27186 int thick
= face
->box_line_width
;
27190 it
->ascent
+= thick
;
27191 it
->descent
+= thick
;
27196 if (it
->start_of_box_run_p
)
27197 it
->pixel_width
+= thick
;
27198 if (it
->end_of_box_run_p
)
27199 it
->pixel_width
+= thick
;
27201 /* If face has an overline, add the height of the overline
27202 (1 pixel) and a 1 pixel margin to the character height. */
27203 if (face
->overline_p
)
27204 it
->ascent
+= overline_margin
;
27205 take_vertical_position_into_account (it
);
27206 if (it
->ascent
< 0)
27208 if (it
->descent
< 0)
27212 append_composite_glyph (it
);
27214 else if (it
->what
== IT_GLYPHLESS
)
27215 produce_glyphless_glyph (it
, 0, Qnil
);
27216 else if (it
->what
== IT_IMAGE
)
27217 produce_image_glyph (it
);
27218 else if (it
->what
== IT_STRETCH
)
27219 produce_stretch_glyph (it
);
27220 #ifdef HAVE_XWIDGETS
27221 else if (it
->what
== IT_XWIDGET
)
27222 produce_xwidget_glyph (it
);
27226 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27227 because this isn't true for images with `:ascent 100'. */
27228 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27229 if (it
->area
== TEXT_AREA
)
27230 it
->current_x
+= it
->pixel_width
;
27232 if (extra_line_spacing
> 0)
27234 it
->descent
+= extra_line_spacing
;
27235 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27236 it
->max_extra_line_spacing
= extra_line_spacing
;
27239 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27240 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27241 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27242 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27246 Output LEN glyphs starting at START at the nominal cursor position.
27247 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27248 being updated, and UPDATED_AREA is the area of that row being updated. */
27251 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27252 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27254 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27256 eassert (updated_row
);
27257 /* When the window is hscrolled, cursor hpos can legitimately be out
27258 of bounds, but we draw the cursor at the corresponding window
27259 margin in that case. */
27260 if (!updated_row
->reversed_p
&& chpos
< 0)
27262 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27263 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27267 /* Write glyphs. */
27269 hpos
= start
- updated_row
->glyphs
[updated_area
];
27270 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27271 updated_row
, updated_area
,
27273 DRAW_NORMAL_TEXT
, 0);
27275 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27276 if (updated_area
== TEXT_AREA
27277 && w
->phys_cursor_on_p
27278 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27280 && chpos
< hpos
+ len
)
27281 w
->phys_cursor_on_p
= 0;
27285 /* Advance the output cursor. */
27286 w
->output_cursor
.hpos
+= len
;
27287 w
->output_cursor
.x
= x
;
27292 Insert LEN glyphs from START at the nominal cursor position. */
27295 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27296 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27299 int line_height
, shift_by_width
, shifted_region_width
;
27300 struct glyph_row
*row
;
27301 struct glyph
*glyph
;
27302 int frame_x
, frame_y
;
27305 eassert (updated_row
);
27307 f
= XFRAME (WINDOW_FRAME (w
));
27309 /* Get the height of the line we are in. */
27311 line_height
= row
->height
;
27313 /* Get the width of the glyphs to insert. */
27314 shift_by_width
= 0;
27315 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27316 shift_by_width
+= glyph
->pixel_width
;
27318 /* Get the width of the region to shift right. */
27319 shifted_region_width
= (window_box_width (w
, updated_area
)
27320 - w
->output_cursor
.x
27324 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27325 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27327 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27328 line_height
, shift_by_width
);
27330 /* Write the glyphs. */
27331 hpos
= start
- row
->glyphs
[updated_area
];
27332 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27334 DRAW_NORMAL_TEXT
, 0);
27336 /* Advance the output cursor. */
27337 w
->output_cursor
.hpos
+= len
;
27338 w
->output_cursor
.x
+= shift_by_width
;
27344 Erase the current text line from the nominal cursor position
27345 (inclusive) to pixel column TO_X (exclusive). The idea is that
27346 everything from TO_X onward is already erased.
27348 TO_X is a pixel position relative to UPDATED_AREA of currently
27349 updated window W. TO_X == -1 means clear to the end of this area. */
27352 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27353 enum glyph_row_area updated_area
, int to_x
)
27356 int max_x
, min_y
, max_y
;
27357 int from_x
, from_y
, to_y
;
27359 eassert (updated_row
);
27360 f
= XFRAME (w
->frame
);
27362 if (updated_row
->full_width_p
)
27363 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27364 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27366 max_x
= window_box_width (w
, updated_area
);
27367 max_y
= window_text_bottom_y (w
);
27369 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27370 of window. For TO_X > 0, truncate to end of drawing area. */
27376 to_x
= min (to_x
, max_x
);
27378 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27380 /* Notice if the cursor will be cleared by this operation. */
27381 if (!updated_row
->full_width_p
)
27382 notice_overwritten_cursor (w
, updated_area
,
27383 w
->output_cursor
.x
, -1,
27385 MATRIX_ROW_BOTTOM_Y (updated_row
));
27387 from_x
= w
->output_cursor
.x
;
27389 /* Translate to frame coordinates. */
27390 if (updated_row
->full_width_p
)
27392 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27393 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27397 int area_left
= window_box_left (w
, updated_area
);
27398 from_x
+= area_left
;
27402 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27403 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27404 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27406 /* Prevent inadvertently clearing to end of the X window. */
27407 if (to_x
> from_x
&& to_y
> from_y
)
27410 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27411 to_x
- from_x
, to_y
- from_y
);
27416 #endif /* HAVE_WINDOW_SYSTEM */
27420 /***********************************************************************
27422 ***********************************************************************/
27424 /* Value is the internal representation of the specified cursor type
27425 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27426 of the bar cursor. */
27428 static enum text_cursor_kinds
27429 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27431 enum text_cursor_kinds type
;
27436 if (EQ (arg
, Qbox
))
27437 return FILLED_BOX_CURSOR
;
27439 if (EQ (arg
, Qhollow
))
27440 return HOLLOW_BOX_CURSOR
;
27442 if (EQ (arg
, Qbar
))
27449 && EQ (XCAR (arg
), Qbar
)
27450 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27452 *width
= XINT (XCDR (arg
));
27456 if (EQ (arg
, Qhbar
))
27459 return HBAR_CURSOR
;
27463 && EQ (XCAR (arg
), Qhbar
)
27464 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27466 *width
= XINT (XCDR (arg
));
27467 return HBAR_CURSOR
;
27470 /* Treat anything unknown as "hollow box cursor".
27471 It was bad to signal an error; people have trouble fixing
27472 .Xdefaults with Emacs, when it has something bad in it. */
27473 type
= HOLLOW_BOX_CURSOR
;
27478 /* Set the default cursor types for specified frame. */
27480 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27485 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27486 FRAME_CURSOR_WIDTH (f
) = width
;
27488 /* By default, set up the blink-off state depending on the on-state. */
27490 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27493 FRAME_BLINK_OFF_CURSOR (f
)
27494 = get_specified_cursor_type (XCDR (tem
), &width
);
27495 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27498 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27500 /* Make sure the cursor gets redrawn. */
27501 f
->cursor_type_changed
= 1;
27505 #ifdef HAVE_WINDOW_SYSTEM
27507 /* Return the cursor we want to be displayed in window W. Return
27508 width of bar/hbar cursor through WIDTH arg. Return with
27509 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27510 (i.e. if the `system caret' should track this cursor).
27512 In a mini-buffer window, we want the cursor only to appear if we
27513 are reading input from this window. For the selected window, we
27514 want the cursor type given by the frame parameter or buffer local
27515 setting of cursor-type. If explicitly marked off, draw no cursor.
27516 In all other cases, we want a hollow box cursor. */
27518 static enum text_cursor_kinds
27519 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27520 int *active_cursor
)
27522 struct frame
*f
= XFRAME (w
->frame
);
27523 struct buffer
*b
= XBUFFER (w
->contents
);
27524 int cursor_type
= DEFAULT_CURSOR
;
27525 Lisp_Object alt_cursor
;
27526 int non_selected
= 0;
27528 *active_cursor
= 1;
27531 if (cursor_in_echo_area
27532 && FRAME_HAS_MINIBUF_P (f
)
27533 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27535 if (w
== XWINDOW (echo_area_window
))
27537 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27539 *width
= FRAME_CURSOR_WIDTH (f
);
27540 return FRAME_DESIRED_CURSOR (f
);
27543 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27546 *active_cursor
= 0;
27550 /* Detect a nonselected window or nonselected frame. */
27551 else if (w
!= XWINDOW (f
->selected_window
)
27552 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27554 *active_cursor
= 0;
27556 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27562 /* Never display a cursor in a window in which cursor-type is nil. */
27563 if (NILP (BVAR (b
, cursor_type
)))
27566 /* Get the normal cursor type for this window. */
27567 if (EQ (BVAR (b
, cursor_type
), Qt
))
27569 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27570 *width
= FRAME_CURSOR_WIDTH (f
);
27573 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27575 /* Use cursor-in-non-selected-windows instead
27576 for non-selected window or frame. */
27579 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27580 if (!EQ (Qt
, alt_cursor
))
27581 return get_specified_cursor_type (alt_cursor
, width
);
27582 /* t means modify the normal cursor type. */
27583 if (cursor_type
== FILLED_BOX_CURSOR
)
27584 cursor_type
= HOLLOW_BOX_CURSOR
;
27585 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27587 return cursor_type
;
27590 /* Use normal cursor if not blinked off. */
27591 if (!w
->cursor_off_p
)
27594 #ifdef HAVE_XWIDGETS
27595 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
){
27599 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27601 if (cursor_type
== FILLED_BOX_CURSOR
)
27603 /* Using a block cursor on large images can be very annoying.
27604 So use a hollow cursor for "large" images.
27605 If image is not transparent (no mask), also use hollow cursor. */
27606 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27607 if (img
!= NULL
&& IMAGEP (img
->spec
))
27609 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27610 where N = size of default frame font size.
27611 This should cover most of the "tiny" icons people may use. */
27613 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27614 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27615 cursor_type
= HOLLOW_BOX_CURSOR
;
27618 else if (cursor_type
!= NO_CURSOR
)
27620 /* Display current only supports BOX and HOLLOW cursors for images.
27621 So for now, unconditionally use a HOLLOW cursor when cursor is
27622 not a solid box cursor. */
27623 cursor_type
= HOLLOW_BOX_CURSOR
;
27626 return cursor_type
;
27629 /* Cursor is blinked off, so determine how to "toggle" it. */
27631 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27632 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27633 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27635 /* Then see if frame has specified a specific blink off cursor type. */
27636 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27638 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27639 return FRAME_BLINK_OFF_CURSOR (f
);
27643 /* Some people liked having a permanently visible blinking cursor,
27644 while others had very strong opinions against it. So it was
27645 decided to remove it. KFS 2003-09-03 */
27647 /* Finally perform built-in cursor blinking:
27648 filled box <-> hollow box
27649 wide [h]bar <-> narrow [h]bar
27650 narrow [h]bar <-> no cursor
27651 other type <-> no cursor */
27653 if (cursor_type
== FILLED_BOX_CURSOR
)
27654 return HOLLOW_BOX_CURSOR
;
27656 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27659 return cursor_type
;
27667 /* Notice when the text cursor of window W has been completely
27668 overwritten by a drawing operation that outputs glyphs in AREA
27669 starting at X0 and ending at X1 in the line starting at Y0 and
27670 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27671 the rest of the line after X0 has been written. Y coordinates
27672 are window-relative. */
27675 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27676 int x0
, int x1
, int y0
, int y1
)
27678 int cx0
, cx1
, cy0
, cy1
;
27679 struct glyph_row
*row
;
27681 if (!w
->phys_cursor_on_p
)
27683 if (area
!= TEXT_AREA
)
27686 if (w
->phys_cursor
.vpos
< 0
27687 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27688 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27689 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27692 if (row
->cursor_in_fringe_p
)
27694 row
->cursor_in_fringe_p
= 0;
27695 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27696 w
->phys_cursor_on_p
= 0;
27700 cx0
= w
->phys_cursor
.x
;
27701 cx1
= cx0
+ w
->phys_cursor_width
;
27702 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27705 /* The cursor image will be completely removed from the
27706 screen if the output area intersects the cursor area in
27707 y-direction. When we draw in [y0 y1[, and some part of
27708 the cursor is at y < y0, that part must have been drawn
27709 before. When scrolling, the cursor is erased before
27710 actually scrolling, so we don't come here. When not
27711 scrolling, the rows above the old cursor row must have
27712 changed, and in this case these rows must have written
27713 over the cursor image.
27715 Likewise if part of the cursor is below y1, with the
27716 exception of the cursor being in the first blank row at
27717 the buffer and window end because update_text_area
27718 doesn't draw that row. (Except when it does, but
27719 that's handled in update_text_area.) */
27721 cy0
= w
->phys_cursor
.y
;
27722 cy1
= cy0
+ w
->phys_cursor_height
;
27723 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27726 w
->phys_cursor_on_p
= 0;
27729 #endif /* HAVE_WINDOW_SYSTEM */
27732 /************************************************************************
27734 ************************************************************************/
27736 #ifdef HAVE_WINDOW_SYSTEM
27739 Fix the display of area AREA of overlapping row ROW in window W
27740 with respect to the overlapping part OVERLAPS. */
27743 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27744 enum glyph_row_area area
, int overlaps
)
27751 for (i
= 0; i
< row
->used
[area
];)
27753 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27755 int start
= i
, start_x
= x
;
27759 x
+= row
->glyphs
[area
][i
].pixel_width
;
27762 while (i
< row
->used
[area
]
27763 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27765 draw_glyphs (w
, start_x
, row
, area
,
27767 DRAW_NORMAL_TEXT
, overlaps
);
27771 x
+= row
->glyphs
[area
][i
].pixel_width
;
27781 Draw the cursor glyph of window W in glyph row ROW. See the
27782 comment of draw_glyphs for the meaning of HL. */
27785 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27786 enum draw_glyphs_face hl
)
27788 /* If cursor hpos is out of bounds, don't draw garbage. This can
27789 happen in mini-buffer windows when switching between echo area
27790 glyphs and mini-buffer. */
27791 if ((row
->reversed_p
27792 ? (w
->phys_cursor
.hpos
>= 0)
27793 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27795 int on_p
= w
->phys_cursor_on_p
;
27797 int hpos
= w
->phys_cursor
.hpos
;
27799 /* When the window is hscrolled, cursor hpos can legitimately be
27800 out of bounds, but we draw the cursor at the corresponding
27801 window margin in that case. */
27802 if (!row
->reversed_p
&& hpos
< 0)
27804 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27805 hpos
= row
->used
[TEXT_AREA
] - 1;
27807 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27809 w
->phys_cursor_on_p
= on_p
;
27811 if (hl
== DRAW_CURSOR
)
27812 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27813 /* When we erase the cursor, and ROW is overlapped by other
27814 rows, make sure that these overlapping parts of other rows
27816 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27818 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27820 if (row
> w
->current_matrix
->rows
27821 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27822 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27823 OVERLAPS_ERASED_CURSOR
);
27825 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27826 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27827 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27828 OVERLAPS_ERASED_CURSOR
);
27834 /* Erase the image of a cursor of window W from the screen. */
27837 erase_phys_cursor (struct window
*w
)
27839 struct frame
*f
= XFRAME (w
->frame
);
27840 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27841 int hpos
= w
->phys_cursor
.hpos
;
27842 int vpos
= w
->phys_cursor
.vpos
;
27843 int mouse_face_here_p
= 0;
27844 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27845 struct glyph_row
*cursor_row
;
27846 struct glyph
*cursor_glyph
;
27847 enum draw_glyphs_face hl
;
27849 /* No cursor displayed or row invalidated => nothing to do on the
27851 if (w
->phys_cursor_type
== NO_CURSOR
)
27852 goto mark_cursor_off
;
27854 /* VPOS >= active_glyphs->nrows means that window has been resized.
27855 Don't bother to erase the cursor. */
27856 if (vpos
>= active_glyphs
->nrows
)
27857 goto mark_cursor_off
;
27859 /* If row containing cursor is marked invalid, there is nothing we
27861 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27862 if (!cursor_row
->enabled_p
)
27863 goto mark_cursor_off
;
27865 /* If line spacing is > 0, old cursor may only be partially visible in
27866 window after split-window. So adjust visible height. */
27867 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27868 window_text_bottom_y (w
) - cursor_row
->y
);
27870 /* If row is completely invisible, don't attempt to delete a cursor which
27871 isn't there. This can happen if cursor is at top of a window, and
27872 we switch to a buffer with a header line in that window. */
27873 if (cursor_row
->visible_height
<= 0)
27874 goto mark_cursor_off
;
27876 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27877 if (cursor_row
->cursor_in_fringe_p
)
27879 cursor_row
->cursor_in_fringe_p
= 0;
27880 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27881 goto mark_cursor_off
;
27884 /* This can happen when the new row is shorter than the old one.
27885 In this case, either draw_glyphs or clear_end_of_line
27886 should have cleared the cursor. Note that we wouldn't be
27887 able to erase the cursor in this case because we don't have a
27888 cursor glyph at hand. */
27889 if ((cursor_row
->reversed_p
27890 ? (w
->phys_cursor
.hpos
< 0)
27891 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27892 goto mark_cursor_off
;
27894 /* When the window is hscrolled, cursor hpos can legitimately be out
27895 of bounds, but we draw the cursor at the corresponding window
27896 margin in that case. */
27897 if (!cursor_row
->reversed_p
&& hpos
< 0)
27899 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27900 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27902 /* If the cursor is in the mouse face area, redisplay that when
27903 we clear the cursor. */
27904 if (! NILP (hlinfo
->mouse_face_window
)
27905 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27906 /* Don't redraw the cursor's spot in mouse face if it is at the
27907 end of a line (on a newline). The cursor appears there, but
27908 mouse highlighting does not. */
27909 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27910 mouse_face_here_p
= 1;
27912 /* Maybe clear the display under the cursor. */
27913 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27916 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27919 cursor_glyph
= get_phys_cursor_glyph (w
);
27920 if (cursor_glyph
== NULL
)
27921 goto mark_cursor_off
;
27923 width
= cursor_glyph
->pixel_width
;
27924 x
= w
->phys_cursor
.x
;
27930 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27931 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27932 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27935 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27938 /* Erase the cursor by redrawing the character underneath it. */
27939 if (mouse_face_here_p
)
27940 hl
= DRAW_MOUSE_FACE
;
27942 hl
= DRAW_NORMAL_TEXT
;
27943 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27946 w
->phys_cursor_on_p
= 0;
27947 w
->phys_cursor_type
= NO_CURSOR
;
27952 Display or clear cursor of window W. If ON is zero, clear the
27953 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27954 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27957 display_and_set_cursor (struct window
*w
, bool on
,
27958 int hpos
, int vpos
, int x
, int y
)
27960 struct frame
*f
= XFRAME (w
->frame
);
27961 int new_cursor_type
;
27962 int new_cursor_width
;
27964 struct glyph_row
*glyph_row
;
27965 struct glyph
*glyph
;
27967 /* This is pointless on invisible frames, and dangerous on garbaged
27968 windows and frames; in the latter case, the frame or window may
27969 be in the midst of changing its size, and x and y may be off the
27971 if (! FRAME_VISIBLE_P (f
)
27972 || FRAME_GARBAGED_P (f
)
27973 || vpos
>= w
->current_matrix
->nrows
27974 || hpos
>= w
->current_matrix
->matrix_w
)
27977 /* If cursor is off and we want it off, return quickly. */
27978 if (!on
&& !w
->phys_cursor_on_p
)
27981 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27982 /* If cursor row is not enabled, we don't really know where to
27983 display the cursor. */
27984 if (!glyph_row
->enabled_p
)
27986 w
->phys_cursor_on_p
= 0;
27991 if (!glyph_row
->exact_window_width_line_p
27992 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27993 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27995 eassert (input_blocked_p ());
27997 /* Set new_cursor_type to the cursor we want to be displayed. */
27998 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27999 &new_cursor_width
, &active_cursor
);
28001 /* If cursor is currently being shown and we don't want it to be or
28002 it is in the wrong place, or the cursor type is not what we want,
28004 if (w
->phys_cursor_on_p
28006 || w
->phys_cursor
.x
!= x
28007 || w
->phys_cursor
.y
!= y
28008 /* HPOS can be negative in R2L rows whose
28009 exact_window_width_line_p flag is set (i.e. their newline
28010 would "overflow into the fringe"). */
28012 || new_cursor_type
!= w
->phys_cursor_type
28013 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28014 && new_cursor_width
!= w
->phys_cursor_width
)))
28015 erase_phys_cursor (w
);
28017 /* Don't check phys_cursor_on_p here because that flag is only set
28018 to zero in some cases where we know that the cursor has been
28019 completely erased, to avoid the extra work of erasing the cursor
28020 twice. In other words, phys_cursor_on_p can be 1 and the cursor
28021 still not be visible, or it has only been partly erased. */
28024 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28025 w
->phys_cursor_height
= glyph_row
->height
;
28027 /* Set phys_cursor_.* before x_draw_.* is called because some
28028 of them may need the information. */
28029 w
->phys_cursor
.x
= x
;
28030 w
->phys_cursor
.y
= glyph_row
->y
;
28031 w
->phys_cursor
.hpos
= hpos
;
28032 w
->phys_cursor
.vpos
= vpos
;
28035 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28036 new_cursor_type
, new_cursor_width
,
28037 on
, active_cursor
);
28041 /* Switch the display of W's cursor on or off, according to the value
28045 update_window_cursor (struct window
*w
, bool on
)
28047 /* Don't update cursor in windows whose frame is in the process
28048 of being deleted. */
28049 if (w
->current_matrix
)
28051 int hpos
= w
->phys_cursor
.hpos
;
28052 int vpos
= w
->phys_cursor
.vpos
;
28053 struct glyph_row
*row
;
28055 if (vpos
>= w
->current_matrix
->nrows
28056 || hpos
>= w
->current_matrix
->matrix_w
)
28059 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28061 /* When the window is hscrolled, cursor hpos can legitimately be
28062 out of bounds, but we draw the cursor at the corresponding
28063 window margin in that case. */
28064 if (!row
->reversed_p
&& hpos
< 0)
28066 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28067 hpos
= row
->used
[TEXT_AREA
] - 1;
28070 display_and_set_cursor (w
, on
, hpos
, vpos
,
28071 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28077 /* Call update_window_cursor with parameter ON_P on all leaf windows
28078 in the window tree rooted at W. */
28081 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28085 if (WINDOWP (w
->contents
))
28086 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28088 update_window_cursor (w
, on_p
);
28090 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28096 Display the cursor on window W, or clear it, according to ON_P.
28097 Don't change the cursor's position. */
28100 x_update_cursor (struct frame
*f
, bool on_p
)
28102 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28107 Clear the cursor of window W to background color, and mark the
28108 cursor as not shown. This is used when the text where the cursor
28109 is about to be rewritten. */
28112 x_clear_cursor (struct window
*w
)
28114 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28115 update_window_cursor (w
, 0);
28118 #endif /* HAVE_WINDOW_SYSTEM */
28120 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28123 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28124 int start_hpos
, int end_hpos
,
28125 enum draw_glyphs_face draw
)
28127 #ifdef HAVE_WINDOW_SYSTEM
28128 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28130 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28134 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28135 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28139 /* Display the active region described by mouse_face_* according to DRAW. */
28142 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28144 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28145 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28147 if (/* If window is in the process of being destroyed, don't bother
28149 w
->current_matrix
!= NULL
28150 /* Don't update mouse highlight if hidden. */
28151 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28152 /* Recognize when we are called to operate on rows that don't exist
28153 anymore. This can happen when a window is split. */
28154 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28156 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
28157 struct glyph_row
*row
, *first
, *last
;
28159 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28160 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28162 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28164 int start_hpos
, end_hpos
, start_x
;
28166 /* For all but the first row, the highlight starts at column 0. */
28169 /* R2L rows have BEG and END in reversed order, but the
28170 screen drawing geometry is always left to right. So
28171 we need to mirror the beginning and end of the
28172 highlighted area in R2L rows. */
28173 if (!row
->reversed_p
)
28175 start_hpos
= hlinfo
->mouse_face_beg_col
;
28176 start_x
= hlinfo
->mouse_face_beg_x
;
28178 else if (row
== last
)
28180 start_hpos
= hlinfo
->mouse_face_end_col
;
28181 start_x
= hlinfo
->mouse_face_end_x
;
28189 else if (row
->reversed_p
&& row
== last
)
28191 start_hpos
= hlinfo
->mouse_face_end_col
;
28192 start_x
= hlinfo
->mouse_face_end_x
;
28202 if (!row
->reversed_p
)
28203 end_hpos
= hlinfo
->mouse_face_end_col
;
28204 else if (row
== first
)
28205 end_hpos
= hlinfo
->mouse_face_beg_col
;
28208 end_hpos
= row
->used
[TEXT_AREA
];
28209 if (draw
== DRAW_NORMAL_TEXT
)
28210 row
->fill_line_p
= 1; /* Clear to end of line */
28213 else if (row
->reversed_p
&& row
== first
)
28214 end_hpos
= hlinfo
->mouse_face_beg_col
;
28217 end_hpos
= row
->used
[TEXT_AREA
];
28218 if (draw
== DRAW_NORMAL_TEXT
)
28219 row
->fill_line_p
= 1; /* Clear to end of line */
28222 if (end_hpos
> start_hpos
)
28224 draw_row_with_mouse_face (w
, start_x
, row
,
28225 start_hpos
, end_hpos
, draw
);
28228 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28232 #ifdef HAVE_WINDOW_SYSTEM
28233 /* When we've written over the cursor, arrange for it to
28234 be displayed again. */
28235 if (FRAME_WINDOW_P (f
)
28236 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28238 int hpos
= w
->phys_cursor
.hpos
;
28240 /* When the window is hscrolled, cursor hpos can legitimately be
28241 out of bounds, but we draw the cursor at the corresponding
28242 window margin in that case. */
28243 if (!row
->reversed_p
&& hpos
< 0)
28245 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28246 hpos
= row
->used
[TEXT_AREA
] - 1;
28249 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
28250 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28253 #endif /* HAVE_WINDOW_SYSTEM */
28256 #ifdef HAVE_WINDOW_SYSTEM
28257 /* Change the mouse cursor. */
28258 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28260 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28261 if (draw
== DRAW_NORMAL_TEXT
28262 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28263 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28266 if (draw
== DRAW_MOUSE_FACE
)
28267 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28269 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28271 #endif /* HAVE_WINDOW_SYSTEM */
28275 Clear out the mouse-highlighted active region.
28276 Redraw it un-highlighted first. Value is non-zero if mouse
28277 face was actually drawn unhighlighted. */
28280 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28284 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
28286 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28290 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28291 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28292 hlinfo
->mouse_face_window
= Qnil
;
28293 hlinfo
->mouse_face_overlay
= Qnil
;
28297 /* Return true if the coordinates HPOS and VPOS on windows W are
28298 within the mouse face on that window. */
28300 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28302 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28304 /* Quickly resolve the easy cases. */
28305 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28306 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28308 if (vpos
< hlinfo
->mouse_face_beg_row
28309 || vpos
> hlinfo
->mouse_face_end_row
)
28311 if (vpos
> hlinfo
->mouse_face_beg_row
28312 && vpos
< hlinfo
->mouse_face_end_row
)
28315 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28317 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28319 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28322 else if ((vpos
== hlinfo
->mouse_face_beg_row
28323 && hpos
>= hlinfo
->mouse_face_beg_col
)
28324 || (vpos
== hlinfo
->mouse_face_end_row
28325 && hpos
< hlinfo
->mouse_face_end_col
))
28330 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28332 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28335 else if ((vpos
== hlinfo
->mouse_face_beg_row
28336 && hpos
<= hlinfo
->mouse_face_beg_col
)
28337 || (vpos
== hlinfo
->mouse_face_end_row
28338 && hpos
> hlinfo
->mouse_face_end_col
))
28346 True if physical cursor of window W is within mouse face. */
28349 cursor_in_mouse_face_p (struct window
*w
)
28351 int hpos
= w
->phys_cursor
.hpos
;
28352 int vpos
= w
->phys_cursor
.vpos
;
28353 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28355 /* When the window is hscrolled, cursor hpos can legitimately be out
28356 of bounds, but we draw the cursor at the corresponding window
28357 margin in that case. */
28358 if (!row
->reversed_p
&& hpos
< 0)
28360 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28361 hpos
= row
->used
[TEXT_AREA
] - 1;
28363 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28368 /* Find the glyph rows START_ROW and END_ROW of window W that display
28369 characters between buffer positions START_CHARPOS and END_CHARPOS
28370 (excluding END_CHARPOS). DISP_STRING is a display string that
28371 covers these buffer positions. This is similar to
28372 row_containing_pos, but is more accurate when bidi reordering makes
28373 buffer positions change non-linearly with glyph rows. */
28375 rows_from_pos_range (struct window
*w
,
28376 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28377 Lisp_Object disp_string
,
28378 struct glyph_row
**start
, struct glyph_row
**end
)
28380 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28381 int last_y
= window_text_bottom_y (w
);
28382 struct glyph_row
*row
;
28387 while (!first
->enabled_p
28388 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28391 /* Find the START row. */
28393 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28396 /* A row can potentially be the START row if the range of the
28397 characters it displays intersects the range
28398 [START_CHARPOS..END_CHARPOS). */
28399 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28400 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28401 /* See the commentary in row_containing_pos, for the
28402 explanation of the complicated way to check whether
28403 some position is beyond the end of the characters
28404 displayed by a row. */
28405 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28406 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28407 && !row
->ends_at_zv_p
28408 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28409 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28410 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28411 && !row
->ends_at_zv_p
28412 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28414 /* Found a candidate row. Now make sure at least one of the
28415 glyphs it displays has a charpos from the range
28416 [START_CHARPOS..END_CHARPOS).
28418 This is not obvious because bidi reordering could make
28419 buffer positions of a row be 1,2,3,102,101,100, and if we
28420 want to highlight characters in [50..60), we don't want
28421 this row, even though [50..60) does intersect [1..103),
28422 the range of character positions given by the row's start
28423 and end positions. */
28424 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28425 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28429 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28430 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28431 /* A glyph that comes from DISP_STRING is by
28432 definition to be highlighted. */
28433 || EQ (g
->object
, disp_string
))
28442 /* Find the END row. */
28444 /* If the last row is partially visible, start looking for END
28445 from that row, instead of starting from FIRST. */
28446 && !(row
->enabled_p
28447 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28449 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28451 struct glyph_row
*next
= row
+ 1;
28452 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28454 if (!next
->enabled_p
28455 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28456 /* The first row >= START whose range of displayed characters
28457 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28458 is the row END + 1. */
28459 || (start_charpos
< next_start
28460 && end_charpos
< next_start
)
28461 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28462 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28463 && !next
->ends_at_zv_p
28464 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28465 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28466 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28467 && !next
->ends_at_zv_p
28468 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28475 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28476 but none of the characters it displays are in the range, it is
28478 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28479 struct glyph
*s
= g
;
28480 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28484 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28485 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28486 /* If the buffer position of the first glyph in
28487 the row is equal to END_CHARPOS, it means
28488 the last character to be highlighted is the
28489 newline of ROW, and we must consider NEXT as
28491 || (((!next
->reversed_p
&& g
== s
)
28492 || (next
->reversed_p
&& g
== e
- 1))
28493 && (g
->charpos
== end_charpos
28494 /* Special case for when NEXT is an
28495 empty line at ZV. */
28496 || (g
->charpos
== -1
28497 && !row
->ends_at_zv_p
28498 && next_start
== end_charpos
)))))
28499 /* A glyph that comes from DISP_STRING is by
28500 definition to be highlighted. */
28501 || EQ (g
->object
, disp_string
))
28510 /* The first row that ends at ZV must be the last to be
28512 else if (next
->ends_at_zv_p
)
28521 /* This function sets the mouse_face_* elements of HLINFO, assuming
28522 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28523 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28524 for the overlay or run of text properties specifying the mouse
28525 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28526 before-string and after-string that must also be highlighted.
28527 DISP_STRING, if non-nil, is a display string that may cover some
28528 or all of the highlighted text. */
28531 mouse_face_from_buffer_pos (Lisp_Object window
,
28532 Mouse_HLInfo
*hlinfo
,
28533 ptrdiff_t mouse_charpos
,
28534 ptrdiff_t start_charpos
,
28535 ptrdiff_t end_charpos
,
28536 Lisp_Object before_string
,
28537 Lisp_Object after_string
,
28538 Lisp_Object disp_string
)
28540 struct window
*w
= XWINDOW (window
);
28541 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28542 struct glyph_row
*r1
, *r2
;
28543 struct glyph
*glyph
, *end
;
28544 ptrdiff_t ignore
, pos
;
28547 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28548 eassert (NILP (before_string
) || STRINGP (before_string
));
28549 eassert (NILP (after_string
) || STRINGP (after_string
));
28551 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28552 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28554 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28555 /* If the before-string or display-string contains newlines,
28556 rows_from_pos_range skips to its last row. Move back. */
28557 if (!NILP (before_string
) || !NILP (disp_string
))
28559 struct glyph_row
*prev
;
28560 while ((prev
= r1
- 1, prev
>= first
)
28561 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28562 && prev
->used
[TEXT_AREA
] > 0)
28564 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28565 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28566 while (--glyph
>= beg
&& NILP (glyph
->object
));
28568 || !(EQ (glyph
->object
, before_string
)
28569 || EQ (glyph
->object
, disp_string
)))
28576 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28577 hlinfo
->mouse_face_past_end
= 1;
28579 else if (!NILP (after_string
))
28581 /* If the after-string has newlines, advance to its last row. */
28582 struct glyph_row
*next
;
28583 struct glyph_row
*last
28584 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28586 for (next
= r2
+ 1;
28588 && next
->used
[TEXT_AREA
] > 0
28589 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28593 /* The rest of the display engine assumes that mouse_face_beg_row is
28594 either above mouse_face_end_row or identical to it. But with
28595 bidi-reordered continued lines, the row for START_CHARPOS could
28596 be below the row for END_CHARPOS. If so, swap the rows and store
28597 them in correct order. */
28600 struct glyph_row
*tem
= r2
;
28606 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28607 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28609 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28610 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28611 could be anywhere in the row and in any order. The strategy
28612 below is to find the leftmost and the rightmost glyph that
28613 belongs to either of these 3 strings, or whose position is
28614 between START_CHARPOS and END_CHARPOS, and highlight all the
28615 glyphs between those two. This may cover more than just the text
28616 between START_CHARPOS and END_CHARPOS if the range of characters
28617 strides the bidi level boundary, e.g. if the beginning is in R2L
28618 text while the end is in L2R text or vice versa. */
28619 if (!r1
->reversed_p
)
28621 /* This row is in a left to right paragraph. Scan it left to
28623 glyph
= r1
->glyphs
[TEXT_AREA
];
28624 end
= glyph
+ r1
->used
[TEXT_AREA
];
28627 /* Skip truncation glyphs at the start of the glyph row. */
28628 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28630 && NILP (glyph
->object
)
28631 && glyph
->charpos
< 0;
28633 x
+= glyph
->pixel_width
;
28635 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28636 or DISP_STRING, and the first glyph from buffer whose
28637 position is between START_CHARPOS and END_CHARPOS. */
28639 && !NILP (glyph
->object
)
28640 && !EQ (glyph
->object
, disp_string
)
28641 && !(BUFFERP (glyph
->object
)
28642 && (glyph
->charpos
>= start_charpos
28643 && glyph
->charpos
< end_charpos
));
28646 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28647 are present at buffer positions between START_CHARPOS and
28648 END_CHARPOS, or if they come from an overlay. */
28649 if (EQ (glyph
->object
, before_string
))
28651 pos
= string_buffer_position (before_string
,
28653 /* If pos == 0, it means before_string came from an
28654 overlay, not from a buffer position. */
28655 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28658 else if (EQ (glyph
->object
, after_string
))
28660 pos
= string_buffer_position (after_string
, end_charpos
);
28661 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28664 x
+= glyph
->pixel_width
;
28666 hlinfo
->mouse_face_beg_x
= x
;
28667 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28671 /* This row is in a right to left paragraph. Scan it right to
28675 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28676 glyph
= end
+ r1
->used
[TEXT_AREA
];
28678 /* Skip truncation glyphs at the start of the glyph row. */
28679 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28681 && NILP (glyph
->object
)
28682 && glyph
->charpos
< 0;
28686 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28687 or DISP_STRING, and the first glyph from buffer whose
28688 position is between START_CHARPOS and END_CHARPOS. */
28690 && !NILP (glyph
->object
)
28691 && !EQ (glyph
->object
, disp_string
)
28692 && !(BUFFERP (glyph
->object
)
28693 && (glyph
->charpos
>= start_charpos
28694 && glyph
->charpos
< end_charpos
));
28697 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28698 are present at buffer positions between START_CHARPOS and
28699 END_CHARPOS, or if they come from an overlay. */
28700 if (EQ (glyph
->object
, before_string
))
28702 pos
= string_buffer_position (before_string
, start_charpos
);
28703 /* If pos == 0, it means before_string came from an
28704 overlay, not from a buffer position. */
28705 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28708 else if (EQ (glyph
->object
, after_string
))
28710 pos
= string_buffer_position (after_string
, end_charpos
);
28711 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28716 glyph
++; /* first glyph to the right of the highlighted area */
28717 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28718 x
+= g
->pixel_width
;
28719 hlinfo
->mouse_face_beg_x
= x
;
28720 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28723 /* If the highlight ends in a different row, compute GLYPH and END
28724 for the end row. Otherwise, reuse the values computed above for
28725 the row where the highlight begins. */
28728 if (!r2
->reversed_p
)
28730 glyph
= r2
->glyphs
[TEXT_AREA
];
28731 end
= glyph
+ r2
->used
[TEXT_AREA
];
28736 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28737 glyph
= end
+ r2
->used
[TEXT_AREA
];
28741 if (!r2
->reversed_p
)
28743 /* Skip truncation and continuation glyphs near the end of the
28744 row, and also blanks and stretch glyphs inserted by
28745 extend_face_to_end_of_line. */
28747 && NILP ((end
- 1)->object
))
28749 /* Scan the rest of the glyph row from the end, looking for the
28750 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28751 DISP_STRING, or whose position is between START_CHARPOS
28755 && !NILP (end
->object
)
28756 && !EQ (end
->object
, disp_string
)
28757 && !(BUFFERP (end
->object
)
28758 && (end
->charpos
>= start_charpos
28759 && end
->charpos
< end_charpos
));
28762 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28763 are present at buffer positions between START_CHARPOS and
28764 END_CHARPOS, or if they come from an overlay. */
28765 if (EQ (end
->object
, before_string
))
28767 pos
= string_buffer_position (before_string
, start_charpos
);
28768 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28771 else if (EQ (end
->object
, after_string
))
28773 pos
= string_buffer_position (after_string
, end_charpos
);
28774 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28778 /* Find the X coordinate of the last glyph to be highlighted. */
28779 for (; glyph
<= end
; ++glyph
)
28780 x
+= glyph
->pixel_width
;
28782 hlinfo
->mouse_face_end_x
= x
;
28783 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28787 /* Skip truncation and continuation glyphs near the end of the
28788 row, and also blanks and stretch glyphs inserted by
28789 extend_face_to_end_of_line. */
28793 && NILP (end
->object
))
28795 x
+= end
->pixel_width
;
28798 /* Scan the rest of the glyph row from the end, looking for the
28799 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28800 DISP_STRING, or whose position is between START_CHARPOS
28804 && !NILP (end
->object
)
28805 && !EQ (end
->object
, disp_string
)
28806 && !(BUFFERP (end
->object
)
28807 && (end
->charpos
>= start_charpos
28808 && end
->charpos
< end_charpos
));
28811 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28812 are present at buffer positions between START_CHARPOS and
28813 END_CHARPOS, or if they come from an overlay. */
28814 if (EQ (end
->object
, before_string
))
28816 pos
= string_buffer_position (before_string
, start_charpos
);
28817 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28820 else if (EQ (end
->object
, after_string
))
28822 pos
= string_buffer_position (after_string
, end_charpos
);
28823 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28826 x
+= end
->pixel_width
;
28828 /* If we exited the above loop because we arrived at the last
28829 glyph of the row, and its buffer position is still not in
28830 range, it means the last character in range is the preceding
28831 newline. Bump the end column and x values to get past the
28834 && BUFFERP (end
->object
)
28835 && (end
->charpos
< start_charpos
28836 || end
->charpos
>= end_charpos
))
28838 x
+= end
->pixel_width
;
28841 hlinfo
->mouse_face_end_x
= x
;
28842 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28845 hlinfo
->mouse_face_window
= window
;
28846 hlinfo
->mouse_face_face_id
28847 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28849 !hlinfo
->mouse_face_hidden
, -1);
28850 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28853 /* The following function is not used anymore (replaced with
28854 mouse_face_from_string_pos), but I leave it here for the time
28855 being, in case someone would. */
28857 #if 0 /* not used */
28859 /* Find the position of the glyph for position POS in OBJECT in
28860 window W's current matrix, and return in *X, *Y the pixel
28861 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28863 RIGHT_P non-zero means return the position of the right edge of the
28864 glyph, RIGHT_P zero means return the left edge position.
28866 If no glyph for POS exists in the matrix, return the position of
28867 the glyph with the next smaller position that is in the matrix, if
28868 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28869 exists in the matrix, return the position of the glyph with the
28870 next larger position in OBJECT.
28872 Value is non-zero if a glyph was found. */
28875 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28876 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28878 int yb
= window_text_bottom_y (w
);
28879 struct glyph_row
*r
;
28880 struct glyph
*best_glyph
= NULL
;
28881 struct glyph_row
*best_row
= NULL
;
28884 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28885 r
->enabled_p
&& r
->y
< yb
;
28888 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28889 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28892 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28893 if (EQ (g
->object
, object
))
28895 if (g
->charpos
== pos
)
28902 else if (best_glyph
== NULL
28903 || ((eabs (g
->charpos
- pos
)
28904 < eabs (best_glyph
->charpos
- pos
))
28907 : g
->charpos
> pos
)))
28921 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28925 *x
+= best_glyph
->pixel_width
;
28930 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28933 return best_glyph
!= NULL
;
28935 #endif /* not used */
28937 /* Find the positions of the first and the last glyphs in window W's
28938 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28939 (assumed to be a string), and return in HLINFO's mouse_face_*
28940 members the pixel and column/row coordinates of those glyphs. */
28943 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28944 Lisp_Object object
,
28945 ptrdiff_t startpos
, ptrdiff_t endpos
)
28947 int yb
= window_text_bottom_y (w
);
28948 struct glyph_row
*r
;
28949 struct glyph
*g
, *e
;
28953 /* Find the glyph row with at least one position in the range
28954 [STARTPOS..ENDPOS), and the first glyph in that row whose
28955 position belongs to that range. */
28956 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28957 r
->enabled_p
&& r
->y
< yb
;
28960 if (!r
->reversed_p
)
28962 g
= r
->glyphs
[TEXT_AREA
];
28963 e
= g
+ r
->used
[TEXT_AREA
];
28964 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28965 if (EQ (g
->object
, object
)
28966 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28968 hlinfo
->mouse_face_beg_row
28969 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28970 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28971 hlinfo
->mouse_face_beg_x
= gx
;
28980 e
= r
->glyphs
[TEXT_AREA
];
28981 g
= e
+ r
->used
[TEXT_AREA
];
28982 for ( ; g
> e
; --g
)
28983 if (EQ ((g
-1)->object
, object
)
28984 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28986 hlinfo
->mouse_face_beg_row
28987 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28988 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28989 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28990 gx
+= g1
->pixel_width
;
28991 hlinfo
->mouse_face_beg_x
= gx
;
29003 /* Starting with the next row, look for the first row which does NOT
29004 include any glyphs whose positions are in the range. */
29005 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29007 g
= r
->glyphs
[TEXT_AREA
];
29008 e
= g
+ r
->used
[TEXT_AREA
];
29010 for ( ; g
< e
; ++g
)
29011 if (EQ (g
->object
, object
)
29012 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29021 /* The highlighted region ends on the previous row. */
29024 /* Set the end row. */
29025 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29027 /* Compute and set the end column and the end column's horizontal
29028 pixel coordinate. */
29029 if (!r
->reversed_p
)
29031 g
= r
->glyphs
[TEXT_AREA
];
29032 e
= g
+ r
->used
[TEXT_AREA
];
29033 for ( ; e
> g
; --e
)
29034 if (EQ ((e
-1)->object
, object
)
29035 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29037 hlinfo
->mouse_face_end_col
= e
- g
;
29039 for (gx
= r
->x
; g
< e
; ++g
)
29040 gx
+= g
->pixel_width
;
29041 hlinfo
->mouse_face_end_x
= gx
;
29045 e
= r
->glyphs
[TEXT_AREA
];
29046 g
= e
+ r
->used
[TEXT_AREA
];
29047 for (gx
= r
->x
; e
< g
; ++e
)
29049 if (EQ (e
->object
, object
)
29050 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29052 gx
+= e
->pixel_width
;
29054 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29055 hlinfo
->mouse_face_end_x
= gx
;
29059 #ifdef HAVE_WINDOW_SYSTEM
29061 /* See if position X, Y is within a hot-spot of an image. */
29064 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29066 if (!CONSP (hot_spot
))
29069 if (EQ (XCAR (hot_spot
), Qrect
))
29071 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29072 Lisp_Object rect
= XCDR (hot_spot
);
29076 if (!CONSP (XCAR (rect
)))
29078 if (!CONSP (XCDR (rect
)))
29080 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29082 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29084 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29086 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29090 else if (EQ (XCAR (hot_spot
), Qcircle
))
29092 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29093 Lisp_Object circ
= XCDR (hot_spot
);
29094 Lisp_Object lr
, lx0
, ly0
;
29096 && CONSP (XCAR (circ
))
29097 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
29098 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29099 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29101 double r
= XFLOATINT (lr
);
29102 double dx
= XINT (lx0
) - x
;
29103 double dy
= XINT (ly0
) - y
;
29104 return (dx
* dx
+ dy
* dy
<= r
* r
);
29107 else if (EQ (XCAR (hot_spot
), Qpoly
))
29109 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29110 if (VECTORP (XCDR (hot_spot
)))
29112 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29113 Lisp_Object
*poly
= v
->contents
;
29114 ptrdiff_t n
= v
->header
.size
;
29117 Lisp_Object lx
, ly
;
29120 /* Need an even number of coordinates, and at least 3 edges. */
29121 if (n
< 6 || n
& 1)
29124 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29125 If count is odd, we are inside polygon. Pixels on edges
29126 may or may not be included depending on actual geometry of the
29128 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29129 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29131 x0
= XINT (lx
), y0
= XINT (ly
);
29132 for (i
= 0; i
< n
; i
+= 2)
29134 int x1
= x0
, y1
= y0
;
29135 if ((lx
= poly
[i
], !INTEGERP (lx
))
29136 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29138 x0
= XINT (lx
), y0
= XINT (ly
);
29140 /* Does this segment cross the X line? */
29148 if (y
> y0
&& y
> y1
)
29150 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29160 find_hot_spot (Lisp_Object map
, int x
, int y
)
29162 while (CONSP (map
))
29164 if (CONSP (XCAR (map
))
29165 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29173 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29175 doc
: /* Lookup in image map MAP coordinates X and Y.
29176 An image map is an alist where each element has the format (AREA ID PLIST).
29177 An AREA is specified as either a rectangle, a circle, or a polygon:
29178 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29179 pixel coordinates of the upper left and bottom right corners.
29180 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29181 and the radius of the circle; r may be a float or integer.
29182 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29183 vector describes one corner in the polygon.
29184 Returns the alist element for the first matching AREA in MAP. */)
29185 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29193 return find_hot_spot (map
,
29194 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29195 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29199 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29201 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29203 /* Do not change cursor shape while dragging mouse. */
29204 if (!NILP (do_mouse_tracking
))
29207 if (!NILP (pointer
))
29209 if (EQ (pointer
, Qarrow
))
29210 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29211 else if (EQ (pointer
, Qhand
))
29212 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29213 else if (EQ (pointer
, Qtext
))
29214 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29215 else if (EQ (pointer
, intern ("hdrag")))
29216 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29217 else if (EQ (pointer
, intern ("nhdrag")))
29218 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29219 #ifdef HAVE_X_WINDOWS
29220 else if (EQ (pointer
, intern ("vdrag")))
29221 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29223 else if (EQ (pointer
, intern ("hourglass")))
29224 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29225 else if (EQ (pointer
, Qmodeline
))
29226 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29228 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29231 if (cursor
!= No_Cursor
)
29232 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29235 #endif /* HAVE_WINDOW_SYSTEM */
29237 /* Take proper action when mouse has moved to the mode or header line
29238 or marginal area AREA of window W, x-position X and y-position Y.
29239 X is relative to the start of the text display area of W, so the
29240 width of bitmap areas and scroll bars must be subtracted to get a
29241 position relative to the start of the mode line. */
29244 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29245 enum window_part area
)
29247 struct window
*w
= XWINDOW (window
);
29248 struct frame
*f
= XFRAME (w
->frame
);
29249 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29250 #ifdef HAVE_WINDOW_SYSTEM
29251 Display_Info
*dpyinfo
;
29253 Cursor cursor
= No_Cursor
;
29254 Lisp_Object pointer
= Qnil
;
29255 int dx
, dy
, width
, height
;
29257 Lisp_Object string
, object
= Qnil
;
29258 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29260 Lisp_Object mouse_face
;
29261 int original_x_pixel
= x
;
29262 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29263 struct glyph_row
*row
IF_LINT (= 0);
29265 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29270 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29271 returns them in row/column units! */
29272 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29273 &object
, &dx
, &dy
, &width
, &height
);
29275 row
= (area
== ON_MODE_LINE
29276 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29277 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29279 /* Find the glyph under the mouse pointer. */
29280 if (row
->mode_line_p
&& row
->enabled_p
)
29282 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29283 end
= glyph
+ row
->used
[TEXT_AREA
];
29285 for (x0
= original_x_pixel
;
29286 glyph
< end
&& x0
>= glyph
->pixel_width
;
29288 x0
-= glyph
->pixel_width
;
29296 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29297 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29298 returns them in row/column units! */
29299 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29300 &object
, &dx
, &dy
, &width
, &height
);
29305 #ifdef HAVE_WINDOW_SYSTEM
29306 if (IMAGEP (object
))
29308 Lisp_Object image_map
, hotspot
;
29309 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29311 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29313 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29317 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29318 If so, we could look for mouse-enter, mouse-leave
29319 properties in PLIST (and do something...). */
29320 hotspot
= XCDR (hotspot
);
29321 if (CONSP (hotspot
)
29322 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29324 pointer
= Fplist_get (plist
, Qpointer
);
29325 if (NILP (pointer
))
29327 help
= Fplist_get (plist
, Qhelp_echo
);
29330 help_echo_string
= help
;
29331 XSETWINDOW (help_echo_window
, w
);
29332 help_echo_object
= w
->contents
;
29333 help_echo_pos
= charpos
;
29337 if (NILP (pointer
))
29338 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29340 #endif /* HAVE_WINDOW_SYSTEM */
29342 if (STRINGP (string
))
29343 pos
= make_number (charpos
);
29345 /* Set the help text and mouse pointer. If the mouse is on a part
29346 of the mode line without any text (e.g. past the right edge of
29347 the mode line text), use the default help text and pointer. */
29348 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29350 /* Arrange to display the help by setting the global variables
29351 help_echo_string, help_echo_object, and help_echo_pos. */
29354 if (STRINGP (string
))
29355 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29359 help_echo_string
= help
;
29360 XSETWINDOW (help_echo_window
, w
);
29361 help_echo_object
= string
;
29362 help_echo_pos
= charpos
;
29364 else if (area
== ON_MODE_LINE
)
29366 Lisp_Object default_help
29367 = buffer_local_value (Qmode_line_default_help_echo
,
29370 if (STRINGP (default_help
))
29372 help_echo_string
= default_help
;
29373 XSETWINDOW (help_echo_window
, w
);
29374 help_echo_object
= Qnil
;
29375 help_echo_pos
= -1;
29380 #ifdef HAVE_WINDOW_SYSTEM
29381 /* Change the mouse pointer according to what is under it. */
29382 if (FRAME_WINDOW_P (f
))
29384 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29386 || NILP (Vresize_mini_windows
));
29388 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29389 if (STRINGP (string
))
29391 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29393 if (NILP (pointer
))
29394 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29396 /* Change the mouse pointer according to what is under X/Y. */
29398 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29401 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29402 if (!KEYMAPP (map
))
29403 map
= Fget_text_property (pos
, Qkeymap
, string
);
29404 if (!KEYMAPP (map
) && draggable
)
29405 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29408 else if (draggable
)
29409 /* Default mode-line pointer. */
29410 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29415 /* Change the mouse face according to what is under X/Y. */
29416 if (STRINGP (string
))
29418 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29419 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29420 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29425 struct glyph
* tmp_glyph
;
29429 int total_pixel_width
;
29430 ptrdiff_t begpos
, endpos
, ignore
;
29434 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29435 Qmouse_face
, string
, Qnil
);
29441 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29443 endpos
= SCHARS (string
);
29447 /* Calculate the glyph position GPOS of GLYPH in the
29448 displayed string, relative to the beginning of the
29449 highlighted part of the string.
29451 Note: GPOS is different from CHARPOS. CHARPOS is the
29452 position of GLYPH in the internal string object. A mode
29453 line string format has structures which are converted to
29454 a flattened string by the Emacs Lisp interpreter. The
29455 internal string is an element of those structures. The
29456 displayed string is the flattened string. */
29457 tmp_glyph
= row_start_glyph
;
29458 while (tmp_glyph
< glyph
29459 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29460 && begpos
<= tmp_glyph
->charpos
29461 && tmp_glyph
->charpos
< endpos
)))
29463 gpos
= glyph
- tmp_glyph
;
29465 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29466 the highlighted part of the displayed string to which
29467 GLYPH belongs. Note: GSEQ_LENGTH is different from
29468 SCHARS (STRING), because the latter returns the length of
29469 the internal string. */
29470 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29472 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29473 && begpos
<= tmp_glyph
->charpos
29474 && tmp_glyph
->charpos
< endpos
));
29477 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29479 /* Calculate the total pixel width of all the glyphs between
29480 the beginning of the highlighted area and GLYPH. */
29481 total_pixel_width
= 0;
29482 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29483 total_pixel_width
+= tmp_glyph
->pixel_width
;
29485 /* Pre calculation of re-rendering position. Note: X is in
29486 column units here, after the call to mode_line_string or
29487 marginal_area_string. */
29489 vpos
= (area
== ON_MODE_LINE
29490 ? (w
->current_matrix
)->nrows
- 1
29493 /* If GLYPH's position is included in the region that is
29494 already drawn in mouse face, we have nothing to do. */
29495 if ( EQ (window
, hlinfo
->mouse_face_window
)
29496 && (!row
->reversed_p
29497 ? (hlinfo
->mouse_face_beg_col
<= hpos
29498 && hpos
< hlinfo
->mouse_face_end_col
)
29499 /* In R2L rows we swap BEG and END, see below. */
29500 : (hlinfo
->mouse_face_end_col
<= hpos
29501 && hpos
< hlinfo
->mouse_face_beg_col
))
29502 && hlinfo
->mouse_face_beg_row
== vpos
)
29505 if (clear_mouse_face (hlinfo
))
29506 cursor
= No_Cursor
;
29508 if (!row
->reversed_p
)
29510 hlinfo
->mouse_face_beg_col
= hpos
;
29511 hlinfo
->mouse_face_beg_x
= original_x_pixel
29512 - (total_pixel_width
+ dx
);
29513 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29514 hlinfo
->mouse_face_end_x
= 0;
29518 /* In R2L rows, show_mouse_face expects BEG and END
29519 coordinates to be swapped. */
29520 hlinfo
->mouse_face_end_col
= hpos
;
29521 hlinfo
->mouse_face_end_x
= original_x_pixel
29522 - (total_pixel_width
+ dx
);
29523 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29524 hlinfo
->mouse_face_beg_x
= 0;
29527 hlinfo
->mouse_face_beg_row
= vpos
;
29528 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29529 hlinfo
->mouse_face_past_end
= 0;
29530 hlinfo
->mouse_face_window
= window
;
29532 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29537 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29539 if (NILP (pointer
))
29542 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29543 clear_mouse_face (hlinfo
);
29545 #ifdef HAVE_WINDOW_SYSTEM
29546 if (FRAME_WINDOW_P (f
))
29547 define_frame_cursor1 (f
, cursor
, pointer
);
29553 Take proper action when the mouse has moved to position X, Y on
29554 frame F with regards to highlighting portions of display that have
29555 mouse-face properties. Also de-highlight portions of display where
29556 the mouse was before, set the mouse pointer shape as appropriate
29557 for the mouse coordinates, and activate help echo (tooltips).
29558 X and Y can be negative or out of range. */
29561 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29563 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29564 enum window_part part
= ON_NOTHING
;
29565 Lisp_Object window
;
29567 Cursor cursor
= No_Cursor
;
29568 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29571 /* When a menu is active, don't highlight because this looks odd. */
29572 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29573 if (popup_activated ())
29577 if (!f
->glyphs_initialized_p
29578 || f
->pointer_invisible
)
29581 hlinfo
->mouse_face_mouse_x
= x
;
29582 hlinfo
->mouse_face_mouse_y
= y
;
29583 hlinfo
->mouse_face_mouse_frame
= f
;
29585 if (hlinfo
->mouse_face_defer
)
29588 /* Which window is that in? */
29589 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29591 /* If displaying active text in another window, clear that. */
29592 if (! EQ (window
, hlinfo
->mouse_face_window
)
29593 /* Also clear if we move out of text area in same window. */
29594 || (!NILP (hlinfo
->mouse_face_window
)
29597 && part
!= ON_MODE_LINE
29598 && part
!= ON_HEADER_LINE
))
29599 clear_mouse_face (hlinfo
);
29601 /* Not on a window -> return. */
29602 if (!WINDOWP (window
))
29605 /* Reset help_echo_string. It will get recomputed below. */
29606 help_echo_string
= Qnil
;
29608 /* Convert to window-relative pixel coordinates. */
29609 w
= XWINDOW (window
);
29610 frame_to_window_pixel_xy (w
, &x
, &y
);
29612 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29613 /* Handle tool-bar window differently since it doesn't display a
29615 if (EQ (window
, f
->tool_bar_window
))
29617 note_tool_bar_highlight (f
, x
, y
);
29622 /* Mouse is on the mode, header line or margin? */
29623 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29624 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29626 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29628 #ifdef HAVE_WINDOW_SYSTEM
29629 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29631 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29632 /* Show non-text cursor (Bug#16647). */
29640 #ifdef HAVE_WINDOW_SYSTEM
29641 if (part
== ON_VERTICAL_BORDER
)
29643 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29644 help_echo_string
= build_string ("drag-mouse-1: resize");
29646 else if (part
== ON_RIGHT_DIVIDER
)
29648 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29649 help_echo_string
= build_string ("drag-mouse-1: resize");
29651 else if (part
== ON_BOTTOM_DIVIDER
)
29652 if (! WINDOW_BOTTOMMOST_P (w
)
29654 || NILP (Vresize_mini_windows
))
29656 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29657 help_echo_string
= build_string ("drag-mouse-1: resize");
29660 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29661 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29662 || part
== ON_VERTICAL_SCROLL_BAR
29663 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29664 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29666 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29669 /* Are we in a window whose display is up to date?
29670 And verify the buffer's text has not changed. */
29671 b
= XBUFFER (w
->contents
);
29672 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29674 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29676 struct glyph
*glyph
;
29677 Lisp_Object object
;
29678 Lisp_Object mouse_face
= Qnil
, position
;
29679 Lisp_Object
*overlay_vec
= NULL
;
29680 ptrdiff_t i
, noverlays
;
29681 struct buffer
*obuf
;
29682 ptrdiff_t obegv
, ozv
;
29685 /* Find the glyph under X/Y. */
29686 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29688 #ifdef HAVE_WINDOW_SYSTEM
29689 /* Look for :pointer property on image. */
29690 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29692 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29693 if (img
!= NULL
&& IMAGEP (img
->spec
))
29695 Lisp_Object image_map
, hotspot
;
29696 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29698 && (hotspot
= find_hot_spot (image_map
,
29699 glyph
->slice
.img
.x
+ dx
,
29700 glyph
->slice
.img
.y
+ dy
),
29702 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29706 /* Could check XCAR (hotspot) to see if we enter/leave
29708 If so, we could look for mouse-enter, mouse-leave
29709 properties in PLIST (and do something...). */
29710 hotspot
= XCDR (hotspot
);
29711 if (CONSP (hotspot
)
29712 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29714 pointer
= Fplist_get (plist
, Qpointer
);
29715 if (NILP (pointer
))
29717 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29718 if (!NILP (help_echo_string
))
29720 help_echo_window
= window
;
29721 help_echo_object
= glyph
->object
;
29722 help_echo_pos
= glyph
->charpos
;
29726 if (NILP (pointer
))
29727 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29730 #endif /* HAVE_WINDOW_SYSTEM */
29732 /* Clear mouse face if X/Y not over text. */
29734 || area
!= TEXT_AREA
29735 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29736 /* Glyph's OBJECT is nil for glyphs inserted by the
29737 display engine for its internal purposes, like truncation
29738 and continuation glyphs and blanks beyond the end of
29739 line's text on text terminals. If we are over such a
29740 glyph, we are not over any text. */
29741 || NILP (glyph
->object
)
29742 /* R2L rows have a stretch glyph at their front, which
29743 stands for no text, whereas L2R rows have no glyphs at
29744 all beyond the end of text. Treat such stretch glyphs
29745 like we do with NULL glyphs in L2R rows. */
29746 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29747 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29748 && glyph
->type
== STRETCH_GLYPH
29749 && glyph
->avoid_cursor_p
))
29751 if (clear_mouse_face (hlinfo
))
29752 cursor
= No_Cursor
;
29753 #ifdef HAVE_WINDOW_SYSTEM
29754 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29756 if (area
!= TEXT_AREA
)
29757 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29759 pointer
= Vvoid_text_area_pointer
;
29765 pos
= glyph
->charpos
;
29766 object
= glyph
->object
;
29767 if (!STRINGP (object
) && !BUFFERP (object
))
29770 /* If we get an out-of-range value, return now; avoid an error. */
29771 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29774 /* Make the window's buffer temporarily current for
29775 overlays_at and compute_char_face. */
29776 obuf
= current_buffer
;
29777 current_buffer
= b
;
29783 /* Is this char mouse-active or does it have help-echo? */
29784 position
= make_number (pos
);
29788 if (BUFFERP (object
))
29790 /* Put all the overlays we want in a vector in overlay_vec. */
29791 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29792 /* Sort overlays into increasing priority order. */
29793 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29798 if (NILP (Vmouse_highlight
))
29800 clear_mouse_face (hlinfo
);
29801 goto check_help_echo
;
29804 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29807 cursor
= No_Cursor
;
29809 /* Check mouse-face highlighting. */
29811 /* If there exists an overlay with mouse-face overlapping
29812 the one we are currently highlighting, we have to
29813 check if we enter the overlapping overlay, and then
29814 highlight only that. */
29815 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29816 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29818 /* Find the highest priority overlay with a mouse-face. */
29819 Lisp_Object overlay
= Qnil
;
29820 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29822 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29823 if (!NILP (mouse_face
))
29824 overlay
= overlay_vec
[i
];
29827 /* If we're highlighting the same overlay as before, there's
29828 no need to do that again. */
29829 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29830 goto check_help_echo
;
29831 hlinfo
->mouse_face_overlay
= overlay
;
29833 /* Clear the display of the old active region, if any. */
29834 if (clear_mouse_face (hlinfo
))
29835 cursor
= No_Cursor
;
29837 /* If no overlay applies, get a text property. */
29838 if (NILP (overlay
))
29839 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29841 /* Next, compute the bounds of the mouse highlighting and
29843 if (!NILP (mouse_face
) && STRINGP (object
))
29845 /* The mouse-highlighting comes from a display string
29846 with a mouse-face. */
29850 s
= Fprevious_single_property_change
29851 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29852 e
= Fnext_single_property_change
29853 (position
, Qmouse_face
, object
, Qnil
);
29855 s
= make_number (0);
29857 e
= make_number (SCHARS (object
));
29858 mouse_face_from_string_pos (w
, hlinfo
, object
,
29859 XINT (s
), XINT (e
));
29860 hlinfo
->mouse_face_past_end
= 0;
29861 hlinfo
->mouse_face_window
= window
;
29862 hlinfo
->mouse_face_face_id
29863 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29864 glyph
->face_id
, 1);
29865 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29866 cursor
= No_Cursor
;
29870 /* The mouse-highlighting, if any, comes from an overlay
29871 or text property in the buffer. */
29872 Lisp_Object buffer
IF_LINT (= Qnil
);
29873 Lisp_Object disp_string
IF_LINT (= Qnil
);
29875 if (STRINGP (object
))
29877 /* If we are on a display string with no mouse-face,
29878 check if the text under it has one. */
29879 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29880 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29881 pos
= string_buffer_position (object
, start
);
29884 mouse_face
= get_char_property_and_overlay
29885 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29886 buffer
= w
->contents
;
29887 disp_string
= object
;
29893 disp_string
= Qnil
;
29896 if (!NILP (mouse_face
))
29898 Lisp_Object before
, after
;
29899 Lisp_Object before_string
, after_string
;
29900 /* To correctly find the limits of mouse highlight
29901 in a bidi-reordered buffer, we must not use the
29902 optimization of limiting the search in
29903 previous-single-property-change and
29904 next-single-property-change, because
29905 rows_from_pos_range needs the real start and end
29906 positions to DTRT in this case. That's because
29907 the first row visible in a window does not
29908 necessarily display the character whose position
29909 is the smallest. */
29911 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29912 ? Fmarker_position (w
->start
)
29915 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29916 ? make_number (BUF_Z (XBUFFER (buffer
))
29917 - w
->window_end_pos
)
29920 if (NILP (overlay
))
29922 /* Handle the text property case. */
29923 before
= Fprevious_single_property_change
29924 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29925 after
= Fnext_single_property_change
29926 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29927 before_string
= after_string
= Qnil
;
29931 /* Handle the overlay case. */
29932 before
= Foverlay_start (overlay
);
29933 after
= Foverlay_end (overlay
);
29934 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29935 after_string
= Foverlay_get (overlay
, Qafter_string
);
29937 if (!STRINGP (before_string
)) before_string
= Qnil
;
29938 if (!STRINGP (after_string
)) after_string
= Qnil
;
29941 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29944 : XFASTINT (before
),
29946 ? BUF_Z (XBUFFER (buffer
))
29947 : XFASTINT (after
),
29948 before_string
, after_string
,
29950 cursor
= No_Cursor
;
29957 /* Look for a `help-echo' property. */
29958 if (NILP (help_echo_string
)) {
29959 Lisp_Object help
, overlay
;
29961 /* Check overlays first. */
29962 help
= overlay
= Qnil
;
29963 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29965 overlay
= overlay_vec
[i
];
29966 help
= Foverlay_get (overlay
, Qhelp_echo
);
29971 help_echo_string
= help
;
29972 help_echo_window
= window
;
29973 help_echo_object
= overlay
;
29974 help_echo_pos
= pos
;
29978 Lisp_Object obj
= glyph
->object
;
29979 ptrdiff_t charpos
= glyph
->charpos
;
29981 /* Try text properties. */
29984 && charpos
< SCHARS (obj
))
29986 help
= Fget_text_property (make_number (charpos
),
29990 /* If the string itself doesn't specify a help-echo,
29991 see if the buffer text ``under'' it does. */
29992 struct glyph_row
*r
29993 = MATRIX_ROW (w
->current_matrix
, vpos
);
29994 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29995 ptrdiff_t p
= string_buffer_position (obj
, start
);
29998 help
= Fget_char_property (make_number (p
),
29999 Qhelp_echo
, w
->contents
);
30008 else if (BUFFERP (obj
)
30011 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30016 help_echo_string
= help
;
30017 help_echo_window
= window
;
30018 help_echo_object
= obj
;
30019 help_echo_pos
= charpos
;
30024 #ifdef HAVE_WINDOW_SYSTEM
30025 /* Look for a `pointer' property. */
30026 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30028 /* Check overlays first. */
30029 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30030 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30032 if (NILP (pointer
))
30034 Lisp_Object obj
= glyph
->object
;
30035 ptrdiff_t charpos
= glyph
->charpos
;
30037 /* Try text properties. */
30040 && charpos
< SCHARS (obj
))
30042 pointer
= Fget_text_property (make_number (charpos
),
30044 if (NILP (pointer
))
30046 /* If the string itself doesn't specify a pointer,
30047 see if the buffer text ``under'' it does. */
30048 struct glyph_row
*r
30049 = MATRIX_ROW (w
->current_matrix
, vpos
);
30050 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30051 ptrdiff_t p
= string_buffer_position (obj
, start
);
30053 pointer
= Fget_char_property (make_number (p
),
30054 Qpointer
, w
->contents
);
30057 else if (BUFFERP (obj
)
30060 pointer
= Fget_text_property (make_number (charpos
),
30064 #endif /* HAVE_WINDOW_SYSTEM */
30068 current_buffer
= obuf
;
30074 #ifdef HAVE_WINDOW_SYSTEM
30075 if (FRAME_WINDOW_P (f
))
30076 define_frame_cursor1 (f
, cursor
, pointer
);
30078 /* This is here to prevent a compiler error, about "label at end of
30079 compound statement". */
30086 Clear any mouse-face on window W. This function is part of the
30087 redisplay interface, and is called from try_window_id and similar
30088 functions to ensure the mouse-highlight is off. */
30091 x_clear_window_mouse_face (struct window
*w
)
30093 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30094 Lisp_Object window
;
30097 XSETWINDOW (window
, w
);
30098 if (EQ (window
, hlinfo
->mouse_face_window
))
30099 clear_mouse_face (hlinfo
);
30105 Just discard the mouse face information for frame F, if any.
30106 This is used when the size of F is changed. */
30109 cancel_mouse_face (struct frame
*f
)
30111 Lisp_Object window
;
30112 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30114 window
= hlinfo
->mouse_face_window
;
30115 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30116 reset_mouse_highlight (hlinfo
);
30121 /***********************************************************************
30123 ***********************************************************************/
30125 #ifdef HAVE_WINDOW_SYSTEM
30127 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30128 which intersects rectangle R. R is in window-relative coordinates. */
30131 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30132 enum glyph_row_area area
)
30134 struct glyph
*first
= row
->glyphs
[area
];
30135 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30136 struct glyph
*last
;
30137 int first_x
, start_x
, x
;
30139 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30140 /* If row extends face to end of line write the whole line. */
30141 draw_glyphs (w
, 0, row
, area
,
30142 0, row
->used
[area
],
30143 DRAW_NORMAL_TEXT
, 0);
30146 /* Set START_X to the window-relative start position for drawing glyphs of
30147 AREA. The first glyph of the text area can be partially visible.
30148 The first glyphs of other areas cannot. */
30149 start_x
= window_box_left_offset (w
, area
);
30151 if (area
== TEXT_AREA
)
30154 /* Find the first glyph that must be redrawn. */
30156 && x
+ first
->pixel_width
< r
->x
)
30158 x
+= first
->pixel_width
;
30162 /* Find the last one. */
30166 && x
< r
->x
+ r
->width
)
30168 x
+= last
->pixel_width
;
30174 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30175 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30176 DRAW_NORMAL_TEXT
, 0);
30181 /* Redraw the parts of the glyph row ROW on window W intersecting
30182 rectangle R. R is in window-relative coordinates. Value is
30183 non-zero if mouse-face was overwritten. */
30186 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30188 eassert (row
->enabled_p
);
30190 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30191 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30192 0, row
->used
[TEXT_AREA
],
30193 DRAW_NORMAL_TEXT
, 0);
30196 if (row
->used
[LEFT_MARGIN_AREA
])
30197 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30198 if (row
->used
[TEXT_AREA
])
30199 expose_area (w
, row
, r
, TEXT_AREA
);
30200 if (row
->used
[RIGHT_MARGIN_AREA
])
30201 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30202 draw_row_fringe_bitmaps (w
, row
);
30205 return row
->mouse_face_p
;
30209 /* Redraw those parts of glyphs rows during expose event handling that
30210 overlap other rows. Redrawing of an exposed line writes over parts
30211 of lines overlapping that exposed line; this function fixes that.
30213 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30214 row in W's current matrix that is exposed and overlaps other rows.
30215 LAST_OVERLAPPING_ROW is the last such row. */
30218 expose_overlaps (struct window
*w
,
30219 struct glyph_row
*first_overlapping_row
,
30220 struct glyph_row
*last_overlapping_row
,
30223 struct glyph_row
*row
;
30225 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30226 if (row
->overlapping_p
)
30228 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30231 if (row
->used
[LEFT_MARGIN_AREA
])
30232 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30234 if (row
->used
[TEXT_AREA
])
30235 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30237 if (row
->used
[RIGHT_MARGIN_AREA
])
30238 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30244 /* Return non-zero if W's cursor intersects rectangle R. */
30247 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30249 XRectangle cr
, result
;
30250 struct glyph
*cursor_glyph
;
30251 struct glyph_row
*row
;
30253 if (w
->phys_cursor
.vpos
>= 0
30254 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30255 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30257 && row
->cursor_in_fringe_p
)
30259 /* Cursor is in the fringe. */
30260 cr
.x
= window_box_right_offset (w
,
30261 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30262 ? RIGHT_MARGIN_AREA
30265 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30266 cr
.height
= row
->height
;
30267 return x_intersect_rectangles (&cr
, r
, &result
);
30270 cursor_glyph
= get_phys_cursor_glyph (w
);
30273 /* r is relative to W's box, but w->phys_cursor.x is relative
30274 to left edge of W's TEXT area. Adjust it. */
30275 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30276 cr
.y
= w
->phys_cursor
.y
;
30277 cr
.width
= cursor_glyph
->pixel_width
;
30278 cr
.height
= w
->phys_cursor_height
;
30279 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30280 I assume the effect is the same -- and this is portable. */
30281 return x_intersect_rectangles (&cr
, r
, &result
);
30283 /* If we don't understand the format, pretend we're not in the hot-spot. */
30289 Draw a vertical window border to the right of window W if W doesn't
30290 have vertical scroll bars. */
30293 x_draw_vertical_border (struct window
*w
)
30295 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30297 /* We could do better, if we knew what type of scroll-bar the adjacent
30298 windows (on either side) have... But we don't :-(
30299 However, I think this works ok. ++KFS 2003-04-25 */
30301 /* Redraw borders between horizontally adjacent windows. Don't
30302 do it for frames with vertical scroll bars because either the
30303 right scroll bar of a window, or the left scroll bar of its
30304 neighbor will suffice as a border. */
30305 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30308 /* Note: It is necessary to redraw both the left and the right
30309 borders, for when only this single window W is being
30311 if (!WINDOW_RIGHTMOST_P (w
)
30312 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30314 int x0
, x1
, y0
, y1
;
30316 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30319 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30322 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30325 if (!WINDOW_LEFTMOST_P (w
)
30326 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30328 int x0
, x1
, y0
, y1
;
30330 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30333 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30336 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30341 /* Draw window dividers for window W. */
30344 x_draw_right_divider (struct window
*w
)
30346 struct frame
*f
= WINDOW_XFRAME (w
);
30348 if (w
->mini
|| w
->pseudo_window_p
)
30350 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30352 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30353 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30354 int y0
= WINDOW_TOP_EDGE_Y (w
);
30355 /* The bottom divider prevails. */
30356 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30358 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30363 x_draw_bottom_divider (struct window
*w
)
30365 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30367 if (w
->mini
|| w
->pseudo_window_p
)
30369 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30371 int x0
= WINDOW_LEFT_EDGE_X (w
);
30372 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30373 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30374 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30376 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30380 /* Redraw the part of window W intersection rectangle FR. Pixel
30381 coordinates in FR are frame-relative. Call this function with
30382 input blocked. Value is non-zero if the exposure overwrites
30386 expose_window (struct window
*w
, XRectangle
*fr
)
30388 struct frame
*f
= XFRAME (w
->frame
);
30390 int mouse_face_overwritten_p
= 0;
30392 /* If window is not yet fully initialized, do nothing. This can
30393 happen when toolkit scroll bars are used and a window is split.
30394 Reconfiguring the scroll bar will generate an expose for a newly
30396 if (w
->current_matrix
== NULL
)
30399 /* When we're currently updating the window, display and current
30400 matrix usually don't agree. Arrange for a thorough display
30402 if (w
->must_be_updated_p
)
30404 SET_FRAME_GARBAGED (f
);
30408 /* Frame-relative pixel rectangle of W. */
30409 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30410 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30411 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30412 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30414 if (x_intersect_rectangles (fr
, &wr
, &r
))
30416 int yb
= window_text_bottom_y (w
);
30417 struct glyph_row
*row
;
30418 int cursor_cleared_p
, phys_cursor_on_p
;
30419 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30421 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30422 r
.x
, r
.y
, r
.width
, r
.height
));
30424 /* Convert to window coordinates. */
30425 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30426 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30428 /* Turn off the cursor. */
30429 if (!w
->pseudo_window_p
30430 && phys_cursor_in_rect_p (w
, &r
))
30432 x_clear_cursor (w
);
30433 cursor_cleared_p
= 1;
30436 cursor_cleared_p
= 0;
30438 /* If the row containing the cursor extends face to end of line,
30439 then expose_area might overwrite the cursor outside the
30440 rectangle and thus notice_overwritten_cursor might clear
30441 w->phys_cursor_on_p. We remember the original value and
30442 check later if it is changed. */
30443 phys_cursor_on_p
= w
->phys_cursor_on_p
;
30445 /* Update lines intersecting rectangle R. */
30446 first_overlapping_row
= last_overlapping_row
= NULL
;
30447 for (row
= w
->current_matrix
->rows
;
30452 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30454 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
30455 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
30456 || (r
.y
>= y0
&& r
.y
< y1
)
30457 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
30459 /* A header line may be overlapping, but there is no need
30460 to fix overlapping areas for them. KFS 2005-02-12 */
30461 if (row
->overlapping_p
&& !row
->mode_line_p
)
30463 if (first_overlapping_row
== NULL
)
30464 first_overlapping_row
= row
;
30465 last_overlapping_row
= row
;
30469 if (expose_line (w
, row
, &r
))
30470 mouse_face_overwritten_p
= 1;
30473 else if (row
->overlapping_p
)
30475 /* We must redraw a row overlapping the exposed area. */
30477 ? y0
+ row
->phys_height
> r
.y
30478 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30480 if (first_overlapping_row
== NULL
)
30481 first_overlapping_row
= row
;
30482 last_overlapping_row
= row
;
30490 /* Display the mode line if there is one. */
30491 if (WINDOW_WANTS_MODELINE_P (w
)
30492 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30494 && row
->y
< r
.y
+ r
.height
)
30496 if (expose_line (w
, row
, &r
))
30497 mouse_face_overwritten_p
= 1;
30500 if (!w
->pseudo_window_p
)
30502 /* Fix the display of overlapping rows. */
30503 if (first_overlapping_row
)
30504 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30507 /* Draw border between windows. */
30508 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30509 x_draw_right_divider (w
);
30511 x_draw_vertical_border (w
);
30513 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30514 x_draw_bottom_divider (w
);
30516 /* Turn the cursor on again. */
30517 if (cursor_cleared_p
30518 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30519 update_window_cursor (w
, 1);
30523 return mouse_face_overwritten_p
;
30528 /* Redraw (parts) of all windows in the window tree rooted at W that
30529 intersect R. R contains frame pixel coordinates. Value is
30530 non-zero if the exposure overwrites mouse-face. */
30533 expose_window_tree (struct window
*w
, XRectangle
*r
)
30535 struct frame
*f
= XFRAME (w
->frame
);
30536 int mouse_face_overwritten_p
= 0;
30538 while (w
&& !FRAME_GARBAGED_P (f
))
30540 if (WINDOWP (w
->contents
))
30541 mouse_face_overwritten_p
30542 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30544 mouse_face_overwritten_p
|= expose_window (w
, r
);
30546 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30549 return mouse_face_overwritten_p
;
30554 Redisplay an exposed area of frame F. X and Y are the upper-left
30555 corner of the exposed rectangle. W and H are width and height of
30556 the exposed area. All are pixel values. W or H zero means redraw
30557 the entire frame. */
30560 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30563 int mouse_face_overwritten_p
= 0;
30565 TRACE ((stderr
, "expose_frame "));
30567 /* No need to redraw if frame will be redrawn soon. */
30568 if (FRAME_GARBAGED_P (f
))
30570 TRACE ((stderr
, " garbaged\n"));
30574 /* If basic faces haven't been realized yet, there is no point in
30575 trying to redraw anything. This can happen when we get an expose
30576 event while Emacs is starting, e.g. by moving another window. */
30577 if (FRAME_FACE_CACHE (f
) == NULL
30578 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30580 TRACE ((stderr
, " no faces\n"));
30584 if (w
== 0 || h
== 0)
30587 r
.width
= FRAME_TEXT_WIDTH (f
);
30588 r
.height
= FRAME_TEXT_HEIGHT (f
);
30598 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30599 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30601 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30602 if (WINDOWP (f
->tool_bar_window
))
30603 mouse_face_overwritten_p
30604 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30607 #ifdef HAVE_X_WINDOWS
30609 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30610 if (WINDOWP (f
->menu_bar_window
))
30611 mouse_face_overwritten_p
30612 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30613 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30617 /* Some window managers support a focus-follows-mouse style with
30618 delayed raising of frames. Imagine a partially obscured frame,
30619 and moving the mouse into partially obscured mouse-face on that
30620 frame. The visible part of the mouse-face will be highlighted,
30621 then the WM raises the obscured frame. With at least one WM, KDE
30622 2.1, Emacs is not getting any event for the raising of the frame
30623 (even tried with SubstructureRedirectMask), only Expose events.
30624 These expose events will draw text normally, i.e. not
30625 highlighted. Which means we must redo the highlight here.
30626 Subsume it under ``we love X''. --gerd 2001-08-15 */
30627 /* Included in Windows version because Windows most likely does not
30628 do the right thing if any third party tool offers
30629 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30630 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30632 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30633 if (f
== hlinfo
->mouse_face_mouse_frame
)
30635 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30636 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30637 clear_mouse_face (hlinfo
);
30638 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30645 Determine the intersection of two rectangles R1 and R2. Return
30646 the intersection in *RESULT. Value is non-zero if RESULT is not
30650 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30652 XRectangle
*left
, *right
;
30653 XRectangle
*upper
, *lower
;
30654 int intersection_p
= 0;
30656 /* Rearrange so that R1 is the left-most rectangle. */
30658 left
= r1
, right
= r2
;
30660 left
= r2
, right
= r1
;
30662 /* X0 of the intersection is right.x0, if this is inside R1,
30663 otherwise there is no intersection. */
30664 if (right
->x
<= left
->x
+ left
->width
)
30666 result
->x
= right
->x
;
30668 /* The right end of the intersection is the minimum of
30669 the right ends of left and right. */
30670 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30673 /* Same game for Y. */
30675 upper
= r1
, lower
= r2
;
30677 upper
= r2
, lower
= r1
;
30679 /* The upper end of the intersection is lower.y0, if this is inside
30680 of upper. Otherwise, there is no intersection. */
30681 if (lower
->y
<= upper
->y
+ upper
->height
)
30683 result
->y
= lower
->y
;
30685 /* The lower end of the intersection is the minimum of the lower
30686 ends of upper and lower. */
30687 result
->height
= (min (lower
->y
+ lower
->height
,
30688 upper
->y
+ upper
->height
)
30690 intersection_p
= 1;
30694 return intersection_p
;
30697 #endif /* HAVE_WINDOW_SYSTEM */
30700 /***********************************************************************
30702 ***********************************************************************/
30705 syms_of_xdisp (void)
30707 Vwith_echo_area_save_vector
= Qnil
;
30708 staticpro (&Vwith_echo_area_save_vector
);
30710 Vmessage_stack
= Qnil
;
30711 staticpro (&Vmessage_stack
);
30713 /* Non-nil means don't actually do any redisplay. */
30714 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30716 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30718 message_dolog_marker1
= Fmake_marker ();
30719 staticpro (&message_dolog_marker1
);
30720 message_dolog_marker2
= Fmake_marker ();
30721 staticpro (&message_dolog_marker2
);
30722 message_dolog_marker3
= Fmake_marker ();
30723 staticpro (&message_dolog_marker3
);
30726 defsubr (&Sdump_frame_glyph_matrix
);
30727 defsubr (&Sdump_glyph_matrix
);
30728 defsubr (&Sdump_glyph_row
);
30729 defsubr (&Sdump_tool_bar_row
);
30730 defsubr (&Strace_redisplay
);
30731 defsubr (&Strace_to_stderr
);
30733 #ifdef HAVE_WINDOW_SYSTEM
30734 defsubr (&Stool_bar_height
);
30735 defsubr (&Slookup_image_map
);
30737 defsubr (&Sline_pixel_height
);
30738 defsubr (&Sformat_mode_line
);
30739 defsubr (&Sinvisible_p
);
30740 defsubr (&Scurrent_bidi_paragraph_direction
);
30741 defsubr (&Swindow_text_pixel_size
);
30742 defsubr (&Smove_point_visually
);
30743 defsubr (&Sbidi_find_overridden_directionality
);
30745 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30746 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30747 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30748 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30749 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30750 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30751 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30752 DEFSYM (Qeval
, "eval");
30753 DEFSYM (QCdata
, ":data");
30755 /* Names of text properties relevant for redisplay. */
30756 DEFSYM (Qdisplay
, "display");
30757 DEFSYM (Qspace_width
, "space-width");
30758 DEFSYM (Qraise
, "raise");
30759 DEFSYM (Qslice
, "slice");
30760 DEFSYM (Qspace
, "space");
30761 DEFSYM (Qmargin
, "margin");
30762 DEFSYM (Qpointer
, "pointer");
30763 DEFSYM (Qleft_margin
, "left-margin");
30764 DEFSYM (Qright_margin
, "right-margin");
30765 DEFSYM (Qcenter
, "center");
30766 DEFSYM (Qline_height
, "line-height");
30767 DEFSYM (QCalign_to
, ":align-to");
30768 DEFSYM (QCrelative_width
, ":relative-width");
30769 DEFSYM (QCrelative_height
, ":relative-height");
30770 DEFSYM (QCeval
, ":eval");
30771 DEFSYM (QCpropertize
, ":propertize");
30772 DEFSYM (QCfile
, ":file");
30773 DEFSYM (Qfontified
, "fontified");
30774 DEFSYM (Qfontification_functions
, "fontification-functions");
30776 /* Name of the face used to highlight trailing whitespace. */
30777 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30779 /* Name and number of the face used to highlight escape glyphs. */
30780 DEFSYM (Qescape_glyph
, "escape-glyph");
30782 /* Name and number of the face used to highlight non-breaking spaces. */
30783 DEFSYM (Qnobreak_space
, "nobreak-space");
30785 /* The symbol 'image' which is the car of the lists used to represent
30786 images in Lisp. Also a tool bar style. */
30787 DEFSYM (Qimage
, "image");
30789 /* Tool bar styles. */
30790 DEFSYM (Qtext
, "text");
30791 DEFSYM (Qboth
, "both");
30792 DEFSYM (Qboth_horiz
, "both-horiz");
30793 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30795 /* The image map types. */
30796 DEFSYM (QCmap
, ":map");
30797 DEFSYM (QCpointer
, ":pointer");
30798 DEFSYM (Qrect
, "rect");
30799 DEFSYM (Qcircle
, "circle");
30800 DEFSYM (Qpoly
, "poly");
30802 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
30803 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30804 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30806 DEFSYM (Qgrow_only
, "grow-only");
30807 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30808 DEFSYM (Qposition
, "position");
30809 DEFSYM (Qbuffer_position
, "buffer-position");
30810 DEFSYM (Qobject
, "object");
30812 /* Cursor shapes. */
30813 DEFSYM (Qbar
, "bar");
30814 DEFSYM (Qhbar
, "hbar");
30815 DEFSYM (Qbox
, "box");
30816 DEFSYM (Qhollow
, "hollow");
30818 /* Pointer shapes. */
30819 DEFSYM (Qhand
, "hand");
30820 DEFSYM (Qarrow
, "arrow");
30823 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30825 list_of_error
= list1 (list2 (intern_c_string ("error"),
30826 intern_c_string ("void-variable")));
30827 staticpro (&list_of_error
);
30829 /* Values of those variables at last redisplay are stored as
30830 properties on 'overlay-arrow-position' symbol. However, if
30831 Voverlay_arrow_position is a marker, last-arrow-position is its
30832 numerical position. */
30833 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30834 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30836 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30837 properties on a symbol in overlay-arrow-variable-list. */
30838 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30839 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30841 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30842 staticpro (&echo_buffer
[0]);
30843 staticpro (&echo_buffer
[1]);
30845 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30846 staticpro (&echo_area_buffer
[0]);
30847 staticpro (&echo_area_buffer
[1]);
30849 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30850 staticpro (&Vmessages_buffer_name
);
30852 mode_line_proptrans_alist
= Qnil
;
30853 staticpro (&mode_line_proptrans_alist
);
30854 mode_line_string_list
= Qnil
;
30855 staticpro (&mode_line_string_list
);
30856 mode_line_string_face
= Qnil
;
30857 staticpro (&mode_line_string_face
);
30858 mode_line_string_face_prop
= Qnil
;
30859 staticpro (&mode_line_string_face_prop
);
30860 Vmode_line_unwind_vector
= Qnil
;
30861 staticpro (&Vmode_line_unwind_vector
);
30863 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30865 help_echo_string
= Qnil
;
30866 staticpro (&help_echo_string
);
30867 help_echo_object
= Qnil
;
30868 staticpro (&help_echo_object
);
30869 help_echo_window
= Qnil
;
30870 staticpro (&help_echo_window
);
30871 previous_help_echo_string
= Qnil
;
30872 staticpro (&previous_help_echo_string
);
30873 help_echo_pos
= -1;
30875 DEFSYM (Qright_to_left
, "right-to-left");
30876 DEFSYM (Qleft_to_right
, "left-to-right");
30877 defsubr (&Sbidi_resolved_levels
);
30879 #ifdef HAVE_WINDOW_SYSTEM
30880 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30881 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30882 For example, if a block cursor is over a tab, it will be drawn as
30883 wide as that tab on the display. */);
30884 x_stretch_cursor_p
= 0;
30887 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30888 doc
: /* Non-nil means highlight trailing whitespace.
30889 The face used for trailing whitespace is `trailing-whitespace'. */);
30890 Vshow_trailing_whitespace
= Qnil
;
30892 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30893 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30894 If the value is t, Emacs highlights non-ASCII chars which have the
30895 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30896 or `escape-glyph' face respectively.
30898 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30899 U+2011 (non-breaking hyphen) are affected.
30901 Any other non-nil value means to display these characters as a escape
30902 glyph followed by an ordinary space or hyphen.
30904 A value of nil means no special handling of these characters. */);
30905 Vnobreak_char_display
= Qt
;
30907 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30908 doc
: /* The pointer shape to show in void text areas.
30909 A value of nil means to show the text pointer. Other options are
30910 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30912 Vvoid_text_area_pointer
= Qarrow
;
30914 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30915 doc
: /* Non-nil means don't actually do any redisplay.
30916 This is used for internal purposes. */);
30917 Vinhibit_redisplay
= Qnil
;
30919 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30920 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30921 Vglobal_mode_string
= Qnil
;
30923 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30924 doc
: /* Marker for where to display an arrow on top of the buffer text.
30925 This must be the beginning of a line in order to work.
30926 See also `overlay-arrow-string'. */);
30927 Voverlay_arrow_position
= Qnil
;
30929 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30930 doc
: /* String to display as an arrow in non-window frames.
30931 See also `overlay-arrow-position'. */);
30932 Voverlay_arrow_string
= build_pure_c_string ("=>");
30934 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30935 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30936 The symbols on this list are examined during redisplay to determine
30937 where to display overlay arrows. */);
30938 Voverlay_arrow_variable_list
30939 = list1 (intern_c_string ("overlay-arrow-position"));
30941 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30942 doc
: /* The number of lines to try scrolling a window by when point moves out.
30943 If that fails to bring point back on frame, point is centered instead.
30944 If this is zero, point is always centered after it moves off frame.
30945 If you want scrolling to always be a line at a time, you should set
30946 `scroll-conservatively' to a large value rather than set this to 1. */);
30948 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30949 doc
: /* Scroll up to this many lines, to bring point back on screen.
30950 If point moves off-screen, redisplay will scroll by up to
30951 `scroll-conservatively' lines in order to bring point just barely
30952 onto the screen again. If that cannot be done, then redisplay
30953 recenters point as usual.
30955 If the value is greater than 100, redisplay will never recenter point,
30956 but will always scroll just enough text to bring point into view, even
30957 if you move far away.
30959 A value of zero means always recenter point if it moves off screen. */);
30960 scroll_conservatively
= 0;
30962 DEFVAR_INT ("scroll-margin", scroll_margin
,
30963 doc
: /* Number of lines of margin at the top and bottom of a window.
30964 Recenter the window whenever point gets within this many lines
30965 of the top or bottom of the window. */);
30968 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30969 doc
: /* Pixels per inch value for non-window system displays.
30970 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30971 Vdisplay_pixels_per_inch
= make_float (72.0);
30974 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30977 DEFVAR_LISP ("truncate-partial-width-windows",
30978 Vtruncate_partial_width_windows
,
30979 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30980 For an integer value, truncate lines in each window narrower than the
30981 full frame width, provided the window width is less than that integer;
30982 otherwise, respect the value of `truncate-lines'.
30984 For any other non-nil value, truncate lines in all windows that do
30985 not span the full frame width.
30987 A value of nil means to respect the value of `truncate-lines'.
30989 If `word-wrap' is enabled, you might want to reduce this. */);
30990 Vtruncate_partial_width_windows
= make_number (50);
30992 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30993 doc
: /* Maximum buffer size for which line number should be displayed.
30994 If the buffer is bigger than this, the line number does not appear
30995 in the mode line. A value of nil means no limit. */);
30996 Vline_number_display_limit
= Qnil
;
30998 DEFVAR_INT ("line-number-display-limit-width",
30999 line_number_display_limit_width
,
31000 doc
: /* Maximum line width (in characters) for line number display.
31001 If the average length of the lines near point is bigger than this, then the
31002 line number may be omitted from the mode line. */);
31003 line_number_display_limit_width
= 200;
31005 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31006 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31007 highlight_nonselected_windows
= 0;
31009 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31010 doc
: /* Non-nil if more than one frame is visible on this display.
31011 Minibuffer-only frames don't count, but iconified frames do.
31012 This variable is not guaranteed to be accurate except while processing
31013 `frame-title-format' and `icon-title-format'. */);
31015 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31016 doc
: /* Template for displaying the title bar of visible frames.
31017 \(Assuming the window manager supports this feature.)
31019 This variable has the same structure as `mode-line-format', except that
31020 the %c and %l constructs are ignored. It is used only on frames for
31021 which no explicit name has been set \(see `modify-frame-parameters'). */);
31023 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31024 doc
: /* Template for displaying the title bar of an iconified frame.
31025 \(Assuming the window manager supports this feature.)
31026 This variable has the same structure as `mode-line-format' (which see),
31027 and is used only on frames for which no explicit name has been set
31028 \(see `modify-frame-parameters'). */);
31030 = Vframe_title_format
31031 = listn (CONSTYPE_PURE
, 3,
31032 intern_c_string ("multiple-frames"),
31033 build_pure_c_string ("%b"),
31034 listn (CONSTYPE_PURE
, 4,
31035 empty_unibyte_string
,
31036 intern_c_string ("invocation-name"),
31037 build_pure_c_string ("@"),
31038 intern_c_string ("system-name")));
31040 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31041 doc
: /* Maximum number of lines to keep in the message log buffer.
31042 If nil, disable message logging. If t, log messages but don't truncate
31043 the buffer when it becomes large. */);
31044 Vmessage_log_max
= make_number (1000);
31046 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31047 doc
: /* Functions called before redisplay, if window sizes have changed.
31048 The value should be a list of functions that take one argument.
31049 Just before redisplay, for each frame, if any of its windows have changed
31050 size since the last redisplay, or have been split or deleted,
31051 all the functions in the list are called, with the frame as argument. */);
31052 Vwindow_size_change_functions
= Qnil
;
31054 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31055 doc
: /* List of functions to call before redisplaying a window with scrolling.
31056 Each function is called with two arguments, the window and its new
31057 display-start position.
31058 These functions are called whenever the `window-start' marker is modified,
31059 either to point into another buffer (e.g. via `set-window-buffer') or another
31060 place in the same buffer.
31061 Note that the value of `window-end' is not valid when these functions are
31064 Warning: Do not use this feature to alter the way the window
31065 is scrolled. It is not designed for that, and such use probably won't
31067 Vwindow_scroll_functions
= Qnil
;
31069 DEFVAR_LISP ("window-text-change-functions",
31070 Vwindow_text_change_functions
,
31071 doc
: /* Functions to call in redisplay when text in the window might change. */);
31072 Vwindow_text_change_functions
= Qnil
;
31074 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31075 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31076 Each function is called with two arguments, the window and the end trigger value.
31077 See `set-window-redisplay-end-trigger'. */);
31078 Vredisplay_end_trigger_functions
= Qnil
;
31080 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31081 doc
: /* Non-nil means autoselect window with mouse pointer.
31082 If nil, do not autoselect windows.
31083 A positive number means delay autoselection by that many seconds: a
31084 window is autoselected only after the mouse has remained in that
31085 window for the duration of the delay.
31086 A negative number has a similar effect, but causes windows to be
31087 autoselected only after the mouse has stopped moving. \(Because of
31088 the way Emacs compares mouse events, you will occasionally wait twice
31089 that time before the window gets selected.\)
31090 Any other value means to autoselect window instantaneously when the
31091 mouse pointer enters it.
31093 Autoselection selects the minibuffer only if it is active, and never
31094 unselects the minibuffer if it is active.
31096 When customizing this variable make sure that the actual value of
31097 `focus-follows-mouse' matches the behavior of your window manager. */);
31098 Vmouse_autoselect_window
= Qnil
;
31100 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31101 doc
: /* Non-nil means automatically resize tool-bars.
31102 This dynamically changes the tool-bar's height to the minimum height
31103 that is needed to make all tool-bar items visible.
31104 If value is `grow-only', the tool-bar's height is only increased
31105 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31106 Vauto_resize_tool_bars
= Qt
;
31108 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31109 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31110 auto_raise_tool_bar_buttons_p
= 1;
31112 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31113 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31114 make_cursor_line_fully_visible_p
= 1;
31116 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31117 doc
: /* Border below tool-bar in pixels.
31118 If an integer, use it as the height of the border.
31119 If it is one of `internal-border-width' or `border-width', use the
31120 value of the corresponding frame parameter.
31121 Otherwise, no border is added below the tool-bar. */);
31122 Vtool_bar_border
= Qinternal_border_width
;
31124 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31125 doc
: /* Margin around tool-bar buttons in pixels.
31126 If an integer, use that for both horizontal and vertical margins.
31127 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31128 HORZ specifying the horizontal margin, and VERT specifying the
31129 vertical margin. */);
31130 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31132 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31133 doc
: /* Relief thickness of tool-bar buttons. */);
31134 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31136 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31137 doc
: /* Tool bar style to use.
31139 image - show images only
31140 text - show text only
31141 both - show both, text below image
31142 both-horiz - show text to the right of the image
31143 text-image-horiz - show text to the left of the image
31144 any other - use system default or image if no system default.
31146 This variable only affects the GTK+ toolkit version of Emacs. */);
31147 Vtool_bar_style
= Qnil
;
31149 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31150 doc
: /* Maximum number of characters a label can have to be shown.
31151 The tool bar style must also show labels for this to have any effect, see
31152 `tool-bar-style'. */);
31153 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31155 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31156 doc
: /* List of functions to call to fontify regions of text.
31157 Each function is called with one argument POS. Functions must
31158 fontify a region starting at POS in the current buffer, and give
31159 fontified regions the property `fontified'. */);
31160 Vfontification_functions
= Qnil
;
31161 Fmake_variable_buffer_local (Qfontification_functions
);
31163 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31164 unibyte_display_via_language_environment
,
31165 doc
: /* Non-nil means display unibyte text according to language environment.
31166 Specifically, this means that raw bytes in the range 160-255 decimal
31167 are displayed by converting them to the equivalent multibyte characters
31168 according to the current language environment. As a result, they are
31169 displayed according to the current fontset.
31171 Note that this variable affects only how these bytes are displayed,
31172 but does not change the fact they are interpreted as raw bytes. */);
31173 unibyte_display_via_language_environment
= 0;
31175 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31176 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31177 If a float, it specifies a fraction of the mini-window frame's height.
31178 If an integer, it specifies a number of lines. */);
31179 Vmax_mini_window_height
= make_float (0.25);
31181 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31182 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31183 A value of nil means don't automatically resize mini-windows.
31184 A value of t means resize them to fit the text displayed in them.
31185 A value of `grow-only', the default, means let mini-windows grow only;
31186 they return to their normal size when the minibuffer is closed, or the
31187 echo area becomes empty. */);
31188 Vresize_mini_windows
= Qgrow_only
;
31190 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31191 doc
: /* Alist specifying how to blink the cursor off.
31192 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31193 `cursor-type' frame-parameter or variable equals ON-STATE,
31194 comparing using `equal', Emacs uses OFF-STATE to specify
31195 how to blink it off. ON-STATE and OFF-STATE are values for
31196 the `cursor-type' frame parameter.
31198 If a frame's ON-STATE has no entry in this list,
31199 the frame's other specifications determine how to blink the cursor off. */);
31200 Vblink_cursor_alist
= Qnil
;
31202 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31203 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31204 If non-nil, windows are automatically scrolled horizontally to make
31205 point visible. */);
31206 automatic_hscrolling_p
= 1;
31207 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31209 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31210 doc
: /* How many columns away from the window edge point is allowed to get
31211 before automatic hscrolling will horizontally scroll the window. */);
31212 hscroll_margin
= 5;
31214 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31215 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31216 When point is less than `hscroll-margin' columns from the window
31217 edge, automatic hscrolling will scroll the window by the amount of columns
31218 determined by this variable. If its value is a positive integer, scroll that
31219 many columns. If it's a positive floating-point number, it specifies the
31220 fraction of the window's width to scroll. If it's nil or zero, point will be
31221 centered horizontally after the scroll. Any other value, including negative
31222 numbers, are treated as if the value were zero.
31224 Automatic hscrolling always moves point outside the scroll margin, so if
31225 point was more than scroll step columns inside the margin, the window will
31226 scroll more than the value given by the scroll step.
31228 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31229 and `scroll-right' overrides this variable's effect. */);
31230 Vhscroll_step
= make_number (0);
31232 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31233 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31234 Bind this around calls to `message' to let it take effect. */);
31235 message_truncate_lines
= 0;
31237 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31238 doc
: /* Normal hook run to update the menu bar definitions.
31239 Redisplay runs this hook before it redisplays the menu bar.
31240 This is used to update menus such as Buffers, whose contents depend on
31242 Vmenu_bar_update_hook
= Qnil
;
31244 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31245 doc
: /* Frame for which we are updating a menu.
31246 The enable predicate for a menu binding should check this variable. */);
31247 Vmenu_updating_frame
= Qnil
;
31249 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31250 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31251 inhibit_menubar_update
= 0;
31253 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31254 doc
: /* Prefix prepended to all continuation lines at display time.
31255 The value may be a string, an image, or a stretch-glyph; it is
31256 interpreted in the same way as the value of a `display' text property.
31258 This variable is overridden by any `wrap-prefix' text or overlay
31261 To add a prefix to non-continuation lines, use `line-prefix'. */);
31262 Vwrap_prefix
= Qnil
;
31263 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31264 Fmake_variable_buffer_local (Qwrap_prefix
);
31266 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31267 doc
: /* Prefix prepended to all non-continuation lines at display time.
31268 The value may be a string, an image, or a stretch-glyph; it is
31269 interpreted in the same way as the value of a `display' text property.
31271 This variable is overridden by any `line-prefix' text or overlay
31274 To add a prefix to continuation lines, use `wrap-prefix'. */);
31275 Vline_prefix
= Qnil
;
31276 DEFSYM (Qline_prefix
, "line-prefix");
31277 Fmake_variable_buffer_local (Qline_prefix
);
31279 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31280 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31281 inhibit_eval_during_redisplay
= 0;
31283 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31284 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31285 inhibit_free_realized_faces
= 0;
31287 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31288 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31289 Intended for use during debugging and for testing bidi display;
31290 see biditest.el in the test suite. */);
31291 inhibit_bidi_mirroring
= 0;
31294 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31295 doc
: /* Inhibit try_window_id display optimization. */);
31296 inhibit_try_window_id
= 0;
31298 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31299 doc
: /* Inhibit try_window_reusing display optimization. */);
31300 inhibit_try_window_reusing
= 0;
31302 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31303 doc
: /* Inhibit try_cursor_movement display optimization. */);
31304 inhibit_try_cursor_movement
= 0;
31305 #endif /* GLYPH_DEBUG */
31307 DEFVAR_INT ("overline-margin", overline_margin
,
31308 doc
: /* Space between overline and text, in pixels.
31309 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31310 margin to the character height. */);
31311 overline_margin
= 2;
31313 DEFVAR_INT ("underline-minimum-offset",
31314 underline_minimum_offset
,
31315 doc
: /* Minimum distance between baseline and underline.
31316 This can improve legibility of underlined text at small font sizes,
31317 particularly when using variable `x-use-underline-position-properties'
31318 with fonts that specify an UNDERLINE_POSITION relatively close to the
31319 baseline. The default value is 1. */);
31320 underline_minimum_offset
= 1;
31322 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31323 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31324 This feature only works when on a window system that can change
31325 cursor shapes. */);
31326 display_hourglass_p
= 1;
31328 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31329 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31330 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31332 #ifdef HAVE_WINDOW_SYSTEM
31333 hourglass_atimer
= NULL
;
31334 hourglass_shown_p
= 0;
31335 #endif /* HAVE_WINDOW_SYSTEM */
31337 /* Name of the face used to display glyphless characters. */
31338 DEFSYM (Qglyphless_char
, "glyphless-char");
31340 /* Method symbols for Vglyphless_char_display. */
31341 DEFSYM (Qhex_code
, "hex-code");
31342 DEFSYM (Qempty_box
, "empty-box");
31343 DEFSYM (Qthin_space
, "thin-space");
31344 DEFSYM (Qzero_width
, "zero-width");
31346 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31347 doc
: /* Function run just before redisplay.
31348 It is called with one argument, which is the set of windows that are to
31349 be redisplayed. This set can be nil (meaning, only the selected window),
31350 or t (meaning all windows). */);
31351 Vpre_redisplay_function
= intern ("ignore");
31353 /* Symbol for the purpose of Vglyphless_char_display. */
31354 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31355 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31357 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31358 doc
: /* Char-table defining glyphless characters.
31359 Each element, if non-nil, should be one of the following:
31360 an ASCII acronym string: display this string in a box
31361 `hex-code': display the hexadecimal code of a character in a box
31362 `empty-box': display as an empty box
31363 `thin-space': display as 1-pixel width space
31364 `zero-width': don't display
31365 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31366 display method for graphical terminals and text terminals respectively.
31367 GRAPHICAL and TEXT should each have one of the values listed above.
31369 The char-table has one extra slot to control the display of a character for
31370 which no font is found. This slot only takes effect on graphical terminals.
31371 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31372 `thin-space'. The default is `empty-box'.
31374 If a character has a non-nil entry in an active display table, the
31375 display table takes effect; in this case, Emacs does not consult
31376 `glyphless-char-display' at all. */);
31377 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31378 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31381 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31382 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31383 Vdebug_on_message
= Qnil
;
31385 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31387 Vredisplay__all_windows_cause
31388 = Fmake_vector (make_number (100), make_number (0));
31390 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31392 Vredisplay__mode_lines_cause
31393 = Fmake_vector (make_number (100), make_number (0));
31397 /* Initialize this module when Emacs starts. */
31402 CHARPOS (this_line_start_pos
) = 0;
31404 if (!noninteractive
)
31406 struct window
*m
= XWINDOW (minibuf_window
);
31407 Lisp_Object frame
= m
->frame
;
31408 struct frame
*f
= XFRAME (frame
);
31409 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31410 struct window
*r
= XWINDOW (root
);
31413 echo_area_window
= minibuf_window
;
31415 r
->top_line
= FRAME_TOP_MARGIN (f
);
31416 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31417 r
->total_cols
= FRAME_COLS (f
);
31418 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31419 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31420 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31422 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31423 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31424 m
->total_cols
= FRAME_COLS (f
);
31425 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31426 m
->total_lines
= 1;
31427 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31429 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31430 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31431 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31433 /* The default ellipsis glyphs `...'. */
31434 for (i
= 0; i
< 3; ++i
)
31435 default_invis_vector
[i
] = make_number ('.');
31439 /* Allocate the buffer for frame titles.
31440 Also used for `format-mode-line'. */
31442 mode_line_noprop_buf
= xmalloc (size
);
31443 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31444 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31445 mode_line_target
= MODE_LINE_DISPLAY
;
31448 help_echo_showing_p
= 0;
31451 #ifdef HAVE_WINDOW_SYSTEM
31453 /* Platform-independent portion of hourglass implementation. */
31455 /* Timer function of hourglass_atimer. */
31458 show_hourglass (struct atimer
*timer
)
31460 /* The timer implementation will cancel this timer automatically
31461 after this function has run. Set hourglass_atimer to null
31462 so that we know the timer doesn't have to be canceled. */
31463 hourglass_atimer
= NULL
;
31465 if (!hourglass_shown_p
)
31467 Lisp_Object tail
, frame
;
31471 FOR_EACH_FRAME (tail
, frame
)
31473 struct frame
*f
= XFRAME (frame
);
31475 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31476 && FRAME_RIF (f
)->show_hourglass
)
31477 FRAME_RIF (f
)->show_hourglass (f
);
31480 hourglass_shown_p
= 1;
31485 /* Cancel a currently active hourglass timer, and start a new one. */
31488 start_hourglass (void)
31490 struct timespec delay
;
31492 cancel_hourglass ();
31494 if (INTEGERP (Vhourglass_delay
)
31495 && XINT (Vhourglass_delay
) > 0)
31496 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31497 TYPE_MAXIMUM (time_t)),
31499 else if (FLOATP (Vhourglass_delay
)
31500 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31501 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31503 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31505 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31506 show_hourglass
, NULL
);
31509 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31513 cancel_hourglass (void)
31515 if (hourglass_atimer
)
31517 cancel_atimer (hourglass_atimer
);
31518 hourglass_atimer
= NULL
;
31521 if (hourglass_shown_p
)
31523 Lisp_Object tail
, frame
;
31527 FOR_EACH_FRAME (tail
, frame
)
31529 struct frame
*f
= XFRAME (frame
);
31531 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31532 && FRAME_RIF (f
)->hide_hourglass
)
31533 FRAME_RIF (f
)->hide_hourglass (f
);
31535 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31536 else if (!FRAME_W32_P (f
))
31537 w32_arrow_cursor ();
31541 hourglass_shown_p
= 0;
31546 #endif /* HAVE_WINDOW_SYSTEM */