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
);
2756 memset (it
, 0, sizeof *it
);
2757 it
->current
.overlay_string_index
= -1;
2758 it
->current
.dpvec_index
= -1;
2759 it
->base_face_id
= remapped_base_face_id
;
2761 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2762 it
->paragraph_embedding
= L2R
;
2763 it
->bidi_it
.string
.lstring
= Qnil
;
2764 it
->bidi_it
.string
.s
= NULL
;
2765 it
->bidi_it
.string
.bufpos
= 0;
2768 /* The window in which we iterate over current_buffer: */
2769 XSETWINDOW (it
->window
, w
);
2771 it
->f
= XFRAME (w
->frame
);
2775 /* Extra space between lines (on window systems only). */
2776 if (base_face_id
== DEFAULT_FACE_ID
2777 && FRAME_WINDOW_P (it
->f
))
2779 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2780 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2781 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2782 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2783 * FRAME_LINE_HEIGHT (it
->f
));
2784 else if (it
->f
->extra_line_spacing
> 0)
2785 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2786 it
->max_extra_line_spacing
= 0;
2789 /* If realized faces have been removed, e.g. because of face
2790 attribute changes of named faces, recompute them. When running
2791 in batch mode, the face cache of the initial frame is null. If
2792 we happen to get called, make a dummy face cache. */
2793 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2794 init_frame_faces (it
->f
);
2795 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2796 recompute_basic_faces (it
->f
);
2798 /* Current value of the `slice', `space-width', and 'height' properties. */
2799 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2800 it
->space_width
= Qnil
;
2801 it
->font_height
= Qnil
;
2802 it
->override_ascent
= -1;
2804 /* Are control characters displayed as `^C'? */
2805 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2807 /* -1 means everything between a CR and the following line end
2808 is invisible. >0 means lines indented more than this value are
2810 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2812 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2814 : (!NILP (BVAR (current_buffer
, selective_display
))
2816 it
->selective_display_ellipsis_p
2817 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2819 /* Display table to use. */
2820 it
->dp
= window_display_table (w
);
2822 /* Are multibyte characters enabled in current_buffer? */
2823 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2825 /* Get the position at which the redisplay_end_trigger hook should
2826 be run, if it is to be run at all. */
2827 if (MARKERP (w
->redisplay_end_trigger
)
2828 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2829 it
->redisplay_end_trigger_charpos
2830 = marker_position (w
->redisplay_end_trigger
);
2831 else if (INTEGERP (w
->redisplay_end_trigger
))
2832 it
->redisplay_end_trigger_charpos
2833 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2836 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2838 /* Are lines in the display truncated? */
2839 if (base_face_id
!= DEFAULT_FACE_ID
2841 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2842 && ((!NILP (Vtruncate_partial_width_windows
)
2843 && !INTEGERP (Vtruncate_partial_width_windows
))
2844 || (INTEGERP (Vtruncate_partial_width_windows
)
2845 /* PXW: Shall we do something about this? */
2846 && (WINDOW_TOTAL_COLS (it
->w
)
2847 < XINT (Vtruncate_partial_width_windows
))))))
2848 it
->line_wrap
= TRUNCATE
;
2849 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2850 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2851 ? WINDOW_WRAP
: WORD_WRAP
;
2853 it
->line_wrap
= TRUNCATE
;
2855 /* Get dimensions of truncation and continuation glyphs. These are
2856 displayed as fringe bitmaps under X, but we need them for such
2857 frames when the fringes are turned off. But leave the dimensions
2858 zero for tooltip frames, as these glyphs look ugly there and also
2859 sabotage calculations of tooltip dimensions in x-show-tip. */
2860 #ifdef HAVE_WINDOW_SYSTEM
2861 if (!(FRAME_WINDOW_P (it
->f
)
2862 && FRAMEP (tip_frame
)
2863 && it
->f
== XFRAME (tip_frame
)))
2866 if (it
->line_wrap
== TRUNCATE
)
2868 /* We will need the truncation glyph. */
2869 eassert (it
->glyph_row
== NULL
);
2870 produce_special_glyphs (it
, IT_TRUNCATION
);
2871 it
->truncation_pixel_width
= it
->pixel_width
;
2875 /* We will need the continuation glyph. */
2876 eassert (it
->glyph_row
== NULL
);
2877 produce_special_glyphs (it
, IT_CONTINUATION
);
2878 it
->continuation_pixel_width
= it
->pixel_width
;
2882 /* Reset these values to zero because the produce_special_glyphs
2883 above has changed them. */
2884 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2885 it
->phys_ascent
= it
->phys_descent
= 0;
2887 /* Set this after getting the dimensions of truncation and
2888 continuation glyphs, so that we don't produce glyphs when calling
2889 produce_special_glyphs, above. */
2890 it
->glyph_row
= row
;
2891 it
->area
= TEXT_AREA
;
2893 /* Get the dimensions of the display area. The display area
2894 consists of the visible window area plus a horizontally scrolled
2895 part to the left of the window. All x-values are relative to the
2896 start of this total display area. */
2897 if (base_face_id
!= DEFAULT_FACE_ID
)
2899 /* Mode lines, menu bar in terminal frames. */
2900 it
->first_visible_x
= 0;
2901 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2906 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2907 it
->last_visible_x
= (it
->first_visible_x
2908 + window_box_width (w
, TEXT_AREA
));
2910 /* If we truncate lines, leave room for the truncation glyph(s) at
2911 the right margin. Otherwise, leave room for the continuation
2912 glyph(s). Done only if the window has no right fringe. */
2913 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2915 if (it
->line_wrap
== TRUNCATE
)
2916 it
->last_visible_x
-= it
->truncation_pixel_width
;
2918 it
->last_visible_x
-= it
->continuation_pixel_width
;
2921 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2922 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2925 /* Leave room for a border glyph. */
2926 if (!FRAME_WINDOW_P (it
->f
)
2927 && !WINDOW_RIGHTMOST_P (it
->w
))
2928 it
->last_visible_x
-= 1;
2930 it
->last_visible_y
= window_text_bottom_y (w
);
2932 /* For mode lines and alike, arrange for the first glyph having a
2933 left box line if the face specifies a box. */
2934 if (base_face_id
!= DEFAULT_FACE_ID
)
2938 it
->face_id
= remapped_base_face_id
;
2940 /* If we have a boxed mode line, make the first character appear
2941 with a left box line. */
2942 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2943 if (face
&& face
->box
!= FACE_NO_BOX
)
2944 it
->start_of_box_run_p
= true;
2947 /* If a buffer position was specified, set the iterator there,
2948 getting overlays and face properties from that position. */
2949 if (charpos
>= BUF_BEG (current_buffer
))
2951 it
->stop_charpos
= charpos
;
2952 it
->end_charpos
= ZV
;
2953 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2954 IT_CHARPOS (*it
) = charpos
;
2955 IT_BYTEPOS (*it
) = bytepos
;
2957 /* We will rely on `reseat' to set this up properly, via
2958 handle_face_prop. */
2959 it
->face_id
= it
->base_face_id
;
2961 it
->start
= it
->current
;
2962 /* Do we need to reorder bidirectional text? Not if this is a
2963 unibyte buffer: by definition, none of the single-byte
2964 characters are strong R2L, so no reordering is needed. And
2965 bidi.c doesn't support unibyte buffers anyway. Also, don't
2966 reorder while we are loading loadup.el, since the tables of
2967 character properties needed for reordering are not yet
2971 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2974 /* If we are to reorder bidirectional text, init the bidi
2978 /* Since we don't know at this point whether there will be
2979 any R2L lines in the window, we reserve space for
2980 truncation/continuation glyphs even if only the left
2981 fringe is absent. */
2982 if (base_face_id
== DEFAULT_FACE_ID
2983 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2984 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2986 if (it
->line_wrap
== TRUNCATE
)
2987 it
->last_visible_x
-= it
->truncation_pixel_width
;
2989 it
->last_visible_x
-= it
->continuation_pixel_width
;
2991 /* Note the paragraph direction that this buffer wants to
2993 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2995 it
->paragraph_embedding
= L2R
;
2996 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2998 it
->paragraph_embedding
= R2L
;
3000 it
->paragraph_embedding
= NEUTRAL_DIR
;
3001 bidi_unshelve_cache (NULL
, 0);
3002 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3006 /* Compute faces etc. */
3007 reseat (it
, it
->current
.pos
, 1);
3014 /* Initialize IT for the display of window W with window start POS. */
3017 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3019 struct glyph_row
*row
;
3020 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3022 row
= w
->desired_matrix
->rows
+ first_vpos
;
3023 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3024 it
->first_vpos
= first_vpos
;
3026 /* Don't reseat to previous visible line start if current start
3027 position is in a string or image. */
3028 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3030 int start_at_line_beg_p
;
3031 int first_y
= it
->current_y
;
3033 /* If window start is not at a line start, skip forward to POS to
3034 get the correct continuation lines width. */
3035 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3036 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3037 if (!start_at_line_beg_p
)
3041 reseat_at_previous_visible_line_start (it
);
3042 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3044 new_x
= it
->current_x
+ it
->pixel_width
;
3046 /* If lines are continued, this line may end in the middle
3047 of a multi-glyph character (e.g. a control character
3048 displayed as \003, or in the middle of an overlay
3049 string). In this case move_it_to above will not have
3050 taken us to the start of the continuation line but to the
3051 end of the continued line. */
3052 if (it
->current_x
> 0
3053 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3054 && (/* And glyph doesn't fit on the line. */
3055 new_x
> it
->last_visible_x
3056 /* Or it fits exactly and we're on a window
3058 || (new_x
== it
->last_visible_x
3059 && FRAME_WINDOW_P (it
->f
)
3060 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3061 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3062 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3064 if ((it
->current
.dpvec_index
>= 0
3065 || it
->current
.overlay_string_index
>= 0)
3066 /* If we are on a newline from a display vector or
3067 overlay string, then we are already at the end of
3068 a screen line; no need to go to the next line in
3069 that case, as this line is not really continued.
3070 (If we do go to the next line, C-e will not DTRT.) */
3073 set_iterator_to_next (it
, 1);
3074 move_it_in_display_line_to (it
, -1, -1, 0);
3077 it
->continuation_lines_width
+= it
->current_x
;
3079 /* If the character at POS is displayed via a display
3080 vector, move_it_to above stops at the final glyph of
3081 IT->dpvec. To make the caller redisplay that character
3082 again (a.k.a. start at POS), we need to reset the
3083 dpvec_index to the beginning of IT->dpvec. */
3084 else if (it
->current
.dpvec_index
>= 0)
3085 it
->current
.dpvec_index
= 0;
3087 /* We're starting a new display line, not affected by the
3088 height of the continued line, so clear the appropriate
3089 fields in the iterator structure. */
3090 it
->max_ascent
= it
->max_descent
= 0;
3091 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3093 it
->current_y
= first_y
;
3095 it
->current_x
= it
->hpos
= 0;
3101 /* Return 1 if POS is a position in ellipses displayed for invisible
3102 text. W is the window we display, for text property lookup. */
3105 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3107 Lisp_Object prop
, window
;
3109 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3111 /* If POS specifies a position in a display vector, this might
3112 be for an ellipsis displayed for invisible text. We won't
3113 get the iterator set up for delivering that ellipsis unless
3114 we make sure that it gets aware of the invisible text. */
3115 if (pos
->dpvec_index
>= 0
3116 && pos
->overlay_string_index
< 0
3117 && CHARPOS (pos
->string_pos
) < 0
3119 && (XSETWINDOW (window
, w
),
3120 prop
= Fget_char_property (make_number (charpos
),
3121 Qinvisible
, window
),
3122 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3124 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3126 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3133 /* Initialize IT for stepping through current_buffer in window W,
3134 starting at position POS that includes overlay string and display
3135 vector/ control character translation position information. Value
3136 is zero if there are overlay strings with newlines at POS. */
3139 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3141 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3142 int i
, overlay_strings_with_newlines
= 0;
3144 /* If POS specifies a position in a display vector, this might
3145 be for an ellipsis displayed for invisible text. We won't
3146 get the iterator set up for delivering that ellipsis unless
3147 we make sure that it gets aware of the invisible text. */
3148 if (in_ellipses_for_invisible_text_p (pos
, w
))
3154 /* Keep in mind: the call to reseat in init_iterator skips invisible
3155 text, so we might end up at a position different from POS. This
3156 is only a problem when POS is a row start after a newline and an
3157 overlay starts there with an after-string, and the overlay has an
3158 invisible property. Since we don't skip invisible text in
3159 display_line and elsewhere immediately after consuming the
3160 newline before the row start, such a POS will not be in a string,
3161 but the call to init_iterator below will move us to the
3163 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3165 /* This only scans the current chunk -- it should scan all chunks.
3166 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3167 to 16 in 22.1 to make this a lesser problem. */
3168 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3170 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3171 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3173 while (s
< e
&& *s
!= '\n')
3178 overlay_strings_with_newlines
= 1;
3183 /* If position is within an overlay string, set up IT to the right
3185 if (pos
->overlay_string_index
>= 0)
3189 /* If the first overlay string happens to have a `display'
3190 property for an image, the iterator will be set up for that
3191 image, and we have to undo that setup first before we can
3192 correct the overlay string index. */
3193 if (it
->method
== GET_FROM_IMAGE
)
3196 /* We already have the first chunk of overlay strings in
3197 IT->overlay_strings. Load more until the one for
3198 pos->overlay_string_index is in IT->overlay_strings. */
3199 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3201 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3202 it
->current
.overlay_string_index
= 0;
3205 load_overlay_strings (it
, 0);
3206 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3210 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3211 relative_index
= (it
->current
.overlay_string_index
3212 % OVERLAY_STRING_CHUNK_SIZE
);
3213 it
->string
= it
->overlay_strings
[relative_index
];
3214 eassert (STRINGP (it
->string
));
3215 it
->current
.string_pos
= pos
->string_pos
;
3216 it
->method
= GET_FROM_STRING
;
3217 it
->end_charpos
= SCHARS (it
->string
);
3218 /* Set up the bidi iterator for this overlay string. */
3221 it
->bidi_it
.string
.lstring
= it
->string
;
3222 it
->bidi_it
.string
.s
= NULL
;
3223 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3224 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3225 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3226 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3227 it
->bidi_it
.w
= it
->w
;
3228 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3229 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3231 /* Synchronize the state of the bidi iterator with
3232 pos->string_pos. For any string position other than
3233 zero, this will be done automagically when we resume
3234 iteration over the string and get_visually_first_element
3235 is called. But if string_pos is zero, and the string is
3236 to be reordered for display, we need to resync manually,
3237 since it could be that the iteration state recorded in
3238 pos ended at string_pos of 0 moving backwards in string. */
3239 if (CHARPOS (pos
->string_pos
) == 0)
3241 get_visually_first_element (it
);
3242 if (IT_STRING_CHARPOS (*it
) != 0)
3245 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3246 bidi_move_to_visually_next (&it
->bidi_it
);
3247 } while (it
->bidi_it
.charpos
!= 0);
3249 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3250 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3254 if (CHARPOS (pos
->string_pos
) >= 0)
3256 /* Recorded position is not in an overlay string, but in another
3257 string. This can only be a string from a `display' property.
3258 IT should already be filled with that string. */
3259 it
->current
.string_pos
= pos
->string_pos
;
3260 eassert (STRINGP (it
->string
));
3262 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3263 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3266 /* Restore position in display vector translations, control
3267 character translations or ellipses. */
3268 if (pos
->dpvec_index
>= 0)
3270 if (it
->dpvec
== NULL
)
3271 get_next_display_element (it
);
3272 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3273 it
->current
.dpvec_index
= pos
->dpvec_index
;
3277 return !overlay_strings_with_newlines
;
3281 /* Initialize IT for stepping through current_buffer in window W
3282 starting at ROW->start. */
3285 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3287 init_from_display_pos (it
, w
, &row
->start
);
3288 it
->start
= row
->start
;
3289 it
->continuation_lines_width
= row
->continuation_lines_width
;
3294 /* Initialize IT for stepping through current_buffer in window W
3295 starting in the line following ROW, i.e. starting at ROW->end.
3296 Value is zero if there are overlay strings with newlines at ROW's
3300 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3304 if (init_from_display_pos (it
, w
, &row
->end
))
3306 if (row
->continued_p
)
3307 it
->continuation_lines_width
3308 = row
->continuation_lines_width
+ row
->pixel_width
;
3319 /***********************************************************************
3321 ***********************************************************************/
3323 /* Called when IT reaches IT->stop_charpos. Handle text property and
3324 overlay changes. Set IT->stop_charpos to the next position where
3328 handle_stop (struct it
*it
)
3330 enum prop_handled handled
;
3331 int handle_overlay_change_p
;
3335 it
->current
.dpvec_index
= -1;
3336 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3337 it
->ignore_overlay_strings_at_pos_p
= 0;
3340 /* Use face of preceding text for ellipsis (if invisible) */
3341 if (it
->selective_display_ellipsis_p
)
3342 it
->saved_face_id
= it
->face_id
;
3344 /* Here's the description of the semantics of, and the logic behind,
3345 the various HANDLED_* statuses:
3347 HANDLED_NORMALLY means the handler did its job, and the loop
3348 should proceed to calling the next handler in order.
3350 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3351 change in the properties and overlays at current position, so the
3352 loop should be restarted, to re-invoke the handlers that were
3353 already called. This happens when fontification-functions were
3354 called by handle_fontified_prop, and actually fontified
3355 something. Another case where HANDLED_RECOMPUTE_PROPS is
3356 returned is when we discover overlay strings that need to be
3357 displayed right away. The loop below will continue for as long
3358 as the status is HANDLED_RECOMPUTE_PROPS.
3360 HANDLED_RETURN means return immediately to the caller, to
3361 continue iteration without calling any further handlers. This is
3362 used when we need to act on some property right away, for example
3363 when we need to display the ellipsis or a replacing display
3364 property, such as display string or image.
3366 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3367 consumed, and the handler switched to the next overlay string.
3368 This signals the loop below to refrain from looking for more
3369 overlays before all the overlay strings of the current overlay
3372 Some of the handlers called by the loop push the iterator state
3373 onto the stack (see 'push_it'), and arrange for the iteration to
3374 continue with another object, such as an image, a display string,
3375 or an overlay string. In most such cases, it->stop_charpos is
3376 set to the first character of the string, so that when the
3377 iteration resumes, this function will immediately be called
3378 again, to examine the properties at the beginning of the string.
3380 When a display or overlay string is exhausted, the iterator state
3381 is popped (see 'pop_it'), and iteration continues with the
3382 previous object. Again, in many such cases this function is
3383 called again to find the next position where properties might
3388 handled
= HANDLED_NORMALLY
;
3390 /* Call text property handlers. */
3391 for (p
= it_props
; p
->handler
; ++p
)
3393 handled
= p
->handler (it
);
3395 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3397 else if (handled
== HANDLED_RETURN
)
3399 /* We still want to show before and after strings from
3400 overlays even if the actual buffer text is replaced. */
3401 if (!handle_overlay_change_p
3403 /* Don't call get_overlay_strings_1 if we already
3404 have overlay strings loaded, because doing so
3405 will load them again and push the iterator state
3406 onto the stack one more time, which is not
3407 expected by the rest of the code that processes
3409 || (it
->current
.overlay_string_index
< 0
3410 ? !get_overlay_strings_1 (it
, 0, 0)
3414 setup_for_ellipsis (it
, 0);
3415 /* When handling a display spec, we might load an
3416 empty string. In that case, discard it here. We
3417 used to discard it in handle_single_display_spec,
3418 but that causes get_overlay_strings_1, above, to
3419 ignore overlay strings that we must check. */
3420 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3424 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3428 it
->ignore_overlay_strings_at_pos_p
= true;
3429 it
->string_from_display_prop_p
= 0;
3430 it
->from_disp_prop_p
= 0;
3431 handle_overlay_change_p
= 0;
3433 handled
= HANDLED_RECOMPUTE_PROPS
;
3436 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3437 handle_overlay_change_p
= 0;
3440 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3442 /* Don't check for overlay strings below when set to deliver
3443 characters from a display vector. */
3444 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3445 handle_overlay_change_p
= 0;
3447 /* Handle overlay changes.
3448 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3449 if it finds overlays. */
3450 if (handle_overlay_change_p
)
3451 handled
= handle_overlay_change (it
);
3456 setup_for_ellipsis (it
, 0);
3460 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3462 /* Determine where to stop next. */
3463 if (handled
== HANDLED_NORMALLY
)
3464 compute_stop_pos (it
);
3468 /* Compute IT->stop_charpos from text property and overlay change
3469 information for IT's current position. */
3472 compute_stop_pos (struct it
*it
)
3474 register INTERVAL iv
, next_iv
;
3475 Lisp_Object object
, limit
, position
;
3476 ptrdiff_t charpos
, bytepos
;
3478 if (STRINGP (it
->string
))
3480 /* Strings are usually short, so don't limit the search for
3482 it
->stop_charpos
= it
->end_charpos
;
3483 object
= it
->string
;
3485 charpos
= IT_STRING_CHARPOS (*it
);
3486 bytepos
= IT_STRING_BYTEPOS (*it
);
3492 /* If end_charpos is out of range for some reason, such as a
3493 misbehaving display function, rationalize it (Bug#5984). */
3494 if (it
->end_charpos
> ZV
)
3495 it
->end_charpos
= ZV
;
3496 it
->stop_charpos
= it
->end_charpos
;
3498 /* If next overlay change is in front of the current stop pos
3499 (which is IT->end_charpos), stop there. Note: value of
3500 next_overlay_change is point-max if no overlay change
3502 charpos
= IT_CHARPOS (*it
);
3503 bytepos
= IT_BYTEPOS (*it
);
3504 pos
= next_overlay_change (charpos
);
3505 if (pos
< it
->stop_charpos
)
3506 it
->stop_charpos
= pos
;
3508 /* Set up variables for computing the stop position from text
3509 property changes. */
3510 XSETBUFFER (object
, current_buffer
);
3511 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3514 /* Get the interval containing IT's position. Value is a null
3515 interval if there isn't such an interval. */
3516 position
= make_number (charpos
);
3517 iv
= validate_interval_range (object
, &position
, &position
, 0);
3520 Lisp_Object values_here
[LAST_PROP_IDX
];
3523 /* Get properties here. */
3524 for (p
= it_props
; p
->handler
; ++p
)
3525 values_here
[p
->idx
] = textget (iv
->plist
,
3526 builtin_lisp_symbol (p
->name
));
3528 /* Look for an interval following iv that has different
3530 for (next_iv
= next_interval (iv
);
3533 || XFASTINT (limit
) > next_iv
->position
));
3534 next_iv
= next_interval (next_iv
))
3536 for (p
= it_props
; p
->handler
; ++p
)
3538 Lisp_Object new_value
= textget (next_iv
->plist
,
3539 builtin_lisp_symbol (p
->name
));
3540 if (!EQ (values_here
[p
->idx
], new_value
))
3550 if (INTEGERP (limit
)
3551 && next_iv
->position
>= XFASTINT (limit
))
3552 /* No text property change up to limit. */
3553 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3555 /* Text properties change in next_iv. */
3556 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3560 if (it
->cmp_it
.id
< 0)
3562 ptrdiff_t stoppos
= it
->end_charpos
;
3564 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3566 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3567 stoppos
, it
->string
);
3570 eassert (STRINGP (it
->string
)
3571 || (it
->stop_charpos
>= BEGV
3572 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3576 /* Return the position of the next overlay change after POS in
3577 current_buffer. Value is point-max if no overlay change
3578 follows. This is like `next-overlay-change' but doesn't use
3582 next_overlay_change (ptrdiff_t pos
)
3584 ptrdiff_t i
, noverlays
;
3586 Lisp_Object
*overlays
;
3589 /* Get all overlays at the given position. */
3590 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3592 /* If any of these overlays ends before endpos,
3593 use its ending point instead. */
3594 for (i
= 0; i
< noverlays
; ++i
)
3599 oend
= OVERLAY_END (overlays
[i
]);
3600 oendpos
= OVERLAY_POSITION (oend
);
3601 endpos
= min (endpos
, oendpos
);
3608 /* How many characters forward to search for a display property or
3609 display string. Searching too far forward makes the bidi display
3610 sluggish, especially in small windows. */
3611 #define MAX_DISP_SCAN 250
3613 /* Return the character position of a display string at or after
3614 position specified by POSITION. If no display string exists at or
3615 after POSITION, return ZV. A display string is either an overlay
3616 with `display' property whose value is a string, or a `display'
3617 text property whose value is a string. STRING is data about the
3618 string to iterate; if STRING->lstring is nil, we are iterating a
3619 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3620 on a GUI frame. DISP_PROP is set to zero if we searched
3621 MAX_DISP_SCAN characters forward without finding any display
3622 strings, non-zero otherwise. It is set to 2 if the display string
3623 uses any kind of `(space ...)' spec that will produce a stretch of
3624 white space in the text area. */
3626 compute_display_string_pos (struct text_pos
*position
,
3627 struct bidi_string_data
*string
,
3629 int frame_window_p
, int *disp_prop
)
3631 /* OBJECT = nil means current buffer. */
3632 Lisp_Object object
, object1
;
3633 Lisp_Object pos
, spec
, limpos
;
3634 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3635 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3636 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3637 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3639 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3640 struct text_pos tpos
;
3643 if (string
&& STRINGP (string
->lstring
))
3644 object1
= object
= string
->lstring
;
3645 else if (w
&& !string_p
)
3647 XSETWINDOW (object
, w
);
3651 object1
= object
= Qnil
;
3656 /* We don't support display properties whose values are strings
3657 that have display string properties. */
3658 || string
->from_disp_str
3659 /* C strings cannot have display properties. */
3660 || (string
->s
&& !STRINGP (object
)))
3666 /* If the character at CHARPOS is where the display string begins,
3668 pos
= make_number (charpos
);
3669 if (STRINGP (object
))
3670 bufpos
= string
->bufpos
;
3674 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3676 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3679 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3687 /* Look forward for the first character with a `display' property
3688 that will replace the underlying text when displayed. */
3689 limpos
= make_number (lim
);
3691 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3692 CHARPOS (tpos
) = XFASTINT (pos
);
3693 if (CHARPOS (tpos
) >= lim
)
3698 if (STRINGP (object
))
3699 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3701 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3702 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3703 if (!STRINGP (object
))
3704 bufpos
= CHARPOS (tpos
);
3705 } while (NILP (spec
)
3706 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3707 bufpos
, frame_window_p
)));
3711 return CHARPOS (tpos
);
3714 /* Return the character position of the end of the display string that
3715 started at CHARPOS. If there's no display string at CHARPOS,
3716 return -1. A display string is either an overlay with `display'
3717 property whose value is a string or a `display' text property whose
3718 value is a string. */
3720 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3722 /* OBJECT = nil means current buffer. */
3723 Lisp_Object object
=
3724 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3725 Lisp_Object pos
= make_number (charpos
);
3727 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3729 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3732 /* It could happen that the display property or overlay was removed
3733 since we found it in compute_display_string_pos above. One way
3734 this can happen is if JIT font-lock was called (through
3735 handle_fontified_prop), and jit-lock-functions remove text
3736 properties or overlays from the portion of buffer that includes
3737 CHARPOS. Muse mode is known to do that, for example. In this
3738 case, we return -1 to the caller, to signal that no display
3739 string is actually present at CHARPOS. See bidi_fetch_char for
3740 how this is handled.
3742 An alternative would be to never look for display properties past
3743 it->stop_charpos. But neither compute_display_string_pos nor
3744 bidi_fetch_char that calls it know or care where the next
3746 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3749 /* Look forward for the first character where the `display' property
3751 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3753 return XFASTINT (pos
);
3758 /***********************************************************************
3760 ***********************************************************************/
3762 /* Handle changes in the `fontified' property of the current buffer by
3763 calling hook functions from Qfontification_functions to fontify
3766 static enum prop_handled
3767 handle_fontified_prop (struct it
*it
)
3769 Lisp_Object prop
, pos
;
3770 enum prop_handled handled
= HANDLED_NORMALLY
;
3772 if (!NILP (Vmemory_full
))
3775 /* Get the value of the `fontified' property at IT's current buffer
3776 position. (The `fontified' property doesn't have a special
3777 meaning in strings.) If the value is nil, call functions from
3778 Qfontification_functions. */
3779 if (!STRINGP (it
->string
)
3781 && !NILP (Vfontification_functions
)
3782 && !NILP (Vrun_hooks
)
3783 && (pos
= make_number (IT_CHARPOS (*it
)),
3784 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3785 /* Ignore the special cased nil value always present at EOB since
3786 no amount of fontifying will be able to change it. */
3787 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3789 ptrdiff_t count
= SPECPDL_INDEX ();
3791 struct buffer
*obuf
= current_buffer
;
3792 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3793 bool old_clip_changed
= current_buffer
->clip_changed
;
3795 val
= Vfontification_functions
;
3796 specbind (Qfontification_functions
, Qnil
);
3798 eassert (it
->end_charpos
== ZV
);
3800 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3801 safe_call1 (val
, pos
);
3804 Lisp_Object fns
, fn
;
3805 struct gcpro gcpro1
, gcpro2
;
3810 for (; CONSP (val
); val
= XCDR (val
))
3816 /* A value of t indicates this hook has a local
3817 binding; it means to run the global binding too.
3818 In a global value, t should not occur. If it
3819 does, we must ignore it to avoid an endless
3821 for (fns
= Fdefault_value (Qfontification_functions
);
3827 safe_call1 (fn
, pos
);
3831 safe_call1 (fn
, pos
);
3837 unbind_to (count
, Qnil
);
3839 /* Fontification functions routinely call `save-restriction'.
3840 Normally, this tags clip_changed, which can confuse redisplay
3841 (see discussion in Bug#6671). Since we don't perform any
3842 special handling of fontification changes in the case where
3843 `save-restriction' isn't called, there's no point doing so in
3844 this case either. So, if the buffer's restrictions are
3845 actually left unchanged, reset clip_changed. */
3846 if (obuf
== current_buffer
)
3848 if (begv
== BEGV
&& zv
== ZV
)
3849 current_buffer
->clip_changed
= old_clip_changed
;
3851 /* There isn't much we can reasonably do to protect against
3852 misbehaving fontification, but here's a fig leaf. */
3853 else if (BUFFER_LIVE_P (obuf
))
3854 set_buffer_internal_1 (obuf
);
3856 /* The fontification code may have added/removed text.
3857 It could do even a lot worse, but let's at least protect against
3858 the most obvious case where only the text past `pos' gets changed',
3859 as is/was done in grep.el where some escapes sequences are turned
3860 into face properties (bug#7876). */
3861 it
->end_charpos
= ZV
;
3863 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3864 something. This avoids an endless loop if they failed to
3865 fontify the text for which reason ever. */
3866 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3867 handled
= HANDLED_RECOMPUTE_PROPS
;
3875 /***********************************************************************
3877 ***********************************************************************/
3879 /* Set up iterator IT from face properties at its current position.
3880 Called from handle_stop. */
3882 static enum prop_handled
3883 handle_face_prop (struct it
*it
)
3886 ptrdiff_t next_stop
;
3888 if (!STRINGP (it
->string
))
3891 = face_at_buffer_position (it
->w
,
3895 + TEXT_PROP_DISTANCE_LIMIT
),
3896 0, it
->base_face_id
);
3898 /* Is this a start of a run of characters with box face?
3899 Caveat: this can be called for a freshly initialized
3900 iterator; face_id is -1 in this case. We know that the new
3901 face will not change until limit, i.e. if the new face has a
3902 box, all characters up to limit will have one. But, as
3903 usual, we don't know whether limit is really the end. */
3904 if (new_face_id
!= it
->face_id
)
3906 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3907 /* If it->face_id is -1, old_face below will be NULL, see
3908 the definition of FACE_FROM_ID. This will happen if this
3909 is the initial call that gets the face. */
3910 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3912 /* If the value of face_id of the iterator is -1, we have to
3913 look in front of IT's position and see whether there is a
3914 face there that's different from new_face_id. */
3915 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3917 int prev_face_id
= face_before_it_pos (it
);
3919 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3922 /* If the new face has a box, but the old face does not,
3923 this is the start of a run of characters with box face,
3924 i.e. this character has a shadow on the left side. */
3925 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3926 && (old_face
== NULL
|| !old_face
->box
));
3927 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3935 Lisp_Object from_overlay
3936 = (it
->current
.overlay_string_index
>= 0
3937 ? it
->string_overlays
[it
->current
.overlay_string_index
3938 % OVERLAY_STRING_CHUNK_SIZE
]
3941 /* See if we got to this string directly or indirectly from
3942 an overlay property. That includes the before-string or
3943 after-string of an overlay, strings in display properties
3944 provided by an overlay, their text properties, etc.
3946 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3947 if (! NILP (from_overlay
))
3948 for (i
= it
->sp
- 1; i
>= 0; i
--)
3950 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3952 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3953 % OVERLAY_STRING_CHUNK_SIZE
];
3954 else if (! NILP (it
->stack
[i
].from_overlay
))
3955 from_overlay
= it
->stack
[i
].from_overlay
;
3957 if (!NILP (from_overlay
))
3961 if (! NILP (from_overlay
))
3963 bufpos
= IT_CHARPOS (*it
);
3964 /* For a string from an overlay, the base face depends
3965 only on text properties and ignores overlays. */
3967 = face_for_overlay_string (it
->w
,
3971 + TEXT_PROP_DISTANCE_LIMIT
),
3979 /* For strings from a `display' property, use the face at
3980 IT's current buffer position as the base face to merge
3981 with, so that overlay strings appear in the same face as
3982 surrounding text, unless they specify their own faces.
3983 For strings from wrap-prefix and line-prefix properties,
3984 use the default face, possibly remapped via
3985 Vface_remapping_alist. */
3986 /* Note that the fact that we use the face at _buffer_
3987 position means that a 'display' property on an overlay
3988 string will not inherit the face of that overlay string,
3989 but will instead revert to the face of buffer text
3990 covered by the overlay. This is visible, e.g., when the
3991 overlay specifies a box face, but neither the buffer nor
3992 the display string do. This sounds like a design bug,
3993 but Emacs always did that since v21.1, so changing that
3994 might be a big deal. */
3995 base_face_id
= it
->string_from_prefix_prop_p
3996 ? (!NILP (Vface_remapping_alist
)
3997 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3999 : underlying_face_id (it
);
4002 new_face_id
= face_at_string_position (it
->w
,
4004 IT_STRING_CHARPOS (*it
),
4009 /* Is this a start of a run of characters with box? Caveat:
4010 this can be called for a freshly allocated iterator; face_id
4011 is -1 is this case. We know that the new face will not
4012 change until the next check pos, i.e. if the new face has a
4013 box, all characters up to that position will have a
4014 box. But, as usual, we don't know whether that position
4015 is really the end. */
4016 if (new_face_id
!= it
->face_id
)
4018 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4019 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4021 /* If new face has a box but old face hasn't, this is the
4022 start of a run of characters with box, i.e. it has a
4023 shadow on the left side. */
4024 it
->start_of_box_run_p
4025 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4026 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4030 it
->face_id
= new_face_id
;
4031 return HANDLED_NORMALLY
;
4035 /* Return the ID of the face ``underlying'' IT's current position,
4036 which is in a string. If the iterator is associated with a
4037 buffer, return the face at IT's current buffer position.
4038 Otherwise, use the iterator's base_face_id. */
4041 underlying_face_id (struct it
*it
)
4043 int face_id
= it
->base_face_id
, i
;
4045 eassert (STRINGP (it
->string
));
4047 for (i
= it
->sp
- 1; i
>= 0; --i
)
4048 if (NILP (it
->stack
[i
].string
))
4049 face_id
= it
->stack
[i
].face_id
;
4055 /* Compute the face one character before or after the current position
4056 of IT, in the visual order. BEFORE_P non-zero means get the face
4057 in front (to the left in L2R paragraphs, to the right in R2L
4058 paragraphs) of IT's screen position. Value is the ID of the face. */
4061 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4064 ptrdiff_t next_check_charpos
;
4066 void *it_copy_data
= NULL
;
4068 eassert (it
->s
== NULL
);
4070 if (STRINGP (it
->string
))
4072 ptrdiff_t bufpos
, charpos
;
4075 /* No face change past the end of the string (for the case
4076 we are padding with spaces). No face change before the
4078 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4079 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4084 /* Set charpos to the position before or after IT's current
4085 position, in the logical order, which in the non-bidi
4086 case is the same as the visual order. */
4088 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4089 else if (it
->what
== IT_COMPOSITION
)
4090 /* For composition, we must check the character after the
4092 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4094 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4100 /* With bidi iteration, the character before the current
4101 in the visual order cannot be found by simple
4102 iteration, because "reverse" reordering is not
4103 supported. Instead, we need to use the move_it_*
4104 family of functions. */
4105 /* Ignore face changes before the first visible
4106 character on this display line. */
4107 if (it
->current_x
<= it
->first_visible_x
)
4109 SAVE_IT (it_copy
, *it
, it_copy_data
);
4110 /* Implementation note: Since move_it_in_display_line
4111 works in the iterator geometry, and thinks the first
4112 character is always the leftmost, even in R2L lines,
4113 we don't need to distinguish between the R2L and L2R
4115 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4116 it_copy
.current_x
- 1, MOVE_TO_X
);
4117 charpos
= IT_STRING_CHARPOS (it_copy
);
4118 RESTORE_IT (it
, it
, it_copy_data
);
4122 /* Set charpos to the string position of the character
4123 that comes after IT's current position in the visual
4125 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4129 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4131 charpos
= it_copy
.bidi_it
.charpos
;
4134 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4136 if (it
->current
.overlay_string_index
>= 0)
4137 bufpos
= IT_CHARPOS (*it
);
4141 base_face_id
= underlying_face_id (it
);
4143 /* Get the face for ASCII, or unibyte. */
4144 face_id
= face_at_string_position (it
->w
,
4148 &next_check_charpos
,
4151 /* Correct the face for charsets different from ASCII. Do it
4152 for the multibyte case only. The face returned above is
4153 suitable for unibyte text if IT->string is unibyte. */
4154 if (STRING_MULTIBYTE (it
->string
))
4156 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4157 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4159 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4161 c
= string_char_and_length (p
, &len
);
4162 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4167 struct text_pos pos
;
4169 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4170 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4173 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4174 pos
= it
->current
.pos
;
4179 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4182 if (it
->what
== IT_COMPOSITION
)
4184 /* For composition, we must check the position after
4186 pos
.charpos
+= it
->cmp_it
.nchars
;
4187 pos
.bytepos
+= it
->len
;
4190 INC_TEXT_POS (pos
, it
->multibyte_p
);
4197 /* With bidi iteration, the character before the current
4198 in the visual order cannot be found by simple
4199 iteration, because "reverse" reordering is not
4200 supported. Instead, we need to use the move_it_*
4201 family of functions. */
4202 /* Ignore face changes before the first visible
4203 character on this display line. */
4204 if (it
->current_x
<= it
->first_visible_x
)
4206 SAVE_IT (it_copy
, *it
, it_copy_data
);
4207 /* Implementation note: Since move_it_in_display_line
4208 works in the iterator geometry, and thinks the first
4209 character is always the leftmost, even in R2L lines,
4210 we don't need to distinguish between the R2L and L2R
4212 move_it_in_display_line (&it_copy
, ZV
,
4213 it_copy
.current_x
- 1, MOVE_TO_X
);
4214 pos
= it_copy
.current
.pos
;
4215 RESTORE_IT (it
, it
, it_copy_data
);
4219 /* Set charpos to the buffer position of the character
4220 that comes after IT's current position in the visual
4222 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4226 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4229 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4232 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4234 /* Determine face for CHARSET_ASCII, or unibyte. */
4235 face_id
= face_at_buffer_position (it
->w
,
4237 &next_check_charpos
,
4240 /* Correct the face for charsets different from ASCII. Do it
4241 for the multibyte case only. The face returned above is
4242 suitable for unibyte text if current_buffer is unibyte. */
4243 if (it
->multibyte_p
)
4245 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4246 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4247 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4256 /***********************************************************************
4258 ***********************************************************************/
4260 /* Set up iterator IT from invisible properties at its current
4261 position. Called from handle_stop. */
4263 static enum prop_handled
4264 handle_invisible_prop (struct it
*it
)
4266 enum prop_handled handled
= HANDLED_NORMALLY
;
4270 if (STRINGP (it
->string
))
4272 Lisp_Object end_charpos
, limit
, charpos
;
4274 /* Get the value of the invisible text property at the
4275 current position. Value will be nil if there is no such
4277 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4278 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4279 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4281 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4283 /* Record whether we have to display an ellipsis for the
4285 int display_ellipsis_p
= (invis_p
== 2);
4286 ptrdiff_t len
, endpos
;
4288 handled
= HANDLED_RECOMPUTE_PROPS
;
4290 /* Get the position at which the next visible text can be
4291 found in IT->string, if any. */
4292 endpos
= len
= SCHARS (it
->string
);
4293 XSETINT (limit
, len
);
4296 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4298 if (INTEGERP (end_charpos
))
4300 endpos
= XFASTINT (end_charpos
);
4301 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4302 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4304 display_ellipsis_p
= true;
4307 while (invis_p
&& endpos
< len
);
4309 if (display_ellipsis_p
)
4310 it
->ellipsis_p
= true;
4314 /* Text at END_CHARPOS is visible. Move IT there. */
4315 struct text_pos old
;
4318 old
= it
->current
.string_pos
;
4319 oldpos
= CHARPOS (old
);
4322 if (it
->bidi_it
.first_elt
4323 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4324 bidi_paragraph_init (it
->paragraph_embedding
,
4326 /* Bidi-iterate out of the invisible text. */
4329 bidi_move_to_visually_next (&it
->bidi_it
);
4331 while (oldpos
<= it
->bidi_it
.charpos
4332 && it
->bidi_it
.charpos
< endpos
);
4334 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4335 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4336 if (IT_CHARPOS (*it
) >= endpos
)
4337 it
->prev_stop
= endpos
;
4341 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4342 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4347 /* The rest of the string is invisible. If this is an
4348 overlay string, proceed with the next overlay string
4349 or whatever comes and return a character from there. */
4350 if (it
->current
.overlay_string_index
>= 0
4351 && !display_ellipsis_p
)
4353 next_overlay_string (it
);
4354 /* Don't check for overlay strings when we just
4355 finished processing them. */
4356 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4360 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4361 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4368 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4369 Lisp_Object pos
, overlay
;
4371 /* First of all, is there invisible text at this position? */
4372 tem
= start_charpos
= IT_CHARPOS (*it
);
4373 pos
= make_number (tem
);
4374 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4376 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4378 /* If we are on invisible text, skip over it. */
4379 if (invis_p
&& start_charpos
< it
->end_charpos
)
4381 /* Record whether we have to display an ellipsis for the
4383 int display_ellipsis_p
= invis_p
== 2;
4385 handled
= HANDLED_RECOMPUTE_PROPS
;
4387 /* Loop skipping over invisible text. The loop is left at
4388 ZV or with IT on the first char being visible again. */
4391 /* Try to skip some invisible text. Return value is the
4392 position reached which can be equal to where we start
4393 if there is nothing invisible there. This skips both
4394 over invisible text properties and overlays with
4395 invisible property. */
4396 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4398 /* If we skipped nothing at all we weren't at invisible
4399 text in the first place. If everything to the end of
4400 the buffer was skipped, end the loop. */
4401 if (newpos
== tem
|| newpos
>= ZV
)
4405 /* We skipped some characters but not necessarily
4406 all there are. Check if we ended up on visible
4407 text. Fget_char_property returns the property of
4408 the char before the given position, i.e. if we
4409 get invis_p = 0, this means that the char at
4410 newpos is visible. */
4411 pos
= make_number (newpos
);
4412 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4413 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4416 /* If we ended up on invisible text, proceed to
4417 skip starting with next_stop. */
4421 /* If there are adjacent invisible texts, don't lose the
4422 second one's ellipsis. */
4424 display_ellipsis_p
= true;
4428 /* The position newpos is now either ZV or on visible text. */
4431 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4433 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4435 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4437 /* If the invisible text ends on a newline or on a
4438 character after a newline, we can avoid the costly,
4439 character by character, bidi iteration to NEWPOS, and
4440 instead simply reseat the iterator there. That's
4441 because all bidi reordering information is tossed at
4442 the newline. This is a big win for modes that hide
4443 complete lines, like Outline, Org, etc. */
4444 if (on_newline
|| after_newline
)
4446 struct text_pos tpos
;
4447 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4449 SET_TEXT_POS (tpos
, newpos
, bpos
);
4450 reseat_1 (it
, tpos
, 0);
4451 /* If we reseat on a newline/ZV, we need to prep the
4452 bidi iterator for advancing to the next character
4453 after the newline/EOB, keeping the current paragraph
4454 direction (so that PRODUCE_GLYPHS does TRT wrt
4455 prepending/appending glyphs to a glyph row). */
4458 it
->bidi_it
.first_elt
= 0;
4459 it
->bidi_it
.paragraph_dir
= pdir
;
4460 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4461 it
->bidi_it
.nchars
= 1;
4462 it
->bidi_it
.ch_len
= 1;
4465 else /* Must use the slow method. */
4467 /* With bidi iteration, the region of invisible text
4468 could start and/or end in the middle of a
4469 non-base embedding level. Therefore, we need to
4470 skip invisible text using the bidi iterator,
4471 starting at IT's current position, until we find
4472 ourselves outside of the invisible text.
4473 Skipping invisible text _after_ bidi iteration
4474 avoids affecting the visual order of the
4475 displayed text when invisible properties are
4476 added or removed. */
4477 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4479 /* If we were `reseat'ed to a new paragraph,
4480 determine the paragraph base direction. We
4481 need to do it now because
4482 next_element_from_buffer may not have a
4483 chance to do it, if we are going to skip any
4484 text at the beginning, which resets the
4486 bidi_paragraph_init (it
->paragraph_embedding
,
4491 bidi_move_to_visually_next (&it
->bidi_it
);
4493 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4494 && it
->bidi_it
.charpos
< newpos
);
4495 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4496 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4497 /* If we overstepped NEWPOS, record its position in
4498 the iterator, so that we skip invisible text if
4499 later the bidi iteration lands us in the
4500 invisible region again. */
4501 if (IT_CHARPOS (*it
) >= newpos
)
4502 it
->prev_stop
= newpos
;
4507 IT_CHARPOS (*it
) = newpos
;
4508 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4511 /* If there are before-strings at the start of invisible
4512 text, and the text is invisible because of a text
4513 property, arrange to show before-strings because 20.x did
4514 it that way. (If the text is invisible because of an
4515 overlay property instead of a text property, this is
4516 already handled in the overlay code.) */
4518 && get_overlay_strings (it
, it
->stop_charpos
))
4520 handled
= HANDLED_RECOMPUTE_PROPS
;
4523 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4524 /* The call to get_overlay_strings above recomputes
4525 it->stop_charpos, but it only considers changes
4526 in properties and overlays beyond iterator's
4527 current position. This causes us to miss changes
4528 that happen exactly where the invisible property
4529 ended. So we play it safe here and force the
4530 iterator to check for potential stop positions
4531 immediately after the invisible text. Note that
4532 if get_overlay_strings returns non-zero, it
4533 normally also pushed the iterator stack, so we
4534 need to update the stop position in the slot
4535 below the current one. */
4536 it
->stack
[it
->sp
- 1].stop_charpos
4537 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4540 else if (display_ellipsis_p
)
4542 /* Make sure that the glyphs of the ellipsis will get
4543 correct `charpos' values. If we would not update
4544 it->position here, the glyphs would belong to the
4545 last visible character _before_ the invisible
4546 text, which confuses `set_cursor_from_row'.
4548 We use the last invisible position instead of the
4549 first because this way the cursor is always drawn on
4550 the first "." of the ellipsis, whenever PT is inside
4551 the invisible text. Otherwise the cursor would be
4552 placed _after_ the ellipsis when the point is after the
4553 first invisible character. */
4554 if (!STRINGP (it
->object
))
4556 it
->position
.charpos
= newpos
- 1;
4557 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4559 it
->ellipsis_p
= true;
4560 /* Let the ellipsis display before
4561 considering any properties of the following char.
4562 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4563 handled
= HANDLED_RETURN
;
4572 /* Make iterator IT return `...' next.
4573 Replaces LEN characters from buffer. */
4576 setup_for_ellipsis (struct it
*it
, int len
)
4578 /* Use the display table definition for `...'. Invalid glyphs
4579 will be handled by the method returning elements from dpvec. */
4580 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4582 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4583 it
->dpvec
= v
->contents
;
4584 it
->dpend
= v
->contents
+ v
->header
.size
;
4588 /* Default `...'. */
4589 it
->dpvec
= default_invis_vector
;
4590 it
->dpend
= default_invis_vector
+ 3;
4593 it
->dpvec_char_len
= len
;
4594 it
->current
.dpvec_index
= 0;
4595 it
->dpvec_face_id
= -1;
4597 /* Remember the current face id in case glyphs specify faces.
4598 IT's face is restored in set_iterator_to_next.
4599 saved_face_id was set to preceding char's face in handle_stop. */
4600 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4601 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4603 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4604 it
->ellipsis_p
= true;
4609 /***********************************************************************
4611 ***********************************************************************/
4613 /* Set up iterator IT from `display' property at its current position.
4614 Called from handle_stop.
4615 We return HANDLED_RETURN if some part of the display property
4616 overrides the display of the buffer text itself.
4617 Otherwise we return HANDLED_NORMALLY. */
4619 static enum prop_handled
4620 handle_display_prop (struct it
*it
)
4622 Lisp_Object propval
, object
, overlay
;
4623 struct text_pos
*position
;
4625 /* Nonzero if some property replaces the display of the text itself. */
4626 int display_replaced_p
= 0;
4628 if (STRINGP (it
->string
))
4630 object
= it
->string
;
4631 position
= &it
->current
.string_pos
;
4632 bufpos
= CHARPOS (it
->current
.pos
);
4636 XSETWINDOW (object
, it
->w
);
4637 position
= &it
->current
.pos
;
4638 bufpos
= CHARPOS (*position
);
4641 /* Reset those iterator values set from display property values. */
4642 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4643 it
->space_width
= Qnil
;
4644 it
->font_height
= Qnil
;
4647 /* We don't support recursive `display' properties, i.e. string
4648 values that have a string `display' property, that have a string
4649 `display' property etc. */
4650 if (!it
->string_from_display_prop_p
)
4651 it
->area
= TEXT_AREA
;
4653 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4654 Qdisplay
, object
, &overlay
);
4656 return HANDLED_NORMALLY
;
4657 /* Now OVERLAY is the overlay that gave us this property, or nil
4658 if it was a text property. */
4660 if (!STRINGP (it
->string
))
4661 object
= it
->w
->contents
;
4663 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4665 FRAME_WINDOW_P (it
->f
));
4667 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4670 /* Subroutine of handle_display_prop. Returns non-zero if the display
4671 specification in SPEC is a replacing specification, i.e. it would
4672 replace the text covered by `display' property with something else,
4673 such as an image or a display string. If SPEC includes any kind or
4674 `(space ...) specification, the value is 2; this is used by
4675 compute_display_string_pos, which see.
4677 See handle_single_display_spec for documentation of arguments.
4678 frame_window_p is non-zero if the window being redisplayed is on a
4679 GUI frame; this argument is used only if IT is NULL, see below.
4681 IT can be NULL, if this is called by the bidi reordering code
4682 through compute_display_string_pos, which see. In that case, this
4683 function only examines SPEC, but does not otherwise "handle" it, in
4684 the sense that it doesn't set up members of IT from the display
4687 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4688 Lisp_Object overlay
, struct text_pos
*position
,
4689 ptrdiff_t bufpos
, int frame_window_p
)
4691 int replacing_p
= 0;
4695 /* Simple specifications. */
4696 && !EQ (XCAR (spec
), Qimage
)
4697 #ifdef HAVE_XWIDGETS
4698 && !EQ (XCAR (spec
), Qxwidget
)
4700 && !EQ (XCAR (spec
), Qspace
)
4701 && !EQ (XCAR (spec
), Qwhen
)
4702 && !EQ (XCAR (spec
), Qslice
)
4703 && !EQ (XCAR (spec
), Qspace_width
)
4704 && !EQ (XCAR (spec
), Qheight
)
4705 && !EQ (XCAR (spec
), Qraise
)
4706 /* Marginal area specifications. */
4707 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4708 && !EQ (XCAR (spec
), Qleft_fringe
)
4709 && !EQ (XCAR (spec
), Qright_fringe
)
4710 && !NILP (XCAR (spec
)))
4712 for (; CONSP (spec
); spec
= XCDR (spec
))
4714 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4715 overlay
, position
, bufpos
,
4716 replacing_p
, frame_window_p
)))
4719 /* If some text in a string is replaced, `position' no
4720 longer points to the position of `object'. */
4721 if (!it
|| STRINGP (object
))
4726 else if (VECTORP (spec
))
4729 for (i
= 0; i
< ASIZE (spec
); ++i
)
4730 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4731 overlay
, position
, bufpos
,
4732 replacing_p
, frame_window_p
)))
4735 /* If some text in a string is replaced, `position' no
4736 longer points to the position of `object'. */
4737 if (!it
|| STRINGP (object
))
4743 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4744 position
, bufpos
, 0,
4752 /* Value is the position of the end of the `display' property starting
4753 at START_POS in OBJECT. */
4755 static struct text_pos
4756 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4759 struct text_pos end_pos
;
4761 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4762 Qdisplay
, object
, Qnil
);
4763 CHARPOS (end_pos
) = XFASTINT (end
);
4764 if (STRINGP (object
))
4765 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4767 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4773 /* Set up IT from a single `display' property specification SPEC. OBJECT
4774 is the object in which the `display' property was found. *POSITION
4775 is the position in OBJECT at which the `display' property was found.
4776 BUFPOS is the buffer position of OBJECT (different from POSITION if
4777 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4778 previously saw a display specification which already replaced text
4779 display with something else, for example an image; we ignore such
4780 properties after the first one has been processed.
4782 OVERLAY is the overlay this `display' property came from,
4783 or nil if it was a text property.
4785 If SPEC is a `space' or `image' specification, and in some other
4786 cases too, set *POSITION to the position where the `display'
4789 If IT is NULL, only examine the property specification in SPEC, but
4790 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4791 is intended to be displayed in a window on a GUI frame.
4793 Value is non-zero if something was found which replaces the display
4794 of buffer or string text. */
4797 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4798 Lisp_Object overlay
, struct text_pos
*position
,
4799 ptrdiff_t bufpos
, int display_replaced_p
,
4803 Lisp_Object location
, value
;
4804 struct text_pos start_pos
= *position
;
4807 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4808 If the result is non-nil, use VALUE instead of SPEC. */
4810 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4819 if (!NILP (form
) && !EQ (form
, Qt
))
4821 ptrdiff_t count
= SPECPDL_INDEX ();
4822 struct gcpro gcpro1
;
4824 /* Bind `object' to the object having the `display' property, a
4825 buffer or string. Bind `position' to the position in the
4826 object where the property was found, and `buffer-position'
4827 to the current position in the buffer. */
4830 XSETBUFFER (object
, current_buffer
);
4831 specbind (Qobject
, object
);
4832 specbind (Qposition
, make_number (CHARPOS (*position
)));
4833 specbind (Qbuffer_position
, make_number (bufpos
));
4835 form
= safe_eval (form
);
4837 unbind_to (count
, Qnil
);
4843 /* Handle `(height HEIGHT)' specifications. */
4845 && EQ (XCAR (spec
), Qheight
)
4846 && CONSP (XCDR (spec
)))
4850 if (!FRAME_WINDOW_P (it
->f
))
4853 it
->font_height
= XCAR (XCDR (spec
));
4854 if (!NILP (it
->font_height
))
4856 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4857 int new_height
= -1;
4859 if (CONSP (it
->font_height
)
4860 && (EQ (XCAR (it
->font_height
), Qplus
)
4861 || EQ (XCAR (it
->font_height
), Qminus
))
4862 && CONSP (XCDR (it
->font_height
))
4863 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4865 /* `(+ N)' or `(- N)' where N is an integer. */
4866 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4867 if (EQ (XCAR (it
->font_height
), Qplus
))
4869 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4871 else if (FUNCTIONP (it
->font_height
))
4873 /* Call function with current height as argument.
4874 Value is the new height. */
4876 height
= safe_call1 (it
->font_height
,
4877 face
->lface
[LFACE_HEIGHT_INDEX
]);
4878 if (NUMBERP (height
))
4879 new_height
= XFLOATINT (height
);
4881 else if (NUMBERP (it
->font_height
))
4883 /* Value is a multiple of the canonical char height. */
4886 f
= FACE_FROM_ID (it
->f
,
4887 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4888 new_height
= (XFLOATINT (it
->font_height
)
4889 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4893 /* Evaluate IT->font_height with `height' bound to the
4894 current specified height to get the new height. */
4895 ptrdiff_t count
= SPECPDL_INDEX ();
4897 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4898 value
= safe_eval (it
->font_height
);
4899 unbind_to (count
, Qnil
);
4901 if (NUMBERP (value
))
4902 new_height
= XFLOATINT (value
);
4906 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4913 /* Handle `(space-width WIDTH)'. */
4915 && EQ (XCAR (spec
), Qspace_width
)
4916 && CONSP (XCDR (spec
)))
4920 if (!FRAME_WINDOW_P (it
->f
))
4923 value
= XCAR (XCDR (spec
));
4924 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4925 it
->space_width
= value
;
4931 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4933 && EQ (XCAR (spec
), Qslice
))
4939 if (!FRAME_WINDOW_P (it
->f
))
4942 if (tem
= XCDR (spec
), CONSP (tem
))
4944 it
->slice
.x
= XCAR (tem
);
4945 if (tem
= XCDR (tem
), CONSP (tem
))
4947 it
->slice
.y
= XCAR (tem
);
4948 if (tem
= XCDR (tem
), CONSP (tem
))
4950 it
->slice
.width
= XCAR (tem
);
4951 if (tem
= XCDR (tem
), CONSP (tem
))
4952 it
->slice
.height
= XCAR (tem
);
4961 /* Handle `(raise FACTOR)'. */
4963 && EQ (XCAR (spec
), Qraise
)
4964 && CONSP (XCDR (spec
)))
4968 if (!FRAME_WINDOW_P (it
->f
))
4971 #ifdef HAVE_WINDOW_SYSTEM
4972 value
= XCAR (XCDR (spec
));
4973 if (NUMBERP (value
))
4975 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4976 it
->voffset
= - (XFLOATINT (value
)
4977 * (FONT_HEIGHT (face
->font
)));
4979 #endif /* HAVE_WINDOW_SYSTEM */
4985 /* Don't handle the other kinds of display specifications
4986 inside a string that we got from a `display' property. */
4987 if (it
&& it
->string_from_display_prop_p
)
4990 /* Characters having this form of property are not displayed, so
4991 we have to find the end of the property. */
4994 start_pos
= *position
;
4995 *position
= display_prop_end (it
, object
, start_pos
);
4999 /* Stop the scan at that end position--we assume that all
5000 text properties change there. */
5002 it
->stop_charpos
= position
->charpos
;
5004 /* Handle `(left-fringe BITMAP [FACE])'
5005 and `(right-fringe BITMAP [FACE])'. */
5007 && (EQ (XCAR (spec
), Qleft_fringe
)
5008 || EQ (XCAR (spec
), Qright_fringe
))
5009 && CONSP (XCDR (spec
)))
5015 if (!FRAME_WINDOW_P (it
->f
))
5016 /* If we return here, POSITION has been advanced
5017 across the text with this property. */
5019 /* Synchronize the bidi iterator with POSITION. This is
5020 needed because we are not going to push the iterator
5021 on behalf of this display property, so there will be
5022 no pop_it call to do this synchronization for us. */
5025 it
->position
= *position
;
5026 iterate_out_of_display_property (it
);
5027 *position
= it
->position
;
5029 /* If we were to display this fringe bitmap,
5030 next_element_from_image would have reset this flag.
5031 Do the same, to avoid affecting overlays that
5033 it
->ignore_overlay_strings_at_pos_p
= 0;
5037 else if (!frame_window_p
)
5040 #ifdef HAVE_WINDOW_SYSTEM
5041 value
= XCAR (XCDR (spec
));
5042 if (!SYMBOLP (value
)
5043 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5044 /* If we return here, POSITION has been advanced
5045 across the text with this property. */
5047 if (it
&& it
->bidi_p
)
5049 it
->position
= *position
;
5050 iterate_out_of_display_property (it
);
5051 *position
= it
->position
;
5054 /* Reset this flag like next_element_from_image would. */
5055 it
->ignore_overlay_strings_at_pos_p
= 0;
5061 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5063 if (CONSP (XCDR (XCDR (spec
))))
5065 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5066 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5072 /* Save current settings of IT so that we can restore them
5073 when we are finished with the glyph property value. */
5074 push_it (it
, position
);
5076 it
->area
= TEXT_AREA
;
5077 it
->what
= IT_IMAGE
;
5078 it
->image_id
= -1; /* no image */
5079 it
->position
= start_pos
;
5080 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5081 it
->method
= GET_FROM_IMAGE
;
5082 it
->from_overlay
= Qnil
;
5083 it
->face_id
= face_id
;
5084 it
->from_disp_prop_p
= true;
5086 /* Say that we haven't consumed the characters with
5087 `display' property yet. The call to pop_it in
5088 set_iterator_to_next will clean this up. */
5089 *position
= start_pos
;
5091 if (EQ (XCAR (spec
), Qleft_fringe
))
5093 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5094 it
->left_user_fringe_face_id
= face_id
;
5098 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5099 it
->right_user_fringe_face_id
= face_id
;
5102 #endif /* HAVE_WINDOW_SYSTEM */
5106 /* Prepare to handle `((margin left-margin) ...)',
5107 `((margin right-margin) ...)' and `((margin nil) ...)'
5108 prefixes for display specifications. */
5109 location
= Qunbound
;
5110 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5114 value
= XCDR (spec
);
5116 value
= XCAR (value
);
5119 if (EQ (XCAR (tem
), Qmargin
)
5120 && (tem
= XCDR (tem
),
5121 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5123 || EQ (tem
, Qleft_margin
)
5124 || EQ (tem
, Qright_margin
))))
5128 if (EQ (location
, Qunbound
))
5134 /* After this point, VALUE is the property after any
5135 margin prefix has been stripped. It must be a string,
5136 an image specification, or `(space ...)'.
5138 LOCATION specifies where to display: `left-margin',
5139 `right-margin' or nil. */
5141 valid_p
= (STRINGP (value
)
5142 #ifdef HAVE_WINDOW_SYSTEM
5143 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5144 && valid_image_p (value
))
5145 #endif /* not HAVE_WINDOW_SYSTEM */
5146 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5147 #ifdef HAVE_XWIDGETS
5148 || valid_xwidget_spec_p(value
)
5152 if (valid_p
&& !display_replaced_p
)
5158 /* Callers need to know whether the display spec is any kind
5159 of `(space ...)' spec that is about to affect text-area
5161 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5166 /* Save current settings of IT so that we can restore them
5167 when we are finished with the glyph property value. */
5168 push_it (it
, position
);
5169 it
->from_overlay
= overlay
;
5170 it
->from_disp_prop_p
= true;
5172 if (NILP (location
))
5173 it
->area
= TEXT_AREA
;
5174 else if (EQ (location
, Qleft_margin
))
5175 it
->area
= LEFT_MARGIN_AREA
;
5177 it
->area
= RIGHT_MARGIN_AREA
;
5179 if (STRINGP (value
))
5182 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5183 it
->current
.overlay_string_index
= -1;
5184 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5185 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5186 it
->method
= GET_FROM_STRING
;
5187 it
->stop_charpos
= 0;
5189 it
->base_level_stop
= 0;
5190 it
->string_from_display_prop_p
= true;
5191 /* Say that we haven't consumed the characters with
5192 `display' property yet. The call to pop_it in
5193 set_iterator_to_next will clean this up. */
5194 if (BUFFERP (object
))
5195 *position
= start_pos
;
5197 /* Force paragraph direction to be that of the parent
5198 object. If the parent object's paragraph direction is
5199 not yet determined, default to L2R. */
5200 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5201 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5203 it
->paragraph_embedding
= L2R
;
5205 /* Set up the bidi iterator for this display string. */
5208 it
->bidi_it
.string
.lstring
= it
->string
;
5209 it
->bidi_it
.string
.s
= NULL
;
5210 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5211 it
->bidi_it
.string
.bufpos
= bufpos
;
5212 it
->bidi_it
.string
.from_disp_str
= 1;
5213 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5214 it
->bidi_it
.w
= it
->w
;
5215 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5218 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5220 it
->method
= GET_FROM_STRETCH
;
5222 *position
= it
->position
= start_pos
;
5223 retval
= 1 + (it
->area
== TEXT_AREA
);
5225 #ifdef HAVE_XWIDGETS
5226 else if (valid_xwidget_spec_p(value
))
5228 //printf("handle_single_display_spec: im an xwidget!!\n");
5229 it
->what
= IT_XWIDGET
;
5230 it
->method
= GET_FROM_XWIDGET
;
5231 it
->position
= start_pos
;
5232 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5233 *position
= start_pos
;
5235 it
->xwidget
= lookup_xwidget(value
);
5238 #ifdef HAVE_WINDOW_SYSTEM
5241 it
->what
= IT_IMAGE
;
5242 it
->image_id
= lookup_image (it
->f
, value
);
5243 it
->position
= start_pos
;
5244 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5245 it
->method
= GET_FROM_IMAGE
;
5247 /* Say that we haven't consumed the characters with
5248 `display' property yet. The call to pop_it in
5249 set_iterator_to_next will clean this up. */
5250 *position
= start_pos
;
5252 #endif /* HAVE_WINDOW_SYSTEM */
5257 /* Invalid property or property not supported. Restore
5258 POSITION to what it was before. */
5259 *position
= start_pos
;
5263 /* Check if PROP is a display property value whose text should be
5264 treated as intangible. OVERLAY is the overlay from which PROP
5265 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5266 specify the buffer position covered by PROP. */
5269 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5270 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5272 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5273 struct text_pos position
;
5275 SET_TEXT_POS (position
, charpos
, bytepos
);
5276 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5277 &position
, charpos
, frame_window_p
);
5281 /* Return 1 if PROP is a display sub-property value containing STRING.
5283 Implementation note: this and the following function are really
5284 special cases of handle_display_spec and
5285 handle_single_display_spec, and should ideally use the same code.
5286 Until they do, these two pairs must be consistent and must be
5287 modified in sync. */
5290 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5292 if (EQ (string
, prop
))
5295 /* Skip over `when FORM'. */
5296 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5301 /* Actually, the condition following `when' should be eval'ed,
5302 like handle_single_display_spec does, and we should return
5303 zero if it evaluates to nil. However, this function is
5304 called only when the buffer was already displayed and some
5305 glyph in the glyph matrix was found to come from a display
5306 string. Therefore, the condition was already evaluated, and
5307 the result was non-nil, otherwise the display string wouldn't
5308 have been displayed and we would have never been called for
5309 this property. Thus, we can skip the evaluation and assume
5310 its result is non-nil. */
5315 /* Skip over `margin LOCATION'. */
5316 if (EQ (XCAR (prop
), Qmargin
))
5327 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5331 /* Return 1 if STRING appears in the `display' property PROP. */
5334 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5337 && !EQ (XCAR (prop
), Qwhen
)
5338 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5340 /* A list of sub-properties. */
5341 while (CONSP (prop
))
5343 if (single_display_spec_string_p (XCAR (prop
), string
))
5348 else if (VECTORP (prop
))
5350 /* A vector of sub-properties. */
5352 for (i
= 0; i
< ASIZE (prop
); ++i
)
5353 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5357 return single_display_spec_string_p (prop
, string
);
5362 /* Look for STRING in overlays and text properties in the current
5363 buffer, between character positions FROM and TO (excluding TO).
5364 BACK_P non-zero means look back (in this case, TO is supposed to be
5366 Value is the first character position where STRING was found, or
5367 zero if it wasn't found before hitting TO.
5369 This function may only use code that doesn't eval because it is
5370 called asynchronously from note_mouse_highlight. */
5373 string_buffer_position_lim (Lisp_Object string
,
5374 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5376 Lisp_Object limit
, prop
, pos
;
5379 pos
= make_number (max (from
, BEGV
));
5381 if (!back_p
) /* looking forward */
5383 limit
= make_number (min (to
, ZV
));
5384 while (!found
&& !EQ (pos
, limit
))
5386 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5387 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5390 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5394 else /* looking back */
5396 limit
= make_number (max (to
, BEGV
));
5397 while (!found
&& !EQ (pos
, limit
))
5399 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5400 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5403 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5408 return found
? XINT (pos
) : 0;
5411 /* Determine which buffer position in current buffer STRING comes from.
5412 AROUND_CHARPOS is an approximate position where it could come from.
5413 Value is the buffer position or 0 if it couldn't be determined.
5415 This function is necessary because we don't record buffer positions
5416 in glyphs generated from strings (to keep struct glyph small).
5417 This function may only use code that doesn't eval because it is
5418 called asynchronously from note_mouse_highlight. */
5421 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5423 const int MAX_DISTANCE
= 1000;
5424 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5425 around_charpos
+ MAX_DISTANCE
,
5429 found
= string_buffer_position_lim (string
, around_charpos
,
5430 around_charpos
- MAX_DISTANCE
, 1);
5436 /***********************************************************************
5437 `composition' property
5438 ***********************************************************************/
5440 /* Set up iterator IT from `composition' property at its current
5441 position. Called from handle_stop. */
5443 static enum prop_handled
5444 handle_composition_prop (struct it
*it
)
5446 Lisp_Object prop
, string
;
5447 ptrdiff_t pos
, pos_byte
, start
, end
;
5449 if (STRINGP (it
->string
))
5453 pos
= IT_STRING_CHARPOS (*it
);
5454 pos_byte
= IT_STRING_BYTEPOS (*it
);
5455 string
= it
->string
;
5456 s
= SDATA (string
) + pos_byte
;
5457 it
->c
= STRING_CHAR (s
);
5461 pos
= IT_CHARPOS (*it
);
5462 pos_byte
= IT_BYTEPOS (*it
);
5464 it
->c
= FETCH_CHAR (pos_byte
);
5467 /* If there's a valid composition and point is not inside of the
5468 composition (in the case that the composition is from the current
5469 buffer), draw a glyph composed from the composition components. */
5470 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5471 && composition_valid_p (start
, end
, prop
)
5472 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5475 /* As we can't handle this situation (perhaps font-lock added
5476 a new composition), we just return here hoping that next
5477 redisplay will detect this composition much earlier. */
5478 return HANDLED_NORMALLY
;
5481 if (STRINGP (it
->string
))
5482 pos_byte
= string_char_to_byte (it
->string
, start
);
5484 pos_byte
= CHAR_TO_BYTE (start
);
5486 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5489 if (it
->cmp_it
.id
>= 0)
5492 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5493 it
->cmp_it
.nglyphs
= -1;
5497 return HANDLED_NORMALLY
;
5502 /***********************************************************************
5504 ***********************************************************************/
5506 /* The following structure is used to record overlay strings for
5507 later sorting in load_overlay_strings. */
5509 struct overlay_entry
5511 Lisp_Object overlay
;
5518 /* Set up iterator IT from overlay strings at its current position.
5519 Called from handle_stop. */
5521 static enum prop_handled
5522 handle_overlay_change (struct it
*it
)
5524 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5525 return HANDLED_RECOMPUTE_PROPS
;
5527 return HANDLED_NORMALLY
;
5531 /* Set up the next overlay string for delivery by IT, if there is an
5532 overlay string to deliver. Called by set_iterator_to_next when the
5533 end of the current overlay string is reached. If there are more
5534 overlay strings to display, IT->string and
5535 IT->current.overlay_string_index are set appropriately here.
5536 Otherwise IT->string is set to nil. */
5539 next_overlay_string (struct it
*it
)
5541 ++it
->current
.overlay_string_index
;
5542 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5544 /* No more overlay strings. Restore IT's settings to what
5545 they were before overlay strings were processed, and
5546 continue to deliver from current_buffer. */
5548 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5551 || (NILP (it
->string
)
5552 && it
->method
== GET_FROM_BUFFER
5553 && it
->stop_charpos
>= BEGV
5554 && it
->stop_charpos
<= it
->end_charpos
));
5555 it
->current
.overlay_string_index
= -1;
5556 it
->n_overlay_strings
= 0;
5557 it
->overlay_strings_charpos
= -1;
5558 /* If there's an empty display string on the stack, pop the
5559 stack, to resync the bidi iterator with IT's position. Such
5560 empty strings are pushed onto the stack in
5561 get_overlay_strings_1. */
5562 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5565 /* If we're at the end of the buffer, record that we have
5566 processed the overlay strings there already, so that
5567 next_element_from_buffer doesn't try it again. */
5568 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5569 it
->overlay_strings_at_end_processed_p
= true;
5573 /* There are more overlay strings to process. If
5574 IT->current.overlay_string_index has advanced to a position
5575 where we must load IT->overlay_strings with more strings, do
5576 it. We must load at the IT->overlay_strings_charpos where
5577 IT->n_overlay_strings was originally computed; when invisible
5578 text is present, this might not be IT_CHARPOS (Bug#7016). */
5579 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5581 if (it
->current
.overlay_string_index
&& i
== 0)
5582 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5584 /* Initialize IT to deliver display elements from the overlay
5586 it
->string
= it
->overlay_strings
[i
];
5587 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5588 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5589 it
->method
= GET_FROM_STRING
;
5590 it
->stop_charpos
= 0;
5591 it
->end_charpos
= SCHARS (it
->string
);
5592 if (it
->cmp_it
.stop_pos
>= 0)
5593 it
->cmp_it
.stop_pos
= 0;
5595 it
->base_level_stop
= 0;
5597 /* Set up the bidi iterator for this overlay string. */
5600 it
->bidi_it
.string
.lstring
= it
->string
;
5601 it
->bidi_it
.string
.s
= NULL
;
5602 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5603 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5604 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5605 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5606 it
->bidi_it
.w
= it
->w
;
5607 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5615 /* Compare two overlay_entry structures E1 and E2. Used as a
5616 comparison function for qsort in load_overlay_strings. Overlay
5617 strings for the same position are sorted so that
5619 1. All after-strings come in front of before-strings, except
5620 when they come from the same overlay.
5622 2. Within after-strings, strings are sorted so that overlay strings
5623 from overlays with higher priorities come first.
5625 2. Within before-strings, strings are sorted so that overlay
5626 strings from overlays with higher priorities come last.
5628 Value is analogous to strcmp. */
5632 compare_overlay_entries (const void *e1
, const void *e2
)
5634 struct overlay_entry
const *entry1
= e1
;
5635 struct overlay_entry
const *entry2
= e2
;
5638 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5640 /* Let after-strings appear in front of before-strings if
5641 they come from different overlays. */
5642 if (EQ (entry1
->overlay
, entry2
->overlay
))
5643 result
= entry1
->after_string_p
? 1 : -1;
5645 result
= entry1
->after_string_p
? -1 : 1;
5647 else if (entry1
->priority
!= entry2
->priority
)
5649 if (entry1
->after_string_p
)
5650 /* After-strings sorted in order of decreasing priority. */
5651 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5653 /* Before-strings sorted in order of increasing priority. */
5654 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5663 /* Load the vector IT->overlay_strings with overlay strings from IT's
5664 current buffer position, or from CHARPOS if that is > 0. Set
5665 IT->n_overlays to the total number of overlay strings found.
5667 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5668 a time. On entry into load_overlay_strings,
5669 IT->current.overlay_string_index gives the number of overlay
5670 strings that have already been loaded by previous calls to this
5673 IT->add_overlay_start contains an additional overlay start
5674 position to consider for taking overlay strings from, if non-zero.
5675 This position comes into play when the overlay has an `invisible'
5676 property, and both before and after-strings. When we've skipped to
5677 the end of the overlay, because of its `invisible' property, we
5678 nevertheless want its before-string to appear.
5679 IT->add_overlay_start will contain the overlay start position
5682 Overlay strings are sorted so that after-string strings come in
5683 front of before-string strings. Within before and after-strings,
5684 strings are sorted by overlay priority. See also function
5685 compare_overlay_entries. */
5688 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5690 Lisp_Object overlay
, window
, str
, invisible
;
5691 struct Lisp_Overlay
*ov
;
5692 ptrdiff_t start
, end
;
5693 ptrdiff_t n
= 0, i
, j
;
5695 struct overlay_entry entriesbuf
[20];
5696 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5697 struct overlay_entry
*entries
= entriesbuf
;
5701 charpos
= IT_CHARPOS (*it
);
5703 /* Append the overlay string STRING of overlay OVERLAY to vector
5704 `entries' which has size `size' and currently contains `n'
5705 elements. AFTER_P non-zero means STRING is an after-string of
5707 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5710 Lisp_Object priority; \
5714 struct overlay_entry *old = entries; \
5715 SAFE_NALLOCA (entries, 2, size); \
5716 memcpy (entries, old, size * sizeof *entries); \
5720 entries[n].string = (STRING); \
5721 entries[n].overlay = (OVERLAY); \
5722 priority = Foverlay_get ((OVERLAY), Qpriority); \
5723 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5724 entries[n].after_string_p = (AFTER_P); \
5729 /* Process overlay before the overlay center. */
5730 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5732 XSETMISC (overlay
, ov
);
5733 eassert (OVERLAYP (overlay
));
5734 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5735 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5740 /* Skip this overlay if it doesn't start or end at IT's current
5742 if (end
!= charpos
&& start
!= charpos
)
5745 /* Skip this overlay if it doesn't apply to IT->w. */
5746 window
= Foverlay_get (overlay
, Qwindow
);
5747 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5750 /* If the text ``under'' the overlay is invisible, both before-
5751 and after-strings from this overlay are visible; start and
5752 end position are indistinguishable. */
5753 invisible
= Foverlay_get (overlay
, Qinvisible
);
5754 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5756 /* If overlay has a non-empty before-string, record it. */
5757 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5758 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5760 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5762 /* If overlay has a non-empty after-string, record it. */
5763 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5764 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5766 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5769 /* Process overlays after the overlay center. */
5770 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5772 XSETMISC (overlay
, ov
);
5773 eassert (OVERLAYP (overlay
));
5774 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5775 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5777 if (start
> charpos
)
5780 /* Skip this overlay if it doesn't start or end at IT's current
5782 if (end
!= charpos
&& start
!= charpos
)
5785 /* Skip this overlay if it doesn't apply to IT->w. */
5786 window
= Foverlay_get (overlay
, Qwindow
);
5787 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5790 /* If the text ``under'' the overlay is invisible, it has a zero
5791 dimension, and both before- and after-strings apply. */
5792 invisible
= Foverlay_get (overlay
, Qinvisible
);
5793 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5795 /* If overlay has a non-empty before-string, record it. */
5796 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5797 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5799 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5801 /* If overlay has a non-empty after-string, record it. */
5802 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5803 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5805 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5808 #undef RECORD_OVERLAY_STRING
5812 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5814 /* Record number of overlay strings, and where we computed it. */
5815 it
->n_overlay_strings
= n
;
5816 it
->overlay_strings_charpos
= charpos
;
5818 /* IT->current.overlay_string_index is the number of overlay strings
5819 that have already been consumed by IT. Copy some of the
5820 remaining overlay strings to IT->overlay_strings. */
5822 j
= it
->current
.overlay_string_index
;
5823 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5825 it
->overlay_strings
[i
] = entries
[j
].string
;
5826 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5834 /* Get the first chunk of overlay strings at IT's current buffer
5835 position, or at CHARPOS if that is > 0. Value is non-zero if at
5836 least one overlay string was found. */
5839 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5841 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5842 process. This fills IT->overlay_strings with strings, and sets
5843 IT->n_overlay_strings to the total number of strings to process.
5844 IT->pos.overlay_string_index has to be set temporarily to zero
5845 because load_overlay_strings needs this; it must be set to -1
5846 when no overlay strings are found because a zero value would
5847 indicate a position in the first overlay string. */
5848 it
->current
.overlay_string_index
= 0;
5849 load_overlay_strings (it
, charpos
);
5851 /* If we found overlay strings, set up IT to deliver display
5852 elements from the first one. Otherwise set up IT to deliver
5853 from current_buffer. */
5854 if (it
->n_overlay_strings
)
5856 /* Make sure we know settings in current_buffer, so that we can
5857 restore meaningful values when we're done with the overlay
5860 compute_stop_pos (it
);
5861 eassert (it
->face_id
>= 0);
5863 /* Save IT's settings. They are restored after all overlay
5864 strings have been processed. */
5865 eassert (!compute_stop_p
|| it
->sp
== 0);
5867 /* When called from handle_stop, there might be an empty display
5868 string loaded. In that case, don't bother saving it. But
5869 don't use this optimization with the bidi iterator, since we
5870 need the corresponding pop_it call to resync the bidi
5871 iterator's position with IT's position, after we are done
5872 with the overlay strings. (The corresponding call to pop_it
5873 in case of an empty display string is in
5874 next_overlay_string.) */
5876 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5879 /* Set up IT to deliver display elements from the first overlay
5881 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5882 it
->string
= it
->overlay_strings
[0];
5883 it
->from_overlay
= Qnil
;
5884 it
->stop_charpos
= 0;
5885 eassert (STRINGP (it
->string
));
5886 it
->end_charpos
= SCHARS (it
->string
);
5888 it
->base_level_stop
= 0;
5889 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5890 it
->method
= GET_FROM_STRING
;
5891 it
->from_disp_prop_p
= 0;
5893 /* Force paragraph direction to be that of the parent
5895 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5896 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5898 it
->paragraph_embedding
= L2R
;
5900 /* Set up the bidi iterator for this overlay string. */
5903 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5905 it
->bidi_it
.string
.lstring
= it
->string
;
5906 it
->bidi_it
.string
.s
= NULL
;
5907 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5908 it
->bidi_it
.string
.bufpos
= pos
;
5909 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5910 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5911 it
->bidi_it
.w
= it
->w
;
5912 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5917 it
->current
.overlay_string_index
= -1;
5922 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5925 it
->method
= GET_FROM_BUFFER
;
5927 (void) get_overlay_strings_1 (it
, charpos
, 1);
5931 /* Value is non-zero if we found at least one overlay string. */
5932 return STRINGP (it
->string
);
5937 /***********************************************************************
5938 Saving and restoring state
5939 ***********************************************************************/
5941 /* Save current settings of IT on IT->stack. Called, for example,
5942 before setting up IT for an overlay string, to be able to restore
5943 IT's settings to what they were after the overlay string has been
5944 processed. If POSITION is non-NULL, it is the position to save on
5945 the stack instead of IT->position. */
5948 push_it (struct it
*it
, struct text_pos
*position
)
5950 struct iterator_stack_entry
*p
;
5952 eassert (it
->sp
< IT_STACK_SIZE
);
5953 p
= it
->stack
+ it
->sp
;
5955 p
->stop_charpos
= it
->stop_charpos
;
5956 p
->prev_stop
= it
->prev_stop
;
5957 p
->base_level_stop
= it
->base_level_stop
;
5958 p
->cmp_it
= it
->cmp_it
;
5959 eassert (it
->face_id
>= 0);
5960 p
->face_id
= it
->face_id
;
5961 p
->string
= it
->string
;
5962 p
->method
= it
->method
;
5963 p
->from_overlay
= it
->from_overlay
;
5966 case GET_FROM_IMAGE
:
5967 p
->u
.image
.object
= it
->object
;
5968 p
->u
.image
.image_id
= it
->image_id
;
5969 p
->u
.image
.slice
= it
->slice
;
5971 case GET_FROM_STRETCH
:
5972 p
->u
.stretch
.object
= it
->object
;
5974 #ifdef HAVE_XWIDGETS
5975 case GET_FROM_XWIDGET
:
5976 p
->u
.xwidget
.object
= it
->object
;
5980 p
->position
= position
? *position
: it
->position
;
5981 p
->current
= it
->current
;
5982 p
->end_charpos
= it
->end_charpos
;
5983 p
->string_nchars
= it
->string_nchars
;
5985 p
->multibyte_p
= it
->multibyte_p
;
5986 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5987 p
->space_width
= it
->space_width
;
5988 p
->font_height
= it
->font_height
;
5989 p
->voffset
= it
->voffset
;
5990 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5991 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5992 p
->display_ellipsis_p
= 0;
5993 p
->line_wrap
= it
->line_wrap
;
5994 p
->bidi_p
= it
->bidi_p
;
5995 p
->paragraph_embedding
= it
->paragraph_embedding
;
5996 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5999 /* Save the state of the bidi iterator as well. */
6001 bidi_push_it (&it
->bidi_it
);
6005 iterate_out_of_display_property (struct it
*it
)
6007 int buffer_p
= !STRINGP (it
->string
);
6008 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6009 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6011 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6013 /* Maybe initialize paragraph direction. If we are at the beginning
6014 of a new paragraph, next_element_from_buffer may not have a
6015 chance to do that. */
6016 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6017 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6018 /* prev_stop can be zero, so check against BEGV as well. */
6019 while (it
->bidi_it
.charpos
>= bob
6020 && it
->prev_stop
<= it
->bidi_it
.charpos
6021 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6022 && it
->bidi_it
.charpos
< eob
)
6023 bidi_move_to_visually_next (&it
->bidi_it
);
6024 /* Record the stop_pos we just crossed, for when we cross it
6026 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6027 it
->prev_stop
= CHARPOS (it
->position
);
6028 /* If we ended up not where pop_it put us, resync IT's
6029 positional members with the bidi iterator. */
6030 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6031 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6033 it
->current
.pos
= it
->position
;
6035 it
->current
.string_pos
= it
->position
;
6038 /* Restore IT's settings from IT->stack. Called, for example, when no
6039 more overlay strings must be processed, and we return to delivering
6040 display elements from a buffer, or when the end of a string from a
6041 `display' property is reached and we return to delivering display
6042 elements from an overlay string, or from a buffer. */
6045 pop_it (struct it
*it
)
6047 struct iterator_stack_entry
*p
;
6048 int from_display_prop
= it
->from_disp_prop_p
;
6050 eassert (it
->sp
> 0);
6052 p
= it
->stack
+ it
->sp
;
6053 it
->stop_charpos
= p
->stop_charpos
;
6054 it
->prev_stop
= p
->prev_stop
;
6055 it
->base_level_stop
= p
->base_level_stop
;
6056 it
->cmp_it
= p
->cmp_it
;
6057 it
->face_id
= p
->face_id
;
6058 it
->current
= p
->current
;
6059 it
->position
= p
->position
;
6060 it
->string
= p
->string
;
6061 it
->from_overlay
= p
->from_overlay
;
6062 if (NILP (it
->string
))
6063 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6064 it
->method
= p
->method
;
6067 case GET_FROM_IMAGE
:
6068 it
->image_id
= p
->u
.image
.image_id
;
6069 it
->object
= p
->u
.image
.object
;
6070 it
->slice
= p
->u
.image
.slice
;
6072 #ifdef HAVE_XWIDGETS
6073 case GET_FROM_XWIDGET
:
6074 it
->object
= p
->u
.xwidget
.object
;
6077 case GET_FROM_STRETCH
:
6078 it
->object
= p
->u
.stretch
.object
;
6080 case GET_FROM_BUFFER
:
6081 it
->object
= it
->w
->contents
;
6083 case GET_FROM_STRING
:
6085 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6087 /* Restore the face_box_p flag, since it could have been
6088 overwritten by the face of the object that we just finished
6091 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6092 it
->object
= it
->string
;
6095 case GET_FROM_DISPLAY_VECTOR
:
6097 it
->method
= GET_FROM_C_STRING
;
6098 else if (STRINGP (it
->string
))
6099 it
->method
= GET_FROM_STRING
;
6102 it
->method
= GET_FROM_BUFFER
;
6103 it
->object
= it
->w
->contents
;
6106 it
->end_charpos
= p
->end_charpos
;
6107 it
->string_nchars
= p
->string_nchars
;
6109 it
->multibyte_p
= p
->multibyte_p
;
6110 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6111 it
->space_width
= p
->space_width
;
6112 it
->font_height
= p
->font_height
;
6113 it
->voffset
= p
->voffset
;
6114 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6115 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6116 it
->line_wrap
= p
->line_wrap
;
6117 it
->bidi_p
= p
->bidi_p
;
6118 it
->paragraph_embedding
= p
->paragraph_embedding
;
6119 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6122 bidi_pop_it (&it
->bidi_it
);
6123 /* Bidi-iterate until we get out of the portion of text, if any,
6124 covered by a `display' text property or by an overlay with
6125 `display' property. (We cannot just jump there, because the
6126 internal coherency of the bidi iterator state can not be
6127 preserved across such jumps.) We also must determine the
6128 paragraph base direction if the overlay we just processed is
6129 at the beginning of a new paragraph. */
6130 if (from_display_prop
6131 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6132 iterate_out_of_display_property (it
);
6134 eassert ((BUFFERP (it
->object
)
6135 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6136 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6137 || (STRINGP (it
->object
)
6138 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6139 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6140 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6146 /***********************************************************************
6148 ***********************************************************************/
6150 /* Set IT's current position to the previous line start. */
6153 back_to_previous_line_start (struct it
*it
)
6155 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6158 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6162 /* Move IT to the next line start.
6164 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6165 we skipped over part of the text (as opposed to moving the iterator
6166 continuously over the text). Otherwise, don't change the value
6169 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6170 iterator on the newline, if it was found.
6172 Newlines may come from buffer text, overlay strings, or strings
6173 displayed via the `display' property. That's the reason we can't
6174 simply use find_newline_no_quit.
6176 Note that this function may not skip over invisible text that is so
6177 because of text properties and immediately follows a newline. If
6178 it would, function reseat_at_next_visible_line_start, when called
6179 from set_iterator_to_next, would effectively make invisible
6180 characters following a newline part of the wrong glyph row, which
6181 leads to wrong cursor motion. */
6184 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6185 struct bidi_it
*bidi_it_prev
)
6187 ptrdiff_t old_selective
;
6188 int newline_found_p
, n
;
6189 const int MAX_NEWLINE_DISTANCE
= 500;
6191 /* If already on a newline, just consume it to avoid unintended
6192 skipping over invisible text below. */
6193 if (it
->what
== IT_CHARACTER
6195 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6197 if (it
->bidi_p
&& bidi_it_prev
)
6198 *bidi_it_prev
= it
->bidi_it
;
6199 set_iterator_to_next (it
, 0);
6204 /* Don't handle selective display in the following. It's (a)
6205 unnecessary because it's done by the caller, and (b) leads to an
6206 infinite recursion because next_element_from_ellipsis indirectly
6207 calls this function. */
6208 old_selective
= it
->selective
;
6211 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6212 from buffer text. */
6213 for (n
= newline_found_p
= 0;
6214 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6215 n
+= STRINGP (it
->string
) ? 0 : 1)
6217 if (!get_next_display_element (it
))
6219 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6220 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6221 *bidi_it_prev
= it
->bidi_it
;
6222 set_iterator_to_next (it
, 0);
6225 /* If we didn't find a newline near enough, see if we can use a
6227 if (!newline_found_p
)
6229 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6230 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6234 eassert (!STRINGP (it
->string
));
6236 /* If there isn't any `display' property in sight, and no
6237 overlays, we can just use the position of the newline in
6239 if (it
->stop_charpos
>= limit
6240 || ((pos
= Fnext_single_property_change (make_number (start
),
6242 make_number (limit
)),
6244 && next_overlay_change (start
) == ZV
))
6248 IT_CHARPOS (*it
) = limit
;
6249 IT_BYTEPOS (*it
) = bytepos
;
6253 struct bidi_it bprev
;
6255 /* Help bidi.c avoid expensive searches for display
6256 properties and overlays, by telling it that there are
6257 none up to `limit'. */
6258 if (it
->bidi_it
.disp_pos
< limit
)
6260 it
->bidi_it
.disp_pos
= limit
;
6261 it
->bidi_it
.disp_prop
= 0;
6264 bprev
= it
->bidi_it
;
6265 bidi_move_to_visually_next (&it
->bidi_it
);
6266 } while (it
->bidi_it
.charpos
!= limit
);
6267 IT_CHARPOS (*it
) = limit
;
6268 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6270 *bidi_it_prev
= bprev
;
6272 *skipped_p
= newline_found_p
= true;
6276 while (get_next_display_element (it
)
6277 && !newline_found_p
)
6279 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6280 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6281 *bidi_it_prev
= it
->bidi_it
;
6282 set_iterator_to_next (it
, 0);
6287 it
->selective
= old_selective
;
6288 return newline_found_p
;
6292 /* Set IT's current position to the previous visible line start. Skip
6293 invisible text that is so either due to text properties or due to
6294 selective display. Caution: this does not change IT->current_x and
6298 back_to_previous_visible_line_start (struct it
*it
)
6300 while (IT_CHARPOS (*it
) > BEGV
)
6302 back_to_previous_line_start (it
);
6304 if (IT_CHARPOS (*it
) <= BEGV
)
6307 /* If selective > 0, then lines indented more than its value are
6309 if (it
->selective
> 0
6310 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6314 /* Check the newline before point for invisibility. */
6317 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6318 Qinvisible
, it
->window
);
6319 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6323 if (IT_CHARPOS (*it
) <= BEGV
)
6328 void *it2data
= NULL
;
6331 Lisp_Object val
, overlay
;
6333 SAVE_IT (it2
, *it
, it2data
);
6335 /* If newline is part of a composition, continue from start of composition */
6336 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6337 && beg
< IT_CHARPOS (*it
))
6340 /* If newline is replaced by a display property, find start of overlay
6341 or interval and continue search from that point. */
6342 pos
= --IT_CHARPOS (it2
);
6345 bidi_unshelve_cache (NULL
, 0);
6346 it2
.string_from_display_prop_p
= 0;
6347 it2
.from_disp_prop_p
= 0;
6348 if (handle_display_prop (&it2
) == HANDLED_RETURN
6349 && !NILP (val
= get_char_property_and_overlay
6350 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6351 && (OVERLAYP (overlay
)
6352 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6353 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6355 RESTORE_IT (it
, it
, it2data
);
6359 /* Newline is not replaced by anything -- so we are done. */
6360 RESTORE_IT (it
, it
, it2data
);
6366 IT_CHARPOS (*it
) = beg
;
6367 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6371 it
->continuation_lines_width
= 0;
6373 eassert (IT_CHARPOS (*it
) >= BEGV
);
6374 eassert (IT_CHARPOS (*it
) == BEGV
6375 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6380 /* Reseat iterator IT at the previous visible line start. Skip
6381 invisible text that is so either due to text properties or due to
6382 selective display. At the end, update IT's overlay information,
6383 face information etc. */
6386 reseat_at_previous_visible_line_start (struct it
*it
)
6388 back_to_previous_visible_line_start (it
);
6389 reseat (it
, it
->current
.pos
, 1);
6394 /* Reseat iterator IT on the next visible line start in the current
6395 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6396 preceding the line start. Skip over invisible text that is so
6397 because of selective display. Compute faces, overlays etc at the
6398 new position. Note that this function does not skip over text that
6399 is invisible because of text properties. */
6402 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6404 int newline_found_p
, skipped_p
= 0;
6405 struct bidi_it bidi_it_prev
;
6407 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6409 /* Skip over lines that are invisible because they are indented
6410 more than the value of IT->selective. */
6411 if (it
->selective
> 0)
6412 while (IT_CHARPOS (*it
) < ZV
6413 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6416 eassert (IT_BYTEPOS (*it
) == BEGV
6417 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6419 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6422 /* Position on the newline if that's what's requested. */
6423 if (on_newline_p
&& newline_found_p
)
6425 if (STRINGP (it
->string
))
6427 if (IT_STRING_CHARPOS (*it
) > 0)
6431 --IT_STRING_CHARPOS (*it
);
6432 --IT_STRING_BYTEPOS (*it
);
6436 /* We need to restore the bidi iterator to the state
6437 it had on the newline, and resync the IT's
6438 position with that. */
6439 it
->bidi_it
= bidi_it_prev
;
6440 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6441 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6445 else if (IT_CHARPOS (*it
) > BEGV
)
6454 /* We need to restore the bidi iterator to the state it
6455 had on the newline and resync IT with that. */
6456 it
->bidi_it
= bidi_it_prev
;
6457 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6458 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6460 reseat (it
, it
->current
.pos
, 0);
6464 reseat (it
, it
->current
.pos
, 0);
6471 /***********************************************************************
6472 Changing an iterator's position
6473 ***********************************************************************/
6475 /* Change IT's current position to POS in current_buffer. If FORCE_P
6476 is non-zero, always check for text properties at the new position.
6477 Otherwise, text properties are only looked up if POS >=
6478 IT->check_charpos of a property. */
6481 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6483 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6485 reseat_1 (it
, pos
, 0);
6487 /* Determine where to check text properties. Avoid doing it
6488 where possible because text property lookup is very expensive. */
6490 || CHARPOS (pos
) > it
->stop_charpos
6491 || CHARPOS (pos
) < original_pos
)
6495 /* For bidi iteration, we need to prime prev_stop and
6496 base_level_stop with our best estimations. */
6497 /* Implementation note: Of course, POS is not necessarily a
6498 stop position, so assigning prev_pos to it is a lie; we
6499 should have called compute_stop_backwards. However, if
6500 the current buffer does not include any R2L characters,
6501 that call would be a waste of cycles, because the
6502 iterator will never move back, and thus never cross this
6503 "fake" stop position. So we delay that backward search
6504 until the time we really need it, in next_element_from_buffer. */
6505 if (CHARPOS (pos
) != it
->prev_stop
)
6506 it
->prev_stop
= CHARPOS (pos
);
6507 if (CHARPOS (pos
) < it
->base_level_stop
)
6508 it
->base_level_stop
= 0; /* meaning it's unknown */
6514 it
->prev_stop
= it
->base_level_stop
= 0;
6523 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6524 IT->stop_pos to POS, also. */
6527 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6529 /* Don't call this function when scanning a C string. */
6530 eassert (it
->s
== NULL
);
6532 /* POS must be a reasonable value. */
6533 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6535 it
->current
.pos
= it
->position
= pos
;
6536 it
->end_charpos
= ZV
;
6538 it
->current
.dpvec_index
= -1;
6539 it
->current
.overlay_string_index
= -1;
6540 IT_STRING_CHARPOS (*it
) = -1;
6541 IT_STRING_BYTEPOS (*it
) = -1;
6543 it
->method
= GET_FROM_BUFFER
;
6544 it
->object
= it
->w
->contents
;
6545 it
->area
= TEXT_AREA
;
6546 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6548 it
->string_from_display_prop_p
= 0;
6549 it
->string_from_prefix_prop_p
= 0;
6551 it
->from_disp_prop_p
= 0;
6552 it
->face_before_selective_p
= 0;
6555 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6557 bidi_unshelve_cache (NULL
, 0);
6558 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6559 it
->bidi_it
.string
.s
= NULL
;
6560 it
->bidi_it
.string
.lstring
= Qnil
;
6561 it
->bidi_it
.string
.bufpos
= 0;
6562 it
->bidi_it
.string
.from_disp_str
= 0;
6563 it
->bidi_it
.string
.unibyte
= 0;
6564 it
->bidi_it
.w
= it
->w
;
6569 it
->stop_charpos
= CHARPOS (pos
);
6570 it
->base_level_stop
= CHARPOS (pos
);
6572 /* This make the information stored in it->cmp_it invalidate. */
6577 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6578 If S is non-null, it is a C string to iterate over. Otherwise,
6579 STRING gives a Lisp string to iterate over.
6581 If PRECISION > 0, don't return more then PRECISION number of
6582 characters from the string.
6584 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6585 characters have been returned. FIELD_WIDTH < 0 means an infinite
6588 MULTIBYTE = 0 means disable processing of multibyte characters,
6589 MULTIBYTE > 0 means enable it,
6590 MULTIBYTE < 0 means use IT->multibyte_p.
6592 IT must be initialized via a prior call to init_iterator before
6593 calling this function. */
6596 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6597 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6600 /* No text property checks performed by default, but see below. */
6601 it
->stop_charpos
= -1;
6603 /* Set iterator position and end position. */
6604 memset (&it
->current
, 0, sizeof it
->current
);
6605 it
->current
.overlay_string_index
= -1;
6606 it
->current
.dpvec_index
= -1;
6607 eassert (charpos
>= 0);
6609 /* If STRING is specified, use its multibyteness, otherwise use the
6610 setting of MULTIBYTE, if specified. */
6612 it
->multibyte_p
= multibyte
> 0;
6614 /* Bidirectional reordering of strings is controlled by the default
6615 value of bidi-display-reordering. Don't try to reorder while
6616 loading loadup.el, as the necessary character property tables are
6617 not yet available. */
6620 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6624 eassert (STRINGP (string
));
6625 it
->string
= string
;
6627 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6628 it
->method
= GET_FROM_STRING
;
6629 it
->current
.string_pos
= string_pos (charpos
, string
);
6633 it
->bidi_it
.string
.lstring
= string
;
6634 it
->bidi_it
.string
.s
= NULL
;
6635 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6636 it
->bidi_it
.string
.bufpos
= 0;
6637 it
->bidi_it
.string
.from_disp_str
= 0;
6638 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6639 it
->bidi_it
.w
= it
->w
;
6640 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6641 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6646 it
->s
= (const unsigned char *) s
;
6649 /* Note that we use IT->current.pos, not it->current.string_pos,
6650 for displaying C strings. */
6651 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6652 if (it
->multibyte_p
)
6654 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6655 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6659 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6660 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6665 it
->bidi_it
.string
.lstring
= Qnil
;
6666 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6667 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6668 it
->bidi_it
.string
.bufpos
= 0;
6669 it
->bidi_it
.string
.from_disp_str
= 0;
6670 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6671 it
->bidi_it
.w
= it
->w
;
6672 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6675 it
->method
= GET_FROM_C_STRING
;
6678 /* PRECISION > 0 means don't return more than PRECISION characters
6680 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6682 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6684 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6687 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6688 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6689 FIELD_WIDTH < 0 means infinite field width. This is useful for
6690 padding with `-' at the end of a mode line. */
6691 if (field_width
< 0)
6692 field_width
= INFINITY
;
6693 /* Implementation note: We deliberately don't enlarge
6694 it->bidi_it.string.schars here to fit it->end_charpos, because
6695 the bidi iterator cannot produce characters out of thin air. */
6696 if (field_width
> it
->end_charpos
- charpos
)
6697 it
->end_charpos
= charpos
+ field_width
;
6699 /* Use the standard display table for displaying strings. */
6700 if (DISP_TABLE_P (Vstandard_display_table
))
6701 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6703 it
->stop_charpos
= charpos
;
6704 it
->prev_stop
= charpos
;
6705 it
->base_level_stop
= 0;
6708 it
->bidi_it
.first_elt
= 1;
6709 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6710 it
->bidi_it
.disp_pos
= -1;
6712 if (s
== NULL
&& it
->multibyte_p
)
6714 ptrdiff_t endpos
= SCHARS (it
->string
);
6715 if (endpos
> it
->end_charpos
)
6716 endpos
= it
->end_charpos
;
6717 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6725 /***********************************************************************
6727 ***********************************************************************/
6729 /* Map enum it_method value to corresponding next_element_from_* function. */
6731 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6733 next_element_from_buffer
,
6734 next_element_from_display_vector
,
6735 next_element_from_string
,
6736 next_element_from_c_string
,
6737 next_element_from_image
,
6738 next_element_from_stretch
6739 #ifdef HAVE_XWIDGETS
6740 ,next_element_from_xwidget
6744 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6747 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6748 (possibly with the following characters). */
6750 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6751 ((IT)->cmp_it.id >= 0 \
6752 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6753 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6754 END_CHARPOS, (IT)->w, \
6755 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6759 /* Lookup the char-table Vglyphless_char_display for character C (-1
6760 if we want information for no-font case), and return the display
6761 method symbol. By side-effect, update it->what and
6762 it->glyphless_method. This function is called from
6763 get_next_display_element for each character element, and from
6764 x_produce_glyphs when no suitable font was found. */
6767 lookup_glyphless_char_display (int c
, struct it
*it
)
6769 Lisp_Object glyphless_method
= Qnil
;
6771 if (CHAR_TABLE_P (Vglyphless_char_display
)
6772 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6776 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6777 if (CONSP (glyphless_method
))
6778 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6779 ? XCAR (glyphless_method
)
6780 : XCDR (glyphless_method
);
6783 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6787 if (NILP (glyphless_method
))
6790 /* The default is to display the character by a proper font. */
6792 /* The default for the no-font case is to display an empty box. */
6793 glyphless_method
= Qempty_box
;
6795 if (EQ (glyphless_method
, Qzero_width
))
6798 return glyphless_method
;
6799 /* This method can't be used for the no-font case. */
6800 glyphless_method
= Qempty_box
;
6802 if (EQ (glyphless_method
, Qthin_space
))
6803 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6804 else if (EQ (glyphless_method
, Qempty_box
))
6805 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6806 else if (EQ (glyphless_method
, Qhex_code
))
6807 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6808 else if (STRINGP (glyphless_method
))
6809 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6812 /* Invalid value. We use the default method. */
6813 glyphless_method
= Qnil
;
6816 it
->what
= IT_GLYPHLESS
;
6817 return glyphless_method
;
6820 /* Merge escape glyph face and cache the result. */
6822 static struct frame
*last_escape_glyph_frame
= NULL
;
6823 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6824 static int last_escape_glyph_merged_face_id
= 0;
6827 merge_escape_glyph_face (struct it
*it
)
6831 if (it
->f
== last_escape_glyph_frame
6832 && it
->face_id
== last_escape_glyph_face_id
)
6833 face_id
= last_escape_glyph_merged_face_id
;
6836 /* Merge the `escape-glyph' face into the current face. */
6837 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6838 last_escape_glyph_frame
= it
->f
;
6839 last_escape_glyph_face_id
= it
->face_id
;
6840 last_escape_glyph_merged_face_id
= face_id
;
6845 /* Likewise for glyphless glyph face. */
6847 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6848 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6849 static int last_glyphless_glyph_merged_face_id
= 0;
6852 merge_glyphless_glyph_face (struct it
*it
)
6856 if (it
->f
== last_glyphless_glyph_frame
6857 && it
->face_id
== last_glyphless_glyph_face_id
)
6858 face_id
= last_glyphless_glyph_merged_face_id
;
6861 /* Merge the `glyphless-char' face into the current face. */
6862 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6863 last_glyphless_glyph_frame
= it
->f
;
6864 last_glyphless_glyph_face_id
= it
->face_id
;
6865 last_glyphless_glyph_merged_face_id
= face_id
;
6870 /* Load IT's display element fields with information about the next
6871 display element from the current position of IT. Value is zero if
6872 end of buffer (or C string) is reached. */
6875 get_next_display_element (struct it
*it
)
6877 /* Non-zero means that we found a display element. Zero means that
6878 we hit the end of what we iterate over. Performance note: the
6879 function pointer `method' used here turns out to be faster than
6880 using a sequence of if-statements. */
6884 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6886 if (it
->what
== IT_CHARACTER
)
6888 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6889 and only if (a) the resolved directionality of that character
6891 /* FIXME: Do we need an exception for characters from display
6893 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6894 && !inhibit_bidi_mirroring
)
6895 it
->c
= bidi_mirror_char (it
->c
);
6896 /* Map via display table or translate control characters.
6897 IT->c, IT->len etc. have been set to the next character by
6898 the function call above. If we have a display table, and it
6899 contains an entry for IT->c, translate it. Don't do this if
6900 IT->c itself comes from a display table, otherwise we could
6901 end up in an infinite recursion. (An alternative could be to
6902 count the recursion depth of this function and signal an
6903 error when a certain maximum depth is reached.) Is it worth
6905 if (success_p
&& it
->dpvec
== NULL
)
6908 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6909 int nonascii_space_p
= 0;
6910 int nonascii_hyphen_p
= 0;
6911 int c
= it
->c
; /* This is the character to display. */
6913 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6915 eassert (SINGLE_BYTE_CHAR_P (c
));
6916 if (unibyte_display_via_language_environment
)
6918 c
= DECODE_CHAR (unibyte
, c
);
6920 c
= BYTE8_TO_CHAR (it
->c
);
6923 c
= BYTE8_TO_CHAR (it
->c
);
6927 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6930 struct Lisp_Vector
*v
= XVECTOR (dv
);
6932 /* Return the first character from the display table
6933 entry, if not empty. If empty, don't display the
6934 current character. */
6937 it
->dpvec_char_len
= it
->len
;
6938 it
->dpvec
= v
->contents
;
6939 it
->dpend
= v
->contents
+ v
->header
.size
;
6940 it
->current
.dpvec_index
= 0;
6941 it
->dpvec_face_id
= -1;
6942 it
->saved_face_id
= it
->face_id
;
6943 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6948 set_iterator_to_next (it
, 0);
6953 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6955 if (it
->what
== IT_GLYPHLESS
)
6957 /* Don't display this character. */
6958 set_iterator_to_next (it
, 0);
6962 /* If `nobreak-char-display' is non-nil, we display
6963 non-ASCII spaces and hyphens specially. */
6964 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6967 nonascii_space_p
= true;
6968 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6969 nonascii_hyphen_p
= true;
6972 /* Translate control characters into `\003' or `^C' form.
6973 Control characters coming from a display table entry are
6974 currently not translated because we use IT->dpvec to hold
6975 the translation. This could easily be changed but I
6976 don't believe that it is worth doing.
6978 The characters handled by `nobreak-char-display' must be
6981 Non-printable characters and raw-byte characters are also
6982 translated to octal form. */
6983 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6984 ? (it
->area
!= TEXT_AREA
6985 /* In mode line, treat \n, \t like other crl chars. */
6988 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6989 || (c
!= '\n' && c
!= '\t'))
6991 || nonascii_hyphen_p
6993 || ! CHAR_PRINTABLE_P (c
))))
6995 /* C is a control character, non-ASCII space/hyphen,
6996 raw-byte, or a non-printable character which must be
6997 displayed either as '\003' or as `^C' where the '\\'
6998 and '^' can be defined in the display table. Fill
6999 IT->ctl_chars with glyphs for what we have to
7000 display. Then, set IT->dpvec to these glyphs. */
7007 /* Handle control characters with ^. */
7009 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7013 g
= '^'; /* default glyph for Control */
7014 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7016 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7018 g
= GLYPH_CODE_CHAR (gc
);
7019 lface_id
= GLYPH_CODE_FACE (gc
);
7023 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7024 : merge_escape_glyph_face (it
));
7026 XSETINT (it
->ctl_chars
[0], g
);
7027 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7029 goto display_control
;
7032 /* Handle non-ascii space in the mode where it only gets
7035 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7037 /* Merge `nobreak-space' into the current face. */
7038 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7040 XSETINT (it
->ctl_chars
[0], ' ');
7042 goto display_control
;
7045 /* Handle sequences that start with the "escape glyph". */
7047 /* the default escape glyph is \. */
7048 escape_glyph
= '\\';
7051 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7053 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7054 lface_id
= GLYPH_CODE_FACE (gc
);
7058 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7059 : merge_escape_glyph_face (it
));
7061 /* Draw non-ASCII hyphen with just highlighting: */
7063 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7065 XSETINT (it
->ctl_chars
[0], '-');
7067 goto display_control
;
7070 /* Draw non-ASCII space/hyphen with escape glyph: */
7072 if (nonascii_space_p
|| nonascii_hyphen_p
)
7074 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7075 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7077 goto display_control
;
7084 if (CHAR_BYTE8_P (c
))
7085 /* Display \200 instead of \17777600. */
7086 c
= CHAR_TO_BYTE8 (c
);
7087 len
= sprintf (str
, "%03o", c
);
7089 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7090 for (i
= 0; i
< len
; i
++)
7091 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7096 /* Set up IT->dpvec and return first character from it. */
7097 it
->dpvec_char_len
= it
->len
;
7098 it
->dpvec
= it
->ctl_chars
;
7099 it
->dpend
= it
->dpvec
+ ctl_len
;
7100 it
->current
.dpvec_index
= 0;
7101 it
->dpvec_face_id
= face_id
;
7102 it
->saved_face_id
= it
->face_id
;
7103 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7107 it
->char_to_display
= c
;
7111 it
->char_to_display
= it
->c
;
7115 #ifdef HAVE_WINDOW_SYSTEM
7116 /* Adjust face id for a multibyte character. There are no multibyte
7117 character in unibyte text. */
7118 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7121 && FRAME_WINDOW_P (it
->f
))
7123 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7125 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7127 /* Automatic composition with glyph-string. */
7128 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7130 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7134 ptrdiff_t pos
= (it
->s
? -1
7135 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7136 : IT_CHARPOS (*it
));
7139 if (it
->what
== IT_CHARACTER
)
7140 c
= it
->char_to_display
;
7143 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7147 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7148 /* TAB in a composition means display glyphs with
7149 padding space on the left or right. */
7150 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7153 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7156 #endif /* HAVE_WINDOW_SYSTEM */
7159 /* Is this character the last one of a run of characters with
7160 box? If yes, set IT->end_of_box_run_p to 1. */
7164 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7166 int face_id
= underlying_face_id (it
);
7167 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7171 if (face
->box
== FACE_NO_BOX
)
7173 /* If the box comes from face properties in a
7174 display string, check faces in that string. */
7175 int string_face_id
= face_after_it_pos (it
);
7176 it
->end_of_box_run_p
7177 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7180 /* Otherwise, the box comes from the underlying face.
7181 If this is the last string character displayed, check
7182 the next buffer location. */
7183 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7184 /* n_overlay_strings is unreliable unless
7185 overlay_string_index is non-negative. */
7186 && ((it
->current
.overlay_string_index
>= 0
7187 && (it
->current
.overlay_string_index
7188 == it
->n_overlay_strings
- 1))
7189 /* A string from display property. */
7190 || it
->from_disp_prop_p
))
7194 struct text_pos pos
= it
->current
.pos
;
7196 /* For a string from a display property, the next
7197 buffer position is stored in the 'position'
7198 member of the iteration stack slot below the
7199 current one, see handle_single_display_spec. By
7200 contrast, it->current.pos was is not yet updated
7201 to point to that buffer position; that will
7202 happen in pop_it, after we finish displaying the
7203 current string. Note that we already checked
7204 above that it->sp is positive, so subtracting one
7206 if (it
->from_disp_prop_p
)
7207 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7209 INC_TEXT_POS (pos
, it
->multibyte_p
);
7211 if (CHARPOS (pos
) >= ZV
)
7212 it
->end_of_box_run_p
= true;
7215 next_face_id
= face_at_buffer_position
7216 (it
->w
, CHARPOS (pos
), &ignore
,
7217 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7218 it
->end_of_box_run_p
7219 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7225 /* next_element_from_display_vector sets this flag according to
7226 faces of the display vector glyphs, see there. */
7227 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7229 int face_id
= face_after_it_pos (it
);
7230 it
->end_of_box_run_p
7231 = (face_id
!= it
->face_id
7232 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7235 /* If we reached the end of the object we've been iterating (e.g., a
7236 display string or an overlay string), and there's something on
7237 IT->stack, proceed with what's on the stack. It doesn't make
7238 sense to return zero if there's unprocessed stuff on the stack,
7239 because otherwise that stuff will never be displayed. */
7240 if (!success_p
&& it
->sp
> 0)
7242 set_iterator_to_next (it
, 0);
7243 success_p
= get_next_display_element (it
);
7246 /* Value is 0 if end of buffer or string reached. */
7251 /* Move IT to the next display element.
7253 RESEAT_P non-zero means if called on a newline in buffer text,
7254 skip to the next visible line start.
7256 Functions get_next_display_element and set_iterator_to_next are
7257 separate because I find this arrangement easier to handle than a
7258 get_next_display_element function that also increments IT's
7259 position. The way it is we can first look at an iterator's current
7260 display element, decide whether it fits on a line, and if it does,
7261 increment the iterator position. The other way around we probably
7262 would either need a flag indicating whether the iterator has to be
7263 incremented the next time, or we would have to implement a
7264 decrement position function which would not be easy to write. */
7267 set_iterator_to_next (struct it
*it
, int reseat_p
)
7269 /* Reset flags indicating start and end of a sequence of characters
7270 with box. Reset them at the start of this function because
7271 moving the iterator to a new position might set them. */
7272 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7276 case GET_FROM_BUFFER
:
7277 /* The current display element of IT is a character from
7278 current_buffer. Advance in the buffer, and maybe skip over
7279 invisible lines that are so because of selective display. */
7280 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7281 reseat_at_next_visible_line_start (it
, 0);
7282 else if (it
->cmp_it
.id
>= 0)
7284 /* We are currently getting glyphs from a composition. */
7287 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7288 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7294 /* Update IT's char/byte positions to point to the first
7295 character of the next grapheme cluster, or to the
7296 character visually after the current composition. */
7297 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7298 bidi_move_to_visually_next (&it
->bidi_it
);
7299 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7300 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7303 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7304 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7306 /* Composition created while scanning forward. Proceed
7307 to the next grapheme cluster. */
7308 it
->cmp_it
.from
= it
->cmp_it
.to
;
7310 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7311 && it
->cmp_it
.from
> 0)
7313 /* Composition created while scanning backward. Proceed
7314 to the previous grapheme cluster. */
7315 it
->cmp_it
.to
= it
->cmp_it
.from
;
7319 /* No more grapheme clusters in this composition.
7320 Find the next stop position. */
7321 ptrdiff_t stop
= it
->end_charpos
;
7323 if (it
->bidi_it
.scan_dir
< 0)
7324 /* Now we are scanning backward and don't know
7327 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7328 IT_BYTEPOS (*it
), stop
, Qnil
);
7333 eassert (it
->len
!= 0);
7337 IT_BYTEPOS (*it
) += it
->len
;
7338 IT_CHARPOS (*it
) += 1;
7342 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7343 /* If this is a new paragraph, determine its base
7344 direction (a.k.a. its base embedding level). */
7345 if (it
->bidi_it
.new_paragraph
)
7346 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7347 bidi_move_to_visually_next (&it
->bidi_it
);
7348 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7349 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7350 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7352 /* As the scan direction was changed, we must
7353 re-compute the stop position for composition. */
7354 ptrdiff_t stop
= it
->end_charpos
;
7355 if (it
->bidi_it
.scan_dir
< 0)
7357 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7358 IT_BYTEPOS (*it
), stop
, Qnil
);
7361 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7365 case GET_FROM_C_STRING
:
7366 /* Current display element of IT is from a C string. */
7368 /* If the string position is beyond string's end, it means
7369 next_element_from_c_string is padding the string with
7370 blanks, in which case we bypass the bidi iterator,
7371 because it cannot deal with such virtual characters. */
7372 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7374 IT_BYTEPOS (*it
) += it
->len
;
7375 IT_CHARPOS (*it
) += 1;
7379 bidi_move_to_visually_next (&it
->bidi_it
);
7380 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7381 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7385 case GET_FROM_DISPLAY_VECTOR
:
7386 /* Current display element of IT is from a display table entry.
7387 Advance in the display table definition. Reset it to null if
7388 end reached, and continue with characters from buffers/
7390 ++it
->current
.dpvec_index
;
7392 /* Restore face of the iterator to what they were before the
7393 display vector entry (these entries may contain faces). */
7394 it
->face_id
= it
->saved_face_id
;
7396 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7398 int recheck_faces
= it
->ellipsis_p
;
7401 it
->method
= GET_FROM_C_STRING
;
7402 else if (STRINGP (it
->string
))
7403 it
->method
= GET_FROM_STRING
;
7406 it
->method
= GET_FROM_BUFFER
;
7407 it
->object
= it
->w
->contents
;
7411 it
->current
.dpvec_index
= -1;
7413 /* Skip over characters which were displayed via IT->dpvec. */
7414 if (it
->dpvec_char_len
< 0)
7415 reseat_at_next_visible_line_start (it
, 1);
7416 else if (it
->dpvec_char_len
> 0)
7418 if (it
->method
== GET_FROM_STRING
7419 && it
->current
.overlay_string_index
>= 0
7420 && it
->n_overlay_strings
> 0)
7421 it
->ignore_overlay_strings_at_pos_p
= true;
7422 it
->len
= it
->dpvec_char_len
;
7423 set_iterator_to_next (it
, reseat_p
);
7426 /* Maybe recheck faces after display vector. */
7428 it
->stop_charpos
= IT_CHARPOS (*it
);
7432 case GET_FROM_STRING
:
7433 /* Current display element is a character from a Lisp string. */
7434 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7435 /* Don't advance past string end. These conditions are true
7436 when set_iterator_to_next is called at the end of
7437 get_next_display_element, in which case the Lisp string is
7438 already exhausted, and all we want is pop the iterator
7440 if (it
->current
.overlay_string_index
>= 0)
7442 /* This is an overlay string, so there's no padding with
7443 spaces, and the number of characters in the string is
7444 where the string ends. */
7445 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7446 goto consider_string_end
;
7450 /* Not an overlay string. There could be padding, so test
7451 against it->end_charpos. */
7452 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7453 goto consider_string_end
;
7455 if (it
->cmp_it
.id
>= 0)
7457 /* We are delivering display elements from a composition.
7458 Update the string position past the grapheme cluster
7459 we've just processed. */
7462 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7463 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7469 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7470 bidi_move_to_visually_next (&it
->bidi_it
);
7471 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7472 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7475 /* Did we exhaust all the grapheme clusters of this
7477 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7478 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7480 /* Not all the grapheme clusters were processed yet;
7481 advance to the next cluster. */
7482 it
->cmp_it
.from
= it
->cmp_it
.to
;
7484 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7485 && it
->cmp_it
.from
> 0)
7487 /* Likewise: advance to the next cluster, but going in
7488 the reverse direction. */
7489 it
->cmp_it
.to
= it
->cmp_it
.from
;
7493 /* This composition was fully processed; find the next
7494 candidate place for checking for composed
7496 /* Always limit string searches to the string length;
7497 any padding spaces are not part of the string, and
7498 there cannot be any compositions in that padding. */
7499 ptrdiff_t stop
= SCHARS (it
->string
);
7501 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7503 else if (it
->end_charpos
< stop
)
7505 /* Cf. PRECISION in reseat_to_string: we might be
7506 limited in how many of the string characters we
7508 stop
= it
->end_charpos
;
7510 composition_compute_stop_pos (&it
->cmp_it
,
7511 IT_STRING_CHARPOS (*it
),
7512 IT_STRING_BYTEPOS (*it
), stop
,
7519 /* If the string position is beyond string's end, it
7520 means next_element_from_string is padding the string
7521 with blanks, in which case we bypass the bidi
7522 iterator, because it cannot deal with such virtual
7524 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7526 IT_STRING_BYTEPOS (*it
) += it
->len
;
7527 IT_STRING_CHARPOS (*it
) += 1;
7531 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7533 bidi_move_to_visually_next (&it
->bidi_it
);
7534 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7535 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7536 /* If the scan direction changes, we may need to update
7537 the place where to check for composed characters. */
7538 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7540 ptrdiff_t stop
= SCHARS (it
->string
);
7542 if (it
->bidi_it
.scan_dir
< 0)
7544 else if (it
->end_charpos
< stop
)
7545 stop
= it
->end_charpos
;
7547 composition_compute_stop_pos (&it
->cmp_it
,
7548 IT_STRING_CHARPOS (*it
),
7549 IT_STRING_BYTEPOS (*it
), stop
,
7555 consider_string_end
:
7557 if (it
->current
.overlay_string_index
>= 0)
7559 /* IT->string is an overlay string. Advance to the
7560 next, if there is one. */
7561 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7564 next_overlay_string (it
);
7566 setup_for_ellipsis (it
, 0);
7571 /* IT->string is not an overlay string. If we reached
7572 its end, and there is something on IT->stack, proceed
7573 with what is on the stack. This can be either another
7574 string, this time an overlay string, or a buffer. */
7575 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7579 if (it
->method
== GET_FROM_STRING
)
7580 goto consider_string_end
;
7585 case GET_FROM_IMAGE
:
7586 case GET_FROM_STRETCH
:
7587 #ifdef HAVE_XWIDGETS
7588 case GET_FROM_XWIDGET
:
7591 /* The position etc with which we have to proceed are on
7592 the stack. The position may be at the end of a string,
7593 if the `display' property takes up the whole string. */
7594 eassert (it
->sp
> 0);
7596 if (it
->method
== GET_FROM_STRING
)
7597 goto consider_string_end
;
7601 /* There are no other methods defined, so this should be a bug. */
7605 eassert (it
->method
!= GET_FROM_STRING
7606 || (STRINGP (it
->string
)
7607 && IT_STRING_CHARPOS (*it
) >= 0));
7610 /* Load IT's display element fields with information about the next
7611 display element which comes from a display table entry or from the
7612 result of translating a control character to one of the forms `^C'
7615 IT->dpvec holds the glyphs to return as characters.
7616 IT->saved_face_id holds the face id before the display vector--it
7617 is restored into IT->face_id in set_iterator_to_next. */
7620 next_element_from_display_vector (struct it
*it
)
7623 int prev_face_id
= it
->face_id
;
7627 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7629 it
->face_id
= it
->saved_face_id
;
7631 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7632 That seemed totally bogus - so I changed it... */
7633 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7635 if (GLYPH_CODE_P (gc
))
7637 struct face
*this_face
, *prev_face
, *next_face
;
7639 it
->c
= GLYPH_CODE_CHAR (gc
);
7640 it
->len
= CHAR_BYTES (it
->c
);
7642 /* The entry may contain a face id to use. Such a face id is
7643 the id of a Lisp face, not a realized face. A face id of
7644 zero means no face is specified. */
7645 if (it
->dpvec_face_id
>= 0)
7646 it
->face_id
= it
->dpvec_face_id
;
7649 int lface_id
= GLYPH_CODE_FACE (gc
);
7651 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7655 /* Glyphs in the display vector could have the box face, so we
7656 need to set the related flags in the iterator, as
7658 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7659 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7661 /* Is this character the first character of a box-face run? */
7662 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7664 || prev_face
->box
== FACE_NO_BOX
));
7666 /* For the last character of the box-face run, we need to look
7667 either at the next glyph from the display vector, or at the
7668 face we saw before the display vector. */
7669 next_face_id
= it
->saved_face_id
;
7670 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7672 if (it
->dpvec_face_id
>= 0)
7673 next_face_id
= it
->dpvec_face_id
;
7677 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7680 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7684 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7685 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7687 || next_face
->box
== FACE_NO_BOX
));
7688 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7691 /* Display table entry is invalid. Return a space. */
7692 it
->c
= ' ', it
->len
= 1;
7694 /* Don't change position and object of the iterator here. They are
7695 still the values of the character that had this display table
7696 entry or was translated, and that's what we want. */
7697 it
->what
= IT_CHARACTER
;
7701 /* Get the first element of string/buffer in the visual order, after
7702 being reseated to a new position in a string or a buffer. */
7704 get_visually_first_element (struct it
*it
)
7706 int string_p
= STRINGP (it
->string
) || it
->s
;
7707 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7708 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7710 if (STRINGP (it
->string
))
7712 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7713 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7717 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7718 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7721 if (it
->bidi_it
.charpos
== eob
)
7723 /* Nothing to do, but reset the FIRST_ELT flag, like
7724 bidi_paragraph_init does, because we are not going to
7726 it
->bidi_it
.first_elt
= 0;
7728 else if (it
->bidi_it
.charpos
== bob
7730 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7731 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7733 /* If we are at the beginning of a line/string, we can produce
7734 the next element right away. */
7735 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7736 bidi_move_to_visually_next (&it
->bidi_it
);
7740 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7742 /* We need to prime the bidi iterator starting at the line's or
7743 string's beginning, before we will be able to produce the
7746 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7748 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7749 IT_BYTEPOS (*it
), -1,
7750 &it
->bidi_it
.bytepos
);
7751 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7754 /* Now return to buffer/string position where we were asked
7755 to get the next display element, and produce that. */
7756 bidi_move_to_visually_next (&it
->bidi_it
);
7758 while (it
->bidi_it
.bytepos
!= orig_bytepos
7759 && it
->bidi_it
.charpos
< eob
);
7762 /* Adjust IT's position information to where we ended up. */
7763 if (STRINGP (it
->string
))
7765 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7766 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7770 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7771 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7774 if (STRINGP (it
->string
) || !it
->s
)
7776 ptrdiff_t stop
, charpos
, bytepos
;
7778 if (STRINGP (it
->string
))
7781 stop
= SCHARS (it
->string
);
7782 if (stop
> it
->end_charpos
)
7783 stop
= it
->end_charpos
;
7784 charpos
= IT_STRING_CHARPOS (*it
);
7785 bytepos
= IT_STRING_BYTEPOS (*it
);
7789 stop
= it
->end_charpos
;
7790 charpos
= IT_CHARPOS (*it
);
7791 bytepos
= IT_BYTEPOS (*it
);
7793 if (it
->bidi_it
.scan_dir
< 0)
7795 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7800 /* Load IT with the next display element from Lisp string IT->string.
7801 IT->current.string_pos is the current position within the string.
7802 If IT->current.overlay_string_index >= 0, the Lisp string is an
7806 next_element_from_string (struct it
*it
)
7808 struct text_pos position
;
7810 eassert (STRINGP (it
->string
));
7811 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7812 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7813 position
= it
->current
.string_pos
;
7815 /* With bidi reordering, the character to display might not be the
7816 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7817 that we were reseat()ed to a new string, whose paragraph
7818 direction is not known. */
7819 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7821 get_visually_first_element (it
);
7822 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7825 /* Time to check for invisible text? */
7826 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7828 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7831 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7832 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7834 /* With bidi non-linear iteration, we could find
7835 ourselves far beyond the last computed stop_charpos,
7836 with several other stop positions in between that we
7837 missed. Scan them all now, in buffer's logical
7838 order, until we find and handle the last stop_charpos
7839 that precedes our current position. */
7840 handle_stop_backwards (it
, it
->stop_charpos
);
7841 return GET_NEXT_DISPLAY_ELEMENT (it
);
7847 /* Take note of the stop position we just moved
7848 across, for when we will move back across it. */
7849 it
->prev_stop
= it
->stop_charpos
;
7850 /* If we are at base paragraph embedding level, take
7851 note of the last stop position seen at this
7853 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7854 it
->base_level_stop
= it
->stop_charpos
;
7858 /* Since a handler may have changed IT->method, we must
7860 return GET_NEXT_DISPLAY_ELEMENT (it
);
7864 /* If we are before prev_stop, we may have overstepped
7865 on our way backwards a stop_pos, and if so, we need
7866 to handle that stop_pos. */
7867 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7868 /* We can sometimes back up for reasons that have nothing
7869 to do with bidi reordering. E.g., compositions. The
7870 code below is only needed when we are above the base
7871 embedding level, so test for that explicitly. */
7872 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7874 /* If we lost track of base_level_stop, we have no better
7875 place for handle_stop_backwards to start from than string
7876 beginning. This happens, e.g., when we were reseated to
7877 the previous screenful of text by vertical-motion. */
7878 if (it
->base_level_stop
<= 0
7879 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7880 it
->base_level_stop
= 0;
7881 handle_stop_backwards (it
, it
->base_level_stop
);
7882 return GET_NEXT_DISPLAY_ELEMENT (it
);
7886 if (it
->current
.overlay_string_index
>= 0)
7888 /* Get the next character from an overlay string. In overlay
7889 strings, there is no field width or padding with spaces to
7891 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7896 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7897 IT_STRING_BYTEPOS (*it
),
7898 it
->bidi_it
.scan_dir
< 0
7900 : SCHARS (it
->string
))
7901 && next_element_from_composition (it
))
7905 else if (STRING_MULTIBYTE (it
->string
))
7907 const unsigned char *s
= (SDATA (it
->string
)
7908 + IT_STRING_BYTEPOS (*it
));
7909 it
->c
= string_char_and_length (s
, &it
->len
);
7913 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7919 /* Get the next character from a Lisp string that is not an
7920 overlay string. Such strings come from the mode line, for
7921 example. We may have to pad with spaces, or truncate the
7922 string. See also next_element_from_c_string. */
7923 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7928 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7930 /* Pad with spaces. */
7931 it
->c
= ' ', it
->len
= 1;
7932 CHARPOS (position
) = BYTEPOS (position
) = -1;
7934 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7935 IT_STRING_BYTEPOS (*it
),
7936 it
->bidi_it
.scan_dir
< 0
7938 : it
->string_nchars
)
7939 && next_element_from_composition (it
))
7943 else if (STRING_MULTIBYTE (it
->string
))
7945 const unsigned char *s
= (SDATA (it
->string
)
7946 + IT_STRING_BYTEPOS (*it
));
7947 it
->c
= string_char_and_length (s
, &it
->len
);
7951 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7956 /* Record what we have and where it came from. */
7957 it
->what
= IT_CHARACTER
;
7958 it
->object
= it
->string
;
7959 it
->position
= position
;
7964 /* Load IT with next display element from C string IT->s.
7965 IT->string_nchars is the maximum number of characters to return
7966 from the string. IT->end_charpos may be greater than
7967 IT->string_nchars when this function is called, in which case we
7968 may have to return padding spaces. Value is zero if end of string
7969 reached, including padding spaces. */
7972 next_element_from_c_string (struct it
*it
)
7974 bool success_p
= true;
7977 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7978 it
->what
= IT_CHARACTER
;
7979 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7980 it
->object
= make_number (0);
7982 /* With bidi reordering, the character to display might not be the
7983 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7984 we were reseated to a new string, whose paragraph direction is
7986 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7987 get_visually_first_element (it
);
7989 /* IT's position can be greater than IT->string_nchars in case a
7990 field width or precision has been specified when the iterator was
7992 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7994 /* End of the game. */
7998 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8000 /* Pad with spaces. */
8001 it
->c
= ' ', it
->len
= 1;
8002 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8004 else if (it
->multibyte_p
)
8005 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8007 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8013 /* Set up IT to return characters from an ellipsis, if appropriate.
8014 The definition of the ellipsis glyphs may come from a display table
8015 entry. This function fills IT with the first glyph from the
8016 ellipsis if an ellipsis is to be displayed. */
8019 next_element_from_ellipsis (struct it
*it
)
8021 if (it
->selective_display_ellipsis_p
)
8022 setup_for_ellipsis (it
, it
->len
);
8025 /* The face at the current position may be different from the
8026 face we find after the invisible text. Remember what it
8027 was in IT->saved_face_id, and signal that it's there by
8028 setting face_before_selective_p. */
8029 it
->saved_face_id
= it
->face_id
;
8030 it
->method
= GET_FROM_BUFFER
;
8031 it
->object
= it
->w
->contents
;
8032 reseat_at_next_visible_line_start (it
, 1);
8033 it
->face_before_selective_p
= true;
8036 return GET_NEXT_DISPLAY_ELEMENT (it
);
8040 /* Deliver an image display element. The iterator IT is already
8041 filled with image information (done in handle_display_prop). Value
8046 next_element_from_image (struct it
*it
)
8048 it
->what
= IT_IMAGE
;
8049 it
->ignore_overlay_strings_at_pos_p
= 0;
8053 #ifdef HAVE_XWIDGETS
8054 /* im not sure about this FIXME JAVE*/
8056 next_element_from_xwidget (struct it
*it
)
8058 it
->what
= IT_XWIDGET
;
8059 //assert_valid_xwidget_id(it->xwidget_id,"next_element_from_xwidget");
8060 //this is shaky because why do we set "what" if we dont set the other parts??
8061 //printf("xwidget_id %d: in next_element_from_xwidget: FIXME \n", it->xwidget_id);
8067 /* Fill iterator IT with next display element from a stretch glyph
8068 property. IT->object is the value of the text property. Value is
8072 next_element_from_stretch (struct it
*it
)
8074 it
->what
= IT_STRETCH
;
8078 /* Scan backwards from IT's current position until we find a stop
8079 position, or until BEGV. This is called when we find ourself
8080 before both the last known prev_stop and base_level_stop while
8081 reordering bidirectional text. */
8084 compute_stop_pos_backwards (struct it
*it
)
8086 const int SCAN_BACK_LIMIT
= 1000;
8087 struct text_pos pos
;
8088 struct display_pos save_current
= it
->current
;
8089 struct text_pos save_position
= it
->position
;
8090 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8091 ptrdiff_t where_we_are
= charpos
;
8092 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8093 ptrdiff_t save_end_pos
= it
->end_charpos
;
8095 eassert (NILP (it
->string
) && !it
->s
);
8096 eassert (it
->bidi_p
);
8100 it
->end_charpos
= min (charpos
+ 1, ZV
);
8101 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8102 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8103 reseat_1 (it
, pos
, 0);
8104 compute_stop_pos (it
);
8105 /* We must advance forward, right? */
8106 if (it
->stop_charpos
<= charpos
)
8109 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8111 if (it
->stop_charpos
<= where_we_are
)
8112 it
->prev_stop
= it
->stop_charpos
;
8114 it
->prev_stop
= BEGV
;
8116 it
->current
= save_current
;
8117 it
->position
= save_position
;
8118 it
->stop_charpos
= save_stop_pos
;
8119 it
->end_charpos
= save_end_pos
;
8122 /* Scan forward from CHARPOS in the current buffer/string, until we
8123 find a stop position > current IT's position. Then handle the stop
8124 position before that. This is called when we bump into a stop
8125 position while reordering bidirectional text. CHARPOS should be
8126 the last previously processed stop_pos (or BEGV/0, if none were
8127 processed yet) whose position is less that IT's current
8131 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8133 int bufp
= !STRINGP (it
->string
);
8134 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8135 struct display_pos save_current
= it
->current
;
8136 struct text_pos save_position
= it
->position
;
8137 struct text_pos pos1
;
8138 ptrdiff_t next_stop
;
8140 /* Scan in strict logical order. */
8141 eassert (it
->bidi_p
);
8145 it
->prev_stop
= charpos
;
8148 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8149 reseat_1 (it
, pos1
, 0);
8152 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8153 compute_stop_pos (it
);
8154 /* We must advance forward, right? */
8155 if (it
->stop_charpos
<= it
->prev_stop
)
8157 charpos
= it
->stop_charpos
;
8159 while (charpos
<= where_we_are
);
8162 it
->current
= save_current
;
8163 it
->position
= save_position
;
8164 next_stop
= it
->stop_charpos
;
8165 it
->stop_charpos
= it
->prev_stop
;
8167 it
->stop_charpos
= next_stop
;
8170 /* Load IT with the next display element from current_buffer. Value
8171 is zero if end of buffer reached. IT->stop_charpos is the next
8172 position at which to stop and check for text properties or buffer
8176 next_element_from_buffer (struct it
*it
)
8178 bool success_p
= true;
8180 eassert (IT_CHARPOS (*it
) >= BEGV
);
8181 eassert (NILP (it
->string
) && !it
->s
);
8182 eassert (!it
->bidi_p
8183 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8184 && it
->bidi_it
.string
.s
== NULL
));
8186 /* With bidi reordering, the character to display might not be the
8187 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8188 we were reseat()ed to a new buffer position, which is potentially
8189 a different paragraph. */
8190 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8192 get_visually_first_element (it
);
8193 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8196 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8198 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8200 int overlay_strings_follow_p
;
8202 /* End of the game, except when overlay strings follow that
8203 haven't been returned yet. */
8204 if (it
->overlay_strings_at_end_processed_p
)
8205 overlay_strings_follow_p
= 0;
8208 it
->overlay_strings_at_end_processed_p
= true;
8209 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8212 if (overlay_strings_follow_p
)
8213 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8217 it
->position
= it
->current
.pos
;
8221 else if (!(!it
->bidi_p
8222 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8223 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8225 /* With bidi non-linear iteration, we could find ourselves
8226 far beyond the last computed stop_charpos, with several
8227 other stop positions in between that we missed. Scan
8228 them all now, in buffer's logical order, until we find
8229 and handle the last stop_charpos that precedes our
8230 current position. */
8231 handle_stop_backwards (it
, it
->stop_charpos
);
8232 return GET_NEXT_DISPLAY_ELEMENT (it
);
8238 /* Take note of the stop position we just moved across,
8239 for when we will move back across it. */
8240 it
->prev_stop
= it
->stop_charpos
;
8241 /* If we are at base paragraph embedding level, take
8242 note of the last stop position seen at this
8244 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8245 it
->base_level_stop
= it
->stop_charpos
;
8248 return GET_NEXT_DISPLAY_ELEMENT (it
);
8252 /* If we are before prev_stop, we may have overstepped on
8253 our way backwards a stop_pos, and if so, we need to
8254 handle that stop_pos. */
8255 && IT_CHARPOS (*it
) < it
->prev_stop
8256 /* We can sometimes back up for reasons that have nothing
8257 to do with bidi reordering. E.g., compositions. The
8258 code below is only needed when we are above the base
8259 embedding level, so test for that explicitly. */
8260 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8262 if (it
->base_level_stop
<= 0
8263 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8265 /* If we lost track of base_level_stop, we need to find
8266 prev_stop by looking backwards. This happens, e.g., when
8267 we were reseated to the previous screenful of text by
8269 it
->base_level_stop
= BEGV
;
8270 compute_stop_pos_backwards (it
);
8271 handle_stop_backwards (it
, it
->prev_stop
);
8274 handle_stop_backwards (it
, it
->base_level_stop
);
8275 return GET_NEXT_DISPLAY_ELEMENT (it
);
8279 /* No face changes, overlays etc. in sight, so just return a
8280 character from current_buffer. */
8284 /* We moved to the next buffer position, so any info about
8285 previously seen overlays is no longer valid. */
8286 it
->ignore_overlay_strings_at_pos_p
= 0;
8288 /* Maybe run the redisplay end trigger hook. Performance note:
8289 This doesn't seem to cost measurable time. */
8290 if (it
->redisplay_end_trigger_charpos
8292 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8293 run_redisplay_end_trigger_hook (it
);
8295 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8296 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8298 && next_element_from_composition (it
))
8303 /* Get the next character, maybe multibyte. */
8304 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8305 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8306 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8308 it
->c
= *p
, it
->len
= 1;
8310 /* Record what we have and where it came from. */
8311 it
->what
= IT_CHARACTER
;
8312 it
->object
= it
->w
->contents
;
8313 it
->position
= it
->current
.pos
;
8315 /* Normally we return the character found above, except when we
8316 really want to return an ellipsis for selective display. */
8321 /* A value of selective > 0 means hide lines indented more
8322 than that number of columns. */
8323 if (it
->selective
> 0
8324 && IT_CHARPOS (*it
) + 1 < ZV
8325 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8326 IT_BYTEPOS (*it
) + 1,
8329 success_p
= next_element_from_ellipsis (it
);
8330 it
->dpvec_char_len
= -1;
8333 else if (it
->c
== '\r' && it
->selective
== -1)
8335 /* A value of selective == -1 means that everything from the
8336 CR to the end of the line is invisible, with maybe an
8337 ellipsis displayed for it. */
8338 success_p
= next_element_from_ellipsis (it
);
8339 it
->dpvec_char_len
= -1;
8344 /* Value is zero if end of buffer reached. */
8345 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8350 /* Run the redisplay end trigger hook for IT. */
8353 run_redisplay_end_trigger_hook (struct it
*it
)
8355 Lisp_Object args
[3];
8357 /* IT->glyph_row should be non-null, i.e. we should be actually
8358 displaying something, or otherwise we should not run the hook. */
8359 eassert (it
->glyph_row
);
8361 /* Set up hook arguments. */
8362 args
[0] = Qredisplay_end_trigger_functions
;
8363 args
[1] = it
->window
;
8364 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8365 it
->redisplay_end_trigger_charpos
= 0;
8367 /* Since we are *trying* to run these functions, don't try to run
8368 them again, even if they get an error. */
8369 wset_redisplay_end_trigger (it
->w
, Qnil
);
8370 Frun_hook_with_args (3, args
);
8372 /* Notice if it changed the face of the character we are on. */
8373 handle_face_prop (it
);
8377 /* Deliver a composition display element. Unlike the other
8378 next_element_from_XXX, this function is not registered in the array
8379 get_next_element[]. It is called from next_element_from_buffer and
8380 next_element_from_string when necessary. */
8383 next_element_from_composition (struct it
*it
)
8385 it
->what
= IT_COMPOSITION
;
8386 it
->len
= it
->cmp_it
.nbytes
;
8387 if (STRINGP (it
->string
))
8391 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8392 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8395 it
->position
= it
->current
.string_pos
;
8396 it
->object
= it
->string
;
8397 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8398 IT_STRING_BYTEPOS (*it
), it
->string
);
8404 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8405 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8408 if (it
->bidi_it
.new_paragraph
)
8409 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8410 /* Resync the bidi iterator with IT's new position.
8411 FIXME: this doesn't support bidirectional text. */
8412 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8413 bidi_move_to_visually_next (&it
->bidi_it
);
8417 it
->position
= it
->current
.pos
;
8418 it
->object
= it
->w
->contents
;
8419 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8420 IT_BYTEPOS (*it
), Qnil
);
8427 /***********************************************************************
8428 Moving an iterator without producing glyphs
8429 ***********************************************************************/
8431 /* Check if iterator is at a position corresponding to a valid buffer
8432 position after some move_it_ call. */
8434 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8435 ((it)->method == GET_FROM_STRING \
8436 ? IT_STRING_CHARPOS (*it) == 0 \
8440 /* Move iterator IT to a specified buffer or X position within one
8441 line on the display without producing glyphs.
8443 OP should be a bit mask including some or all of these bits:
8444 MOVE_TO_X: Stop upon reaching x-position TO_X.
8445 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8446 Regardless of OP's value, stop upon reaching the end of the display line.
8448 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8449 This means, in particular, that TO_X includes window's horizontal
8452 The return value has several possible values that
8453 say what condition caused the scan to stop:
8455 MOVE_POS_MATCH_OR_ZV
8456 - when TO_POS or ZV was reached.
8459 -when TO_X was reached before TO_POS or ZV were reached.
8462 - when we reached the end of the display area and the line must
8466 - when we reached the end of the display area and the line is
8470 - when we stopped at a line end, i.e. a newline or a CR and selective
8473 static enum move_it_result
8474 move_it_in_display_line_to (struct it
*it
,
8475 ptrdiff_t to_charpos
, int to_x
,
8476 enum move_operation_enum op
)
8478 enum move_it_result result
= MOVE_UNDEFINED
;
8479 struct glyph_row
*saved_glyph_row
;
8480 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8481 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8482 void *ppos_data
= NULL
;
8484 enum it_method prev_method
= it
->method
;
8485 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8486 int saw_smaller_pos
= prev_pos
< to_charpos
;
8488 /* Don't produce glyphs in produce_glyphs. */
8489 saved_glyph_row
= it
->glyph_row
;
8490 it
->glyph_row
= NULL
;
8492 /* Use wrap_it to save a copy of IT wherever a word wrap could
8493 occur. Use atpos_it to save a copy of IT at the desired buffer
8494 position, if found, so that we can scan ahead and check if the
8495 word later overshoots the window edge. Use atx_it similarly, for
8501 /* Use ppos_it under bidi reordering to save a copy of IT for the
8502 initial position. We restore that position in IT when we have
8503 scanned the entire display line without finding a match for
8504 TO_CHARPOS and all the character positions are greater than
8505 TO_CHARPOS. We then restart the scan from the initial position,
8506 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8507 the closest to TO_CHARPOS. */
8510 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8512 SAVE_IT (ppos_it
, *it
, ppos_data
);
8513 closest_pos
= IT_CHARPOS (*it
);
8519 #define BUFFER_POS_REACHED_P() \
8520 ((op & MOVE_TO_POS) != 0 \
8521 && BUFFERP (it->object) \
8522 && (IT_CHARPOS (*it) == to_charpos \
8524 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8525 && IT_CHARPOS (*it) > to_charpos) \
8526 || (it->what == IT_COMPOSITION \
8527 && ((IT_CHARPOS (*it) > to_charpos \
8528 && to_charpos >= it->cmp_it.charpos) \
8529 || (IT_CHARPOS (*it) < to_charpos \
8530 && to_charpos <= it->cmp_it.charpos)))) \
8531 && (it->method == GET_FROM_BUFFER \
8532 || (it->method == GET_FROM_DISPLAY_VECTOR \
8533 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8535 /* If there's a line-/wrap-prefix, handle it. */
8536 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8537 && it
->current_y
< it
->last_visible_y
)
8538 handle_line_prefix (it
);
8540 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8541 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8545 int x
, i
, ascent
= 0, descent
= 0;
8547 /* Utility macro to reset an iterator with x, ascent, and descent. */
8548 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8549 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8550 (IT)->max_descent = descent)
8552 /* Stop if we move beyond TO_CHARPOS (after an image or a
8553 display string or stretch glyph). */
8554 if ((op
& MOVE_TO_POS
) != 0
8555 && BUFFERP (it
->object
)
8556 && it
->method
== GET_FROM_BUFFER
8558 /* When the iterator is at base embedding level, we
8559 are guaranteed that characters are delivered for
8560 display in strictly increasing order of their
8561 buffer positions. */
8562 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8563 && IT_CHARPOS (*it
) > to_charpos
)
8565 && (prev_method
== GET_FROM_IMAGE
8566 || prev_method
== GET_FROM_STRETCH
8567 || prev_method
== GET_FROM_STRING
)
8568 /* Passed TO_CHARPOS from left to right. */
8569 && ((prev_pos
< to_charpos
8570 && IT_CHARPOS (*it
) > to_charpos
)
8571 /* Passed TO_CHARPOS from right to left. */
8572 || (prev_pos
> to_charpos
8573 && IT_CHARPOS (*it
) < to_charpos
)))))
8575 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8577 result
= MOVE_POS_MATCH_OR_ZV
;
8580 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8581 /* If wrap_it is valid, the current position might be in a
8582 word that is wrapped. So, save the iterator in
8583 atpos_it and continue to see if wrapping happens. */
8584 SAVE_IT (atpos_it
, *it
, atpos_data
);
8587 /* Stop when ZV reached.
8588 We used to stop here when TO_CHARPOS reached as well, but that is
8589 too soon if this glyph does not fit on this line. So we handle it
8590 explicitly below. */
8591 if (!get_next_display_element (it
))
8593 result
= MOVE_POS_MATCH_OR_ZV
;
8597 if (it
->line_wrap
== TRUNCATE
)
8599 if (BUFFER_POS_REACHED_P ())
8601 result
= MOVE_POS_MATCH_OR_ZV
;
8607 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8609 if (IT_DISPLAYING_WHITESPACE (it
))
8613 /* We have reached a glyph that follows one or more
8614 whitespace characters. If the position is
8615 already found, we are done. */
8616 if (atpos_it
.sp
>= 0)
8618 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8619 result
= MOVE_POS_MATCH_OR_ZV
;
8624 RESTORE_IT (it
, &atx_it
, atx_data
);
8625 result
= MOVE_X_REACHED
;
8628 /* Otherwise, we can wrap here. */
8629 SAVE_IT (wrap_it
, *it
, wrap_data
);
8635 /* Remember the line height for the current line, in case
8636 the next element doesn't fit on the line. */
8637 ascent
= it
->max_ascent
;
8638 descent
= it
->max_descent
;
8640 /* The call to produce_glyphs will get the metrics of the
8641 display element IT is loaded with. Record the x-position
8642 before this display element, in case it doesn't fit on the
8646 PRODUCE_GLYPHS (it
);
8648 if (it
->area
!= TEXT_AREA
)
8650 prev_method
= it
->method
;
8651 if (it
->method
== GET_FROM_BUFFER
)
8652 prev_pos
= IT_CHARPOS (*it
);
8653 set_iterator_to_next (it
, 1);
8654 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8655 SET_TEXT_POS (this_line_min_pos
,
8656 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8658 && (op
& MOVE_TO_POS
)
8659 && IT_CHARPOS (*it
) > to_charpos
8660 && IT_CHARPOS (*it
) < closest_pos
)
8661 closest_pos
= IT_CHARPOS (*it
);
8665 /* The number of glyphs we get back in IT->nglyphs will normally
8666 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8667 character on a terminal frame, or (iii) a line end. For the
8668 second case, IT->nglyphs - 1 padding glyphs will be present.
8669 (On X frames, there is only one glyph produced for a
8670 composite character.)
8672 The behavior implemented below means, for continuation lines,
8673 that as many spaces of a TAB as fit on the current line are
8674 displayed there. For terminal frames, as many glyphs of a
8675 multi-glyph character are displayed in the current line, too.
8676 This is what the old redisplay code did, and we keep it that
8677 way. Under X, the whole shape of a complex character must
8678 fit on the line or it will be completely displayed in the
8681 Note that both for tabs and padding glyphs, all glyphs have
8685 /* More than one glyph or glyph doesn't fit on line. All
8686 glyphs have the same width. */
8687 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8689 int x_before_this_char
= x
;
8690 int hpos_before_this_char
= it
->hpos
;
8692 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8694 new_x
= x
+ single_glyph_width
;
8696 /* We want to leave anything reaching TO_X to the caller. */
8697 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8699 if (BUFFER_POS_REACHED_P ())
8701 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8702 goto buffer_pos_reached
;
8703 if (atpos_it
.sp
< 0)
8705 SAVE_IT (atpos_it
, *it
, atpos_data
);
8706 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8711 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8714 result
= MOVE_X_REACHED
;
8719 SAVE_IT (atx_it
, *it
, atx_data
);
8720 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8725 if (/* Lines are continued. */
8726 it
->line_wrap
!= TRUNCATE
8727 && (/* And glyph doesn't fit on the line. */
8728 new_x
> it
->last_visible_x
8729 /* Or it fits exactly and we're on a window
8731 || (new_x
== it
->last_visible_x
8732 && FRAME_WINDOW_P (it
->f
)
8733 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8734 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8735 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8737 if (/* IT->hpos == 0 means the very first glyph
8738 doesn't fit on the line, e.g. a wide image. */
8740 || (new_x
== it
->last_visible_x
8741 && FRAME_WINDOW_P (it
->f
)))
8744 it
->current_x
= new_x
;
8746 /* The character's last glyph just barely fits
8748 if (i
== it
->nglyphs
- 1)
8750 /* If this is the destination position,
8751 return a position *before* it in this row,
8752 now that we know it fits in this row. */
8753 if (BUFFER_POS_REACHED_P ())
8755 if (it
->line_wrap
!= WORD_WRAP
8758 it
->hpos
= hpos_before_this_char
;
8759 it
->current_x
= x_before_this_char
;
8760 result
= MOVE_POS_MATCH_OR_ZV
;
8763 if (it
->line_wrap
== WORD_WRAP
8766 SAVE_IT (atpos_it
, *it
, atpos_data
);
8767 atpos_it
.current_x
= x_before_this_char
;
8768 atpos_it
.hpos
= hpos_before_this_char
;
8772 prev_method
= it
->method
;
8773 if (it
->method
== GET_FROM_BUFFER
)
8774 prev_pos
= IT_CHARPOS (*it
);
8775 set_iterator_to_next (it
, 1);
8776 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8777 SET_TEXT_POS (this_line_min_pos
,
8778 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8779 /* On graphical terminals, newlines may
8780 "overflow" into the fringe if
8781 overflow-newline-into-fringe is non-nil.
8782 On text terminals, and on graphical
8783 terminals with no right margin, newlines
8784 may overflow into the last glyph on the
8786 if (!FRAME_WINDOW_P (it
->f
)
8788 && it
->bidi_it
.paragraph_dir
== R2L
)
8789 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8790 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8791 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8793 if (!get_next_display_element (it
))
8795 result
= MOVE_POS_MATCH_OR_ZV
;
8798 if (BUFFER_POS_REACHED_P ())
8800 if (ITERATOR_AT_END_OF_LINE_P (it
))
8801 result
= MOVE_POS_MATCH_OR_ZV
;
8803 result
= MOVE_LINE_CONTINUED
;
8806 if (ITERATOR_AT_END_OF_LINE_P (it
)
8807 && (it
->line_wrap
!= WORD_WRAP
8809 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8811 result
= MOVE_NEWLINE_OR_CR
;
8818 IT_RESET_X_ASCENT_DESCENT (it
);
8820 if (wrap_it
.sp
>= 0)
8822 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8827 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8829 result
= MOVE_LINE_CONTINUED
;
8833 if (BUFFER_POS_REACHED_P ())
8835 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8836 goto buffer_pos_reached
;
8837 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8839 SAVE_IT (atpos_it
, *it
, atpos_data
);
8840 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8844 if (new_x
> it
->first_visible_x
)
8846 /* Glyph is visible. Increment number of glyphs that
8847 would be displayed. */
8852 if (result
!= MOVE_UNDEFINED
)
8855 else if (BUFFER_POS_REACHED_P ())
8858 IT_RESET_X_ASCENT_DESCENT (it
);
8859 result
= MOVE_POS_MATCH_OR_ZV
;
8862 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8864 /* Stop when TO_X specified and reached. This check is
8865 necessary here because of lines consisting of a line end,
8866 only. The line end will not produce any glyphs and we
8867 would never get MOVE_X_REACHED. */
8868 eassert (it
->nglyphs
== 0);
8869 result
= MOVE_X_REACHED
;
8873 /* Is this a line end? If yes, we're done. */
8874 if (ITERATOR_AT_END_OF_LINE_P (it
))
8876 /* If we are past TO_CHARPOS, but never saw any character
8877 positions smaller than TO_CHARPOS, return
8878 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8880 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8882 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8884 if (closest_pos
< ZV
)
8886 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8887 /* Don't recurse if closest_pos is equal to
8888 to_charpos, since we have just tried that. */
8889 if (closest_pos
!= to_charpos
)
8890 move_it_in_display_line_to (it
, closest_pos
, -1,
8892 result
= MOVE_POS_MATCH_OR_ZV
;
8895 goto buffer_pos_reached
;
8897 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8898 && IT_CHARPOS (*it
) > to_charpos
)
8899 goto buffer_pos_reached
;
8901 result
= MOVE_NEWLINE_OR_CR
;
8904 result
= MOVE_NEWLINE_OR_CR
;
8908 prev_method
= it
->method
;
8909 if (it
->method
== GET_FROM_BUFFER
)
8910 prev_pos
= IT_CHARPOS (*it
);
8911 /* The current display element has been consumed. Advance
8913 set_iterator_to_next (it
, 1);
8914 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8915 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8916 if (IT_CHARPOS (*it
) < to_charpos
)
8917 saw_smaller_pos
= 1;
8919 && (op
& MOVE_TO_POS
)
8920 && IT_CHARPOS (*it
) >= to_charpos
8921 && IT_CHARPOS (*it
) < closest_pos
)
8922 closest_pos
= IT_CHARPOS (*it
);
8924 /* Stop if lines are truncated and IT's current x-position is
8925 past the right edge of the window now. */
8926 if (it
->line_wrap
== TRUNCATE
8927 && it
->current_x
>= it
->last_visible_x
)
8929 if (!FRAME_WINDOW_P (it
->f
)
8930 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8931 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8932 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8933 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8937 if ((at_eob_p
= !get_next_display_element (it
))
8938 || BUFFER_POS_REACHED_P ()
8939 /* If we are past TO_CHARPOS, but never saw any
8940 character positions smaller than TO_CHARPOS,
8941 return MOVE_POS_MATCH_OR_ZV, like the
8942 unidirectional display did. */
8943 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8945 && IT_CHARPOS (*it
) > to_charpos
))
8948 && !BUFFER_POS_REACHED_P ()
8949 && !at_eob_p
&& closest_pos
< ZV
)
8951 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8952 if (closest_pos
!= to_charpos
)
8953 move_it_in_display_line_to (it
, closest_pos
, -1,
8956 result
= MOVE_POS_MATCH_OR_ZV
;
8959 if (ITERATOR_AT_END_OF_LINE_P (it
))
8961 result
= MOVE_NEWLINE_OR_CR
;
8965 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8967 && IT_CHARPOS (*it
) > to_charpos
)
8969 if (closest_pos
< ZV
)
8971 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8972 if (closest_pos
!= to_charpos
)
8973 move_it_in_display_line_to (it
, closest_pos
, -1,
8976 result
= MOVE_POS_MATCH_OR_ZV
;
8979 result
= MOVE_LINE_TRUNCATED
;
8982 #undef IT_RESET_X_ASCENT_DESCENT
8985 #undef BUFFER_POS_REACHED_P
8987 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8988 restore the saved iterator. */
8989 if (atpos_it
.sp
>= 0)
8990 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8991 else if (atx_it
.sp
>= 0)
8992 RESTORE_IT (it
, &atx_it
, atx_data
);
8997 bidi_unshelve_cache (atpos_data
, 1);
8999 bidi_unshelve_cache (atx_data
, 1);
9001 bidi_unshelve_cache (wrap_data
, 1);
9003 bidi_unshelve_cache (ppos_data
, 1);
9005 /* Restore the iterator settings altered at the beginning of this
9007 it
->glyph_row
= saved_glyph_row
;
9011 /* For external use. */
9013 move_it_in_display_line (struct it
*it
,
9014 ptrdiff_t to_charpos
, int to_x
,
9015 enum move_operation_enum op
)
9017 if (it
->line_wrap
== WORD_WRAP
9018 && (op
& MOVE_TO_X
))
9021 void *save_data
= NULL
;
9024 SAVE_IT (save_it
, *it
, save_data
);
9025 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9026 /* When word-wrap is on, TO_X may lie past the end
9027 of a wrapped line. Then it->current is the
9028 character on the next line, so backtrack to the
9029 space before the wrap point. */
9030 if (skip
== MOVE_LINE_CONTINUED
)
9032 int prev_x
= max (it
->current_x
- 1, 0);
9033 RESTORE_IT (it
, &save_it
, save_data
);
9034 move_it_in_display_line_to
9035 (it
, -1, prev_x
, MOVE_TO_X
);
9038 bidi_unshelve_cache (save_data
, 1);
9041 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9045 /* Move IT forward until it satisfies one or more of the criteria in
9046 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9048 OP is a bit-mask that specifies where to stop, and in particular,
9049 which of those four position arguments makes a difference. See the
9050 description of enum move_operation_enum.
9052 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9053 screen line, this function will set IT to the next position that is
9054 displayed to the right of TO_CHARPOS on the screen.
9056 Return the maximum pixel length of any line scanned but never more
9057 than it.last_visible_x. */
9060 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9062 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9063 int line_height
, line_start_x
= 0, reached
= 0;
9064 int max_current_x
= 0;
9065 void *backup_data
= NULL
;
9069 if (op
& MOVE_TO_VPOS
)
9071 /* If no TO_CHARPOS and no TO_X specified, stop at the
9072 start of the line TO_VPOS. */
9073 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9075 if (it
->vpos
== to_vpos
)
9081 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9085 /* TO_VPOS >= 0 means stop at TO_X in the line at
9086 TO_VPOS, or at TO_POS, whichever comes first. */
9087 if (it
->vpos
== to_vpos
)
9093 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9095 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9100 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9102 /* We have reached TO_X but not in the line we want. */
9103 skip
= move_it_in_display_line_to (it
, to_charpos
,
9105 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9113 else if (op
& MOVE_TO_Y
)
9115 struct it it_backup
;
9117 if (it
->line_wrap
== WORD_WRAP
)
9118 SAVE_IT (it_backup
, *it
, backup_data
);
9120 /* TO_Y specified means stop at TO_X in the line containing
9121 TO_Y---or at TO_CHARPOS if this is reached first. The
9122 problem is that we can't really tell whether the line
9123 contains TO_Y before we have completely scanned it, and
9124 this may skip past TO_X. What we do is to first scan to
9127 If TO_X is not specified, use a TO_X of zero. The reason
9128 is to make the outcome of this function more predictable.
9129 If we didn't use TO_X == 0, we would stop at the end of
9130 the line which is probably not what a caller would expect
9132 skip
= move_it_in_display_line_to
9133 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9134 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9136 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9137 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9139 else if (skip
== MOVE_X_REACHED
)
9141 /* If TO_X was reached, we want to know whether TO_Y is
9142 in the line. We know this is the case if the already
9143 scanned glyphs make the line tall enough. Otherwise,
9144 we must check by scanning the rest of the line. */
9145 line_height
= it
->max_ascent
+ it
->max_descent
;
9146 if (to_y
>= it
->current_y
9147 && to_y
< it
->current_y
+ line_height
)
9152 SAVE_IT (it_backup
, *it
, backup_data
);
9153 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9154 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9156 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9157 line_height
= it
->max_ascent
+ it
->max_descent
;
9158 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9160 if (to_y
>= it
->current_y
9161 && to_y
< it
->current_y
+ line_height
)
9163 /* If TO_Y is in this line and TO_X was reached
9164 above, we scanned too far. We have to restore
9165 IT's settings to the ones before skipping. But
9166 keep the more accurate values of max_ascent and
9167 max_descent we've found while skipping the rest
9168 of the line, for the sake of callers, such as
9169 pos_visible_p, that need to know the line
9171 int max_ascent
= it
->max_ascent
;
9172 int max_descent
= it
->max_descent
;
9174 RESTORE_IT (it
, &it_backup
, backup_data
);
9175 it
->max_ascent
= max_ascent
;
9176 it
->max_descent
= max_descent
;
9182 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9188 /* Check whether TO_Y is in this line. */
9189 line_height
= it
->max_ascent
+ it
->max_descent
;
9190 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9192 if (to_y
>= it
->current_y
9193 && to_y
< it
->current_y
+ line_height
)
9195 if (to_y
> it
->current_y
)
9196 max_current_x
= max (it
->current_x
, max_current_x
);
9198 /* When word-wrap is on, TO_X may lie past the end
9199 of a wrapped line. Then it->current is the
9200 character on the next line, so backtrack to the
9201 space before the wrap point. */
9202 if (skip
== MOVE_LINE_CONTINUED
9203 && it
->line_wrap
== WORD_WRAP
)
9205 int prev_x
= max (it
->current_x
- 1, 0);
9206 RESTORE_IT (it
, &it_backup
, backup_data
);
9207 skip
= move_it_in_display_line_to
9208 (it
, -1, prev_x
, MOVE_TO_X
);
9217 max_current_x
= max (it
->current_x
, max_current_x
);
9221 else if (BUFFERP (it
->object
)
9222 && (it
->method
== GET_FROM_BUFFER
9223 || it
->method
== GET_FROM_STRETCH
)
9224 && IT_CHARPOS (*it
) >= to_charpos
9225 /* Under bidi iteration, a call to set_iterator_to_next
9226 can scan far beyond to_charpos if the initial
9227 portion of the next line needs to be reordered. In
9228 that case, give move_it_in_display_line_to another
9231 && it
->bidi_it
.scan_dir
== -1))
9232 skip
= MOVE_POS_MATCH_OR_ZV
;
9234 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9238 case MOVE_POS_MATCH_OR_ZV
:
9239 max_current_x
= max (it
->current_x
, max_current_x
);
9243 case MOVE_NEWLINE_OR_CR
:
9244 max_current_x
= max (it
->current_x
, max_current_x
);
9245 set_iterator_to_next (it
, 1);
9246 it
->continuation_lines_width
= 0;
9249 case MOVE_LINE_TRUNCATED
:
9250 max_current_x
= it
->last_visible_x
;
9251 it
->continuation_lines_width
= 0;
9252 reseat_at_next_visible_line_start (it
, 0);
9253 if ((op
& MOVE_TO_POS
) != 0
9254 && IT_CHARPOS (*it
) > to_charpos
)
9261 case MOVE_LINE_CONTINUED
:
9262 max_current_x
= it
->last_visible_x
;
9263 /* For continued lines ending in a tab, some of the glyphs
9264 associated with the tab are displayed on the current
9265 line. Since it->current_x does not include these glyphs,
9266 we use it->last_visible_x instead. */
9269 it
->continuation_lines_width
+= it
->last_visible_x
;
9270 /* When moving by vpos, ensure that the iterator really
9271 advances to the next line (bug#847, bug#969). Fixme:
9272 do we need to do this in other circumstances? */
9273 if (it
->current_x
!= it
->last_visible_x
9274 && (op
& MOVE_TO_VPOS
)
9275 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9277 line_start_x
= it
->current_x
+ it
->pixel_width
9278 - it
->last_visible_x
;
9279 if (FRAME_WINDOW_P (it
->f
))
9281 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9282 struct font
*face_font
= face
->font
;
9284 /* When display_line produces a continued line
9285 that ends in a TAB, it skips a tab stop that
9286 is closer than the font's space character
9287 width (see x_produce_glyphs where it produces
9288 the stretch glyph which represents a TAB).
9289 We need to reproduce the same logic here. */
9290 eassert (face_font
);
9293 if (line_start_x
< face_font
->space_width
)
9295 += it
->tab_width
* face_font
->space_width
;
9298 set_iterator_to_next (it
, 0);
9302 it
->continuation_lines_width
+= it
->current_x
;
9309 /* Reset/increment for the next run. */
9310 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9311 it
->current_x
= line_start_x
;
9314 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9316 last_height
= it
->max_ascent
+ it
->max_descent
;
9317 it
->max_ascent
= it
->max_descent
= 0;
9322 /* On text terminals, we may stop at the end of a line in the middle
9323 of a multi-character glyph. If the glyph itself is continued,
9324 i.e. it is actually displayed on the next line, don't treat this
9325 stopping point as valid; move to the next line instead (unless
9326 that brings us offscreen). */
9327 if (!FRAME_WINDOW_P (it
->f
)
9329 && IT_CHARPOS (*it
) == to_charpos
9330 && it
->what
== IT_CHARACTER
9332 && it
->line_wrap
== WINDOW_WRAP
9333 && it
->current_x
== it
->last_visible_x
- 1
9336 && it
->vpos
< it
->w
->window_end_vpos
)
9338 it
->continuation_lines_width
+= it
->current_x
;
9339 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9340 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9342 last_height
= it
->max_ascent
+ it
->max_descent
;
9346 bidi_unshelve_cache (backup_data
, 1);
9348 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9350 return max_current_x
;
9354 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9356 If DY > 0, move IT backward at least that many pixels. DY = 0
9357 means move IT backward to the preceding line start or BEGV. This
9358 function may move over more than DY pixels if IT->current_y - DY
9359 ends up in the middle of a line; in this case IT->current_y will be
9360 set to the top of the line moved to. */
9363 move_it_vertically_backward (struct it
*it
, int dy
)
9367 void *it2data
= NULL
, *it3data
= NULL
;
9368 ptrdiff_t start_pos
;
9370 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9371 ptrdiff_t pos_limit
;
9376 start_pos
= IT_CHARPOS (*it
);
9378 /* Estimate how many newlines we must move back. */
9379 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9380 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9383 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9385 /* Set the iterator's position that many lines back. But don't go
9386 back more than NLINES full screen lines -- this wins a day with
9387 buffers which have very long lines. */
9388 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9389 back_to_previous_visible_line_start (it
);
9391 /* Reseat the iterator here. When moving backward, we don't want
9392 reseat to skip forward over invisible text, set up the iterator
9393 to deliver from overlay strings at the new position etc. So,
9394 use reseat_1 here. */
9395 reseat_1 (it
, it
->current
.pos
, 1);
9397 /* We are now surely at a line start. */
9398 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9399 reordering is in effect. */
9400 it
->continuation_lines_width
= 0;
9402 /* Move forward and see what y-distance we moved. First move to the
9403 start of the next line so that we get its height. We need this
9404 height to be able to tell whether we reached the specified
9406 SAVE_IT (it2
, *it
, it2data
);
9407 it2
.max_ascent
= it2
.max_descent
= 0;
9410 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9411 MOVE_TO_POS
| MOVE_TO_VPOS
);
9413 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9414 /* If we are in a display string which starts at START_POS,
9415 and that display string includes a newline, and we are
9416 right after that newline (i.e. at the beginning of a
9417 display line), exit the loop, because otherwise we will
9418 infloop, since move_it_to will see that it is already at
9419 START_POS and will not move. */
9420 || (it2
.method
== GET_FROM_STRING
9421 && IT_CHARPOS (it2
) == start_pos
9422 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9423 eassert (IT_CHARPOS (*it
) >= BEGV
);
9424 SAVE_IT (it3
, it2
, it3data
);
9426 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9427 eassert (IT_CHARPOS (*it
) >= BEGV
);
9428 /* H is the actual vertical distance from the position in *IT
9429 and the starting position. */
9430 h
= it2
.current_y
- it
->current_y
;
9431 /* NLINES is the distance in number of lines. */
9432 nlines
= it2
.vpos
- it
->vpos
;
9434 /* Correct IT's y and vpos position
9435 so that they are relative to the starting point. */
9441 /* DY == 0 means move to the start of the screen line. The
9442 value of nlines is > 0 if continuation lines were involved,
9443 or if the original IT position was at start of a line. */
9444 RESTORE_IT (it
, it
, it2data
);
9446 move_it_by_lines (it
, nlines
);
9447 /* The above code moves us to some position NLINES down,
9448 usually to its first glyph (leftmost in an L2R line), but
9449 that's not necessarily the start of the line, under bidi
9450 reordering. We want to get to the character position
9451 that is immediately after the newline of the previous
9454 && !it
->continuation_lines_width
9455 && !STRINGP (it
->string
)
9456 && IT_CHARPOS (*it
) > BEGV
9457 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9459 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9462 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9463 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9465 bidi_unshelve_cache (it3data
, 1);
9469 /* The y-position we try to reach, relative to *IT.
9470 Note that H has been subtracted in front of the if-statement. */
9471 int target_y
= it
->current_y
+ h
- dy
;
9472 int y0
= it3
.current_y
;
9476 RESTORE_IT (&it3
, &it3
, it3data
);
9477 y1
= line_bottom_y (&it3
);
9478 line_height
= y1
- y0
;
9479 RESTORE_IT (it
, it
, it2data
);
9480 /* If we did not reach target_y, try to move further backward if
9481 we can. If we moved too far backward, try to move forward. */
9482 if (target_y
< it
->current_y
9483 /* This is heuristic. In a window that's 3 lines high, with
9484 a line height of 13 pixels each, recentering with point
9485 on the bottom line will try to move -39/2 = 19 pixels
9486 backward. Try to avoid moving into the first line. */
9487 && (it
->current_y
- target_y
9488 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9489 && IT_CHARPOS (*it
) > BEGV
)
9491 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9492 target_y
- it
->current_y
));
9493 dy
= it
->current_y
- target_y
;
9494 goto move_further_back
;
9496 else if (target_y
>= it
->current_y
+ line_height
9497 && IT_CHARPOS (*it
) < ZV
)
9499 /* Should move forward by at least one line, maybe more.
9501 Note: Calling move_it_by_lines can be expensive on
9502 terminal frames, where compute_motion is used (via
9503 vmotion) to do the job, when there are very long lines
9504 and truncate-lines is nil. That's the reason for
9505 treating terminal frames specially here. */
9507 if (!FRAME_WINDOW_P (it
->f
))
9508 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9513 move_it_by_lines (it
, 1);
9515 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9522 /* Move IT by a specified amount of pixel lines DY. DY negative means
9523 move backwards. DY = 0 means move to start of screen line. At the
9524 end, IT will be on the start of a screen line. */
9527 move_it_vertically (struct it
*it
, int dy
)
9530 move_it_vertically_backward (it
, -dy
);
9533 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9534 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9535 MOVE_TO_POS
| MOVE_TO_Y
);
9536 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9538 /* If buffer ends in ZV without a newline, move to the start of
9539 the line to satisfy the post-condition. */
9540 if (IT_CHARPOS (*it
) == ZV
9542 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9543 move_it_by_lines (it
, 0);
9548 /* Move iterator IT past the end of the text line it is in. */
9551 move_it_past_eol (struct it
*it
)
9553 enum move_it_result rc
;
9555 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9556 if (rc
== MOVE_NEWLINE_OR_CR
)
9557 set_iterator_to_next (it
, 0);
9561 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9562 negative means move up. DVPOS == 0 means move to the start of the
9565 Optimization idea: If we would know that IT->f doesn't use
9566 a face with proportional font, we could be faster for
9567 truncate-lines nil. */
9570 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9573 /* The commented-out optimization uses vmotion on terminals. This
9574 gives bad results, because elements like it->what, on which
9575 callers such as pos_visible_p rely, aren't updated. */
9576 /* struct position pos;
9577 if (!FRAME_WINDOW_P (it->f))
9579 struct text_pos textpos;
9581 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9582 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9583 reseat (it, textpos, 1);
9584 it->vpos += pos.vpos;
9585 it->current_y += pos.vpos;
9591 /* DVPOS == 0 means move to the start of the screen line. */
9592 move_it_vertically_backward (it
, 0);
9593 /* Let next call to line_bottom_y calculate real line height. */
9598 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9599 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9601 /* Only move to the next buffer position if we ended up in a
9602 string from display property, not in an overlay string
9603 (before-string or after-string). That is because the
9604 latter don't conceal the underlying buffer position, so
9605 we can ask to move the iterator to the exact position we
9606 are interested in. Note that, even if we are already at
9607 IT_CHARPOS (*it), the call below is not a no-op, as it
9608 will detect that we are at the end of the string, pop the
9609 iterator, and compute it->current_x and it->hpos
9611 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9612 -1, -1, -1, MOVE_TO_POS
);
9618 void *it2data
= NULL
;
9619 ptrdiff_t start_charpos
, i
;
9621 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9622 bool hit_pos_limit
= false;
9623 ptrdiff_t pos_limit
;
9625 /* Start at the beginning of the screen line containing IT's
9626 position. This may actually move vertically backwards,
9627 in case of overlays, so adjust dvpos accordingly. */
9629 move_it_vertically_backward (it
, 0);
9632 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9633 screen lines, and reseat the iterator there. */
9634 start_charpos
= IT_CHARPOS (*it
);
9635 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9638 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9640 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9641 back_to_previous_visible_line_start (it
);
9642 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9643 hit_pos_limit
= true;
9644 reseat (it
, it
->current
.pos
, 1);
9646 /* Move further back if we end up in a string or an image. */
9647 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9649 /* First try to move to start of display line. */
9651 move_it_vertically_backward (it
, 0);
9653 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9655 /* If start of line is still in string or image,
9656 move further back. */
9657 back_to_previous_visible_line_start (it
);
9658 reseat (it
, it
->current
.pos
, 1);
9662 it
->current_x
= it
->hpos
= 0;
9664 /* Above call may have moved too far if continuation lines
9665 are involved. Scan forward and see if it did. */
9666 SAVE_IT (it2
, *it
, it2data
);
9667 it2
.vpos
= it2
.current_y
= 0;
9668 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9669 it
->vpos
-= it2
.vpos
;
9670 it
->current_y
-= it2
.current_y
;
9671 it
->current_x
= it
->hpos
= 0;
9673 /* If we moved too far back, move IT some lines forward. */
9674 if (it2
.vpos
> -dvpos
)
9676 int delta
= it2
.vpos
+ dvpos
;
9678 RESTORE_IT (&it2
, &it2
, it2data
);
9679 SAVE_IT (it2
, *it
, it2data
);
9680 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9681 /* Move back again if we got too far ahead. */
9682 if (IT_CHARPOS (*it
) >= start_charpos
)
9683 RESTORE_IT (it
, &it2
, it2data
);
9685 bidi_unshelve_cache (it2data
, 1);
9687 else if (hit_pos_limit
&& pos_limit
> BEGV
9688 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9690 /* If we hit the limit, but still didn't make it far enough
9691 back, that means there's a display string with a newline
9692 covering a large chunk of text, and that caused
9693 back_to_previous_visible_line_start try to go too far.
9694 Punish those who commit such atrocities by going back
9695 until we've reached DVPOS, after lifting the limit, which
9696 could make it slow for very long lines. "If it hurts,
9699 RESTORE_IT (it
, it
, it2data
);
9700 for (i
= -dvpos
; i
> 0; --i
)
9702 back_to_previous_visible_line_start (it
);
9705 reseat_1 (it
, it
->current
.pos
, 1);
9708 RESTORE_IT (it
, it
, it2data
);
9712 /* Return true if IT points into the middle of a display vector. */
9715 in_display_vector_p (struct it
*it
)
9717 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9718 && it
->current
.dpvec_index
> 0
9719 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9722 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9723 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9724 WINDOW must be a live window and defaults to the selected one. The
9725 return value is a cons of the maximum pixel-width of any text line and
9726 the maximum pixel-height of all text lines.
9728 The optional argument FROM, if non-nil, specifies the first text
9729 position and defaults to the minimum accessible position of the buffer.
9730 If FROM is t, use the minimum accessible position that is not a newline
9731 character. TO, if non-nil, specifies the last text position and
9732 defaults to the maximum accessible position of the buffer. If TO is t,
9733 use the maximum accessible position that is not a newline character.
9735 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9736 width that can be returned. X-LIMIT nil or omitted, means to use the
9737 pixel-width of WINDOW's body; use this if you do not intend to change
9738 the width of WINDOW. Use the maximum width WINDOW may assume if you
9739 intend to change WINDOW's width. In any case, text whose x-coordinate
9740 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9741 can take some time, it's always a good idea to make this argument as
9742 small as possible; in particular, if the buffer contains long lines that
9743 shall be truncated anyway.
9745 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9746 height that can be returned. Text lines whose y-coordinate is beyond
9747 Y-LIMIT are ignored. Since calculating the text height of a large
9748 buffer can take some time, it makes sense to specify this argument if
9749 the size of the buffer is unknown.
9751 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9752 include the height of the mode- or header-line of WINDOW in the return
9753 value. If it is either the symbol `mode-line' or `header-line', include
9754 only the height of that line, if present, in the return value. If t,
9755 include the height of both, if present, in the return value. */)
9756 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9757 Lisp_Object mode_and_header_line
)
9759 struct window
*w
= decode_live_window (window
);
9763 struct buffer
*old_buffer
= NULL
;
9764 ptrdiff_t start
, end
, pos
;
9765 struct text_pos startp
;
9766 void *itdata
= NULL
;
9767 int c
, max_y
= -1, x
= 0, y
= 0;
9773 if (b
!= current_buffer
)
9775 old_buffer
= current_buffer
;
9776 set_buffer_internal (b
);
9781 else if (EQ (from
, Qt
))
9784 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9785 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9787 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9792 CHECK_NUMBER_COERCE_MARKER (from
);
9793 start
= min (max (XINT (from
), BEGV
), ZV
);
9798 else if (EQ (to
, Qt
))
9801 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9802 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9804 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9809 CHECK_NUMBER_COERCE_MARKER (to
);
9810 end
= max (start
, min (XINT (to
), ZV
));
9813 if (!NILP (y_limit
))
9815 CHECK_NUMBER (y_limit
);
9816 max_y
= min (XINT (y_limit
), INT_MAX
);
9819 itdata
= bidi_shelve_cache ();
9820 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9821 start_display (&it
, w
, startp
);
9824 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9827 CHECK_NUMBER (x_limit
);
9828 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9829 /* Actually, we never want move_it_to stop at to_x. But to make
9830 sure that move_it_in_display_line_to always moves far enough,
9831 we set it to INT_MAX and specify MOVE_TO_X. */
9832 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9833 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9836 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9838 if (!EQ (mode_and_header_line
, Qheader_line
)
9839 && !EQ (mode_and_header_line
, Qt
))
9840 /* Do not count the header-line which was counted automatically by
9842 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9844 if (EQ (mode_and_header_line
, Qmode_line
)
9845 || EQ (mode_and_header_line
, Qt
))
9846 /* Do count the mode-line which is not included automatically by
9848 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9850 bidi_unshelve_cache (itdata
, 0);
9853 set_buffer_internal (old_buffer
);
9855 return Fcons (make_number (x
), make_number (y
));
9858 /***********************************************************************
9860 ***********************************************************************/
9863 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9867 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9869 Lisp_Object args
[3];
9870 Lisp_Object msg
, fmt
;
9873 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9877 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9879 args
[0] = fmt
= build_string (format
);
9882 msg
= Fformat (3, args
);
9884 len
= SBYTES (msg
) + 1;
9885 buffer
= SAFE_ALLOCA (len
);
9886 memcpy (buffer
, SDATA (msg
), len
);
9888 message_dolog (buffer
, len
- 1, 1, 0);
9895 /* Output a newline in the *Messages* buffer if "needs" one. */
9898 message_log_maybe_newline (void)
9900 if (message_log_need_newline
)
9901 message_dolog ("", 0, 1, 0);
9905 /* Add a string M of length NBYTES to the message log, optionally
9906 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9907 true, means interpret the contents of M as multibyte. This
9908 function calls low-level routines in order to bypass text property
9909 hooks, etc. which might not be safe to run.
9911 This may GC (insert may run before/after change hooks),
9912 so the buffer M must NOT point to a Lisp string. */
9915 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9917 const unsigned char *msg
= (const unsigned char *) m
;
9919 if (!NILP (Vmemory_full
))
9922 if (!NILP (Vmessage_log_max
))
9924 struct buffer
*oldbuf
;
9925 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9926 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9927 ptrdiff_t point_at_end
= 0;
9928 ptrdiff_t zv_at_end
= 0;
9929 Lisp_Object old_deactivate_mark
;
9930 struct gcpro gcpro1
;
9932 old_deactivate_mark
= Vdeactivate_mark
;
9933 oldbuf
= current_buffer
;
9935 /* Ensure the Messages buffer exists, and switch to it.
9936 If we created it, set the major-mode. */
9939 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9941 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9944 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9945 call0 (intern ("messages-buffer-mode"));
9948 bset_undo_list (current_buffer
, Qt
);
9949 bset_cache_long_scans (current_buffer
, Qnil
);
9951 oldpoint
= message_dolog_marker1
;
9952 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9953 oldbegv
= message_dolog_marker2
;
9954 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9955 oldzv
= message_dolog_marker3
;
9956 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9957 GCPRO1 (old_deactivate_mark
);
9965 BEGV_BYTE
= BEG_BYTE
;
9968 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9970 /* Insert the string--maybe converting multibyte to single byte
9971 or vice versa, so that all the text fits the buffer. */
9973 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9979 /* Convert a multibyte string to single-byte
9980 for the *Message* buffer. */
9981 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9983 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9984 work
[0] = CHAR_TO_BYTE8 (c
);
9985 insert_1_both (work
, 1, 1, 1, 0, 0);
9988 else if (! multibyte
9989 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9993 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9994 /* Convert a single-byte string to multibyte
9995 for the *Message* buffer. */
9996 for (i
= 0; i
< nbytes
; i
++)
9999 MAKE_CHAR_MULTIBYTE (c
);
10000 char_bytes
= CHAR_STRING (c
, str
);
10001 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
10005 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
10009 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10012 insert_1_both ("\n", 1, 1, 1, 0, 0);
10014 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10016 this_bol_byte
= PT_BYTE
;
10018 /* See if this line duplicates the previous one.
10019 If so, combine duplicates. */
10020 if (this_bol
> BEG
)
10022 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10024 prev_bol_byte
= PT_BYTE
;
10026 dups
= message_log_check_duplicate (prev_bol_byte
,
10030 del_range_both (prev_bol
, prev_bol_byte
,
10031 this_bol
, this_bol_byte
, 0);
10034 char dupstr
[sizeof " [ times]"
10035 + INT_STRLEN_BOUND (printmax_t
)];
10037 /* If you change this format, don't forget to also
10038 change message_log_check_duplicate. */
10039 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10040 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10041 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10046 /* If we have more than the desired maximum number of lines
10047 in the *Messages* buffer now, delete the oldest ones.
10048 This is safe because we don't have undo in this buffer. */
10050 if (NATNUMP (Vmessage_log_max
))
10052 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10053 -XFASTINT (Vmessage_log_max
) - 1, 0);
10054 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10057 BEGV
= marker_position (oldbegv
);
10058 BEGV_BYTE
= marker_byte_position (oldbegv
);
10067 ZV
= marker_position (oldzv
);
10068 ZV_BYTE
= marker_byte_position (oldzv
);
10072 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10074 /* We can't do Fgoto_char (oldpoint) because it will run some
10076 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10077 marker_byte_position (oldpoint
));
10080 unchain_marker (XMARKER (oldpoint
));
10081 unchain_marker (XMARKER (oldbegv
));
10082 unchain_marker (XMARKER (oldzv
));
10084 /* We called insert_1_both above with its 5th argument (PREPARE)
10085 zero, which prevents insert_1_both from calling
10086 prepare_to_modify_buffer, which in turns prevents us from
10087 incrementing windows_or_buffers_changed even if *Messages* is
10088 shown in some window. So we must manually set
10089 windows_or_buffers_changed here to make up for that. */
10090 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10091 bset_redisplay (current_buffer
);
10093 set_buffer_internal (oldbuf
);
10095 message_log_need_newline
= !nlflag
;
10096 Vdeactivate_mark
= old_deactivate_mark
;
10101 /* We are at the end of the buffer after just having inserted a newline.
10102 (Note: We depend on the fact we won't be crossing the gap.)
10103 Check to see if the most recent message looks a lot like the previous one.
10104 Return 0 if different, 1 if the new one should just replace it, or a
10105 value N > 1 if we should also append " [N times]". */
10108 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10111 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10113 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10114 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10116 for (i
= 0; i
< len
; i
++)
10118 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10120 if (p1
[i
] != p2
[i
])
10126 if (*p1
++ == ' ' && *p1
++ == '[')
10129 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10130 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10137 /* Display an echo area message M with a specified length of NBYTES
10138 bytes. The string may include null characters. If M is not a
10139 string, clear out any existing message, and let the mini-buffer
10142 This function cancels echoing. */
10145 message3 (Lisp_Object m
)
10147 struct gcpro gcpro1
;
10150 clear_message (true, true);
10153 /* First flush out any partial line written with print. */
10154 message_log_maybe_newline ();
10157 ptrdiff_t nbytes
= SBYTES (m
);
10158 bool multibyte
= STRING_MULTIBYTE (m
);
10161 SAFE_ALLOCA_STRING (buffer
, m
);
10162 message_dolog (buffer
, nbytes
, 1, multibyte
);
10165 message3_nolog (m
);
10171 /* The non-logging version of message3.
10172 This does not cancel echoing, because it is used for echoing.
10173 Perhaps we need to make a separate function for echoing
10174 and make this cancel echoing. */
10177 message3_nolog (Lisp_Object m
)
10179 struct frame
*sf
= SELECTED_FRAME ();
10181 if (FRAME_INITIAL_P (sf
))
10183 if (noninteractive_need_newline
)
10184 putc ('\n', stderr
);
10185 noninteractive_need_newline
= 0;
10188 Lisp_Object s
= ENCODE_SYSTEM (m
);
10190 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10192 if (cursor_in_echo_area
== 0)
10193 fprintf (stderr
, "\n");
10196 /* Error messages get reported properly by cmd_error, so this must be just an
10197 informative message; if the frame hasn't really been initialized yet, just
10199 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10201 /* Get the frame containing the mini-buffer
10202 that the selected frame is using. */
10203 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10204 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10205 struct frame
*f
= XFRAME (frame
);
10207 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10208 Fmake_frame_visible (frame
);
10210 if (STRINGP (m
) && SCHARS (m
) > 0)
10213 if (minibuffer_auto_raise
)
10214 Fraise_frame (frame
);
10215 /* Assume we are not echoing.
10216 (If we are, echo_now will override this.) */
10217 echo_message_buffer
= Qnil
;
10220 clear_message (true, true);
10222 do_pending_window_change (false);
10223 echo_area_display (true);
10224 do_pending_window_change (false);
10225 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10226 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10231 /* Display a null-terminated echo area message M. If M is 0, clear
10232 out any existing message, and let the mini-buffer text show through.
10234 The buffer M must continue to exist until after the echo area gets
10235 cleared or some other message gets displayed there. Do not pass
10236 text that is stored in a Lisp string. Do not pass text in a buffer
10237 that was alloca'd. */
10240 message1 (const char *m
)
10242 message3 (m
? build_unibyte_string (m
) : Qnil
);
10246 /* The non-logging counterpart of message1. */
10249 message1_nolog (const char *m
)
10251 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10254 /* Display a message M which contains a single %s
10255 which gets replaced with STRING. */
10258 message_with_string (const char *m
, Lisp_Object string
, int log
)
10260 CHECK_STRING (string
);
10262 if (noninteractive
)
10266 /* ENCODE_SYSTEM below can GC and/or relocate the
10267 Lisp data, so make sure we don't use it here. */
10268 eassert (relocatable_string_data_p (m
) != 1);
10270 if (noninteractive_need_newline
)
10271 putc ('\n', stderr
);
10272 noninteractive_need_newline
= 0;
10273 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10274 if (!cursor_in_echo_area
)
10275 fprintf (stderr
, "\n");
10279 else if (INTERACTIVE
)
10281 /* The frame whose minibuffer we're going to display the message on.
10282 It may be larger than the selected frame, so we need
10283 to use its buffer, not the selected frame's buffer. */
10284 Lisp_Object mini_window
;
10285 struct frame
*f
, *sf
= SELECTED_FRAME ();
10287 /* Get the frame containing the minibuffer
10288 that the selected frame is using. */
10289 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10290 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10292 /* Error messages get reported properly by cmd_error, so this must be
10293 just an informative message; if the frame hasn't really been
10294 initialized yet, just toss it. */
10295 if (f
->glyphs_initialized_p
)
10297 Lisp_Object args
[2], msg
;
10298 struct gcpro gcpro1
, gcpro2
;
10300 args
[0] = build_string (m
);
10301 args
[1] = msg
= string
;
10302 GCPRO2 (args
[0], msg
);
10305 msg
= Fformat (2, args
);
10310 message3_nolog (msg
);
10314 /* Print should start at the beginning of the message
10315 buffer next time. */
10316 message_buf_print
= 0;
10322 /* Dump an informative message to the minibuf. If M is 0, clear out
10323 any existing message, and let the mini-buffer text show through. */
10326 vmessage (const char *m
, va_list ap
)
10328 if (noninteractive
)
10332 if (noninteractive_need_newline
)
10333 putc ('\n', stderr
);
10334 noninteractive_need_newline
= 0;
10335 vfprintf (stderr
, m
, ap
);
10336 if (cursor_in_echo_area
== 0)
10337 fprintf (stderr
, "\n");
10341 else if (INTERACTIVE
)
10343 /* The frame whose mini-buffer we're going to display the message
10344 on. It may be larger than the selected frame, so we need to
10345 use its buffer, not the selected frame's buffer. */
10346 Lisp_Object mini_window
;
10347 struct frame
*f
, *sf
= SELECTED_FRAME ();
10349 /* Get the frame containing the mini-buffer
10350 that the selected frame is using. */
10351 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10352 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10354 /* Error messages get reported properly by cmd_error, so this must be
10355 just an informative message; if the frame hasn't really been
10356 initialized yet, just toss it. */
10357 if (f
->glyphs_initialized_p
)
10362 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10364 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10366 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10368 message3 (make_string (message_buf
, len
));
10374 /* Print should start at the beginning of the message
10375 buffer next time. */
10376 message_buf_print
= 0;
10382 message (const char *m
, ...)
10392 /* The non-logging version of message. */
10395 message_nolog (const char *m
, ...)
10397 Lisp_Object old_log_max
;
10400 old_log_max
= Vmessage_log_max
;
10401 Vmessage_log_max
= Qnil
;
10403 Vmessage_log_max
= old_log_max
;
10409 /* Display the current message in the current mini-buffer. This is
10410 only called from error handlers in process.c, and is not time
10414 update_echo_area (void)
10416 if (!NILP (echo_area_buffer
[0]))
10418 Lisp_Object string
;
10419 string
= Fcurrent_message ();
10425 /* Make sure echo area buffers in `echo_buffers' are live.
10426 If they aren't, make new ones. */
10429 ensure_echo_area_buffers (void)
10433 for (i
= 0; i
< 2; ++i
)
10434 if (!BUFFERP (echo_buffer
[i
])
10435 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10438 Lisp_Object old_buffer
;
10441 old_buffer
= echo_buffer
[i
];
10442 echo_buffer
[i
] = Fget_buffer_create
10443 (make_formatted_string (name
, " *Echo Area %d*", i
));
10444 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10445 /* to force word wrap in echo area -
10446 it was decided to postpone this*/
10447 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10449 for (j
= 0; j
< 2; ++j
)
10450 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10451 echo_area_buffer
[j
] = echo_buffer
[i
];
10456 /* Call FN with args A1..A2 with either the current or last displayed
10457 echo_area_buffer as current buffer.
10459 WHICH zero means use the current message buffer
10460 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10461 from echo_buffer[] and clear it.
10463 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10464 suitable buffer from echo_buffer[] and clear it.
10466 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10467 that the current message becomes the last displayed one, make
10468 choose a suitable buffer for echo_area_buffer[0], and clear it.
10470 Value is what FN returns. */
10473 with_echo_area_buffer (struct window
*w
, int which
,
10474 int (*fn
) (ptrdiff_t, Lisp_Object
),
10475 ptrdiff_t a1
, Lisp_Object a2
)
10477 Lisp_Object buffer
;
10478 int this_one
, the_other
, clear_buffer_p
, rc
;
10479 ptrdiff_t count
= SPECPDL_INDEX ();
10481 /* If buffers aren't live, make new ones. */
10482 ensure_echo_area_buffers ();
10484 clear_buffer_p
= 0;
10487 this_one
= 0, the_other
= 1;
10488 else if (which
> 0)
10489 this_one
= 1, the_other
= 0;
10492 this_one
= 0, the_other
= 1;
10493 clear_buffer_p
= true;
10495 /* We need a fresh one in case the current echo buffer equals
10496 the one containing the last displayed echo area message. */
10497 if (!NILP (echo_area_buffer
[this_one
])
10498 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10499 echo_area_buffer
[this_one
] = Qnil
;
10502 /* Choose a suitable buffer from echo_buffer[] is we don't
10504 if (NILP (echo_area_buffer
[this_one
]))
10506 echo_area_buffer
[this_one
]
10507 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10508 ? echo_buffer
[the_other
]
10509 : echo_buffer
[this_one
]);
10510 clear_buffer_p
= true;
10513 buffer
= echo_area_buffer
[this_one
];
10515 /* Don't get confused by reusing the buffer used for echoing
10516 for a different purpose. */
10517 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10520 record_unwind_protect (unwind_with_echo_area_buffer
,
10521 with_echo_area_buffer_unwind_data (w
));
10523 /* Make the echo area buffer current. Note that for display
10524 purposes, it is not necessary that the displayed window's buffer
10525 == current_buffer, except for text property lookup. So, let's
10526 only set that buffer temporarily here without doing a full
10527 Fset_window_buffer. We must also change w->pointm, though,
10528 because otherwise an assertions in unshow_buffer fails, and Emacs
10530 set_buffer_internal_1 (XBUFFER (buffer
));
10533 wset_buffer (w
, buffer
);
10534 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10535 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10538 bset_undo_list (current_buffer
, Qt
);
10539 bset_read_only (current_buffer
, Qnil
);
10540 specbind (Qinhibit_read_only
, Qt
);
10541 specbind (Qinhibit_modification_hooks
, Qt
);
10543 if (clear_buffer_p
&& Z
> BEG
)
10544 del_range (BEG
, Z
);
10546 eassert (BEGV
>= BEG
);
10547 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10551 eassert (BEGV
>= BEG
);
10552 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10554 unbind_to (count
, Qnil
);
10559 /* Save state that should be preserved around the call to the function
10560 FN called in with_echo_area_buffer. */
10563 with_echo_area_buffer_unwind_data (struct window
*w
)
10566 Lisp_Object vector
, tmp
;
10568 /* Reduce consing by keeping one vector in
10569 Vwith_echo_area_save_vector. */
10570 vector
= Vwith_echo_area_save_vector
;
10571 Vwith_echo_area_save_vector
= Qnil
;
10574 vector
= Fmake_vector (make_number (11), Qnil
);
10576 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10577 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10578 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10582 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10583 ASET (vector
, i
, w
->contents
); ++i
;
10584 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10585 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10586 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10587 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10588 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10589 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10594 for (; i
< end
; ++i
)
10595 ASET (vector
, i
, Qnil
);
10598 eassert (i
== ASIZE (vector
));
10603 /* Restore global state from VECTOR which was created by
10604 with_echo_area_buffer_unwind_data. */
10607 unwind_with_echo_area_buffer (Lisp_Object vector
)
10609 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10610 Vdeactivate_mark
= AREF (vector
, 1);
10611 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10613 if (WINDOWP (AREF (vector
, 3)))
10616 Lisp_Object buffer
;
10618 w
= XWINDOW (AREF (vector
, 3));
10619 buffer
= AREF (vector
, 4);
10621 wset_buffer (w
, buffer
);
10622 set_marker_both (w
->pointm
, buffer
,
10623 XFASTINT (AREF (vector
, 5)),
10624 XFASTINT (AREF (vector
, 6)));
10625 set_marker_both (w
->old_pointm
, buffer
,
10626 XFASTINT (AREF (vector
, 7)),
10627 XFASTINT (AREF (vector
, 8)));
10628 set_marker_both (w
->start
, buffer
,
10629 XFASTINT (AREF (vector
, 9)),
10630 XFASTINT (AREF (vector
, 10)));
10633 Vwith_echo_area_save_vector
= vector
;
10637 /* Set up the echo area for use by print functions. MULTIBYTE_P
10638 non-zero means we will print multibyte. */
10641 setup_echo_area_for_printing (int multibyte_p
)
10643 /* If we can't find an echo area any more, exit. */
10644 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10645 Fkill_emacs (Qnil
);
10647 ensure_echo_area_buffers ();
10649 if (!message_buf_print
)
10651 /* A message has been output since the last time we printed.
10652 Choose a fresh echo area buffer. */
10653 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10654 echo_area_buffer
[0] = echo_buffer
[1];
10656 echo_area_buffer
[0] = echo_buffer
[0];
10658 /* Switch to that buffer and clear it. */
10659 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10660 bset_truncate_lines (current_buffer
, Qnil
);
10664 ptrdiff_t count
= SPECPDL_INDEX ();
10665 specbind (Qinhibit_read_only
, Qt
);
10666 /* Note that undo recording is always disabled. */
10667 del_range (BEG
, Z
);
10668 unbind_to (count
, Qnil
);
10670 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10672 /* Set up the buffer for the multibyteness we need. */
10674 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10675 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10677 /* Raise the frame containing the echo area. */
10678 if (minibuffer_auto_raise
)
10680 struct frame
*sf
= SELECTED_FRAME ();
10681 Lisp_Object mini_window
;
10682 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10683 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10686 message_log_maybe_newline ();
10687 message_buf_print
= 1;
10691 if (NILP (echo_area_buffer
[0]))
10693 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10694 echo_area_buffer
[0] = echo_buffer
[1];
10696 echo_area_buffer
[0] = echo_buffer
[0];
10699 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10701 /* Someone switched buffers between print requests. */
10702 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10703 bset_truncate_lines (current_buffer
, Qnil
);
10709 /* Display an echo area message in window W. Value is non-zero if W's
10710 height is changed. If display_last_displayed_message_p is
10711 non-zero, display the message that was last displayed, otherwise
10712 display the current message. */
10715 display_echo_area (struct window
*w
)
10717 int i
, no_message_p
, window_height_changed_p
;
10719 /* Temporarily disable garbage collections while displaying the echo
10720 area. This is done because a GC can print a message itself.
10721 That message would modify the echo area buffer's contents while a
10722 redisplay of the buffer is going on, and seriously confuse
10724 ptrdiff_t count
= inhibit_garbage_collection ();
10726 /* If there is no message, we must call display_echo_area_1
10727 nevertheless because it resizes the window. But we will have to
10728 reset the echo_area_buffer in question to nil at the end because
10729 with_echo_area_buffer will sets it to an empty buffer. */
10730 i
= display_last_displayed_message_p
? 1 : 0;
10731 no_message_p
= NILP (echo_area_buffer
[i
]);
10733 window_height_changed_p
10734 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10735 display_echo_area_1
,
10736 (intptr_t) w
, Qnil
);
10739 echo_area_buffer
[i
] = Qnil
;
10741 unbind_to (count
, Qnil
);
10742 return window_height_changed_p
;
10746 /* Helper for display_echo_area. Display the current buffer which
10747 contains the current echo area message in window W, a mini-window,
10748 a pointer to which is passed in A1. A2..A4 are currently not used.
10749 Change the height of W so that all of the message is displayed.
10750 Value is non-zero if height of W was changed. */
10753 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10756 struct window
*w
= (struct window
*) i1
;
10757 Lisp_Object window
;
10758 struct text_pos start
;
10759 int window_height_changed_p
= 0;
10761 /* Do this before displaying, so that we have a large enough glyph
10762 matrix for the display. If we can't get enough space for the
10763 whole text, display the last N lines. That works by setting w->start. */
10764 window_height_changed_p
= resize_mini_window (w
, 0);
10766 /* Use the starting position chosen by resize_mini_window. */
10767 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10770 clear_glyph_matrix (w
->desired_matrix
);
10771 XSETWINDOW (window
, w
);
10772 try_window (window
, start
, 0);
10774 return window_height_changed_p
;
10778 /* Resize the echo area window to exactly the size needed for the
10779 currently displayed message, if there is one. If a mini-buffer
10780 is active, don't shrink it. */
10783 resize_echo_area_exactly (void)
10785 if (BUFFERP (echo_area_buffer
[0])
10786 && WINDOWP (echo_area_window
))
10788 struct window
*w
= XWINDOW (echo_area_window
);
10789 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10790 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10791 (intptr_t) w
, resize_exactly
);
10794 windows_or_buffers_changed
= 42;
10795 update_mode_lines
= 30;
10796 redisplay_internal ();
10802 /* Callback function for with_echo_area_buffer, when used from
10803 resize_echo_area_exactly. A1 contains a pointer to the window to
10804 resize, EXACTLY non-nil means resize the mini-window exactly to the
10805 size of the text displayed. A3 and A4 are not used. Value is what
10806 resize_mini_window returns. */
10809 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10812 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10816 /* Resize mini-window W to fit the size of its contents. EXACT_P
10817 means size the window exactly to the size needed. Otherwise, it's
10818 only enlarged until W's buffer is empty.
10820 Set W->start to the right place to begin display. If the whole
10821 contents fit, start at the beginning. Otherwise, start so as
10822 to make the end of the contents appear. This is particularly
10823 important for y-or-n-p, but seems desirable generally.
10825 Value is non-zero if the window height has been changed. */
10828 resize_mini_window (struct window
*w
, int exact_p
)
10830 struct frame
*f
= XFRAME (w
->frame
);
10831 int window_height_changed_p
= 0;
10833 eassert (MINI_WINDOW_P (w
));
10835 /* By default, start display at the beginning. */
10836 set_marker_both (w
->start
, w
->contents
,
10837 BUF_BEGV (XBUFFER (w
->contents
)),
10838 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10840 /* Don't resize windows while redisplaying a window; it would
10841 confuse redisplay functions when the size of the window they are
10842 displaying changes from under them. Such a resizing can happen,
10843 for instance, when which-func prints a long message while
10844 we are running fontification-functions. We're running these
10845 functions with safe_call which binds inhibit-redisplay to t. */
10846 if (!NILP (Vinhibit_redisplay
))
10849 /* Nil means don't try to resize. */
10850 if (NILP (Vresize_mini_windows
)
10851 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10854 if (!FRAME_MINIBUF_ONLY_P (f
))
10857 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10858 + WINDOW_PIXEL_HEIGHT (w
));
10859 int unit
= FRAME_LINE_HEIGHT (f
);
10860 int height
, max_height
;
10861 struct text_pos start
;
10862 struct buffer
*old_current_buffer
= NULL
;
10864 if (current_buffer
!= XBUFFER (w
->contents
))
10866 old_current_buffer
= current_buffer
;
10867 set_buffer_internal (XBUFFER (w
->contents
));
10870 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10872 /* Compute the max. number of lines specified by the user. */
10873 if (FLOATP (Vmax_mini_window_height
))
10874 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10875 else if (INTEGERP (Vmax_mini_window_height
))
10876 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10878 max_height
= total_height
/ 4;
10880 /* Correct that max. height if it's bogus. */
10881 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10883 /* Find out the height of the text in the window. */
10884 if (it
.line_wrap
== TRUNCATE
)
10889 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10890 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10891 height
= it
.current_y
+ last_height
;
10893 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10894 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10897 /* Compute a suitable window start. */
10898 if (height
> max_height
)
10900 height
= (max_height
/ unit
) * unit
;
10901 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10902 move_it_vertically_backward (&it
, height
- unit
);
10903 start
= it
.current
.pos
;
10906 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10907 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10909 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10911 /* Let it grow only, until we display an empty message, in which
10912 case the window shrinks again. */
10913 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10915 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10917 FRAME_WINDOWS_FROZEN (f
) = 1;
10918 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10919 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10921 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10922 && (exact_p
|| BEGV
== ZV
))
10924 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10926 FRAME_WINDOWS_FROZEN (f
) = 0;
10927 shrink_mini_window (w
, 1);
10928 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10933 /* Always resize to exact size needed. */
10934 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10936 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10938 FRAME_WINDOWS_FROZEN (f
) = 1;
10939 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10940 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10942 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10944 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10946 FRAME_WINDOWS_FROZEN (f
) = 0;
10947 shrink_mini_window (w
, 1);
10951 FRAME_WINDOWS_FROZEN (f
) = 1;
10952 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10955 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10959 if (old_current_buffer
)
10960 set_buffer_internal (old_current_buffer
);
10963 return window_height_changed_p
;
10967 /* Value is the current message, a string, or nil if there is no
10968 current message. */
10971 current_message (void)
10975 if (!BUFFERP (echo_area_buffer
[0]))
10979 with_echo_area_buffer (0, 0, current_message_1
,
10980 (intptr_t) &msg
, Qnil
);
10982 echo_area_buffer
[0] = Qnil
;
10990 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10993 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10996 *msg
= make_buffer_string (BEG
, Z
, 1);
11003 /* Push the current message on Vmessage_stack for later restoration
11004 by restore_message. Value is non-zero if the current message isn't
11005 empty. This is a relatively infrequent operation, so it's not
11006 worth optimizing. */
11009 push_message (void)
11011 Lisp_Object msg
= current_message ();
11012 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11013 return STRINGP (msg
);
11017 /* Restore message display from the top of Vmessage_stack. */
11020 restore_message (void)
11022 eassert (CONSP (Vmessage_stack
));
11023 message3_nolog (XCAR (Vmessage_stack
));
11027 /* Handler for unwind-protect calling pop_message. */
11030 pop_message_unwind (void)
11032 /* Pop the top-most entry off Vmessage_stack. */
11033 eassert (CONSP (Vmessage_stack
));
11034 Vmessage_stack
= XCDR (Vmessage_stack
);
11038 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11039 exits. If the stack is not empty, we have a missing pop_message
11043 check_message_stack (void)
11045 if (!NILP (Vmessage_stack
))
11050 /* Truncate to NCHARS what will be displayed in the echo area the next
11051 time we display it---but don't redisplay it now. */
11054 truncate_echo_area (ptrdiff_t nchars
)
11057 echo_area_buffer
[0] = Qnil
;
11058 else if (!noninteractive
11060 && !NILP (echo_area_buffer
[0]))
11062 struct frame
*sf
= SELECTED_FRAME ();
11063 /* Error messages get reported properly by cmd_error, so this must be
11064 just an informative message; if the frame hasn't really been
11065 initialized yet, just toss it. */
11066 if (sf
->glyphs_initialized_p
)
11067 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11072 /* Helper function for truncate_echo_area. Truncate the current
11073 message to at most NCHARS characters. */
11076 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11078 if (BEG
+ nchars
< Z
)
11079 del_range (BEG
+ nchars
, Z
);
11081 echo_area_buffer
[0] = Qnil
;
11085 /* Set the current message to STRING. */
11088 set_message (Lisp_Object string
)
11090 eassert (STRINGP (string
));
11092 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11094 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11095 message_buf_print
= 0;
11096 help_echo_showing_p
= 0;
11098 if (STRINGP (Vdebug_on_message
)
11099 && STRINGP (string
)
11100 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11101 call_debugger (list2 (Qerror
, string
));
11105 /* Helper function for set_message. First argument is ignored and second
11106 argument has the same meaning as for set_message.
11107 This function is called with the echo area buffer being current. */
11110 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11112 eassert (STRINGP (string
));
11114 /* Change multibyteness of the echo buffer appropriately. */
11115 if (message_enable_multibyte
11116 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11117 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11119 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11120 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11121 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11123 /* Insert new message at BEG. */
11124 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11126 /* This function takes care of single/multibyte conversion.
11127 We just have to ensure that the echo area buffer has the right
11128 setting of enable_multibyte_characters. */
11129 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11135 /* Clear messages. CURRENT_P non-zero means clear the current
11136 message. LAST_DISPLAYED_P non-zero means clear the message
11140 clear_message (bool current_p
, bool last_displayed_p
)
11144 echo_area_buffer
[0] = Qnil
;
11145 message_cleared_p
= true;
11148 if (last_displayed_p
)
11149 echo_area_buffer
[1] = Qnil
;
11151 message_buf_print
= 0;
11154 /* Clear garbaged frames.
11156 This function is used where the old redisplay called
11157 redraw_garbaged_frames which in turn called redraw_frame which in
11158 turn called clear_frame. The call to clear_frame was a source of
11159 flickering. I believe a clear_frame is not necessary. It should
11160 suffice in the new redisplay to invalidate all current matrices,
11161 and ensure a complete redisplay of all windows. */
11164 clear_garbaged_frames (void)
11166 if (frame_garbaged
)
11168 Lisp_Object tail
, frame
;
11170 FOR_EACH_FRAME (tail
, frame
)
11172 struct frame
*f
= XFRAME (frame
);
11174 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11179 clear_current_matrices (f
);
11180 fset_redisplay (f
);
11181 f
->garbaged
= false;
11182 f
->resized_p
= false;
11186 frame_garbaged
= false;
11191 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11192 is non-zero update selected_frame. Value is non-zero if the
11193 mini-windows height has been changed. */
11196 echo_area_display (bool update_frame_p
)
11198 Lisp_Object mini_window
;
11201 bool window_height_changed_p
= false;
11202 struct frame
*sf
= SELECTED_FRAME ();
11204 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11205 w
= XWINDOW (mini_window
);
11206 f
= XFRAME (WINDOW_FRAME (w
));
11208 /* Don't display if frame is invisible or not yet initialized. */
11209 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11212 #ifdef HAVE_WINDOW_SYSTEM
11213 /* When Emacs starts, selected_frame may be the initial terminal
11214 frame. If we let this through, a message would be displayed on
11216 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11218 #endif /* HAVE_WINDOW_SYSTEM */
11220 /* Redraw garbaged frames. */
11221 clear_garbaged_frames ();
11223 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11225 echo_area_window
= mini_window
;
11226 window_height_changed_p
= display_echo_area (w
);
11227 w
->must_be_updated_p
= true;
11229 /* Update the display, unless called from redisplay_internal.
11230 Also don't update the screen during redisplay itself. The
11231 update will happen at the end of redisplay, and an update
11232 here could cause confusion. */
11233 if (update_frame_p
&& !redisplaying_p
)
11237 /* If the display update has been interrupted by pending
11238 input, update mode lines in the frame. Due to the
11239 pending input, it might have been that redisplay hasn't
11240 been called, so that mode lines above the echo area are
11241 garbaged. This looks odd, so we prevent it here. */
11242 if (!display_completed
)
11243 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11245 if (window_height_changed_p
11246 /* Don't do this if Emacs is shutting down. Redisplay
11247 needs to run hooks. */
11248 && !NILP (Vrun_hooks
))
11250 /* Must update other windows. Likewise as in other
11251 cases, don't let this update be interrupted by
11253 ptrdiff_t count
= SPECPDL_INDEX ();
11254 specbind (Qredisplay_dont_pause
, Qt
);
11255 windows_or_buffers_changed
= 44;
11256 redisplay_internal ();
11257 unbind_to (count
, Qnil
);
11259 else if (FRAME_WINDOW_P (f
) && n
== 0)
11261 /* Window configuration is the same as before.
11262 Can do with a display update of the echo area,
11263 unless we displayed some mode lines. */
11264 update_single_window (w
);
11268 update_frame (f
, true, true);
11270 /* If cursor is in the echo area, make sure that the next
11271 redisplay displays the minibuffer, so that the cursor will
11272 be replaced with what the minibuffer wants. */
11273 if (cursor_in_echo_area
)
11274 wset_redisplay (XWINDOW (mini_window
));
11277 else if (!EQ (mini_window
, selected_window
))
11278 wset_redisplay (XWINDOW (mini_window
));
11280 /* Last displayed message is now the current message. */
11281 echo_area_buffer
[1] = echo_area_buffer
[0];
11282 /* Inform read_char that we're not echoing. */
11283 echo_message_buffer
= Qnil
;
11285 /* Prevent redisplay optimization in redisplay_internal by resetting
11286 this_line_start_pos. This is done because the mini-buffer now
11287 displays the message instead of its buffer text. */
11288 if (EQ (mini_window
, selected_window
))
11289 CHARPOS (this_line_start_pos
) = 0;
11291 return window_height_changed_p
;
11294 /* Nonzero if W's buffer was changed but not saved. */
11297 window_buffer_changed (struct window
*w
)
11299 struct buffer
*b
= XBUFFER (w
->contents
);
11301 eassert (BUFFER_LIVE_P (b
));
11303 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11306 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11309 mode_line_update_needed (struct window
*w
)
11311 return (w
->column_number_displayed
!= -1
11312 && !(PT
== w
->last_point
&& !window_outdated (w
))
11313 && (w
->column_number_displayed
!= current_column ()));
11316 /* Nonzero if window start of W is frozen and may not be changed during
11320 window_frozen_p (struct window
*w
)
11322 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11324 Lisp_Object window
;
11326 XSETWINDOW (window
, w
);
11327 if (MINI_WINDOW_P (w
))
11329 else if (EQ (window
, selected_window
))
11331 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11332 && EQ (window
, Vminibuf_scroll_window
))
11333 /* This special window can't be frozen too. */
11341 /***********************************************************************
11342 Mode Lines and Frame Titles
11343 ***********************************************************************/
11345 /* A buffer for constructing non-propertized mode-line strings and
11346 frame titles in it; allocated from the heap in init_xdisp and
11347 resized as needed in store_mode_line_noprop_char. */
11349 static char *mode_line_noprop_buf
;
11351 /* The buffer's end, and a current output position in it. */
11353 static char *mode_line_noprop_buf_end
;
11354 static char *mode_line_noprop_ptr
;
11356 #define MODE_LINE_NOPROP_LEN(start) \
11357 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11360 MODE_LINE_DISPLAY
= 0,
11364 } mode_line_target
;
11366 /* Alist that caches the results of :propertize.
11367 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11368 static Lisp_Object mode_line_proptrans_alist
;
11370 /* List of strings making up the mode-line. */
11371 static Lisp_Object mode_line_string_list
;
11373 /* Base face property when building propertized mode line string. */
11374 static Lisp_Object mode_line_string_face
;
11375 static Lisp_Object mode_line_string_face_prop
;
11378 /* Unwind data for mode line strings */
11380 static Lisp_Object Vmode_line_unwind_vector
;
11383 format_mode_line_unwind_data (struct frame
*target_frame
,
11384 struct buffer
*obuf
,
11386 int save_proptrans
)
11388 Lisp_Object vector
, tmp
;
11390 /* Reduce consing by keeping one vector in
11391 Vwith_echo_area_save_vector. */
11392 vector
= Vmode_line_unwind_vector
;
11393 Vmode_line_unwind_vector
= Qnil
;
11396 vector
= Fmake_vector (make_number (10), Qnil
);
11398 ASET (vector
, 0, make_number (mode_line_target
));
11399 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11400 ASET (vector
, 2, mode_line_string_list
);
11401 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11402 ASET (vector
, 4, mode_line_string_face
);
11403 ASET (vector
, 5, mode_line_string_face_prop
);
11406 XSETBUFFER (tmp
, obuf
);
11409 ASET (vector
, 6, tmp
);
11410 ASET (vector
, 7, owin
);
11413 /* Similarly to `with-selected-window', if the operation selects
11414 a window on another frame, we must restore that frame's
11415 selected window, and (for a tty) the top-frame. */
11416 ASET (vector
, 8, target_frame
->selected_window
);
11417 if (FRAME_TERMCAP_P (target_frame
))
11418 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11425 unwind_format_mode_line (Lisp_Object vector
)
11427 Lisp_Object old_window
= AREF (vector
, 7);
11428 Lisp_Object target_frame_window
= AREF (vector
, 8);
11429 Lisp_Object old_top_frame
= AREF (vector
, 9);
11431 mode_line_target
= XINT (AREF (vector
, 0));
11432 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11433 mode_line_string_list
= AREF (vector
, 2);
11434 if (! EQ (AREF (vector
, 3), Qt
))
11435 mode_line_proptrans_alist
= AREF (vector
, 3);
11436 mode_line_string_face
= AREF (vector
, 4);
11437 mode_line_string_face_prop
= AREF (vector
, 5);
11439 /* Select window before buffer, since it may change the buffer. */
11440 if (!NILP (old_window
))
11442 /* If the operation that we are unwinding had selected a window
11443 on a different frame, reset its frame-selected-window. For a
11444 text terminal, reset its top-frame if necessary. */
11445 if (!NILP (target_frame_window
))
11448 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11450 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11451 Fselect_window (target_frame_window
, Qt
);
11453 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11454 Fselect_frame (old_top_frame
, Qt
);
11457 Fselect_window (old_window
, Qt
);
11460 if (!NILP (AREF (vector
, 6)))
11462 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11463 ASET (vector
, 6, Qnil
);
11466 Vmode_line_unwind_vector
= vector
;
11470 /* Store a single character C for the frame title in mode_line_noprop_buf.
11471 Re-allocate mode_line_noprop_buf if necessary. */
11474 store_mode_line_noprop_char (char c
)
11476 /* If output position has reached the end of the allocated buffer,
11477 increase the buffer's size. */
11478 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11480 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11481 ptrdiff_t size
= len
;
11482 mode_line_noprop_buf
=
11483 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11484 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11485 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11488 *mode_line_noprop_ptr
++ = c
;
11492 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11493 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11494 characters that yield more columns than PRECISION; PRECISION <= 0
11495 means copy the whole string. Pad with spaces until FIELD_WIDTH
11496 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11497 pad. Called from display_mode_element when it is used to build a
11501 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11503 const unsigned char *str
= (const unsigned char *) string
;
11505 ptrdiff_t dummy
, nbytes
;
11507 /* Copy at most PRECISION chars from STR. */
11508 nbytes
= strlen (string
);
11509 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11511 store_mode_line_noprop_char (*str
++);
11513 /* Fill up with spaces until FIELD_WIDTH reached. */
11514 while (field_width
> 0
11515 && n
< field_width
)
11517 store_mode_line_noprop_char (' ');
11524 /***********************************************************************
11526 ***********************************************************************/
11528 #ifdef HAVE_WINDOW_SYSTEM
11530 /* Set the title of FRAME, if it has changed. The title format is
11531 Vicon_title_format if FRAME is iconified, otherwise it is
11532 frame_title_format. */
11535 x_consider_frame_title (Lisp_Object frame
)
11537 struct frame
*f
= XFRAME (frame
);
11539 if (FRAME_WINDOW_P (f
)
11540 || FRAME_MINIBUF_ONLY_P (f
)
11541 || f
->explicit_name
)
11543 /* Do we have more than one visible frame on this X display? */
11544 Lisp_Object tail
, other_frame
, fmt
;
11545 ptrdiff_t title_start
;
11549 ptrdiff_t count
= SPECPDL_INDEX ();
11551 FOR_EACH_FRAME (tail
, other_frame
)
11553 struct frame
*tf
= XFRAME (other_frame
);
11556 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11557 && !FRAME_MINIBUF_ONLY_P (tf
)
11558 && !EQ (other_frame
, tip_frame
)
11559 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11563 /* Set global variable indicating that multiple frames exist. */
11564 multiple_frames
= CONSP (tail
);
11566 /* Switch to the buffer of selected window of the frame. Set up
11567 mode_line_target so that display_mode_element will output into
11568 mode_line_noprop_buf; then display the title. */
11569 record_unwind_protect (unwind_format_mode_line
,
11570 format_mode_line_unwind_data
11571 (f
, current_buffer
, selected_window
, 0));
11573 Fselect_window (f
->selected_window
, Qt
);
11574 set_buffer_internal_1
11575 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11576 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11578 mode_line_target
= MODE_LINE_TITLE
;
11579 title_start
= MODE_LINE_NOPROP_LEN (0);
11580 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11581 NULL
, DEFAULT_FACE_ID
);
11582 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11583 len
= MODE_LINE_NOPROP_LEN (title_start
);
11584 title
= mode_line_noprop_buf
+ title_start
;
11585 unbind_to (count
, Qnil
);
11587 /* Set the title only if it's changed. This avoids consing in
11588 the common case where it hasn't. (If it turns out that we've
11589 already wasted too much time by walking through the list with
11590 display_mode_element, then we might need to optimize at a
11591 higher level than this.) */
11592 if (! STRINGP (f
->name
)
11593 || SBYTES (f
->name
) != len
11594 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11595 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11599 #endif /* not HAVE_WINDOW_SYSTEM */
11602 /***********************************************************************
11604 ***********************************************************************/
11606 /* Non-zero if we will not redisplay all visible windows. */
11607 #define REDISPLAY_SOME_P() \
11608 ((windows_or_buffers_changed == 0 \
11609 || windows_or_buffers_changed == REDISPLAY_SOME) \
11610 && (update_mode_lines == 0 \
11611 || update_mode_lines == REDISPLAY_SOME))
11613 /* Prepare for redisplay by updating menu-bar item lists when
11614 appropriate. This can call eval. */
11617 prepare_menu_bars (void)
11619 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11620 bool some_windows
= REDISPLAY_SOME_P ();
11621 struct gcpro gcpro1
, gcpro2
;
11622 Lisp_Object tooltip_frame
;
11624 #ifdef HAVE_WINDOW_SYSTEM
11625 tooltip_frame
= tip_frame
;
11627 tooltip_frame
= Qnil
;
11630 if (FUNCTIONP (Vpre_redisplay_function
))
11632 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11633 if (all_windows
&& some_windows
)
11635 Lisp_Object ws
= window_list ();
11636 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11638 Lisp_Object
this = XCAR (ws
);
11639 struct window
*w
= XWINDOW (this);
11641 || XFRAME (w
->frame
)->redisplay
11642 || XBUFFER (w
->contents
)->text
->redisplay
)
11644 windows
= Fcons (this, windows
);
11648 safe__call1 (true, Vpre_redisplay_function
, windows
);
11651 /* Update all frame titles based on their buffer names, etc. We do
11652 this before the menu bars so that the buffer-menu will show the
11653 up-to-date frame titles. */
11654 #ifdef HAVE_WINDOW_SYSTEM
11657 Lisp_Object tail
, frame
;
11659 FOR_EACH_FRAME (tail
, frame
)
11661 struct frame
*f
= XFRAME (frame
);
11662 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11666 && !XBUFFER (w
->contents
)->text
->redisplay
)
11669 if (!EQ (frame
, tooltip_frame
)
11670 && (FRAME_ICONIFIED_P (f
)
11671 || FRAME_VISIBLE_P (f
) == 1
11672 /* Exclude TTY frames that are obscured because they
11673 are not the top frame on their console. This is
11674 because x_consider_frame_title actually switches
11675 to the frame, which for TTY frames means it is
11676 marked as garbaged, and will be completely
11677 redrawn on the next redisplay cycle. This causes
11678 TTY frames to be completely redrawn, when there
11679 are more than one of them, even though nothing
11680 should be changed on display. */
11681 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11682 x_consider_frame_title (frame
);
11685 #endif /* HAVE_WINDOW_SYSTEM */
11687 /* Update the menu bar item lists, if appropriate. This has to be
11688 done before any actual redisplay or generation of display lines. */
11692 Lisp_Object tail
, frame
;
11693 ptrdiff_t count
= SPECPDL_INDEX ();
11694 /* 1 means that update_menu_bar has run its hooks
11695 so any further calls to update_menu_bar shouldn't do so again. */
11696 int menu_bar_hooks_run
= 0;
11698 record_unwind_save_match_data ();
11700 FOR_EACH_FRAME (tail
, frame
)
11702 struct frame
*f
= XFRAME (frame
);
11703 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11705 /* Ignore tooltip frame. */
11706 if (EQ (frame
, tooltip_frame
))
11712 && !XBUFFER (w
->contents
)->text
->redisplay
)
11715 /* If a window on this frame changed size, report that to
11716 the user and clear the size-change flag. */
11717 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11719 Lisp_Object functions
;
11721 /* Clear flag first in case we get an error below. */
11722 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11723 functions
= Vwindow_size_change_functions
;
11724 GCPRO2 (tail
, functions
);
11726 while (CONSP (functions
))
11728 if (!EQ (XCAR (functions
), Qt
))
11729 call1 (XCAR (functions
), frame
);
11730 functions
= XCDR (functions
);
11736 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11737 #ifdef HAVE_WINDOW_SYSTEM
11738 update_tool_bar (f
, 0);
11743 unbind_to (count
, Qnil
);
11747 struct frame
*sf
= SELECTED_FRAME ();
11748 update_menu_bar (sf
, 1, 0);
11749 #ifdef HAVE_WINDOW_SYSTEM
11750 update_tool_bar (sf
, 1);
11756 /* Update the menu bar item list for frame F. This has to be done
11757 before we start to fill in any display lines, because it can call
11760 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11762 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11763 already ran the menu bar hooks for this redisplay, so there
11764 is no need to run them again. The return value is the
11765 updated value of this flag, to pass to the next call. */
11768 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11770 Lisp_Object window
;
11771 register struct window
*w
;
11773 /* If called recursively during a menu update, do nothing. This can
11774 happen when, for instance, an activate-menubar-hook causes a
11776 if (inhibit_menubar_update
)
11779 window
= FRAME_SELECTED_WINDOW (f
);
11780 w
= XWINDOW (window
);
11782 if (FRAME_WINDOW_P (f
)
11784 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11785 || defined (HAVE_NS) || defined (USE_GTK)
11786 FRAME_EXTERNAL_MENU_BAR (f
)
11788 FRAME_MENU_BAR_LINES (f
) > 0
11790 : FRAME_MENU_BAR_LINES (f
) > 0)
11792 /* If the user has switched buffers or windows, we need to
11793 recompute to reflect the new bindings. But we'll
11794 recompute when update_mode_lines is set too; that means
11795 that people can use force-mode-line-update to request
11796 that the menu bar be recomputed. The adverse effect on
11797 the rest of the redisplay algorithm is about the same as
11798 windows_or_buffers_changed anyway. */
11799 if (windows_or_buffers_changed
11800 /* This used to test w->update_mode_line, but we believe
11801 there is no need to recompute the menu in that case. */
11802 || update_mode_lines
11803 || window_buffer_changed (w
))
11805 struct buffer
*prev
= current_buffer
;
11806 ptrdiff_t count
= SPECPDL_INDEX ();
11808 specbind (Qinhibit_menubar_update
, Qt
);
11810 set_buffer_internal_1 (XBUFFER (w
->contents
));
11811 if (save_match_data
)
11812 record_unwind_save_match_data ();
11813 if (NILP (Voverriding_local_map_menu_flag
))
11815 specbind (Qoverriding_terminal_local_map
, Qnil
);
11816 specbind (Qoverriding_local_map
, Qnil
);
11821 /* Run the Lucid hook. */
11822 safe_run_hooks (Qactivate_menubar_hook
);
11824 /* If it has changed current-menubar from previous value,
11825 really recompute the menu-bar from the value. */
11826 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11827 call0 (Qrecompute_lucid_menubar
);
11829 safe_run_hooks (Qmenu_bar_update_hook
);
11834 XSETFRAME (Vmenu_updating_frame
, f
);
11835 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11837 /* Redisplay the menu bar in case we changed it. */
11838 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11839 || defined (HAVE_NS) || defined (USE_GTK)
11840 if (FRAME_WINDOW_P (f
))
11842 #if defined (HAVE_NS)
11843 /* All frames on Mac OS share the same menubar. So only
11844 the selected frame should be allowed to set it. */
11845 if (f
== SELECTED_FRAME ())
11847 set_frame_menubar (f
, 0, 0);
11850 /* On a terminal screen, the menu bar is an ordinary screen
11851 line, and this makes it get updated. */
11852 w
->update_mode_line
= 1;
11853 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11854 /* In the non-toolkit version, the menu bar is an ordinary screen
11855 line, and this makes it get updated. */
11856 w
->update_mode_line
= 1;
11857 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11859 unbind_to (count
, Qnil
);
11860 set_buffer_internal_1 (prev
);
11867 /***********************************************************************
11869 ***********************************************************************/
11871 #ifdef HAVE_WINDOW_SYSTEM
11873 /* Select `frame' temporarily without running all the code in
11875 FIXME: Maybe do_switch_frame should be trimmed down similarly
11876 when `norecord' is set. */
11878 fast_set_selected_frame (Lisp_Object frame
)
11880 if (!EQ (selected_frame
, frame
))
11882 selected_frame
= frame
;
11883 selected_window
= XFRAME (frame
)->selected_window
;
11887 /* Update the tool-bar item list for frame F. This has to be done
11888 before we start to fill in any display lines. Called from
11889 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11890 and restore it here. */
11893 update_tool_bar (struct frame
*f
, int save_match_data
)
11895 #if defined (USE_GTK) || defined (HAVE_NS)
11896 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11898 int do_update
= (WINDOWP (f
->tool_bar_window
)
11899 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11904 Lisp_Object window
;
11907 window
= FRAME_SELECTED_WINDOW (f
);
11908 w
= XWINDOW (window
);
11910 /* If the user has switched buffers or windows, we need to
11911 recompute to reflect the new bindings. But we'll
11912 recompute when update_mode_lines is set too; that means
11913 that people can use force-mode-line-update to request
11914 that the menu bar be recomputed. The adverse effect on
11915 the rest of the redisplay algorithm is about the same as
11916 windows_or_buffers_changed anyway. */
11917 if (windows_or_buffers_changed
11918 || w
->update_mode_line
11919 || update_mode_lines
11920 || window_buffer_changed (w
))
11922 struct buffer
*prev
= current_buffer
;
11923 ptrdiff_t count
= SPECPDL_INDEX ();
11924 Lisp_Object frame
, new_tool_bar
;
11925 int new_n_tool_bar
;
11926 struct gcpro gcpro1
;
11928 /* Set current_buffer to the buffer of the selected
11929 window of the frame, so that we get the right local
11931 set_buffer_internal_1 (XBUFFER (w
->contents
));
11933 /* Save match data, if we must. */
11934 if (save_match_data
)
11935 record_unwind_save_match_data ();
11937 /* Make sure that we don't accidentally use bogus keymaps. */
11938 if (NILP (Voverriding_local_map_menu_flag
))
11940 specbind (Qoverriding_terminal_local_map
, Qnil
);
11941 specbind (Qoverriding_local_map
, Qnil
);
11944 GCPRO1 (new_tool_bar
);
11946 /* We must temporarily set the selected frame to this frame
11947 before calling tool_bar_items, because the calculation of
11948 the tool-bar keymap uses the selected frame (see
11949 `tool-bar-make-keymap' in tool-bar.el). */
11950 eassert (EQ (selected_window
,
11951 /* Since we only explicitly preserve selected_frame,
11952 check that selected_window would be redundant. */
11953 XFRAME (selected_frame
)->selected_window
));
11954 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11955 XSETFRAME (frame
, f
);
11956 fast_set_selected_frame (frame
);
11958 /* Build desired tool-bar items from keymaps. */
11960 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11963 /* Redisplay the tool-bar if we changed it. */
11964 if (new_n_tool_bar
!= f
->n_tool_bar_items
11965 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11967 /* Redisplay that happens asynchronously due to an expose event
11968 may access f->tool_bar_items. Make sure we update both
11969 variables within BLOCK_INPUT so no such event interrupts. */
11971 fset_tool_bar_items (f
, new_tool_bar
);
11972 f
->n_tool_bar_items
= new_n_tool_bar
;
11973 w
->update_mode_line
= 1;
11979 unbind_to (count
, Qnil
);
11980 set_buffer_internal_1 (prev
);
11985 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11987 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11988 F's desired tool-bar contents. F->tool_bar_items must have
11989 been set up previously by calling prepare_menu_bars. */
11992 build_desired_tool_bar_string (struct frame
*f
)
11994 int i
, size
, size_needed
;
11995 struct gcpro gcpro1
, gcpro2
;
11996 Lisp_Object image
, plist
;
11998 image
= plist
= Qnil
;
11999 GCPRO2 (image
, plist
);
12001 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12002 Otherwise, make a new string. */
12004 /* The size of the string we might be able to reuse. */
12005 size
= (STRINGP (f
->desired_tool_bar_string
)
12006 ? SCHARS (f
->desired_tool_bar_string
)
12009 /* We need one space in the string for each image. */
12010 size_needed
= f
->n_tool_bar_items
;
12012 /* Reuse f->desired_tool_bar_string, if possible. */
12013 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12014 fset_desired_tool_bar_string
12015 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12018 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12019 struct gcpro gcpro1
;
12021 Fremove_text_properties (make_number (0), make_number (size
),
12022 props
, f
->desired_tool_bar_string
);
12026 /* Put a `display' property on the string for the images to display,
12027 put a `menu_item' property on tool-bar items with a value that
12028 is the index of the item in F's tool-bar item vector. */
12029 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12031 #define PROP(IDX) \
12032 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12034 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12035 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12036 int hmargin
, vmargin
, relief
, idx
, end
;
12038 /* If image is a vector, choose the image according to the
12040 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12041 if (VECTORP (image
))
12045 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12046 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12049 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12050 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12052 eassert (ASIZE (image
) >= idx
);
12053 image
= AREF (image
, idx
);
12058 /* Ignore invalid image specifications. */
12059 if (!valid_image_p (image
))
12062 /* Display the tool-bar button pressed, or depressed. */
12063 plist
= Fcopy_sequence (XCDR (image
));
12065 /* Compute margin and relief to draw. */
12066 relief
= (tool_bar_button_relief
>= 0
12067 ? tool_bar_button_relief
12068 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12069 hmargin
= vmargin
= relief
;
12071 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12072 INT_MAX
- max (hmargin
, vmargin
)))
12074 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12075 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12077 else if (CONSP (Vtool_bar_button_margin
))
12079 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12080 INT_MAX
- hmargin
))
12081 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12083 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12084 INT_MAX
- vmargin
))
12085 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12088 if (auto_raise_tool_bar_buttons_p
)
12090 /* Add a `:relief' property to the image spec if the item is
12094 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12101 /* If image is selected, display it pressed, i.e. with a
12102 negative relief. If it's not selected, display it with a
12104 plist
= Fplist_put (plist
, QCrelief
,
12106 ? make_number (-relief
)
12107 : make_number (relief
)));
12112 /* Put a margin around the image. */
12113 if (hmargin
|| vmargin
)
12115 if (hmargin
== vmargin
)
12116 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12118 plist
= Fplist_put (plist
, QCmargin
,
12119 Fcons (make_number (hmargin
),
12120 make_number (vmargin
)));
12123 /* If button is not enabled, and we don't have special images
12124 for the disabled state, make the image appear disabled by
12125 applying an appropriate algorithm to it. */
12126 if (!enabled_p
&& idx
< 0)
12127 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12129 /* Put a `display' text property on the string for the image to
12130 display. Put a `menu-item' property on the string that gives
12131 the start of this item's properties in the tool-bar items
12133 image
= Fcons (Qimage
, plist
);
12134 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12135 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12136 struct gcpro gcpro1
;
12139 /* Let the last image hide all remaining spaces in the tool bar
12140 string. The string can be longer than needed when we reuse a
12141 previous string. */
12142 if (i
+ 1 == f
->n_tool_bar_items
)
12143 end
= SCHARS (f
->desired_tool_bar_string
);
12146 Fadd_text_properties (make_number (i
), make_number (end
),
12147 props
, f
->desired_tool_bar_string
);
12156 /* Display one line of the tool-bar of frame IT->f.
12158 HEIGHT specifies the desired height of the tool-bar line.
12159 If the actual height of the glyph row is less than HEIGHT, the
12160 row's height is increased to HEIGHT, and the icons are centered
12161 vertically in the new height.
12163 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12164 count a final empty row in case the tool-bar width exactly matches
12169 display_tool_bar_line (struct it
*it
, int height
)
12171 struct glyph_row
*row
= it
->glyph_row
;
12172 int max_x
= it
->last_visible_x
;
12173 struct glyph
*last
;
12175 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12176 clear_glyph_row (row
);
12177 row
->enabled_p
= true;
12178 row
->y
= it
->current_y
;
12180 /* Note that this isn't made use of if the face hasn't a box,
12181 so there's no need to check the face here. */
12182 it
->start_of_box_run_p
= 1;
12184 while (it
->current_x
< max_x
)
12186 int x
, n_glyphs_before
, i
, nglyphs
;
12187 struct it it_before
;
12189 /* Get the next display element. */
12190 if (!get_next_display_element (it
))
12192 /* Don't count empty row if we are counting needed tool-bar lines. */
12193 if (height
< 0 && !it
->hpos
)
12198 /* Produce glyphs. */
12199 n_glyphs_before
= row
->used
[TEXT_AREA
];
12202 PRODUCE_GLYPHS (it
);
12204 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12206 x
= it_before
.current_x
;
12207 while (i
< nglyphs
)
12209 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12211 if (x
+ glyph
->pixel_width
> max_x
)
12213 /* Glyph doesn't fit on line. Backtrack. */
12214 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12216 /* If this is the only glyph on this line, it will never fit on the
12217 tool-bar, so skip it. But ensure there is at least one glyph,
12218 so we don't accidentally disable the tool-bar. */
12219 if (n_glyphs_before
== 0
12220 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12226 x
+= glyph
->pixel_width
;
12230 /* Stop at line end. */
12231 if (ITERATOR_AT_END_OF_LINE_P (it
))
12234 set_iterator_to_next (it
, 1);
12239 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12241 /* Use default face for the border below the tool bar.
12243 FIXME: When auto-resize-tool-bars is grow-only, there is
12244 no additional border below the possibly empty tool-bar lines.
12245 So to make the extra empty lines look "normal", we have to
12246 use the tool-bar face for the border too. */
12247 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12248 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12249 it
->face_id
= DEFAULT_FACE_ID
;
12251 extend_face_to_end_of_line (it
);
12252 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12253 last
->right_box_line_p
= 1;
12254 if (last
== row
->glyphs
[TEXT_AREA
])
12255 last
->left_box_line_p
= 1;
12257 /* Make line the desired height and center it vertically. */
12258 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12260 /* Don't add more than one line height. */
12261 height
%= FRAME_LINE_HEIGHT (it
->f
);
12262 it
->max_ascent
+= height
/ 2;
12263 it
->max_descent
+= (height
+ 1) / 2;
12266 compute_line_metrics (it
);
12268 /* If line is empty, make it occupy the rest of the tool-bar. */
12269 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12271 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12272 row
->visible_height
= row
->height
;
12273 row
->ascent
= row
->phys_ascent
= 0;
12274 row
->extra_line_spacing
= 0;
12277 row
->full_width_p
= 1;
12278 row
->continued_p
= 0;
12279 row
->truncated_on_left_p
= 0;
12280 row
->truncated_on_right_p
= 0;
12282 it
->current_x
= it
->hpos
= 0;
12283 it
->current_y
+= row
->height
;
12289 /* Value is the number of pixels needed to make all tool-bar items of
12290 frame F visible. The actual number of glyph rows needed is
12291 returned in *N_ROWS if non-NULL. */
12293 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12295 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12297 /* tool_bar_height is called from redisplay_tool_bar after building
12298 the desired matrix, so use (unused) mode-line row as temporary row to
12299 avoid destroying the first tool-bar row. */
12300 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12302 /* Initialize an iterator for iteration over
12303 F->desired_tool_bar_string in the tool-bar window of frame F. */
12304 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12305 temp_row
->reversed_p
= false;
12306 it
.first_visible_x
= 0;
12307 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12308 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12309 it
.paragraph_embedding
= L2R
;
12311 while (!ITERATOR_AT_END_P (&it
))
12313 clear_glyph_row (temp_row
);
12314 it
.glyph_row
= temp_row
;
12315 display_tool_bar_line (&it
, -1);
12317 clear_glyph_row (temp_row
);
12319 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12321 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12324 return it
.current_y
;
12326 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12329 #endif /* !USE_GTK && !HAVE_NS */
12331 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12333 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12334 If FRAME is nil or omitted, use the selected frame. Optional argument
12335 PIXELWISE non-nil means return the height of the tool bar in pixels. */
12337 (Lisp_Object frame
, Lisp_Object pixelwise
)
12341 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12342 struct frame
*f
= decode_any_frame (frame
);
12344 if (WINDOWP (f
->tool_bar_window
)
12345 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12347 update_tool_bar (f
, 1);
12348 if (f
->n_tool_bar_items
)
12350 build_desired_tool_bar_string (f
);
12351 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12356 return make_number (height
);
12360 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12361 height should be changed. */
12363 redisplay_tool_bar (struct frame
*f
)
12365 #if defined (USE_GTK) || defined (HAVE_NS)
12367 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12368 update_frame_tool_bar (f
);
12371 #else /* !USE_GTK && !HAVE_NS */
12375 struct glyph_row
*row
;
12377 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12378 do anything. This means you must start with tool-bar-lines
12379 non-zero to get the auto-sizing effect. Or in other words, you
12380 can turn off tool-bars by specifying tool-bar-lines zero. */
12381 if (!WINDOWP (f
->tool_bar_window
)
12382 || (w
= XWINDOW (f
->tool_bar_window
),
12383 WINDOW_TOTAL_LINES (w
) == 0))
12386 /* Set up an iterator for the tool-bar window. */
12387 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12388 it
.first_visible_x
= 0;
12389 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12390 row
= it
.glyph_row
;
12391 row
->reversed_p
= false;
12393 /* Build a string that represents the contents of the tool-bar. */
12394 build_desired_tool_bar_string (f
);
12395 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12396 /* FIXME: This should be controlled by a user option. But it
12397 doesn't make sense to have an R2L tool bar if the menu bar cannot
12398 be drawn also R2L, and making the menu bar R2L is tricky due
12399 toolkit-specific code that implements it. If an R2L tool bar is
12400 ever supported, display_tool_bar_line should also be augmented to
12401 call unproduce_glyphs like display_line and display_string
12403 it
.paragraph_embedding
= L2R
;
12405 if (f
->n_tool_bar_rows
== 0)
12407 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12409 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12411 x_change_tool_bar_height (f
, new_height
);
12412 frame_default_tool_bar_height
= new_height
;
12413 /* Always do that now. */
12414 clear_glyph_matrix (w
->desired_matrix
);
12415 f
->fonts_changed
= 1;
12420 /* Display as many lines as needed to display all tool-bar items. */
12422 if (f
->n_tool_bar_rows
> 0)
12424 int border
, rows
, height
, extra
;
12426 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12427 border
= XINT (Vtool_bar_border
);
12428 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12429 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12430 else if (EQ (Vtool_bar_border
, Qborder_width
))
12431 border
= f
->border_width
;
12437 rows
= f
->n_tool_bar_rows
;
12438 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12439 extra
= it
.last_visible_y
- border
- height
* rows
;
12441 while (it
.current_y
< it
.last_visible_y
)
12444 if (extra
> 0 && rows
-- > 0)
12446 h
= (extra
+ rows
- 1) / rows
;
12449 display_tool_bar_line (&it
, height
+ h
);
12454 while (it
.current_y
< it
.last_visible_y
)
12455 display_tool_bar_line (&it
, 0);
12458 /* It doesn't make much sense to try scrolling in the tool-bar
12459 window, so don't do it. */
12460 w
->desired_matrix
->no_scrolling_p
= 1;
12461 w
->must_be_updated_p
= 1;
12463 if (!NILP (Vauto_resize_tool_bars
))
12465 int change_height_p
= 0;
12467 /* If we couldn't display everything, change the tool-bar's
12468 height if there is room for more. */
12469 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12470 change_height_p
= 1;
12472 /* We subtract 1 because display_tool_bar_line advances the
12473 glyph_row pointer before returning to its caller. We want to
12474 examine the last glyph row produced by
12475 display_tool_bar_line. */
12476 row
= it
.glyph_row
- 1;
12478 /* If there are blank lines at the end, except for a partially
12479 visible blank line at the end that is smaller than
12480 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12481 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12482 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12483 change_height_p
= 1;
12485 /* If row displays tool-bar items, but is partially visible,
12486 change the tool-bar's height. */
12487 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12488 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12489 change_height_p
= 1;
12491 /* Resize windows as needed by changing the `tool-bar-lines'
12492 frame parameter. */
12493 if (change_height_p
)
12496 int new_height
= tool_bar_height (f
, &nrows
, 1);
12498 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12499 && !f
->minimize_tool_bar_window_p
)
12500 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12501 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12502 f
->minimize_tool_bar_window_p
= 0;
12504 if (change_height_p
)
12506 x_change_tool_bar_height (f
, new_height
);
12507 frame_default_tool_bar_height
= new_height
;
12508 clear_glyph_matrix (w
->desired_matrix
);
12509 f
->n_tool_bar_rows
= nrows
;
12510 f
->fonts_changed
= 1;
12517 f
->minimize_tool_bar_window_p
= 0;
12520 #endif /* USE_GTK || HAVE_NS */
12523 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12525 /* Get information about the tool-bar item which is displayed in GLYPH
12526 on frame F. Return in *PROP_IDX the index where tool-bar item
12527 properties start in F->tool_bar_items. Value is zero if
12528 GLYPH doesn't display a tool-bar item. */
12531 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12537 /* This function can be called asynchronously, which means we must
12538 exclude any possibility that Fget_text_property signals an
12540 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12541 charpos
= max (0, charpos
);
12543 /* Get the text property `menu-item' at pos. The value of that
12544 property is the start index of this item's properties in
12545 F->tool_bar_items. */
12546 prop
= Fget_text_property (make_number (charpos
),
12547 Qmenu_item
, f
->current_tool_bar_string
);
12548 if (INTEGERP (prop
))
12550 *prop_idx
= XINT (prop
);
12560 /* Get information about the tool-bar item at position X/Y on frame F.
12561 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12562 the current matrix of the tool-bar window of F, or NULL if not
12563 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12564 item in F->tool_bar_items. Value is
12566 -1 if X/Y is not on a tool-bar item
12567 0 if X/Y is on the same item that was highlighted before.
12571 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12572 int *hpos
, int *vpos
, int *prop_idx
)
12574 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12575 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12578 /* Find the glyph under X/Y. */
12579 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12580 if (*glyph
== NULL
)
12583 /* Get the start of this tool-bar item's properties in
12584 f->tool_bar_items. */
12585 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12588 /* Is mouse on the highlighted item? */
12589 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12590 && *vpos
>= hlinfo
->mouse_face_beg_row
12591 && *vpos
<= hlinfo
->mouse_face_end_row
12592 && (*vpos
> hlinfo
->mouse_face_beg_row
12593 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12594 && (*vpos
< hlinfo
->mouse_face_end_row
12595 || *hpos
< hlinfo
->mouse_face_end_col
12596 || hlinfo
->mouse_face_past_end
))
12604 Handle mouse button event on the tool-bar of frame F, at
12605 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12606 0 for button release. MODIFIERS is event modifiers for button
12610 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12613 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12614 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12615 int hpos
, vpos
, prop_idx
;
12616 struct glyph
*glyph
;
12617 Lisp_Object enabled_p
;
12620 /* If not on the highlighted tool-bar item, and mouse-highlight is
12621 non-nil, return. This is so we generate the tool-bar button
12622 click only when the mouse button is released on the same item as
12623 where it was pressed. However, when mouse-highlight is disabled,
12624 generate the click when the button is released regardless of the
12625 highlight, since tool-bar items are not highlighted in that
12627 frame_to_window_pixel_xy (w
, &x
, &y
);
12628 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12630 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12633 /* When mouse-highlight is off, generate the click for the item
12634 where the button was pressed, disregarding where it was
12636 if (NILP (Vmouse_highlight
) && !down_p
)
12637 prop_idx
= f
->last_tool_bar_item
;
12639 /* If item is disabled, do nothing. */
12640 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12641 if (NILP (enabled_p
))
12646 /* Show item in pressed state. */
12647 if (!NILP (Vmouse_highlight
))
12648 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12649 f
->last_tool_bar_item
= prop_idx
;
12653 Lisp_Object key
, frame
;
12654 struct input_event event
;
12655 EVENT_INIT (event
);
12657 /* Show item in released state. */
12658 if (!NILP (Vmouse_highlight
))
12659 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12661 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12663 XSETFRAME (frame
, f
);
12664 event
.kind
= TOOL_BAR_EVENT
;
12665 event
.frame_or_window
= frame
;
12667 kbd_buffer_store_event (&event
);
12669 event
.kind
= TOOL_BAR_EVENT
;
12670 event
.frame_or_window
= frame
;
12672 event
.modifiers
= modifiers
;
12673 kbd_buffer_store_event (&event
);
12674 f
->last_tool_bar_item
= -1;
12679 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12680 tool-bar window-relative coordinates X/Y. Called from
12681 note_mouse_highlight. */
12684 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12686 Lisp_Object window
= f
->tool_bar_window
;
12687 struct window
*w
= XWINDOW (window
);
12688 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12689 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12691 struct glyph
*glyph
;
12692 struct glyph_row
*row
;
12694 Lisp_Object enabled_p
;
12696 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12697 int mouse_down_p
, rc
;
12699 /* Function note_mouse_highlight is called with negative X/Y
12700 values when mouse moves outside of the frame. */
12701 if (x
<= 0 || y
<= 0)
12703 clear_mouse_face (hlinfo
);
12707 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12710 /* Not on tool-bar item. */
12711 clear_mouse_face (hlinfo
);
12715 /* On same tool-bar item as before. */
12716 goto set_help_echo
;
12718 clear_mouse_face (hlinfo
);
12720 /* Mouse is down, but on different tool-bar item? */
12721 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12722 && f
== dpyinfo
->last_mouse_frame
);
12724 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12727 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12729 /* If tool-bar item is not enabled, don't highlight it. */
12730 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12731 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12733 /* Compute the x-position of the glyph. In front and past the
12734 image is a space. We include this in the highlighted area. */
12735 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12736 for (i
= x
= 0; i
< hpos
; ++i
)
12737 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12739 /* Record this as the current active region. */
12740 hlinfo
->mouse_face_beg_col
= hpos
;
12741 hlinfo
->mouse_face_beg_row
= vpos
;
12742 hlinfo
->mouse_face_beg_x
= x
;
12743 hlinfo
->mouse_face_past_end
= 0;
12745 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12746 hlinfo
->mouse_face_end_row
= vpos
;
12747 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12748 hlinfo
->mouse_face_window
= window
;
12749 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12751 /* Display it as active. */
12752 show_mouse_face (hlinfo
, draw
);
12757 /* Set help_echo_string to a help string to display for this tool-bar item.
12758 XTread_socket does the rest. */
12759 help_echo_object
= help_echo_window
= Qnil
;
12760 help_echo_pos
= -1;
12761 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12762 if (NILP (help_echo_string
))
12763 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12766 #endif /* !USE_GTK && !HAVE_NS */
12768 #endif /* HAVE_WINDOW_SYSTEM */
12772 /************************************************************************
12773 Horizontal scrolling
12774 ************************************************************************/
12776 static int hscroll_window_tree (Lisp_Object
);
12777 static int hscroll_windows (Lisp_Object
);
12779 /* For all leaf windows in the window tree rooted at WINDOW, set their
12780 hscroll value so that PT is (i) visible in the window, and (ii) so
12781 that it is not within a certain margin at the window's left and
12782 right border. Value is non-zero if any window's hscroll has been
12786 hscroll_window_tree (Lisp_Object window
)
12788 int hscrolled_p
= 0;
12789 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12790 int hscroll_step_abs
= 0;
12791 double hscroll_step_rel
= 0;
12793 if (hscroll_relative_p
)
12795 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12796 if (hscroll_step_rel
< 0)
12798 hscroll_relative_p
= 0;
12799 hscroll_step_abs
= 0;
12802 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12804 hscroll_step_abs
= XINT (Vhscroll_step
);
12805 if (hscroll_step_abs
< 0)
12806 hscroll_step_abs
= 0;
12809 hscroll_step_abs
= 0;
12811 while (WINDOWP (window
))
12813 struct window
*w
= XWINDOW (window
);
12815 if (WINDOWP (w
->contents
))
12816 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12817 else if (w
->cursor
.vpos
>= 0)
12820 int text_area_width
;
12821 struct glyph_row
*cursor_row
;
12822 struct glyph_row
*bottom_row
;
12825 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12826 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12827 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12829 cursor_row
= bottom_row
- 1;
12831 if (!cursor_row
->enabled_p
)
12833 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12834 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12835 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12837 cursor_row
= bottom_row
- 1;
12839 row_r2l_p
= cursor_row
->reversed_p
;
12841 text_area_width
= window_box_width (w
, TEXT_AREA
);
12843 /* Scroll when cursor is inside this scroll margin. */
12844 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12846 /* If the position of this window's point has explicitly
12847 changed, no more suspend auto hscrolling. */
12848 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12849 w
->suspend_auto_hscroll
= 0;
12851 /* Remember window point. */
12852 Fset_marker (w
->old_pointm
,
12853 ((w
== XWINDOW (selected_window
))
12854 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12855 : Fmarker_position (w
->pointm
)),
12858 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12859 && w
->suspend_auto_hscroll
== 0
12860 /* In some pathological cases, like restoring a window
12861 configuration into a frame that is much smaller than
12862 the one from which the configuration was saved, we
12863 get glyph rows whose start and end have zero buffer
12864 positions, which we cannot handle below. Just skip
12866 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12867 /* For left-to-right rows, hscroll when cursor is either
12868 (i) inside the right hscroll margin, or (ii) if it is
12869 inside the left margin and the window is already
12872 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12873 || (cursor_row
->enabled_p
12874 && cursor_row
->truncated_on_right_p
12875 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12876 /* For right-to-left rows, the logic is similar,
12877 except that rules for scrolling to left and right
12878 are reversed. E.g., if cursor.x <= h_margin, we
12879 need to hscroll "to the right" unconditionally,
12880 and that will scroll the screen to the left so as
12881 to reveal the next portion of the row. */
12883 && ((cursor_row
->enabled_p
12884 /* FIXME: It is confusing to set the
12885 truncated_on_right_p flag when R2L rows
12886 are actually truncated on the left. */
12887 && cursor_row
->truncated_on_right_p
12888 && w
->cursor
.x
<= h_margin
)
12890 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12894 struct buffer
*saved_current_buffer
;
12898 /* Find point in a display of infinite width. */
12899 saved_current_buffer
= current_buffer
;
12900 current_buffer
= XBUFFER (w
->contents
);
12902 if (w
== XWINDOW (selected_window
))
12905 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12907 /* Move iterator to pt starting at cursor_row->start in
12908 a line with infinite width. */
12909 init_to_row_start (&it
, w
, cursor_row
);
12910 it
.last_visible_x
= INFINITY
;
12911 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12912 current_buffer
= saved_current_buffer
;
12914 /* Position cursor in window. */
12915 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12916 hscroll
= max (0, (it
.current_x
12917 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12918 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12919 : (text_area_width
/ 2))))
12920 / FRAME_COLUMN_WIDTH (it
.f
);
12921 else if ((!row_r2l_p
12922 && w
->cursor
.x
>= text_area_width
- h_margin
)
12923 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12925 if (hscroll_relative_p
)
12926 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12929 wanted_x
= text_area_width
12930 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12933 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12937 if (hscroll_relative_p
)
12938 wanted_x
= text_area_width
* hscroll_step_rel
12941 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12944 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12946 hscroll
= max (hscroll
, w
->min_hscroll
);
12948 /* Don't prevent redisplay optimizations if hscroll
12949 hasn't changed, as it will unnecessarily slow down
12951 if (w
->hscroll
!= hscroll
)
12953 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12954 w
->hscroll
= hscroll
;
12963 /* Value is non-zero if hscroll of any leaf window has been changed. */
12964 return hscrolled_p
;
12968 /* Set hscroll so that cursor is visible and not inside horizontal
12969 scroll margins for all windows in the tree rooted at WINDOW. See
12970 also hscroll_window_tree above. Value is non-zero if any window's
12971 hscroll has been changed. If it has, desired matrices on the frame
12972 of WINDOW are cleared. */
12975 hscroll_windows (Lisp_Object window
)
12977 int hscrolled_p
= hscroll_window_tree (window
);
12979 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12980 return hscrolled_p
;
12985 /************************************************************************
12987 ************************************************************************/
12989 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12990 to a non-zero value. This is sometimes handy to have in a debugger
12995 /* First and last unchanged row for try_window_id. */
12997 static int debug_first_unchanged_at_end_vpos
;
12998 static int debug_last_unchanged_at_beg_vpos
;
13000 /* Delta vpos and y. */
13002 static int debug_dvpos
, debug_dy
;
13004 /* Delta in characters and bytes for try_window_id. */
13006 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13008 /* Values of window_end_pos and window_end_vpos at the end of
13011 static ptrdiff_t debug_end_vpos
;
13013 /* Append a string to W->desired_matrix->method. FMT is a printf
13014 format string. If trace_redisplay_p is true also printf the
13015 resulting string to stderr. */
13017 static void debug_method_add (struct window
*, char const *, ...)
13018 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13021 debug_method_add (struct window
*w
, char const *fmt
, ...)
13024 char *method
= w
->desired_matrix
->method
;
13025 int len
= strlen (method
);
13026 int size
= sizeof w
->desired_matrix
->method
;
13027 int remaining
= size
- len
- 1;
13030 if (len
&& remaining
)
13033 --remaining
, ++len
;
13036 va_start (ap
, fmt
);
13037 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13040 if (trace_redisplay_p
)
13041 fprintf (stderr
, "%p (%s): %s\n",
13043 ((BUFFERP (w
->contents
)
13044 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13045 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13050 #endif /* GLYPH_DEBUG */
13053 /* Value is non-zero if all changes in window W, which displays
13054 current_buffer, are in the text between START and END. START is a
13055 buffer position, END is given as a distance from Z. Used in
13056 redisplay_internal for display optimization. */
13059 text_outside_line_unchanged_p (struct window
*w
,
13060 ptrdiff_t start
, ptrdiff_t end
)
13062 int unchanged_p
= 1;
13064 /* If text or overlays have changed, see where. */
13065 if (window_outdated (w
))
13067 /* Gap in the line? */
13068 if (GPT
< start
|| Z
- GPT
< end
)
13071 /* Changes start in front of the line, or end after it? */
13073 && (BEG_UNCHANGED
< start
- 1
13074 || END_UNCHANGED
< end
))
13077 /* If selective display, can't optimize if changes start at the
13078 beginning of the line. */
13080 && INTEGERP (BVAR (current_buffer
, selective_display
))
13081 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13082 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13085 /* If there are overlays at the start or end of the line, these
13086 may have overlay strings with newlines in them. A change at
13087 START, for instance, may actually concern the display of such
13088 overlay strings as well, and they are displayed on different
13089 lines. So, quickly rule out this case. (For the future, it
13090 might be desirable to implement something more telling than
13091 just BEG/END_UNCHANGED.) */
13094 if (BEG
+ BEG_UNCHANGED
== start
13095 && overlay_touches_p (start
))
13097 if (END_UNCHANGED
== end
13098 && overlay_touches_p (Z
- end
))
13102 /* Under bidi reordering, adding or deleting a character in the
13103 beginning of a paragraph, before the first strong directional
13104 character, can change the base direction of the paragraph (unless
13105 the buffer specifies a fixed paragraph direction), which will
13106 require to redisplay the whole paragraph. It might be worthwhile
13107 to find the paragraph limits and widen the range of redisplayed
13108 lines to that, but for now just give up this optimization. */
13109 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13110 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13114 return unchanged_p
;
13118 /* Do a frame update, taking possible shortcuts into account. This is
13119 the main external entry point for redisplay.
13121 If the last redisplay displayed an echo area message and that message
13122 is no longer requested, we clear the echo area or bring back the
13123 mini-buffer if that is in use. */
13128 redisplay_internal ();
13133 overlay_arrow_string_or_property (Lisp_Object var
)
13137 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13140 return Voverlay_arrow_string
;
13143 /* Return 1 if there are any overlay-arrows in current_buffer. */
13145 overlay_arrow_in_current_buffer_p (void)
13149 for (vlist
= Voverlay_arrow_variable_list
;
13151 vlist
= XCDR (vlist
))
13153 Lisp_Object var
= XCAR (vlist
);
13156 if (!SYMBOLP (var
))
13158 val
= find_symbol_value (var
);
13160 && current_buffer
== XMARKER (val
)->buffer
)
13167 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13171 overlay_arrows_changed_p (void)
13175 for (vlist
= Voverlay_arrow_variable_list
;
13177 vlist
= XCDR (vlist
))
13179 Lisp_Object var
= XCAR (vlist
);
13180 Lisp_Object val
, pstr
;
13182 if (!SYMBOLP (var
))
13184 val
= find_symbol_value (var
);
13185 if (!MARKERP (val
))
13187 if (! EQ (COERCE_MARKER (val
),
13188 Fget (var
, Qlast_arrow_position
))
13189 || ! (pstr
= overlay_arrow_string_or_property (var
),
13190 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13196 /* Mark overlay arrows to be updated on next redisplay. */
13199 update_overlay_arrows (int up_to_date
)
13203 for (vlist
= Voverlay_arrow_variable_list
;
13205 vlist
= XCDR (vlist
))
13207 Lisp_Object var
= XCAR (vlist
);
13209 if (!SYMBOLP (var
))
13212 if (up_to_date
> 0)
13214 Lisp_Object val
= find_symbol_value (var
);
13215 Fput (var
, Qlast_arrow_position
,
13216 COERCE_MARKER (val
));
13217 Fput (var
, Qlast_arrow_string
,
13218 overlay_arrow_string_or_property (var
));
13220 else if (up_to_date
< 0
13221 || !NILP (Fget (var
, Qlast_arrow_position
)))
13223 Fput (var
, Qlast_arrow_position
, Qt
);
13224 Fput (var
, Qlast_arrow_string
, Qt
);
13230 /* Return overlay arrow string to display at row.
13231 Return integer (bitmap number) for arrow bitmap in left fringe.
13232 Return nil if no overlay arrow. */
13235 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13239 for (vlist
= Voverlay_arrow_variable_list
;
13241 vlist
= XCDR (vlist
))
13243 Lisp_Object var
= XCAR (vlist
);
13246 if (!SYMBOLP (var
))
13249 val
= find_symbol_value (var
);
13252 && current_buffer
== XMARKER (val
)->buffer
13253 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13255 if (FRAME_WINDOW_P (it
->f
)
13256 /* FIXME: if ROW->reversed_p is set, this should test
13257 the right fringe, not the left one. */
13258 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13260 #ifdef HAVE_WINDOW_SYSTEM
13261 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13264 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13265 return make_number (fringe_bitmap
);
13268 return make_number (-1); /* Use default arrow bitmap. */
13270 return overlay_arrow_string_or_property (var
);
13277 /* Return 1 if point moved out of or into a composition. Otherwise
13278 return 0. PREV_BUF and PREV_PT are the last point buffer and
13279 position. BUF and PT are the current point buffer and position. */
13282 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13283 struct buffer
*buf
, ptrdiff_t pt
)
13285 ptrdiff_t start
, end
;
13287 Lisp_Object buffer
;
13289 XSETBUFFER (buffer
, buf
);
13290 /* Check a composition at the last point if point moved within the
13292 if (prev_buf
== buf
)
13295 /* Point didn't move. */
13298 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13299 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13300 && composition_valid_p (start
, end
, prop
)
13301 && start
< prev_pt
&& end
> prev_pt
)
13302 /* The last point was within the composition. Return 1 iff
13303 point moved out of the composition. */
13304 return (pt
<= start
|| pt
>= end
);
13307 /* Check a composition at the current point. */
13308 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13309 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13310 && composition_valid_p (start
, end
, prop
)
13311 && start
< pt
&& end
> pt
);
13314 /* Reconsider the clip changes of buffer which is displayed in W. */
13317 reconsider_clip_changes (struct window
*w
)
13319 struct buffer
*b
= XBUFFER (w
->contents
);
13321 if (b
->clip_changed
13322 && w
->window_end_valid
13323 && w
->current_matrix
->buffer
== b
13324 && w
->current_matrix
->zv
== BUF_ZV (b
)
13325 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13326 b
->clip_changed
= 0;
13328 /* If display wasn't paused, and W is not a tool bar window, see if
13329 point has been moved into or out of a composition. In that case,
13330 we set b->clip_changed to 1 to force updating the screen. If
13331 b->clip_changed has already been set to 1, we can skip this
13333 if (!b
->clip_changed
&& w
->window_end_valid
)
13335 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13336 ? PT
: marker_position (w
->pointm
));
13338 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13339 && check_point_in_composition (w
->current_matrix
->buffer
,
13340 w
->last_point
, b
, pt
))
13341 b
->clip_changed
= 1;
13346 propagate_buffer_redisplay (void)
13347 { /* Resetting b->text->redisplay is problematic!
13348 We can't just reset it in the case that some window that displays
13349 it has not been redisplayed; and such a window can stay
13350 unredisplayed for a long time if it's currently invisible.
13351 But we do want to reset it at the end of redisplay otherwise
13352 its displayed windows will keep being redisplayed over and over
13354 So we copy all b->text->redisplay flags up to their windows here,
13355 such that mark_window_display_accurate can safely reset
13356 b->text->redisplay. */
13357 Lisp_Object ws
= window_list ();
13358 for (; CONSP (ws
); ws
= XCDR (ws
))
13360 struct window
*thisw
= XWINDOW (XCAR (ws
));
13361 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13362 if (thisb
->text
->redisplay
)
13363 thisw
->redisplay
= true;
13367 #define STOP_POLLING \
13368 do { if (! polling_stopped_here) stop_polling (); \
13369 polling_stopped_here = 1; } while (0)
13371 #define RESUME_POLLING \
13372 do { if (polling_stopped_here) start_polling (); \
13373 polling_stopped_here = 0; } while (0)
13376 /* Perhaps in the future avoid recentering windows if it
13377 is not necessary; currently that causes some problems. */
13380 redisplay_internal (void)
13382 struct window
*w
= XWINDOW (selected_window
);
13386 bool must_finish
= 0, match_p
;
13387 struct text_pos tlbufpos
, tlendpos
;
13388 int number_of_visible_frames
;
13391 int polling_stopped_here
= 0;
13392 Lisp_Object tail
, frame
;
13394 /* True means redisplay has to consider all windows on all
13395 frames. False, only selected_window is considered. */
13396 bool consider_all_windows_p
;
13398 /* True means redisplay has to redisplay the miniwindow. */
13399 bool update_miniwindow_p
= false;
13401 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13403 /* No redisplay if running in batch mode or frame is not yet fully
13404 initialized, or redisplay is explicitly turned off by setting
13405 Vinhibit_redisplay. */
13406 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13407 || !NILP (Vinhibit_redisplay
))
13410 /* Don't examine these until after testing Vinhibit_redisplay.
13411 When Emacs is shutting down, perhaps because its connection to
13412 X has dropped, we should not look at them at all. */
13413 fr
= XFRAME (w
->frame
);
13414 sf
= SELECTED_FRAME ();
13416 if (!fr
->glyphs_initialized_p
)
13419 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13420 if (popup_activated ())
13424 /* I don't think this happens but let's be paranoid. */
13425 if (redisplaying_p
)
13428 /* Record a function that clears redisplaying_p
13429 when we leave this function. */
13430 count
= SPECPDL_INDEX ();
13431 record_unwind_protect_void (unwind_redisplay
);
13432 redisplaying_p
= 1;
13433 specbind (Qinhibit_free_realized_faces
, Qnil
);
13435 /* Record this function, so it appears on the profiler's backtraces. */
13436 record_in_backtrace (Qredisplay_internal
, 0, 0);
13438 FOR_EACH_FRAME (tail
, frame
)
13439 XFRAME (frame
)->already_hscrolled_p
= 0;
13442 /* Remember the currently selected window. */
13446 last_escape_glyph_frame
= NULL
;
13447 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13448 last_glyphless_glyph_frame
= NULL
;
13449 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13451 /* If face_change_count is non-zero, init_iterator will free all
13452 realized faces, which includes the faces referenced from current
13453 matrices. So, we can't reuse current matrices in this case. */
13454 if (face_change_count
)
13455 windows_or_buffers_changed
= 47;
13457 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13458 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13460 /* Since frames on a single ASCII terminal share the same
13461 display area, displaying a different frame means redisplay
13462 the whole thing. */
13463 SET_FRAME_GARBAGED (sf
);
13465 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13467 FRAME_TTY (sf
)->previous_frame
= sf
;
13470 /* Set the visible flags for all frames. Do this before checking for
13471 resized or garbaged frames; they want to know if their frames are
13472 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13473 number_of_visible_frames
= 0;
13475 FOR_EACH_FRAME (tail
, frame
)
13477 struct frame
*f
= XFRAME (frame
);
13479 if (FRAME_VISIBLE_P (f
))
13481 ++number_of_visible_frames
;
13482 /* Adjust matrices for visible frames only. */
13483 if (f
->fonts_changed
)
13485 adjust_frame_glyphs (f
);
13486 f
->fonts_changed
= 0;
13488 /* If cursor type has been changed on the frame
13489 other than selected, consider all frames. */
13490 if (f
!= sf
&& f
->cursor_type_changed
)
13491 update_mode_lines
= 31;
13493 clear_desired_matrices (f
);
13496 /* Notice any pending interrupt request to change frame size. */
13497 do_pending_window_change (true);
13499 /* do_pending_window_change could change the selected_window due to
13500 frame resizing which makes the selected window too small. */
13501 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13504 /* Clear frames marked as garbaged. */
13505 clear_garbaged_frames ();
13507 /* Build menubar and tool-bar items. */
13508 if (NILP (Vmemory_full
))
13509 prepare_menu_bars ();
13511 reconsider_clip_changes (w
);
13513 /* In most cases selected window displays current buffer. */
13514 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13517 /* Detect case that we need to write or remove a star in the mode line. */
13518 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13519 w
->update_mode_line
= 1;
13521 if (mode_line_update_needed (w
))
13522 w
->update_mode_line
= 1;
13524 /* If reconsider_clip_changes above decided that the narrowing
13525 in the current buffer changed, make sure all other windows
13526 showing that buffer will be redisplayed. */
13527 if (current_buffer
->clip_changed
)
13528 bset_update_mode_line (current_buffer
);
13531 /* Normally the message* functions will have already displayed and
13532 updated the echo area, but the frame may have been trashed, or
13533 the update may have been preempted, so display the echo area
13534 again here. Checking message_cleared_p captures the case that
13535 the echo area should be cleared. */
13536 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13537 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13538 || (message_cleared_p
13539 && minibuf_level
== 0
13540 /* If the mini-window is currently selected, this means the
13541 echo-area doesn't show through. */
13542 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13544 int window_height_changed_p
= echo_area_display (false);
13546 if (message_cleared_p
)
13547 update_miniwindow_p
= true;
13551 /* If we don't display the current message, don't clear the
13552 message_cleared_p flag, because, if we did, we wouldn't clear
13553 the echo area in the next redisplay which doesn't preserve
13555 if (!display_last_displayed_message_p
)
13556 message_cleared_p
= 0;
13558 if (window_height_changed_p
)
13560 windows_or_buffers_changed
= 50;
13562 /* If window configuration was changed, frames may have been
13563 marked garbaged. Clear them or we will experience
13564 surprises wrt scrolling. */
13565 clear_garbaged_frames ();
13568 else if (EQ (selected_window
, minibuf_window
)
13569 && (current_buffer
->clip_changed
|| window_outdated (w
))
13570 && resize_mini_window (w
, 0))
13572 /* Resized active mini-window to fit the size of what it is
13573 showing if its contents might have changed. */
13576 /* If window configuration was changed, frames may have been
13577 marked garbaged. Clear them or we will experience
13578 surprises wrt scrolling. */
13579 clear_garbaged_frames ();
13582 if (windows_or_buffers_changed
&& !update_mode_lines
)
13583 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13584 only the windows's contents needs to be refreshed, or whether the
13585 mode-lines also need a refresh. */
13586 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13587 ? REDISPLAY_SOME
: 32);
13589 /* If specs for an arrow have changed, do thorough redisplay
13590 to ensure we remove any arrow that should no longer exist. */
13591 if (overlay_arrows_changed_p ())
13592 /* Apparently, this is the only case where we update other windows,
13593 without updating other mode-lines. */
13594 windows_or_buffers_changed
= 49;
13596 consider_all_windows_p
= (update_mode_lines
13597 || windows_or_buffers_changed
);
13599 #define AINC(a,i) \
13600 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13601 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13603 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13604 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13606 /* Optimize the case that only the line containing the cursor in the
13607 selected window has changed. Variables starting with this_ are
13608 set in display_line and record information about the line
13609 containing the cursor. */
13610 tlbufpos
= this_line_start_pos
;
13611 tlendpos
= this_line_end_pos
;
13612 if (!consider_all_windows_p
13613 && CHARPOS (tlbufpos
) > 0
13614 && !w
->update_mode_line
13615 && !current_buffer
->clip_changed
13616 && !current_buffer
->prevent_redisplay_optimizations_p
13617 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13618 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13619 && !XFRAME (w
->frame
)->cursor_type_changed
13620 /* Make sure recorded data applies to current buffer, etc. */
13621 && this_line_buffer
== current_buffer
13624 && !w
->optional_new_start
13625 /* Point must be on the line that we have info recorded about. */
13626 && PT
>= CHARPOS (tlbufpos
)
13627 && PT
<= Z
- CHARPOS (tlendpos
)
13628 /* All text outside that line, including its final newline,
13629 must be unchanged. */
13630 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13631 CHARPOS (tlendpos
)))
13633 if (CHARPOS (tlbufpos
) > BEGV
13634 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13635 && (CHARPOS (tlbufpos
) == ZV
13636 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13637 /* Former continuation line has disappeared by becoming empty. */
13639 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13641 /* We have to handle the case of continuation around a
13642 wide-column character (see the comment in indent.c around
13645 For instance, in the following case:
13647 -------- Insert --------
13648 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13649 J_I_ ==> J_I_ `^^' are cursors.
13653 As we have to redraw the line above, we cannot use this
13657 int line_height_before
= this_line_pixel_height
;
13659 /* Note that start_display will handle the case that the
13660 line starting at tlbufpos is a continuation line. */
13661 start_display (&it
, w
, tlbufpos
);
13663 /* Implementation note: It this still necessary? */
13664 if (it
.current_x
!= this_line_start_x
)
13667 TRACE ((stderr
, "trying display optimization 1\n"));
13668 w
->cursor
.vpos
= -1;
13669 overlay_arrow_seen
= 0;
13670 it
.vpos
= this_line_vpos
;
13671 it
.current_y
= this_line_y
;
13672 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13673 display_line (&it
);
13675 /* If line contains point, is not continued,
13676 and ends at same distance from eob as before, we win. */
13677 if (w
->cursor
.vpos
>= 0
13678 /* Line is not continued, otherwise this_line_start_pos
13679 would have been set to 0 in display_line. */
13680 && CHARPOS (this_line_start_pos
)
13681 /* Line ends as before. */
13682 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13683 /* Line has same height as before. Otherwise other lines
13684 would have to be shifted up or down. */
13685 && this_line_pixel_height
== line_height_before
)
13687 /* If this is not the window's last line, we must adjust
13688 the charstarts of the lines below. */
13689 if (it
.current_y
< it
.last_visible_y
)
13691 struct glyph_row
*row
13692 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13693 ptrdiff_t delta
, delta_bytes
;
13695 /* We used to distinguish between two cases here,
13696 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13697 when the line ends in a newline or the end of the
13698 buffer's accessible portion. But both cases did
13699 the same, so they were collapsed. */
13701 - CHARPOS (tlendpos
)
13702 - MATRIX_ROW_START_CHARPOS (row
));
13703 delta_bytes
= (Z_BYTE
13704 - BYTEPOS (tlendpos
)
13705 - MATRIX_ROW_START_BYTEPOS (row
));
13707 increment_matrix_positions (w
->current_matrix
,
13708 this_line_vpos
+ 1,
13709 w
->current_matrix
->nrows
,
13710 delta
, delta_bytes
);
13713 /* If this row displays text now but previously didn't,
13714 or vice versa, w->window_end_vpos may have to be
13716 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13718 if (w
->window_end_vpos
< this_line_vpos
)
13719 w
->window_end_vpos
= this_line_vpos
;
13721 else if (w
->window_end_vpos
== this_line_vpos
13722 && this_line_vpos
> 0)
13723 w
->window_end_vpos
= this_line_vpos
- 1;
13724 w
->window_end_valid
= 0;
13726 /* Update hint: No need to try to scroll in update_window. */
13727 w
->desired_matrix
->no_scrolling_p
= 1;
13730 *w
->desired_matrix
->method
= 0;
13731 debug_method_add (w
, "optimization 1");
13733 #ifdef HAVE_WINDOW_SYSTEM
13734 update_window_fringes (w
, 0);
13741 else if (/* Cursor position hasn't changed. */
13742 PT
== w
->last_point
13743 /* Make sure the cursor was last displayed
13744 in this window. Otherwise we have to reposition it. */
13746 /* PXW: Must be converted to pixels, probably. */
13747 && 0 <= w
->cursor
.vpos
13748 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13752 do_pending_window_change (true);
13753 /* If selected_window changed, redisplay again. */
13754 if (WINDOWP (selected_window
)
13755 && (w
= XWINDOW (selected_window
)) != sw
)
13758 /* We used to always goto end_of_redisplay here, but this
13759 isn't enough if we have a blinking cursor. */
13760 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13761 goto end_of_redisplay
;
13765 /* If highlighting the region, or if the cursor is in the echo area,
13766 then we can't just move the cursor. */
13767 else if (NILP (Vshow_trailing_whitespace
)
13768 && !cursor_in_echo_area
)
13771 struct glyph_row
*row
;
13773 /* Skip from tlbufpos to PT and see where it is. Note that
13774 PT may be in invisible text. If so, we will end at the
13775 next visible position. */
13776 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13777 NULL
, DEFAULT_FACE_ID
);
13778 it
.current_x
= this_line_start_x
;
13779 it
.current_y
= this_line_y
;
13780 it
.vpos
= this_line_vpos
;
13782 /* The call to move_it_to stops in front of PT, but
13783 moves over before-strings. */
13784 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13786 if (it
.vpos
== this_line_vpos
13787 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13790 eassert (this_line_vpos
== it
.vpos
);
13791 eassert (this_line_y
== it
.current_y
);
13792 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13794 *w
->desired_matrix
->method
= 0;
13795 debug_method_add (w
, "optimization 3");
13804 /* Text changed drastically or point moved off of line. */
13805 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13808 CHARPOS (this_line_start_pos
) = 0;
13809 ++clear_face_cache_count
;
13810 #ifdef HAVE_WINDOW_SYSTEM
13811 ++clear_image_cache_count
;
13814 /* Build desired matrices, and update the display. If
13815 consider_all_windows_p is non-zero, do it for all windows on all
13816 frames. Otherwise do it for selected_window, only. */
13818 if (consider_all_windows_p
)
13820 FOR_EACH_FRAME (tail
, frame
)
13821 XFRAME (frame
)->updated_p
= 0;
13823 propagate_buffer_redisplay ();
13825 FOR_EACH_FRAME (tail
, frame
)
13827 struct frame
*f
= XFRAME (frame
);
13829 /* We don't have to do anything for unselected terminal
13831 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13832 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13837 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_GTK) && !defined (HAVE_NS)
13838 /* Redisplay internal tool bar if this is the first time so we
13839 can adjust the frame height right now, if necessary. */
13840 if (!f
->tool_bar_redisplayed_once
)
13842 if (redisplay_tool_bar (f
))
13843 adjust_frame_glyphs (f
);
13844 f
->tool_bar_redisplayed_once
= true;
13848 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13851 /* Only GC scrollbars when we redisplay the whole frame. */
13852 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13853 /* Mark all the scroll bars to be removed; we'll redeem
13854 the ones we want when we redisplay their windows. */
13855 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13856 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13858 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13859 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13860 /* Remember that the invisible frames need to be redisplayed next
13861 time they're visible. */
13862 else if (!REDISPLAY_SOME_P ())
13863 f
->redisplay
= true;
13865 /* The X error handler may have deleted that frame. */
13866 if (!FRAME_LIVE_P (f
))
13869 /* Any scroll bars which redisplay_windows should have
13870 nuked should now go away. */
13871 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13872 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13874 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13876 /* If fonts changed on visible frame, display again. */
13877 if (f
->fonts_changed
)
13879 adjust_frame_glyphs (f
);
13880 f
->fonts_changed
= false;
13884 /* See if we have to hscroll. */
13885 if (!f
->already_hscrolled_p
)
13887 f
->already_hscrolled_p
= true;
13888 if (hscroll_windows (f
->root_window
))
13892 /* Prevent various kinds of signals during display
13893 update. stdio is not robust about handling
13894 signals, which can cause an apparent I/O error. */
13895 if (interrupt_input
)
13896 unrequest_sigio ();
13899 pending
|= update_frame (f
, false, false);
13900 f
->cursor_type_changed
= false;
13901 f
->updated_p
= true;
13906 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13910 /* Do the mark_window_display_accurate after all windows have
13911 been redisplayed because this call resets flags in buffers
13912 which are needed for proper redisplay. */
13913 FOR_EACH_FRAME (tail
, frame
)
13915 struct frame
*f
= XFRAME (frame
);
13918 f
->redisplay
= false;
13919 mark_window_display_accurate (f
->root_window
, 1);
13920 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13921 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13926 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13928 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13929 struct frame
*mini_frame
;
13931 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13932 /* Use list_of_error, not Qerror, so that
13933 we catch only errors and don't run the debugger. */
13934 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13936 redisplay_window_error
);
13937 if (update_miniwindow_p
)
13938 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13940 redisplay_window_error
);
13942 /* Compare desired and current matrices, perform output. */
13945 /* If fonts changed, display again. */
13946 if (sf
->fonts_changed
)
13949 /* Prevent various kinds of signals during display update.
13950 stdio is not robust about handling signals,
13951 which can cause an apparent I/O error. */
13952 if (interrupt_input
)
13953 unrequest_sigio ();
13956 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13958 if (hscroll_windows (selected_window
))
13961 XWINDOW (selected_window
)->must_be_updated_p
= true;
13962 pending
= update_frame (sf
, false, false);
13963 sf
->cursor_type_changed
= false;
13966 /* We may have called echo_area_display at the top of this
13967 function. If the echo area is on another frame, that may
13968 have put text on a frame other than the selected one, so the
13969 above call to update_frame would not have caught it. Catch
13971 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13972 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13974 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13976 XWINDOW (mini_window
)->must_be_updated_p
= true;
13977 pending
|= update_frame (mini_frame
, false, false);
13978 mini_frame
->cursor_type_changed
= false;
13979 if (!pending
&& hscroll_windows (mini_window
))
13984 /* If display was paused because of pending input, make sure we do a
13985 thorough update the next time. */
13988 /* Prevent the optimization at the beginning of
13989 redisplay_internal that tries a single-line update of the
13990 line containing the cursor in the selected window. */
13991 CHARPOS (this_line_start_pos
) = 0;
13993 /* Let the overlay arrow be updated the next time. */
13994 update_overlay_arrows (0);
13996 /* If we pause after scrolling, some rows in the current
13997 matrices of some windows are not valid. */
13998 if (!WINDOW_FULL_WIDTH_P (w
)
13999 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14000 update_mode_lines
= 36;
14004 if (!consider_all_windows_p
)
14006 /* This has already been done above if
14007 consider_all_windows_p is set. */
14008 if (XBUFFER (w
->contents
)->text
->redisplay
14009 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14010 /* This can happen if b->text->redisplay was set during
14012 propagate_buffer_redisplay ();
14013 mark_window_display_accurate_1 (w
, 1);
14015 /* Say overlay arrows are up to date. */
14016 update_overlay_arrows (1);
14018 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14019 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14022 update_mode_lines
= 0;
14023 windows_or_buffers_changed
= 0;
14026 /* Start SIGIO interrupts coming again. Having them off during the
14027 code above makes it less likely one will discard output, but not
14028 impossible, since there might be stuff in the system buffer here.
14029 But it is much hairier to try to do anything about that. */
14030 if (interrupt_input
)
14034 /* If a frame has become visible which was not before, redisplay
14035 again, so that we display it. Expose events for such a frame
14036 (which it gets when becoming visible) don't call the parts of
14037 redisplay constructing glyphs, so simply exposing a frame won't
14038 display anything in this case. So, we have to display these
14039 frames here explicitly. */
14044 FOR_EACH_FRAME (tail
, frame
)
14046 if (XFRAME (frame
)->visible
)
14050 if (new_count
!= number_of_visible_frames
)
14051 windows_or_buffers_changed
= 52;
14054 /* Change frame size now if a change is pending. */
14055 do_pending_window_change (true);
14057 /* If we just did a pending size change, or have additional
14058 visible frames, or selected_window changed, redisplay again. */
14059 if ((windows_or_buffers_changed
&& !pending
)
14060 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14063 /* Clear the face and image caches.
14065 We used to do this only if consider_all_windows_p. But the cache
14066 needs to be cleared if a timer creates images in the current
14067 buffer (e.g. the test case in Bug#6230). */
14069 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14071 clear_face_cache (false);
14072 clear_face_cache_count
= 0;
14075 #ifdef HAVE_WINDOW_SYSTEM
14076 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14078 clear_image_caches (Qnil
);
14079 clear_image_cache_count
= 0;
14081 #endif /* HAVE_WINDOW_SYSTEM */
14085 ns_set_doc_edited ();
14087 if (interrupt_input
&& interrupts_deferred
)
14090 unbind_to (count
, Qnil
);
14095 /* Redisplay, but leave alone any recent echo area message unless
14096 another message has been requested in its place.
14098 This is useful in situations where you need to redisplay but no
14099 user action has occurred, making it inappropriate for the message
14100 area to be cleared. See tracking_off and
14101 wait_reading_process_output for examples of these situations.
14103 FROM_WHERE is an integer saying from where this function was
14104 called. This is useful for debugging. */
14107 redisplay_preserve_echo_area (int from_where
)
14109 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14111 if (!NILP (echo_area_buffer
[1]))
14113 /* We have a previously displayed message, but no current
14114 message. Redisplay the previous message. */
14115 display_last_displayed_message_p
= true;
14116 redisplay_internal ();
14117 display_last_displayed_message_p
= false;
14120 redisplay_internal ();
14122 flush_frame (SELECTED_FRAME ());
14126 /* Function registered with record_unwind_protect in redisplay_internal. */
14129 unwind_redisplay (void)
14131 redisplaying_p
= 0;
14135 /* Mark the display of leaf window W as accurate or inaccurate.
14136 If ACCURATE_P is non-zero mark display of W as accurate. If
14137 ACCURATE_P is zero, arrange for W to be redisplayed the next
14138 time redisplay_internal is called. */
14141 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14143 struct buffer
*b
= XBUFFER (w
->contents
);
14145 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14146 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14147 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14151 b
->clip_changed
= false;
14152 b
->prevent_redisplay_optimizations_p
= false;
14153 eassert (buffer_window_count (b
) > 0);
14154 /* Resetting b->text->redisplay is problematic!
14155 In order to make it safer to do it here, redisplay_internal must
14156 have copied all b->text->redisplay to their respective windows. */
14157 b
->text
->redisplay
= false;
14159 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14160 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14161 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14162 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14164 w
->current_matrix
->buffer
= b
;
14165 w
->current_matrix
->begv
= BUF_BEGV (b
);
14166 w
->current_matrix
->zv
= BUF_ZV (b
);
14168 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14169 w
->last_cursor_off_p
= w
->cursor_off_p
;
14171 if (w
== XWINDOW (selected_window
))
14172 w
->last_point
= BUF_PT (b
);
14174 w
->last_point
= marker_position (w
->pointm
);
14176 w
->window_end_valid
= true;
14177 w
->update_mode_line
= false;
14180 w
->redisplay
= !accurate_p
;
14184 /* Mark the display of windows in the window tree rooted at WINDOW as
14185 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14186 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14187 be redisplayed the next time redisplay_internal is called. */
14190 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14194 for (; !NILP (window
); window
= w
->next
)
14196 w
= XWINDOW (window
);
14197 if (WINDOWP (w
->contents
))
14198 mark_window_display_accurate (w
->contents
, accurate_p
);
14200 mark_window_display_accurate_1 (w
, accurate_p
);
14204 update_overlay_arrows (1);
14206 /* Force a thorough redisplay the next time by setting
14207 last_arrow_position and last_arrow_string to t, which is
14208 unequal to any useful value of Voverlay_arrow_... */
14209 update_overlay_arrows (-1);
14213 /* Return value in display table DP (Lisp_Char_Table *) for character
14214 C. Since a display table doesn't have any parent, we don't have to
14215 follow parent. Do not call this function directly but use the
14216 macro DISP_CHAR_VECTOR. */
14219 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14223 if (ASCII_CHAR_P (c
))
14226 if (SUB_CHAR_TABLE_P (val
))
14227 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14233 XSETCHAR_TABLE (table
, dp
);
14234 val
= char_table_ref (table
, c
);
14243 /***********************************************************************
14245 ***********************************************************************/
14247 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14250 redisplay_windows (Lisp_Object window
)
14252 while (!NILP (window
))
14254 struct window
*w
= XWINDOW (window
);
14256 if (WINDOWP (w
->contents
))
14257 redisplay_windows (w
->contents
);
14258 else if (BUFFERP (w
->contents
))
14260 displayed_buffer
= XBUFFER (w
->contents
);
14261 /* Use list_of_error, not Qerror, so that
14262 we catch only errors and don't run the debugger. */
14263 internal_condition_case_1 (redisplay_window_0
, window
,
14265 redisplay_window_error
);
14273 redisplay_window_error (Lisp_Object ignore
)
14275 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14280 redisplay_window_0 (Lisp_Object window
)
14282 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14283 redisplay_window (window
, false);
14288 redisplay_window_1 (Lisp_Object window
)
14290 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14291 redisplay_window (window
, true);
14296 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14297 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14298 which positions recorded in ROW differ from current buffer
14301 Return 0 if cursor is not on this row, 1 otherwise. */
14304 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14305 struct glyph_matrix
*matrix
,
14306 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14309 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14310 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14311 struct glyph
*cursor
= NULL
;
14312 /* The last known character position in row. */
14313 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14315 ptrdiff_t pt_old
= PT
- delta
;
14316 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14317 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14318 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14319 /* A glyph beyond the edge of TEXT_AREA which we should never
14321 struct glyph
*glyphs_end
= end
;
14322 /* Non-zero means we've found a match for cursor position, but that
14323 glyph has the avoid_cursor_p flag set. */
14324 int match_with_avoid_cursor
= 0;
14325 /* Non-zero means we've seen at least one glyph that came from a
14327 int string_seen
= 0;
14328 /* Largest and smallest buffer positions seen so far during scan of
14330 ptrdiff_t bpos_max
= pos_before
;
14331 ptrdiff_t bpos_min
= pos_after
;
14332 /* Last buffer position covered by an overlay string with an integer
14333 `cursor' property. */
14334 ptrdiff_t bpos_covered
= 0;
14335 /* Non-zero means the display string on which to display the cursor
14336 comes from a text property, not from an overlay. */
14337 int string_from_text_prop
= 0;
14339 /* Don't even try doing anything if called for a mode-line or
14340 header-line row, since the rest of the code isn't prepared to
14341 deal with such calamities. */
14342 eassert (!row
->mode_line_p
);
14343 if (row
->mode_line_p
)
14346 /* Skip over glyphs not having an object at the start and the end of
14347 the row. These are special glyphs like truncation marks on
14348 terminal frames. */
14349 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14351 if (!row
->reversed_p
)
14354 && NILP (glyph
->object
)
14355 && glyph
->charpos
< 0)
14357 x
+= glyph
->pixel_width
;
14361 && NILP ((end
- 1)->object
)
14362 /* CHARPOS is zero for blanks and stretch glyphs
14363 inserted by extend_face_to_end_of_line. */
14364 && (end
- 1)->charpos
<= 0)
14366 glyph_before
= glyph
- 1;
14373 /* If the glyph row is reversed, we need to process it from back
14374 to front, so swap the edge pointers. */
14375 glyphs_end
= end
= glyph
- 1;
14376 glyph
+= row
->used
[TEXT_AREA
] - 1;
14378 while (glyph
> end
+ 1
14379 && NILP (glyph
->object
)
14380 && glyph
->charpos
< 0)
14383 x
-= glyph
->pixel_width
;
14385 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14387 /* By default, in reversed rows we put the cursor on the
14388 rightmost (first in the reading order) glyph. */
14389 for (g
= end
+ 1; g
< glyph
; g
++)
14390 x
+= g
->pixel_width
;
14392 && NILP ((end
+ 1)->object
)
14393 && (end
+ 1)->charpos
<= 0)
14395 glyph_before
= glyph
+ 1;
14399 else if (row
->reversed_p
)
14401 /* In R2L rows that don't display text, put the cursor on the
14402 rightmost glyph. Case in point: an empty last line that is
14403 part of an R2L paragraph. */
14405 /* Avoid placing the cursor on the last glyph of the row, where
14406 on terminal frames we hold the vertical border between
14407 adjacent windows. */
14408 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14409 && !WINDOW_RIGHTMOST_P (w
)
14410 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14412 x
= -1; /* will be computed below, at label compute_x */
14415 /* Step 1: Try to find the glyph whose character position
14416 corresponds to point. If that's not possible, find 2 glyphs
14417 whose character positions are the closest to point, one before
14418 point, the other after it. */
14419 if (!row
->reversed_p
)
14420 while (/* not marched to end of glyph row */
14422 /* glyph was not inserted by redisplay for internal purposes */
14423 && !NILP (glyph
->object
))
14425 if (BUFFERP (glyph
->object
))
14427 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14429 if (glyph
->charpos
> bpos_max
)
14430 bpos_max
= glyph
->charpos
;
14431 if (glyph
->charpos
< bpos_min
)
14432 bpos_min
= glyph
->charpos
;
14433 if (!glyph
->avoid_cursor_p
)
14435 /* If we hit point, we've found the glyph on which to
14436 display the cursor. */
14439 match_with_avoid_cursor
= 0;
14442 /* See if we've found a better approximation to
14443 POS_BEFORE or to POS_AFTER. */
14444 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14446 pos_before
= glyph
->charpos
;
14447 glyph_before
= glyph
;
14449 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14451 pos_after
= glyph
->charpos
;
14452 glyph_after
= glyph
;
14455 else if (dpos
== 0)
14456 match_with_avoid_cursor
= 1;
14458 else if (STRINGP (glyph
->object
))
14460 Lisp_Object chprop
;
14461 ptrdiff_t glyph_pos
= glyph
->charpos
;
14463 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14465 if (!NILP (chprop
))
14467 /* If the string came from a `display' text property,
14468 look up the buffer position of that property and
14469 use that position to update bpos_max, as if we
14470 actually saw such a position in one of the row's
14471 glyphs. This helps with supporting integer values
14472 of `cursor' property on the display string in
14473 situations where most or all of the row's buffer
14474 text is completely covered by display properties,
14475 so that no glyph with valid buffer positions is
14476 ever seen in the row. */
14477 ptrdiff_t prop_pos
=
14478 string_buffer_position_lim (glyph
->object
, pos_before
,
14481 if (prop_pos
>= pos_before
)
14482 bpos_max
= prop_pos
;
14484 if (INTEGERP (chprop
))
14486 bpos_covered
= bpos_max
+ XINT (chprop
);
14487 /* If the `cursor' property covers buffer positions up
14488 to and including point, we should display cursor on
14489 this glyph. Note that, if a `cursor' property on one
14490 of the string's characters has an integer value, we
14491 will break out of the loop below _before_ we get to
14492 the position match above. IOW, integer values of
14493 the `cursor' property override the "exact match for
14494 point" strategy of positioning the cursor. */
14495 /* Implementation note: bpos_max == pt_old when, e.g.,
14496 we are in an empty line, where bpos_max is set to
14497 MATRIX_ROW_START_CHARPOS, see above. */
14498 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14507 x
+= glyph
->pixel_width
;
14510 else if (glyph
> end
) /* row is reversed */
14511 while (!NILP (glyph
->object
))
14513 if (BUFFERP (glyph
->object
))
14515 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14517 if (glyph
->charpos
> bpos_max
)
14518 bpos_max
= glyph
->charpos
;
14519 if (glyph
->charpos
< bpos_min
)
14520 bpos_min
= glyph
->charpos
;
14521 if (!glyph
->avoid_cursor_p
)
14525 match_with_avoid_cursor
= 0;
14528 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14530 pos_before
= glyph
->charpos
;
14531 glyph_before
= glyph
;
14533 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14535 pos_after
= glyph
->charpos
;
14536 glyph_after
= glyph
;
14539 else if (dpos
== 0)
14540 match_with_avoid_cursor
= 1;
14542 else if (STRINGP (glyph
->object
))
14544 Lisp_Object chprop
;
14545 ptrdiff_t glyph_pos
= glyph
->charpos
;
14547 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14549 if (!NILP (chprop
))
14551 ptrdiff_t prop_pos
=
14552 string_buffer_position_lim (glyph
->object
, pos_before
,
14555 if (prop_pos
>= pos_before
)
14556 bpos_max
= prop_pos
;
14558 if (INTEGERP (chprop
))
14560 bpos_covered
= bpos_max
+ XINT (chprop
);
14561 /* If the `cursor' property covers buffer positions up
14562 to and including point, we should display cursor on
14564 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14573 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14575 x
--; /* can't use any pixel_width */
14578 x
-= glyph
->pixel_width
;
14581 /* Step 2: If we didn't find an exact match for point, we need to
14582 look for a proper place to put the cursor among glyphs between
14583 GLYPH_BEFORE and GLYPH_AFTER. */
14584 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14585 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14586 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14588 /* An empty line has a single glyph whose OBJECT is nil and
14589 whose CHARPOS is the position of a newline on that line.
14590 Note that on a TTY, there are more glyphs after that, which
14591 were produced by extend_face_to_end_of_line, but their
14592 CHARPOS is zero or negative. */
14594 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14595 && NILP (glyph
->object
) && glyph
->charpos
> 0
14596 /* On a TTY, continued and truncated rows also have a glyph at
14597 their end whose OBJECT is nil and whose CHARPOS is
14598 positive (the continuation and truncation glyphs), but such
14599 rows are obviously not "empty". */
14600 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14602 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14604 ptrdiff_t ellipsis_pos
;
14606 /* Scan back over the ellipsis glyphs. */
14607 if (!row
->reversed_p
)
14609 ellipsis_pos
= (glyph
- 1)->charpos
;
14610 while (glyph
> row
->glyphs
[TEXT_AREA
]
14611 && (glyph
- 1)->charpos
== ellipsis_pos
)
14612 glyph
--, x
-= glyph
->pixel_width
;
14613 /* That loop always goes one position too far, including
14614 the glyph before the ellipsis. So scan forward over
14616 x
+= glyph
->pixel_width
;
14619 else /* row is reversed */
14621 ellipsis_pos
= (glyph
+ 1)->charpos
;
14622 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14623 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14624 glyph
++, x
+= glyph
->pixel_width
;
14625 x
-= glyph
->pixel_width
;
14629 else if (match_with_avoid_cursor
)
14631 cursor
= glyph_after
;
14634 else if (string_seen
)
14636 int incr
= row
->reversed_p
? -1 : +1;
14638 /* Need to find the glyph that came out of a string which is
14639 present at point. That glyph is somewhere between
14640 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14641 positioned between POS_BEFORE and POS_AFTER in the
14643 struct glyph
*start
, *stop
;
14644 ptrdiff_t pos
= pos_before
;
14648 /* If the row ends in a newline from a display string,
14649 reordering could have moved the glyphs belonging to the
14650 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14651 in this case we extend the search to the last glyph in
14652 the row that was not inserted by redisplay. */
14653 if (row
->ends_in_newline_from_string_p
)
14656 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14659 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14660 correspond to POS_BEFORE and POS_AFTER, respectively. We
14661 need START and STOP in the order that corresponds to the
14662 row's direction as given by its reversed_p flag. If the
14663 directionality of characters between POS_BEFORE and
14664 POS_AFTER is the opposite of the row's base direction,
14665 these characters will have been reordered for display,
14666 and we need to reverse START and STOP. */
14667 if (!row
->reversed_p
)
14669 start
= min (glyph_before
, glyph_after
);
14670 stop
= max (glyph_before
, glyph_after
);
14674 start
= max (glyph_before
, glyph_after
);
14675 stop
= min (glyph_before
, glyph_after
);
14677 for (glyph
= start
+ incr
;
14678 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14681 /* Any glyphs that come from the buffer are here because
14682 of bidi reordering. Skip them, and only pay
14683 attention to glyphs that came from some string. */
14684 if (STRINGP (glyph
->object
))
14688 /* If the display property covers the newline, we
14689 need to search for it one position farther. */
14690 ptrdiff_t lim
= pos_after
14691 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14693 string_from_text_prop
= 0;
14694 str
= glyph
->object
;
14695 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14696 if (tem
== 0 /* from overlay */
14699 /* If the string from which this glyph came is
14700 found in the buffer at point, or at position
14701 that is closer to point than pos_after, then
14702 we've found the glyph we've been looking for.
14703 If it comes from an overlay (tem == 0), and
14704 it has the `cursor' property on one of its
14705 glyphs, record that glyph as a candidate for
14706 displaying the cursor. (As in the
14707 unidirectional version, we will display the
14708 cursor on the last candidate we find.) */
14711 || (tem
- pt_old
> 0 && tem
< pos_after
))
14713 /* The glyphs from this string could have
14714 been reordered. Find the one with the
14715 smallest string position. Or there could
14716 be a character in the string with the
14717 `cursor' property, which means display
14718 cursor on that character's glyph. */
14719 ptrdiff_t strpos
= glyph
->charpos
;
14724 string_from_text_prop
= 1;
14727 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14728 && EQ (glyph
->object
, str
);
14732 ptrdiff_t gpos
= glyph
->charpos
;
14734 cprop
= Fget_char_property (make_number (gpos
),
14742 if (tem
&& glyph
->charpos
< strpos
)
14744 strpos
= glyph
->charpos
;
14750 || (tem
- pt_old
> 0 && tem
< pos_after
))
14754 pos
= tem
+ 1; /* don't find previous instances */
14756 /* This string is not what we want; skip all of the
14757 glyphs that came from it. */
14758 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14759 && EQ (glyph
->object
, str
))
14766 /* If we reached the end of the line, and END was from a string,
14767 the cursor is not on this line. */
14769 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14770 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14771 && STRINGP (end
->object
)
14772 && row
->continued_p
)
14775 /* A truncated row may not include PT among its character positions.
14776 Setting the cursor inside the scroll margin will trigger
14777 recalculation of hscroll in hscroll_window_tree. But if a
14778 display string covers point, defer to the string-handling
14779 code below to figure this out. */
14780 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14782 cursor
= glyph_before
;
14785 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14786 /* Zero-width characters produce no glyphs. */
14788 && (row
->reversed_p
14789 ? glyph_after
> glyphs_end
14790 : glyph_after
< glyphs_end
)))
14792 cursor
= glyph_after
;
14798 if (cursor
!= NULL
)
14800 else if (glyph
== glyphs_end
14801 && pos_before
== pos_after
14802 && STRINGP ((row
->reversed_p
14803 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14804 : row
->glyphs
[TEXT_AREA
])->object
))
14806 /* If all the glyphs of this row came from strings, put the
14807 cursor on the first glyph of the row. This avoids having the
14808 cursor outside of the text area in this very rare and hard
14812 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14813 : row
->glyphs
[TEXT_AREA
];
14819 /* Need to compute x that corresponds to GLYPH. */
14820 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14822 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14824 x
+= g
->pixel_width
;
14828 /* ROW could be part of a continued line, which, under bidi
14829 reordering, might have other rows whose start and end charpos
14830 occlude point. Only set w->cursor if we found a better
14831 approximation to the cursor position than we have from previously
14832 examined candidate rows belonging to the same continued line. */
14833 if (/* We already have a candidate row. */
14834 w
->cursor
.vpos
>= 0
14835 /* That candidate is not the row we are processing. */
14836 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14837 /* Make sure cursor.vpos specifies a row whose start and end
14838 charpos occlude point, and it is valid candidate for being a
14839 cursor-row. This is because some callers of this function
14840 leave cursor.vpos at the row where the cursor was displayed
14841 during the last redisplay cycle. */
14842 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14843 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14844 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14847 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14849 /* Don't consider glyphs that are outside TEXT_AREA. */
14850 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14852 /* Keep the candidate whose buffer position is the closest to
14853 point or has the `cursor' property. */
14854 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14855 w
->cursor
.hpos
>= 0
14856 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14857 && ((BUFFERP (g1
->object
)
14858 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14859 || (BUFFERP (glyph
->object
)
14860 && eabs (g1
->charpos
- pt_old
)
14861 < eabs (glyph
->charpos
- pt_old
))))
14862 /* Previous candidate is a glyph from a string that has
14863 a non-nil `cursor' property. */
14864 || (STRINGP (g1
->object
)
14865 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14866 Qcursor
, g1
->object
))
14867 /* Previous candidate is from the same display
14868 string as this one, and the display string
14869 came from a text property. */
14870 || (EQ (g1
->object
, glyph
->object
)
14871 && string_from_text_prop
)
14872 /* this candidate is from newline and its
14873 position is not an exact match */
14874 || (NILP (glyph
->object
)
14875 && glyph
->charpos
!= pt_old
)))))
14877 /* If this candidate gives an exact match, use that. */
14878 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14879 /* If this candidate is a glyph created for the
14880 terminating newline of a line, and point is on that
14881 newline, it wins because it's an exact match. */
14882 || (!row
->continued_p
14883 && NILP (glyph
->object
)
14884 && glyph
->charpos
== 0
14885 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14886 /* Otherwise, keep the candidate that comes from a row
14887 spanning less buffer positions. This may win when one or
14888 both candidate positions are on glyphs that came from
14889 display strings, for which we cannot compare buffer
14891 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14892 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14893 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14896 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14898 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14899 w
->cursor
.y
= row
->y
+ dy
;
14901 if (w
== XWINDOW (selected_window
))
14903 if (!row
->continued_p
14904 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14907 this_line_buffer
= XBUFFER (w
->contents
);
14909 CHARPOS (this_line_start_pos
)
14910 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14911 BYTEPOS (this_line_start_pos
)
14912 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14914 CHARPOS (this_line_end_pos
)
14915 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14916 BYTEPOS (this_line_end_pos
)
14917 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14919 this_line_y
= w
->cursor
.y
;
14920 this_line_pixel_height
= row
->height
;
14921 this_line_vpos
= w
->cursor
.vpos
;
14922 this_line_start_x
= row
->x
;
14925 CHARPOS (this_line_start_pos
) = 0;
14932 /* Run window scroll functions, if any, for WINDOW with new window
14933 start STARTP. Sets the window start of WINDOW to that position.
14935 We assume that the window's buffer is really current. */
14937 static struct text_pos
14938 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14940 struct window
*w
= XWINDOW (window
);
14941 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14943 eassert (current_buffer
== XBUFFER (w
->contents
));
14945 if (!NILP (Vwindow_scroll_functions
))
14947 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14948 make_number (CHARPOS (startp
)));
14949 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14950 /* In case the hook functions switch buffers. */
14951 set_buffer_internal (XBUFFER (w
->contents
));
14958 /* Make sure the line containing the cursor is fully visible.
14959 A value of 1 means there is nothing to be done.
14960 (Either the line is fully visible, or it cannot be made so,
14961 or we cannot tell.)
14963 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14964 is higher than window.
14966 If CURRENT_MATRIX_P is non-zero, use the information from the
14967 window's current glyph matrix; otherwise use the desired glyph
14970 A value of 0 means the caller should do scrolling
14971 as if point had gone off the screen. */
14974 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14976 struct glyph_matrix
*matrix
;
14977 struct glyph_row
*row
;
14980 if (!make_cursor_line_fully_visible_p
)
14983 /* It's not always possible to find the cursor, e.g, when a window
14984 is full of overlay strings. Don't do anything in that case. */
14985 if (w
->cursor
.vpos
< 0)
14988 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14989 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14991 /* If the cursor row is not partially visible, there's nothing to do. */
14992 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14995 /* If the row the cursor is in is taller than the window's height,
14996 it's not clear what to do, so do nothing. */
14997 window_height
= window_box_height (w
);
14998 if (row
->height
>= window_height
)
15000 if (!force_p
|| MINI_WINDOW_P (w
)
15001 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15008 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15009 non-zero means only WINDOW is redisplayed in redisplay_internal.
15010 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15011 in redisplay_window to bring a partially visible line into view in
15012 the case that only the cursor has moved.
15014 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15015 last screen line's vertical height extends past the end of the screen.
15019 1 if scrolling succeeded
15021 0 if scrolling didn't find point.
15023 -1 if new fonts have been loaded so that we must interrupt
15024 redisplay, adjust glyph matrices, and try again. */
15030 SCROLLING_NEED_LARGER_MATRICES
15033 /* If scroll-conservatively is more than this, never recenter.
15035 If you change this, don't forget to update the doc string of
15036 `scroll-conservatively' and the Emacs manual. */
15037 #define SCROLL_LIMIT 100
15040 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15041 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15042 int temp_scroll_step
, int last_line_misfit
)
15044 struct window
*w
= XWINDOW (window
);
15045 struct frame
*f
= XFRAME (w
->frame
);
15046 struct text_pos pos
, startp
;
15048 int this_scroll_margin
, scroll_max
, rc
, height
;
15049 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15050 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15051 Lisp_Object aggressive
;
15052 /* We will never try scrolling more than this number of lines. */
15053 int scroll_limit
= SCROLL_LIMIT
;
15054 int frame_line_height
= default_line_pixel_height (w
);
15055 int window_total_lines
15056 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15059 debug_method_add (w
, "try_scrolling");
15062 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15064 /* Compute scroll margin height in pixels. We scroll when point is
15065 within this distance from the top or bottom of the window. */
15066 if (scroll_margin
> 0)
15067 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15068 * frame_line_height
;
15070 this_scroll_margin
= 0;
15072 /* Force arg_scroll_conservatively to have a reasonable value, to
15073 avoid scrolling too far away with slow move_it_* functions. Note
15074 that the user can supply scroll-conservatively equal to
15075 `most-positive-fixnum', which can be larger than INT_MAX. */
15076 if (arg_scroll_conservatively
> scroll_limit
)
15078 arg_scroll_conservatively
= scroll_limit
+ 1;
15079 scroll_max
= scroll_limit
* frame_line_height
;
15081 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15082 /* Compute how much we should try to scroll maximally to bring
15083 point into view. */
15084 scroll_max
= (max (scroll_step
,
15085 max (arg_scroll_conservatively
, temp_scroll_step
))
15086 * frame_line_height
);
15087 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15088 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15089 /* We're trying to scroll because of aggressive scrolling but no
15090 scroll_step is set. Choose an arbitrary one. */
15091 scroll_max
= 10 * frame_line_height
;
15097 /* Decide whether to scroll down. */
15098 if (PT
> CHARPOS (startp
))
15100 int scroll_margin_y
;
15102 /* Compute the pixel ypos of the scroll margin, then move IT to
15103 either that ypos or PT, whichever comes first. */
15104 start_display (&it
, w
, startp
);
15105 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15106 - frame_line_height
* extra_scroll_margin_lines
;
15107 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15108 (MOVE_TO_POS
| MOVE_TO_Y
));
15110 if (PT
> CHARPOS (it
.current
.pos
))
15112 int y0
= line_bottom_y (&it
);
15113 /* Compute how many pixels below window bottom to stop searching
15114 for PT. This avoids costly search for PT that is far away if
15115 the user limited scrolling by a small number of lines, but
15116 always finds PT if scroll_conservatively is set to a large
15117 number, such as most-positive-fixnum. */
15118 int slack
= max (scroll_max
, 10 * frame_line_height
);
15119 int y_to_move
= it
.last_visible_y
+ slack
;
15121 /* Compute the distance from the scroll margin to PT or to
15122 the scroll limit, whichever comes first. This should
15123 include the height of the cursor line, to make that line
15125 move_it_to (&it
, PT
, -1, y_to_move
,
15126 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15127 dy
= line_bottom_y (&it
) - y0
;
15129 if (dy
> scroll_max
)
15130 return SCROLLING_FAILED
;
15139 /* Point is in or below the bottom scroll margin, so move the
15140 window start down. If scrolling conservatively, move it just
15141 enough down to make point visible. If scroll_step is set,
15142 move it down by scroll_step. */
15143 if (arg_scroll_conservatively
)
15145 = min (max (dy
, frame_line_height
),
15146 frame_line_height
* arg_scroll_conservatively
);
15147 else if (scroll_step
|| temp_scroll_step
)
15148 amount_to_scroll
= scroll_max
;
15151 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15152 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15153 if (NUMBERP (aggressive
))
15155 double float_amount
= XFLOATINT (aggressive
) * height
;
15156 int aggressive_scroll
= float_amount
;
15157 if (aggressive_scroll
== 0 && float_amount
> 0)
15158 aggressive_scroll
= 1;
15159 /* Don't let point enter the scroll margin near top of
15160 the window. This could happen if the value of
15161 scroll_up_aggressively is too large and there are
15162 non-zero margins, because scroll_up_aggressively
15163 means put point that fraction of window height
15164 _from_the_bottom_margin_. */
15165 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15166 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15167 amount_to_scroll
= dy
+ aggressive_scroll
;
15171 if (amount_to_scroll
<= 0)
15172 return SCROLLING_FAILED
;
15174 start_display (&it
, w
, startp
);
15175 if (arg_scroll_conservatively
<= scroll_limit
)
15176 move_it_vertically (&it
, amount_to_scroll
);
15179 /* Extra precision for users who set scroll-conservatively
15180 to a large number: make sure the amount we scroll
15181 the window start is never less than amount_to_scroll,
15182 which was computed as distance from window bottom to
15183 point. This matters when lines at window top and lines
15184 below window bottom have different height. */
15186 void *it1data
= NULL
;
15187 /* We use a temporary it1 because line_bottom_y can modify
15188 its argument, if it moves one line down; see there. */
15191 SAVE_IT (it1
, it
, it1data
);
15192 start_y
= line_bottom_y (&it1
);
15194 RESTORE_IT (&it
, &it
, it1data
);
15195 move_it_by_lines (&it
, 1);
15196 SAVE_IT (it1
, it
, it1data
);
15197 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15200 /* If STARTP is unchanged, move it down another screen line. */
15201 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15202 move_it_by_lines (&it
, 1);
15203 startp
= it
.current
.pos
;
15207 struct text_pos scroll_margin_pos
= startp
;
15210 /* See if point is inside the scroll margin at the top of the
15212 if (this_scroll_margin
)
15216 start_display (&it
, w
, startp
);
15217 y_start
= it
.current_y
;
15218 move_it_vertically (&it
, this_scroll_margin
);
15219 scroll_margin_pos
= it
.current
.pos
;
15220 /* If we didn't move enough before hitting ZV, request
15221 additional amount of scroll, to move point out of the
15223 if (IT_CHARPOS (it
) == ZV
15224 && it
.current_y
- y_start
< this_scroll_margin
)
15225 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15228 if (PT
< CHARPOS (scroll_margin_pos
))
15230 /* Point is in the scroll margin at the top of the window or
15231 above what is displayed in the window. */
15234 /* Compute the vertical distance from PT to the scroll
15235 margin position. Move as far as scroll_max allows, or
15236 one screenful, or 10 screen lines, whichever is largest.
15237 Give up if distance is greater than scroll_max or if we
15238 didn't reach the scroll margin position. */
15239 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15240 start_display (&it
, w
, pos
);
15242 y_to_move
= max (it
.last_visible_y
,
15243 max (scroll_max
, 10 * frame_line_height
));
15244 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15246 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15247 dy
= it
.current_y
- y0
;
15248 if (dy
> scroll_max
15249 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15250 return SCROLLING_FAILED
;
15252 /* Additional scroll for when ZV was too close to point. */
15255 /* Compute new window start. */
15256 start_display (&it
, w
, startp
);
15258 if (arg_scroll_conservatively
)
15259 amount_to_scroll
= max (dy
, frame_line_height
15260 * max (scroll_step
, temp_scroll_step
));
15261 else if (scroll_step
|| temp_scroll_step
)
15262 amount_to_scroll
= scroll_max
;
15265 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15266 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15267 if (NUMBERP (aggressive
))
15269 double float_amount
= XFLOATINT (aggressive
) * height
;
15270 int aggressive_scroll
= float_amount
;
15271 if (aggressive_scroll
== 0 && float_amount
> 0)
15272 aggressive_scroll
= 1;
15273 /* Don't let point enter the scroll margin near
15274 bottom of the window, if the value of
15275 scroll_down_aggressively happens to be too
15277 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15278 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15279 amount_to_scroll
= dy
+ aggressive_scroll
;
15283 if (amount_to_scroll
<= 0)
15284 return SCROLLING_FAILED
;
15286 move_it_vertically_backward (&it
, amount_to_scroll
);
15287 startp
= it
.current
.pos
;
15291 /* Run window scroll functions. */
15292 startp
= run_window_scroll_functions (window
, startp
);
15294 /* Display the window. Give up if new fonts are loaded, or if point
15296 if (!try_window (window
, startp
, 0))
15297 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15298 else if (w
->cursor
.vpos
< 0)
15300 clear_glyph_matrix (w
->desired_matrix
);
15301 rc
= SCROLLING_FAILED
;
15305 /* Maybe forget recorded base line for line number display. */
15306 if (!just_this_one_p
15307 || current_buffer
->clip_changed
15308 || BEG_UNCHANGED
< CHARPOS (startp
))
15309 w
->base_line_number
= 0;
15311 /* If cursor ends up on a partially visible line,
15312 treat that as being off the bottom of the screen. */
15313 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15314 /* It's possible that the cursor is on the first line of the
15315 buffer, which is partially obscured due to a vscroll
15316 (Bug#7537). In that case, avoid looping forever. */
15317 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15319 clear_glyph_matrix (w
->desired_matrix
);
15320 ++extra_scroll_margin_lines
;
15323 rc
= SCROLLING_SUCCESS
;
15330 /* Compute a suitable window start for window W if display of W starts
15331 on a continuation line. Value is non-zero if a new window start
15334 The new window start will be computed, based on W's width, starting
15335 from the start of the continued line. It is the start of the
15336 screen line with the minimum distance from the old start W->start. */
15339 compute_window_start_on_continuation_line (struct window
*w
)
15341 struct text_pos pos
, start_pos
;
15342 int window_start_changed_p
= 0;
15344 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15346 /* If window start is on a continuation line... Window start may be
15347 < BEGV in case there's invisible text at the start of the
15348 buffer (M-x rmail, for example). */
15349 if (CHARPOS (start_pos
) > BEGV
15350 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15353 struct glyph_row
*row
;
15355 /* Handle the case that the window start is out of range. */
15356 if (CHARPOS (start_pos
) < BEGV
)
15357 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15358 else if (CHARPOS (start_pos
) > ZV
)
15359 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15361 /* Find the start of the continued line. This should be fast
15362 because find_newline is fast (newline cache). */
15363 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15364 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15365 row
, DEFAULT_FACE_ID
);
15366 reseat_at_previous_visible_line_start (&it
);
15368 /* If the line start is "too far" away from the window start,
15369 say it takes too much time to compute a new window start. */
15370 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15371 /* PXW: Do we need upper bounds here? */
15372 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15374 int min_distance
, distance
;
15376 /* Move forward by display lines to find the new window
15377 start. If window width was enlarged, the new start can
15378 be expected to be > the old start. If window width was
15379 decreased, the new window start will be < the old start.
15380 So, we're looking for the display line start with the
15381 minimum distance from the old window start. */
15382 pos
= it
.current
.pos
;
15383 min_distance
= INFINITY
;
15384 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15385 distance
< min_distance
)
15387 min_distance
= distance
;
15388 pos
= it
.current
.pos
;
15389 if (it
.line_wrap
== WORD_WRAP
)
15391 /* Under WORD_WRAP, move_it_by_lines is likely to
15392 overshoot and stop not at the first, but the
15393 second character from the left margin. So in
15394 that case, we need a more tight control on the X
15395 coordinate of the iterator than move_it_by_lines
15396 promises in its contract. The method is to first
15397 go to the last (rightmost) visible character of a
15398 line, then move to the leftmost character on the
15399 next line in a separate call. */
15400 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15401 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15402 move_it_to (&it
, ZV
, 0,
15403 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15404 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15407 move_it_by_lines (&it
, 1);
15410 /* Set the window start there. */
15411 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15412 window_start_changed_p
= 1;
15416 return window_start_changed_p
;
15420 /* Try cursor movement in case text has not changed in window WINDOW,
15421 with window start STARTP. Value is
15423 CURSOR_MOVEMENT_SUCCESS if successful
15425 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15427 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15428 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15429 we want to scroll as if scroll-step were set to 1. See the code.
15431 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15432 which case we have to abort this redisplay, and adjust matrices
15437 CURSOR_MOVEMENT_SUCCESS
,
15438 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15439 CURSOR_MOVEMENT_MUST_SCROLL
,
15440 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15444 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15446 struct window
*w
= XWINDOW (window
);
15447 struct frame
*f
= XFRAME (w
->frame
);
15448 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15451 if (inhibit_try_cursor_movement
)
15455 /* Previously, there was a check for Lisp integer in the
15456 if-statement below. Now, this field is converted to
15457 ptrdiff_t, thus zero means invalid position in a buffer. */
15458 eassert (w
->last_point
> 0);
15459 /* Likewise there was a check whether window_end_vpos is nil or larger
15460 than the window. Now window_end_vpos is int and so never nil, but
15461 let's leave eassert to check whether it fits in the window. */
15462 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15464 /* Handle case where text has not changed, only point, and it has
15465 not moved off the frame. */
15466 if (/* Point may be in this window. */
15467 PT
>= CHARPOS (startp
)
15468 /* Selective display hasn't changed. */
15469 && !current_buffer
->clip_changed
15470 /* Function force-mode-line-update is used to force a thorough
15471 redisplay. It sets either windows_or_buffers_changed or
15472 update_mode_lines. So don't take a shortcut here for these
15474 && !update_mode_lines
15475 && !windows_or_buffers_changed
15476 && !f
->cursor_type_changed
15477 && NILP (Vshow_trailing_whitespace
)
15478 /* This code is not used for mini-buffer for the sake of the case
15479 of redisplaying to replace an echo area message; since in
15480 that case the mini-buffer contents per se are usually
15481 unchanged. This code is of no real use in the mini-buffer
15482 since the handling of this_line_start_pos, etc., in redisplay
15483 handles the same cases. */
15484 && !EQ (window
, minibuf_window
)
15485 && (FRAME_WINDOW_P (f
)
15486 || !overlay_arrow_in_current_buffer_p ()))
15488 int this_scroll_margin
, top_scroll_margin
;
15489 struct glyph_row
*row
= NULL
;
15490 int frame_line_height
= default_line_pixel_height (w
);
15491 int window_total_lines
15492 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15495 debug_method_add (w
, "cursor movement");
15498 /* Scroll if point within this distance from the top or bottom
15499 of the window. This is a pixel value. */
15500 if (scroll_margin
> 0)
15502 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15503 this_scroll_margin
*= frame_line_height
;
15506 this_scroll_margin
= 0;
15508 top_scroll_margin
= this_scroll_margin
;
15509 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15510 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15512 /* Start with the row the cursor was displayed during the last
15513 not paused redisplay. Give up if that row is not valid. */
15514 if (w
->last_cursor_vpos
< 0
15515 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15516 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15519 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15520 if (row
->mode_line_p
)
15522 if (!row
->enabled_p
)
15523 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15526 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15528 int scroll_p
= 0, must_scroll
= 0;
15529 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15531 if (PT
> w
->last_point
)
15533 /* Point has moved forward. */
15534 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15535 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15537 eassert (row
->enabled_p
);
15541 /* If the end position of a row equals the start
15542 position of the next row, and PT is at that position,
15543 we would rather display cursor in the next line. */
15544 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15545 && MATRIX_ROW_END_CHARPOS (row
) == PT
15546 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15547 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15548 && !cursor_row_p (row
))
15551 /* If within the scroll margin, scroll. Note that
15552 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15553 the next line would be drawn, and that
15554 this_scroll_margin can be zero. */
15555 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15556 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15557 /* Line is completely visible last line in window
15558 and PT is to be set in the next line. */
15559 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15560 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15561 && !row
->ends_at_zv_p
15562 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15565 else if (PT
< w
->last_point
)
15567 /* Cursor has to be moved backward. Note that PT >=
15568 CHARPOS (startp) because of the outer if-statement. */
15569 while (!row
->mode_line_p
15570 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15571 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15572 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15573 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15574 row
> w
->current_matrix
->rows
15575 && (row
-1)->ends_in_newline_from_string_p
))))
15576 && (row
->y
> top_scroll_margin
15577 || CHARPOS (startp
) == BEGV
))
15579 eassert (row
->enabled_p
);
15583 /* Consider the following case: Window starts at BEGV,
15584 there is invisible, intangible text at BEGV, so that
15585 display starts at some point START > BEGV. It can
15586 happen that we are called with PT somewhere between
15587 BEGV and START. Try to handle that case. */
15588 if (row
< w
->current_matrix
->rows
15589 || row
->mode_line_p
)
15591 row
= w
->current_matrix
->rows
;
15592 if (row
->mode_line_p
)
15596 /* Due to newlines in overlay strings, we may have to
15597 skip forward over overlay strings. */
15598 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15599 && MATRIX_ROW_END_CHARPOS (row
) == PT
15600 && !cursor_row_p (row
))
15603 /* If within the scroll margin, scroll. */
15604 if (row
->y
< top_scroll_margin
15605 && CHARPOS (startp
) != BEGV
)
15610 /* Cursor did not move. So don't scroll even if cursor line
15611 is partially visible, as it was so before. */
15612 rc
= CURSOR_MOVEMENT_SUCCESS
;
15615 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15616 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15618 /* if PT is not in the glyph row, give up. */
15619 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15622 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15623 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15625 struct glyph_row
*row1
;
15627 /* If rows are bidi-reordered and point moved, back up
15628 until we find a row that does not belong to a
15629 continuation line. This is because we must consider
15630 all rows of a continued line as candidates for the
15631 new cursor positioning, since row start and end
15632 positions change non-linearly with vertical position
15634 /* FIXME: Revisit this when glyph ``spilling'' in
15635 continuation lines' rows is implemented for
15636 bidi-reordered rows. */
15637 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15638 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15641 /* If we hit the beginning of the displayed portion
15642 without finding the first row of a continued
15646 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15649 eassert (row
->enabled_p
);
15654 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15655 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15656 /* Make sure this isn't a header line by any chance, since
15657 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15658 && !row
->mode_line_p
15659 && make_cursor_line_fully_visible_p
)
15661 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15662 && !row
->ends_at_zv_p
15663 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15664 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15665 else if (row
->height
> window_box_height (w
))
15667 /* If we end up in a partially visible line, let's
15668 make it fully visible, except when it's taller
15669 than the window, in which case we can't do much
15672 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15676 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15677 if (!cursor_row_fully_visible_p (w
, 0, 1))
15678 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15680 rc
= CURSOR_MOVEMENT_SUCCESS
;
15684 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15685 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15686 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15688 /* With bidi-reordered rows, there could be more than
15689 one candidate row whose start and end positions
15690 occlude point. We need to let set_cursor_from_row
15691 find the best candidate. */
15692 /* FIXME: Revisit this when glyph ``spilling'' in
15693 continuation lines' rows is implemented for
15694 bidi-reordered rows. */
15699 int at_zv_p
= 0, exact_match_p
= 0;
15701 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15702 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15703 && cursor_row_p (row
))
15704 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15706 /* As soon as we've found the exact match for point,
15707 or the first suitable row whose ends_at_zv_p flag
15708 is set, we are done. */
15711 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15712 w
->cursor
.vpos
)->ends_at_zv_p
;
15714 && w
->cursor
.hpos
>= 0
15715 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15718 struct glyph_row
*candidate
=
15719 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15721 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15722 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15725 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15726 || (NILP (g
->object
)
15727 && (g
->charpos
== PT
15728 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15730 if (at_zv_p
|| exact_match_p
)
15732 rc
= CURSOR_MOVEMENT_SUCCESS
;
15736 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15740 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15741 || row
->continued_p
)
15742 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15743 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15744 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15745 /* If we didn't find any candidate rows, or exited the
15746 loop before all the candidates were examined, signal
15747 to the caller that this method failed. */
15748 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15750 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15751 && !row
->continued_p
))
15752 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15754 rc
= CURSOR_MOVEMENT_SUCCESS
;
15760 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15762 rc
= CURSOR_MOVEMENT_SUCCESS
;
15767 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15768 && MATRIX_ROW_START_CHARPOS (row
) == PT
15769 && cursor_row_p (row
));
15779 set_vertical_scroll_bar (struct window
*w
)
15781 ptrdiff_t start
, end
, whole
;
15783 /* Calculate the start and end positions for the current window.
15784 At some point, it would be nice to choose between scrollbars
15785 which reflect the whole buffer size, with special markers
15786 indicating narrowing, and scrollbars which reflect only the
15789 Note that mini-buffers sometimes aren't displaying any text. */
15790 if (!MINI_WINDOW_P (w
)
15791 || (w
== XWINDOW (minibuf_window
)
15792 && NILP (echo_area_buffer
[0])))
15794 struct buffer
*buf
= XBUFFER (w
->contents
);
15795 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15796 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15797 /* I don't think this is guaranteed to be right. For the
15798 moment, we'll pretend it is. */
15799 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15803 if (whole
< (end
- start
))
15804 whole
= end
- start
;
15807 start
= end
= whole
= 0;
15809 /* Indicate what this scroll bar ought to be displaying now. */
15810 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15811 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15812 (w
, end
- start
, whole
, start
);
15817 set_horizontal_scroll_bar (struct window
*w
)
15819 int start
, end
, whole
, portion
;
15821 if (!MINI_WINDOW_P (w
)
15822 || (w
== XWINDOW (minibuf_window
)
15823 && NILP (echo_area_buffer
[0])))
15825 struct buffer
*b
= XBUFFER (w
->contents
);
15826 struct buffer
*old_buffer
= NULL
;
15828 struct text_pos startp
;
15830 if (b
!= current_buffer
)
15832 old_buffer
= current_buffer
;
15833 set_buffer_internal (b
);
15836 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15837 start_display (&it
, w
, startp
);
15838 it
.last_visible_x
= INT_MAX
;
15839 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15840 MOVE_TO_X
| MOVE_TO_Y
);
15841 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15842 window_box_height (w), -1,
15843 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15845 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15846 end
= start
+ window_box_width (w
, TEXT_AREA
);
15847 portion
= end
- start
;
15848 /* After enlarging a horizontally scrolled window such that it
15849 gets at least as wide as the text it contains, make sure that
15850 the thumb doesn't fill the entire scroll bar so we can still
15851 drag it back to see the entire text. */
15852 whole
= max (whole
, end
);
15858 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15859 if (EQ (pdir
, Qright_to_left
))
15861 start
= whole
- end
;
15862 end
= start
+ portion
;
15867 set_buffer_internal (old_buffer
);
15870 start
= end
= whole
= portion
= 0;
15872 w
->hscroll_whole
= whole
;
15874 /* Indicate what this scroll bar ought to be displaying now. */
15875 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15876 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15877 (w
, portion
, whole
, start
);
15881 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15882 selected_window is redisplayed.
15884 We can return without actually redisplaying the window if fonts has been
15885 changed on window's frame. In that case, redisplay_internal will retry.
15887 As one of the important parts of redisplaying a window, we need to
15888 decide whether the previous window-start position (stored in the
15889 window's w->start marker position) is still valid, and if it isn't,
15890 recompute it. Some details about that:
15892 . The previous window-start could be in a continuation line, in
15893 which case we need to recompute it when the window width
15894 changes. See compute_window_start_on_continuation_line and its
15897 . The text that changed since last redisplay could include the
15898 previous window-start position. In that case, we try to salvage
15899 what we can from the current glyph matrix by calling
15900 try_scrolling, which see.
15902 . Some Emacs command could force us to use a specific window-start
15903 position by setting the window's force_start flag, or gently
15904 propose doing that by setting the window's optional_new_start
15905 flag. In these cases, we try using the specified start point if
15906 that succeeds (i.e. the window desired matrix is successfully
15907 recomputed, and point location is within the window). In case
15908 of optional_new_start, we first check if the specified start
15909 position is feasible, i.e. if it will allow point to be
15910 displayed in the window. If using the specified start point
15911 fails, e.g., if new fonts are needed to be loaded, we abort the
15912 redisplay cycle and leave it up to the next cycle to figure out
15915 . Note that the window's force_start flag is sometimes set by
15916 redisplay itself, when it decides that the previous window start
15917 point is fine and should be kept. Search for "goto force_start"
15918 below to see the details. Like the values of window-start
15919 specified outside of redisplay, these internally-deduced values
15920 are tested for feasibility, and ignored if found to be
15923 . Note that the function try_window, used to completely redisplay
15924 a window, accepts the window's start point as its argument.
15925 This is used several times in the redisplay code to control
15926 where the window start will be, according to user options such
15927 as scroll-conservatively, and also to ensure the screen line
15928 showing point will be fully (as opposed to partially) visible on
15932 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15934 struct window
*w
= XWINDOW (window
);
15935 struct frame
*f
= XFRAME (w
->frame
);
15936 struct buffer
*buffer
= XBUFFER (w
->contents
);
15937 struct buffer
*old
= current_buffer
;
15938 struct text_pos lpoint
, opoint
, startp
;
15939 int update_mode_line
;
15942 /* Record it now because it's overwritten. */
15943 bool current_matrix_up_to_date_p
= false;
15944 bool used_current_matrix_p
= false;
15945 /* This is less strict than current_matrix_up_to_date_p.
15946 It indicates that the buffer contents and narrowing are unchanged. */
15947 bool buffer_unchanged_p
= false;
15948 int temp_scroll_step
= 0;
15949 ptrdiff_t count
= SPECPDL_INDEX ();
15951 int centering_position
= -1;
15952 int last_line_misfit
= 0;
15953 ptrdiff_t beg_unchanged
, end_unchanged
;
15954 int frame_line_height
;
15956 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15960 *w
->desired_matrix
->method
= 0;
15963 if (!just_this_one_p
15964 && REDISPLAY_SOME_P ()
15967 && !buffer
->text
->redisplay
15968 && BUF_PT (buffer
) == w
->last_point
)
15971 /* Make sure that both W's markers are valid. */
15972 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15973 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15975 /* We come here again if we need to run window-text-change-functions
15978 reconsider_clip_changes (w
);
15979 frame_line_height
= default_line_pixel_height (w
);
15981 /* Has the mode line to be updated? */
15982 update_mode_line
= (w
->update_mode_line
15983 || update_mode_lines
15984 || buffer
->clip_changed
15985 || buffer
->prevent_redisplay_optimizations_p
);
15987 if (!just_this_one_p
)
15988 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15989 cleverly elsewhere. */
15990 w
->must_be_updated_p
= true;
15992 if (MINI_WINDOW_P (w
))
15994 if (w
== XWINDOW (echo_area_window
)
15995 && !NILP (echo_area_buffer
[0]))
15997 if (update_mode_line
)
15998 /* We may have to update a tty frame's menu bar or a
15999 tool-bar. Example `M-x C-h C-h C-g'. */
16000 goto finish_menu_bars
;
16002 /* We've already displayed the echo area glyphs in this window. */
16003 goto finish_scroll_bars
;
16005 else if ((w
!= XWINDOW (minibuf_window
)
16006 || minibuf_level
== 0)
16007 /* When buffer is nonempty, redisplay window normally. */
16008 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16009 /* Quail displays non-mini buffers in minibuffer window.
16010 In that case, redisplay the window normally. */
16011 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16013 /* W is a mini-buffer window, but it's not active, so clear
16015 int yb
= window_text_bottom_y (w
);
16016 struct glyph_row
*row
;
16019 for (y
= 0, row
= w
->desired_matrix
->rows
;
16021 y
+= row
->height
, ++row
)
16022 blank_row (w
, row
, y
);
16023 goto finish_scroll_bars
;
16026 clear_glyph_matrix (w
->desired_matrix
);
16029 /* Otherwise set up data on this window; select its buffer and point
16031 /* Really select the buffer, for the sake of buffer-local
16033 set_buffer_internal_1 (XBUFFER (w
->contents
));
16035 current_matrix_up_to_date_p
16036 = (w
->window_end_valid
16037 && !current_buffer
->clip_changed
16038 && !current_buffer
->prevent_redisplay_optimizations_p
16039 && !window_outdated (w
));
16041 /* Run the window-text-change-functions
16042 if it is possible that the text on the screen has changed
16043 (either due to modification of the text, or any other reason). */
16044 if (!current_matrix_up_to_date_p
16045 && !NILP (Vwindow_text_change_functions
))
16047 safe_run_hooks (Qwindow_text_change_functions
);
16051 beg_unchanged
= BEG_UNCHANGED
;
16052 end_unchanged
= END_UNCHANGED
;
16054 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16056 specbind (Qinhibit_point_motion_hooks
, Qt
);
16059 = (w
->window_end_valid
16060 && !current_buffer
->clip_changed
16061 && !window_outdated (w
));
16063 /* When windows_or_buffers_changed is non-zero, we can't rely
16064 on the window end being valid, so set it to zero there. */
16065 if (windows_or_buffers_changed
)
16067 /* If window starts on a continuation line, maybe adjust the
16068 window start in case the window's width changed. */
16069 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16070 compute_window_start_on_continuation_line (w
);
16072 w
->window_end_valid
= false;
16073 /* If so, we also can't rely on current matrix
16074 and should not fool try_cursor_movement below. */
16075 current_matrix_up_to_date_p
= false;
16078 /* Some sanity checks. */
16079 CHECK_WINDOW_END (w
);
16080 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16082 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16085 if (mode_line_update_needed (w
))
16086 update_mode_line
= 1;
16088 /* Point refers normally to the selected window. For any other
16089 window, set up appropriate value. */
16090 if (!EQ (window
, selected_window
))
16092 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16093 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16098 new_pt_byte
= BEGV_BYTE
;
16099 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16101 else if (new_pt
> (ZV
- 1))
16104 new_pt_byte
= ZV_BYTE
;
16105 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16108 /* We don't use SET_PT so that the point-motion hooks don't run. */
16109 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16112 /* If any of the character widths specified in the display table
16113 have changed, invalidate the width run cache. It's true that
16114 this may be a bit late to catch such changes, but the rest of
16115 redisplay goes (non-fatally) haywire when the display table is
16116 changed, so why should we worry about doing any better? */
16117 if (current_buffer
->width_run_cache
16118 || (current_buffer
->base_buffer
16119 && current_buffer
->base_buffer
->width_run_cache
))
16121 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16123 if (! disptab_matches_widthtab
16124 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16126 struct buffer
*buf
= current_buffer
;
16128 if (buf
->base_buffer
)
16129 buf
= buf
->base_buffer
;
16130 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16131 recompute_width_table (current_buffer
, disptab
);
16135 /* If window-start is screwed up, choose a new one. */
16136 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16139 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16141 /* If someone specified a new starting point but did not insist,
16142 check whether it can be used. */
16143 if ((w
->optional_new_start
|| window_frozen_p (w
))
16144 && CHARPOS (startp
) >= BEGV
16145 && CHARPOS (startp
) <= ZV
)
16147 ptrdiff_t it_charpos
;
16149 w
->optional_new_start
= 0;
16150 start_display (&it
, w
, startp
);
16151 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16152 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16153 /* Record IT's position now, since line_bottom_y might change
16155 it_charpos
= IT_CHARPOS (it
);
16156 /* Make sure we set the force_start flag only if the cursor row
16157 will be fully visible. Otherwise, the code under force_start
16158 label below will try to move point back into view, which is
16159 not what the code which sets optional_new_start wants. */
16160 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16161 && !w
->force_start
)
16163 if (it_charpos
== PT
)
16164 w
->force_start
= 1;
16165 /* IT may overshoot PT if text at PT is invisible. */
16166 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16167 w
->force_start
= 1;
16169 if (w
->force_start
)
16171 if (window_frozen_p (w
))
16172 debug_method_add (w
, "set force_start from frozen window start");
16174 debug_method_add (w
, "set force_start from optional_new_start");
16182 /* Handle case where place to start displaying has been specified,
16183 unless the specified location is outside the accessible range. */
16184 if (w
->force_start
)
16186 /* We set this later on if we have to adjust point. */
16189 w
->force_start
= 0;
16191 w
->window_end_valid
= 0;
16193 /* Forget any recorded base line for line number display. */
16194 if (!buffer_unchanged_p
)
16195 w
->base_line_number
= 0;
16197 /* Redisplay the mode line. Select the buffer properly for that.
16198 Also, run the hook window-scroll-functions
16199 because we have scrolled. */
16200 /* Note, we do this after clearing force_start because
16201 if there's an error, it is better to forget about force_start
16202 than to get into an infinite loop calling the hook functions
16203 and having them get more errors. */
16204 if (!update_mode_line
16205 || ! NILP (Vwindow_scroll_functions
))
16207 update_mode_line
= 1;
16208 w
->update_mode_line
= 1;
16209 startp
= run_window_scroll_functions (window
, startp
);
16212 if (CHARPOS (startp
) < BEGV
)
16213 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16214 else if (CHARPOS (startp
) > ZV
)
16215 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16217 /* Redisplay, then check if cursor has been set during the
16218 redisplay. Give up if new fonts were loaded. */
16219 /* We used to issue a CHECK_MARGINS argument to try_window here,
16220 but this causes scrolling to fail when point begins inside
16221 the scroll margin (bug#148) -- cyd */
16222 if (!try_window (window
, startp
, 0))
16224 w
->force_start
= 1;
16225 clear_glyph_matrix (w
->desired_matrix
);
16226 goto need_larger_matrices
;
16229 if (w
->cursor
.vpos
< 0)
16231 /* If point does not appear, try to move point so it does
16232 appear. The desired matrix has been built above, so we
16233 can use it here. */
16234 new_vpos
= window_box_height (w
) / 2;
16237 if (!cursor_row_fully_visible_p (w
, 0, 0))
16239 /* Point does appear, but on a line partly visible at end of window.
16240 Move it back to a fully-visible line. */
16241 new_vpos
= window_box_height (w
);
16242 /* But if window_box_height suggests a Y coordinate that is
16243 not less than we already have, that line will clearly not
16244 be fully visible, so give up and scroll the display.
16245 This can happen when the default face uses a font whose
16246 dimensions are different from the frame's default
16248 if (new_vpos
>= w
->cursor
.y
)
16250 w
->cursor
.vpos
= -1;
16251 clear_glyph_matrix (w
->desired_matrix
);
16252 goto try_to_scroll
;
16255 else if (w
->cursor
.vpos
>= 0)
16257 /* Some people insist on not letting point enter the scroll
16258 margin, even though this part handles windows that didn't
16260 int window_total_lines
16261 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16262 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16263 int pixel_margin
= margin
* frame_line_height
;
16264 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16266 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16267 below, which finds the row to move point to, advances by
16268 the Y coordinate of the _next_ row, see the definition of
16269 MATRIX_ROW_BOTTOM_Y. */
16270 if (w
->cursor
.vpos
< margin
+ header_line
)
16272 w
->cursor
.vpos
= -1;
16273 clear_glyph_matrix (w
->desired_matrix
);
16274 goto try_to_scroll
;
16278 int window_height
= window_box_height (w
);
16281 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16282 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16284 w
->cursor
.vpos
= -1;
16285 clear_glyph_matrix (w
->desired_matrix
);
16286 goto try_to_scroll
;
16291 /* If we need to move point for either of the above reasons,
16292 now actually do it. */
16295 struct glyph_row
*row
;
16297 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16298 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16301 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16302 MATRIX_ROW_START_BYTEPOS (row
));
16304 if (w
!= XWINDOW (selected_window
))
16305 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16306 else if (current_buffer
== old
)
16307 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16309 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16311 /* Re-run pre-redisplay-function so it can update the region
16312 according to the new position of point. */
16313 /* Other than the cursor, w's redisplay is done so we can set its
16314 redisplay to false. Also the buffer's redisplay can be set to
16315 false, since propagate_buffer_redisplay should have already
16316 propagated its info to `w' anyway. */
16317 w
->redisplay
= false;
16318 XBUFFER (w
->contents
)->text
->redisplay
= false;
16319 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16321 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16323 /* pre-redisplay-function made changes (e.g. move the region)
16324 that require another round of redisplay. */
16325 clear_glyph_matrix (w
->desired_matrix
);
16326 if (!try_window (window
, startp
, 0))
16327 goto need_larger_matrices
;
16330 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, 0, 0))
16332 clear_glyph_matrix (w
->desired_matrix
);
16333 goto try_to_scroll
;
16337 debug_method_add (w
, "forced window start");
16342 /* Handle case where text has not changed, only point, and it has
16343 not moved off the frame, and we are not retrying after hscroll.
16344 (current_matrix_up_to_date_p is nonzero when retrying.) */
16345 if (current_matrix_up_to_date_p
16346 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16347 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16351 case CURSOR_MOVEMENT_SUCCESS
:
16352 used_current_matrix_p
= 1;
16355 case CURSOR_MOVEMENT_MUST_SCROLL
:
16356 goto try_to_scroll
;
16362 /* If current starting point was originally the beginning of a line
16363 but no longer is, find a new starting point. */
16364 else if (w
->start_at_line_beg
16365 && !(CHARPOS (startp
) <= BEGV
16366 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16369 debug_method_add (w
, "recenter 1");
16374 /* Try scrolling with try_window_id. Value is > 0 if update has
16375 been done, it is -1 if we know that the same window start will
16376 not work. It is 0 if unsuccessful for some other reason. */
16377 else if ((tem
= try_window_id (w
)) != 0)
16380 debug_method_add (w
, "try_window_id %d", tem
);
16383 if (f
->fonts_changed
)
16384 goto need_larger_matrices
;
16388 /* Otherwise try_window_id has returned -1 which means that we
16389 don't want the alternative below this comment to execute. */
16391 else if (CHARPOS (startp
) >= BEGV
16392 && CHARPOS (startp
) <= ZV
16393 && PT
>= CHARPOS (startp
)
16394 && (CHARPOS (startp
) < ZV
16395 /* Avoid starting at end of buffer. */
16396 || CHARPOS (startp
) == BEGV
16397 || !window_outdated (w
)))
16399 int d1
, d2
, d5
, d6
;
16402 /* If first window line is a continuation line, and window start
16403 is inside the modified region, but the first change is before
16404 current window start, we must select a new window start.
16406 However, if this is the result of a down-mouse event (e.g. by
16407 extending the mouse-drag-overlay), we don't want to select a
16408 new window start, since that would change the position under
16409 the mouse, resulting in an unwanted mouse-movement rather
16410 than a simple mouse-click. */
16411 if (!w
->start_at_line_beg
16412 && NILP (do_mouse_tracking
)
16413 && CHARPOS (startp
) > BEGV
16414 && CHARPOS (startp
) > BEG
+ beg_unchanged
16415 && CHARPOS (startp
) <= Z
- end_unchanged
16416 /* Even if w->start_at_line_beg is nil, a new window may
16417 start at a line_beg, since that's how set_buffer_window
16418 sets it. So, we need to check the return value of
16419 compute_window_start_on_continuation_line. (See also
16421 && XMARKER (w
->start
)->buffer
== current_buffer
16422 && compute_window_start_on_continuation_line (w
)
16423 /* It doesn't make sense to force the window start like we
16424 do at label force_start if it is already known that point
16425 will not be fully visible in the resulting window, because
16426 doing so will move point from its correct position
16427 instead of scrolling the window to bring point into view.
16429 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16430 /* A very tall row could need more than the window height,
16431 in which case we accept that it is partially visible. */
16432 && (rtop
!= 0) == (rbot
!= 0))
16434 w
->force_start
= 1;
16435 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16437 debug_method_add (w
, "recomputed window start in continuation line");
16443 debug_method_add (w
, "same window start");
16446 /* Try to redisplay starting at same place as before.
16447 If point has not moved off frame, accept the results. */
16448 if (!current_matrix_up_to_date_p
16449 /* Don't use try_window_reusing_current_matrix in this case
16450 because a window scroll function can have changed the
16452 || !NILP (Vwindow_scroll_functions
)
16453 || MINI_WINDOW_P (w
)
16454 || !(used_current_matrix_p
16455 = try_window_reusing_current_matrix (w
)))
16457 IF_DEBUG (debug_method_add (w
, "1"));
16458 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16459 /* -1 means we need to scroll.
16460 0 means we need new matrices, but fonts_changed
16461 is set in that case, so we will detect it below. */
16462 goto try_to_scroll
;
16465 if (f
->fonts_changed
)
16466 goto need_larger_matrices
;
16468 if (w
->cursor
.vpos
>= 0)
16470 if (!just_this_one_p
16471 || current_buffer
->clip_changed
16472 || BEG_UNCHANGED
< CHARPOS (startp
))
16473 /* Forget any recorded base line for line number display. */
16474 w
->base_line_number
= 0;
16476 if (!cursor_row_fully_visible_p (w
, 1, 0))
16478 clear_glyph_matrix (w
->desired_matrix
);
16479 last_line_misfit
= 1;
16481 /* Drop through and scroll. */
16486 clear_glyph_matrix (w
->desired_matrix
);
16491 /* Redisplay the mode line. Select the buffer properly for that. */
16492 if (!update_mode_line
)
16494 update_mode_line
= 1;
16495 w
->update_mode_line
= 1;
16498 /* Try to scroll by specified few lines. */
16499 if ((scroll_conservatively
16500 || emacs_scroll_step
16501 || temp_scroll_step
16502 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16503 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16504 && CHARPOS (startp
) >= BEGV
16505 && CHARPOS (startp
) <= ZV
)
16507 /* The function returns -1 if new fonts were loaded, 1 if
16508 successful, 0 if not successful. */
16509 int ss
= try_scrolling (window
, just_this_one_p
,
16510 scroll_conservatively
,
16512 temp_scroll_step
, last_line_misfit
);
16515 case SCROLLING_SUCCESS
:
16518 case SCROLLING_NEED_LARGER_MATRICES
:
16519 goto need_larger_matrices
;
16521 case SCROLLING_FAILED
:
16529 /* Finally, just choose a place to start which positions point
16530 according to user preferences. */
16535 debug_method_add (w
, "recenter");
16538 /* Forget any previously recorded base line for line number display. */
16539 if (!buffer_unchanged_p
)
16540 w
->base_line_number
= 0;
16542 /* Determine the window start relative to point. */
16543 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16544 it
.current_y
= it
.last_visible_y
;
16545 if (centering_position
< 0)
16547 int window_total_lines
16548 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16550 = scroll_margin
> 0
16551 ? min (scroll_margin
, window_total_lines
/ 4)
16553 ptrdiff_t margin_pos
= CHARPOS (startp
);
16554 Lisp_Object aggressive
;
16557 /* If there is a scroll margin at the top of the window, find
16558 its character position. */
16560 /* Cannot call start_display if startp is not in the
16561 accessible region of the buffer. This can happen when we
16562 have just switched to a different buffer and/or changed
16563 its restriction. In that case, startp is initialized to
16564 the character position 1 (BEGV) because we did not yet
16565 have chance to display the buffer even once. */
16566 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16569 void *it1data
= NULL
;
16571 SAVE_IT (it1
, it
, it1data
);
16572 start_display (&it1
, w
, startp
);
16573 move_it_vertically (&it1
, margin
* frame_line_height
);
16574 margin_pos
= IT_CHARPOS (it1
);
16575 RESTORE_IT (&it
, &it
, it1data
);
16577 scrolling_up
= PT
> margin_pos
;
16580 ? BVAR (current_buffer
, scroll_up_aggressively
)
16581 : BVAR (current_buffer
, scroll_down_aggressively
);
16583 if (!MINI_WINDOW_P (w
)
16584 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16588 /* Setting scroll-conservatively overrides
16589 scroll-*-aggressively. */
16590 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16592 double float_amount
= XFLOATINT (aggressive
);
16594 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16595 if (pt_offset
== 0 && float_amount
> 0)
16597 if (pt_offset
&& margin
> 0)
16600 /* Compute how much to move the window start backward from
16601 point so that point will be displayed where the user
16605 centering_position
= it
.last_visible_y
;
16607 centering_position
-= pt_offset
;
16608 centering_position
-=
16609 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16610 + WINDOW_HEADER_LINE_HEIGHT (w
);
16611 /* Don't let point enter the scroll margin near top of
16613 if (centering_position
< margin
* frame_line_height
)
16614 centering_position
= margin
* frame_line_height
;
16617 centering_position
= margin
* frame_line_height
+ pt_offset
;
16620 /* Set the window start half the height of the window backward
16622 centering_position
= window_box_height (w
) / 2;
16624 move_it_vertically_backward (&it
, centering_position
);
16626 eassert (IT_CHARPOS (it
) >= BEGV
);
16628 /* The function move_it_vertically_backward may move over more
16629 than the specified y-distance. If it->w is small, e.g. a
16630 mini-buffer window, we may end up in front of the window's
16631 display area. Start displaying at the start of the line
16632 containing PT in this case. */
16633 if (it
.current_y
<= 0)
16635 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16636 move_it_vertically_backward (&it
, 0);
16640 it
.current_x
= it
.hpos
= 0;
16642 /* Set the window start position here explicitly, to avoid an
16643 infinite loop in case the functions in window-scroll-functions
16645 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16647 /* Run scroll hooks. */
16648 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16650 /* Redisplay the window. */
16651 if (!current_matrix_up_to_date_p
16652 || windows_or_buffers_changed
16653 || f
->cursor_type_changed
16654 /* Don't use try_window_reusing_current_matrix in this case
16655 because it can have changed the buffer. */
16656 || !NILP (Vwindow_scroll_functions
)
16657 || !just_this_one_p
16658 || MINI_WINDOW_P (w
)
16659 || !(used_current_matrix_p
16660 = try_window_reusing_current_matrix (w
)))
16661 try_window (window
, startp
, 0);
16663 /* If new fonts have been loaded (due to fontsets), give up. We
16664 have to start a new redisplay since we need to re-adjust glyph
16666 if (f
->fonts_changed
)
16667 goto need_larger_matrices
;
16669 /* If cursor did not appear assume that the middle of the window is
16670 in the first line of the window. Do it again with the next line.
16671 (Imagine a window of height 100, displaying two lines of height
16672 60. Moving back 50 from it->last_visible_y will end in the first
16674 if (w
->cursor
.vpos
< 0)
16676 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16678 clear_glyph_matrix (w
->desired_matrix
);
16679 move_it_by_lines (&it
, 1);
16680 try_window (window
, it
.current
.pos
, 0);
16682 else if (PT
< IT_CHARPOS (it
))
16684 clear_glyph_matrix (w
->desired_matrix
);
16685 move_it_by_lines (&it
, -1);
16686 try_window (window
, it
.current
.pos
, 0);
16690 /* Not much we can do about it. */
16694 /* Consider the following case: Window starts at BEGV, there is
16695 invisible, intangible text at BEGV, so that display starts at
16696 some point START > BEGV. It can happen that we are called with
16697 PT somewhere between BEGV and START. Try to handle that case,
16698 and similar ones. */
16699 if (w
->cursor
.vpos
< 0)
16701 /* First, try locating the proper glyph row for PT. */
16702 struct glyph_row
*row
=
16703 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16705 /* Sometimes point is at the beginning of invisible text that is
16706 before the 1st character displayed in the row. In that case,
16707 row_containing_pos fails to find the row, because no glyphs
16708 with appropriate buffer positions are present in the row.
16709 Therefore, we next try to find the row which shows the 1st
16710 position after the invisible text. */
16714 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16717 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16720 Lisp_Object invis_end
=
16721 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16724 if (NATNUMP (invis_end
))
16725 alt_pos
= XFASTINT (invis_end
);
16728 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16732 /* Finally, fall back on the first row of the window after the
16733 header line (if any). This is slightly better than not
16734 displaying the cursor at all. */
16737 row
= w
->current_matrix
->rows
;
16738 if (row
->mode_line_p
)
16741 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16744 if (!cursor_row_fully_visible_p (w
, 0, 0))
16746 /* If vscroll is enabled, disable it and try again. */
16750 clear_glyph_matrix (w
->desired_matrix
);
16754 /* Users who set scroll-conservatively to a large number want
16755 point just above/below the scroll margin. If we ended up
16756 with point's row partially visible, move the window start to
16757 make that row fully visible and out of the margin. */
16758 if (scroll_conservatively
> SCROLL_LIMIT
)
16760 int window_total_lines
16761 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16764 ? min (scroll_margin
, window_total_lines
/ 4)
16766 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16768 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16769 clear_glyph_matrix (w
->desired_matrix
);
16770 if (1 == try_window (window
, it
.current
.pos
,
16771 TRY_WINDOW_CHECK_MARGINS
))
16775 /* If centering point failed to make the whole line visible,
16776 put point at the top instead. That has to make the whole line
16777 visible, if it can be done. */
16778 if (centering_position
== 0)
16781 clear_glyph_matrix (w
->desired_matrix
);
16782 centering_position
= 0;
16788 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16789 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16790 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16792 /* Display the mode line, if we must. */
16793 if ((update_mode_line
16794 /* If window not full width, must redo its mode line
16795 if (a) the window to its side is being redone and
16796 (b) we do a frame-based redisplay. This is a consequence
16797 of how inverted lines are drawn in frame-based redisplay. */
16798 || (!just_this_one_p
16799 && !FRAME_WINDOW_P (f
)
16800 && !WINDOW_FULL_WIDTH_P (w
))
16801 /* Line number to display. */
16802 || w
->base_line_pos
> 0
16803 /* Column number is displayed and different from the one displayed. */
16804 || (w
->column_number_displayed
!= -1
16805 && (w
->column_number_displayed
!= current_column ())))
16806 /* This means that the window has a mode line. */
16807 && (WINDOW_WANTS_MODELINE_P (w
)
16808 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16811 display_mode_lines (w
);
16813 /* If mode line height has changed, arrange for a thorough
16814 immediate redisplay using the correct mode line height. */
16815 if (WINDOW_WANTS_MODELINE_P (w
)
16816 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16818 f
->fonts_changed
= 1;
16819 w
->mode_line_height
= -1;
16820 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16821 = DESIRED_MODE_LINE_HEIGHT (w
);
16824 /* If header line height has changed, arrange for a thorough
16825 immediate redisplay using the correct header line height. */
16826 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16827 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16829 f
->fonts_changed
= 1;
16830 w
->header_line_height
= -1;
16831 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16832 = DESIRED_HEADER_LINE_HEIGHT (w
);
16835 if (f
->fonts_changed
)
16836 goto need_larger_matrices
;
16839 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16841 w
->base_line_pos
= 0;
16842 w
->base_line_number
= 0;
16847 /* When we reach a frame's selected window, redo the frame's menu bar. */
16848 if (update_mode_line
16849 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16851 int redisplay_menu_p
= 0;
16853 if (FRAME_WINDOW_P (f
))
16855 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16856 || defined (HAVE_NS) || defined (USE_GTK)
16857 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16859 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16863 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16865 if (redisplay_menu_p
)
16866 display_menu_bar (w
);
16868 #ifdef HAVE_WINDOW_SYSTEM
16869 if (FRAME_WINDOW_P (f
))
16871 #if defined (USE_GTK) || defined (HAVE_NS)
16872 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16873 redisplay_tool_bar (f
);
16875 if (WINDOWP (f
->tool_bar_window
)
16876 && (FRAME_TOOL_BAR_LINES (f
) > 0
16877 || !NILP (Vauto_resize_tool_bars
))
16878 && redisplay_tool_bar (f
))
16879 ignore_mouse_drag_p
= 1;
16885 #ifdef HAVE_WINDOW_SYSTEM
16886 if (FRAME_WINDOW_P (f
)
16887 && update_window_fringes (w
, (just_this_one_p
16888 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16889 || w
->pseudo_window_p
)))
16893 if (draw_window_fringes (w
, 1))
16895 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16896 x_draw_right_divider (w
);
16898 x_draw_vertical_border (w
);
16904 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16905 x_draw_bottom_divider (w
);
16906 #endif /* HAVE_WINDOW_SYSTEM */
16908 /* We go to this label, with fonts_changed set, if it is
16909 necessary to try again using larger glyph matrices.
16910 We have to redeem the scroll bar even in this case,
16911 because the loop in redisplay_internal expects that. */
16912 need_larger_matrices
:
16914 finish_scroll_bars
:
16916 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16918 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16919 /* Set the thumb's position and size. */
16920 set_vertical_scroll_bar (w
);
16922 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16923 /* Set the thumb's position and size. */
16924 set_horizontal_scroll_bar (w
);
16926 /* Note that we actually used the scroll bar attached to this
16927 window, so it shouldn't be deleted at the end of redisplay. */
16928 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16929 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16932 /* Restore current_buffer and value of point in it. The window
16933 update may have changed the buffer, so first make sure `opoint'
16934 is still valid (Bug#6177). */
16935 if (CHARPOS (opoint
) < BEGV
)
16936 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16937 else if (CHARPOS (opoint
) > ZV
)
16938 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16940 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16942 set_buffer_internal_1 (old
);
16943 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16944 shorter. This can be caused by log truncation in *Messages*. */
16945 if (CHARPOS (lpoint
) <= ZV
)
16946 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16948 unbind_to (count
, Qnil
);
16952 /* Build the complete desired matrix of WINDOW with a window start
16953 buffer position POS.
16955 Value is 1 if successful. It is zero if fonts were loaded during
16956 redisplay which makes re-adjusting glyph matrices necessary, and -1
16957 if point would appear in the scroll margins.
16958 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16959 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16963 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16965 struct window
*w
= XWINDOW (window
);
16967 struct glyph_row
*last_text_row
= NULL
;
16968 struct frame
*f
= XFRAME (w
->frame
);
16969 int frame_line_height
= default_line_pixel_height (w
);
16971 /* Make POS the new window start. */
16972 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16974 /* Mark cursor position as unknown. No overlay arrow seen. */
16975 w
->cursor
.vpos
= -1;
16976 overlay_arrow_seen
= 0;
16978 /* Initialize iterator and info to start at POS. */
16979 start_display (&it
, w
, pos
);
16980 it
.glyph_row
->reversed_p
= false;
16982 /* Display all lines of W. */
16983 while (it
.current_y
< it
.last_visible_y
)
16985 if (display_line (&it
))
16986 last_text_row
= it
.glyph_row
- 1;
16987 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16991 /* Don't let the cursor end in the scroll margins. */
16992 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16993 && !MINI_WINDOW_P (w
))
16995 int this_scroll_margin
;
16996 int window_total_lines
16997 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16999 if (scroll_margin
> 0)
17001 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17002 this_scroll_margin
*= frame_line_height
;
17005 this_scroll_margin
= 0;
17007 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17008 && w
->cursor
.y
< this_scroll_margin
17009 && CHARPOS (pos
) > BEGV
17010 && IT_CHARPOS (it
) < ZV
)
17011 /* rms: considering make_cursor_line_fully_visible_p here
17012 seems to give wrong results. We don't want to recenter
17013 when the last line is partly visible, we want to allow
17014 that case to be handled in the usual way. */
17015 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17017 w
->cursor
.vpos
= -1;
17018 clear_glyph_matrix (w
->desired_matrix
);
17023 /* If bottom moved off end of frame, change mode line percentage. */
17024 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17025 w
->update_mode_line
= 1;
17027 /* Set window_end_pos to the offset of the last character displayed
17028 on the window from the end of current_buffer. Set
17029 window_end_vpos to its row number. */
17032 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17033 adjust_window_ends (w
, last_text_row
, 0);
17035 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17036 w
->window_end_vpos
)));
17040 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17041 w
->window_end_pos
= Z
- ZV
;
17042 w
->window_end_vpos
= 0;
17045 /* But that is not valid info until redisplay finishes. */
17046 w
->window_end_valid
= 0;
17052 /************************************************************************
17053 Window redisplay reusing current matrix when buffer has not changed
17054 ************************************************************************/
17056 /* Try redisplay of window W showing an unchanged buffer with a
17057 different window start than the last time it was displayed by
17058 reusing its current matrix. Value is non-zero if successful.
17059 W->start is the new window start. */
17062 try_window_reusing_current_matrix (struct window
*w
)
17064 struct frame
*f
= XFRAME (w
->frame
);
17065 struct glyph_row
*bottom_row
;
17068 struct text_pos start
, new_start
;
17069 int nrows_scrolled
, i
;
17070 struct glyph_row
*last_text_row
;
17071 struct glyph_row
*last_reused_text_row
;
17072 struct glyph_row
*start_row
;
17073 int start_vpos
, min_y
, max_y
;
17076 if (inhibit_try_window_reusing
)
17080 #ifdef HAVE_XWIDGETS_xxx
17081 //currently this is needed to detect xwidget movement reliably. or probably not.
17082 printf("try_window_reusing_current_matrix\n");
17087 if (/* This function doesn't handle terminal frames. */
17088 !FRAME_WINDOW_P (f
)
17089 /* Don't try to reuse the display if windows have been split
17091 || windows_or_buffers_changed
17092 || f
->cursor_type_changed
)
17095 /* Can't do this if showing trailing whitespace. */
17096 if (!NILP (Vshow_trailing_whitespace
))
17099 /* If top-line visibility has changed, give up. */
17100 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17101 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17104 /* Give up if old or new display is scrolled vertically. We could
17105 make this function handle this, but right now it doesn't. */
17106 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17107 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17110 /* The variable new_start now holds the new window start. The old
17111 start `start' can be determined from the current matrix. */
17112 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17113 start
= start_row
->minpos
;
17114 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17116 /* Clear the desired matrix for the display below. */
17117 clear_glyph_matrix (w
->desired_matrix
);
17119 if (CHARPOS (new_start
) <= CHARPOS (start
))
17121 /* Don't use this method if the display starts with an ellipsis
17122 displayed for invisible text. It's not easy to handle that case
17123 below, and it's certainly not worth the effort since this is
17124 not a frequent case. */
17125 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17128 IF_DEBUG (debug_method_add (w
, "twu1"));
17130 /* Display up to a row that can be reused. The variable
17131 last_text_row is set to the last row displayed that displays
17132 text. Note that it.vpos == 0 if or if not there is a
17133 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17134 start_display (&it
, w
, new_start
);
17135 w
->cursor
.vpos
= -1;
17136 last_text_row
= last_reused_text_row
= NULL
;
17138 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17140 /* If we have reached into the characters in the START row,
17141 that means the line boundaries have changed. So we
17142 can't start copying with the row START. Maybe it will
17143 work to start copying with the following row. */
17144 while (IT_CHARPOS (it
) > CHARPOS (start
))
17146 /* Advance to the next row as the "start". */
17148 start
= start_row
->minpos
;
17149 /* If there are no more rows to try, or just one, give up. */
17150 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17151 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17152 || CHARPOS (start
) == ZV
)
17154 clear_glyph_matrix (w
->desired_matrix
);
17158 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17160 /* If we have reached alignment, we can copy the rest of the
17162 if (IT_CHARPOS (it
) == CHARPOS (start
)
17163 /* Don't accept "alignment" inside a display vector,
17164 since start_row could have started in the middle of
17165 that same display vector (thus their character
17166 positions match), and we have no way of telling if
17167 that is the case. */
17168 && it
.current
.dpvec_index
< 0)
17171 it
.glyph_row
->reversed_p
= false;
17172 if (display_line (&it
))
17173 last_text_row
= it
.glyph_row
- 1;
17177 /* A value of current_y < last_visible_y means that we stopped
17178 at the previous window start, which in turn means that we
17179 have at least one reusable row. */
17180 if (it
.current_y
< it
.last_visible_y
)
17182 struct glyph_row
*row
;
17184 /* IT.vpos always starts from 0; it counts text lines. */
17185 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17187 /* Find PT if not already found in the lines displayed. */
17188 if (w
->cursor
.vpos
< 0)
17190 int dy
= it
.current_y
- start_row
->y
;
17192 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17193 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17195 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17196 dy
, nrows_scrolled
);
17199 clear_glyph_matrix (w
->desired_matrix
);
17204 /* Scroll the display. Do it before the current matrix is
17205 changed. The problem here is that update has not yet
17206 run, i.e. part of the current matrix is not up to date.
17207 scroll_run_hook will clear the cursor, and use the
17208 current matrix to get the height of the row the cursor is
17210 run
.current_y
= start_row
->y
;
17211 run
.desired_y
= it
.current_y
;
17212 run
.height
= it
.last_visible_y
- it
.current_y
;
17214 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17217 FRAME_RIF (f
)->update_window_begin_hook (w
);
17218 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17219 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17220 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17224 /* Shift current matrix down by nrows_scrolled lines. */
17225 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17226 rotate_matrix (w
->current_matrix
,
17228 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17231 /* Disable lines that must be updated. */
17232 for (i
= 0; i
< nrows_scrolled
; ++i
)
17233 (start_row
+ i
)->enabled_p
= false;
17235 /* Re-compute Y positions. */
17236 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17237 max_y
= it
.last_visible_y
;
17238 for (row
= start_row
+ nrows_scrolled
;
17242 row
->y
= it
.current_y
;
17243 row
->visible_height
= row
->height
;
17245 if (row
->y
< min_y
)
17246 row
->visible_height
-= min_y
- row
->y
;
17247 if (row
->y
+ row
->height
> max_y
)
17248 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17249 if (row
->fringe_bitmap_periodic_p
)
17250 row
->redraw_fringe_bitmaps_p
= 1;
17252 it
.current_y
+= row
->height
;
17254 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17255 last_reused_text_row
= row
;
17256 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17260 /* Disable lines in the current matrix which are now
17261 below the window. */
17262 for (++row
; row
< bottom_row
; ++row
)
17263 row
->enabled_p
= row
->mode_line_p
= 0;
17266 /* Update window_end_pos etc.; last_reused_text_row is the last
17267 reused row from the current matrix containing text, if any.
17268 The value of last_text_row is the last displayed line
17269 containing text. */
17270 if (last_reused_text_row
)
17271 adjust_window_ends (w
, last_reused_text_row
, 1);
17272 else if (last_text_row
)
17273 adjust_window_ends (w
, last_text_row
, 0);
17276 /* This window must be completely empty. */
17277 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17278 w
->window_end_pos
= Z
- ZV
;
17279 w
->window_end_vpos
= 0;
17281 w
->window_end_valid
= 0;
17283 /* Update hint: don't try scrolling again in update_window. */
17284 w
->desired_matrix
->no_scrolling_p
= 1;
17287 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17291 else if (CHARPOS (new_start
) > CHARPOS (start
))
17293 struct glyph_row
*pt_row
, *row
;
17294 struct glyph_row
*first_reusable_row
;
17295 struct glyph_row
*first_row_to_display
;
17297 int yb
= window_text_bottom_y (w
);
17299 /* Find the row starting at new_start, if there is one. Don't
17300 reuse a partially visible line at the end. */
17301 first_reusable_row
= start_row
;
17302 while (first_reusable_row
->enabled_p
17303 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17304 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17305 < CHARPOS (new_start
)))
17306 ++first_reusable_row
;
17308 /* Give up if there is no row to reuse. */
17309 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17310 || !first_reusable_row
->enabled_p
17311 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17312 != CHARPOS (new_start
)))
17315 /* We can reuse fully visible rows beginning with
17316 first_reusable_row to the end of the window. Set
17317 first_row_to_display to the first row that cannot be reused.
17318 Set pt_row to the row containing point, if there is any. */
17320 for (first_row_to_display
= first_reusable_row
;
17321 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17322 ++first_row_to_display
)
17324 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17325 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17326 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17327 && first_row_to_display
->ends_at_zv_p
17328 && pt_row
== NULL
)))
17329 pt_row
= first_row_to_display
;
17332 /* Start displaying at the start of first_row_to_display. */
17333 eassert (first_row_to_display
->y
< yb
);
17334 init_to_row_start (&it
, w
, first_row_to_display
);
17336 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17338 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17340 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17341 + WINDOW_HEADER_LINE_HEIGHT (w
));
17343 /* Display lines beginning with first_row_to_display in the
17344 desired matrix. Set last_text_row to the last row displayed
17345 that displays text. */
17346 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17347 if (pt_row
== NULL
)
17348 w
->cursor
.vpos
= -1;
17349 last_text_row
= NULL
;
17350 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17351 if (display_line (&it
))
17352 last_text_row
= it
.glyph_row
- 1;
17354 /* If point is in a reused row, adjust y and vpos of the cursor
17358 w
->cursor
.vpos
-= nrows_scrolled
;
17359 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17362 /* Give up if point isn't in a row displayed or reused. (This
17363 also handles the case where w->cursor.vpos < nrows_scrolled
17364 after the calls to display_line, which can happen with scroll
17365 margins. See bug#1295.) */
17366 if (w
->cursor
.vpos
< 0)
17368 clear_glyph_matrix (w
->desired_matrix
);
17372 /* Scroll the display. */
17373 run
.current_y
= first_reusable_row
->y
;
17374 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17375 run
.height
= it
.last_visible_y
- run
.current_y
;
17376 dy
= run
.current_y
- run
.desired_y
;
17381 FRAME_RIF (f
)->update_window_begin_hook (w
);
17382 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17383 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17384 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17388 /* Adjust Y positions of reused rows. */
17389 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17390 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17391 max_y
= it
.last_visible_y
;
17392 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17395 row
->visible_height
= row
->height
;
17396 if (row
->y
< min_y
)
17397 row
->visible_height
-= min_y
- row
->y
;
17398 if (row
->y
+ row
->height
> max_y
)
17399 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17400 if (row
->fringe_bitmap_periodic_p
)
17401 row
->redraw_fringe_bitmaps_p
= 1;
17404 /* Scroll the current matrix. */
17405 eassert (nrows_scrolled
> 0);
17406 rotate_matrix (w
->current_matrix
,
17408 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17411 /* Disable rows not reused. */
17412 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17413 row
->enabled_p
= false;
17415 /* Point may have moved to a different line, so we cannot assume that
17416 the previous cursor position is valid; locate the correct row. */
17419 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17421 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17422 && !row
->ends_at_zv_p
;
17426 w
->cursor
.y
= row
->y
;
17428 if (row
< bottom_row
)
17430 /* Can't simply scan the row for point with
17431 bidi-reordered glyph rows. Let set_cursor_from_row
17432 figure out where to put the cursor, and if it fails,
17434 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17436 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17439 clear_glyph_matrix (w
->desired_matrix
);
17445 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17446 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17449 && (!BUFFERP (glyph
->object
)
17450 || glyph
->charpos
< PT
);
17454 w
->cursor
.x
+= glyph
->pixel_width
;
17460 /* Adjust window end. A null value of last_text_row means that
17461 the window end is in reused rows which in turn means that
17462 only its vpos can have changed. */
17464 adjust_window_ends (w
, last_text_row
, 0);
17466 w
->window_end_vpos
-= nrows_scrolled
;
17468 w
->window_end_valid
= 0;
17469 w
->desired_matrix
->no_scrolling_p
= 1;
17472 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17482 /************************************************************************
17483 Window redisplay reusing current matrix when buffer has changed
17484 ************************************************************************/
17486 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17487 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17488 ptrdiff_t *, ptrdiff_t *);
17489 static struct glyph_row
*
17490 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17491 struct glyph_row
*);
17494 /* Return the last row in MATRIX displaying text. If row START is
17495 non-null, start searching with that row. IT gives the dimensions
17496 of the display. Value is null if matrix is empty; otherwise it is
17497 a pointer to the row found. */
17499 static struct glyph_row
*
17500 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17501 struct glyph_row
*start
)
17503 struct glyph_row
*row
, *row_found
;
17505 /* Set row_found to the last row in IT->w's current matrix
17506 displaying text. The loop looks funny but think of partially
17509 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17510 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17512 eassert (row
->enabled_p
);
17514 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17523 /* Return the last row in the current matrix of W that is not affected
17524 by changes at the start of current_buffer that occurred since W's
17525 current matrix was built. Value is null if no such row exists.
17527 BEG_UNCHANGED us the number of characters unchanged at the start of
17528 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17529 first changed character in current_buffer. Characters at positions <
17530 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17531 when the current matrix was built. */
17533 static struct glyph_row
*
17534 find_last_unchanged_at_beg_row (struct window
*w
)
17536 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17537 struct glyph_row
*row
;
17538 struct glyph_row
*row_found
= NULL
;
17539 int yb
= window_text_bottom_y (w
);
17541 /* Find the last row displaying unchanged text. */
17542 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17543 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17544 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17547 if (/* If row ends before first_changed_pos, it is unchanged,
17548 except in some case. */
17549 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17550 /* When row ends in ZV and we write at ZV it is not
17552 && !row
->ends_at_zv_p
17553 /* When first_changed_pos is the end of a continued line,
17554 row is not unchanged because it may be no longer
17556 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17557 && (row
->continued_p
17558 || row
->exact_window_width_line_p
))
17559 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17560 needs to be recomputed, so don't consider this row as
17561 unchanged. This happens when the last line was
17562 bidi-reordered and was killed immediately before this
17563 redisplay cycle. In that case, ROW->end stores the
17564 buffer position of the first visual-order character of
17565 the killed text, which is now beyond ZV. */
17566 && CHARPOS (row
->end
.pos
) <= ZV
)
17569 /* Stop if last visible row. */
17570 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17578 /* Find the first glyph row in the current matrix of W that is not
17579 affected by changes at the end of current_buffer since the
17580 time W's current matrix was built.
17582 Return in *DELTA the number of chars by which buffer positions in
17583 unchanged text at the end of current_buffer must be adjusted.
17585 Return in *DELTA_BYTES the corresponding number of bytes.
17587 Value is null if no such row exists, i.e. all rows are affected by
17590 static struct glyph_row
*
17591 find_first_unchanged_at_end_row (struct window
*w
,
17592 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17594 struct glyph_row
*row
;
17595 struct glyph_row
*row_found
= NULL
;
17597 *delta
= *delta_bytes
= 0;
17599 /* Display must not have been paused, otherwise the current matrix
17600 is not up to date. */
17601 eassert (w
->window_end_valid
);
17603 /* A value of window_end_pos >= END_UNCHANGED means that the window
17604 end is in the range of changed text. If so, there is no
17605 unchanged row at the end of W's current matrix. */
17606 if (w
->window_end_pos
>= END_UNCHANGED
)
17609 /* Set row to the last row in W's current matrix displaying text. */
17610 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17612 /* If matrix is entirely empty, no unchanged row exists. */
17613 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17615 /* The value of row is the last glyph row in the matrix having a
17616 meaningful buffer position in it. The end position of row
17617 corresponds to window_end_pos. This allows us to translate
17618 buffer positions in the current matrix to current buffer
17619 positions for characters not in changed text. */
17621 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17622 ptrdiff_t Z_BYTE_old
=
17623 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17624 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17625 struct glyph_row
*first_text_row
17626 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17628 *delta
= Z
- Z_old
;
17629 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17631 /* Set last_unchanged_pos to the buffer position of the last
17632 character in the buffer that has not been changed. Z is the
17633 index + 1 of the last character in current_buffer, i.e. by
17634 subtracting END_UNCHANGED we get the index of the last
17635 unchanged character, and we have to add BEG to get its buffer
17637 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17638 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17640 /* Search backward from ROW for a row displaying a line that
17641 starts at a minimum position >= last_unchanged_pos_old. */
17642 for (; row
> first_text_row
; --row
)
17644 /* This used to abort, but it can happen.
17645 It is ok to just stop the search instead here. KFS. */
17646 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17649 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17654 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17660 /* Make sure that glyph rows in the current matrix of window W
17661 reference the same glyph memory as corresponding rows in the
17662 frame's frame matrix. This function is called after scrolling W's
17663 current matrix on a terminal frame in try_window_id and
17664 try_window_reusing_current_matrix. */
17667 sync_frame_with_window_matrix_rows (struct window
*w
)
17669 struct frame
*f
= XFRAME (w
->frame
);
17670 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17672 /* Preconditions: W must be a leaf window and full-width. Its frame
17673 must have a frame matrix. */
17674 eassert (BUFFERP (w
->contents
));
17675 eassert (WINDOW_FULL_WIDTH_P (w
));
17676 eassert (!FRAME_WINDOW_P (f
));
17678 /* If W is a full-width window, glyph pointers in W's current matrix
17679 have, by definition, to be the same as glyph pointers in the
17680 corresponding frame matrix. Note that frame matrices have no
17681 marginal areas (see build_frame_matrix). */
17682 window_row
= w
->current_matrix
->rows
;
17683 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17684 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17685 while (window_row
< window_row_end
)
17687 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17688 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17690 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17691 frame_row
->glyphs
[TEXT_AREA
] = start
;
17692 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17693 frame_row
->glyphs
[LAST_AREA
] = end
;
17695 /* Disable frame rows whose corresponding window rows have
17696 been disabled in try_window_id. */
17697 if (!window_row
->enabled_p
)
17698 frame_row
->enabled_p
= false;
17700 ++window_row
, ++frame_row
;
17705 /* Find the glyph row in window W containing CHARPOS. Consider all
17706 rows between START and END (not inclusive). END null means search
17707 all rows to the end of the display area of W. Value is the row
17708 containing CHARPOS or null. */
17711 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17712 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17714 struct glyph_row
*row
= start
;
17715 struct glyph_row
*best_row
= NULL
;
17716 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17719 /* If we happen to start on a header-line, skip that. */
17720 if (row
->mode_line_p
)
17723 if ((end
&& row
>= end
) || !row
->enabled_p
)
17726 last_y
= window_text_bottom_y (w
) - dy
;
17730 /* Give up if we have gone too far. */
17731 if (end
&& row
>= end
)
17733 /* This formerly returned if they were equal.
17734 I think that both quantities are of a "last plus one" type;
17735 if so, when they are equal, the row is within the screen. -- rms. */
17736 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17739 /* If it is in this row, return this row. */
17740 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17741 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17742 /* The end position of a row equals the start
17743 position of the next row. If CHARPOS is there, we
17744 would rather consider it displayed in the next
17745 line, except when this line ends in ZV. */
17746 && !row_for_charpos_p (row
, charpos
)))
17747 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17751 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17752 || (!best_row
&& !row
->continued_p
))
17754 /* In bidi-reordered rows, there could be several rows whose
17755 edges surround CHARPOS, all of these rows belonging to
17756 the same continued line. We need to find the row which
17757 fits CHARPOS the best. */
17758 for (g
= row
->glyphs
[TEXT_AREA
];
17759 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17762 if (!STRINGP (g
->object
))
17764 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17766 mindif
= eabs (g
->charpos
- charpos
);
17768 /* Exact match always wins. */
17775 else if (best_row
&& !row
->continued_p
)
17782 /* Try to redisplay window W by reusing its existing display. W's
17783 current matrix must be up to date when this function is called,
17784 i.e. window_end_valid must be nonzero.
17788 >= 1 if successful, i.e. display has been updated
17790 1 means the changes were in front of a newline that precedes
17791 the window start, and the whole current matrix was reused
17792 2 means the changes were after the last position displayed
17793 in the window, and the whole current matrix was reused
17794 3 means portions of the current matrix were reused, while
17795 some of the screen lines were redrawn
17796 -1 if redisplay with same window start is known not to succeed
17797 0 if otherwise unsuccessful
17799 The following steps are performed:
17801 1. Find the last row in the current matrix of W that is not
17802 affected by changes at the start of current_buffer. If no such row
17805 2. Find the first row in W's current matrix that is not affected by
17806 changes at the end of current_buffer. Maybe there is no such row.
17808 3. Display lines beginning with the row + 1 found in step 1 to the
17809 row found in step 2 or, if step 2 didn't find a row, to the end of
17812 4. If cursor is not known to appear on the window, give up.
17814 5. If display stopped at the row found in step 2, scroll the
17815 display and current matrix as needed.
17817 6. Maybe display some lines at the end of W, if we must. This can
17818 happen under various circumstances, like a partially visible line
17819 becoming fully visible, or because newly displayed lines are displayed
17820 in smaller font sizes.
17822 7. Update W's window end information. */
17825 try_window_id (struct window
*w
)
17827 struct frame
*f
= XFRAME (w
->frame
);
17828 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17829 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17830 struct glyph_row
*last_unchanged_at_beg_row
;
17831 struct glyph_row
*first_unchanged_at_end_row
;
17832 struct glyph_row
*row
;
17833 struct glyph_row
*bottom_row
;
17836 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17838 struct text_pos start_pos
;
17840 int first_unchanged_at_end_vpos
= 0;
17841 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17842 struct text_pos start
;
17843 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17846 if (inhibit_try_window_id
)
17850 /* This is handy for debugging. */
17852 #define GIVE_UP(X) \
17854 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17858 #define GIVE_UP(X) return 0
17861 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17863 /* Don't use this for mini-windows because these can show
17864 messages and mini-buffers, and we don't handle that here. */
17865 if (MINI_WINDOW_P (w
))
17868 /* This flag is used to prevent redisplay optimizations. */
17869 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17872 /* This function's optimizations cannot be used if overlays have
17873 changed in the buffer displayed by the window, so give up if they
17875 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17878 /* Verify that narrowing has not changed.
17879 Also verify that we were not told to prevent redisplay optimizations.
17880 It would be nice to further
17881 reduce the number of cases where this prevents try_window_id. */
17882 if (current_buffer
->clip_changed
17883 || current_buffer
->prevent_redisplay_optimizations_p
)
17886 /* Window must either use window-based redisplay or be full width. */
17887 if (!FRAME_WINDOW_P (f
)
17888 && (!FRAME_LINE_INS_DEL_OK (f
)
17889 || !WINDOW_FULL_WIDTH_P (w
)))
17892 /* Give up if point is known NOT to appear in W. */
17893 if (PT
< CHARPOS (start
))
17896 /* Another way to prevent redisplay optimizations. */
17897 if (w
->last_modified
== 0)
17900 /* Verify that window is not hscrolled. */
17901 if (w
->hscroll
!= 0)
17904 /* Verify that display wasn't paused. */
17905 if (!w
->window_end_valid
)
17908 /* Likewise if highlighting trailing whitespace. */
17909 if (!NILP (Vshow_trailing_whitespace
))
17912 /* Can't use this if overlay arrow position and/or string have
17914 if (overlay_arrows_changed_p ())
17917 /* When word-wrap is on, adding a space to the first word of a
17918 wrapped line can change the wrap position, altering the line
17919 above it. It might be worthwhile to handle this more
17920 intelligently, but for now just redisplay from scratch. */
17921 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17924 /* Under bidi reordering, adding or deleting a character in the
17925 beginning of a paragraph, before the first strong directional
17926 character, can change the base direction of the paragraph (unless
17927 the buffer specifies a fixed paragraph direction), which will
17928 require to redisplay the whole paragraph. It might be worthwhile
17929 to find the paragraph limits and widen the range of redisplayed
17930 lines to that, but for now just give up this optimization and
17931 redisplay from scratch. */
17932 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17933 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17936 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17937 only if buffer has really changed. The reason is that the gap is
17938 initially at Z for freshly visited files. The code below would
17939 set end_unchanged to 0 in that case. */
17940 if (MODIFF
> SAVE_MODIFF
17941 /* This seems to happen sometimes after saving a buffer. */
17942 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17944 if (GPT
- BEG
< BEG_UNCHANGED
)
17945 BEG_UNCHANGED
= GPT
- BEG
;
17946 if (Z
- GPT
< END_UNCHANGED
)
17947 END_UNCHANGED
= Z
- GPT
;
17950 /* The position of the first and last character that has been changed. */
17951 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17952 last_changed_charpos
= Z
- END_UNCHANGED
;
17954 /* If window starts after a line end, and the last change is in
17955 front of that newline, then changes don't affect the display.
17956 This case happens with stealth-fontification. Note that although
17957 the display is unchanged, glyph positions in the matrix have to
17958 be adjusted, of course. */
17959 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17960 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17961 && ((last_changed_charpos
< CHARPOS (start
)
17962 && CHARPOS (start
) == BEGV
)
17963 || (last_changed_charpos
< CHARPOS (start
) - 1
17964 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17966 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17967 struct glyph_row
*r0
;
17969 /* Compute how many chars/bytes have been added to or removed
17970 from the buffer. */
17971 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17972 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17973 Z_delta
= Z
- Z_old
;
17974 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17976 /* Give up if PT is not in the window. Note that it already has
17977 been checked at the start of try_window_id that PT is not in
17978 front of the window start. */
17979 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17982 /* If window start is unchanged, we can reuse the whole matrix
17983 as is, after adjusting glyph positions. No need to compute
17984 the window end again, since its offset from Z hasn't changed. */
17985 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17986 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17987 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17988 /* PT must not be in a partially visible line. */
17989 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17990 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17992 /* Adjust positions in the glyph matrix. */
17993 if (Z_delta
|| Z_delta_bytes
)
17995 struct glyph_row
*r1
17996 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17997 increment_matrix_positions (w
->current_matrix
,
17998 MATRIX_ROW_VPOS (r0
, current_matrix
),
17999 MATRIX_ROW_VPOS (r1
, current_matrix
),
18000 Z_delta
, Z_delta_bytes
);
18003 /* Set the cursor. */
18004 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18006 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18011 /* Handle the case that changes are all below what is displayed in
18012 the window, and that PT is in the window. This shortcut cannot
18013 be taken if ZV is visible in the window, and text has been added
18014 there that is visible in the window. */
18015 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18016 /* ZV is not visible in the window, or there are no
18017 changes at ZV, actually. */
18018 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18019 || first_changed_charpos
== last_changed_charpos
))
18021 struct glyph_row
*r0
;
18023 /* Give up if PT is not in the window. Note that it already has
18024 been checked at the start of try_window_id that PT is not in
18025 front of the window start. */
18026 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18029 /* If window start is unchanged, we can reuse the whole matrix
18030 as is, without changing glyph positions since no text has
18031 been added/removed in front of the window end. */
18032 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18033 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18034 /* PT must not be in a partially visible line. */
18035 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18036 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18038 /* We have to compute the window end anew since text
18039 could have been added/removed after it. */
18040 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18041 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18043 /* Set the cursor. */
18044 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18046 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18051 /* Give up if window start is in the changed area.
18053 The condition used to read
18055 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18057 but why that was tested escapes me at the moment. */
18058 if (CHARPOS (start
) >= first_changed_charpos
18059 && CHARPOS (start
) <= last_changed_charpos
)
18062 /* Check that window start agrees with the start of the first glyph
18063 row in its current matrix. Check this after we know the window
18064 start is not in changed text, otherwise positions would not be
18066 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18067 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18070 /* Give up if the window ends in strings. Overlay strings
18071 at the end are difficult to handle, so don't try. */
18072 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18073 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18076 /* Compute the position at which we have to start displaying new
18077 lines. Some of the lines at the top of the window might be
18078 reusable because they are not displaying changed text. Find the
18079 last row in W's current matrix not affected by changes at the
18080 start of current_buffer. Value is null if changes start in the
18081 first line of window. */
18082 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18083 if (last_unchanged_at_beg_row
)
18085 /* Avoid starting to display in the middle of a character, a TAB
18086 for instance. This is easier than to set up the iterator
18087 exactly, and it's not a frequent case, so the additional
18088 effort wouldn't really pay off. */
18089 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18090 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18091 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18092 --last_unchanged_at_beg_row
;
18094 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18097 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18099 start_pos
= it
.current
.pos
;
18101 /* Start displaying new lines in the desired matrix at the same
18102 vpos we would use in the current matrix, i.e. below
18103 last_unchanged_at_beg_row. */
18104 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18106 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18107 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18109 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18113 /* There are no reusable lines at the start of the window.
18114 Start displaying in the first text line. */
18115 start_display (&it
, w
, start
);
18116 it
.vpos
= it
.first_vpos
;
18117 start_pos
= it
.current
.pos
;
18120 /* Find the first row that is not affected by changes at the end of
18121 the buffer. Value will be null if there is no unchanged row, in
18122 which case we must redisplay to the end of the window. delta
18123 will be set to the value by which buffer positions beginning with
18124 first_unchanged_at_end_row have to be adjusted due to text
18126 first_unchanged_at_end_row
18127 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18128 IF_DEBUG (debug_delta
= delta
);
18129 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18131 /* Set stop_pos to the buffer position up to which we will have to
18132 display new lines. If first_unchanged_at_end_row != NULL, this
18133 is the buffer position of the start of the line displayed in that
18134 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18135 that we don't stop at a buffer position. */
18137 if (first_unchanged_at_end_row
)
18139 eassert (last_unchanged_at_beg_row
== NULL
18140 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18142 /* If this is a continuation line, move forward to the next one
18143 that isn't. Changes in lines above affect this line.
18144 Caution: this may move first_unchanged_at_end_row to a row
18145 not displaying text. */
18146 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18147 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18148 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18149 < it
.last_visible_y
))
18150 ++first_unchanged_at_end_row
;
18152 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18153 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18154 >= it
.last_visible_y
))
18155 first_unchanged_at_end_row
= NULL
;
18158 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18160 first_unchanged_at_end_vpos
18161 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18162 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18165 else if (last_unchanged_at_beg_row
== NULL
)
18171 /* Either there is no unchanged row at the end, or the one we have
18172 now displays text. This is a necessary condition for the window
18173 end pos calculation at the end of this function. */
18174 eassert (first_unchanged_at_end_row
== NULL
18175 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18177 debug_last_unchanged_at_beg_vpos
18178 = (last_unchanged_at_beg_row
18179 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18181 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18183 #endif /* GLYPH_DEBUG */
18186 /* Display new lines. Set last_text_row to the last new line
18187 displayed which has text on it, i.e. might end up as being the
18188 line where the window_end_vpos is. */
18189 w
->cursor
.vpos
= -1;
18190 last_text_row
= NULL
;
18191 overlay_arrow_seen
= 0;
18192 if (it
.current_y
< it
.last_visible_y
18193 && !f
->fonts_changed
18194 && (first_unchanged_at_end_row
== NULL
18195 || IT_CHARPOS (it
) < stop_pos
))
18196 it
.glyph_row
->reversed_p
= false;
18197 while (it
.current_y
< it
.last_visible_y
18198 && !f
->fonts_changed
18199 && (first_unchanged_at_end_row
== NULL
18200 || IT_CHARPOS (it
) < stop_pos
))
18202 if (display_line (&it
))
18203 last_text_row
= it
.glyph_row
- 1;
18206 if (f
->fonts_changed
)
18210 /* Compute differences in buffer positions, y-positions etc. for
18211 lines reused at the bottom of the window. Compute what we can
18213 if (first_unchanged_at_end_row
18214 /* No lines reused because we displayed everything up to the
18215 bottom of the window. */
18216 && it
.current_y
< it
.last_visible_y
)
18219 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18221 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18222 run
.current_y
= first_unchanged_at_end_row
->y
;
18223 run
.desired_y
= run
.current_y
+ dy
;
18224 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18228 delta
= delta_bytes
= dvpos
= dy
18229 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18230 first_unchanged_at_end_row
= NULL
;
18232 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18235 /* Find the cursor if not already found. We have to decide whether
18236 PT will appear on this window (it sometimes doesn't, but this is
18237 not a very frequent case.) This decision has to be made before
18238 the current matrix is altered. A value of cursor.vpos < 0 means
18239 that PT is either in one of the lines beginning at
18240 first_unchanged_at_end_row or below the window. Don't care for
18241 lines that might be displayed later at the window end; as
18242 mentioned, this is not a frequent case. */
18243 if (w
->cursor
.vpos
< 0)
18245 /* Cursor in unchanged rows at the top? */
18246 if (PT
< CHARPOS (start_pos
)
18247 && last_unchanged_at_beg_row
)
18249 row
= row_containing_pos (w
, PT
,
18250 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18251 last_unchanged_at_beg_row
+ 1, 0);
18253 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18256 /* Start from first_unchanged_at_end_row looking for PT. */
18257 else if (first_unchanged_at_end_row
)
18259 row
= row_containing_pos (w
, PT
- delta
,
18260 first_unchanged_at_end_row
, NULL
, 0);
18262 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18263 delta_bytes
, dy
, dvpos
);
18266 /* Give up if cursor was not found. */
18267 if (w
->cursor
.vpos
< 0)
18269 clear_glyph_matrix (w
->desired_matrix
);
18274 /* Don't let the cursor end in the scroll margins. */
18276 int this_scroll_margin
, cursor_height
;
18277 int frame_line_height
= default_line_pixel_height (w
);
18278 int window_total_lines
18279 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18281 this_scroll_margin
=
18282 max (0, min (scroll_margin
, window_total_lines
/ 4));
18283 this_scroll_margin
*= frame_line_height
;
18284 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18286 if ((w
->cursor
.y
< this_scroll_margin
18287 && CHARPOS (start
) > BEGV
)
18288 /* Old redisplay didn't take scroll margin into account at the bottom,
18289 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18290 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18291 ? cursor_height
+ this_scroll_margin
18292 : 1)) > it
.last_visible_y
)
18294 w
->cursor
.vpos
= -1;
18295 clear_glyph_matrix (w
->desired_matrix
);
18300 /* Scroll the display. Do it before changing the current matrix so
18301 that xterm.c doesn't get confused about where the cursor glyph is
18303 if (dy
&& run
.height
)
18307 if (FRAME_WINDOW_P (f
))
18309 FRAME_RIF (f
)->update_window_begin_hook (w
);
18310 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18311 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18312 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18316 /* Terminal frame. In this case, dvpos gives the number of
18317 lines to scroll by; dvpos < 0 means scroll up. */
18319 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18320 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18321 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18322 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18323 + window_internal_height (w
));
18325 #if defined (HAVE_GPM) || defined (MSDOS)
18326 x_clear_window_mouse_face (w
);
18328 /* Perform the operation on the screen. */
18331 /* Scroll last_unchanged_at_beg_row to the end of the
18332 window down dvpos lines. */
18333 set_terminal_window (f
, end
);
18335 /* On dumb terminals delete dvpos lines at the end
18336 before inserting dvpos empty lines. */
18337 if (!FRAME_SCROLL_REGION_OK (f
))
18338 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18340 /* Insert dvpos empty lines in front of
18341 last_unchanged_at_beg_row. */
18342 ins_del_lines (f
, from
, dvpos
);
18344 else if (dvpos
< 0)
18346 /* Scroll up last_unchanged_at_beg_vpos to the end of
18347 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18348 set_terminal_window (f
, end
);
18350 /* Delete dvpos lines in front of
18351 last_unchanged_at_beg_vpos. ins_del_lines will set
18352 the cursor to the given vpos and emit |dvpos| delete
18354 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18356 /* On a dumb terminal insert dvpos empty lines at the
18358 if (!FRAME_SCROLL_REGION_OK (f
))
18359 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18362 set_terminal_window (f
, 0);
18368 /* Shift reused rows of the current matrix to the right position.
18369 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18371 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18372 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18375 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18376 bottom_vpos
, dvpos
);
18377 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18380 else if (dvpos
> 0)
18382 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18383 bottom_vpos
, dvpos
);
18384 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18385 first_unchanged_at_end_vpos
+ dvpos
);
18388 /* For frame-based redisplay, make sure that current frame and window
18389 matrix are in sync with respect to glyph memory. */
18390 if (!FRAME_WINDOW_P (f
))
18391 sync_frame_with_window_matrix_rows (w
);
18393 /* Adjust buffer positions in reused rows. */
18394 if (delta
|| delta_bytes
)
18395 increment_matrix_positions (current_matrix
,
18396 first_unchanged_at_end_vpos
+ dvpos
,
18397 bottom_vpos
, delta
, delta_bytes
);
18399 /* Adjust Y positions. */
18401 shift_glyph_matrix (w
, current_matrix
,
18402 first_unchanged_at_end_vpos
+ dvpos
,
18405 if (first_unchanged_at_end_row
)
18407 first_unchanged_at_end_row
+= dvpos
;
18408 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18409 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18410 first_unchanged_at_end_row
= NULL
;
18413 /* If scrolling up, there may be some lines to display at the end of
18415 last_text_row_at_end
= NULL
;
18418 /* Scrolling up can leave for example a partially visible line
18419 at the end of the window to be redisplayed. */
18420 /* Set last_row to the glyph row in the current matrix where the
18421 window end line is found. It has been moved up or down in
18422 the matrix by dvpos. */
18423 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18424 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18426 /* If last_row is the window end line, it should display text. */
18427 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18429 /* If window end line was partially visible before, begin
18430 displaying at that line. Otherwise begin displaying with the
18431 line following it. */
18432 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18434 init_to_row_start (&it
, w
, last_row
);
18435 it
.vpos
= last_vpos
;
18436 it
.current_y
= last_row
->y
;
18440 init_to_row_end (&it
, w
, last_row
);
18441 it
.vpos
= 1 + last_vpos
;
18442 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18446 /* We may start in a continuation line. If so, we have to
18447 get the right continuation_lines_width and current_x. */
18448 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18449 it
.hpos
= it
.current_x
= 0;
18451 /* Display the rest of the lines at the window end. */
18452 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18453 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18455 /* Is it always sure that the display agrees with lines in
18456 the current matrix? I don't think so, so we mark rows
18457 displayed invalid in the current matrix by setting their
18458 enabled_p flag to zero. */
18459 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18460 if (display_line (&it
))
18461 last_text_row_at_end
= it
.glyph_row
- 1;
18465 /* Update window_end_pos and window_end_vpos. */
18466 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18468 /* Window end line if one of the preserved rows from the current
18469 matrix. Set row to the last row displaying text in current
18470 matrix starting at first_unchanged_at_end_row, after
18472 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18473 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18474 first_unchanged_at_end_row
);
18475 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18476 adjust_window_ends (w
, row
, 1);
18477 eassert (w
->window_end_bytepos
>= 0);
18478 IF_DEBUG (debug_method_add (w
, "A"));
18480 else if (last_text_row_at_end
)
18482 adjust_window_ends (w
, last_text_row_at_end
, 0);
18483 eassert (w
->window_end_bytepos
>= 0);
18484 IF_DEBUG (debug_method_add (w
, "B"));
18486 else if (last_text_row
)
18488 /* We have displayed either to the end of the window or at the
18489 end of the window, i.e. the last row with text is to be found
18490 in the desired matrix. */
18491 adjust_window_ends (w
, last_text_row
, 0);
18492 eassert (w
->window_end_bytepos
>= 0);
18494 else if (first_unchanged_at_end_row
== NULL
18495 && last_text_row
== NULL
18496 && last_text_row_at_end
== NULL
)
18498 /* Displayed to end of window, but no line containing text was
18499 displayed. Lines were deleted at the end of the window. */
18500 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18501 int vpos
= w
->window_end_vpos
;
18502 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18503 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18506 row
== NULL
&& vpos
>= first_vpos
;
18507 --vpos
, --current_row
, --desired_row
)
18509 if (desired_row
->enabled_p
)
18511 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18514 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18518 eassert (row
!= NULL
);
18519 w
->window_end_vpos
= vpos
+ 1;
18520 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18521 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18522 eassert (w
->window_end_bytepos
>= 0);
18523 IF_DEBUG (debug_method_add (w
, "C"));
18528 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18529 debug_end_vpos
= w
->window_end_vpos
));
18531 /* Record that display has not been completed. */
18532 w
->window_end_valid
= 0;
18533 w
->desired_matrix
->no_scrolling_p
= 1;
18541 /***********************************************************************
18542 More debugging support
18543 ***********************************************************************/
18547 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18548 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18549 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18552 /* Dump the contents of glyph matrix MATRIX on stderr.
18554 GLYPHS 0 means don't show glyph contents.
18555 GLYPHS 1 means show glyphs in short form
18556 GLYPHS > 1 means show glyphs in long form. */
18559 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18562 for (i
= 0; i
< matrix
->nrows
; ++i
)
18563 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18567 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18568 the glyph row and area where the glyph comes from. */
18571 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18573 if (glyph
->type
== CHAR_GLYPH
18574 || glyph
->type
== GLYPHLESS_GLYPH
)
18577 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18578 glyph
- row
->glyphs
[TEXT_AREA
],
18579 (glyph
->type
== CHAR_GLYPH
18583 (BUFFERP (glyph
->object
)
18585 : (STRINGP (glyph
->object
)
18587 : (NILP (glyph
->object
)
18590 glyph
->pixel_width
,
18592 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18596 glyph
->left_box_line_p
,
18597 glyph
->right_box_line_p
);
18599 else if (glyph
->type
== STRETCH_GLYPH
)
18602 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18603 glyph
- row
->glyphs
[TEXT_AREA
],
18606 (BUFFERP (glyph
->object
)
18608 : (STRINGP (glyph
->object
)
18610 : (NILP (glyph
->object
)
18613 glyph
->pixel_width
,
18617 glyph
->left_box_line_p
,
18618 glyph
->right_box_line_p
);
18620 else if (glyph
->type
== IMAGE_GLYPH
)
18623 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18624 glyph
- row
->glyphs
[TEXT_AREA
],
18627 (BUFFERP (glyph
->object
)
18629 : (STRINGP (glyph
->object
)
18631 : (NILP (glyph
->object
)
18634 glyph
->pixel_width
,
18638 glyph
->left_box_line_p
,
18639 glyph
->right_box_line_p
);
18641 else if (glyph
->type
== COMPOSITE_GLYPH
)
18644 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18645 glyph
- row
->glyphs
[TEXT_AREA
],
18648 (BUFFERP (glyph
->object
)
18650 : (STRINGP (glyph
->object
)
18652 : (NILP (glyph
->object
)
18655 glyph
->pixel_width
,
18657 if (glyph
->u
.cmp
.automatic
)
18660 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18661 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18663 glyph
->left_box_line_p
,
18664 glyph
->right_box_line_p
);
18666 #ifdef HAVE_XWIDGETS
18667 else if (glyph
->type
== XWIDGET_GLYPH
)
18670 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18671 glyph
- row
->glyphs
[TEXT_AREA
],
18674 (BUFFERP (glyph
->object
)
18676 : (STRINGP (glyph
->object
)
18679 glyph
->pixel_width
,
18683 glyph
->left_box_line_p
,
18684 glyph
->right_box_line_p
);
18686 // printf("dump xwidget glyph\n");
18692 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18693 GLYPHS 0 means don't show glyph contents.
18694 GLYPHS 1 means show glyphs in short form
18695 GLYPHS > 1 means show glyphs in long form. */
18698 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18702 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18703 fprintf (stderr
, "==============================================================================\n");
18705 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18706 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18708 MATRIX_ROW_START_CHARPOS (row
),
18709 MATRIX_ROW_END_CHARPOS (row
),
18710 row
->used
[TEXT_AREA
],
18711 row
->contains_overlapping_glyphs_p
,
18713 row
->truncated_on_left_p
,
18714 row
->truncated_on_right_p
,
18716 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18717 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18720 row
->ends_in_middle_of_char_p
,
18721 row
->starts_in_middle_of_char_p
,
18727 row
->visible_height
,
18730 /* The next 3 lines should align to "Start" in the header. */
18731 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18732 row
->end
.overlay_string_index
,
18733 row
->continuation_lines_width
);
18734 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18735 CHARPOS (row
->start
.string_pos
),
18736 CHARPOS (row
->end
.string_pos
));
18737 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18738 row
->end
.dpvec_index
);
18745 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18747 struct glyph
*glyph
= row
->glyphs
[area
];
18748 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18750 /* Glyph for a line end in text. */
18751 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18754 if (glyph
< glyph_end
)
18755 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18757 for (; glyph
< glyph_end
; ++glyph
)
18758 dump_glyph (row
, glyph
, area
);
18761 else if (glyphs
== 1)
18764 char s
[SHRT_MAX
+ 4];
18766 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18770 for (i
= 0; i
< row
->used
[area
]; ++i
)
18772 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18773 if (i
== row
->used
[area
] - 1
18774 && area
== TEXT_AREA
18775 && NILP (glyph
->object
)
18776 && glyph
->type
== CHAR_GLYPH
18777 && glyph
->u
.ch
== ' ')
18779 strcpy (&s
[i
], "[\\n]");
18782 else if (glyph
->type
== CHAR_GLYPH
18783 && glyph
->u
.ch
< 0x80
18784 && glyph
->u
.ch
>= ' ')
18785 s
[i
] = glyph
->u
.ch
;
18791 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18797 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18798 Sdump_glyph_matrix
, 0, 1, "p",
18799 doc
: /* Dump the current matrix of the selected window to stderr.
18800 Shows contents of glyph row structures. With non-nil
18801 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18802 glyphs in short form, otherwise show glyphs in long form.
18804 Interactively, no argument means show glyphs in short form;
18805 with numeric argument, its value is passed as the GLYPHS flag. */)
18806 (Lisp_Object glyphs
)
18808 struct window
*w
= XWINDOW (selected_window
);
18809 struct buffer
*buffer
= XBUFFER (w
->contents
);
18811 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18812 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18813 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18814 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18815 fprintf (stderr
, "=============================================\n");
18816 dump_glyph_matrix (w
->current_matrix
,
18817 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18822 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18823 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18824 Only text-mode frames have frame glyph matrices. */)
18827 struct frame
*f
= XFRAME (selected_frame
);
18829 if (f
->current_matrix
)
18830 dump_glyph_matrix (f
->current_matrix
, 1);
18832 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18837 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18838 doc
: /* Dump glyph row ROW to stderr.
18839 GLYPH 0 means don't dump glyphs.
18840 GLYPH 1 means dump glyphs in short form.
18841 GLYPH > 1 or omitted means dump glyphs in long form. */)
18842 (Lisp_Object row
, Lisp_Object glyphs
)
18844 struct glyph_matrix
*matrix
;
18847 CHECK_NUMBER (row
);
18848 matrix
= XWINDOW (selected_window
)->current_matrix
;
18850 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18851 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18853 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18858 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18859 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18860 GLYPH 0 means don't dump glyphs.
18861 GLYPH 1 means dump glyphs in short form.
18862 GLYPH > 1 or omitted means dump glyphs in long form.
18864 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18866 (Lisp_Object row
, Lisp_Object glyphs
)
18868 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18869 struct frame
*sf
= SELECTED_FRAME ();
18870 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18873 CHECK_NUMBER (row
);
18875 if (vpos
>= 0 && vpos
< m
->nrows
)
18876 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18877 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18883 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18884 doc
: /* Toggle tracing of redisplay.
18885 With ARG, turn tracing on if and only if ARG is positive. */)
18889 trace_redisplay_p
= !trace_redisplay_p
;
18892 arg
= Fprefix_numeric_value (arg
);
18893 trace_redisplay_p
= XINT (arg
) > 0;
18900 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18901 doc
: /* Like `format', but print result to stderr.
18902 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18903 (ptrdiff_t nargs
, Lisp_Object
*args
)
18905 Lisp_Object s
= Fformat (nargs
, args
);
18906 fprintf (stderr
, "%s", SDATA (s
));
18910 #endif /* GLYPH_DEBUG */
18914 /***********************************************************************
18915 Building Desired Matrix Rows
18916 ***********************************************************************/
18918 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18919 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18921 static struct glyph_row
*
18922 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18924 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18925 struct buffer
*buffer
= XBUFFER (w
->contents
);
18926 struct buffer
*old
= current_buffer
;
18927 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18928 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18929 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18930 const unsigned char *p
;
18933 int n_glyphs_before
;
18935 set_buffer_temp (buffer
);
18936 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18937 scratch_glyph_row
.reversed_p
= false;
18938 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18939 SET_TEXT_POS (it
.position
, 0, 0);
18941 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18943 while (p
< arrow_end
)
18945 Lisp_Object face
, ilisp
;
18947 /* Get the next character. */
18949 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18952 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18953 if (! ASCII_CHAR_P (it
.c
))
18954 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18958 /* Get its face. */
18959 ilisp
= make_number (p
- arrow_string
);
18960 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18961 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18963 /* Compute its width, get its glyphs. */
18964 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18965 SET_TEXT_POS (it
.position
, -1, -1);
18966 PRODUCE_GLYPHS (&it
);
18968 /* If this character doesn't fit any more in the line, we have
18969 to remove some glyphs. */
18970 if (it
.current_x
> it
.last_visible_x
)
18972 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18977 set_buffer_temp (old
);
18978 return it
.glyph_row
;
18982 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18983 glyphs to insert is determined by produce_special_glyphs. */
18986 insert_left_trunc_glyphs (struct it
*it
)
18988 struct it truncate_it
;
18989 struct glyph
*from
, *end
, *to
, *toend
;
18991 eassert (!FRAME_WINDOW_P (it
->f
)
18992 || (!it
->glyph_row
->reversed_p
18993 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18994 || (it
->glyph_row
->reversed_p
18995 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18997 /* Get the truncation glyphs. */
18999 truncate_it
.current_x
= 0;
19000 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19001 truncate_it
.glyph_row
= &scratch_glyph_row
;
19002 truncate_it
.area
= TEXT_AREA
;
19003 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19004 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19005 truncate_it
.object
= Qnil
;
19006 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19008 /* Overwrite glyphs from IT with truncation glyphs. */
19009 if (!it
->glyph_row
->reversed_p
)
19011 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19013 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19014 end
= from
+ tused
;
19015 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19016 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19017 if (FRAME_WINDOW_P (it
->f
))
19019 /* On GUI frames, when variable-size fonts are displayed,
19020 the truncation glyphs may need more pixels than the row's
19021 glyphs they overwrite. We overwrite more glyphs to free
19022 enough screen real estate, and enlarge the stretch glyph
19023 on the right (see display_line), if there is one, to
19024 preserve the screen position of the truncation glyphs on
19027 struct glyph
*g
= to
;
19030 /* The first glyph could be partially visible, in which case
19031 it->glyph_row->x will be negative. But we want the left
19032 truncation glyphs to be aligned at the left margin of the
19033 window, so we override the x coordinate at which the row
19035 it
->glyph_row
->x
= 0;
19036 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19038 w
+= g
->pixel_width
;
19041 if (g
- to
- tused
> 0)
19043 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19044 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19046 used
= it
->glyph_row
->used
[TEXT_AREA
];
19047 if (it
->glyph_row
->truncated_on_right_p
19048 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19049 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19052 int extra
= w
- it
->truncation_pixel_width
;
19054 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19061 /* There may be padding glyphs left over. Overwrite them too. */
19062 if (!FRAME_WINDOW_P (it
->f
))
19064 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19066 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19073 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19077 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19079 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19080 that back to front. */
19081 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19082 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19083 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19084 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19085 if (FRAME_WINDOW_P (it
->f
))
19088 struct glyph
*g
= to
;
19090 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19092 w
+= g
->pixel_width
;
19095 if (to
- g
- tused
> 0)
19097 if (it
->glyph_row
->truncated_on_right_p
19098 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19099 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19101 int extra
= w
- it
->truncation_pixel_width
;
19103 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19107 while (from
>= end
&& to
>= toend
)
19109 if (!FRAME_WINDOW_P (it
->f
))
19111 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19114 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19115 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19116 while (from
>= end
&& to
>= toend
)
19122 /* Need to free some room before prepending additional
19124 int move_by
= from
- end
+ 1;
19125 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19126 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19128 for ( ; g
>= g0
; g
--)
19130 while (from
>= end
)
19132 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19137 /* Compute the hash code for ROW. */
19139 row_hash (struct glyph_row
*row
)
19142 unsigned hashval
= 0;
19144 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19145 for (k
= 0; k
< row
->used
[area
]; ++k
)
19146 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19147 + row
->glyphs
[area
][k
].u
.val
19148 + row
->glyphs
[area
][k
].face_id
19149 + row
->glyphs
[area
][k
].padding_p
19150 + (row
->glyphs
[area
][k
].type
<< 2));
19155 /* Compute the pixel height and width of IT->glyph_row.
19157 Most of the time, ascent and height of a display line will be equal
19158 to the max_ascent and max_height values of the display iterator
19159 structure. This is not the case if
19161 1. We hit ZV without displaying anything. In this case, max_ascent
19162 and max_height will be zero.
19164 2. We have some glyphs that don't contribute to the line height.
19165 (The glyph row flag contributes_to_line_height_p is for future
19166 pixmap extensions).
19168 The first case is easily covered by using default values because in
19169 these cases, the line height does not really matter, except that it
19170 must not be zero. */
19173 compute_line_metrics (struct it
*it
)
19175 struct glyph_row
*row
= it
->glyph_row
;
19177 if (FRAME_WINDOW_P (it
->f
))
19179 int i
, min_y
, max_y
;
19181 /* The line may consist of one space only, that was added to
19182 place the cursor on it. If so, the row's height hasn't been
19184 if (row
->height
== 0)
19186 if (it
->max_ascent
+ it
->max_descent
== 0)
19187 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19188 row
->ascent
= it
->max_ascent
;
19189 row
->height
= it
->max_ascent
+ it
->max_descent
;
19190 row
->phys_ascent
= it
->max_phys_ascent
;
19191 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19192 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19195 /* Compute the width of this line. */
19196 row
->pixel_width
= row
->x
;
19197 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19198 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19200 eassert (row
->pixel_width
>= 0);
19201 eassert (row
->ascent
>= 0 && row
->height
> 0);
19203 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19204 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19206 /* If first line's physical ascent is larger than its logical
19207 ascent, use the physical ascent, and make the row taller.
19208 This makes accented characters fully visible. */
19209 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19210 && row
->phys_ascent
> row
->ascent
)
19212 row
->height
+= row
->phys_ascent
- row
->ascent
;
19213 row
->ascent
= row
->phys_ascent
;
19216 /* Compute how much of the line is visible. */
19217 row
->visible_height
= row
->height
;
19219 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19220 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19222 if (row
->y
< min_y
)
19223 row
->visible_height
-= min_y
- row
->y
;
19224 if (row
->y
+ row
->height
> max_y
)
19225 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19229 row
->pixel_width
= row
->used
[TEXT_AREA
];
19230 if (row
->continued_p
)
19231 row
->pixel_width
-= it
->continuation_pixel_width
;
19232 else if (row
->truncated_on_right_p
)
19233 row
->pixel_width
-= it
->truncation_pixel_width
;
19234 row
->ascent
= row
->phys_ascent
= 0;
19235 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19236 row
->extra_line_spacing
= 0;
19239 /* Compute a hash code for this row. */
19240 row
->hash
= row_hash (row
);
19242 it
->max_ascent
= it
->max_descent
= 0;
19243 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19247 /* Append one space to the glyph row of iterator IT if doing a
19248 window-based redisplay. The space has the same face as
19249 IT->face_id. Value is non-zero if a space was added.
19251 This function is called to make sure that there is always one glyph
19252 at the end of a glyph row that the cursor can be set on under
19253 window-systems. (If there weren't such a glyph we would not know
19254 how wide and tall a box cursor should be displayed).
19256 At the same time this space let's a nicely handle clearing to the
19257 end of the line if the row ends in italic text. */
19260 append_space_for_newline (struct it
*it
, int default_face_p
)
19262 if (FRAME_WINDOW_P (it
->f
))
19264 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19266 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19267 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19269 /* Save some values that must not be changed.
19270 Must save IT->c and IT->len because otherwise
19271 ITERATOR_AT_END_P wouldn't work anymore after
19272 append_space_for_newline has been called. */
19273 enum display_element_type saved_what
= it
->what
;
19274 int saved_c
= it
->c
, saved_len
= it
->len
;
19275 int saved_char_to_display
= it
->char_to_display
;
19276 int saved_x
= it
->current_x
;
19277 int saved_face_id
= it
->face_id
;
19278 int saved_box_end
= it
->end_of_box_run_p
;
19279 struct text_pos saved_pos
;
19280 Lisp_Object saved_object
;
19283 saved_object
= it
->object
;
19284 saved_pos
= it
->position
;
19286 it
->what
= IT_CHARACTER
;
19287 memset (&it
->position
, 0, sizeof it
->position
);
19289 it
->c
= it
->char_to_display
= ' ';
19292 /* If the default face was remapped, be sure to use the
19293 remapped face for the appended newline. */
19294 if (default_face_p
)
19295 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19296 else if (it
->face_before_selective_p
)
19297 it
->face_id
= it
->saved_face_id
;
19298 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19299 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19300 /* In R2L rows, we will prepend a stretch glyph that will
19301 have the end_of_box_run_p flag set for it, so there's no
19302 need for the appended newline glyph to have that flag
19304 if (it
->glyph_row
->reversed_p
19305 /* But if the appended newline glyph goes all the way to
19306 the end of the row, there will be no stretch glyph,
19307 so leave the box flag set. */
19308 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19309 it
->end_of_box_run_p
= 0;
19311 PRODUCE_GLYPHS (it
);
19313 it
->override_ascent
= -1;
19314 it
->constrain_row_ascent_descent_p
= 0;
19315 it
->current_x
= saved_x
;
19316 it
->object
= saved_object
;
19317 it
->position
= saved_pos
;
19318 it
->what
= saved_what
;
19319 it
->face_id
= saved_face_id
;
19320 it
->len
= saved_len
;
19322 it
->char_to_display
= saved_char_to_display
;
19323 it
->end_of_box_run_p
= saved_box_end
;
19332 /* Extend the face of the last glyph in the text area of IT->glyph_row
19333 to the end of the display line. Called from display_line. If the
19334 glyph row is empty, add a space glyph to it so that we know the
19335 face to draw. Set the glyph row flag fill_line_p. If the glyph
19336 row is R2L, prepend a stretch glyph to cover the empty space to the
19337 left of the leftmost glyph. */
19340 extend_face_to_end_of_line (struct it
*it
)
19342 struct face
*face
, *default_face
;
19343 struct frame
*f
= it
->f
;
19345 /* If line is already filled, do nothing. Non window-system frames
19346 get a grace of one more ``pixel'' because their characters are
19347 1-``pixel'' wide, so they hit the equality too early. This grace
19348 is needed only for R2L rows that are not continued, to produce
19349 one extra blank where we could display the cursor. */
19350 if ((it
->current_x
>= it
->last_visible_x
19351 + (!FRAME_WINDOW_P (f
)
19352 && it
->glyph_row
->reversed_p
19353 && !it
->glyph_row
->continued_p
))
19354 /* If the window has display margins, we will need to extend
19355 their face even if the text area is filled. */
19356 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19357 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19360 /* The default face, possibly remapped. */
19361 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19363 /* Face extension extends the background and box of IT->face_id
19364 to the end of the line. If the background equals the background
19365 of the frame, we don't have to do anything. */
19366 if (it
->face_before_selective_p
)
19367 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19369 face
= FACE_FROM_ID (f
, it
->face_id
);
19371 if (FRAME_WINDOW_P (f
)
19372 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19373 && face
->box
== FACE_NO_BOX
19374 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19375 #ifdef HAVE_WINDOW_SYSTEM
19378 && !it
->glyph_row
->reversed_p
)
19381 /* Set the glyph row flag indicating that the face of the last glyph
19382 in the text area has to be drawn to the end of the text area. */
19383 it
->glyph_row
->fill_line_p
= 1;
19385 /* If current character of IT is not ASCII, make sure we have the
19386 ASCII face. This will be automatically undone the next time
19387 get_next_display_element returns a multibyte character. Note
19388 that the character will always be single byte in unibyte
19390 if (!ASCII_CHAR_P (it
->c
))
19392 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19395 if (FRAME_WINDOW_P (f
))
19397 /* If the row is empty, add a space with the current face of IT,
19398 so that we know which face to draw. */
19399 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19401 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19402 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19403 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19405 /* Mode line and the header line don't have margins, and
19406 likewise the frame's tool-bar window, if there is any. */
19407 if (!(it
->glyph_row
->mode_line_p
19408 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19409 || (WINDOWP (f
->tool_bar_window
)
19410 && it
->w
== XWINDOW (f
->tool_bar_window
))
19414 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19415 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19417 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19418 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19420 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19422 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19423 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19425 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19426 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19428 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19431 #ifdef HAVE_WINDOW_SYSTEM
19432 if (it
->glyph_row
->reversed_p
)
19434 /* Prepend a stretch glyph to the row, such that the
19435 rightmost glyph will be drawn flushed all the way to the
19436 right margin of the window. The stretch glyph that will
19437 occupy the empty space, if any, to the left of the
19439 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19440 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19441 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19443 int row_width
, stretch_ascent
, stretch_width
;
19444 struct text_pos saved_pos
;
19445 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19447 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19448 row_width
+= g
->pixel_width
;
19450 /* FIXME: There are various minor display glitches in R2L
19451 rows when only one of the fringes is missing. The
19452 strange condition below produces the least bad effect. */
19453 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19454 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19455 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19456 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19458 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19459 stretch_width
-= row_width
;
19461 if (stretch_width
> 0)
19464 (((it
->ascent
+ it
->descent
)
19465 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19466 saved_pos
= it
->position
;
19467 memset (&it
->position
, 0, sizeof it
->position
);
19468 saved_avoid_cursor
= it
->avoid_cursor_p
;
19469 it
->avoid_cursor_p
= 1;
19470 saved_face_id
= it
->face_id
;
19471 saved_box_start
= it
->start_of_box_run_p
;
19472 /* The last row's stretch glyph should get the default
19473 face, to avoid painting the rest of the window with
19474 the region face, if the region ends at ZV. */
19475 if (it
->glyph_row
->ends_at_zv_p
)
19476 it
->face_id
= default_face
->id
;
19478 it
->face_id
= face
->id
;
19479 it
->start_of_box_run_p
= 0;
19480 append_stretch_glyph (it
, Qnil
, stretch_width
,
19481 it
->ascent
+ it
->descent
, stretch_ascent
);
19482 it
->position
= saved_pos
;
19483 it
->avoid_cursor_p
= saved_avoid_cursor
;
19484 it
->face_id
= saved_face_id
;
19485 it
->start_of_box_run_p
= saved_box_start
;
19487 /* If stretch_width comes out negative, it means that the
19488 last glyph is only partially visible. In R2L rows, we
19489 want the leftmost glyph to be partially visible, so we
19490 need to give the row the corresponding left offset. */
19491 if (stretch_width
< 0)
19492 it
->glyph_row
->x
= stretch_width
;
19494 #endif /* HAVE_WINDOW_SYSTEM */
19498 /* Save some values that must not be changed. */
19499 int saved_x
= it
->current_x
;
19500 struct text_pos saved_pos
;
19501 Lisp_Object saved_object
;
19502 enum display_element_type saved_what
= it
->what
;
19503 int saved_face_id
= it
->face_id
;
19505 saved_object
= it
->object
;
19506 saved_pos
= it
->position
;
19508 it
->what
= IT_CHARACTER
;
19509 memset (&it
->position
, 0, sizeof it
->position
);
19511 it
->c
= it
->char_to_display
= ' ';
19514 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19515 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19516 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19517 && !it
->glyph_row
->mode_line_p
19518 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19520 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19521 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19523 for (it
->current_x
= 0; g
< e
; g
++)
19524 it
->current_x
+= g
->pixel_width
;
19526 it
->area
= LEFT_MARGIN_AREA
;
19527 it
->face_id
= default_face
->id
;
19528 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19529 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19531 PRODUCE_GLYPHS (it
);
19532 /* term.c:produce_glyphs advances it->current_x only for
19534 it
->current_x
+= it
->pixel_width
;
19537 it
->current_x
= saved_x
;
19538 it
->area
= TEXT_AREA
;
19541 /* The last row's blank glyphs should get the default face, to
19542 avoid painting the rest of the window with the region face,
19543 if the region ends at ZV. */
19544 if (it
->glyph_row
->ends_at_zv_p
)
19545 it
->face_id
= default_face
->id
;
19547 it
->face_id
= face
->id
;
19548 PRODUCE_GLYPHS (it
);
19550 while (it
->current_x
<= it
->last_visible_x
)
19551 PRODUCE_GLYPHS (it
);
19553 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19554 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19555 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19556 && !it
->glyph_row
->mode_line_p
19557 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19559 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19560 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19562 for ( ; g
< e
; g
++)
19563 it
->current_x
+= g
->pixel_width
;
19565 it
->area
= RIGHT_MARGIN_AREA
;
19566 it
->face_id
= default_face
->id
;
19567 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19568 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19570 PRODUCE_GLYPHS (it
);
19571 it
->current_x
+= it
->pixel_width
;
19574 it
->area
= TEXT_AREA
;
19577 /* Don't count these blanks really. It would let us insert a left
19578 truncation glyph below and make us set the cursor on them, maybe. */
19579 it
->current_x
= saved_x
;
19580 it
->object
= saved_object
;
19581 it
->position
= saved_pos
;
19582 it
->what
= saved_what
;
19583 it
->face_id
= saved_face_id
;
19588 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19589 trailing whitespace. */
19592 trailing_whitespace_p (ptrdiff_t charpos
)
19594 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19597 while (bytepos
< ZV_BYTE
19598 && (c
= FETCH_CHAR (bytepos
),
19599 c
== ' ' || c
== '\t'))
19602 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19604 if (bytepos
!= PT_BYTE
)
19611 /* Highlight trailing whitespace, if any, in ROW. */
19614 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19616 int used
= row
->used
[TEXT_AREA
];
19620 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19621 struct glyph
*glyph
= start
+ used
- 1;
19623 if (row
->reversed_p
)
19625 /* Right-to-left rows need to be processed in the opposite
19626 direction, so swap the edge pointers. */
19628 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19631 /* Skip over glyphs inserted to display the cursor at the
19632 end of a line, for extending the face of the last glyph
19633 to the end of the line on terminals, and for truncation
19634 and continuation glyphs. */
19635 if (!row
->reversed_p
)
19637 while (glyph
>= start
19638 && glyph
->type
== CHAR_GLYPH
19639 && NILP (glyph
->object
))
19644 while (glyph
<= start
19645 && glyph
->type
== CHAR_GLYPH
19646 && NILP (glyph
->object
))
19650 /* If last glyph is a space or stretch, and it's trailing
19651 whitespace, set the face of all trailing whitespace glyphs in
19652 IT->glyph_row to `trailing-whitespace'. */
19653 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19654 && BUFFERP (glyph
->object
)
19655 && (glyph
->type
== STRETCH_GLYPH
19656 || (glyph
->type
== CHAR_GLYPH
19657 && glyph
->u
.ch
== ' '))
19658 && trailing_whitespace_p (glyph
->charpos
))
19660 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19664 if (!row
->reversed_p
)
19666 while (glyph
>= start
19667 && BUFFERP (glyph
->object
)
19668 && (glyph
->type
== STRETCH_GLYPH
19669 || (glyph
->type
== CHAR_GLYPH
19670 && glyph
->u
.ch
== ' ')))
19671 (glyph
--)->face_id
= face_id
;
19675 while (glyph
<= start
19676 && BUFFERP (glyph
->object
)
19677 && (glyph
->type
== STRETCH_GLYPH
19678 || (glyph
->type
== CHAR_GLYPH
19679 && glyph
->u
.ch
== ' ')))
19680 (glyph
++)->face_id
= face_id
;
19687 /* Value is non-zero if glyph row ROW should be
19688 considered to hold the buffer position CHARPOS. */
19691 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19695 if (charpos
== CHARPOS (row
->end
.pos
)
19696 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19698 /* Suppose the row ends on a string.
19699 Unless the row is continued, that means it ends on a newline
19700 in the string. If it's anything other than a display string
19701 (e.g., a before-string from an overlay), we don't want the
19702 cursor there. (This heuristic seems to give the optimal
19703 behavior for the various types of multi-line strings.)
19704 One exception: if the string has `cursor' property on one of
19705 its characters, we _do_ want the cursor there. */
19706 if (CHARPOS (row
->end
.string_pos
) >= 0)
19708 if (row
->continued_p
)
19712 /* Check for `display' property. */
19713 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19714 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19715 struct glyph
*glyph
;
19718 for (glyph
= end
; glyph
>= beg
; --glyph
)
19719 if (STRINGP (glyph
->object
))
19722 = Fget_char_property (make_number (charpos
),
19726 && display_prop_string_p (prop
, glyph
->object
));
19727 /* If there's a `cursor' property on one of the
19728 string's characters, this row is a cursor row,
19729 even though this is not a display string. */
19732 Lisp_Object s
= glyph
->object
;
19734 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19736 ptrdiff_t gpos
= glyph
->charpos
;
19738 if (!NILP (Fget_char_property (make_number (gpos
),
19750 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19752 /* If the row ends in middle of a real character,
19753 and the line is continued, we want the cursor here.
19754 That's because CHARPOS (ROW->end.pos) would equal
19755 PT if PT is before the character. */
19756 if (!row
->ends_in_ellipsis_p
)
19757 result
= row
->continued_p
;
19759 /* If the row ends in an ellipsis, then
19760 CHARPOS (ROW->end.pos) will equal point after the
19761 invisible text. We want that position to be displayed
19762 after the ellipsis. */
19765 /* If the row ends at ZV, display the cursor at the end of that
19766 row instead of at the start of the row below. */
19767 else if (row
->ends_at_zv_p
)
19776 /* Value is non-zero if glyph row ROW should be
19777 used to hold the cursor. */
19780 cursor_row_p (struct glyph_row
*row
)
19782 return row_for_charpos_p (row
, PT
);
19787 /* Push the property PROP so that it will be rendered at the current
19788 position in IT. Return 1 if PROP was successfully pushed, 0
19789 otherwise. Called from handle_line_prefix to handle the
19790 `line-prefix' and `wrap-prefix' properties. */
19793 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19795 struct text_pos pos
=
19796 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19798 eassert (it
->method
== GET_FROM_BUFFER
19799 || it
->method
== GET_FROM_DISPLAY_VECTOR
19800 || it
->method
== GET_FROM_STRING
);
19802 /* We need to save the current buffer/string position, so it will be
19803 restored by pop_it, because iterate_out_of_display_property
19804 depends on that being set correctly, but some situations leave
19805 it->position not yet set when this function is called. */
19806 push_it (it
, &pos
);
19808 if (STRINGP (prop
))
19810 if (SCHARS (prop
) == 0)
19817 it
->string_from_prefix_prop_p
= 1;
19818 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19819 it
->current
.overlay_string_index
= -1;
19820 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19821 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19822 it
->method
= GET_FROM_STRING
;
19823 it
->stop_charpos
= 0;
19825 it
->base_level_stop
= 0;
19827 /* Force paragraph direction to be that of the parent
19829 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19830 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19832 it
->paragraph_embedding
= L2R
;
19834 /* Set up the bidi iterator for this display string. */
19837 it
->bidi_it
.string
.lstring
= it
->string
;
19838 it
->bidi_it
.string
.s
= NULL
;
19839 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19840 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19841 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19842 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19843 it
->bidi_it
.w
= it
->w
;
19844 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19847 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19849 it
->method
= GET_FROM_STRETCH
;
19852 #ifdef HAVE_WINDOW_SYSTEM
19853 else if (IMAGEP (prop
))
19855 it
->what
= IT_IMAGE
;
19856 it
->image_id
= lookup_image (it
->f
, prop
);
19857 it
->method
= GET_FROM_IMAGE
;
19859 #endif /* HAVE_WINDOW_SYSTEM */
19862 pop_it (it
); /* bogus display property, give up */
19869 /* Return the character-property PROP at the current position in IT. */
19872 get_it_property (struct it
*it
, Lisp_Object prop
)
19874 Lisp_Object position
, object
= it
->object
;
19876 if (STRINGP (object
))
19877 position
= make_number (IT_STRING_CHARPOS (*it
));
19878 else if (BUFFERP (object
))
19880 position
= make_number (IT_CHARPOS (*it
));
19881 object
= it
->window
;
19886 return Fget_char_property (position
, prop
, object
);
19889 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19892 handle_line_prefix (struct it
*it
)
19894 Lisp_Object prefix
;
19896 if (it
->continuation_lines_width
> 0)
19898 prefix
= get_it_property (it
, Qwrap_prefix
);
19900 prefix
= Vwrap_prefix
;
19904 prefix
= get_it_property (it
, Qline_prefix
);
19906 prefix
= Vline_prefix
;
19908 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19910 /* If the prefix is wider than the window, and we try to wrap
19911 it, it would acquire its own wrap prefix, and so on till the
19912 iterator stack overflows. So, don't wrap the prefix. */
19913 it
->line_wrap
= TRUNCATE
;
19914 it
->avoid_cursor_p
= 1;
19920 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19921 only for R2L lines from display_line and display_string, when they
19922 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19923 the line/string needs to be continued on the next glyph row. */
19925 unproduce_glyphs (struct it
*it
, int n
)
19927 struct glyph
*glyph
, *end
;
19929 eassert (it
->glyph_row
);
19930 eassert (it
->glyph_row
->reversed_p
);
19931 eassert (it
->area
== TEXT_AREA
);
19932 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19934 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19935 n
= it
->glyph_row
->used
[TEXT_AREA
];
19936 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19937 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19938 for ( ; glyph
< end
; glyph
++)
19939 glyph
[-n
] = *glyph
;
19942 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19943 and ROW->maxpos. */
19945 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19946 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19947 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19949 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19950 lines' rows is implemented for bidi-reordered rows. */
19952 /* ROW->minpos is the value of min_pos, the minimal buffer position
19953 we have in ROW, or ROW->start.pos if that is smaller. */
19954 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19955 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19957 /* We didn't find buffer positions smaller than ROW->start, or
19958 didn't find _any_ valid buffer positions in any of the glyphs,
19959 so we must trust the iterator's computed positions. */
19960 row
->minpos
= row
->start
.pos
;
19963 max_pos
= CHARPOS (it
->current
.pos
);
19964 max_bpos
= BYTEPOS (it
->current
.pos
);
19967 /* Here are the various use-cases for ending the row, and the
19968 corresponding values for ROW->maxpos:
19970 Line ends in a newline from buffer eol_pos + 1
19971 Line is continued from buffer max_pos + 1
19972 Line is truncated on right it->current.pos
19973 Line ends in a newline from string max_pos + 1(*)
19974 (*) + 1 only when line ends in a forward scan
19975 Line is continued from string max_pos
19976 Line is continued from display vector max_pos
19977 Line is entirely from a string min_pos == max_pos
19978 Line is entirely from a display vector min_pos == max_pos
19979 Line that ends at ZV ZV
19981 If you discover other use-cases, please add them here as
19983 if (row
->ends_at_zv_p
)
19984 row
->maxpos
= it
->current
.pos
;
19985 else if (row
->used
[TEXT_AREA
])
19987 int seen_this_string
= 0;
19988 struct glyph_row
*r1
= row
- 1;
19990 /* Did we see the same display string on the previous row? */
19991 if (STRINGP (it
->object
)
19992 /* this is not the first row */
19993 && row
> it
->w
->desired_matrix
->rows
19994 /* previous row is not the header line */
19995 && !r1
->mode_line_p
19996 /* previous row also ends in a newline from a string */
19997 && r1
->ends_in_newline_from_string_p
)
19999 struct glyph
*start
, *end
;
20001 /* Search for the last glyph of the previous row that came
20002 from buffer or string. Depending on whether the row is
20003 L2R or R2L, we need to process it front to back or the
20004 other way round. */
20005 if (!r1
->reversed_p
)
20007 start
= r1
->glyphs
[TEXT_AREA
];
20008 end
= start
+ r1
->used
[TEXT_AREA
];
20009 /* Glyphs inserted by redisplay have nil as their object. */
20011 && NILP ((end
- 1)->object
)
20012 && (end
- 1)->charpos
<= 0)
20016 if (EQ ((end
- 1)->object
, it
->object
))
20017 seen_this_string
= 1;
20020 /* If all the glyphs of the previous row were inserted
20021 by redisplay, it means the previous row was
20022 produced from a single newline, which is only
20023 possible if that newline came from the same string
20024 as the one which produced this ROW. */
20025 seen_this_string
= 1;
20029 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20030 start
= end
+ r1
->used
[TEXT_AREA
];
20032 && NILP ((end
+ 1)->object
)
20033 && (end
+ 1)->charpos
<= 0)
20037 if (EQ ((end
+ 1)->object
, it
->object
))
20038 seen_this_string
= 1;
20041 seen_this_string
= 1;
20044 /* Take note of each display string that covers a newline only
20045 once, the first time we see it. This is for when a display
20046 string includes more than one newline in it. */
20047 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20049 /* If we were scanning the buffer forward when we displayed
20050 the string, we want to account for at least one buffer
20051 position that belongs to this row (position covered by
20052 the display string), so that cursor positioning will
20053 consider this row as a candidate when point is at the end
20054 of the visual line represented by this row. This is not
20055 required when scanning back, because max_pos will already
20056 have a much larger value. */
20057 if (CHARPOS (row
->end
.pos
) > max_pos
)
20058 INC_BOTH (max_pos
, max_bpos
);
20059 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20061 else if (CHARPOS (it
->eol_pos
) > 0)
20062 SET_TEXT_POS (row
->maxpos
,
20063 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20064 else if (row
->continued_p
)
20066 /* If max_pos is different from IT's current position, it
20067 means IT->method does not belong to the display element
20068 at max_pos. However, it also means that the display
20069 element at max_pos was displayed in its entirety on this
20070 line, which is equivalent to saying that the next line
20071 starts at the next buffer position. */
20072 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20073 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20076 INC_BOTH (max_pos
, max_bpos
);
20077 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20080 else if (row
->truncated_on_right_p
)
20081 /* display_line already called reseat_at_next_visible_line_start,
20082 which puts the iterator at the beginning of the next line, in
20083 the logical order. */
20084 row
->maxpos
= it
->current
.pos
;
20085 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20086 /* A line that is entirely from a string/image/stretch... */
20087 row
->maxpos
= row
->minpos
;
20092 row
->maxpos
= it
->current
.pos
;
20095 /* Construct the glyph row IT->glyph_row in the desired matrix of
20096 IT->w from text at the current position of IT. See dispextern.h
20097 for an overview of struct it. Value is non-zero if
20098 IT->glyph_row displays text, as opposed to a line displaying ZV
20102 display_line (struct it
*it
)
20104 struct glyph_row
*row
= it
->glyph_row
;
20105 Lisp_Object overlay_arrow_string
;
20107 void *wrap_data
= NULL
;
20108 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20109 int wrap_row_used
= -1;
20110 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20111 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20112 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20113 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20114 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20116 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20117 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20118 bool pending_handle_line_prefix
= false;
20120 /* We always start displaying at hpos zero even if hscrolled. */
20121 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20123 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20124 >= it
->w
->desired_matrix
->nrows
)
20126 it
->w
->nrows_scale_factor
++;
20127 it
->f
->fonts_changed
= 1;
20131 /* Clear the result glyph row and enable it. */
20132 prepare_desired_row (it
->w
, row
, false);
20134 row
->y
= it
->current_y
;
20135 row
->start
= it
->start
;
20136 row
->continuation_lines_width
= it
->continuation_lines_width
;
20137 row
->displays_text_p
= 1;
20138 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20139 it
->starts_in_middle_of_char_p
= 0;
20141 /* Arrange the overlays nicely for our purposes. Usually, we call
20142 display_line on only one line at a time, in which case this
20143 can't really hurt too much, or we call it on lines which appear
20144 one after another in the buffer, in which case all calls to
20145 recenter_overlay_lists but the first will be pretty cheap. */
20146 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20148 /* Move over display elements that are not visible because we are
20149 hscrolled. This may stop at an x-position < IT->first_visible_x
20150 if the first glyph is partially visible or if we hit a line end. */
20151 if (it
->current_x
< it
->first_visible_x
)
20153 enum move_it_result move_result
;
20155 this_line_min_pos
= row
->start
.pos
;
20156 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20157 MOVE_TO_POS
| MOVE_TO_X
);
20158 /* If we are under a large hscroll, move_it_in_display_line_to
20159 could hit the end of the line without reaching
20160 it->first_visible_x. Pretend that we did reach it. This is
20161 especially important on a TTY, where we will call
20162 extend_face_to_end_of_line, which needs to know how many
20163 blank glyphs to produce. */
20164 if (it
->current_x
< it
->first_visible_x
20165 && (move_result
== MOVE_NEWLINE_OR_CR
20166 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20167 it
->current_x
= it
->first_visible_x
;
20169 /* Record the smallest positions seen while we moved over
20170 display elements that are not visible. This is needed by
20171 redisplay_internal for optimizing the case where the cursor
20172 stays inside the same line. The rest of this function only
20173 considers positions that are actually displayed, so
20174 RECORD_MAX_MIN_POS will not otherwise record positions that
20175 are hscrolled to the left of the left edge of the window. */
20176 min_pos
= CHARPOS (this_line_min_pos
);
20177 min_bpos
= BYTEPOS (this_line_min_pos
);
20179 else if (it
->area
== TEXT_AREA
)
20181 /* We only do this when not calling move_it_in_display_line_to
20182 above, because that function calls itself handle_line_prefix. */
20183 handle_line_prefix (it
);
20187 /* Line-prefix and wrap-prefix are always displayed in the text
20188 area. But if this is the first call to display_line after
20189 init_iterator, the iterator might have been set up to write
20190 into a marginal area, e.g. if the line begins with some
20191 display property that writes to the margins. So we need to
20192 wait with the call to handle_line_prefix until whatever
20193 writes to the margin has done its job. */
20194 pending_handle_line_prefix
= true;
20197 /* Get the initial row height. This is either the height of the
20198 text hscrolled, if there is any, or zero. */
20199 row
->ascent
= it
->max_ascent
;
20200 row
->height
= it
->max_ascent
+ it
->max_descent
;
20201 row
->phys_ascent
= it
->max_phys_ascent
;
20202 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20203 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20205 /* Utility macro to record max and min buffer positions seen until now. */
20206 #define RECORD_MAX_MIN_POS(IT) \
20209 int composition_p = !STRINGP ((IT)->string) \
20210 && ((IT)->what == IT_COMPOSITION); \
20211 ptrdiff_t current_pos = \
20212 composition_p ? (IT)->cmp_it.charpos \
20213 : IT_CHARPOS (*(IT)); \
20214 ptrdiff_t current_bpos = \
20215 composition_p ? CHAR_TO_BYTE (current_pos) \
20216 : IT_BYTEPOS (*(IT)); \
20217 if (current_pos < min_pos) \
20219 min_pos = current_pos; \
20220 min_bpos = current_bpos; \
20222 if (IT_CHARPOS (*it) > max_pos) \
20224 max_pos = IT_CHARPOS (*it); \
20225 max_bpos = IT_BYTEPOS (*it); \
20230 /* Loop generating characters. The loop is left with IT on the next
20231 character to display. */
20234 int n_glyphs_before
, hpos_before
, x_before
;
20236 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20238 /* Retrieve the next thing to display. Value is zero if end of
20240 if (!get_next_display_element (it
))
20242 /* Maybe add a space at the end of this line that is used to
20243 display the cursor there under X. Set the charpos of the
20244 first glyph of blank lines not corresponding to any text
20246 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20247 row
->exact_window_width_line_p
= 1;
20248 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20249 || row
->used
[TEXT_AREA
] == 0)
20251 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20252 row
->displays_text_p
= 0;
20254 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20255 && (!MINI_WINDOW_P (it
->w
)
20256 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20257 row
->indicate_empty_line_p
= 1;
20260 it
->continuation_lines_width
= 0;
20261 row
->ends_at_zv_p
= 1;
20262 /* A row that displays right-to-left text must always have
20263 its last face extended all the way to the end of line,
20264 even if this row ends in ZV, because we still write to
20265 the screen left to right. We also need to extend the
20266 last face if the default face is remapped to some
20267 different face, otherwise the functions that clear
20268 portions of the screen will clear with the default face's
20269 background color. */
20270 if (row
->reversed_p
20271 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20272 extend_face_to_end_of_line (it
);
20276 /* Now, get the metrics of what we want to display. This also
20277 generates glyphs in `row' (which is IT->glyph_row). */
20278 n_glyphs_before
= row
->used
[TEXT_AREA
];
20281 /* Remember the line height so far in case the next element doesn't
20282 fit on the line. */
20283 if (it
->line_wrap
!= TRUNCATE
)
20285 ascent
= it
->max_ascent
;
20286 descent
= it
->max_descent
;
20287 phys_ascent
= it
->max_phys_ascent
;
20288 phys_descent
= it
->max_phys_descent
;
20290 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20292 if (IT_DISPLAYING_WHITESPACE (it
))
20296 SAVE_IT (wrap_it
, *it
, wrap_data
);
20298 wrap_row_used
= row
->used
[TEXT_AREA
];
20299 wrap_row_ascent
= row
->ascent
;
20300 wrap_row_height
= row
->height
;
20301 wrap_row_phys_ascent
= row
->phys_ascent
;
20302 wrap_row_phys_height
= row
->phys_height
;
20303 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20304 wrap_row_min_pos
= min_pos
;
20305 wrap_row_min_bpos
= min_bpos
;
20306 wrap_row_max_pos
= max_pos
;
20307 wrap_row_max_bpos
= max_bpos
;
20313 PRODUCE_GLYPHS (it
);
20315 /* If this display element was in marginal areas, continue with
20317 if (it
->area
!= TEXT_AREA
)
20319 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20320 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20321 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20322 row
->phys_height
= max (row
->phys_height
,
20323 it
->max_phys_ascent
+ it
->max_phys_descent
);
20324 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20325 it
->max_extra_line_spacing
);
20326 set_iterator_to_next (it
, 1);
20327 /* If we didn't handle the line/wrap prefix above, and the
20328 call to set_iterator_to_next just switched to TEXT_AREA,
20329 process the prefix now. */
20330 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20332 pending_handle_line_prefix
= false;
20333 handle_line_prefix (it
);
20338 /* Does the display element fit on the line? If we truncate
20339 lines, we should draw past the right edge of the window. If
20340 we don't truncate, we want to stop so that we can display the
20341 continuation glyph before the right margin. If lines are
20342 continued, there are two possible strategies for characters
20343 resulting in more than 1 glyph (e.g. tabs): Display as many
20344 glyphs as possible in this line and leave the rest for the
20345 continuation line, or display the whole element in the next
20346 line. Original redisplay did the former, so we do it also. */
20347 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20348 hpos_before
= it
->hpos
;
20351 if (/* Not a newline. */
20353 /* Glyphs produced fit entirely in the line. */
20354 && it
->current_x
< it
->last_visible_x
)
20356 it
->hpos
+= nglyphs
;
20357 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20358 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20359 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20360 row
->phys_height
= max (row
->phys_height
,
20361 it
->max_phys_ascent
+ it
->max_phys_descent
);
20362 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20363 it
->max_extra_line_spacing
);
20364 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20365 /* In R2L rows, we arrange in extend_face_to_end_of_line
20366 to add a right offset to the line, by a suitable
20367 change to the stretch glyph that is the leftmost
20368 glyph of the line. */
20369 && !row
->reversed_p
)
20370 row
->x
= x
- it
->first_visible_x
;
20371 /* Record the maximum and minimum buffer positions seen so
20372 far in glyphs that will be displayed by this row. */
20374 RECORD_MAX_MIN_POS (it
);
20379 struct glyph
*glyph
;
20381 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20383 /* Identify the glyphs added by the last call to
20384 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20385 the previous glyphs. */
20386 if (!row
->reversed_p
)
20387 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20389 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20390 new_x
= x
+ glyph
->pixel_width
;
20392 if (/* Lines are continued. */
20393 it
->line_wrap
!= TRUNCATE
20394 && (/* Glyph doesn't fit on the line. */
20395 new_x
> it
->last_visible_x
20396 /* Or it fits exactly on a window system frame. */
20397 || (new_x
== it
->last_visible_x
20398 && FRAME_WINDOW_P (it
->f
)
20399 && (row
->reversed_p
20400 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20401 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20403 /* End of a continued line. */
20406 || (new_x
== it
->last_visible_x
20407 && FRAME_WINDOW_P (it
->f
)
20408 && (row
->reversed_p
20409 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20410 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20412 /* Current glyph is the only one on the line or
20413 fits exactly on the line. We must continue
20414 the line because we can't draw the cursor
20415 after the glyph. */
20416 row
->continued_p
= 1;
20417 it
->current_x
= new_x
;
20418 it
->continuation_lines_width
+= new_x
;
20420 if (i
== nglyphs
- 1)
20422 /* If line-wrap is on, check if a previous
20423 wrap point was found. */
20424 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20425 && wrap_row_used
> 0
20426 /* Even if there is a previous wrap
20427 point, continue the line here as
20428 usual, if (i) the previous character
20429 was a space or tab AND (ii) the
20430 current character is not. */
20432 || IT_DISPLAYING_WHITESPACE (it
)))
20435 /* Record the maximum and minimum buffer
20436 positions seen so far in glyphs that will be
20437 displayed by this row. */
20439 RECORD_MAX_MIN_POS (it
);
20440 set_iterator_to_next (it
, 1);
20441 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20443 if (!get_next_display_element (it
))
20445 row
->exact_window_width_line_p
= 1;
20446 it
->continuation_lines_width
= 0;
20447 row
->continued_p
= 0;
20448 row
->ends_at_zv_p
= 1;
20450 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20452 row
->continued_p
= 0;
20453 row
->exact_window_width_line_p
= 1;
20455 /* If line-wrap is on, check if a
20456 previous wrap point was found. */
20457 else if (wrap_row_used
> 0
20458 /* Even if there is a previous wrap
20459 point, continue the line here as
20460 usual, if (i) the previous character
20461 was a space or tab AND (ii) the
20462 current character is not. */
20464 || IT_DISPLAYING_WHITESPACE (it
)))
20469 else if (it
->bidi_p
)
20470 RECORD_MAX_MIN_POS (it
);
20471 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20472 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20473 extend_face_to_end_of_line (it
);
20475 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20476 && !FRAME_WINDOW_P (it
->f
))
20478 /* A padding glyph that doesn't fit on this line.
20479 This means the whole character doesn't fit
20481 if (row
->reversed_p
)
20482 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20483 - n_glyphs_before
);
20484 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20486 /* Fill the rest of the row with continuation
20487 glyphs like in 20.x. */
20488 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20489 < row
->glyphs
[1 + TEXT_AREA
])
20490 produce_special_glyphs (it
, IT_CONTINUATION
);
20492 row
->continued_p
= 1;
20493 it
->current_x
= x_before
;
20494 it
->continuation_lines_width
+= x_before
;
20496 /* Restore the height to what it was before the
20497 element not fitting on the line. */
20498 it
->max_ascent
= ascent
;
20499 it
->max_descent
= descent
;
20500 it
->max_phys_ascent
= phys_ascent
;
20501 it
->max_phys_descent
= phys_descent
;
20502 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20503 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20504 extend_face_to_end_of_line (it
);
20506 else if (wrap_row_used
> 0)
20509 if (row
->reversed_p
)
20510 unproduce_glyphs (it
,
20511 row
->used
[TEXT_AREA
] - wrap_row_used
);
20512 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20513 it
->continuation_lines_width
+= wrap_x
;
20514 row
->used
[TEXT_AREA
] = wrap_row_used
;
20515 row
->ascent
= wrap_row_ascent
;
20516 row
->height
= wrap_row_height
;
20517 row
->phys_ascent
= wrap_row_phys_ascent
;
20518 row
->phys_height
= wrap_row_phys_height
;
20519 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20520 min_pos
= wrap_row_min_pos
;
20521 min_bpos
= wrap_row_min_bpos
;
20522 max_pos
= wrap_row_max_pos
;
20523 max_bpos
= wrap_row_max_bpos
;
20524 row
->continued_p
= 1;
20525 row
->ends_at_zv_p
= 0;
20526 row
->exact_window_width_line_p
= 0;
20527 it
->continuation_lines_width
+= x
;
20529 /* Make sure that a non-default face is extended
20530 up to the right margin of the window. */
20531 extend_face_to_end_of_line (it
);
20533 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20535 /* A TAB that extends past the right edge of the
20536 window. This produces a single glyph on
20537 window system frames. We leave the glyph in
20538 this row and let it fill the row, but don't
20539 consume the TAB. */
20540 if ((row
->reversed_p
20541 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20542 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20543 produce_special_glyphs (it
, IT_CONTINUATION
);
20544 it
->continuation_lines_width
+= it
->last_visible_x
;
20545 row
->ends_in_middle_of_char_p
= 1;
20546 row
->continued_p
= 1;
20547 glyph
->pixel_width
= it
->last_visible_x
- x
;
20548 it
->starts_in_middle_of_char_p
= 1;
20549 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20550 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20551 extend_face_to_end_of_line (it
);
20555 /* Something other than a TAB that draws past
20556 the right edge of the window. Restore
20557 positions to values before the element. */
20558 if (row
->reversed_p
)
20559 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20560 - (n_glyphs_before
+ i
));
20561 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20563 /* Display continuation glyphs. */
20564 it
->current_x
= x_before
;
20565 it
->continuation_lines_width
+= x
;
20566 if (!FRAME_WINDOW_P (it
->f
)
20567 || (row
->reversed_p
20568 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20569 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20570 produce_special_glyphs (it
, IT_CONTINUATION
);
20571 row
->continued_p
= 1;
20573 extend_face_to_end_of_line (it
);
20575 if (nglyphs
> 1 && i
> 0)
20577 row
->ends_in_middle_of_char_p
= 1;
20578 it
->starts_in_middle_of_char_p
= 1;
20581 /* Restore the height to what it was before the
20582 element not fitting on the line. */
20583 it
->max_ascent
= ascent
;
20584 it
->max_descent
= descent
;
20585 it
->max_phys_ascent
= phys_ascent
;
20586 it
->max_phys_descent
= phys_descent
;
20591 else if (new_x
> it
->first_visible_x
)
20593 /* Increment number of glyphs actually displayed. */
20596 /* Record the maximum and minimum buffer positions
20597 seen so far in glyphs that will be displayed by
20600 RECORD_MAX_MIN_POS (it
);
20602 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20603 /* Glyph is partially visible, i.e. row starts at
20604 negative X position. Don't do that in R2L
20605 rows, where we arrange to add a right offset to
20606 the line in extend_face_to_end_of_line, by a
20607 suitable change to the stretch glyph that is
20608 the leftmost glyph of the line. */
20609 row
->x
= x
- it
->first_visible_x
;
20610 /* When the last glyph of an R2L row only fits
20611 partially on the line, we need to set row->x to a
20612 negative offset, so that the leftmost glyph is
20613 the one that is partially visible. But if we are
20614 going to produce the truncation glyph, this will
20615 be taken care of in produce_special_glyphs. */
20616 if (row
->reversed_p
20617 && new_x
> it
->last_visible_x
20618 && !(it
->line_wrap
== TRUNCATE
20619 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20621 eassert (FRAME_WINDOW_P (it
->f
));
20622 row
->x
= it
->last_visible_x
- new_x
;
20627 /* Glyph is completely off the left margin of the
20628 window. This should not happen because of the
20629 move_it_in_display_line at the start of this
20630 function, unless the text display area of the
20631 window is empty. */
20632 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20635 /* Even if this display element produced no glyphs at all,
20636 we want to record its position. */
20637 if (it
->bidi_p
&& nglyphs
== 0)
20638 RECORD_MAX_MIN_POS (it
);
20640 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20641 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20642 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20643 row
->phys_height
= max (row
->phys_height
,
20644 it
->max_phys_ascent
+ it
->max_phys_descent
);
20645 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20646 it
->max_extra_line_spacing
);
20648 /* End of this display line if row is continued. */
20649 if (row
->continued_p
|| row
->ends_at_zv_p
)
20654 /* Is this a line end? If yes, we're also done, after making
20655 sure that a non-default face is extended up to the right
20656 margin of the window. */
20657 if (ITERATOR_AT_END_OF_LINE_P (it
))
20659 int used_before
= row
->used
[TEXT_AREA
];
20661 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20663 /* Add a space at the end of the line that is used to
20664 display the cursor there. */
20665 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20666 append_space_for_newline (it
, 0);
20668 /* Extend the face to the end of the line. */
20669 extend_face_to_end_of_line (it
);
20671 /* Make sure we have the position. */
20672 if (used_before
== 0)
20673 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20675 /* Record the position of the newline, for use in
20677 it
->eol_pos
= it
->current
.pos
;
20679 /* Consume the line end. This skips over invisible lines. */
20680 set_iterator_to_next (it
, 1);
20681 it
->continuation_lines_width
= 0;
20685 /* Proceed with next display element. Note that this skips
20686 over lines invisible because of selective display. */
20687 set_iterator_to_next (it
, 1);
20689 /* If we truncate lines, we are done when the last displayed
20690 glyphs reach past the right margin of the window. */
20691 if (it
->line_wrap
== TRUNCATE
20692 && ((FRAME_WINDOW_P (it
->f
)
20693 /* Images are preprocessed in produce_image_glyph such
20694 that they are cropped at the right edge of the
20695 window, so an image glyph will always end exactly at
20696 last_visible_x, even if there's no right fringe. */
20697 && ((row
->reversed_p
20698 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20699 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20700 || it
->what
== IT_IMAGE
))
20701 ? (it
->current_x
>= it
->last_visible_x
)
20702 : (it
->current_x
> it
->last_visible_x
)))
20704 /* Maybe add truncation glyphs. */
20705 if (!FRAME_WINDOW_P (it
->f
)
20706 || (row
->reversed_p
20707 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20708 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20712 if (!row
->reversed_p
)
20714 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20715 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20720 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20721 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20723 /* Remove any padding glyphs at the front of ROW, to
20724 make room for the truncation glyphs we will be
20725 adding below. The loop below always inserts at
20726 least one truncation glyph, so also remove the
20727 last glyph added to ROW. */
20728 unproduce_glyphs (it
, i
+ 1);
20729 /* Adjust i for the loop below. */
20730 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20733 /* produce_special_glyphs overwrites the last glyph, so
20734 we don't want that if we want to keep that last
20735 glyph, which means it's an image. */
20736 if (it
->current_x
> it
->last_visible_x
)
20738 it
->current_x
= x_before
;
20739 if (!FRAME_WINDOW_P (it
->f
))
20741 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20743 row
->used
[TEXT_AREA
] = i
;
20744 produce_special_glyphs (it
, IT_TRUNCATION
);
20749 row
->used
[TEXT_AREA
] = i
;
20750 produce_special_glyphs (it
, IT_TRUNCATION
);
20752 it
->hpos
= hpos_before
;
20755 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20757 /* Don't truncate if we can overflow newline into fringe. */
20758 if (!get_next_display_element (it
))
20760 it
->continuation_lines_width
= 0;
20761 row
->ends_at_zv_p
= 1;
20762 row
->exact_window_width_line_p
= 1;
20765 if (ITERATOR_AT_END_OF_LINE_P (it
))
20767 row
->exact_window_width_line_p
= 1;
20768 goto at_end_of_line
;
20770 it
->current_x
= x_before
;
20771 it
->hpos
= hpos_before
;
20774 row
->truncated_on_right_p
= 1;
20775 it
->continuation_lines_width
= 0;
20776 reseat_at_next_visible_line_start (it
, 0);
20777 /* We insist below that IT's position be at ZV because in
20778 bidi-reordered lines the character at visible line start
20779 might not be the character that follows the newline in
20780 the logical order. */
20781 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20782 row
->ends_at_zv_p
=
20783 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20785 row
->ends_at_zv_p
= false;
20791 bidi_unshelve_cache (wrap_data
, 1);
20793 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20794 at the left window margin. */
20795 if (it
->first_visible_x
20796 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20798 if (!FRAME_WINDOW_P (it
->f
)
20799 || (((row
->reversed_p
20800 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20801 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20802 /* Don't let insert_left_trunc_glyphs overwrite the
20803 first glyph of the row if it is an image. */
20804 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20805 insert_left_trunc_glyphs (it
);
20806 row
->truncated_on_left_p
= 1;
20809 /* Remember the position at which this line ends.
20811 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20812 cannot be before the call to find_row_edges below, since that is
20813 where these positions are determined. */
20814 row
->end
= it
->current
;
20817 row
->minpos
= row
->start
.pos
;
20818 row
->maxpos
= row
->end
.pos
;
20822 /* ROW->minpos and ROW->maxpos must be the smallest and
20823 `1 + the largest' buffer positions in ROW. But if ROW was
20824 bidi-reordered, these two positions can be anywhere in the
20825 row, so we must determine them now. */
20826 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20829 /* If the start of this line is the overlay arrow-position, then
20830 mark this glyph row as the one containing the overlay arrow.
20831 This is clearly a mess with variable size fonts. It would be
20832 better to let it be displayed like cursors under X. */
20833 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20834 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20835 !NILP (overlay_arrow_string
)))
20837 /* Overlay arrow in window redisplay is a fringe bitmap. */
20838 if (STRINGP (overlay_arrow_string
))
20840 struct glyph_row
*arrow_row
20841 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20842 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20843 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20844 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20845 struct glyph
*p2
, *end
;
20847 /* Copy the arrow glyphs. */
20848 while (glyph
< arrow_end
)
20851 /* Throw away padding glyphs. */
20853 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20854 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20860 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20865 eassert (INTEGERP (overlay_arrow_string
));
20866 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20868 overlay_arrow_seen
= 1;
20871 /* Highlight trailing whitespace. */
20872 if (!NILP (Vshow_trailing_whitespace
))
20873 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20875 /* Compute pixel dimensions of this line. */
20876 compute_line_metrics (it
);
20878 /* Implementation note: No changes in the glyphs of ROW or in their
20879 faces can be done past this point, because compute_line_metrics
20880 computes ROW's hash value and stores it within the glyph_row
20883 /* Record whether this row ends inside an ellipsis. */
20884 row
->ends_in_ellipsis_p
20885 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20886 && it
->ellipsis_p
);
20888 /* Save fringe bitmaps in this row. */
20889 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20890 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20891 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20892 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20894 it
->left_user_fringe_bitmap
= 0;
20895 it
->left_user_fringe_face_id
= 0;
20896 it
->right_user_fringe_bitmap
= 0;
20897 it
->right_user_fringe_face_id
= 0;
20899 /* Maybe set the cursor. */
20900 cvpos
= it
->w
->cursor
.vpos
;
20902 /* In bidi-reordered rows, keep checking for proper cursor
20903 position even if one has been found already, because buffer
20904 positions in such rows change non-linearly with ROW->VPOS,
20905 when a line is continued. One exception: when we are at ZV,
20906 display cursor on the first suitable glyph row, since all
20907 the empty rows after that also have their position set to ZV. */
20908 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20909 lines' rows is implemented for bidi-reordered rows. */
20911 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20912 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20913 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20914 && cursor_row_p (row
))
20915 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20917 /* Prepare for the next line. This line starts horizontally at (X
20918 HPOS) = (0 0). Vertical positions are incremented. As a
20919 convenience for the caller, IT->glyph_row is set to the next
20921 it
->current_x
= it
->hpos
= 0;
20922 it
->current_y
+= row
->height
;
20923 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20926 /* The next row should by default use the same value of the
20927 reversed_p flag as this one. set_iterator_to_next decides when
20928 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20929 the flag accordingly. */
20930 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20931 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20932 it
->start
= row
->end
;
20933 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20935 #undef RECORD_MAX_MIN_POS
20938 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20939 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20940 doc
: /* Return paragraph direction at point in BUFFER.
20941 Value is either `left-to-right' or `right-to-left'.
20942 If BUFFER is omitted or nil, it defaults to the current buffer.
20944 Paragraph direction determines how the text in the paragraph is displayed.
20945 In left-to-right paragraphs, text begins at the left margin of the window
20946 and the reading direction is generally left to right. In right-to-left
20947 paragraphs, text begins at the right margin and is read from right to left.
20949 See also `bidi-paragraph-direction'. */)
20950 (Lisp_Object buffer
)
20952 struct buffer
*buf
= current_buffer
;
20953 struct buffer
*old
= buf
;
20955 if (! NILP (buffer
))
20957 CHECK_BUFFER (buffer
);
20958 buf
= XBUFFER (buffer
);
20961 if (NILP (BVAR (buf
, bidi_display_reordering
))
20962 || NILP (BVAR (buf
, enable_multibyte_characters
))
20963 /* When we are loading loadup.el, the character property tables
20964 needed for bidi iteration are not yet available. */
20965 || !NILP (Vpurify_flag
))
20966 return Qleft_to_right
;
20967 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20968 return BVAR (buf
, bidi_paragraph_direction
);
20971 /* Determine the direction from buffer text. We could try to
20972 use current_matrix if it is up to date, but this seems fast
20973 enough as it is. */
20974 struct bidi_it itb
;
20975 ptrdiff_t pos
= BUF_PT (buf
);
20976 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20978 void *itb_data
= bidi_shelve_cache ();
20980 set_buffer_temp (buf
);
20981 /* bidi_paragraph_init finds the base direction of the paragraph
20982 by searching forward from paragraph start. We need the base
20983 direction of the current or _previous_ paragraph, so we need
20984 to make sure we are within that paragraph. To that end, find
20985 the previous non-empty line. */
20986 if (pos
>= ZV
&& pos
> BEGV
)
20987 DEC_BOTH (pos
, bytepos
);
20988 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
20989 if (fast_looking_at (trailing_white_space
,
20990 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20992 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20993 || c
== ' ' || c
== '\t' || c
== '\f')
20995 if (bytepos
<= BEGV_BYTE
)
21000 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21003 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21004 itb
.paragraph_dir
= NEUTRAL_DIR
;
21005 itb
.string
.s
= NULL
;
21006 itb
.string
.lstring
= Qnil
;
21007 itb
.string
.bufpos
= 0;
21008 itb
.string
.from_disp_str
= 0;
21009 itb
.string
.unibyte
= 0;
21010 /* We have no window to use here for ignoring window-specific
21011 overlays. Using NULL for window pointer will cause
21012 compute_display_string_pos to use the current buffer. */
21014 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
21015 bidi_unshelve_cache (itb_data
, 0);
21016 set_buffer_temp (old
);
21017 switch (itb
.paragraph_dir
)
21020 return Qleft_to_right
;
21023 return Qright_to_left
;
21031 DEFUN ("bidi-find-overridden-directionality",
21032 Fbidi_find_overridden_directionality
,
21033 Sbidi_find_overridden_directionality
, 2, 3, 0,
21034 doc
: /* Return position between FROM and TO where directionality was overridden.
21036 This function returns the first character position in the specified
21037 region of OBJECT where there is a character whose `bidi-class' property
21038 is `L', but which was forced to display as `R' by a directional
21039 override, and likewise with characters whose `bidi-class' is `R'
21040 or `AL' that were forced to display as `L'.
21042 If no such character is found, the function returns nil.
21044 OBJECT is a Lisp string or buffer to search for overridden
21045 directionality, and defaults to the current buffer if nil or omitted.
21046 OBJECT can also be a window, in which case the function will search
21047 the buffer displayed in that window. Passing the window instead of
21048 a buffer is preferable when the buffer is displayed in some window,
21049 because this function will then be able to correctly account for
21050 window-specific overlays, which can affect the results.
21052 Strong directional characters `L', `R', and `AL' can have their
21053 intrinsic directionality overridden by directional override
21054 control characters RLO \(u+202e) and LRO \(u+202d). See the
21055 function `get-char-code-property' for a way to inquire about
21056 the `bidi-class' property of a character. */)
21057 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21059 struct buffer
*buf
= current_buffer
;
21060 struct buffer
*old
= buf
;
21061 struct window
*w
= NULL
;
21062 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21063 struct bidi_it itb
;
21064 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21067 if (!NILP (object
))
21069 if (BUFFERP (object
))
21070 buf
= XBUFFER (object
);
21071 else if (WINDOWP (object
))
21073 w
= decode_live_window (object
);
21074 buf
= XBUFFER (w
->contents
);
21075 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21078 CHECK_STRING (object
);
21081 if (STRINGP (object
))
21083 /* Characters in unibyte strings are always treated by bidi.c as
21085 if (!STRING_MULTIBYTE (object
)
21086 /* When we are loading loadup.el, the character property
21087 tables needed for bidi iteration are not yet
21089 || !NILP (Vpurify_flag
))
21092 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21093 if (from_pos
>= SCHARS (object
))
21096 /* Set up the bidi iterator. */
21097 itb_data
= bidi_shelve_cache ();
21098 itb
.paragraph_dir
= NEUTRAL_DIR
;
21099 itb
.string
.lstring
= object
;
21100 itb
.string
.s
= NULL
;
21101 itb
.string
.schars
= SCHARS (object
);
21102 itb
.string
.bufpos
= 0;
21103 itb
.string
.from_disp_str
= 0;
21104 itb
.string
.unibyte
= 0;
21106 bidi_init_it (0, 0, frame_window_p
, &itb
);
21110 /* Nothing this fancy can happen in unibyte buffers, or in a
21111 buffer that disabled reordering, or if FROM is at EOB. */
21112 if (NILP (BVAR (buf
, bidi_display_reordering
))
21113 || NILP (BVAR (buf
, enable_multibyte_characters
))
21114 /* When we are loading loadup.el, the character property
21115 tables needed for bidi iteration are not yet
21117 || !NILP (Vpurify_flag
))
21120 set_buffer_temp (buf
);
21121 validate_region (&from
, &to
);
21122 from_pos
= XINT (from
);
21123 to_pos
= XINT (to
);
21124 if (from_pos
>= ZV
)
21127 /* Set up the bidi iterator. */
21128 itb_data
= bidi_shelve_cache ();
21129 from_bpos
= CHAR_TO_BYTE (from_pos
);
21130 if (from_pos
== BEGV
)
21132 itb
.charpos
= BEGV
;
21133 itb
.bytepos
= BEGV_BYTE
;
21135 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21137 itb
.charpos
= from_pos
;
21138 itb
.bytepos
= from_bpos
;
21141 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21143 itb
.paragraph_dir
= NEUTRAL_DIR
;
21144 itb
.string
.s
= NULL
;
21145 itb
.string
.lstring
= Qnil
;
21146 itb
.string
.bufpos
= 0;
21147 itb
.string
.from_disp_str
= 0;
21148 itb
.string
.unibyte
= 0;
21150 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21155 /* For the purposes of this function, the actual base direction of
21156 the paragraph doesn't matter, so just set it to L2R. */
21157 bidi_paragraph_init (L2R
, &itb
, 0);
21158 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21160 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21162 bidi_unshelve_cache (itb_data
, 0);
21163 set_buffer_temp (old
);
21165 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21168 DEFUN ("move-point-visually", Fmove_point_visually
,
21169 Smove_point_visually
, 1, 1, 0,
21170 doc
: /* Move point in the visual order in the specified DIRECTION.
21171 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21174 Value is the new character position of point. */)
21175 (Lisp_Object direction
)
21177 struct window
*w
= XWINDOW (selected_window
);
21178 struct buffer
*b
= XBUFFER (w
->contents
);
21179 struct glyph_row
*row
;
21181 Lisp_Object paragraph_dir
;
21183 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21184 (!(ROW)->continued_p \
21185 && NILP ((GLYPH)->object) \
21186 && (GLYPH)->type == CHAR_GLYPH \
21187 && (GLYPH)->u.ch == ' ' \
21188 && (GLYPH)->charpos >= 0 \
21189 && !(GLYPH)->avoid_cursor_p)
21191 CHECK_NUMBER (direction
);
21192 dir
= XINT (direction
);
21198 /* If current matrix is up-to-date, we can use the information
21199 recorded in the glyphs, at least as long as the goal is on the
21201 if (w
->window_end_valid
21202 && !windows_or_buffers_changed
21204 && !b
->clip_changed
21205 && !b
->prevent_redisplay_optimizations_p
21206 && !window_outdated (w
)
21207 /* We rely below on the cursor coordinates to be up to date, but
21208 we cannot trust them if some command moved point since the
21209 last complete redisplay. */
21210 && w
->last_point
== BUF_PT (b
)
21211 && w
->cursor
.vpos
>= 0
21212 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21213 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21215 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21216 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21217 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21219 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21221 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21223 SET_PT (g
->charpos
);
21224 w
->cursor
.vpos
= -1;
21225 return make_number (PT
);
21227 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21231 if (BUFFERP (gpt
->object
))
21234 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21235 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21237 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21239 else if (BUFFERP (g
->object
))
21240 new_pos
= g
->charpos
;
21244 w
->cursor
.vpos
= -1;
21245 return make_number (PT
);
21247 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21249 /* Glyphs inserted at the end of a non-empty line for
21250 positioning the cursor have zero charpos, so we must
21251 deduce the value of point by other means. */
21252 if (g
->charpos
> 0)
21253 SET_PT (g
->charpos
);
21254 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21256 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21257 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21260 w
->cursor
.vpos
= -1;
21261 return make_number (PT
);
21264 if (g
== e
|| NILP (g
->object
))
21266 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21267 goto simulate_display
;
21268 if (!row
->reversed_p
)
21272 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21273 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21274 goto simulate_display
;
21278 if (row
->reversed_p
&& !row
->continued_p
)
21280 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21281 w
->cursor
.vpos
= -1;
21282 return make_number (PT
);
21284 g
= row
->glyphs
[TEXT_AREA
];
21285 e
= g
+ row
->used
[TEXT_AREA
];
21286 for ( ; g
< e
; g
++)
21288 if (BUFFERP (g
->object
)
21289 /* Empty lines have only one glyph, which stands
21290 for the newline, and whose charpos is the
21291 buffer position of the newline. */
21292 || ROW_GLYPH_NEWLINE_P (row
, g
)
21293 /* When the buffer ends in a newline, the line at
21294 EOB also has one glyph, but its charpos is -1. */
21295 || (row
->ends_at_zv_p
21296 && !row
->reversed_p
21297 && NILP (g
->object
)
21298 && g
->type
== CHAR_GLYPH
21299 && g
->u
.ch
== ' '))
21301 if (g
->charpos
> 0)
21302 SET_PT (g
->charpos
);
21303 else if (!row
->reversed_p
21304 && row
->ends_at_zv_p
21309 w
->cursor
.vpos
= -1;
21310 return make_number (PT
);
21316 if (!row
->reversed_p
&& !row
->continued_p
)
21318 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21319 w
->cursor
.vpos
= -1;
21320 return make_number (PT
);
21322 e
= row
->glyphs
[TEXT_AREA
];
21323 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21324 for ( ; g
>= e
; g
--)
21326 if (BUFFERP (g
->object
)
21327 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21329 /* Empty R2L lines on GUI frames have the buffer
21330 position of the newline stored in the stretch
21332 || g
->type
== STRETCH_GLYPH
21333 || (row
->ends_at_zv_p
21335 && NILP (g
->object
)
21336 && g
->type
== CHAR_GLYPH
21337 && g
->u
.ch
== ' '))
21339 if (g
->charpos
> 0)
21340 SET_PT (g
->charpos
);
21341 else if (row
->reversed_p
21342 && row
->ends_at_zv_p
21347 w
->cursor
.vpos
= -1;
21348 return make_number (PT
);
21357 /* If we wind up here, we failed to move by using the glyphs, so we
21358 need to simulate display instead. */
21361 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21363 paragraph_dir
= Qleft_to_right
;
21364 if (EQ (paragraph_dir
, Qright_to_left
))
21366 if (PT
<= BEGV
&& dir
< 0)
21367 xsignal0 (Qbeginning_of_buffer
);
21368 else if (PT
>= ZV
&& dir
> 0)
21369 xsignal0 (Qend_of_buffer
);
21372 struct text_pos pt
;
21374 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21376 bool overshoot_expected
= false;
21377 bool target_is_eol_p
= false;
21379 /* Setup the arena. */
21380 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21381 start_display (&it
, w
, pt
);
21383 if (it
.cmp_it
.id
< 0
21384 && it
.method
== GET_FROM_STRING
21385 && it
.area
== TEXT_AREA
21386 && it
.string_from_display_prop_p
21387 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21388 overshoot_expected
= true;
21390 /* Find the X coordinate of point. We start from the beginning
21391 of this or previous line to make sure we are before point in
21392 the logical order (since the move_it_* functions can only
21395 reseat_at_previous_visible_line_start (&it
);
21396 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21397 if (IT_CHARPOS (it
) != PT
)
21399 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21400 -1, -1, -1, MOVE_TO_POS
);
21401 /* If we missed point because the character there is
21402 displayed out of a display vector that has more than one
21403 glyph, retry expecting overshoot. */
21404 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21405 && it
.current
.dpvec_index
> 0
21406 && !overshoot_expected
)
21408 overshoot_expected
= true;
21411 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21412 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21414 pt_x
= it
.current_x
;
21416 if (dir
> 0 || overshoot_expected
)
21418 struct glyph_row
*row
= it
.glyph_row
;
21420 /* When point is at beginning of line, we don't have
21421 information about the glyph there loaded into struct
21422 it. Calling get_next_display_element fixes that. */
21424 get_next_display_element (&it
);
21425 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21426 it
.glyph_row
= NULL
;
21427 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21428 it
.glyph_row
= row
;
21429 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21430 it, lest it will become out of sync with it's buffer
21432 it
.current_x
= pt_x
;
21435 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21436 pixel_width
= it
.pixel_width
;
21437 if (overshoot_expected
&& at_eol_p
)
21439 else if (pixel_width
<= 0)
21442 /* If there's a display string (or something similar) at point,
21443 we are actually at the glyph to the left of point, so we need
21444 to correct the X coordinate. */
21445 if (overshoot_expected
)
21448 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21450 pt_x
+= pixel_width
;
21453 /* Compute target X coordinate, either to the left or to the
21454 right of point. On TTY frames, all characters have the same
21455 pixel width of 1, so we can use that. On GUI frames we don't
21456 have an easy way of getting at the pixel width of the
21457 character to the left of point, so we use a different method
21458 of getting to that place. */
21460 target_x
= pt_x
+ pixel_width
;
21462 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21464 /* Target X coordinate could be one line above or below the line
21465 of point, in which case we need to adjust the target X
21466 coordinate. Also, if moving to the left, we need to begin at
21467 the left edge of the point's screen line. */
21472 start_display (&it
, w
, pt
);
21473 reseat_at_previous_visible_line_start (&it
);
21474 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21476 move_it_by_lines (&it
, pt_vpos
);
21480 move_it_by_lines (&it
, -1);
21481 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21482 target_is_eol_p
= true;
21483 /* Under word-wrap, we don't know the x coordinate of
21484 the last character displayed on the previous line,
21485 which immediately precedes the wrap point. To find
21486 out its x coordinate, we try moving to the right
21487 margin of the window, which will stop at the wrap
21488 point, and then reset target_x to point at the
21489 character that precedes the wrap point. This is not
21490 needed on GUI frames, because (see below) there we
21491 move from the left margin one grapheme cluster at a
21492 time, and stop when we hit the wrap point. */
21493 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21495 void *it_data
= NULL
;
21498 SAVE_IT (it2
, it
, it_data
);
21499 move_it_in_display_line_to (&it
, ZV
, target_x
,
21500 MOVE_TO_POS
| MOVE_TO_X
);
21501 /* If we arrived at target_x, that _is_ the last
21502 character on the previous line. */
21503 if (it
.current_x
!= target_x
)
21504 target_x
= it
.current_x
- 1;
21505 RESTORE_IT (&it
, &it2
, it_data
);
21512 || (target_x
>= it
.last_visible_x
21513 && it
.line_wrap
!= TRUNCATE
))
21516 move_it_by_lines (&it
, 0);
21517 move_it_by_lines (&it
, 1);
21522 /* Move to the target X coordinate. */
21523 #ifdef HAVE_WINDOW_SYSTEM
21524 /* On GUI frames, as we don't know the X coordinate of the
21525 character to the left of point, moving point to the left
21526 requires walking, one grapheme cluster at a time, until we
21527 find ourself at a place immediately to the left of the
21528 character at point. */
21529 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21531 struct text_pos new_pos
;
21532 enum move_it_result rc
= MOVE_X_REACHED
;
21534 if (it
.current_x
== 0)
21535 get_next_display_element (&it
);
21536 if (it
.what
== IT_COMPOSITION
)
21538 new_pos
.charpos
= it
.cmp_it
.charpos
;
21539 new_pos
.bytepos
= -1;
21542 new_pos
= it
.current
.pos
;
21544 while (it
.current_x
+ it
.pixel_width
<= target_x
21545 && (rc
== MOVE_X_REACHED
21546 /* Under word-wrap, move_it_in_display_line_to
21547 stops at correct coordinates, but sometimes
21548 returns MOVE_POS_MATCH_OR_ZV. */
21549 || (it
.line_wrap
== WORD_WRAP
21550 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21552 int new_x
= it
.current_x
+ it
.pixel_width
;
21554 /* For composed characters, we want the position of the
21555 first character in the grapheme cluster (usually, the
21556 composition's base character), whereas it.current
21557 might give us the position of the _last_ one, e.g. if
21558 the composition is rendered in reverse due to bidi
21560 if (it
.what
== IT_COMPOSITION
)
21562 new_pos
.charpos
= it
.cmp_it
.charpos
;
21563 new_pos
.bytepos
= -1;
21566 new_pos
= it
.current
.pos
;
21567 if (new_x
== it
.current_x
)
21569 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21570 MOVE_TO_POS
| MOVE_TO_X
);
21571 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21574 /* The previous position we saw in the loop is the one we
21576 if (new_pos
.bytepos
== -1)
21577 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21578 it
.current
.pos
= new_pos
;
21582 if (it
.current_x
!= target_x
)
21583 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21585 /* When lines are truncated, the above loop will stop at the
21586 window edge. But we want to get to the end of line, even if
21587 it is beyond the window edge; automatic hscroll will then
21588 scroll the window to show point as appropriate. */
21589 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21590 && get_next_display_element (&it
))
21592 struct text_pos new_pos
= it
.current
.pos
;
21594 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21596 set_iterator_to_next (&it
, 0);
21597 if (it
.method
== GET_FROM_BUFFER
)
21598 new_pos
= it
.current
.pos
;
21599 if (!get_next_display_element (&it
))
21603 it
.current
.pos
= new_pos
;
21606 /* If we ended up in a display string that covers point, move to
21607 buffer position to the right in the visual order. */
21610 while (IT_CHARPOS (it
) == PT
)
21612 set_iterator_to_next (&it
, 0);
21613 if (!get_next_display_element (&it
))
21618 /* Move point to that position. */
21619 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21622 return make_number (PT
);
21624 #undef ROW_GLYPH_NEWLINE_P
21627 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21628 Sbidi_resolved_levels
, 0, 1, 0,
21629 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21631 The resolved levels are produced by the Emacs bidi reordering engine
21632 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21633 read the Unicode Standard Annex 9 (UAX#9) for background information
21634 about these levels.
21636 VPOS is the zero-based number of the current window's screen line
21637 for which to produce the resolved levels. If VPOS is nil or omitted,
21638 it defaults to the screen line of point. If the window displays a
21639 header line, VPOS of zero will report on the header line, and first
21640 line of text in the window will have VPOS of 1.
21642 Value is an array of resolved levels, indexed by glyph number.
21643 Glyphs are numbered from zero starting from the beginning of the
21644 screen line, i.e. the left edge of the window for left-to-right lines
21645 and from the right edge for right-to-left lines. The resolved levels
21646 are produced only for the window's text area; text in display margins
21649 If the selected window's display is not up-to-date, or if the specified
21650 screen line does not display text, this function returns nil. It is
21651 highly recommended to bind this function to some simple key, like F8,
21652 in order to avoid these problems.
21654 This function exists mainly for testing the correctness of the
21655 Emacs UBA implementation, in particular with the test suite. */)
21658 struct window
*w
= XWINDOW (selected_window
);
21659 struct buffer
*b
= XBUFFER (w
->contents
);
21661 struct glyph_row
*row
;
21665 int d1
, d2
, d3
, d4
, d5
;
21667 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21671 CHECK_NUMBER_COERCE_MARKER (vpos
);
21672 nrow
= XINT (vpos
);
21675 /* We require up-to-date glyph matrix for this window. */
21676 if (w
->window_end_valid
21677 && !windows_or_buffers_changed
21679 && !b
->clip_changed
21680 && !b
->prevent_redisplay_optimizations_p
21681 && !window_outdated (w
)
21683 && nrow
< w
->current_matrix
->nrows
21684 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21685 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21687 struct glyph
*g
, *e
, *g1
;
21689 Lisp_Object levels
;
21691 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21693 g
= g1
= row
->glyphs
[TEXT_AREA
];
21694 e
= g
+ row
->used
[TEXT_AREA
];
21696 /* Skip over glyphs at the start of the row that was
21697 generated by redisplay for its own needs. */
21699 && NILP (g
->object
)
21704 /* Count the "interesting" glyphs in this row. */
21705 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21708 /* Create and fill the array. */
21709 levels
= make_uninit_vector (nglyphs
);
21710 for (i
= 0; g1
< g
; i
++, g1
++)
21711 ASET (levels
, i
, make_number (g1
->resolved_level
));
21713 else /* Right-to-left glyph row. */
21715 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21716 e
= row
->glyphs
[TEXT_AREA
] - 1;
21718 && NILP (g
->object
)
21722 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21724 levels
= make_uninit_vector (nglyphs
);
21725 for (i
= 0; g1
> g
; i
++, g1
--)
21726 ASET (levels
, i
, make_number (g1
->resolved_level
));
21736 /***********************************************************************
21738 ***********************************************************************/
21740 /* Redisplay the menu bar in the frame for window W.
21742 The menu bar of X frames that don't have X toolkit support is
21743 displayed in a special window W->frame->menu_bar_window.
21745 The menu bar of terminal frames is treated specially as far as
21746 glyph matrices are concerned. Menu bar lines are not part of
21747 windows, so the update is done directly on the frame matrix rows
21748 for the menu bar. */
21751 display_menu_bar (struct window
*w
)
21753 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21758 /* Don't do all this for graphical frames. */
21760 if (FRAME_W32_P (f
))
21763 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21769 if (FRAME_NS_P (f
))
21771 #endif /* HAVE_NS */
21773 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21774 eassert (!FRAME_WINDOW_P (f
));
21775 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21776 it
.first_visible_x
= 0;
21777 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21778 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21779 if (FRAME_WINDOW_P (f
))
21781 /* Menu bar lines are displayed in the desired matrix of the
21782 dummy window menu_bar_window. */
21783 struct window
*menu_w
;
21784 menu_w
= XWINDOW (f
->menu_bar_window
);
21785 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21787 it
.first_visible_x
= 0;
21788 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21791 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21793 /* This is a TTY frame, i.e. character hpos/vpos are used as
21795 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21797 it
.first_visible_x
= 0;
21798 it
.last_visible_x
= FRAME_COLS (f
);
21801 /* FIXME: This should be controlled by a user option. See the
21802 comments in redisplay_tool_bar and display_mode_line about
21804 it
.paragraph_embedding
= L2R
;
21806 /* Clear all rows of the menu bar. */
21807 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21809 struct glyph_row
*row
= it
.glyph_row
+ i
;
21810 clear_glyph_row (row
);
21811 row
->enabled_p
= true;
21812 row
->full_width_p
= 1;
21813 row
->reversed_p
= false;
21816 /* Display all items of the menu bar. */
21817 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21818 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21820 Lisp_Object string
;
21822 /* Stop at nil string. */
21823 string
= AREF (items
, i
+ 1);
21827 /* Remember where item was displayed. */
21828 ASET (items
, i
+ 3, make_number (it
.hpos
));
21830 /* Display the item, pad with one space. */
21831 if (it
.current_x
< it
.last_visible_x
)
21832 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21833 SCHARS (string
) + 1, 0, 0, -1);
21836 /* Fill out the line with spaces. */
21837 if (it
.current_x
< it
.last_visible_x
)
21838 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21840 /* Compute the total height of the lines. */
21841 compute_line_metrics (&it
);
21844 /* Deep copy of a glyph row, including the glyphs. */
21846 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21848 struct glyph
*pointers
[1 + LAST_AREA
];
21849 int to_used
= to
->used
[TEXT_AREA
];
21851 /* Save glyph pointers of TO. */
21852 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21854 /* Do a structure assignment. */
21857 /* Restore original glyph pointers of TO. */
21858 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21860 /* Copy the glyphs. */
21861 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21862 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21864 /* If we filled only part of the TO row, fill the rest with
21865 space_glyph (which will display as empty space). */
21866 if (to_used
> from
->used
[TEXT_AREA
])
21867 fill_up_frame_row_with_spaces (to
, to_used
);
21870 /* Display one menu item on a TTY, by overwriting the glyphs in the
21871 frame F's desired glyph matrix with glyphs produced from the menu
21872 item text. Called from term.c to display TTY drop-down menus one
21875 ITEM_TEXT is the menu item text as a C string.
21877 FACE_ID is the face ID to be used for this menu item. FACE_ID
21878 could specify one of 3 faces: a face for an enabled item, a face
21879 for a disabled item, or a face for a selected item.
21881 X and Y are coordinates of the first glyph in the frame's desired
21882 matrix to be overwritten by the menu item. Since this is a TTY, Y
21883 is the zero-based number of the glyph row and X is the zero-based
21884 glyph number in the row, starting from left, where to start
21885 displaying the item.
21887 SUBMENU non-zero means this menu item drops down a submenu, which
21888 should be indicated by displaying a proper visual cue after the
21892 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21893 int x
, int y
, int submenu
)
21896 struct frame
*f
= SELECTED_FRAME ();
21897 struct window
*w
= XWINDOW (f
->selected_window
);
21898 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21899 struct glyph_row
*row
;
21900 size_t item_len
= strlen (item_text
);
21902 eassert (FRAME_TERMCAP_P (f
));
21904 /* Don't write beyond the matrix's last row. This can happen for
21905 TTY screens that are not high enough to show the entire menu.
21906 (This is actually a bit of defensive programming, as
21907 tty_menu_display already limits the number of menu items to one
21908 less than the number of screen lines.) */
21909 if (y
>= f
->desired_matrix
->nrows
)
21912 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21913 it
.first_visible_x
= 0;
21914 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21915 row
= it
.glyph_row
;
21916 /* Start with the row contents from the current matrix. */
21917 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21918 saved_width
= row
->full_width_p
;
21919 row
->full_width_p
= 1;
21920 saved_reversed
= row
->reversed_p
;
21921 row
->reversed_p
= 0;
21922 row
->enabled_p
= true;
21924 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21926 eassert (x
< f
->desired_matrix
->matrix_w
);
21927 it
.current_x
= it
.hpos
= x
;
21928 it
.current_y
= it
.vpos
= y
;
21929 saved_used
= row
->used
[TEXT_AREA
];
21930 saved_truncated
= row
->truncated_on_right_p
;
21931 row
->used
[TEXT_AREA
] = x
;
21932 it
.face_id
= face_id
;
21933 it
.line_wrap
= TRUNCATE
;
21935 /* FIXME: This should be controlled by a user option. See the
21936 comments in redisplay_tool_bar and display_mode_line about this.
21937 Also, if paragraph_embedding could ever be R2L, changes will be
21938 needed to avoid shifting to the right the row characters in
21939 term.c:append_glyph. */
21940 it
.paragraph_embedding
= L2R
;
21942 /* Pad with a space on the left. */
21943 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21945 /* Display the menu item, pad with spaces to WIDTH. */
21948 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21949 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21951 /* Indicate with " >" that there's a submenu. */
21952 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21953 FRAME_COLS (f
) - 1, -1);
21956 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21957 width
, 0, FRAME_COLS (f
) - 1, -1);
21959 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21960 row
->truncated_on_right_p
= saved_truncated
;
21961 row
->hash
= row_hash (row
);
21962 row
->full_width_p
= saved_width
;
21963 row
->reversed_p
= saved_reversed
;
21966 /***********************************************************************
21968 ***********************************************************************/
21970 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21971 FORCE is non-zero, redisplay mode lines unconditionally.
21972 Otherwise, redisplay only mode lines that are garbaged. Value is
21973 the number of windows whose mode lines were redisplayed. */
21976 redisplay_mode_lines (Lisp_Object window
, bool force
)
21980 while (!NILP (window
))
21982 struct window
*w
= XWINDOW (window
);
21984 if (WINDOWP (w
->contents
))
21985 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21987 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21988 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21990 struct text_pos lpoint
;
21991 struct buffer
*old
= current_buffer
;
21993 /* Set the window's buffer for the mode line display. */
21994 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21995 set_buffer_internal_1 (XBUFFER (w
->contents
));
21997 /* Point refers normally to the selected window. For any
21998 other window, set up appropriate value. */
21999 if (!EQ (window
, selected_window
))
22001 struct text_pos pt
;
22003 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22004 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22007 /* Display mode lines. */
22008 clear_glyph_matrix (w
->desired_matrix
);
22009 if (display_mode_lines (w
))
22012 /* Restore old settings. */
22013 set_buffer_internal_1 (old
);
22014 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22024 /* Display the mode and/or header line of window W. Value is the
22025 sum number of mode lines and header lines displayed. */
22028 display_mode_lines (struct window
*w
)
22030 Lisp_Object old_selected_window
= selected_window
;
22031 Lisp_Object old_selected_frame
= selected_frame
;
22032 Lisp_Object new_frame
= w
->frame
;
22033 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22036 selected_frame
= new_frame
;
22037 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22038 or window's point, then we'd need select_window_1 here as well. */
22039 XSETWINDOW (selected_window
, w
);
22040 XFRAME (new_frame
)->selected_window
= selected_window
;
22042 /* These will be set while the mode line specs are processed. */
22043 line_number_displayed
= 0;
22044 w
->column_number_displayed
= -1;
22046 if (WINDOW_WANTS_MODELINE_P (w
))
22048 struct window
*sel_w
= XWINDOW (old_selected_window
);
22050 /* Select mode line face based on the real selected window. */
22051 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22052 BVAR (current_buffer
, mode_line_format
));
22056 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22058 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22059 BVAR (current_buffer
, header_line_format
));
22063 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22064 selected_frame
= old_selected_frame
;
22065 selected_window
= old_selected_window
;
22067 w
->must_be_updated_p
= true;
22072 /* Display mode or header line of window W. FACE_ID specifies which
22073 line to display; it is either MODE_LINE_FACE_ID or
22074 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22075 display. Value is the pixel height of the mode/header line
22079 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22083 ptrdiff_t count
= SPECPDL_INDEX ();
22085 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22086 /* Don't extend on a previously drawn mode-line.
22087 This may happen if called from pos_visible_p. */
22088 it
.glyph_row
->enabled_p
= false;
22089 prepare_desired_row (w
, it
.glyph_row
, true);
22091 it
.glyph_row
->mode_line_p
= 1;
22093 /* FIXME: This should be controlled by a user option. But
22094 supporting such an option is not trivial, since the mode line is
22095 made up of many separate strings. */
22096 it
.paragraph_embedding
= L2R
;
22098 record_unwind_protect (unwind_format_mode_line
,
22099 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
22101 mode_line_target
= MODE_LINE_DISPLAY
;
22103 /* Temporarily make frame's keyboard the current kboard so that
22104 kboard-local variables in the mode_line_format will get the right
22106 push_kboard (FRAME_KBOARD (it
.f
));
22107 record_unwind_save_match_data ();
22108 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22111 unbind_to (count
, Qnil
);
22113 /* Fill up with spaces. */
22114 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22116 compute_line_metrics (&it
);
22117 it
.glyph_row
->full_width_p
= 1;
22118 it
.glyph_row
->continued_p
= 0;
22119 it
.glyph_row
->truncated_on_left_p
= 0;
22120 it
.glyph_row
->truncated_on_right_p
= 0;
22122 /* Make a 3D mode-line have a shadow at its right end. */
22123 face
= FACE_FROM_ID (it
.f
, face_id
);
22124 extend_face_to_end_of_line (&it
);
22125 if (face
->box
!= FACE_NO_BOX
)
22127 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22128 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22129 last
->right_box_line_p
= 1;
22132 return it
.glyph_row
->height
;
22135 /* Move element ELT in LIST to the front of LIST.
22136 Return the updated list. */
22139 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22141 register Lisp_Object tail
, prev
;
22142 register Lisp_Object tem
;
22146 while (CONSP (tail
))
22152 /* Splice out the link TAIL. */
22154 list
= XCDR (tail
);
22156 Fsetcdr (prev
, XCDR (tail
));
22158 /* Now make it the first. */
22159 Fsetcdr (tail
, list
);
22164 tail
= XCDR (tail
);
22168 /* Not found--return unchanged LIST. */
22172 /* Contribute ELT to the mode line for window IT->w. How it
22173 translates into text depends on its data type.
22175 IT describes the display environment in which we display, as usual.
22177 DEPTH is the depth in recursion. It is used to prevent
22178 infinite recursion here.
22180 FIELD_WIDTH is the number of characters the display of ELT should
22181 occupy in the mode line, and PRECISION is the maximum number of
22182 characters to display from ELT's representation. See
22183 display_string for details.
22185 Returns the hpos of the end of the text generated by ELT.
22187 PROPS is a property list to add to any string we encounter.
22189 If RISKY is nonzero, remove (disregard) any properties in any string
22190 we encounter, and ignore :eval and :propertize.
22192 The global variable `mode_line_target' determines whether the
22193 output is passed to `store_mode_line_noprop',
22194 `store_mode_line_string', or `display_string'. */
22197 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22198 Lisp_Object elt
, Lisp_Object props
, int risky
)
22200 int n
= 0, field
, prec
;
22205 elt
= build_string ("*too-deep*");
22209 switch (XTYPE (elt
))
22213 /* A string: output it and check for %-constructs within it. */
22215 ptrdiff_t offset
= 0;
22217 if (SCHARS (elt
) > 0
22218 && (!NILP (props
) || risky
))
22220 Lisp_Object oprops
, aelt
;
22221 oprops
= Ftext_properties_at (make_number (0), elt
);
22223 /* If the starting string's properties are not what
22224 we want, translate the string. Also, if the string
22225 is risky, do that anyway. */
22227 if (NILP (Fequal (props
, oprops
)) || risky
)
22229 /* If the starting string has properties,
22230 merge the specified ones onto the existing ones. */
22231 if (! NILP (oprops
) && !risky
)
22235 oprops
= Fcopy_sequence (oprops
);
22237 while (CONSP (tem
))
22239 oprops
= Fplist_put (oprops
, XCAR (tem
),
22240 XCAR (XCDR (tem
)));
22241 tem
= XCDR (XCDR (tem
));
22246 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22247 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22249 /* AELT is what we want. Move it to the front
22250 without consing. */
22252 mode_line_proptrans_alist
22253 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22259 /* If AELT has the wrong props, it is useless.
22260 so get rid of it. */
22262 mode_line_proptrans_alist
22263 = Fdelq (aelt
, mode_line_proptrans_alist
);
22265 elt
= Fcopy_sequence (elt
);
22266 Fset_text_properties (make_number (0), Flength (elt
),
22268 /* Add this item to mode_line_proptrans_alist. */
22269 mode_line_proptrans_alist
22270 = Fcons (Fcons (elt
, props
),
22271 mode_line_proptrans_alist
);
22272 /* Truncate mode_line_proptrans_alist
22273 to at most 50 elements. */
22274 tem
= Fnthcdr (make_number (50),
22275 mode_line_proptrans_alist
);
22277 XSETCDR (tem
, Qnil
);
22286 prec
= precision
- n
;
22287 switch (mode_line_target
)
22289 case MODE_LINE_NOPROP
:
22290 case MODE_LINE_TITLE
:
22291 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22293 case MODE_LINE_STRING
:
22294 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
22296 case MODE_LINE_DISPLAY
:
22297 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22298 0, prec
, 0, STRING_MULTIBYTE (elt
));
22305 /* Handle the non-literal case. */
22307 while ((precision
<= 0 || n
< precision
)
22308 && SREF (elt
, offset
) != 0
22309 && (mode_line_target
!= MODE_LINE_DISPLAY
22310 || it
->current_x
< it
->last_visible_x
))
22312 ptrdiff_t last_offset
= offset
;
22314 /* Advance to end of string or next format specifier. */
22315 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22318 if (offset
- 1 != last_offset
)
22320 ptrdiff_t nchars
, nbytes
;
22322 /* Output to end of string or up to '%'. Field width
22323 is length of string. Don't output more than
22324 PRECISION allows us. */
22327 prec
= c_string_width (SDATA (elt
) + last_offset
,
22328 offset
- last_offset
, precision
- n
,
22331 switch (mode_line_target
)
22333 case MODE_LINE_NOPROP
:
22334 case MODE_LINE_TITLE
:
22335 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22337 case MODE_LINE_STRING
:
22339 ptrdiff_t bytepos
= last_offset
;
22340 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22341 ptrdiff_t endpos
= (precision
<= 0
22342 ? string_byte_to_char (elt
, offset
)
22343 : charpos
+ nchars
);
22345 n
+= store_mode_line_string (NULL
,
22346 Fsubstring (elt
, make_number (charpos
),
22347 make_number (endpos
)),
22351 case MODE_LINE_DISPLAY
:
22353 ptrdiff_t bytepos
= last_offset
;
22354 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22356 if (precision
<= 0)
22357 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22358 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22360 STRING_MULTIBYTE (elt
));
22365 else /* c == '%' */
22367 ptrdiff_t percent_position
= offset
;
22369 /* Get the specified minimum width. Zero means
22372 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22373 field
= field
* 10 + c
- '0';
22375 /* Don't pad beyond the total padding allowed. */
22376 if (field_width
- n
> 0 && field
> field_width
- n
)
22377 field
= field_width
- n
;
22379 /* Note that either PRECISION <= 0 or N < PRECISION. */
22380 prec
= precision
- n
;
22383 n
+= display_mode_element (it
, depth
, field
, prec
,
22384 Vglobal_mode_string
, props
,
22389 ptrdiff_t bytepos
, charpos
;
22391 Lisp_Object string
;
22393 bytepos
= percent_position
;
22394 charpos
= (STRING_MULTIBYTE (elt
)
22395 ? string_byte_to_char (elt
, bytepos
)
22397 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22398 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22400 switch (mode_line_target
)
22402 case MODE_LINE_NOPROP
:
22403 case MODE_LINE_TITLE
:
22404 n
+= store_mode_line_noprop (spec
, field
, prec
);
22406 case MODE_LINE_STRING
:
22408 Lisp_Object tem
= build_string (spec
);
22409 props
= Ftext_properties_at (make_number (charpos
), elt
);
22410 /* Should only keep face property in props */
22411 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22414 case MODE_LINE_DISPLAY
:
22416 int nglyphs_before
, nwritten
;
22418 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22419 nwritten
= display_string (spec
, string
, elt
,
22424 /* Assign to the glyphs written above the
22425 string where the `%x' came from, position
22429 struct glyph
*glyph
22430 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22434 for (i
= 0; i
< nwritten
; ++i
)
22436 glyph
[i
].object
= elt
;
22437 glyph
[i
].charpos
= charpos
;
22454 /* A symbol: process the value of the symbol recursively
22455 as if it appeared here directly. Avoid error if symbol void.
22456 Special case: if value of symbol is a string, output the string
22459 register Lisp_Object tem
;
22461 /* If the variable is not marked as risky to set
22462 then its contents are risky to use. */
22463 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22466 tem
= Fboundp (elt
);
22469 tem
= Fsymbol_value (elt
);
22470 /* If value is a string, output that string literally:
22471 don't check for % within it. */
22475 if (!EQ (tem
, elt
))
22477 /* Give up right away for nil or t. */
22487 register Lisp_Object car
, tem
;
22489 /* A cons cell: five distinct cases.
22490 If first element is :eval or :propertize, do something special.
22491 If first element is a string or a cons, process all the elements
22492 and effectively concatenate them.
22493 If first element is a negative number, truncate displaying cdr to
22494 at most that many characters. If positive, pad (with spaces)
22495 to at least that many characters.
22496 If first element is a symbol, process the cadr or caddr recursively
22497 according to whether the symbol's value is non-nil or nil. */
22499 if (EQ (car
, QCeval
))
22501 /* An element of the form (:eval FORM) means evaluate FORM
22502 and use the result as mode line elements. */
22507 if (CONSP (XCDR (elt
)))
22510 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22511 n
+= display_mode_element (it
, depth
, field_width
- n
,
22512 precision
- n
, spec
, props
,
22516 else if (EQ (car
, QCpropertize
))
22518 /* An element of the form (:propertize ELT PROPS...)
22519 means display ELT but applying properties PROPS. */
22524 if (CONSP (XCDR (elt
)))
22525 n
+= display_mode_element (it
, depth
, field_width
- n
,
22526 precision
- n
, XCAR (XCDR (elt
)),
22527 XCDR (XCDR (elt
)), risky
);
22529 else if (SYMBOLP (car
))
22531 tem
= Fboundp (car
);
22535 /* elt is now the cdr, and we know it is a cons cell.
22536 Use its car if CAR has a non-nil value. */
22539 tem
= Fsymbol_value (car
);
22546 /* Symbol's value is nil (or symbol is unbound)
22547 Get the cddr of the original list
22548 and if possible find the caddr and use that. */
22552 else if (!CONSP (elt
))
22557 else if (INTEGERP (car
))
22559 register int lim
= XINT (car
);
22563 /* Negative int means reduce maximum width. */
22564 if (precision
<= 0)
22567 precision
= min (precision
, -lim
);
22571 /* Padding specified. Don't let it be more than
22572 current maximum. */
22574 lim
= min (precision
, lim
);
22576 /* If that's more padding than already wanted, queue it.
22577 But don't reduce padding already specified even if
22578 that is beyond the current truncation point. */
22579 field_width
= max (lim
, field_width
);
22583 else if (STRINGP (car
) || CONSP (car
))
22585 Lisp_Object halftail
= elt
;
22589 && (precision
<= 0 || n
< precision
))
22591 n
+= display_mode_element (it
, depth
,
22592 /* Do padding only after the last
22593 element in the list. */
22594 (! CONSP (XCDR (elt
))
22597 precision
- n
, XCAR (elt
),
22601 if ((len
& 1) == 0)
22602 halftail
= XCDR (halftail
);
22603 /* Check for cycle. */
22604 if (EQ (halftail
, elt
))
22613 elt
= build_string ("*invalid*");
22617 /* Pad to FIELD_WIDTH. */
22618 if (field_width
> 0 && n
< field_width
)
22620 switch (mode_line_target
)
22622 case MODE_LINE_NOPROP
:
22623 case MODE_LINE_TITLE
:
22624 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22626 case MODE_LINE_STRING
:
22627 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22629 case MODE_LINE_DISPLAY
:
22630 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22639 /* Store a mode-line string element in mode_line_string_list.
22641 If STRING is non-null, display that C string. Otherwise, the Lisp
22642 string LISP_STRING is displayed.
22644 FIELD_WIDTH is the minimum number of output glyphs to produce.
22645 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22646 with spaces. FIELD_WIDTH <= 0 means don't pad.
22648 PRECISION is the maximum number of characters to output from
22649 STRING. PRECISION <= 0 means don't truncate the string.
22651 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22652 properties to the string.
22654 PROPS are the properties to add to the string.
22655 The mode_line_string_face face property is always added to the string.
22659 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22660 int field_width
, int precision
, Lisp_Object props
)
22665 if (string
!= NULL
)
22667 len
= strlen (string
);
22668 if (precision
> 0 && len
> precision
)
22670 lisp_string
= make_string (string
, len
);
22672 props
= mode_line_string_face_prop
;
22673 else if (!NILP (mode_line_string_face
))
22675 Lisp_Object face
= Fplist_get (props
, Qface
);
22676 props
= Fcopy_sequence (props
);
22678 face
= mode_line_string_face
;
22680 face
= list2 (face
, mode_line_string_face
);
22681 props
= Fplist_put (props
, Qface
, face
);
22683 Fadd_text_properties (make_number (0), make_number (len
),
22684 props
, lisp_string
);
22688 len
= XFASTINT (Flength (lisp_string
));
22689 if (precision
> 0 && len
> precision
)
22692 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22695 if (!NILP (mode_line_string_face
))
22699 props
= Ftext_properties_at (make_number (0), lisp_string
);
22700 face
= Fplist_get (props
, Qface
);
22702 face
= mode_line_string_face
;
22704 face
= list2 (face
, mode_line_string_face
);
22705 props
= list2 (Qface
, face
);
22707 lisp_string
= Fcopy_sequence (lisp_string
);
22710 Fadd_text_properties (make_number (0), make_number (len
),
22711 props
, lisp_string
);
22716 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22720 if (field_width
> len
)
22722 field_width
-= len
;
22723 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22725 Fadd_text_properties (make_number (0), make_number (field_width
),
22726 props
, lisp_string
);
22727 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22735 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22737 doc
: /* Format a string out of a mode line format specification.
22738 First arg FORMAT specifies the mode line format (see `mode-line-format'
22739 for details) to use.
22741 By default, the format is evaluated for the currently selected window.
22743 Optional second arg FACE specifies the face property to put on all
22744 characters for which no face is specified. The value nil means the
22745 default face. The value t means whatever face the window's mode line
22746 currently uses (either `mode-line' or `mode-line-inactive',
22747 depending on whether the window is the selected window or not).
22748 An integer value means the value string has no text
22751 Optional third and fourth args WINDOW and BUFFER specify the window
22752 and buffer to use as the context for the formatting (defaults
22753 are the selected window and the WINDOW's buffer). */)
22754 (Lisp_Object format
, Lisp_Object face
,
22755 Lisp_Object window
, Lisp_Object buffer
)
22760 struct buffer
*old_buffer
= NULL
;
22762 int no_props
= INTEGERP (face
);
22763 ptrdiff_t count
= SPECPDL_INDEX ();
22765 int string_start
= 0;
22767 w
= decode_any_window (window
);
22768 XSETWINDOW (window
, w
);
22771 buffer
= w
->contents
;
22772 CHECK_BUFFER (buffer
);
22774 /* Make formatting the modeline a non-op when noninteractive, otherwise
22775 there will be problems later caused by a partially initialized frame. */
22776 if (NILP (format
) || noninteractive
)
22777 return empty_unibyte_string
;
22782 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22783 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22784 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22785 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22786 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22787 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22788 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22791 old_buffer
= current_buffer
;
22793 /* Save things including mode_line_proptrans_alist,
22794 and set that to nil so that we don't alter the outer value. */
22795 record_unwind_protect (unwind_format_mode_line
,
22796 format_mode_line_unwind_data
22797 (XFRAME (WINDOW_FRAME (w
)),
22798 old_buffer
, selected_window
, 1));
22799 mode_line_proptrans_alist
= Qnil
;
22801 Fselect_window (window
, Qt
);
22802 set_buffer_internal_1 (XBUFFER (buffer
));
22804 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22808 mode_line_target
= MODE_LINE_NOPROP
;
22809 mode_line_string_face_prop
= Qnil
;
22810 mode_line_string_list
= Qnil
;
22811 string_start
= MODE_LINE_NOPROP_LEN (0);
22815 mode_line_target
= MODE_LINE_STRING
;
22816 mode_line_string_list
= Qnil
;
22817 mode_line_string_face
= face
;
22818 mode_line_string_face_prop
22819 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22822 push_kboard (FRAME_KBOARD (it
.f
));
22823 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22828 len
= MODE_LINE_NOPROP_LEN (string_start
);
22829 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22833 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22834 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22835 empty_unibyte_string
);
22838 unbind_to (count
, Qnil
);
22842 /* Write a null-terminated, right justified decimal representation of
22843 the positive integer D to BUF using a minimal field width WIDTH. */
22846 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22848 register char *p
= buf
;
22856 *p
++ = d
% 10 + '0';
22861 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22872 /* Write a null-terminated, right justified decimal and "human
22873 readable" representation of the nonnegative integer D to BUF using
22874 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22876 static const char power_letter
[] =
22890 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22892 /* We aim to represent the nonnegative integer D as
22893 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22894 ptrdiff_t quotient
= d
;
22896 /* -1 means: do not use TENTHS. */
22900 /* Length of QUOTIENT.TENTHS as a string. */
22906 if (quotient
>= 1000)
22908 /* Scale to the appropriate EXPONENT. */
22911 remainder
= quotient
% 1000;
22915 while (quotient
>= 1000);
22917 /* Round to nearest and decide whether to use TENTHS or not. */
22920 tenths
= remainder
/ 100;
22921 if (remainder
% 100 >= 50)
22928 if (quotient
== 10)
22936 if (remainder
>= 500)
22938 if (quotient
< 999)
22949 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22950 if (tenths
== -1 && quotient
<= 99)
22957 p
= psuffix
= buf
+ max (width
, length
);
22959 /* Print EXPONENT. */
22960 *psuffix
++ = power_letter
[exponent
];
22963 /* Print TENTHS. */
22966 *--p
= '0' + tenths
;
22970 /* Print QUOTIENT. */
22973 int digit
= quotient
% 10;
22974 *--p
= '0' + digit
;
22976 while ((quotient
/= 10) != 0);
22978 /* Print leading spaces. */
22983 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22984 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22985 type of CODING_SYSTEM. Return updated pointer into BUF. */
22987 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22990 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22993 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22994 const unsigned char *eol_str
;
22996 /* The EOL conversion we are using. */
22997 Lisp_Object eoltype
;
22999 val
= CODING_SYSTEM_SPEC (coding_system
);
23002 if (!VECTORP (val
)) /* Not yet decided. */
23004 *buf
++ = multibyte
? '-' : ' ';
23006 eoltype
= eol_mnemonic_undecided
;
23007 /* Don't mention EOL conversion if it isn't decided. */
23012 Lisp_Object eolvalue
;
23014 attrs
= AREF (val
, 0);
23015 eolvalue
= AREF (val
, 2);
23018 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23023 /* The EOL conversion that is normal on this system. */
23025 if (NILP (eolvalue
)) /* Not yet decided. */
23026 eoltype
= eol_mnemonic_undecided
;
23027 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23028 eoltype
= eol_mnemonic_undecided
;
23029 else /* eolvalue is Qunix, Qdos, or Qmac. */
23030 eoltype
= (EQ (eolvalue
, Qunix
)
23031 ? eol_mnemonic_unix
23032 : (EQ (eolvalue
, Qdos
) == 1
23033 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
23039 /* Mention the EOL conversion if it is not the usual one. */
23040 if (STRINGP (eoltype
))
23042 eol_str
= SDATA (eoltype
);
23043 eol_str_len
= SBYTES (eoltype
);
23045 else if (CHARACTERP (eoltype
))
23047 int c
= XFASTINT (eoltype
);
23048 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23052 eol_str
= invalid_eol_type
;
23053 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23055 memcpy (buf
, eol_str
, eol_str_len
);
23056 buf
+= eol_str_len
;
23062 /* Return a string for the output of a mode line %-spec for window W,
23063 generated by character C. FIELD_WIDTH > 0 means pad the string
23064 returned with spaces to that value. Return a Lisp string in
23065 *STRING if the resulting string is taken from that Lisp string.
23067 Note we operate on the current buffer for most purposes. */
23069 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23071 static const char *
23072 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23073 Lisp_Object
*string
)
23076 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23077 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23078 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23079 produce strings from numerical values, so limit preposterously
23080 large values of FIELD_WIDTH to avoid overrunning the buffer's
23081 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23082 bytes plus the terminating null. */
23083 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23084 struct buffer
*b
= current_buffer
;
23092 if (!NILP (BVAR (b
, read_only
)))
23094 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23099 /* This differs from %* only for a modified read-only buffer. */
23100 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23102 if (!NILP (BVAR (b
, read_only
)))
23107 /* This differs from %* in ignoring read-only-ness. */
23108 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23120 if (command_loop_level
> 5)
23122 p
= decode_mode_spec_buf
;
23123 for (i
= 0; i
< command_loop_level
; i
++)
23126 return decode_mode_spec_buf
;
23134 if (command_loop_level
> 5)
23136 p
= decode_mode_spec_buf
;
23137 for (i
= 0; i
< command_loop_level
; i
++)
23140 return decode_mode_spec_buf
;
23147 /* Let lots_of_dashes be a string of infinite length. */
23148 if (mode_line_target
== MODE_LINE_NOPROP
23149 || mode_line_target
== MODE_LINE_STRING
)
23151 if (field_width
<= 0
23152 || field_width
> sizeof (lots_of_dashes
))
23154 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23155 decode_mode_spec_buf
[i
] = '-';
23156 decode_mode_spec_buf
[i
] = '\0';
23157 return decode_mode_spec_buf
;
23160 return lots_of_dashes
;
23164 obj
= BVAR (b
, name
);
23168 /* %c and %l are ignored in `frame-title-format'.
23169 (In redisplay_internal, the frame title is drawn _before_ the
23170 windows are updated, so the stuff which depends on actual
23171 window contents (such as %l) may fail to render properly, or
23172 even crash emacs.) */
23173 if (mode_line_target
== MODE_LINE_TITLE
)
23177 ptrdiff_t col
= current_column ();
23178 w
->column_number_displayed
= col
;
23179 pint2str (decode_mode_spec_buf
, width
, col
);
23180 return decode_mode_spec_buf
;
23184 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23186 if (NILP (Vmemory_full
))
23189 return "!MEM FULL! ";
23196 /* %F displays the frame name. */
23197 if (!NILP (f
->title
))
23198 return SSDATA (f
->title
);
23199 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23200 return SSDATA (f
->name
);
23204 obj
= BVAR (b
, filename
);
23209 ptrdiff_t size
= ZV
- BEGV
;
23210 pint2str (decode_mode_spec_buf
, width
, size
);
23211 return decode_mode_spec_buf
;
23216 ptrdiff_t size
= ZV
- BEGV
;
23217 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23218 return decode_mode_spec_buf
;
23223 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23224 ptrdiff_t topline
, nlines
, height
;
23227 /* %c and %l are ignored in `frame-title-format'. */
23228 if (mode_line_target
== MODE_LINE_TITLE
)
23231 startpos
= marker_position (w
->start
);
23232 startpos_byte
= marker_byte_position (w
->start
);
23233 height
= WINDOW_TOTAL_LINES (w
);
23235 /* If we decided that this buffer isn't suitable for line numbers,
23236 don't forget that too fast. */
23237 if (w
->base_line_pos
== -1)
23240 /* If the buffer is very big, don't waste time. */
23241 if (INTEGERP (Vline_number_display_limit
)
23242 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23244 w
->base_line_pos
= 0;
23245 w
->base_line_number
= 0;
23249 if (w
->base_line_number
> 0
23250 && w
->base_line_pos
> 0
23251 && w
->base_line_pos
<= startpos
)
23253 line
= w
->base_line_number
;
23254 linepos
= w
->base_line_pos
;
23255 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23260 linepos
= BUF_BEGV (b
);
23261 linepos_byte
= BUF_BEGV_BYTE (b
);
23264 /* Count lines from base line to window start position. */
23265 nlines
= display_count_lines (linepos_byte
,
23269 topline
= nlines
+ line
;
23271 /* Determine a new base line, if the old one is too close
23272 or too far away, or if we did not have one.
23273 "Too close" means it's plausible a scroll-down would
23274 go back past it. */
23275 if (startpos
== BUF_BEGV (b
))
23277 w
->base_line_number
= topline
;
23278 w
->base_line_pos
= BUF_BEGV (b
);
23280 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23281 || linepos
== BUF_BEGV (b
))
23283 ptrdiff_t limit
= BUF_BEGV (b
);
23284 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23285 ptrdiff_t position
;
23286 ptrdiff_t distance
=
23287 (height
* 2 + 30) * line_number_display_limit_width
;
23289 if (startpos
- distance
> limit
)
23291 limit
= startpos
- distance
;
23292 limit_byte
= CHAR_TO_BYTE (limit
);
23295 nlines
= display_count_lines (startpos_byte
,
23297 - (height
* 2 + 30),
23299 /* If we couldn't find the lines we wanted within
23300 line_number_display_limit_width chars per line,
23301 give up on line numbers for this window. */
23302 if (position
== limit_byte
&& limit
== startpos
- distance
)
23304 w
->base_line_pos
= -1;
23305 w
->base_line_number
= 0;
23309 w
->base_line_number
= topline
- nlines
;
23310 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23313 /* Now count lines from the start pos to point. */
23314 nlines
= display_count_lines (startpos_byte
,
23315 PT_BYTE
, PT
, &junk
);
23317 /* Record that we did display the line number. */
23318 line_number_displayed
= 1;
23320 /* Make the string to show. */
23321 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23322 return decode_mode_spec_buf
;
23325 char *p
= decode_mode_spec_buf
;
23326 int pad
= width
- 2;
23332 return decode_mode_spec_buf
;
23338 obj
= BVAR (b
, mode_name
);
23342 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23348 ptrdiff_t pos
= marker_position (w
->start
);
23349 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23351 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23353 if (pos
<= BUF_BEGV (b
))
23358 else if (pos
<= BUF_BEGV (b
))
23362 if (total
> 1000000)
23363 /* Do it differently for a large value, to avoid overflow. */
23364 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23366 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23367 /* We can't normally display a 3-digit number,
23368 so get us a 2-digit number that is close. */
23371 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23372 return decode_mode_spec_buf
;
23376 /* Display percentage of size above the bottom of the screen. */
23379 ptrdiff_t toppos
= marker_position (w
->start
);
23380 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23381 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23383 if (botpos
>= BUF_ZV (b
))
23385 if (toppos
<= BUF_BEGV (b
))
23392 if (total
> 1000000)
23393 /* Do it differently for a large value, to avoid overflow. */
23394 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23396 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23397 /* We can't normally display a 3-digit number,
23398 so get us a 2-digit number that is close. */
23401 if (toppos
<= BUF_BEGV (b
))
23402 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23404 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23405 return decode_mode_spec_buf
;
23410 /* status of process */
23411 obj
= Fget_buffer_process (Fcurrent_buffer ());
23413 return "no process";
23415 obj
= Fsymbol_name (Fprocess_status (obj
));
23421 ptrdiff_t count
= inhibit_garbage_collection ();
23422 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23423 Lisp_Object val
= Qnil
;
23425 if (STRINGP (curdir
))
23426 val
= call1 (intern ("file-remote-p"), curdir
);
23428 unbind_to (count
, Qnil
);
23437 /* coding-system (not including end-of-line format) */
23439 /* coding-system (including end-of-line type) */
23441 int eol_flag
= (c
== 'Z');
23442 char *p
= decode_mode_spec_buf
;
23444 if (! FRAME_WINDOW_P (f
))
23446 /* No need to mention EOL here--the terminal never needs
23447 to do EOL conversion. */
23448 p
= decode_mode_spec_coding (CODING_ID_NAME
23449 (FRAME_KEYBOARD_CODING (f
)->id
),
23451 p
= decode_mode_spec_coding (CODING_ID_NAME
23452 (FRAME_TERMINAL_CODING (f
)->id
),
23455 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23458 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23459 #ifdef subprocesses
23460 obj
= Fget_buffer_process (Fcurrent_buffer ());
23461 if (PROCESSP (obj
))
23463 p
= decode_mode_spec_coding
23464 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23465 p
= decode_mode_spec_coding
23466 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23468 #endif /* subprocesses */
23471 return decode_mode_spec_buf
;
23478 return SSDATA (obj
);
23485 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23486 means count lines back from START_BYTE. But don't go beyond
23487 LIMIT_BYTE. Return the number of lines thus found (always
23490 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23491 either the position COUNT lines after/before START_BYTE, if we
23492 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23496 display_count_lines (ptrdiff_t start_byte
,
23497 ptrdiff_t limit_byte
, ptrdiff_t count
,
23498 ptrdiff_t *byte_pos_ptr
)
23500 register unsigned char *cursor
;
23501 unsigned char *base
;
23503 register ptrdiff_t ceiling
;
23504 register unsigned char *ceiling_addr
;
23505 ptrdiff_t orig_count
= count
;
23507 /* If we are not in selective display mode,
23508 check only for newlines. */
23509 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23510 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23514 while (start_byte
< limit_byte
)
23516 ceiling
= BUFFER_CEILING_OF (start_byte
);
23517 ceiling
= min (limit_byte
- 1, ceiling
);
23518 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23519 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23523 if (selective_display
)
23525 while (*cursor
!= '\n' && *cursor
!= 015
23526 && ++cursor
!= ceiling_addr
)
23528 if (cursor
== ceiling_addr
)
23533 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23542 start_byte
+= cursor
- base
;
23543 *byte_pos_ptr
= start_byte
;
23547 while (cursor
< ceiling_addr
);
23549 start_byte
+= ceiling_addr
- base
;
23554 while (start_byte
> limit_byte
)
23556 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23557 ceiling
= max (limit_byte
, ceiling
);
23558 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23559 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23562 if (selective_display
)
23564 while (--cursor
>= ceiling_addr
23565 && *cursor
!= '\n' && *cursor
!= 015)
23567 if (cursor
< ceiling_addr
)
23572 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23579 start_byte
+= cursor
- base
+ 1;
23580 *byte_pos_ptr
= start_byte
;
23581 /* When scanning backwards, we should
23582 not count the newline posterior to which we stop. */
23583 return - orig_count
- 1;
23586 start_byte
+= ceiling_addr
- base
;
23590 *byte_pos_ptr
= limit_byte
;
23593 return - orig_count
+ count
;
23594 return orig_count
- count
;
23600 /***********************************************************************
23602 ***********************************************************************/
23604 /* Display a NUL-terminated string, starting with index START.
23606 If STRING is non-null, display that C string. Otherwise, the Lisp
23607 string LISP_STRING is displayed. There's a case that STRING is
23608 non-null and LISP_STRING is not nil. It means STRING is a string
23609 data of LISP_STRING. In that case, we display LISP_STRING while
23610 ignoring its text properties.
23612 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23613 FACE_STRING. Display STRING or LISP_STRING with the face at
23614 FACE_STRING_POS in FACE_STRING:
23616 Display the string in the environment given by IT, but use the
23617 standard display table, temporarily.
23619 FIELD_WIDTH is the minimum number of output glyphs to produce.
23620 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23621 with spaces. If STRING has more characters, more than FIELD_WIDTH
23622 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23624 PRECISION is the maximum number of characters to output from
23625 STRING. PRECISION < 0 means don't truncate the string.
23627 This is roughly equivalent to printf format specifiers:
23629 FIELD_WIDTH PRECISION PRINTF
23630 ----------------------------------------
23636 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23637 display them, and < 0 means obey the current buffer's value of
23638 enable_multibyte_characters.
23640 Value is the number of columns displayed. */
23643 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23644 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23645 int field_width
, int precision
, int max_x
, int multibyte
)
23647 int hpos_at_start
= it
->hpos
;
23648 int saved_face_id
= it
->face_id
;
23649 struct glyph_row
*row
= it
->glyph_row
;
23650 ptrdiff_t it_charpos
;
23652 /* Initialize the iterator IT for iteration over STRING beginning
23653 with index START. */
23654 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23655 precision
, field_width
, multibyte
);
23656 if (string
&& STRINGP (lisp_string
))
23657 /* LISP_STRING is the one returned by decode_mode_spec. We should
23658 ignore its text properties. */
23659 it
->stop_charpos
= it
->end_charpos
;
23661 /* If displaying STRING, set up the face of the iterator from
23662 FACE_STRING, if that's given. */
23663 if (STRINGP (face_string
))
23669 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23670 0, &endptr
, it
->base_face_id
, 0);
23671 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23672 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23675 /* Set max_x to the maximum allowed X position. Don't let it go
23676 beyond the right edge of the window. */
23678 max_x
= it
->last_visible_x
;
23680 max_x
= min (max_x
, it
->last_visible_x
);
23682 /* Skip over display elements that are not visible. because IT->w is
23684 if (it
->current_x
< it
->first_visible_x
)
23685 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23686 MOVE_TO_POS
| MOVE_TO_X
);
23688 row
->ascent
= it
->max_ascent
;
23689 row
->height
= it
->max_ascent
+ it
->max_descent
;
23690 row
->phys_ascent
= it
->max_phys_ascent
;
23691 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23692 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23694 if (STRINGP (it
->string
))
23695 it_charpos
= IT_STRING_CHARPOS (*it
);
23697 it_charpos
= IT_CHARPOS (*it
);
23699 /* This condition is for the case that we are called with current_x
23700 past last_visible_x. */
23701 while (it
->current_x
< max_x
)
23703 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23705 /* Get the next display element. */
23706 if (!get_next_display_element (it
))
23709 /* Produce glyphs. */
23710 x_before
= it
->current_x
;
23711 n_glyphs_before
= row
->used
[TEXT_AREA
];
23712 PRODUCE_GLYPHS (it
);
23714 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23717 while (i
< nglyphs
)
23719 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23721 if (it
->line_wrap
!= TRUNCATE
23722 && x
+ glyph
->pixel_width
> max_x
)
23724 /* End of continued line or max_x reached. */
23725 if (CHAR_GLYPH_PADDING_P (*glyph
))
23727 /* A wide character is unbreakable. */
23728 if (row
->reversed_p
)
23729 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23730 - n_glyphs_before
);
23731 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23732 it
->current_x
= x_before
;
23736 if (row
->reversed_p
)
23737 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23738 - (n_glyphs_before
+ i
));
23739 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23744 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23746 /* Glyph is at least partially visible. */
23748 if (x
< it
->first_visible_x
)
23749 row
->x
= x
- it
->first_visible_x
;
23753 /* Glyph is off the left margin of the display area.
23754 Should not happen. */
23758 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23759 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23760 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23761 row
->phys_height
= max (row
->phys_height
,
23762 it
->max_phys_ascent
+ it
->max_phys_descent
);
23763 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23764 it
->max_extra_line_spacing
);
23765 x
+= glyph
->pixel_width
;
23769 /* Stop if max_x reached. */
23773 /* Stop at line ends. */
23774 if (ITERATOR_AT_END_OF_LINE_P (it
))
23776 it
->continuation_lines_width
= 0;
23780 set_iterator_to_next (it
, 1);
23781 if (STRINGP (it
->string
))
23782 it_charpos
= IT_STRING_CHARPOS (*it
);
23784 it_charpos
= IT_CHARPOS (*it
);
23786 /* Stop if truncating at the right edge. */
23787 if (it
->line_wrap
== TRUNCATE
23788 && it
->current_x
>= it
->last_visible_x
)
23790 /* Add truncation mark, but don't do it if the line is
23791 truncated at a padding space. */
23792 if (it_charpos
< it
->string_nchars
)
23794 if (!FRAME_WINDOW_P (it
->f
))
23798 if (it
->current_x
> it
->last_visible_x
)
23800 if (!row
->reversed_p
)
23802 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23803 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23808 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23809 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23811 unproduce_glyphs (it
, ii
+ 1);
23812 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23814 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23816 row
->used
[TEXT_AREA
] = ii
;
23817 produce_special_glyphs (it
, IT_TRUNCATION
);
23820 produce_special_glyphs (it
, IT_TRUNCATION
);
23822 row
->truncated_on_right_p
= 1;
23828 /* Maybe insert a truncation at the left. */
23829 if (it
->first_visible_x
23832 if (!FRAME_WINDOW_P (it
->f
)
23833 || (row
->reversed_p
23834 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23835 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23836 insert_left_trunc_glyphs (it
);
23837 row
->truncated_on_left_p
= 1;
23840 it
->face_id
= saved_face_id
;
23842 /* Value is number of columns displayed. */
23843 return it
->hpos
- hpos_at_start
;
23848 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23849 appears as an element of LIST or as the car of an element of LIST.
23850 If PROPVAL is a list, compare each element against LIST in that
23851 way, and return 1/2 if any element of PROPVAL is found in LIST.
23852 Otherwise return 0. This function cannot quit.
23853 The return value is 2 if the text is invisible but with an ellipsis
23854 and 1 if it's invisible and without an ellipsis. */
23857 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23859 register Lisp_Object tail
, proptail
;
23861 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23863 register Lisp_Object tem
;
23865 if (EQ (propval
, tem
))
23867 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23868 return NILP (XCDR (tem
)) ? 1 : 2;
23871 if (CONSP (propval
))
23873 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23875 Lisp_Object propelt
;
23876 propelt
= XCAR (proptail
);
23877 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23879 register Lisp_Object tem
;
23881 if (EQ (propelt
, tem
))
23883 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23884 return NILP (XCDR (tem
)) ? 1 : 2;
23892 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23893 doc
: /* Non-nil if the property makes the text invisible.
23894 POS-OR-PROP can be a marker or number, in which case it is taken to be
23895 a position in the current buffer and the value of the `invisible' property
23896 is checked; or it can be some other value, which is then presumed to be the
23897 value of the `invisible' property of the text of interest.
23898 The non-nil value returned can be t for truly invisible text or something
23899 else if the text is replaced by an ellipsis. */)
23900 (Lisp_Object pos_or_prop
)
23903 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23904 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23906 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23907 return (invis
== 0 ? Qnil
23909 : make_number (invis
));
23912 /* Calculate a width or height in pixels from a specification using
23913 the following elements:
23916 NUM - a (fractional) multiple of the default font width/height
23917 (NUM) - specifies exactly NUM pixels
23918 UNIT - a fixed number of pixels, see below.
23919 ELEMENT - size of a display element in pixels, see below.
23920 (NUM . SPEC) - equals NUM * SPEC
23921 (+ SPEC SPEC ...) - add pixel values
23922 (- SPEC SPEC ...) - subtract pixel values
23923 (- SPEC) - negate pixel value
23926 INT or FLOAT - a number constant
23927 SYMBOL - use symbol's (buffer local) variable binding.
23930 in - pixels per inch *)
23931 mm - pixels per 1/1000 meter *)
23932 cm - pixels per 1/100 meter *)
23933 width - width of current font in pixels.
23934 height - height of current font in pixels.
23936 *) using the ratio(s) defined in display-pixels-per-inch.
23940 left-fringe - left fringe width in pixels
23941 right-fringe - right fringe width in pixels
23943 left-margin - left margin width in pixels
23944 right-margin - right margin width in pixels
23946 scroll-bar - scroll-bar area width in pixels
23950 Pixels corresponding to 5 inches:
23953 Total width of non-text areas on left side of window (if scroll-bar is on left):
23954 '(space :width (+ left-fringe left-margin scroll-bar))
23956 Align to first text column (in header line):
23957 '(space :align-to 0)
23959 Align to middle of text area minus half the width of variable `my-image'
23960 containing a loaded image:
23961 '(space :align-to (0.5 . (- text my-image)))
23963 Width of left margin minus width of 1 character in the default font:
23964 '(space :width (- left-margin 1))
23966 Width of left margin minus width of 2 characters in the current font:
23967 '(space :width (- left-margin (2 . width)))
23969 Center 1 character over left-margin (in header line):
23970 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23972 Different ways to express width of left fringe plus left margin minus one pixel:
23973 '(space :width (- (+ left-fringe left-margin) (1)))
23974 '(space :width (+ left-fringe left-margin (- (1))))
23975 '(space :width (+ left-fringe left-margin (-1)))
23980 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23981 struct font
*font
, int width_p
, int *align_to
)
23985 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23986 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23989 return OK_PIXELS (0);
23991 eassert (FRAME_LIVE_P (it
->f
));
23993 if (SYMBOLP (prop
))
23995 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23997 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23999 if (unit
[0] == 'i' && unit
[1] == 'n')
24001 else if (unit
[0] == 'm' && unit
[1] == 'm')
24003 else if (unit
[0] == 'c' && unit
[1] == 'm')
24009 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24010 : FRAME_RES_Y (it
->f
));
24013 return OK_PIXELS (ppi
/ pixels
);
24018 #ifdef HAVE_WINDOW_SYSTEM
24019 if (EQ (prop
, Qheight
))
24020 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
24021 if (EQ (prop
, Qwidth
))
24022 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
24024 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24025 return OK_PIXELS (1);
24028 if (EQ (prop
, Qtext
))
24029 return OK_PIXELS (width_p
24030 ? window_box_width (it
->w
, TEXT_AREA
)
24031 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24033 if (align_to
&& *align_to
< 0)
24036 if (EQ (prop
, Qleft
))
24037 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24038 if (EQ (prop
, Qright
))
24039 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24040 if (EQ (prop
, Qcenter
))
24041 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24042 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24043 if (EQ (prop
, Qleft_fringe
))
24044 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24045 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24046 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24047 if (EQ (prop
, Qright_fringe
))
24048 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24049 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24050 : window_box_right_offset (it
->w
, TEXT_AREA
));
24051 if (EQ (prop
, Qleft_margin
))
24052 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24053 if (EQ (prop
, Qright_margin
))
24054 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24055 if (EQ (prop
, Qscroll_bar
))
24056 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24058 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24059 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24060 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24065 if (EQ (prop
, Qleft_fringe
))
24066 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24067 if (EQ (prop
, Qright_fringe
))
24068 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24069 if (EQ (prop
, Qleft_margin
))
24070 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24071 if (EQ (prop
, Qright_margin
))
24072 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24073 if (EQ (prop
, Qscroll_bar
))
24074 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24077 prop
= buffer_local_value (prop
, it
->w
->contents
);
24078 if (EQ (prop
, Qunbound
))
24082 if (INTEGERP (prop
) || FLOATP (prop
))
24084 int base_unit
= (width_p
24085 ? FRAME_COLUMN_WIDTH (it
->f
)
24086 : FRAME_LINE_HEIGHT (it
->f
));
24087 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24092 Lisp_Object car
= XCAR (prop
);
24093 Lisp_Object cdr
= XCDR (prop
);
24097 #ifdef HAVE_WINDOW_SYSTEM
24098 if (FRAME_WINDOW_P (it
->f
)
24099 && valid_image_p (prop
))
24101 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24102 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24104 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24106 #ifdef HAVE_XWIDGETS
24107 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24109 printf("calc_pixel_width_or_height: return dummy size FIXME\n");
24110 return OK_PIXELS (width_p
? 100 : 100);
24114 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24120 while (CONSP (cdr
))
24122 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24123 font
, width_p
, align_to
))
24126 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
24131 if (EQ (car
, Qminus
))
24133 return OK_PIXELS (pixels
);
24136 car
= buffer_local_value (car
, it
->w
->contents
);
24137 if (EQ (car
, Qunbound
))
24141 if (INTEGERP (car
) || FLOATP (car
))
24144 pixels
= XFLOATINT (car
);
24146 return OK_PIXELS (pixels
);
24147 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24148 font
, width_p
, align_to
))
24149 return OK_PIXELS (pixels
* fact
);
24160 /***********************************************************************
24162 ***********************************************************************/
24164 #ifdef HAVE_WINDOW_SYSTEM
24169 dump_glyph_string (struct glyph_string
*s
)
24171 fprintf (stderr
, "glyph string\n");
24172 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24173 s
->x
, s
->y
, s
->width
, s
->height
);
24174 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24175 fprintf (stderr
, " hl = %d\n", s
->hl
);
24176 fprintf (stderr
, " left overhang = %d, right = %d\n",
24177 s
->left_overhang
, s
->right_overhang
);
24178 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24179 fprintf (stderr
, " extends to end of line = %d\n",
24180 s
->extends_to_end_of_line_p
);
24181 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24182 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24185 #endif /* GLYPH_DEBUG */
24187 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24188 of XChar2b structures for S; it can't be allocated in
24189 init_glyph_string because it must be allocated via `alloca'. W
24190 is the window on which S is drawn. ROW and AREA are the glyph row
24191 and area within the row from which S is constructed. START is the
24192 index of the first glyph structure covered by S. HL is a
24193 face-override for drawing S. */
24196 #define OPTIONAL_HDC(hdc) HDC hdc,
24197 #define DECLARE_HDC(hdc) HDC hdc;
24198 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24199 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24202 #ifndef OPTIONAL_HDC
24203 #define OPTIONAL_HDC(hdc)
24204 #define DECLARE_HDC(hdc)
24205 #define ALLOCATE_HDC(hdc, f)
24206 #define RELEASE_HDC(hdc, f)
24210 init_glyph_string (struct glyph_string
*s
,
24212 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24213 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24215 memset (s
, 0, sizeof *s
);
24217 s
->f
= XFRAME (w
->frame
);
24221 s
->display
= FRAME_X_DISPLAY (s
->f
);
24222 s
->window
= FRAME_X_WINDOW (s
->f
);
24223 s
->char2b
= char2b
;
24227 s
->first_glyph
= row
->glyphs
[area
] + start
;
24228 s
->height
= row
->height
;
24229 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24230 s
->ybase
= s
->y
+ row
->ascent
;
24234 /* Append the list of glyph strings with head H and tail T to the list
24235 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24238 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24239 struct glyph_string
*h
, struct glyph_string
*t
)
24253 /* Prepend the list of glyph strings with head H and tail T to the
24254 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24258 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24259 struct glyph_string
*h
, struct glyph_string
*t
)
24273 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24274 Set *HEAD and *TAIL to the resulting list. */
24277 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24278 struct glyph_string
*s
)
24280 s
->next
= s
->prev
= NULL
;
24281 append_glyph_string_lists (head
, tail
, s
, s
);
24285 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24286 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
24287 make sure that X resources for the face returned are allocated.
24288 Value is a pointer to a realized face that is ready for display if
24289 DISPLAY_P is non-zero. */
24291 static struct face
*
24292 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24293 XChar2b
*char2b
, int display_p
)
24295 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24300 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24302 if (code
== FONT_INVALID_CODE
)
24305 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24307 /* Make sure X resources of the face are allocated. */
24308 #ifdef HAVE_X_WINDOWS
24312 eassert (face
!= NULL
);
24313 prepare_face_for_display (f
, face
);
24320 /* Get face and two-byte form of character glyph GLYPH on frame F.
24321 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24322 a pointer to a realized face that is ready for display. */
24324 static struct face
*
24325 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24326 XChar2b
*char2b
, int *two_byte_p
)
24331 eassert (glyph
->type
== CHAR_GLYPH
);
24332 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24334 /* Make sure X resources of the face are allocated. */
24335 eassert (face
!= NULL
);
24336 prepare_face_for_display (f
, face
);
24343 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24344 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24346 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24348 if (code
== FONT_INVALID_CODE
)
24352 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24357 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24358 Return 1 if FONT has a glyph for C, otherwise return 0. */
24361 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24365 if (CHAR_BYTE8_P (c
))
24366 code
= CHAR_TO_BYTE8 (c
);
24368 code
= font
->driver
->encode_char (font
, c
);
24370 if (code
== FONT_INVALID_CODE
)
24372 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24377 /* Fill glyph string S with composition components specified by S->cmp.
24379 BASE_FACE is the base face of the composition.
24380 S->cmp_from is the index of the first component for S.
24382 OVERLAPS non-zero means S should draw the foreground only, and use
24383 its physical height for clipping. See also draw_glyphs.
24385 Value is the index of a component not in S. */
24388 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24392 /* For all glyphs of this composition, starting at the offset
24393 S->cmp_from, until we reach the end of the definition or encounter a
24394 glyph that requires the different face, add it to S. */
24399 s
->for_overlaps
= overlaps
;
24402 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24404 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24406 /* TAB in a composition means display glyphs with padding space
24407 on the left or right. */
24410 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24413 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24420 s
->font
= s
->face
->font
;
24422 else if (s
->face
!= face
)
24430 if (s
->face
== NULL
)
24432 s
->face
= base_face
->ascii_face
;
24433 s
->font
= s
->face
->font
;
24436 /* All glyph strings for the same composition has the same width,
24437 i.e. the width set for the first component of the composition. */
24438 s
->width
= s
->first_glyph
->pixel_width
;
24440 /* If the specified font could not be loaded, use the frame's
24441 default font, but record the fact that we couldn't load it in
24442 the glyph string so that we can draw rectangles for the
24443 characters of the glyph string. */
24444 if (s
->font
== NULL
)
24446 s
->font_not_found_p
= 1;
24447 s
->font
= FRAME_FONT (s
->f
);
24450 /* Adjust base line for subscript/superscript text. */
24451 s
->ybase
+= s
->first_glyph
->voffset
;
24453 /* This glyph string must always be drawn with 16-bit functions. */
24460 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24461 int start
, int end
, int overlaps
)
24463 struct glyph
*glyph
, *last
;
24464 Lisp_Object lgstring
;
24467 s
->for_overlaps
= overlaps
;
24468 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24469 last
= s
->row
->glyphs
[s
->area
] + end
;
24470 s
->cmp_id
= glyph
->u
.cmp
.id
;
24471 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24472 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24473 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24474 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24475 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24477 while (glyph
< last
24478 && glyph
->u
.cmp
.automatic
24479 && glyph
->u
.cmp
.id
== s
->cmp_id
24480 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24481 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24483 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24485 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24486 unsigned code
= LGLYPH_CODE (lglyph
);
24488 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24490 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24491 return glyph
- s
->row
->glyphs
[s
->area
];
24495 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24496 See the comment of fill_glyph_string for arguments.
24497 Value is the index of the first glyph not in S. */
24501 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24502 int start
, int end
, int overlaps
)
24504 struct glyph
*glyph
, *last
;
24507 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24508 s
->for_overlaps
= overlaps
;
24509 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24510 last
= s
->row
->glyphs
[s
->area
] + end
;
24511 voffset
= glyph
->voffset
;
24512 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24513 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24515 s
->width
= glyph
->pixel_width
;
24517 while (glyph
< last
24518 && glyph
->type
== GLYPHLESS_GLYPH
24519 && glyph
->voffset
== voffset
24520 && glyph
->face_id
== face_id
)
24523 s
->width
+= glyph
->pixel_width
;
24526 s
->ybase
+= voffset
;
24527 return glyph
- s
->row
->glyphs
[s
->area
];
24531 /* Fill glyph string S from a sequence of character glyphs.
24533 FACE_ID is the face id of the string. START is the index of the
24534 first glyph to consider, END is the index of the last + 1.
24535 OVERLAPS non-zero means S should draw the foreground only, and use
24536 its physical height for clipping. See also draw_glyphs.
24538 Value is the index of the first glyph not in S. */
24541 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24542 int start
, int end
, int overlaps
)
24544 struct glyph
*glyph
, *last
;
24546 int glyph_not_available_p
;
24548 eassert (s
->f
== XFRAME (s
->w
->frame
));
24549 eassert (s
->nchars
== 0);
24550 eassert (start
>= 0 && end
> start
);
24552 s
->for_overlaps
= overlaps
;
24553 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24554 last
= s
->row
->glyphs
[s
->area
] + end
;
24555 voffset
= glyph
->voffset
;
24556 s
->padding_p
= glyph
->padding_p
;
24557 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24559 while (glyph
< last
24560 && glyph
->type
== CHAR_GLYPH
24561 && glyph
->voffset
== voffset
24562 /* Same face id implies same font, nowadays. */
24563 && glyph
->face_id
== face_id
24564 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24568 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24569 s
->char2b
+ s
->nchars
,
24571 s
->two_byte_p
= two_byte_p
;
24573 eassert (s
->nchars
<= end
- start
);
24574 s
->width
+= glyph
->pixel_width
;
24575 if (glyph
++->padding_p
!= s
->padding_p
)
24579 s
->font
= s
->face
->font
;
24581 /* If the specified font could not be loaded, use the frame's font,
24582 but record the fact that we couldn't load it in
24583 S->font_not_found_p so that we can draw rectangles for the
24584 characters of the glyph string. */
24585 if (s
->font
== NULL
|| glyph_not_available_p
)
24587 s
->font_not_found_p
= 1;
24588 s
->font
= FRAME_FONT (s
->f
);
24591 /* Adjust base line for subscript/superscript text. */
24592 s
->ybase
+= voffset
;
24594 eassert (s
->face
&& s
->face
->gc
);
24595 return glyph
- s
->row
->glyphs
[s
->area
];
24599 /* Fill glyph string S from image glyph S->first_glyph. */
24602 fill_image_glyph_string (struct glyph_string
*s
)
24604 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24605 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24607 s
->slice
= s
->first_glyph
->slice
.img
;
24608 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24609 s
->font
= s
->face
->font
;
24610 s
->width
= s
->first_glyph
->pixel_width
;
24612 /* Adjust base line for subscript/superscript text. */
24613 s
->ybase
+= s
->first_glyph
->voffset
;
24617 #ifdef HAVE_XWIDGETS
24619 fill_xwidget_glyph_string (struct glyph_string
*s
)
24621 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24622 printf("fill_xwidget_glyph_string: width:%d \n",s
->first_glyph
->pixel_width
);
24623 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24624 s
->font
= s
->face
->font
;
24625 s
->width
= s
->first_glyph
->pixel_width
;
24626 s
->ybase
+= s
->first_glyph
->voffset
;
24627 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24628 //assert_valid_xwidget_id ( s->xwidget, "fill_xwidget_glyph_string");
24631 /* Fill glyph string S from a sequence of stretch glyphs.
24633 START is the index of the first glyph to consider,
24634 END is the index of the last + 1.
24636 Value is the index of the first glyph not in S. */
24639 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24641 struct glyph
*glyph
, *last
;
24642 int voffset
, face_id
;
24644 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24646 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24647 last
= s
->row
->glyphs
[s
->area
] + end
;
24648 face_id
= glyph
->face_id
;
24649 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24650 s
->font
= s
->face
->font
;
24651 s
->width
= glyph
->pixel_width
;
24653 voffset
= glyph
->voffset
;
24657 && glyph
->type
== STRETCH_GLYPH
24658 && glyph
->voffset
== voffset
24659 && glyph
->face_id
== face_id
);
24661 s
->width
+= glyph
->pixel_width
;
24663 /* Adjust base line for subscript/superscript text. */
24664 s
->ybase
+= voffset
;
24666 /* The case that face->gc == 0 is handled when drawing the glyph
24667 string by calling prepare_face_for_display. */
24669 return glyph
- s
->row
->glyphs
[s
->area
];
24672 static struct font_metrics
*
24673 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24675 static struct font_metrics metrics
;
24680 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24681 if (code
== FONT_INVALID_CODE
)
24683 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24688 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24689 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24690 assumed to be zero. */
24693 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24695 *left
= *right
= 0;
24697 if (glyph
->type
== CHAR_GLYPH
)
24701 struct font_metrics
*pcm
;
24703 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24704 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24706 if (pcm
->rbearing
> pcm
->width
)
24707 *right
= pcm
->rbearing
- pcm
->width
;
24708 if (pcm
->lbearing
< 0)
24709 *left
= -pcm
->lbearing
;
24712 else if (glyph
->type
== COMPOSITE_GLYPH
)
24714 if (! glyph
->u
.cmp
.automatic
)
24716 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24718 if (cmp
->rbearing
> cmp
->pixel_width
)
24719 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24720 if (cmp
->lbearing
< 0)
24721 *left
= - cmp
->lbearing
;
24725 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24726 struct font_metrics metrics
;
24728 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24729 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24730 if (metrics
.rbearing
> metrics
.width
)
24731 *right
= metrics
.rbearing
- metrics
.width
;
24732 if (metrics
.lbearing
< 0)
24733 *left
= - metrics
.lbearing
;
24739 /* Return the index of the first glyph preceding glyph string S that
24740 is overwritten by S because of S's left overhang. Value is -1
24741 if no glyphs are overwritten. */
24744 left_overwritten (struct glyph_string
*s
)
24748 if (s
->left_overhang
)
24751 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24752 int first
= s
->first_glyph
- glyphs
;
24754 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24755 x
-= glyphs
[i
].pixel_width
;
24766 /* Return the index of the first glyph preceding glyph string S that
24767 is overwriting S because of its right overhang. Value is -1 if no
24768 glyph in front of S overwrites S. */
24771 left_overwriting (struct glyph_string
*s
)
24774 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24775 int first
= s
->first_glyph
- glyphs
;
24779 for (i
= first
- 1; i
>= 0; --i
)
24782 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24785 x
-= glyphs
[i
].pixel_width
;
24792 /* Return the index of the last glyph following glyph string S that is
24793 overwritten by S because of S's right overhang. Value is -1 if
24794 no such glyph is found. */
24797 right_overwritten (struct glyph_string
*s
)
24801 if (s
->right_overhang
)
24804 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24805 int first
= (s
->first_glyph
- glyphs
24806 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24807 int end
= s
->row
->used
[s
->area
];
24809 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24810 x
+= glyphs
[i
].pixel_width
;
24819 /* Return the index of the last glyph following glyph string S that
24820 overwrites S because of its left overhang. Value is negative
24821 if no such glyph is found. */
24824 right_overwriting (struct glyph_string
*s
)
24827 int end
= s
->row
->used
[s
->area
];
24828 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24829 int first
= (s
->first_glyph
- glyphs
24830 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24834 for (i
= first
; i
< end
; ++i
)
24837 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24840 x
+= glyphs
[i
].pixel_width
;
24847 /* Set background width of glyph string S. START is the index of the
24848 first glyph following S. LAST_X is the right-most x-position + 1
24849 in the drawing area. */
24852 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24854 /* If the face of this glyph string has to be drawn to the end of
24855 the drawing area, set S->extends_to_end_of_line_p. */
24857 if (start
== s
->row
->used
[s
->area
]
24858 && ((s
->row
->fill_line_p
24859 && (s
->hl
== DRAW_NORMAL_TEXT
24860 || s
->hl
== DRAW_IMAGE_RAISED
24861 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24862 || s
->hl
== DRAW_MOUSE_FACE
))
24863 s
->extends_to_end_of_line_p
= 1;
24865 /* If S extends its face to the end of the line, set its
24866 background_width to the distance to the right edge of the drawing
24868 if (s
->extends_to_end_of_line_p
)
24869 s
->background_width
= last_x
- s
->x
+ 1;
24871 s
->background_width
= s
->width
;
24875 /* Compute overhangs and x-positions for glyph string S and its
24876 predecessors, or successors. X is the starting x-position for S.
24877 BACKWARD_P non-zero means process predecessors. */
24880 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24886 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24887 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24897 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24898 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24908 /* The following macros are only called from draw_glyphs below.
24909 They reference the following parameters of that function directly:
24910 `w', `row', `area', and `overlap_p'
24911 as well as the following local variables:
24912 `s', `f', and `hdc' (in W32) */
24915 /* On W32, silently add local `hdc' variable to argument list of
24916 init_glyph_string. */
24917 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24918 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24920 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24921 init_glyph_string (s, char2b, w, row, area, start, hl)
24924 /* Add a glyph string for a stretch glyph to the list of strings
24925 between HEAD and TAIL. START is the index of the stretch glyph in
24926 row area AREA of glyph row ROW. END is the index of the last glyph
24927 in that glyph row area. X is the current output position assigned
24928 to the new glyph string constructed. HL overrides that face of the
24929 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24930 is the right-most x-position of the drawing area. */
24932 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24933 and below -- keep them on one line. */
24934 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24937 s = alloca (sizeof *s); \
24938 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24939 START = fill_stretch_glyph_string (s, START, END); \
24940 append_glyph_string (&HEAD, &TAIL, s); \
24946 /* Add a glyph string for an image glyph to the list of strings
24947 between HEAD and TAIL. START is the index of the image glyph in
24948 row area AREA of glyph row ROW. END is the index of the last glyph
24949 in that glyph row area. X is the current output position assigned
24950 to the new glyph string constructed. HL overrides that face of the
24951 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24952 is the right-most x-position of the drawing area. */
24954 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24957 s = alloca (sizeof *s); \
24958 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24959 fill_image_glyph_string (s); \
24960 append_glyph_string (&HEAD, &TAIL, s); \
24966 #ifdef HAVE_XWIDGETS
24967 #define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24970 printf("BUILD_XWIDGET_GLYPH_STRING\n"); \
24971 s = (struct glyph_string *) alloca (sizeof *s); \
24972 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24973 fill_xwidget_glyph_string (s); \
24974 append_glyph_string (&HEAD, &TAIL, s); \
24982 /* Add a glyph string for a sequence of character glyphs to the list
24983 of strings between HEAD and TAIL. START is the index of the first
24984 glyph in row area AREA of glyph row ROW that is part of the new
24985 glyph string. END is the index of the last glyph in that glyph row
24986 area. X is the current output position assigned to the new glyph
24987 string constructed. HL overrides that face of the glyph; e.g. it
24988 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24989 right-most x-position of the drawing area. */
24991 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24997 face_id = (row)->glyphs[area][START].face_id; \
24999 s = alloca (sizeof *s); \
25000 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25001 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25002 append_glyph_string (&HEAD, &TAIL, s); \
25004 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25009 /* Add a glyph string for a composite sequence to the list of strings
25010 between HEAD and TAIL. START is the index of the first glyph in
25011 row area AREA of glyph row ROW that is part of the new glyph
25012 string. END is the index of the last glyph in that glyph row area.
25013 X is the current output position assigned to the new glyph string
25014 constructed. HL overrides that face of the glyph; e.g. it is
25015 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25016 x-position of the drawing area. */
25018 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25020 int face_id = (row)->glyphs[area][START].face_id; \
25021 struct face *base_face = FACE_FROM_ID (f, face_id); \
25022 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25023 struct composition *cmp = composition_table[cmp_id]; \
25025 struct glyph_string *first_s = NULL; \
25028 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25030 /* Make glyph_strings for each glyph sequence that is drawable by \
25031 the same face, and append them to HEAD/TAIL. */ \
25032 for (n = 0; n < cmp->glyph_len;) \
25034 s = alloca (sizeof *s); \
25035 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25036 append_glyph_string (&(HEAD), &(TAIL), s); \
25042 n = fill_composite_glyph_string (s, base_face, overlaps); \
25050 /* Add a glyph string for a glyph-string sequence to the list of strings
25051 between HEAD and TAIL. */
25053 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25057 Lisp_Object gstring; \
25059 face_id = (row)->glyphs[area][START].face_id; \
25060 gstring = (composition_gstring_from_id \
25061 ((row)->glyphs[area][START].u.cmp.id)); \
25062 s = alloca (sizeof *s); \
25063 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25064 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25065 append_glyph_string (&(HEAD), &(TAIL), s); \
25067 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25071 /* Add a glyph string for a sequence of glyphless character's glyphs
25072 to the list of strings between HEAD and TAIL. The meanings of
25073 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25075 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25080 face_id = (row)->glyphs[area][START].face_id; \
25082 s = alloca (sizeof *s); \
25083 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25084 append_glyph_string (&HEAD, &TAIL, s); \
25086 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25092 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25093 of AREA of glyph row ROW on window W between indices START and END.
25094 HL overrides the face for drawing glyph strings, e.g. it is
25095 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25096 x-positions of the drawing area.
25098 This is an ugly monster macro construct because we must use alloca
25099 to allocate glyph strings (because draw_glyphs can be called
25100 asynchronously). */
25102 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25105 HEAD = TAIL = NULL; \
25106 while (START < END) \
25108 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25109 switch (first_glyph->type) \
25112 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25116 case COMPOSITE_GLYPH: \
25117 if (first_glyph->u.cmp.automatic) \
25118 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25121 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25125 case STRETCH_GLYPH: \
25126 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25130 case IMAGE_GLYPH: \
25131 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25135 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25136 case XWIDGET_GLYPH: \
25137 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25141 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25142 case GLYPHLESS_GLYPH: \
25143 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25153 set_glyph_string_background_width (s, START, LAST_X); \
25160 #ifdef HAVE_XWIDGETS
25161 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25162 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25163 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25164 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25166 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25167 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25168 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25172 /* Draw glyphs between START and END in AREA of ROW on window W,
25173 starting at x-position X. X is relative to AREA in W. HL is a
25174 face-override with the following meaning:
25176 DRAW_NORMAL_TEXT draw normally
25177 DRAW_CURSOR draw in cursor face
25178 DRAW_MOUSE_FACE draw in mouse face.
25179 DRAW_INVERSE_VIDEO draw in mode line face
25180 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25181 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25183 If OVERLAPS is non-zero, draw only the foreground of characters and
25184 clip to the physical height of ROW. Non-zero value also defines
25185 the overlapping part to be drawn:
25187 OVERLAPS_PRED overlap with preceding rows
25188 OVERLAPS_SUCC overlap with succeeding rows
25189 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25190 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25192 Value is the x-position reached, relative to AREA of W. */
25195 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25196 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25197 enum draw_glyphs_face hl
, int overlaps
)
25199 struct glyph_string
*head
, *tail
;
25200 struct glyph_string
*s
;
25201 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25202 int i
, j
, x_reached
, last_x
, area_left
= 0;
25203 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25206 ALLOCATE_HDC (hdc
, f
);
25208 /* Let's rather be paranoid than getting a SEGV. */
25209 end
= min (end
, row
->used
[area
]);
25210 start
= clip_to_bounds (0, start
, end
);
25212 /* Translate X to frame coordinates. Set last_x to the right
25213 end of the drawing area. */
25214 if (row
->full_width_p
)
25216 /* X is relative to the left edge of W, without scroll bars
25218 area_left
= WINDOW_LEFT_EDGE_X (w
);
25219 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25220 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25224 area_left
= window_box_left (w
, area
);
25225 last_x
= area_left
+ window_box_width (w
, area
);
25229 /* Build a doubly-linked list of glyph_string structures between
25230 head and tail from what we have to draw. Note that the macro
25231 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25232 the reason we use a separate variable `i'. */
25235 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25237 x_reached
= tail
->x
+ tail
->background_width
;
25241 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25242 the row, redraw some glyphs in front or following the glyph
25243 strings built above. */
25244 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25246 struct glyph_string
*h
, *t
;
25247 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25248 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25249 int check_mouse_face
= 0;
25252 /* If mouse highlighting is on, we may need to draw adjacent
25253 glyphs using mouse-face highlighting. */
25254 if (area
== TEXT_AREA
&& row
->mouse_face_p
25255 && hlinfo
->mouse_face_beg_row
>= 0
25256 && hlinfo
->mouse_face_end_row
>= 0)
25258 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25260 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25261 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25263 check_mouse_face
= 1;
25264 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25265 ? hlinfo
->mouse_face_beg_col
: 0;
25266 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25267 ? hlinfo
->mouse_face_end_col
25268 : row
->used
[TEXT_AREA
];
25272 /* Compute overhangs for all glyph strings. */
25273 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25274 for (s
= head
; s
; s
= s
->next
)
25275 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25277 /* Prepend glyph strings for glyphs in front of the first glyph
25278 string that are overwritten because of the first glyph
25279 string's left overhang. The background of all strings
25280 prepended must be drawn because the first glyph string
25282 i
= left_overwritten (head
);
25285 enum draw_glyphs_face overlap_hl
;
25287 /* If this row contains mouse highlighting, attempt to draw
25288 the overlapped glyphs with the correct highlight. This
25289 code fails if the overlap encompasses more than one glyph
25290 and mouse-highlight spans only some of these glyphs.
25291 However, making it work perfectly involves a lot more
25292 code, and I don't know if the pathological case occurs in
25293 practice, so we'll stick to this for now. --- cyd */
25294 if (check_mouse_face
25295 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25296 overlap_hl
= DRAW_MOUSE_FACE
;
25298 overlap_hl
= DRAW_NORMAL_TEXT
;
25300 if (hl
!= overlap_hl
)
25303 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25304 overlap_hl
, dummy_x
, last_x
);
25306 compute_overhangs_and_x (t
, head
->x
, 1);
25307 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25308 if (clip_head
== NULL
)
25312 /* Prepend glyph strings for glyphs in front of the first glyph
25313 string that overwrite that glyph string because of their
25314 right overhang. For these strings, only the foreground must
25315 be drawn, because it draws over the glyph string at `head'.
25316 The background must not be drawn because this would overwrite
25317 right overhangs of preceding glyphs for which no glyph
25319 i
= left_overwriting (head
);
25322 enum draw_glyphs_face overlap_hl
;
25324 if (check_mouse_face
25325 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25326 overlap_hl
= DRAW_MOUSE_FACE
;
25328 overlap_hl
= DRAW_NORMAL_TEXT
;
25330 if (hl
== overlap_hl
|| clip_head
== NULL
)
25332 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25333 overlap_hl
, dummy_x
, last_x
);
25334 for (s
= h
; s
; s
= s
->next
)
25335 s
->background_filled_p
= 1;
25336 compute_overhangs_and_x (t
, head
->x
, 1);
25337 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25340 /* Append glyphs strings for glyphs following the last glyph
25341 string tail that are overwritten by tail. The background of
25342 these strings has to be drawn because tail's foreground draws
25344 i
= right_overwritten (tail
);
25347 enum draw_glyphs_face overlap_hl
;
25349 if (check_mouse_face
25350 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25351 overlap_hl
= DRAW_MOUSE_FACE
;
25353 overlap_hl
= DRAW_NORMAL_TEXT
;
25355 if (hl
!= overlap_hl
)
25357 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25358 overlap_hl
, x
, last_x
);
25359 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25360 we don't have `end = i;' here. */
25361 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25362 append_glyph_string_lists (&head
, &tail
, h
, t
);
25363 if (clip_tail
== NULL
)
25367 /* Append glyph strings for glyphs following the last glyph
25368 string tail that overwrite tail. The foreground of such
25369 glyphs has to be drawn because it writes into the background
25370 of tail. The background must not be drawn because it could
25371 paint over the foreground of following glyphs. */
25372 i
= right_overwriting (tail
);
25375 enum draw_glyphs_face overlap_hl
;
25376 if (check_mouse_face
25377 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25378 overlap_hl
= DRAW_MOUSE_FACE
;
25380 overlap_hl
= DRAW_NORMAL_TEXT
;
25382 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25384 i
++; /* We must include the Ith glyph. */
25385 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25386 overlap_hl
, x
, last_x
);
25387 for (s
= h
; s
; s
= s
->next
)
25388 s
->background_filled_p
= 1;
25389 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25390 append_glyph_string_lists (&head
, &tail
, h
, t
);
25392 if (clip_head
|| clip_tail
)
25393 for (s
= head
; s
; s
= s
->next
)
25395 s
->clip_head
= clip_head
;
25396 s
->clip_tail
= clip_tail
;
25400 /* Draw all strings. */
25401 for (s
= head
; s
; s
= s
->next
)
25402 FRAME_RIF (f
)->draw_glyph_string (s
);
25405 /* When focus a sole frame and move horizontally, this sets on_p to 0
25406 causing a failure to erase prev cursor position. */
25407 if (area
== TEXT_AREA
25408 && !row
->full_width_p
25409 /* When drawing overlapping rows, only the glyph strings'
25410 foreground is drawn, which doesn't erase a cursor
25414 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25415 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25416 : (tail
? tail
->x
+ tail
->background_width
: x
));
25420 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25421 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25425 /* Value is the x-position up to which drawn, relative to AREA of W.
25426 This doesn't include parts drawn because of overhangs. */
25427 if (row
->full_width_p
)
25428 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25430 x_reached
-= area_left
;
25432 RELEASE_HDC (hdc
, f
);
25438 /* Expand row matrix if too narrow. Don't expand if area
25441 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25443 if (!it->f->fonts_changed \
25444 && (it->glyph_row->glyphs[area] \
25445 < it->glyph_row->glyphs[area + 1])) \
25447 it->w->ncols_scale_factor++; \
25448 it->f->fonts_changed = 1; \
25452 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25453 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25456 append_glyph (struct it
*it
)
25458 struct glyph
*glyph
;
25459 enum glyph_row_area area
= it
->area
;
25461 eassert (it
->glyph_row
);
25462 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25464 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25465 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25467 /* If the glyph row is reversed, we need to prepend the glyph
25468 rather than append it. */
25469 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25473 /* Make room for the additional glyph. */
25474 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25476 glyph
= it
->glyph_row
->glyphs
[area
];
25478 glyph
->charpos
= CHARPOS (it
->position
);
25479 glyph
->object
= it
->object
;
25480 if (it
->pixel_width
> 0)
25482 glyph
->pixel_width
= it
->pixel_width
;
25483 glyph
->padding_p
= 0;
25487 /* Assure at least 1-pixel width. Otherwise, cursor can't
25488 be displayed correctly. */
25489 glyph
->pixel_width
= 1;
25490 glyph
->padding_p
= 1;
25492 glyph
->ascent
= it
->ascent
;
25493 glyph
->descent
= it
->descent
;
25494 glyph
->voffset
= it
->voffset
;
25495 glyph
->type
= CHAR_GLYPH
;
25496 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25497 glyph
->multibyte_p
= it
->multibyte_p
;
25498 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25500 /* In R2L rows, the left and the right box edges need to be
25501 drawn in reverse direction. */
25502 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25503 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25507 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25508 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25510 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25511 || it
->phys_descent
> it
->descent
);
25512 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25513 glyph
->face_id
= it
->face_id
;
25514 glyph
->u
.ch
= it
->char_to_display
;
25515 glyph
->slice
.img
= null_glyph_slice
;
25516 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25519 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25520 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25521 glyph
->bidi_type
= it
->bidi_it
.type
;
25525 glyph
->resolved_level
= 0;
25526 glyph
->bidi_type
= UNKNOWN_BT
;
25528 ++it
->glyph_row
->used
[area
];
25531 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25534 /* Store one glyph for the composition IT->cmp_it.id in
25535 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25539 append_composite_glyph (struct it
*it
)
25541 struct glyph
*glyph
;
25542 enum glyph_row_area area
= it
->area
;
25544 eassert (it
->glyph_row
);
25546 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25547 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25549 /* If the glyph row is reversed, we need to prepend the glyph
25550 rather than append it. */
25551 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25555 /* Make room for the new glyph. */
25556 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25558 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25560 glyph
->charpos
= it
->cmp_it
.charpos
;
25561 glyph
->object
= it
->object
;
25562 glyph
->pixel_width
= it
->pixel_width
;
25563 glyph
->ascent
= it
->ascent
;
25564 glyph
->descent
= it
->descent
;
25565 glyph
->voffset
= it
->voffset
;
25566 glyph
->type
= COMPOSITE_GLYPH
;
25567 if (it
->cmp_it
.ch
< 0)
25569 glyph
->u
.cmp
.automatic
= 0;
25570 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25571 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25575 glyph
->u
.cmp
.automatic
= 1;
25576 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25577 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25578 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25580 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25581 glyph
->multibyte_p
= it
->multibyte_p
;
25582 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25584 /* In R2L rows, the left and the right box edges need to be
25585 drawn in reverse direction. */
25586 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25587 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25591 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25592 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25594 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25595 || it
->phys_descent
> it
->descent
);
25596 glyph
->padding_p
= 0;
25597 glyph
->glyph_not_available_p
= 0;
25598 glyph
->face_id
= it
->face_id
;
25599 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25602 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25603 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25604 glyph
->bidi_type
= it
->bidi_it
.type
;
25606 ++it
->glyph_row
->used
[area
];
25609 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25613 /* Change IT->ascent and IT->height according to the setting of
25617 take_vertical_position_into_account (struct it
*it
)
25621 if (it
->voffset
< 0)
25622 /* Increase the ascent so that we can display the text higher
25624 it
->ascent
-= it
->voffset
;
25626 /* Increase the descent so that we can display the text lower
25628 it
->descent
+= it
->voffset
;
25633 /* Produce glyphs/get display metrics for the image IT is loaded with.
25634 See the description of struct display_iterator in dispextern.h for
25635 an overview of struct display_iterator. */
25638 produce_image_glyph (struct it
*it
)
25642 int glyph_ascent
, crop
;
25643 struct glyph_slice slice
;
25645 eassert (it
->what
== IT_IMAGE
);
25647 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25649 /* Make sure X resources of the face is loaded. */
25650 prepare_face_for_display (it
->f
, face
);
25652 if (it
->image_id
< 0)
25654 /* Fringe bitmap. */
25655 it
->ascent
= it
->phys_ascent
= 0;
25656 it
->descent
= it
->phys_descent
= 0;
25657 it
->pixel_width
= 0;
25662 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25664 /* Make sure X resources of the image is loaded. */
25665 prepare_image_for_display (it
->f
, img
);
25667 slice
.x
= slice
.y
= 0;
25668 slice
.width
= img
->width
;
25669 slice
.height
= img
->height
;
25671 if (INTEGERP (it
->slice
.x
))
25672 slice
.x
= XINT (it
->slice
.x
);
25673 else if (FLOATP (it
->slice
.x
))
25674 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25676 if (INTEGERP (it
->slice
.y
))
25677 slice
.y
= XINT (it
->slice
.y
);
25678 else if (FLOATP (it
->slice
.y
))
25679 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25681 if (INTEGERP (it
->slice
.width
))
25682 slice
.width
= XINT (it
->slice
.width
);
25683 else if (FLOATP (it
->slice
.width
))
25684 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25686 if (INTEGERP (it
->slice
.height
))
25687 slice
.height
= XINT (it
->slice
.height
);
25688 else if (FLOATP (it
->slice
.height
))
25689 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25691 if (slice
.x
>= img
->width
)
25692 slice
.x
= img
->width
;
25693 if (slice
.y
>= img
->height
)
25694 slice
.y
= img
->height
;
25695 if (slice
.x
+ slice
.width
>= img
->width
)
25696 slice
.width
= img
->width
- slice
.x
;
25697 if (slice
.y
+ slice
.height
> img
->height
)
25698 slice
.height
= img
->height
- slice
.y
;
25700 if (slice
.width
== 0 || slice
.height
== 0)
25703 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25705 it
->descent
= slice
.height
- glyph_ascent
;
25707 it
->descent
+= img
->vmargin
;
25708 if (slice
.y
+ slice
.height
== img
->height
)
25709 it
->descent
+= img
->vmargin
;
25710 it
->phys_descent
= it
->descent
;
25712 it
->pixel_width
= slice
.width
;
25714 it
->pixel_width
+= img
->hmargin
;
25715 if (slice
.x
+ slice
.width
== img
->width
)
25716 it
->pixel_width
+= img
->hmargin
;
25718 /* It's quite possible for images to have an ascent greater than
25719 their height, so don't get confused in that case. */
25720 if (it
->descent
< 0)
25725 if (face
->box
!= FACE_NO_BOX
)
25727 if (face
->box_line_width
> 0)
25730 it
->ascent
+= face
->box_line_width
;
25731 if (slice
.y
+ slice
.height
== img
->height
)
25732 it
->descent
+= face
->box_line_width
;
25735 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25736 it
->pixel_width
+= eabs (face
->box_line_width
);
25737 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25738 it
->pixel_width
+= eabs (face
->box_line_width
);
25741 take_vertical_position_into_account (it
);
25743 /* Automatically crop wide image glyphs at right edge so we can
25744 draw the cursor on same display row. */
25745 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25746 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25748 it
->pixel_width
-= crop
;
25749 slice
.width
-= crop
;
25754 struct glyph
*glyph
;
25755 enum glyph_row_area area
= it
->area
;
25757 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25758 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25760 glyph
->charpos
= CHARPOS (it
->position
);
25761 glyph
->object
= it
->object
;
25762 glyph
->pixel_width
= it
->pixel_width
;
25763 glyph
->ascent
= glyph_ascent
;
25764 glyph
->descent
= it
->descent
;
25765 glyph
->voffset
= it
->voffset
;
25766 glyph
->type
= IMAGE_GLYPH
;
25767 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25768 glyph
->multibyte_p
= it
->multibyte_p
;
25769 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25771 /* In R2L rows, the left and the right box edges need to be
25772 drawn in reverse direction. */
25773 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25774 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25778 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25779 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25781 glyph
->overlaps_vertically_p
= 0;
25782 glyph
->padding_p
= 0;
25783 glyph
->glyph_not_available_p
= 0;
25784 glyph
->face_id
= it
->face_id
;
25785 glyph
->u
.img_id
= img
->id
;
25786 glyph
->slice
.img
= slice
;
25787 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25790 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25791 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25792 glyph
->bidi_type
= it
->bidi_it
.type
;
25794 ++it
->glyph_row
->used
[area
];
25797 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25801 #ifdef HAVE_XWIDGETS
25803 produce_xwidget_glyph (struct it
*it
)
25805 struct xwidget
* xw
;
25807 int glyph_ascent
, crop
;
25808 printf("produce_xwidget_glyph:\n");
25809 eassert (it
->what
== IT_XWIDGET
);
25811 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25813 /* Make sure X resources of the face is loaded. */
25814 prepare_face_for_display (it
->f
, face
);
25817 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
25818 it
->descent
= xw
->height
/2;
25819 it
->phys_descent
= it
->descent
;
25820 it
->pixel_width
= xw
->width
;
25821 /* It's quite possible for images to have an ascent greater than
25822 their height, so don't get confused in that case. */
25823 if (it
->descent
< 0)
25828 if (face
->box
!= FACE_NO_BOX
)
25830 if (face
->box_line_width
> 0)
25832 it
->ascent
+= face
->box_line_width
;
25833 it
->descent
+= face
->box_line_width
;
25836 if (it
->start_of_box_run_p
)
25837 it
->pixel_width
+= eabs (face
->box_line_width
);
25838 it
->pixel_width
+= eabs (face
->box_line_width
);
25841 take_vertical_position_into_account (it
);
25843 /* Automatically crop wide image glyphs at right edge so we can
25844 draw the cursor on same display row. */
25845 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25846 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25848 it
->pixel_width
-= crop
;
25853 struct glyph
*glyph
;
25854 enum glyph_row_area area
= it
->area
;
25856 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25857 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25859 glyph
->charpos
= CHARPOS (it
->position
);
25860 glyph
->object
= it
->object
;
25861 glyph
->pixel_width
= it
->pixel_width
;
25862 glyph
->ascent
= glyph_ascent
;
25863 glyph
->descent
= it
->descent
;
25864 glyph
->voffset
= it
->voffset
;
25865 glyph
->type
= XWIDGET_GLYPH
;
25866 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25867 glyph
->multibyte_p
= it
->multibyte_p
;
25868 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25870 /* In R2L rows, the left and the right box edges need to be
25871 drawn in reverse direction. */
25872 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25873 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25877 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25878 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25880 glyph
->overlaps_vertically_p
= 0;
25881 glyph
->padding_p
= 0;
25882 glyph
->glyph_not_available_p
= 0;
25883 glyph
->face_id
= it
->face_id
;
25884 glyph
->u
.xwidget
= it
->xwidget
;
25885 //assert_valid_xwidget_id(glyph->u.xwidget_id,"produce_xwidget_glyph");
25886 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25889 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25890 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25891 glyph
->bidi_type
= it
->bidi_it
.type
;
25893 ++it
->glyph_row
->used
[area
];
25896 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25901 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25902 of the glyph, WIDTH and HEIGHT are the width and height of the
25903 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25906 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25907 int width
, int height
, int ascent
)
25909 struct glyph
*glyph
;
25910 enum glyph_row_area area
= it
->area
;
25912 eassert (ascent
>= 0 && ascent
<= height
);
25914 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25915 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25917 /* If the glyph row is reversed, we need to prepend the glyph
25918 rather than append it. */
25919 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25923 /* Make room for the additional glyph. */
25924 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25926 glyph
= it
->glyph_row
->glyphs
[area
];
25928 /* Decrease the width of the first glyph of the row that
25929 begins before first_visible_x (e.g., due to hscroll).
25930 This is so the overall width of the row becomes smaller
25931 by the scroll amount, and the stretch glyph appended by
25932 extend_face_to_end_of_line will be wider, to shift the
25933 row glyphs to the right. (In L2R rows, the corresponding
25934 left-shift effect is accomplished by setting row->x to a
25935 negative value, which won't work with R2L rows.)
25937 This must leave us with a positive value of WIDTH, since
25938 otherwise the call to move_it_in_display_line_to at the
25939 beginning of display_line would have got past the entire
25940 first glyph, and then it->current_x would have been
25941 greater or equal to it->first_visible_x. */
25942 if (it
->current_x
< it
->first_visible_x
)
25943 width
-= it
->first_visible_x
- it
->current_x
;
25944 eassert (width
> 0);
25946 glyph
->charpos
= CHARPOS (it
->position
);
25947 glyph
->object
= object
;
25948 glyph
->pixel_width
= width
;
25949 glyph
->ascent
= ascent
;
25950 glyph
->descent
= height
- ascent
;
25951 glyph
->voffset
= it
->voffset
;
25952 glyph
->type
= STRETCH_GLYPH
;
25953 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25954 glyph
->multibyte_p
= it
->multibyte_p
;
25955 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25957 /* In R2L rows, the left and the right box edges need to be
25958 drawn in reverse direction. */
25959 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25960 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25964 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25965 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25967 glyph
->overlaps_vertically_p
= 0;
25968 glyph
->padding_p
= 0;
25969 glyph
->glyph_not_available_p
= 0;
25970 glyph
->face_id
= it
->face_id
;
25971 glyph
->u
.stretch
.ascent
= ascent
;
25972 glyph
->u
.stretch
.height
= height
;
25973 glyph
->slice
.img
= null_glyph_slice
;
25974 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25977 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25978 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25979 glyph
->bidi_type
= it
->bidi_it
.type
;
25983 glyph
->resolved_level
= 0;
25984 glyph
->bidi_type
= UNKNOWN_BT
;
25986 ++it
->glyph_row
->used
[area
];
25989 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25992 #endif /* HAVE_WINDOW_SYSTEM */
25994 /* Produce a stretch glyph for iterator IT. IT->object is the value
25995 of the glyph property displayed. The value must be a list
25996 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25999 1. `:width WIDTH' specifies that the space should be WIDTH *
26000 canonical char width wide. WIDTH may be an integer or floating
26003 2. `:relative-width FACTOR' specifies that the width of the stretch
26004 should be computed from the width of the first character having the
26005 `glyph' property, and should be FACTOR times that width.
26007 3. `:align-to HPOS' specifies that the space should be wide enough
26008 to reach HPOS, a value in canonical character units.
26010 Exactly one of the above pairs must be present.
26012 4. `:height HEIGHT' specifies that the height of the stretch produced
26013 should be HEIGHT, measured in canonical character units.
26015 5. `:relative-height FACTOR' specifies that the height of the
26016 stretch should be FACTOR times the height of the characters having
26017 the glyph property.
26019 Either none or exactly one of 4 or 5 must be present.
26021 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26022 of the stretch should be used for the ascent of the stretch.
26023 ASCENT must be in the range 0 <= ASCENT <= 100. */
26026 produce_stretch_glyph (struct it
*it
)
26028 /* (space :width WIDTH :height HEIGHT ...) */
26029 Lisp_Object prop
, plist
;
26030 int width
= 0, height
= 0, align_to
= -1;
26031 int zero_width_ok_p
= 0;
26033 struct font
*font
= NULL
;
26035 #ifdef HAVE_WINDOW_SYSTEM
26037 int zero_height_ok_p
= 0;
26039 if (FRAME_WINDOW_P (it
->f
))
26041 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26042 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26043 prepare_face_for_display (it
->f
, face
);
26047 /* List should start with `space'. */
26048 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26049 plist
= XCDR (it
->object
);
26051 /* Compute the width of the stretch. */
26052 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26053 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
26055 /* Absolute width `:width WIDTH' specified and valid. */
26056 zero_width_ok_p
= 1;
26059 #ifdef HAVE_WINDOW_SYSTEM
26060 else if (FRAME_WINDOW_P (it
->f
)
26061 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
26063 /* Relative width `:relative-width FACTOR' specified and valid.
26064 Compute the width of the characters having the `glyph'
26067 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26070 if (it
->multibyte_p
)
26071 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26074 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26075 if (! ASCII_CHAR_P (it2
.c
))
26076 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26079 it2
.glyph_row
= NULL
;
26080 it2
.what
= IT_CHARACTER
;
26081 x_produce_glyphs (&it2
);
26082 width
= NUMVAL (prop
) * it2
.pixel_width
;
26084 #endif /* HAVE_WINDOW_SYSTEM */
26085 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26086 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
26088 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26089 align_to
= (align_to
< 0
26091 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26092 else if (align_to
< 0)
26093 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26094 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26095 zero_width_ok_p
= 1;
26098 /* Nothing specified -> width defaults to canonical char width. */
26099 width
= FRAME_COLUMN_WIDTH (it
->f
);
26101 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26104 #ifdef HAVE_WINDOW_SYSTEM
26105 /* Compute height. */
26106 if (FRAME_WINDOW_P (it
->f
))
26108 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26109 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
26112 zero_height_ok_p
= 1;
26114 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26116 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
26118 height
= FONT_HEIGHT (font
);
26120 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26123 /* Compute percentage of height used for ascent. If
26124 `:ascent ASCENT' is present and valid, use that. Otherwise,
26125 derive the ascent from the font in use. */
26126 if (prop
= Fplist_get (plist
, QCascent
),
26127 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26128 ascent
= height
* NUMVAL (prop
) / 100.0;
26129 else if (!NILP (prop
)
26130 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
26131 ascent
= min (max (0, (int)tem
), height
);
26133 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26136 #endif /* HAVE_WINDOW_SYSTEM */
26139 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26140 && it
->current_x
+ width
> it
->last_visible_x
)
26142 width
= it
->last_visible_x
- it
->current_x
;
26143 #ifdef HAVE_WINDOW_SYSTEM
26144 /* Subtract one more pixel from the stretch width, but only on
26145 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26146 width
-= FRAME_WINDOW_P (it
->f
);
26150 if (width
> 0 && height
> 0 && it
->glyph_row
)
26152 Lisp_Object o_object
= it
->object
;
26153 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26156 if (!STRINGP (object
))
26157 object
= it
->w
->contents
;
26158 #ifdef HAVE_WINDOW_SYSTEM
26159 if (FRAME_WINDOW_P (it
->f
))
26160 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26164 it
->object
= object
;
26165 it
->char_to_display
= ' ';
26166 it
->pixel_width
= it
->len
= 1;
26168 tty_append_glyph (it
);
26169 it
->object
= o_object
;
26173 it
->pixel_width
= width
;
26174 #ifdef HAVE_WINDOW_SYSTEM
26175 if (FRAME_WINDOW_P (it
->f
))
26177 it
->ascent
= it
->phys_ascent
= ascent
;
26178 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26179 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
26180 take_vertical_position_into_account (it
);
26184 it
->nglyphs
= width
;
26187 /* Get information about special display element WHAT in an
26188 environment described by IT. WHAT is one of IT_TRUNCATION or
26189 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26190 non-null glyph_row member. This function ensures that fields like
26191 face_id, c, len of IT are left untouched. */
26194 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26201 temp_it
.object
= Qnil
;
26202 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26204 if (what
== IT_CONTINUATION
)
26206 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26207 if (it
->bidi_it
.paragraph_dir
== R2L
)
26208 SET_GLYPH_FROM_CHAR (glyph
, '/');
26210 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26212 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26214 /* FIXME: Should we mirror GC for R2L lines? */
26215 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26216 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26219 else if (what
== IT_TRUNCATION
)
26221 /* Truncation glyph. */
26222 SET_GLYPH_FROM_CHAR (glyph
, '$');
26224 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26226 /* FIXME: Should we mirror GC for R2L lines? */
26227 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26228 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26234 #ifdef HAVE_WINDOW_SYSTEM
26235 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26236 is turned off, we precede the truncation/continuation glyphs by a
26237 stretch glyph whose width is computed such that these special
26238 glyphs are aligned at the window margin, even when very different
26239 fonts are used in different glyph rows. */
26240 if (FRAME_WINDOW_P (temp_it
.f
)
26241 /* init_iterator calls this with it->glyph_row == NULL, and it
26242 wants only the pixel width of the truncation/continuation
26244 && temp_it
.glyph_row
26245 /* insert_left_trunc_glyphs calls us at the beginning of the
26246 row, and it has its own calculation of the stretch glyph
26248 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26249 && (temp_it
.glyph_row
->reversed_p
26250 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26251 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26253 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26255 if (stretch_width
> 0)
26257 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26258 struct font
*font
=
26259 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26260 int stretch_ascent
=
26261 (((temp_it
.ascent
+ temp_it
.descent
)
26262 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26264 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26265 temp_it
.ascent
+ temp_it
.descent
,
26272 temp_it
.what
= IT_CHARACTER
;
26273 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26274 temp_it
.face_id
= GLYPH_FACE (glyph
);
26275 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26277 PRODUCE_GLYPHS (&temp_it
);
26278 it
->pixel_width
= temp_it
.pixel_width
;
26279 it
->nglyphs
= temp_it
.nglyphs
;
26282 #ifdef HAVE_WINDOW_SYSTEM
26284 /* Calculate line-height and line-spacing properties.
26285 An integer value specifies explicit pixel value.
26286 A float value specifies relative value to current face height.
26287 A cons (float . face-name) specifies relative value to
26288 height of specified face font.
26290 Returns height in pixels, or nil. */
26294 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26295 int boff
, int override
)
26297 Lisp_Object face_name
= Qnil
;
26298 int ascent
, descent
, height
;
26300 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26305 face_name
= XCAR (val
);
26307 if (!NUMBERP (val
))
26308 val
= make_number (1);
26309 if (NILP (face_name
))
26311 height
= it
->ascent
+ it
->descent
;
26316 if (NILP (face_name
))
26318 font
= FRAME_FONT (it
->f
);
26319 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26321 else if (EQ (face_name
, Qt
))
26330 face_id
= lookup_named_face (it
->f
, face_name
, 0);
26332 return make_number (-1);
26334 face
= FACE_FROM_ID (it
->f
, face_id
);
26337 return make_number (-1);
26338 boff
= font
->baseline_offset
;
26339 if (font
->vertical_centering
)
26340 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26343 ascent
= FONT_BASE (font
) + boff
;
26344 descent
= FONT_DESCENT (font
) - boff
;
26348 it
->override_ascent
= ascent
;
26349 it
->override_descent
= descent
;
26350 it
->override_boff
= boff
;
26353 height
= ascent
+ descent
;
26357 height
= (int)(XFLOAT_DATA (val
) * height
);
26358 else if (INTEGERP (val
))
26359 height
*= XINT (val
);
26361 return make_number (height
);
26365 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26366 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
26367 and only if this is for a character for which no font was found.
26369 If the display method (it->glyphless_method) is
26370 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26371 length of the acronym or the hexadecimal string, UPPER_XOFF and
26372 UPPER_YOFF are pixel offsets for the upper part of the string,
26373 LOWER_XOFF and LOWER_YOFF are for the lower part.
26375 For the other display methods, LEN through LOWER_YOFF are zero. */
26378 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
26379 short upper_xoff
, short upper_yoff
,
26380 short lower_xoff
, short lower_yoff
)
26382 struct glyph
*glyph
;
26383 enum glyph_row_area area
= it
->area
;
26385 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26386 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26388 /* If the glyph row is reversed, we need to prepend the glyph
26389 rather than append it. */
26390 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26394 /* Make room for the additional glyph. */
26395 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26397 glyph
= it
->glyph_row
->glyphs
[area
];
26399 glyph
->charpos
= CHARPOS (it
->position
);
26400 glyph
->object
= it
->object
;
26401 glyph
->pixel_width
= it
->pixel_width
;
26402 glyph
->ascent
= it
->ascent
;
26403 glyph
->descent
= it
->descent
;
26404 glyph
->voffset
= it
->voffset
;
26405 glyph
->type
= GLYPHLESS_GLYPH
;
26406 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26407 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26408 glyph
->u
.glyphless
.len
= len
;
26409 glyph
->u
.glyphless
.ch
= it
->c
;
26410 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26411 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26412 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26413 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26414 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26415 glyph
->multibyte_p
= it
->multibyte_p
;
26416 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26418 /* In R2L rows, the left and the right box edges need to be
26419 drawn in reverse direction. */
26420 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26421 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26425 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26426 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26428 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26429 || it
->phys_descent
> it
->descent
);
26430 glyph
->padding_p
= 0;
26431 glyph
->glyph_not_available_p
= 0;
26432 glyph
->face_id
= face_id
;
26433 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26436 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26437 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26438 glyph
->bidi_type
= it
->bidi_it
.type
;
26440 ++it
->glyph_row
->used
[area
];
26443 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26447 /* Produce a glyph for a glyphless character for iterator IT.
26448 IT->glyphless_method specifies which method to use for displaying
26449 the character. See the description of enum
26450 glyphless_display_method in dispextern.h for the detail.
26452 FOR_NO_FONT is nonzero if and only if this is for a character for
26453 which no font was found. ACRONYM, if non-nil, is an acronym string
26454 for the character. */
26457 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
26462 int base_width
, base_height
, width
, height
;
26463 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26466 /* Get the metrics of the base font. We always refer to the current
26468 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26469 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26470 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
26471 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
26472 base_height
= it
->ascent
+ it
->descent
;
26473 base_width
= font
->average_width
;
26475 face_id
= merge_glyphless_glyph_face (it
);
26477 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26479 it
->pixel_width
= THIN_SPACE_WIDTH
;
26481 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26483 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26485 width
= CHAR_WIDTH (it
->c
);
26488 else if (width
> 4)
26490 it
->pixel_width
= base_width
* width
;
26492 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26498 unsigned int code
[6];
26500 int ascent
, descent
;
26501 struct font_metrics metrics_upper
, metrics_lower
;
26503 face
= FACE_FROM_ID (it
->f
, face_id
);
26504 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26505 prepare_face_for_display (it
->f
, face
);
26507 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26509 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26510 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26511 if (CONSP (acronym
))
26512 acronym
= XCAR (acronym
);
26513 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26517 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26518 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26521 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26522 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26523 upper_len
= (len
+ 1) / 2;
26524 font
->driver
->text_extents (font
, code
, upper_len
,
26526 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26531 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26532 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26533 upper_xoff
= upper_yoff
= 2; /* the typical case */
26534 if (base_width
>= width
)
26536 /* Align the upper to the left, the lower to the right. */
26537 it
->pixel_width
= base_width
;
26538 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26542 /* Center the shorter one. */
26543 it
->pixel_width
= width
;
26544 if (metrics_upper
.width
>= metrics_lower
.width
)
26545 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26548 /* FIXME: This code doesn't look right. It formerly was
26549 missing the "lower_xoff = 0;", which couldn't have
26550 been right since it left lower_xoff uninitialized. */
26552 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26556 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26557 top, bottom, and between upper and lower strings. */
26558 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26559 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26560 /* Center vertically.
26561 H:base_height, D:base_descent
26562 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26564 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26565 descent = D - H/2 + h/2;
26566 lower_yoff = descent - 2 - ld;
26567 upper_yoff = lower_yoff - la - 1 - ud; */
26568 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26569 descent
= it
->descent
- (base_height
- height
) / 2;
26570 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26571 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26572 - metrics_upper
.descent
);
26573 /* Don't make the height shorter than the base height. */
26574 if (height
> base_height
)
26576 it
->ascent
= ascent
;
26577 it
->descent
= descent
;
26581 it
->phys_ascent
= it
->ascent
;
26582 it
->phys_descent
= it
->descent
;
26584 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26585 upper_xoff
, upper_yoff
,
26586 lower_xoff
, lower_yoff
);
26588 take_vertical_position_into_account (it
);
26593 Produce glyphs/get display metrics for the display element IT is
26594 loaded with. See the description of struct it in dispextern.h
26595 for an overview of struct it. */
26598 x_produce_glyphs (struct it
*it
)
26600 int extra_line_spacing
= it
->extra_line_spacing
;
26602 it
->glyph_not_available_p
= 0;
26604 if (it
->what
== IT_CHARACTER
)
26607 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26608 struct font
*font
= face
->font
;
26609 struct font_metrics
*pcm
= NULL
;
26610 int boff
; /* Baseline offset. */
26614 /* When no suitable font is found, display this character by
26615 the method specified in the first extra slot of
26616 Vglyphless_char_display. */
26617 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26619 eassert (it
->what
== IT_GLYPHLESS
);
26620 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26624 boff
= font
->baseline_offset
;
26625 if (font
->vertical_centering
)
26626 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26628 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26634 if (it
->override_ascent
>= 0)
26636 it
->ascent
= it
->override_ascent
;
26637 it
->descent
= it
->override_descent
;
26638 boff
= it
->override_boff
;
26642 it
->ascent
= FONT_BASE (font
) + boff
;
26643 it
->descent
= FONT_DESCENT (font
) - boff
;
26646 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26648 pcm
= get_per_char_metric (font
, &char2b
);
26649 if (pcm
->width
== 0
26650 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26656 it
->phys_ascent
= pcm
->ascent
+ boff
;
26657 it
->phys_descent
= pcm
->descent
- boff
;
26658 it
->pixel_width
= pcm
->width
;
26662 it
->glyph_not_available_p
= 1;
26663 it
->phys_ascent
= it
->ascent
;
26664 it
->phys_descent
= it
->descent
;
26665 it
->pixel_width
= font
->space_width
;
26668 if (it
->constrain_row_ascent_descent_p
)
26670 if (it
->descent
> it
->max_descent
)
26672 it
->ascent
+= it
->descent
- it
->max_descent
;
26673 it
->descent
= it
->max_descent
;
26675 if (it
->ascent
> it
->max_ascent
)
26677 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26678 it
->ascent
= it
->max_ascent
;
26680 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26681 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26682 extra_line_spacing
= 0;
26685 /* If this is a space inside a region of text with
26686 `space-width' property, change its width. */
26687 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26689 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26691 /* If face has a box, add the box thickness to the character
26692 height. If character has a box line to the left and/or
26693 right, add the box line width to the character's width. */
26694 if (face
->box
!= FACE_NO_BOX
)
26696 int thick
= face
->box_line_width
;
26700 it
->ascent
+= thick
;
26701 it
->descent
+= thick
;
26706 if (it
->start_of_box_run_p
)
26707 it
->pixel_width
+= thick
;
26708 if (it
->end_of_box_run_p
)
26709 it
->pixel_width
+= thick
;
26712 /* If face has an overline, add the height of the overline
26713 (1 pixel) and a 1 pixel margin to the character height. */
26714 if (face
->overline_p
)
26715 it
->ascent
+= overline_margin
;
26717 if (it
->constrain_row_ascent_descent_p
)
26719 if (it
->ascent
> it
->max_ascent
)
26720 it
->ascent
= it
->max_ascent
;
26721 if (it
->descent
> it
->max_descent
)
26722 it
->descent
= it
->max_descent
;
26725 take_vertical_position_into_account (it
);
26727 /* If we have to actually produce glyphs, do it. */
26732 /* Translate a space with a `space-width' property
26733 into a stretch glyph. */
26734 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26735 / FONT_HEIGHT (font
));
26736 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26737 it
->ascent
+ it
->descent
, ascent
);
26742 /* If characters with lbearing or rbearing are displayed
26743 in this line, record that fact in a flag of the
26744 glyph row. This is used to optimize X output code. */
26745 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26746 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26748 if (! stretched_p
&& it
->pixel_width
== 0)
26749 /* We assure that all visible glyphs have at least 1-pixel
26751 it
->pixel_width
= 1;
26753 else if (it
->char_to_display
== '\n')
26755 /* A newline has no width, but we need the height of the
26756 line. But if previous part of the line sets a height,
26757 don't increase that height. */
26759 Lisp_Object height
;
26760 Lisp_Object total_height
= Qnil
;
26762 it
->override_ascent
= -1;
26763 it
->pixel_width
= 0;
26766 height
= get_it_property (it
, Qline_height
);
26767 /* Split (line-height total-height) list. */
26769 && CONSP (XCDR (height
))
26770 && NILP (XCDR (XCDR (height
))))
26772 total_height
= XCAR (XCDR (height
));
26773 height
= XCAR (height
);
26775 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26777 if (it
->override_ascent
>= 0)
26779 it
->ascent
= it
->override_ascent
;
26780 it
->descent
= it
->override_descent
;
26781 boff
= it
->override_boff
;
26785 it
->ascent
= FONT_BASE (font
) + boff
;
26786 it
->descent
= FONT_DESCENT (font
) - boff
;
26789 if (EQ (height
, Qt
))
26791 if (it
->descent
> it
->max_descent
)
26793 it
->ascent
+= it
->descent
- it
->max_descent
;
26794 it
->descent
= it
->max_descent
;
26796 if (it
->ascent
> it
->max_ascent
)
26798 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26799 it
->ascent
= it
->max_ascent
;
26801 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26802 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26803 it
->constrain_row_ascent_descent_p
= 1;
26804 extra_line_spacing
= 0;
26808 Lisp_Object spacing
;
26810 it
->phys_ascent
= it
->ascent
;
26811 it
->phys_descent
= it
->descent
;
26813 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26814 && face
->box
!= FACE_NO_BOX
26815 && face
->box_line_width
> 0)
26817 it
->ascent
+= face
->box_line_width
;
26818 it
->descent
+= face
->box_line_width
;
26821 && XINT (height
) > it
->ascent
+ it
->descent
)
26822 it
->ascent
= XINT (height
) - it
->descent
;
26824 if (!NILP (total_height
))
26825 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26828 spacing
= get_it_property (it
, Qline_spacing
);
26829 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26831 if (INTEGERP (spacing
))
26833 extra_line_spacing
= XINT (spacing
);
26834 if (!NILP (total_height
))
26835 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26839 else /* i.e. (it->char_to_display == '\t') */
26841 if (font
->space_width
> 0)
26843 int tab_width
= it
->tab_width
* font
->space_width
;
26844 int x
= it
->current_x
+ it
->continuation_lines_width
;
26845 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26847 /* If the distance from the current position to the next tab
26848 stop is less than a space character width, use the
26849 tab stop after that. */
26850 if (next_tab_x
- x
< font
->space_width
)
26851 next_tab_x
+= tab_width
;
26853 it
->pixel_width
= next_tab_x
- x
;
26855 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26856 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26860 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26861 it
->ascent
+ it
->descent
, it
->ascent
);
26866 it
->pixel_width
= 0;
26871 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26873 /* A static composition.
26875 Note: A composition is represented as one glyph in the
26876 glyph matrix. There are no padding glyphs.
26878 Important note: pixel_width, ascent, and descent are the
26879 values of what is drawn by draw_glyphs (i.e. the values of
26880 the overall glyphs composed). */
26881 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26882 int boff
; /* baseline offset */
26883 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26884 int glyph_len
= cmp
->glyph_len
;
26885 struct font
*font
= face
->font
;
26889 /* If we have not yet calculated pixel size data of glyphs of
26890 the composition for the current face font, calculate them
26891 now. Theoretically, we have to check all fonts for the
26892 glyphs, but that requires much time and memory space. So,
26893 here we check only the font of the first glyph. This may
26894 lead to incorrect display, but it's very rare, and C-l
26895 (recenter-top-bottom) can correct the display anyway. */
26896 if (! cmp
->font
|| cmp
->font
!= font
)
26898 /* Ascent and descent of the font of the first character
26899 of this composition (adjusted by baseline offset).
26900 Ascent and descent of overall glyphs should not be less
26901 than these, respectively. */
26902 int font_ascent
, font_descent
, font_height
;
26903 /* Bounding box of the overall glyphs. */
26904 int leftmost
, rightmost
, lowest
, highest
;
26905 int lbearing
, rbearing
;
26906 int i
, width
, ascent
, descent
;
26907 int left_padded
= 0, right_padded
= 0;
26908 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26910 struct font_metrics
*pcm
;
26911 int font_not_found_p
;
26914 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26915 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26917 if (glyph_len
< cmp
->glyph_len
)
26919 for (i
= 0; i
< glyph_len
; i
++)
26921 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26923 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26928 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26929 : IT_CHARPOS (*it
));
26930 /* If no suitable font is found, use the default font. */
26931 font_not_found_p
= font
== NULL
;
26932 if (font_not_found_p
)
26934 face
= face
->ascii_face
;
26937 boff
= font
->baseline_offset
;
26938 if (font
->vertical_centering
)
26939 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26940 font_ascent
= FONT_BASE (font
) + boff
;
26941 font_descent
= FONT_DESCENT (font
) - boff
;
26942 font_height
= FONT_HEIGHT (font
);
26947 if (! font_not_found_p
)
26949 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26951 pcm
= get_per_char_metric (font
, &char2b
);
26954 /* Initialize the bounding box. */
26957 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26958 ascent
= pcm
->ascent
;
26959 descent
= pcm
->descent
;
26960 lbearing
= pcm
->lbearing
;
26961 rbearing
= pcm
->rbearing
;
26965 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26966 ascent
= FONT_BASE (font
);
26967 descent
= FONT_DESCENT (font
);
26974 lowest
= - descent
+ boff
;
26975 highest
= ascent
+ boff
;
26977 if (! font_not_found_p
26978 && font
->default_ascent
26979 && CHAR_TABLE_P (Vuse_default_ascent
)
26980 && !NILP (Faref (Vuse_default_ascent
,
26981 make_number (it
->char_to_display
))))
26982 highest
= font
->default_ascent
+ boff
;
26984 /* Draw the first glyph at the normal position. It may be
26985 shifted to right later if some other glyphs are drawn
26987 cmp
->offsets
[i
* 2] = 0;
26988 cmp
->offsets
[i
* 2 + 1] = boff
;
26989 cmp
->lbearing
= lbearing
;
26990 cmp
->rbearing
= rbearing
;
26992 /* Set cmp->offsets for the remaining glyphs. */
26993 for (i
++; i
< glyph_len
; i
++)
26995 int left
, right
, btm
, top
;
26996 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26998 struct face
*this_face
;
27002 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27003 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27004 font
= this_face
->font
;
27010 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27012 pcm
= get_per_char_metric (font
, &char2b
);
27015 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27018 width
= pcm
->width
;
27019 ascent
= pcm
->ascent
;
27020 descent
= pcm
->descent
;
27021 lbearing
= pcm
->lbearing
;
27022 rbearing
= pcm
->rbearing
;
27023 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27025 /* Relative composition with or without
27026 alternate chars. */
27027 left
= (leftmost
+ rightmost
- width
) / 2;
27028 btm
= - descent
+ boff
;
27029 if (font
->relative_compose
27030 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27031 || NILP (Faref (Vignore_relative_composition
,
27032 make_number (ch
)))))
27035 if (- descent
>= font
->relative_compose
)
27036 /* One extra pixel between two glyphs. */
27038 else if (ascent
<= 0)
27039 /* One extra pixel between two glyphs. */
27040 btm
= lowest
- 1 - ascent
- descent
;
27045 /* A composition rule is specified by an integer
27046 value that encodes global and new reference
27047 points (GREF and NREF). GREF and NREF are
27048 specified by numbers as below:
27050 0---1---2 -- ascent
27054 9--10--11 -- center
27056 ---3---4---5--- baseline
27058 6---7---8 -- descent
27060 int rule
= COMPOSITION_RULE (cmp
, i
);
27061 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27063 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27064 grefx
= gref
% 3, nrefx
= nref
% 3;
27065 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27067 xoff
= font_height
* (xoff
- 128) / 256;
27069 yoff
= font_height
* (yoff
- 128) / 256;
27072 + grefx
* (rightmost
- leftmost
) / 2
27073 - nrefx
* width
/ 2
27076 btm
= ((grefy
== 0 ? highest
27078 : grefy
== 2 ? lowest
27079 : (highest
+ lowest
) / 2)
27080 - (nrefy
== 0 ? ascent
+ descent
27081 : nrefy
== 1 ? descent
- boff
27083 : (ascent
+ descent
) / 2)
27087 cmp
->offsets
[i
* 2] = left
;
27088 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27090 /* Update the bounding box of the overall glyphs. */
27093 right
= left
+ width
;
27094 if (left
< leftmost
)
27096 if (right
> rightmost
)
27099 top
= btm
+ descent
+ ascent
;
27105 if (cmp
->lbearing
> left
+ lbearing
)
27106 cmp
->lbearing
= left
+ lbearing
;
27107 if (cmp
->rbearing
< left
+ rbearing
)
27108 cmp
->rbearing
= left
+ rbearing
;
27112 /* If there are glyphs whose x-offsets are negative,
27113 shift all glyphs to the right and make all x-offsets
27117 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27118 cmp
->offsets
[i
* 2] -= leftmost
;
27119 rightmost
-= leftmost
;
27120 cmp
->lbearing
-= leftmost
;
27121 cmp
->rbearing
-= leftmost
;
27124 if (left_padded
&& cmp
->lbearing
< 0)
27126 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27127 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27128 rightmost
-= cmp
->lbearing
;
27129 cmp
->rbearing
-= cmp
->lbearing
;
27132 if (right_padded
&& rightmost
< cmp
->rbearing
)
27134 rightmost
= cmp
->rbearing
;
27137 cmp
->pixel_width
= rightmost
;
27138 cmp
->ascent
= highest
;
27139 cmp
->descent
= - lowest
;
27140 if (cmp
->ascent
< font_ascent
)
27141 cmp
->ascent
= font_ascent
;
27142 if (cmp
->descent
< font_descent
)
27143 cmp
->descent
= font_descent
;
27147 && (cmp
->lbearing
< 0
27148 || cmp
->rbearing
> cmp
->pixel_width
))
27149 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
27151 it
->pixel_width
= cmp
->pixel_width
;
27152 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27153 it
->descent
= it
->phys_descent
= cmp
->descent
;
27154 if (face
->box
!= FACE_NO_BOX
)
27156 int thick
= face
->box_line_width
;
27160 it
->ascent
+= thick
;
27161 it
->descent
+= thick
;
27166 if (it
->start_of_box_run_p
)
27167 it
->pixel_width
+= thick
;
27168 if (it
->end_of_box_run_p
)
27169 it
->pixel_width
+= thick
;
27172 /* If face has an overline, add the height of the overline
27173 (1 pixel) and a 1 pixel margin to the character height. */
27174 if (face
->overline_p
)
27175 it
->ascent
+= overline_margin
;
27177 take_vertical_position_into_account (it
);
27178 if (it
->ascent
< 0)
27180 if (it
->descent
< 0)
27183 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27184 append_composite_glyph (it
);
27186 else if (it
->what
== IT_COMPOSITION
)
27188 /* A dynamic (automatic) composition. */
27189 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27190 Lisp_Object gstring
;
27191 struct font_metrics metrics
;
27195 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27197 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27200 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27201 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
27202 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27203 it
->descent
= it
->phys_descent
= metrics
.descent
;
27204 if (face
->box
!= FACE_NO_BOX
)
27206 int thick
= face
->box_line_width
;
27210 it
->ascent
+= thick
;
27211 it
->descent
+= thick
;
27216 if (it
->start_of_box_run_p
)
27217 it
->pixel_width
+= thick
;
27218 if (it
->end_of_box_run_p
)
27219 it
->pixel_width
+= thick
;
27221 /* If face has an overline, add the height of the overline
27222 (1 pixel) and a 1 pixel margin to the character height. */
27223 if (face
->overline_p
)
27224 it
->ascent
+= overline_margin
;
27225 take_vertical_position_into_account (it
);
27226 if (it
->ascent
< 0)
27228 if (it
->descent
< 0)
27232 append_composite_glyph (it
);
27234 else if (it
->what
== IT_GLYPHLESS
)
27235 produce_glyphless_glyph (it
, 0, Qnil
);
27236 else if (it
->what
== IT_IMAGE
)
27237 produce_image_glyph (it
);
27238 else if (it
->what
== IT_STRETCH
)
27239 produce_stretch_glyph (it
);
27240 #ifdef HAVE_XWIDGETS
27241 else if (it
->what
== IT_XWIDGET
)
27242 produce_xwidget_glyph (it
);
27246 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27247 because this isn't true for images with `:ascent 100'. */
27248 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27249 if (it
->area
== TEXT_AREA
)
27250 it
->current_x
+= it
->pixel_width
;
27252 if (extra_line_spacing
> 0)
27254 it
->descent
+= extra_line_spacing
;
27255 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27256 it
->max_extra_line_spacing
= extra_line_spacing
;
27259 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27260 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27261 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27262 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27266 Output LEN glyphs starting at START at the nominal cursor position.
27267 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27268 being updated, and UPDATED_AREA is the area of that row being updated. */
27271 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27272 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27274 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27276 eassert (updated_row
);
27277 /* When the window is hscrolled, cursor hpos can legitimately be out
27278 of bounds, but we draw the cursor at the corresponding window
27279 margin in that case. */
27280 if (!updated_row
->reversed_p
&& chpos
< 0)
27282 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27283 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27287 /* Write glyphs. */
27289 hpos
= start
- updated_row
->glyphs
[updated_area
];
27290 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27291 updated_row
, updated_area
,
27293 DRAW_NORMAL_TEXT
, 0);
27295 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27296 if (updated_area
== TEXT_AREA
27297 && w
->phys_cursor_on_p
27298 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27300 && chpos
< hpos
+ len
)
27301 w
->phys_cursor_on_p
= 0;
27305 /* Advance the output cursor. */
27306 w
->output_cursor
.hpos
+= len
;
27307 w
->output_cursor
.x
= x
;
27312 Insert LEN glyphs from START at the nominal cursor position. */
27315 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27316 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27319 int line_height
, shift_by_width
, shifted_region_width
;
27320 struct glyph_row
*row
;
27321 struct glyph
*glyph
;
27322 int frame_x
, frame_y
;
27325 eassert (updated_row
);
27327 f
= XFRAME (WINDOW_FRAME (w
));
27329 /* Get the height of the line we are in. */
27331 line_height
= row
->height
;
27333 /* Get the width of the glyphs to insert. */
27334 shift_by_width
= 0;
27335 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27336 shift_by_width
+= glyph
->pixel_width
;
27338 /* Get the width of the region to shift right. */
27339 shifted_region_width
= (window_box_width (w
, updated_area
)
27340 - w
->output_cursor
.x
27344 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27345 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27347 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27348 line_height
, shift_by_width
);
27350 /* Write the glyphs. */
27351 hpos
= start
- row
->glyphs
[updated_area
];
27352 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27354 DRAW_NORMAL_TEXT
, 0);
27356 /* Advance the output cursor. */
27357 w
->output_cursor
.hpos
+= len
;
27358 w
->output_cursor
.x
+= shift_by_width
;
27364 Erase the current text line from the nominal cursor position
27365 (inclusive) to pixel column TO_X (exclusive). The idea is that
27366 everything from TO_X onward is already erased.
27368 TO_X is a pixel position relative to UPDATED_AREA of currently
27369 updated window W. TO_X == -1 means clear to the end of this area. */
27372 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27373 enum glyph_row_area updated_area
, int to_x
)
27376 int max_x
, min_y
, max_y
;
27377 int from_x
, from_y
, to_y
;
27379 eassert (updated_row
);
27380 f
= XFRAME (w
->frame
);
27382 if (updated_row
->full_width_p
)
27383 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27384 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27386 max_x
= window_box_width (w
, updated_area
);
27387 max_y
= window_text_bottom_y (w
);
27389 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27390 of window. For TO_X > 0, truncate to end of drawing area. */
27396 to_x
= min (to_x
, max_x
);
27398 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27400 /* Notice if the cursor will be cleared by this operation. */
27401 if (!updated_row
->full_width_p
)
27402 notice_overwritten_cursor (w
, updated_area
,
27403 w
->output_cursor
.x
, -1,
27405 MATRIX_ROW_BOTTOM_Y (updated_row
));
27407 from_x
= w
->output_cursor
.x
;
27409 /* Translate to frame coordinates. */
27410 if (updated_row
->full_width_p
)
27412 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27413 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27417 int area_left
= window_box_left (w
, updated_area
);
27418 from_x
+= area_left
;
27422 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27423 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27424 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27426 /* Prevent inadvertently clearing to end of the X window. */
27427 if (to_x
> from_x
&& to_y
> from_y
)
27430 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27431 to_x
- from_x
, to_y
- from_y
);
27436 #endif /* HAVE_WINDOW_SYSTEM */
27440 /***********************************************************************
27442 ***********************************************************************/
27444 /* Value is the internal representation of the specified cursor type
27445 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27446 of the bar cursor. */
27448 static enum text_cursor_kinds
27449 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27451 enum text_cursor_kinds type
;
27456 if (EQ (arg
, Qbox
))
27457 return FILLED_BOX_CURSOR
;
27459 if (EQ (arg
, Qhollow
))
27460 return HOLLOW_BOX_CURSOR
;
27462 if (EQ (arg
, Qbar
))
27469 && EQ (XCAR (arg
), Qbar
)
27470 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27472 *width
= XINT (XCDR (arg
));
27476 if (EQ (arg
, Qhbar
))
27479 return HBAR_CURSOR
;
27483 && EQ (XCAR (arg
), Qhbar
)
27484 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27486 *width
= XINT (XCDR (arg
));
27487 return HBAR_CURSOR
;
27490 /* Treat anything unknown as "hollow box cursor".
27491 It was bad to signal an error; people have trouble fixing
27492 .Xdefaults with Emacs, when it has something bad in it. */
27493 type
= HOLLOW_BOX_CURSOR
;
27498 /* Set the default cursor types for specified frame. */
27500 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27505 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27506 FRAME_CURSOR_WIDTH (f
) = width
;
27508 /* By default, set up the blink-off state depending on the on-state. */
27510 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27513 FRAME_BLINK_OFF_CURSOR (f
)
27514 = get_specified_cursor_type (XCDR (tem
), &width
);
27515 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27518 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27520 /* Make sure the cursor gets redrawn. */
27521 f
->cursor_type_changed
= 1;
27525 #ifdef HAVE_WINDOW_SYSTEM
27527 /* Return the cursor we want to be displayed in window W. Return
27528 width of bar/hbar cursor through WIDTH arg. Return with
27529 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27530 (i.e. if the `system caret' should track this cursor).
27532 In a mini-buffer window, we want the cursor only to appear if we
27533 are reading input from this window. For the selected window, we
27534 want the cursor type given by the frame parameter or buffer local
27535 setting of cursor-type. If explicitly marked off, draw no cursor.
27536 In all other cases, we want a hollow box cursor. */
27538 static enum text_cursor_kinds
27539 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27540 int *active_cursor
)
27542 struct frame
*f
= XFRAME (w
->frame
);
27543 struct buffer
*b
= XBUFFER (w
->contents
);
27544 int cursor_type
= DEFAULT_CURSOR
;
27545 Lisp_Object alt_cursor
;
27546 int non_selected
= 0;
27548 *active_cursor
= 1;
27551 if (cursor_in_echo_area
27552 && FRAME_HAS_MINIBUF_P (f
)
27553 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27555 if (w
== XWINDOW (echo_area_window
))
27557 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27559 *width
= FRAME_CURSOR_WIDTH (f
);
27560 return FRAME_DESIRED_CURSOR (f
);
27563 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27566 *active_cursor
= 0;
27570 /* Detect a nonselected window or nonselected frame. */
27571 else if (w
!= XWINDOW (f
->selected_window
)
27572 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27574 *active_cursor
= 0;
27576 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27582 /* Never display a cursor in a window in which cursor-type is nil. */
27583 if (NILP (BVAR (b
, cursor_type
)))
27586 /* Get the normal cursor type for this window. */
27587 if (EQ (BVAR (b
, cursor_type
), Qt
))
27589 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27590 *width
= FRAME_CURSOR_WIDTH (f
);
27593 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27595 /* Use cursor-in-non-selected-windows instead
27596 for non-selected window or frame. */
27599 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27600 if (!EQ (Qt
, alt_cursor
))
27601 return get_specified_cursor_type (alt_cursor
, width
);
27602 /* t means modify the normal cursor type. */
27603 if (cursor_type
== FILLED_BOX_CURSOR
)
27604 cursor_type
= HOLLOW_BOX_CURSOR
;
27605 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27607 return cursor_type
;
27610 /* Use normal cursor if not blinked off. */
27611 if (!w
->cursor_off_p
)
27614 #ifdef HAVE_XWIDGETS
27615 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
){
27616 //printf("attempt xwidget cursor avoidance in get_window_cursor_type\n");
27620 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27622 if (cursor_type
== FILLED_BOX_CURSOR
)
27624 /* Using a block cursor on large images can be very annoying.
27625 So use a hollow cursor for "large" images.
27626 If image is not transparent (no mask), also use hollow cursor. */
27627 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27628 if (img
!= NULL
&& IMAGEP (img
->spec
))
27630 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27631 where N = size of default frame font size.
27632 This should cover most of the "tiny" icons people may use. */
27634 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27635 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27636 cursor_type
= HOLLOW_BOX_CURSOR
;
27639 else if (cursor_type
!= NO_CURSOR
)
27641 /* Display current only supports BOX and HOLLOW cursors for images.
27642 So for now, unconditionally use a HOLLOW cursor when cursor is
27643 not a solid box cursor. */
27644 cursor_type
= HOLLOW_BOX_CURSOR
;
27647 return cursor_type
;
27650 /* Cursor is blinked off, so determine how to "toggle" it. */
27652 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27653 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27654 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27656 /* Then see if frame has specified a specific blink off cursor type. */
27657 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27659 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27660 return FRAME_BLINK_OFF_CURSOR (f
);
27664 /* Some people liked having a permanently visible blinking cursor,
27665 while others had very strong opinions against it. So it was
27666 decided to remove it. KFS 2003-09-03 */
27668 /* Finally perform built-in cursor blinking:
27669 filled box <-> hollow box
27670 wide [h]bar <-> narrow [h]bar
27671 narrow [h]bar <-> no cursor
27672 other type <-> no cursor */
27674 if (cursor_type
== FILLED_BOX_CURSOR
)
27675 return HOLLOW_BOX_CURSOR
;
27677 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27680 return cursor_type
;
27688 /* Notice when the text cursor of window W has been completely
27689 overwritten by a drawing operation that outputs glyphs in AREA
27690 starting at X0 and ending at X1 in the line starting at Y0 and
27691 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27692 the rest of the line after X0 has been written. Y coordinates
27693 are window-relative. */
27696 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27697 int x0
, int x1
, int y0
, int y1
)
27699 int cx0
, cx1
, cy0
, cy1
;
27700 struct glyph_row
*row
;
27702 if (!w
->phys_cursor_on_p
)
27704 if (area
!= TEXT_AREA
)
27707 if (w
->phys_cursor
.vpos
< 0
27708 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27709 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27710 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27713 if (row
->cursor_in_fringe_p
)
27715 row
->cursor_in_fringe_p
= 0;
27716 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27717 w
->phys_cursor_on_p
= 0;
27721 cx0
= w
->phys_cursor
.x
;
27722 cx1
= cx0
+ w
->phys_cursor_width
;
27723 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27726 /* The cursor image will be completely removed from the
27727 screen if the output area intersects the cursor area in
27728 y-direction. When we draw in [y0 y1[, and some part of
27729 the cursor is at y < y0, that part must have been drawn
27730 before. When scrolling, the cursor is erased before
27731 actually scrolling, so we don't come here. When not
27732 scrolling, the rows above the old cursor row must have
27733 changed, and in this case these rows must have written
27734 over the cursor image.
27736 Likewise if part of the cursor is below y1, with the
27737 exception of the cursor being in the first blank row at
27738 the buffer and window end because update_text_area
27739 doesn't draw that row. (Except when it does, but
27740 that's handled in update_text_area.) */
27742 cy0
= w
->phys_cursor
.y
;
27743 cy1
= cy0
+ w
->phys_cursor_height
;
27744 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27747 w
->phys_cursor_on_p
= 0;
27750 #endif /* HAVE_WINDOW_SYSTEM */
27753 /************************************************************************
27755 ************************************************************************/
27757 #ifdef HAVE_WINDOW_SYSTEM
27760 Fix the display of area AREA of overlapping row ROW in window W
27761 with respect to the overlapping part OVERLAPS. */
27764 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27765 enum glyph_row_area area
, int overlaps
)
27772 for (i
= 0; i
< row
->used
[area
];)
27774 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27776 int start
= i
, start_x
= x
;
27780 x
+= row
->glyphs
[area
][i
].pixel_width
;
27783 while (i
< row
->used
[area
]
27784 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27786 draw_glyphs (w
, start_x
, row
, area
,
27788 DRAW_NORMAL_TEXT
, overlaps
);
27792 x
+= row
->glyphs
[area
][i
].pixel_width
;
27802 Draw the cursor glyph of window W in glyph row ROW. See the
27803 comment of draw_glyphs for the meaning of HL. */
27806 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27807 enum draw_glyphs_face hl
)
27809 /* If cursor hpos is out of bounds, don't draw garbage. This can
27810 happen in mini-buffer windows when switching between echo area
27811 glyphs and mini-buffer. */
27812 if ((row
->reversed_p
27813 ? (w
->phys_cursor
.hpos
>= 0)
27814 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27816 int on_p
= w
->phys_cursor_on_p
;
27818 int hpos
= w
->phys_cursor
.hpos
;
27820 /* When the window is hscrolled, cursor hpos can legitimately be
27821 out of bounds, but we draw the cursor at the corresponding
27822 window margin in that case. */
27823 if (!row
->reversed_p
&& hpos
< 0)
27825 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27826 hpos
= row
->used
[TEXT_AREA
] - 1;
27828 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27830 w
->phys_cursor_on_p
= on_p
;
27832 if (hl
== DRAW_CURSOR
)
27833 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27834 /* When we erase the cursor, and ROW is overlapped by other
27835 rows, make sure that these overlapping parts of other rows
27837 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27839 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27841 if (row
> w
->current_matrix
->rows
27842 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27843 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27844 OVERLAPS_ERASED_CURSOR
);
27846 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27847 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27848 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27849 OVERLAPS_ERASED_CURSOR
);
27855 /* Erase the image of a cursor of window W from the screen. */
27858 erase_phys_cursor (struct window
*w
)
27860 struct frame
*f
= XFRAME (w
->frame
);
27861 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27862 int hpos
= w
->phys_cursor
.hpos
;
27863 int vpos
= w
->phys_cursor
.vpos
;
27864 int mouse_face_here_p
= 0;
27865 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27866 struct glyph_row
*cursor_row
;
27867 struct glyph
*cursor_glyph
;
27868 enum draw_glyphs_face hl
;
27870 /* No cursor displayed or row invalidated => nothing to do on the
27872 if (w
->phys_cursor_type
== NO_CURSOR
)
27873 goto mark_cursor_off
;
27875 /* VPOS >= active_glyphs->nrows means that window has been resized.
27876 Don't bother to erase the cursor. */
27877 if (vpos
>= active_glyphs
->nrows
)
27878 goto mark_cursor_off
;
27880 /* If row containing cursor is marked invalid, there is nothing we
27882 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27883 if (!cursor_row
->enabled_p
)
27884 goto mark_cursor_off
;
27886 /* If line spacing is > 0, old cursor may only be partially visible in
27887 window after split-window. So adjust visible height. */
27888 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27889 window_text_bottom_y (w
) - cursor_row
->y
);
27891 /* If row is completely invisible, don't attempt to delete a cursor which
27892 isn't there. This can happen if cursor is at top of a window, and
27893 we switch to a buffer with a header line in that window. */
27894 if (cursor_row
->visible_height
<= 0)
27895 goto mark_cursor_off
;
27897 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27898 if (cursor_row
->cursor_in_fringe_p
)
27900 cursor_row
->cursor_in_fringe_p
= 0;
27901 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27902 goto mark_cursor_off
;
27905 /* This can happen when the new row is shorter than the old one.
27906 In this case, either draw_glyphs or clear_end_of_line
27907 should have cleared the cursor. Note that we wouldn't be
27908 able to erase the cursor in this case because we don't have a
27909 cursor glyph at hand. */
27910 if ((cursor_row
->reversed_p
27911 ? (w
->phys_cursor
.hpos
< 0)
27912 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27913 goto mark_cursor_off
;
27915 /* When the window is hscrolled, cursor hpos can legitimately be out
27916 of bounds, but we draw the cursor at the corresponding window
27917 margin in that case. */
27918 if (!cursor_row
->reversed_p
&& hpos
< 0)
27920 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27921 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27923 /* If the cursor is in the mouse face area, redisplay that when
27924 we clear the cursor. */
27925 if (! NILP (hlinfo
->mouse_face_window
)
27926 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27927 /* Don't redraw the cursor's spot in mouse face if it is at the
27928 end of a line (on a newline). The cursor appears there, but
27929 mouse highlighting does not. */
27930 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27931 mouse_face_here_p
= 1;
27933 /* Maybe clear the display under the cursor. */
27934 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27937 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27940 cursor_glyph
= get_phys_cursor_glyph (w
);
27941 if (cursor_glyph
== NULL
)
27942 goto mark_cursor_off
;
27944 width
= cursor_glyph
->pixel_width
;
27945 x
= w
->phys_cursor
.x
;
27951 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27952 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27953 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27956 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27959 /* Erase the cursor by redrawing the character underneath it. */
27960 if (mouse_face_here_p
)
27961 hl
= DRAW_MOUSE_FACE
;
27963 hl
= DRAW_NORMAL_TEXT
;
27964 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27967 w
->phys_cursor_on_p
= 0;
27968 w
->phys_cursor_type
= NO_CURSOR
;
27973 Display or clear cursor of window W. If ON is zero, clear the
27974 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27975 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27978 display_and_set_cursor (struct window
*w
, bool on
,
27979 int hpos
, int vpos
, int x
, int y
)
27981 struct frame
*f
= XFRAME (w
->frame
);
27982 int new_cursor_type
;
27983 int new_cursor_width
;
27985 struct glyph_row
*glyph_row
;
27986 struct glyph
*glyph
;
27988 /* This is pointless on invisible frames, and dangerous on garbaged
27989 windows and frames; in the latter case, the frame or window may
27990 be in the midst of changing its size, and x and y may be off the
27992 if (! FRAME_VISIBLE_P (f
)
27993 || FRAME_GARBAGED_P (f
)
27994 || vpos
>= w
->current_matrix
->nrows
27995 || hpos
>= w
->current_matrix
->matrix_w
)
27998 /* If cursor is off and we want it off, return quickly. */
27999 if (!on
&& !w
->phys_cursor_on_p
)
28002 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28003 /* If cursor row is not enabled, we don't really know where to
28004 display the cursor. */
28005 if (!glyph_row
->enabled_p
)
28007 w
->phys_cursor_on_p
= 0;
28012 if (!glyph_row
->exact_window_width_line_p
28013 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28014 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28016 eassert (input_blocked_p ());
28018 /* Set new_cursor_type to the cursor we want to be displayed. */
28019 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28020 &new_cursor_width
, &active_cursor
);
28022 /* If cursor is currently being shown and we don't want it to be or
28023 it is in the wrong place, or the cursor type is not what we want,
28025 if (w
->phys_cursor_on_p
28027 || w
->phys_cursor
.x
!= x
28028 || w
->phys_cursor
.y
!= y
28029 /* HPOS can be negative in R2L rows whose
28030 exact_window_width_line_p flag is set (i.e. their newline
28031 would "overflow into the fringe"). */
28033 || new_cursor_type
!= w
->phys_cursor_type
28034 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28035 && new_cursor_width
!= w
->phys_cursor_width
)))
28036 erase_phys_cursor (w
);
28038 /* Don't check phys_cursor_on_p here because that flag is only set
28039 to zero in some cases where we know that the cursor has been
28040 completely erased, to avoid the extra work of erasing the cursor
28041 twice. In other words, phys_cursor_on_p can be 1 and the cursor
28042 still not be visible, or it has only been partly erased. */
28045 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28046 w
->phys_cursor_height
= glyph_row
->height
;
28048 /* Set phys_cursor_.* before x_draw_.* is called because some
28049 of them may need the information. */
28050 w
->phys_cursor
.x
= x
;
28051 w
->phys_cursor
.y
= glyph_row
->y
;
28052 w
->phys_cursor
.hpos
= hpos
;
28053 w
->phys_cursor
.vpos
= vpos
;
28056 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28057 new_cursor_type
, new_cursor_width
,
28058 on
, active_cursor
);
28062 /* Switch the display of W's cursor on or off, according to the value
28066 update_window_cursor (struct window
*w
, bool on
)
28068 /* Don't update cursor in windows whose frame is in the process
28069 of being deleted. */
28070 if (w
->current_matrix
)
28072 int hpos
= w
->phys_cursor
.hpos
;
28073 int vpos
= w
->phys_cursor
.vpos
;
28074 struct glyph_row
*row
;
28076 if (vpos
>= w
->current_matrix
->nrows
28077 || hpos
>= w
->current_matrix
->matrix_w
)
28080 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28082 /* When the window is hscrolled, cursor hpos can legitimately be
28083 out of bounds, but we draw the cursor at the corresponding
28084 window margin in that case. */
28085 if (!row
->reversed_p
&& hpos
< 0)
28087 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28088 hpos
= row
->used
[TEXT_AREA
] - 1;
28091 display_and_set_cursor (w
, on
, hpos
, vpos
,
28092 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28098 /* Call update_window_cursor with parameter ON_P on all leaf windows
28099 in the window tree rooted at W. */
28102 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28106 if (WINDOWP (w
->contents
))
28107 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28109 update_window_cursor (w
, on_p
);
28111 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28117 Display the cursor on window W, or clear it, according to ON_P.
28118 Don't change the cursor's position. */
28121 x_update_cursor (struct frame
*f
, bool on_p
)
28123 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28128 Clear the cursor of window W to background color, and mark the
28129 cursor as not shown. This is used when the text where the cursor
28130 is about to be rewritten. */
28133 x_clear_cursor (struct window
*w
)
28135 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28136 update_window_cursor (w
, 0);
28139 #endif /* HAVE_WINDOW_SYSTEM */
28141 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28144 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28145 int start_hpos
, int end_hpos
,
28146 enum draw_glyphs_face draw
)
28148 #ifdef HAVE_WINDOW_SYSTEM
28149 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28151 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28155 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28156 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28160 /* Display the active region described by mouse_face_* according to DRAW. */
28163 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28165 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28166 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28168 if (/* If window is in the process of being destroyed, don't bother
28170 w
->current_matrix
!= NULL
28171 /* Don't update mouse highlight if hidden. */
28172 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28173 /* Recognize when we are called to operate on rows that don't exist
28174 anymore. This can happen when a window is split. */
28175 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28177 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
28178 struct glyph_row
*row
, *first
, *last
;
28180 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28181 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28183 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28185 int start_hpos
, end_hpos
, start_x
;
28187 /* For all but the first row, the highlight starts at column 0. */
28190 /* R2L rows have BEG and END in reversed order, but the
28191 screen drawing geometry is always left to right. So
28192 we need to mirror the beginning and end of the
28193 highlighted area in R2L rows. */
28194 if (!row
->reversed_p
)
28196 start_hpos
= hlinfo
->mouse_face_beg_col
;
28197 start_x
= hlinfo
->mouse_face_beg_x
;
28199 else if (row
== last
)
28201 start_hpos
= hlinfo
->mouse_face_end_col
;
28202 start_x
= hlinfo
->mouse_face_end_x
;
28210 else if (row
->reversed_p
&& row
== last
)
28212 start_hpos
= hlinfo
->mouse_face_end_col
;
28213 start_x
= hlinfo
->mouse_face_end_x
;
28223 if (!row
->reversed_p
)
28224 end_hpos
= hlinfo
->mouse_face_end_col
;
28225 else if (row
== first
)
28226 end_hpos
= hlinfo
->mouse_face_beg_col
;
28229 end_hpos
= row
->used
[TEXT_AREA
];
28230 if (draw
== DRAW_NORMAL_TEXT
)
28231 row
->fill_line_p
= 1; /* Clear to end of line */
28234 else if (row
->reversed_p
&& row
== first
)
28235 end_hpos
= hlinfo
->mouse_face_beg_col
;
28238 end_hpos
= row
->used
[TEXT_AREA
];
28239 if (draw
== DRAW_NORMAL_TEXT
)
28240 row
->fill_line_p
= 1; /* Clear to end of line */
28243 if (end_hpos
> start_hpos
)
28245 draw_row_with_mouse_face (w
, start_x
, row
,
28246 start_hpos
, end_hpos
, draw
);
28249 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28253 #ifdef HAVE_WINDOW_SYSTEM
28254 /* When we've written over the cursor, arrange for it to
28255 be displayed again. */
28256 if (FRAME_WINDOW_P (f
)
28257 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28259 int hpos
= w
->phys_cursor
.hpos
;
28261 /* When the window is hscrolled, cursor hpos can legitimately be
28262 out of bounds, but we draw the cursor at the corresponding
28263 window margin in that case. */
28264 if (!row
->reversed_p
&& hpos
< 0)
28266 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28267 hpos
= row
->used
[TEXT_AREA
] - 1;
28270 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
28271 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28274 #endif /* HAVE_WINDOW_SYSTEM */
28277 #ifdef HAVE_WINDOW_SYSTEM
28278 /* Change the mouse cursor. */
28279 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28281 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28282 if (draw
== DRAW_NORMAL_TEXT
28283 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28284 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28287 if (draw
== DRAW_MOUSE_FACE
)
28288 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28290 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28292 #endif /* HAVE_WINDOW_SYSTEM */
28296 Clear out the mouse-highlighted active region.
28297 Redraw it un-highlighted first. Value is non-zero if mouse
28298 face was actually drawn unhighlighted. */
28301 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28305 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
28307 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28311 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28312 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28313 hlinfo
->mouse_face_window
= Qnil
;
28314 hlinfo
->mouse_face_overlay
= Qnil
;
28318 /* Return true if the coordinates HPOS and VPOS on windows W are
28319 within the mouse face on that window. */
28321 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28323 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28325 /* Quickly resolve the easy cases. */
28326 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28327 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28329 if (vpos
< hlinfo
->mouse_face_beg_row
28330 || vpos
> hlinfo
->mouse_face_end_row
)
28332 if (vpos
> hlinfo
->mouse_face_beg_row
28333 && vpos
< hlinfo
->mouse_face_end_row
)
28336 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28338 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28340 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28343 else if ((vpos
== hlinfo
->mouse_face_beg_row
28344 && hpos
>= hlinfo
->mouse_face_beg_col
)
28345 || (vpos
== hlinfo
->mouse_face_end_row
28346 && hpos
< hlinfo
->mouse_face_end_col
))
28351 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28353 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28356 else if ((vpos
== hlinfo
->mouse_face_beg_row
28357 && hpos
<= hlinfo
->mouse_face_beg_col
)
28358 || (vpos
== hlinfo
->mouse_face_end_row
28359 && hpos
> hlinfo
->mouse_face_end_col
))
28367 True if physical cursor of window W is within mouse face. */
28370 cursor_in_mouse_face_p (struct window
*w
)
28372 int hpos
= w
->phys_cursor
.hpos
;
28373 int vpos
= w
->phys_cursor
.vpos
;
28374 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28376 /* When the window is hscrolled, cursor hpos can legitimately be out
28377 of bounds, but we draw the cursor at the corresponding window
28378 margin in that case. */
28379 if (!row
->reversed_p
&& hpos
< 0)
28381 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28382 hpos
= row
->used
[TEXT_AREA
] - 1;
28384 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28389 /* Find the glyph rows START_ROW and END_ROW of window W that display
28390 characters between buffer positions START_CHARPOS and END_CHARPOS
28391 (excluding END_CHARPOS). DISP_STRING is a display string that
28392 covers these buffer positions. This is similar to
28393 row_containing_pos, but is more accurate when bidi reordering makes
28394 buffer positions change non-linearly with glyph rows. */
28396 rows_from_pos_range (struct window
*w
,
28397 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28398 Lisp_Object disp_string
,
28399 struct glyph_row
**start
, struct glyph_row
**end
)
28401 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28402 int last_y
= window_text_bottom_y (w
);
28403 struct glyph_row
*row
;
28408 while (!first
->enabled_p
28409 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28412 /* Find the START row. */
28414 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28417 /* A row can potentially be the START row if the range of the
28418 characters it displays intersects the range
28419 [START_CHARPOS..END_CHARPOS). */
28420 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28421 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28422 /* See the commentary in row_containing_pos, for the
28423 explanation of the complicated way to check whether
28424 some position is beyond the end of the characters
28425 displayed by a row. */
28426 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28427 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28428 && !row
->ends_at_zv_p
28429 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28430 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28431 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28432 && !row
->ends_at_zv_p
28433 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28435 /* Found a candidate row. Now make sure at least one of the
28436 glyphs it displays has a charpos from the range
28437 [START_CHARPOS..END_CHARPOS).
28439 This is not obvious because bidi reordering could make
28440 buffer positions of a row be 1,2,3,102,101,100, and if we
28441 want to highlight characters in [50..60), we don't want
28442 this row, even though [50..60) does intersect [1..103),
28443 the range of character positions given by the row's start
28444 and end positions. */
28445 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28446 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28450 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28451 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28452 /* A glyph that comes from DISP_STRING is by
28453 definition to be highlighted. */
28454 || EQ (g
->object
, disp_string
))
28463 /* Find the END row. */
28465 /* If the last row is partially visible, start looking for END
28466 from that row, instead of starting from FIRST. */
28467 && !(row
->enabled_p
28468 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28470 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28472 struct glyph_row
*next
= row
+ 1;
28473 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28475 if (!next
->enabled_p
28476 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28477 /* The first row >= START whose range of displayed characters
28478 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28479 is the row END + 1. */
28480 || (start_charpos
< next_start
28481 && end_charpos
< next_start
)
28482 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28483 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28484 && !next
->ends_at_zv_p
28485 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28486 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28487 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28488 && !next
->ends_at_zv_p
28489 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28496 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28497 but none of the characters it displays are in the range, it is
28499 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28500 struct glyph
*s
= g
;
28501 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28505 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28506 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28507 /* If the buffer position of the first glyph in
28508 the row is equal to END_CHARPOS, it means
28509 the last character to be highlighted is the
28510 newline of ROW, and we must consider NEXT as
28512 || (((!next
->reversed_p
&& g
== s
)
28513 || (next
->reversed_p
&& g
== e
- 1))
28514 && (g
->charpos
== end_charpos
28515 /* Special case for when NEXT is an
28516 empty line at ZV. */
28517 || (g
->charpos
== -1
28518 && !row
->ends_at_zv_p
28519 && next_start
== end_charpos
)))))
28520 /* A glyph that comes from DISP_STRING is by
28521 definition to be highlighted. */
28522 || EQ (g
->object
, disp_string
))
28531 /* The first row that ends at ZV must be the last to be
28533 else if (next
->ends_at_zv_p
)
28542 /* This function sets the mouse_face_* elements of HLINFO, assuming
28543 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28544 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28545 for the overlay or run of text properties specifying the mouse
28546 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28547 before-string and after-string that must also be highlighted.
28548 DISP_STRING, if non-nil, is a display string that may cover some
28549 or all of the highlighted text. */
28552 mouse_face_from_buffer_pos (Lisp_Object window
,
28553 Mouse_HLInfo
*hlinfo
,
28554 ptrdiff_t mouse_charpos
,
28555 ptrdiff_t start_charpos
,
28556 ptrdiff_t end_charpos
,
28557 Lisp_Object before_string
,
28558 Lisp_Object after_string
,
28559 Lisp_Object disp_string
)
28561 struct window
*w
= XWINDOW (window
);
28562 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28563 struct glyph_row
*r1
, *r2
;
28564 struct glyph
*glyph
, *end
;
28565 ptrdiff_t ignore
, pos
;
28568 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28569 eassert (NILP (before_string
) || STRINGP (before_string
));
28570 eassert (NILP (after_string
) || STRINGP (after_string
));
28572 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28573 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28575 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28576 /* If the before-string or display-string contains newlines,
28577 rows_from_pos_range skips to its last row. Move back. */
28578 if (!NILP (before_string
) || !NILP (disp_string
))
28580 struct glyph_row
*prev
;
28581 while ((prev
= r1
- 1, prev
>= first
)
28582 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28583 && prev
->used
[TEXT_AREA
] > 0)
28585 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28586 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28587 while (--glyph
>= beg
&& NILP (glyph
->object
));
28589 || !(EQ (glyph
->object
, before_string
)
28590 || EQ (glyph
->object
, disp_string
)))
28597 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28598 hlinfo
->mouse_face_past_end
= 1;
28600 else if (!NILP (after_string
))
28602 /* If the after-string has newlines, advance to its last row. */
28603 struct glyph_row
*next
;
28604 struct glyph_row
*last
28605 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28607 for (next
= r2
+ 1;
28609 && next
->used
[TEXT_AREA
] > 0
28610 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28614 /* The rest of the display engine assumes that mouse_face_beg_row is
28615 either above mouse_face_end_row or identical to it. But with
28616 bidi-reordered continued lines, the row for START_CHARPOS could
28617 be below the row for END_CHARPOS. If so, swap the rows and store
28618 them in correct order. */
28621 struct glyph_row
*tem
= r2
;
28627 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28628 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28630 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28631 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28632 could be anywhere in the row and in any order. The strategy
28633 below is to find the leftmost and the rightmost glyph that
28634 belongs to either of these 3 strings, or whose position is
28635 between START_CHARPOS and END_CHARPOS, and highlight all the
28636 glyphs between those two. This may cover more than just the text
28637 between START_CHARPOS and END_CHARPOS if the range of characters
28638 strides the bidi level boundary, e.g. if the beginning is in R2L
28639 text while the end is in L2R text or vice versa. */
28640 if (!r1
->reversed_p
)
28642 /* This row is in a left to right paragraph. Scan it left to
28644 glyph
= r1
->glyphs
[TEXT_AREA
];
28645 end
= glyph
+ r1
->used
[TEXT_AREA
];
28648 /* Skip truncation glyphs at the start of the glyph row. */
28649 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28651 && NILP (glyph
->object
)
28652 && glyph
->charpos
< 0;
28654 x
+= glyph
->pixel_width
;
28656 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28657 or DISP_STRING, and the first glyph from buffer whose
28658 position is between START_CHARPOS and END_CHARPOS. */
28660 && !NILP (glyph
->object
)
28661 && !EQ (glyph
->object
, disp_string
)
28662 && !(BUFFERP (glyph
->object
)
28663 && (glyph
->charpos
>= start_charpos
28664 && glyph
->charpos
< end_charpos
));
28667 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28668 are present at buffer positions between START_CHARPOS and
28669 END_CHARPOS, or if they come from an overlay. */
28670 if (EQ (glyph
->object
, before_string
))
28672 pos
= string_buffer_position (before_string
,
28674 /* If pos == 0, it means before_string came from an
28675 overlay, not from a buffer position. */
28676 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28679 else if (EQ (glyph
->object
, after_string
))
28681 pos
= string_buffer_position (after_string
, end_charpos
);
28682 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28685 x
+= glyph
->pixel_width
;
28687 hlinfo
->mouse_face_beg_x
= x
;
28688 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28692 /* This row is in a right to left paragraph. Scan it right to
28696 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28697 glyph
= end
+ r1
->used
[TEXT_AREA
];
28699 /* Skip truncation glyphs at the start of the glyph row. */
28700 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28702 && NILP (glyph
->object
)
28703 && glyph
->charpos
< 0;
28707 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28708 or DISP_STRING, and the first glyph from buffer whose
28709 position is between START_CHARPOS and END_CHARPOS. */
28711 && !NILP (glyph
->object
)
28712 && !EQ (glyph
->object
, disp_string
)
28713 && !(BUFFERP (glyph
->object
)
28714 && (glyph
->charpos
>= start_charpos
28715 && glyph
->charpos
< end_charpos
));
28718 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28719 are present at buffer positions between START_CHARPOS and
28720 END_CHARPOS, or if they come from an overlay. */
28721 if (EQ (glyph
->object
, before_string
))
28723 pos
= string_buffer_position (before_string
, start_charpos
);
28724 /* If pos == 0, it means before_string came from an
28725 overlay, not from a buffer position. */
28726 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28729 else if (EQ (glyph
->object
, after_string
))
28731 pos
= string_buffer_position (after_string
, end_charpos
);
28732 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28737 glyph
++; /* first glyph to the right of the highlighted area */
28738 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28739 x
+= g
->pixel_width
;
28740 hlinfo
->mouse_face_beg_x
= x
;
28741 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28744 /* If the highlight ends in a different row, compute GLYPH and END
28745 for the end row. Otherwise, reuse the values computed above for
28746 the row where the highlight begins. */
28749 if (!r2
->reversed_p
)
28751 glyph
= r2
->glyphs
[TEXT_AREA
];
28752 end
= glyph
+ r2
->used
[TEXT_AREA
];
28757 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28758 glyph
= end
+ r2
->used
[TEXT_AREA
];
28762 if (!r2
->reversed_p
)
28764 /* Skip truncation and continuation glyphs near the end of the
28765 row, and also blanks and stretch glyphs inserted by
28766 extend_face_to_end_of_line. */
28768 && NILP ((end
- 1)->object
))
28770 /* Scan the rest of the glyph row from the end, looking for the
28771 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28772 DISP_STRING, or whose position is between START_CHARPOS
28776 && !NILP (end
->object
)
28777 && !EQ (end
->object
, disp_string
)
28778 && !(BUFFERP (end
->object
)
28779 && (end
->charpos
>= start_charpos
28780 && end
->charpos
< end_charpos
));
28783 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28784 are present at buffer positions between START_CHARPOS and
28785 END_CHARPOS, or if they come from an overlay. */
28786 if (EQ (end
->object
, before_string
))
28788 pos
= string_buffer_position (before_string
, start_charpos
);
28789 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28792 else if (EQ (end
->object
, after_string
))
28794 pos
= string_buffer_position (after_string
, end_charpos
);
28795 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28799 /* Find the X coordinate of the last glyph to be highlighted. */
28800 for (; glyph
<= end
; ++glyph
)
28801 x
+= glyph
->pixel_width
;
28803 hlinfo
->mouse_face_end_x
= x
;
28804 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28808 /* Skip truncation and continuation glyphs near the end of the
28809 row, and also blanks and stretch glyphs inserted by
28810 extend_face_to_end_of_line. */
28814 && NILP (end
->object
))
28816 x
+= end
->pixel_width
;
28819 /* Scan the rest of the glyph row from the end, looking for the
28820 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28821 DISP_STRING, or whose position is between START_CHARPOS
28825 && !NILP (end
->object
)
28826 && !EQ (end
->object
, disp_string
)
28827 && !(BUFFERP (end
->object
)
28828 && (end
->charpos
>= start_charpos
28829 && end
->charpos
< end_charpos
));
28832 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28833 are present at buffer positions between START_CHARPOS and
28834 END_CHARPOS, or if they come from an overlay. */
28835 if (EQ (end
->object
, before_string
))
28837 pos
= string_buffer_position (before_string
, start_charpos
);
28838 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28841 else if (EQ (end
->object
, after_string
))
28843 pos
= string_buffer_position (after_string
, end_charpos
);
28844 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28847 x
+= end
->pixel_width
;
28849 /* If we exited the above loop because we arrived at the last
28850 glyph of the row, and its buffer position is still not in
28851 range, it means the last character in range is the preceding
28852 newline. Bump the end column and x values to get past the
28855 && BUFFERP (end
->object
)
28856 && (end
->charpos
< start_charpos
28857 || end
->charpos
>= end_charpos
))
28859 x
+= end
->pixel_width
;
28862 hlinfo
->mouse_face_end_x
= x
;
28863 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28866 hlinfo
->mouse_face_window
= window
;
28867 hlinfo
->mouse_face_face_id
28868 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28870 !hlinfo
->mouse_face_hidden
, -1);
28871 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28874 /* The following function is not used anymore (replaced with
28875 mouse_face_from_string_pos), but I leave it here for the time
28876 being, in case someone would. */
28878 #if 0 /* not used */
28880 /* Find the position of the glyph for position POS in OBJECT in
28881 window W's current matrix, and return in *X, *Y the pixel
28882 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28884 RIGHT_P non-zero means return the position of the right edge of the
28885 glyph, RIGHT_P zero means return the left edge position.
28887 If no glyph for POS exists in the matrix, return the position of
28888 the glyph with the next smaller position that is in the matrix, if
28889 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28890 exists in the matrix, return the position of the glyph with the
28891 next larger position in OBJECT.
28893 Value is non-zero if a glyph was found. */
28896 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28897 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28899 int yb
= window_text_bottom_y (w
);
28900 struct glyph_row
*r
;
28901 struct glyph
*best_glyph
= NULL
;
28902 struct glyph_row
*best_row
= NULL
;
28905 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28906 r
->enabled_p
&& r
->y
< yb
;
28909 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28910 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28913 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28914 if (EQ (g
->object
, object
))
28916 if (g
->charpos
== pos
)
28923 else if (best_glyph
== NULL
28924 || ((eabs (g
->charpos
- pos
)
28925 < eabs (best_glyph
->charpos
- pos
))
28928 : g
->charpos
> pos
)))
28942 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28946 *x
+= best_glyph
->pixel_width
;
28951 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28954 return best_glyph
!= NULL
;
28956 #endif /* not used */
28958 /* Find the positions of the first and the last glyphs in window W's
28959 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28960 (assumed to be a string), and return in HLINFO's mouse_face_*
28961 members the pixel and column/row coordinates of those glyphs. */
28964 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28965 Lisp_Object object
,
28966 ptrdiff_t startpos
, ptrdiff_t endpos
)
28968 int yb
= window_text_bottom_y (w
);
28969 struct glyph_row
*r
;
28970 struct glyph
*g
, *e
;
28974 /* Find the glyph row with at least one position in the range
28975 [STARTPOS..ENDPOS), and the first glyph in that row whose
28976 position belongs to that range. */
28977 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28978 r
->enabled_p
&& r
->y
< yb
;
28981 if (!r
->reversed_p
)
28983 g
= r
->glyphs
[TEXT_AREA
];
28984 e
= g
+ r
->used
[TEXT_AREA
];
28985 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28986 if (EQ (g
->object
, object
)
28987 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28989 hlinfo
->mouse_face_beg_row
28990 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28991 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28992 hlinfo
->mouse_face_beg_x
= gx
;
29001 e
= r
->glyphs
[TEXT_AREA
];
29002 g
= e
+ r
->used
[TEXT_AREA
];
29003 for ( ; g
> e
; --g
)
29004 if (EQ ((g
-1)->object
, object
)
29005 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29007 hlinfo
->mouse_face_beg_row
29008 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29009 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29010 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29011 gx
+= g1
->pixel_width
;
29012 hlinfo
->mouse_face_beg_x
= gx
;
29024 /* Starting with the next row, look for the first row which does NOT
29025 include any glyphs whose positions are in the range. */
29026 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29028 g
= r
->glyphs
[TEXT_AREA
];
29029 e
= g
+ r
->used
[TEXT_AREA
];
29031 for ( ; g
< e
; ++g
)
29032 if (EQ (g
->object
, object
)
29033 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29042 /* The highlighted region ends on the previous row. */
29045 /* Set the end row. */
29046 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29048 /* Compute and set the end column and the end column's horizontal
29049 pixel coordinate. */
29050 if (!r
->reversed_p
)
29052 g
= r
->glyphs
[TEXT_AREA
];
29053 e
= g
+ r
->used
[TEXT_AREA
];
29054 for ( ; e
> g
; --e
)
29055 if (EQ ((e
-1)->object
, object
)
29056 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29058 hlinfo
->mouse_face_end_col
= e
- g
;
29060 for (gx
= r
->x
; g
< e
; ++g
)
29061 gx
+= g
->pixel_width
;
29062 hlinfo
->mouse_face_end_x
= gx
;
29066 e
= r
->glyphs
[TEXT_AREA
];
29067 g
= e
+ r
->used
[TEXT_AREA
];
29068 for (gx
= r
->x
; e
< g
; ++e
)
29070 if (EQ (e
->object
, object
)
29071 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29073 gx
+= e
->pixel_width
;
29075 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29076 hlinfo
->mouse_face_end_x
= gx
;
29080 #ifdef HAVE_WINDOW_SYSTEM
29082 /* See if position X, Y is within a hot-spot of an image. */
29085 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29087 if (!CONSP (hot_spot
))
29090 if (EQ (XCAR (hot_spot
), Qrect
))
29092 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29093 Lisp_Object rect
= XCDR (hot_spot
);
29097 if (!CONSP (XCAR (rect
)))
29099 if (!CONSP (XCDR (rect
)))
29101 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29103 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29105 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29107 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29111 else if (EQ (XCAR (hot_spot
), Qcircle
))
29113 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29114 Lisp_Object circ
= XCDR (hot_spot
);
29115 Lisp_Object lr
, lx0
, ly0
;
29117 && CONSP (XCAR (circ
))
29118 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
29119 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29120 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29122 double r
= XFLOATINT (lr
);
29123 double dx
= XINT (lx0
) - x
;
29124 double dy
= XINT (ly0
) - y
;
29125 return (dx
* dx
+ dy
* dy
<= r
* r
);
29128 else if (EQ (XCAR (hot_spot
), Qpoly
))
29130 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29131 if (VECTORP (XCDR (hot_spot
)))
29133 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29134 Lisp_Object
*poly
= v
->contents
;
29135 ptrdiff_t n
= v
->header
.size
;
29138 Lisp_Object lx
, ly
;
29141 /* Need an even number of coordinates, and at least 3 edges. */
29142 if (n
< 6 || n
& 1)
29145 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29146 If count is odd, we are inside polygon. Pixels on edges
29147 may or may not be included depending on actual geometry of the
29149 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29150 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29152 x0
= XINT (lx
), y0
= XINT (ly
);
29153 for (i
= 0; i
< n
; i
+= 2)
29155 int x1
= x0
, y1
= y0
;
29156 if ((lx
= poly
[i
], !INTEGERP (lx
))
29157 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29159 x0
= XINT (lx
), y0
= XINT (ly
);
29161 /* Does this segment cross the X line? */
29169 if (y
> y0
&& y
> y1
)
29171 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29181 find_hot_spot (Lisp_Object map
, int x
, int y
)
29183 while (CONSP (map
))
29185 if (CONSP (XCAR (map
))
29186 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29194 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29196 doc
: /* Lookup in image map MAP coordinates X and Y.
29197 An image map is an alist where each element has the format (AREA ID PLIST).
29198 An AREA is specified as either a rectangle, a circle, or a polygon:
29199 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29200 pixel coordinates of the upper left and bottom right corners.
29201 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29202 and the radius of the circle; r may be a float or integer.
29203 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29204 vector describes one corner in the polygon.
29205 Returns the alist element for the first matching AREA in MAP. */)
29206 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29214 return find_hot_spot (map
,
29215 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29216 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29220 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29222 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29224 /* Do not change cursor shape while dragging mouse. */
29225 if (!NILP (do_mouse_tracking
))
29228 if (!NILP (pointer
))
29230 if (EQ (pointer
, Qarrow
))
29231 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29232 else if (EQ (pointer
, Qhand
))
29233 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29234 else if (EQ (pointer
, Qtext
))
29235 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29236 else if (EQ (pointer
, intern ("hdrag")))
29237 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29238 else if (EQ (pointer
, intern ("nhdrag")))
29239 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29240 #ifdef HAVE_X_WINDOWS
29241 else if (EQ (pointer
, intern ("vdrag")))
29242 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29244 else if (EQ (pointer
, intern ("hourglass")))
29245 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29246 else if (EQ (pointer
, Qmodeline
))
29247 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29249 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29252 if (cursor
!= No_Cursor
)
29253 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29256 #endif /* HAVE_WINDOW_SYSTEM */
29258 /* Take proper action when mouse has moved to the mode or header line
29259 or marginal area AREA of window W, x-position X and y-position Y.
29260 X is relative to the start of the text display area of W, so the
29261 width of bitmap areas and scroll bars must be subtracted to get a
29262 position relative to the start of the mode line. */
29265 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29266 enum window_part area
)
29268 struct window
*w
= XWINDOW (window
);
29269 struct frame
*f
= XFRAME (w
->frame
);
29270 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29271 #ifdef HAVE_WINDOW_SYSTEM
29272 Display_Info
*dpyinfo
;
29274 Cursor cursor
= No_Cursor
;
29275 Lisp_Object pointer
= Qnil
;
29276 int dx
, dy
, width
, height
;
29278 Lisp_Object string
, object
= Qnil
;
29279 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29281 Lisp_Object mouse_face
;
29282 int original_x_pixel
= x
;
29283 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29284 struct glyph_row
*row
IF_LINT (= 0);
29286 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29291 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29292 returns them in row/column units! */
29293 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29294 &object
, &dx
, &dy
, &width
, &height
);
29296 row
= (area
== ON_MODE_LINE
29297 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29298 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29300 /* Find the glyph under the mouse pointer. */
29301 if (row
->mode_line_p
&& row
->enabled_p
)
29303 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29304 end
= glyph
+ row
->used
[TEXT_AREA
];
29306 for (x0
= original_x_pixel
;
29307 glyph
< end
&& x0
>= glyph
->pixel_width
;
29309 x0
-= glyph
->pixel_width
;
29317 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29318 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29319 returns them in row/column units! */
29320 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29321 &object
, &dx
, &dy
, &width
, &height
);
29326 #ifdef HAVE_WINDOW_SYSTEM
29327 if (IMAGEP (object
))
29329 Lisp_Object image_map
, hotspot
;
29330 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29332 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29334 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29338 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29339 If so, we could look for mouse-enter, mouse-leave
29340 properties in PLIST (and do something...). */
29341 hotspot
= XCDR (hotspot
);
29342 if (CONSP (hotspot
)
29343 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29345 pointer
= Fplist_get (plist
, Qpointer
);
29346 if (NILP (pointer
))
29348 help
= Fplist_get (plist
, Qhelp_echo
);
29351 help_echo_string
= help
;
29352 XSETWINDOW (help_echo_window
, w
);
29353 help_echo_object
= w
->contents
;
29354 help_echo_pos
= charpos
;
29358 if (NILP (pointer
))
29359 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29361 #endif /* HAVE_WINDOW_SYSTEM */
29363 if (STRINGP (string
))
29364 pos
= make_number (charpos
);
29366 /* Set the help text and mouse pointer. If the mouse is on a part
29367 of the mode line without any text (e.g. past the right edge of
29368 the mode line text), use the default help text and pointer. */
29369 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29371 /* Arrange to display the help by setting the global variables
29372 help_echo_string, help_echo_object, and help_echo_pos. */
29375 if (STRINGP (string
))
29376 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29380 help_echo_string
= help
;
29381 XSETWINDOW (help_echo_window
, w
);
29382 help_echo_object
= string
;
29383 help_echo_pos
= charpos
;
29385 else if (area
== ON_MODE_LINE
)
29387 Lisp_Object default_help
29388 = buffer_local_value (Qmode_line_default_help_echo
,
29391 if (STRINGP (default_help
))
29393 help_echo_string
= default_help
;
29394 XSETWINDOW (help_echo_window
, w
);
29395 help_echo_object
= Qnil
;
29396 help_echo_pos
= -1;
29401 #ifdef HAVE_WINDOW_SYSTEM
29402 /* Change the mouse pointer according to what is under it. */
29403 if (FRAME_WINDOW_P (f
))
29405 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29407 || NILP (Vresize_mini_windows
));
29409 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29410 if (STRINGP (string
))
29412 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29414 if (NILP (pointer
))
29415 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29417 /* Change the mouse pointer according to what is under X/Y. */
29419 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29422 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29423 if (!KEYMAPP (map
))
29424 map
= Fget_text_property (pos
, Qkeymap
, string
);
29425 if (!KEYMAPP (map
) && draggable
)
29426 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29429 else if (draggable
)
29430 /* Default mode-line pointer. */
29431 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29436 /* Change the mouse face according to what is under X/Y. */
29437 if (STRINGP (string
))
29439 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29440 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29441 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29446 struct glyph
* tmp_glyph
;
29450 int total_pixel_width
;
29451 ptrdiff_t begpos
, endpos
, ignore
;
29455 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29456 Qmouse_face
, string
, Qnil
);
29462 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29464 endpos
= SCHARS (string
);
29468 /* Calculate the glyph position GPOS of GLYPH in the
29469 displayed string, relative to the beginning of the
29470 highlighted part of the string.
29472 Note: GPOS is different from CHARPOS. CHARPOS is the
29473 position of GLYPH in the internal string object. A mode
29474 line string format has structures which are converted to
29475 a flattened string by the Emacs Lisp interpreter. The
29476 internal string is an element of those structures. The
29477 displayed string is the flattened string. */
29478 tmp_glyph
= row_start_glyph
;
29479 while (tmp_glyph
< glyph
29480 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29481 && begpos
<= tmp_glyph
->charpos
29482 && tmp_glyph
->charpos
< endpos
)))
29484 gpos
= glyph
- tmp_glyph
;
29486 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29487 the highlighted part of the displayed string to which
29488 GLYPH belongs. Note: GSEQ_LENGTH is different from
29489 SCHARS (STRING), because the latter returns the length of
29490 the internal string. */
29491 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29493 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29494 && begpos
<= tmp_glyph
->charpos
29495 && tmp_glyph
->charpos
< endpos
));
29498 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29500 /* Calculate the total pixel width of all the glyphs between
29501 the beginning of the highlighted area and GLYPH. */
29502 total_pixel_width
= 0;
29503 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29504 total_pixel_width
+= tmp_glyph
->pixel_width
;
29506 /* Pre calculation of re-rendering position. Note: X is in
29507 column units here, after the call to mode_line_string or
29508 marginal_area_string. */
29510 vpos
= (area
== ON_MODE_LINE
29511 ? (w
->current_matrix
)->nrows
- 1
29514 /* If GLYPH's position is included in the region that is
29515 already drawn in mouse face, we have nothing to do. */
29516 if ( EQ (window
, hlinfo
->mouse_face_window
)
29517 && (!row
->reversed_p
29518 ? (hlinfo
->mouse_face_beg_col
<= hpos
29519 && hpos
< hlinfo
->mouse_face_end_col
)
29520 /* In R2L rows we swap BEG and END, see below. */
29521 : (hlinfo
->mouse_face_end_col
<= hpos
29522 && hpos
< hlinfo
->mouse_face_beg_col
))
29523 && hlinfo
->mouse_face_beg_row
== vpos
)
29526 if (clear_mouse_face (hlinfo
))
29527 cursor
= No_Cursor
;
29529 if (!row
->reversed_p
)
29531 hlinfo
->mouse_face_beg_col
= hpos
;
29532 hlinfo
->mouse_face_beg_x
= original_x_pixel
29533 - (total_pixel_width
+ dx
);
29534 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29535 hlinfo
->mouse_face_end_x
= 0;
29539 /* In R2L rows, show_mouse_face expects BEG and END
29540 coordinates to be swapped. */
29541 hlinfo
->mouse_face_end_col
= hpos
;
29542 hlinfo
->mouse_face_end_x
= original_x_pixel
29543 - (total_pixel_width
+ dx
);
29544 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29545 hlinfo
->mouse_face_beg_x
= 0;
29548 hlinfo
->mouse_face_beg_row
= vpos
;
29549 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29550 hlinfo
->mouse_face_past_end
= 0;
29551 hlinfo
->mouse_face_window
= window
;
29553 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29558 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29560 if (NILP (pointer
))
29563 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29564 clear_mouse_face (hlinfo
);
29566 #ifdef HAVE_WINDOW_SYSTEM
29567 if (FRAME_WINDOW_P (f
))
29568 define_frame_cursor1 (f
, cursor
, pointer
);
29574 Take proper action when the mouse has moved to position X, Y on
29575 frame F with regards to highlighting portions of display that have
29576 mouse-face properties. Also de-highlight portions of display where
29577 the mouse was before, set the mouse pointer shape as appropriate
29578 for the mouse coordinates, and activate help echo (tooltips).
29579 X and Y can be negative or out of range. */
29582 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29584 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29585 enum window_part part
= ON_NOTHING
;
29586 Lisp_Object window
;
29588 Cursor cursor
= No_Cursor
;
29589 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29592 /* When a menu is active, don't highlight because this looks odd. */
29593 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29594 if (popup_activated ())
29598 if (!f
->glyphs_initialized_p
29599 || f
->pointer_invisible
)
29602 hlinfo
->mouse_face_mouse_x
= x
;
29603 hlinfo
->mouse_face_mouse_y
= y
;
29604 hlinfo
->mouse_face_mouse_frame
= f
;
29606 if (hlinfo
->mouse_face_defer
)
29609 /* Which window is that in? */
29610 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29612 /* If displaying active text in another window, clear that. */
29613 if (! EQ (window
, hlinfo
->mouse_face_window
)
29614 /* Also clear if we move out of text area in same window. */
29615 || (!NILP (hlinfo
->mouse_face_window
)
29618 && part
!= ON_MODE_LINE
29619 && part
!= ON_HEADER_LINE
))
29620 clear_mouse_face (hlinfo
);
29622 /* Not on a window -> return. */
29623 if (!WINDOWP (window
))
29626 /* Reset help_echo_string. It will get recomputed below. */
29627 help_echo_string
= Qnil
;
29629 /* Convert to window-relative pixel coordinates. */
29630 w
= XWINDOW (window
);
29631 frame_to_window_pixel_xy (w
, &x
, &y
);
29633 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29634 /* Handle tool-bar window differently since it doesn't display a
29636 if (EQ (window
, f
->tool_bar_window
))
29638 note_tool_bar_highlight (f
, x
, y
);
29643 /* Mouse is on the mode, header line or margin? */
29644 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29645 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29647 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29649 #ifdef HAVE_WINDOW_SYSTEM
29650 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29652 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29653 /* Show non-text cursor (Bug#16647). */
29661 #ifdef HAVE_WINDOW_SYSTEM
29662 if (part
== ON_VERTICAL_BORDER
)
29664 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29665 help_echo_string
= build_string ("drag-mouse-1: resize");
29667 else if (part
== ON_RIGHT_DIVIDER
)
29669 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29670 help_echo_string
= build_string ("drag-mouse-1: resize");
29672 else if (part
== ON_BOTTOM_DIVIDER
)
29673 if (! WINDOW_BOTTOMMOST_P (w
)
29675 || NILP (Vresize_mini_windows
))
29677 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29678 help_echo_string
= build_string ("drag-mouse-1: resize");
29681 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29682 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29683 || part
== ON_VERTICAL_SCROLL_BAR
29684 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29685 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29687 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29690 /* Are we in a window whose display is up to date?
29691 And verify the buffer's text has not changed. */
29692 b
= XBUFFER (w
->contents
);
29693 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29695 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29697 struct glyph
*glyph
;
29698 Lisp_Object object
;
29699 Lisp_Object mouse_face
= Qnil
, position
;
29700 Lisp_Object
*overlay_vec
= NULL
;
29701 ptrdiff_t i
, noverlays
;
29702 struct buffer
*obuf
;
29703 ptrdiff_t obegv
, ozv
;
29706 /* Find the glyph under X/Y. */
29707 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29709 #ifdef HAVE_WINDOW_SYSTEM
29710 /* Look for :pointer property on image. */
29711 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29713 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29714 if (img
!= NULL
&& IMAGEP (img
->spec
))
29716 Lisp_Object image_map
, hotspot
;
29717 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29719 && (hotspot
= find_hot_spot (image_map
,
29720 glyph
->slice
.img
.x
+ dx
,
29721 glyph
->slice
.img
.y
+ dy
),
29723 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29727 /* Could check XCAR (hotspot) to see if we enter/leave
29729 If so, we could look for mouse-enter, mouse-leave
29730 properties in PLIST (and do something...). */
29731 hotspot
= XCDR (hotspot
);
29732 if (CONSP (hotspot
)
29733 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29735 pointer
= Fplist_get (plist
, Qpointer
);
29736 if (NILP (pointer
))
29738 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29739 if (!NILP (help_echo_string
))
29741 help_echo_window
= window
;
29742 help_echo_object
= glyph
->object
;
29743 help_echo_pos
= glyph
->charpos
;
29747 if (NILP (pointer
))
29748 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29751 #endif /* HAVE_WINDOW_SYSTEM */
29753 /* Clear mouse face if X/Y not over text. */
29755 || area
!= TEXT_AREA
29756 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29757 /* Glyph's OBJECT is nil for glyphs inserted by the
29758 display engine for its internal purposes, like truncation
29759 and continuation glyphs and blanks beyond the end of
29760 line's text on text terminals. If we are over such a
29761 glyph, we are not over any text. */
29762 || NILP (glyph
->object
)
29763 /* R2L rows have a stretch glyph at their front, which
29764 stands for no text, whereas L2R rows have no glyphs at
29765 all beyond the end of text. Treat such stretch glyphs
29766 like we do with NULL glyphs in L2R rows. */
29767 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29768 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29769 && glyph
->type
== STRETCH_GLYPH
29770 && glyph
->avoid_cursor_p
))
29772 if (clear_mouse_face (hlinfo
))
29773 cursor
= No_Cursor
;
29774 #ifdef HAVE_WINDOW_SYSTEM
29775 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29777 if (area
!= TEXT_AREA
)
29778 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29780 pointer
= Vvoid_text_area_pointer
;
29786 pos
= glyph
->charpos
;
29787 object
= glyph
->object
;
29788 if (!STRINGP (object
) && !BUFFERP (object
))
29791 /* If we get an out-of-range value, return now; avoid an error. */
29792 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29795 /* Make the window's buffer temporarily current for
29796 overlays_at and compute_char_face. */
29797 obuf
= current_buffer
;
29798 current_buffer
= b
;
29804 /* Is this char mouse-active or does it have help-echo? */
29805 position
= make_number (pos
);
29809 if (BUFFERP (object
))
29811 /* Put all the overlays we want in a vector in overlay_vec. */
29812 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29813 /* Sort overlays into increasing priority order. */
29814 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29819 if (NILP (Vmouse_highlight
))
29821 clear_mouse_face (hlinfo
);
29822 goto check_help_echo
;
29825 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29828 cursor
= No_Cursor
;
29830 /* Check mouse-face highlighting. */
29832 /* If there exists an overlay with mouse-face overlapping
29833 the one we are currently highlighting, we have to
29834 check if we enter the overlapping overlay, and then
29835 highlight only that. */
29836 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29837 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29839 /* Find the highest priority overlay with a mouse-face. */
29840 Lisp_Object overlay
= Qnil
;
29841 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29843 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29844 if (!NILP (mouse_face
))
29845 overlay
= overlay_vec
[i
];
29848 /* If we're highlighting the same overlay as before, there's
29849 no need to do that again. */
29850 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29851 goto check_help_echo
;
29852 hlinfo
->mouse_face_overlay
= overlay
;
29854 /* Clear the display of the old active region, if any. */
29855 if (clear_mouse_face (hlinfo
))
29856 cursor
= No_Cursor
;
29858 /* If no overlay applies, get a text property. */
29859 if (NILP (overlay
))
29860 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29862 /* Next, compute the bounds of the mouse highlighting and
29864 if (!NILP (mouse_face
) && STRINGP (object
))
29866 /* The mouse-highlighting comes from a display string
29867 with a mouse-face. */
29871 s
= Fprevious_single_property_change
29872 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29873 e
= Fnext_single_property_change
29874 (position
, Qmouse_face
, object
, Qnil
);
29876 s
= make_number (0);
29878 e
= make_number (SCHARS (object
));
29879 mouse_face_from_string_pos (w
, hlinfo
, object
,
29880 XINT (s
), XINT (e
));
29881 hlinfo
->mouse_face_past_end
= 0;
29882 hlinfo
->mouse_face_window
= window
;
29883 hlinfo
->mouse_face_face_id
29884 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29885 glyph
->face_id
, 1);
29886 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29887 cursor
= No_Cursor
;
29891 /* The mouse-highlighting, if any, comes from an overlay
29892 or text property in the buffer. */
29893 Lisp_Object buffer
IF_LINT (= Qnil
);
29894 Lisp_Object disp_string
IF_LINT (= Qnil
);
29896 if (STRINGP (object
))
29898 /* If we are on a display string with no mouse-face,
29899 check if the text under it has one. */
29900 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29901 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29902 pos
= string_buffer_position (object
, start
);
29905 mouse_face
= get_char_property_and_overlay
29906 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29907 buffer
= w
->contents
;
29908 disp_string
= object
;
29914 disp_string
= Qnil
;
29917 if (!NILP (mouse_face
))
29919 Lisp_Object before
, after
;
29920 Lisp_Object before_string
, after_string
;
29921 /* To correctly find the limits of mouse highlight
29922 in a bidi-reordered buffer, we must not use the
29923 optimization of limiting the search in
29924 previous-single-property-change and
29925 next-single-property-change, because
29926 rows_from_pos_range needs the real start and end
29927 positions to DTRT in this case. That's because
29928 the first row visible in a window does not
29929 necessarily display the character whose position
29930 is the smallest. */
29932 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29933 ? Fmarker_position (w
->start
)
29936 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29937 ? make_number (BUF_Z (XBUFFER (buffer
))
29938 - w
->window_end_pos
)
29941 if (NILP (overlay
))
29943 /* Handle the text property case. */
29944 before
= Fprevious_single_property_change
29945 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29946 after
= Fnext_single_property_change
29947 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29948 before_string
= after_string
= Qnil
;
29952 /* Handle the overlay case. */
29953 before
= Foverlay_start (overlay
);
29954 after
= Foverlay_end (overlay
);
29955 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29956 after_string
= Foverlay_get (overlay
, Qafter_string
);
29958 if (!STRINGP (before_string
)) before_string
= Qnil
;
29959 if (!STRINGP (after_string
)) after_string
= Qnil
;
29962 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29965 : XFASTINT (before
),
29967 ? BUF_Z (XBUFFER (buffer
))
29968 : XFASTINT (after
),
29969 before_string
, after_string
,
29971 cursor
= No_Cursor
;
29978 /* Look for a `help-echo' property. */
29979 if (NILP (help_echo_string
)) {
29980 Lisp_Object help
, overlay
;
29982 /* Check overlays first. */
29983 help
= overlay
= Qnil
;
29984 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29986 overlay
= overlay_vec
[i
];
29987 help
= Foverlay_get (overlay
, Qhelp_echo
);
29992 help_echo_string
= help
;
29993 help_echo_window
= window
;
29994 help_echo_object
= overlay
;
29995 help_echo_pos
= pos
;
29999 Lisp_Object obj
= glyph
->object
;
30000 ptrdiff_t charpos
= glyph
->charpos
;
30002 /* Try text properties. */
30005 && charpos
< SCHARS (obj
))
30007 help
= Fget_text_property (make_number (charpos
),
30011 /* If the string itself doesn't specify a help-echo,
30012 see if the buffer text ``under'' it does. */
30013 struct glyph_row
*r
30014 = MATRIX_ROW (w
->current_matrix
, vpos
);
30015 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30016 ptrdiff_t p
= string_buffer_position (obj
, start
);
30019 help
= Fget_char_property (make_number (p
),
30020 Qhelp_echo
, w
->contents
);
30029 else if (BUFFERP (obj
)
30032 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30037 help_echo_string
= help
;
30038 help_echo_window
= window
;
30039 help_echo_object
= obj
;
30040 help_echo_pos
= charpos
;
30045 #ifdef HAVE_WINDOW_SYSTEM
30046 /* Look for a `pointer' property. */
30047 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30049 /* Check overlays first. */
30050 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30051 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30053 if (NILP (pointer
))
30055 Lisp_Object obj
= glyph
->object
;
30056 ptrdiff_t charpos
= glyph
->charpos
;
30058 /* Try text properties. */
30061 && charpos
< SCHARS (obj
))
30063 pointer
= Fget_text_property (make_number (charpos
),
30065 if (NILP (pointer
))
30067 /* If the string itself doesn't specify a pointer,
30068 see if the buffer text ``under'' it does. */
30069 struct glyph_row
*r
30070 = MATRIX_ROW (w
->current_matrix
, vpos
);
30071 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30072 ptrdiff_t p
= string_buffer_position (obj
, start
);
30074 pointer
= Fget_char_property (make_number (p
),
30075 Qpointer
, w
->contents
);
30078 else if (BUFFERP (obj
)
30081 pointer
= Fget_text_property (make_number (charpos
),
30085 #endif /* HAVE_WINDOW_SYSTEM */
30089 current_buffer
= obuf
;
30095 #ifdef HAVE_WINDOW_SYSTEM
30096 if (FRAME_WINDOW_P (f
))
30097 define_frame_cursor1 (f
, cursor
, pointer
);
30099 /* This is here to prevent a compiler error, about "label at end of
30100 compound statement". */
30107 Clear any mouse-face on window W. This function is part of the
30108 redisplay interface, and is called from try_window_id and similar
30109 functions to ensure the mouse-highlight is off. */
30112 x_clear_window_mouse_face (struct window
*w
)
30114 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30115 Lisp_Object window
;
30118 XSETWINDOW (window
, w
);
30119 if (EQ (window
, hlinfo
->mouse_face_window
))
30120 clear_mouse_face (hlinfo
);
30126 Just discard the mouse face information for frame F, if any.
30127 This is used when the size of F is changed. */
30130 cancel_mouse_face (struct frame
*f
)
30132 Lisp_Object window
;
30133 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30135 window
= hlinfo
->mouse_face_window
;
30136 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30137 reset_mouse_highlight (hlinfo
);
30142 /***********************************************************************
30144 ***********************************************************************/
30146 #ifdef HAVE_WINDOW_SYSTEM
30148 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30149 which intersects rectangle R. R is in window-relative coordinates. */
30152 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30153 enum glyph_row_area area
)
30155 struct glyph
*first
= row
->glyphs
[area
];
30156 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30157 struct glyph
*last
;
30158 int first_x
, start_x
, x
;
30160 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30161 /* If row extends face to end of line write the whole line. */
30162 draw_glyphs (w
, 0, row
, area
,
30163 0, row
->used
[area
],
30164 DRAW_NORMAL_TEXT
, 0);
30167 /* Set START_X to the window-relative start position for drawing glyphs of
30168 AREA. The first glyph of the text area can be partially visible.
30169 The first glyphs of other areas cannot. */
30170 start_x
= window_box_left_offset (w
, area
);
30172 if (area
== TEXT_AREA
)
30175 /* Find the first glyph that must be redrawn. */
30177 && x
+ first
->pixel_width
< r
->x
)
30179 x
+= first
->pixel_width
;
30183 /* Find the last one. */
30187 && x
< r
->x
+ r
->width
)
30189 x
+= last
->pixel_width
;
30195 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30196 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30197 DRAW_NORMAL_TEXT
, 0);
30202 /* Redraw the parts of the glyph row ROW on window W intersecting
30203 rectangle R. R is in window-relative coordinates. Value is
30204 non-zero if mouse-face was overwritten. */
30207 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30209 eassert (row
->enabled_p
);
30211 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30212 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30213 0, row
->used
[TEXT_AREA
],
30214 DRAW_NORMAL_TEXT
, 0);
30217 if (row
->used
[LEFT_MARGIN_AREA
])
30218 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30219 if (row
->used
[TEXT_AREA
])
30220 expose_area (w
, row
, r
, TEXT_AREA
);
30221 if (row
->used
[RIGHT_MARGIN_AREA
])
30222 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30223 draw_row_fringe_bitmaps (w
, row
);
30226 return row
->mouse_face_p
;
30230 /* Redraw those parts of glyphs rows during expose event handling that
30231 overlap other rows. Redrawing of an exposed line writes over parts
30232 of lines overlapping that exposed line; this function fixes that.
30234 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30235 row in W's current matrix that is exposed and overlaps other rows.
30236 LAST_OVERLAPPING_ROW is the last such row. */
30239 expose_overlaps (struct window
*w
,
30240 struct glyph_row
*first_overlapping_row
,
30241 struct glyph_row
*last_overlapping_row
,
30244 struct glyph_row
*row
;
30246 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30247 if (row
->overlapping_p
)
30249 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30252 if (row
->used
[LEFT_MARGIN_AREA
])
30253 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30255 if (row
->used
[TEXT_AREA
])
30256 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30258 if (row
->used
[RIGHT_MARGIN_AREA
])
30259 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30265 /* Return non-zero if W's cursor intersects rectangle R. */
30268 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30270 XRectangle cr
, result
;
30271 struct glyph
*cursor_glyph
;
30272 struct glyph_row
*row
;
30274 if (w
->phys_cursor
.vpos
>= 0
30275 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30276 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30278 && row
->cursor_in_fringe_p
)
30280 /* Cursor is in the fringe. */
30281 cr
.x
= window_box_right_offset (w
,
30282 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30283 ? RIGHT_MARGIN_AREA
30286 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30287 cr
.height
= row
->height
;
30288 return x_intersect_rectangles (&cr
, r
, &result
);
30291 cursor_glyph
= get_phys_cursor_glyph (w
);
30294 /* r is relative to W's box, but w->phys_cursor.x is relative
30295 to left edge of W's TEXT area. Adjust it. */
30296 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30297 cr
.y
= w
->phys_cursor
.y
;
30298 cr
.width
= cursor_glyph
->pixel_width
;
30299 cr
.height
= w
->phys_cursor_height
;
30300 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30301 I assume the effect is the same -- and this is portable. */
30302 return x_intersect_rectangles (&cr
, r
, &result
);
30304 /* If we don't understand the format, pretend we're not in the hot-spot. */
30310 Draw a vertical window border to the right of window W if W doesn't
30311 have vertical scroll bars. */
30314 x_draw_vertical_border (struct window
*w
)
30316 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30318 /* We could do better, if we knew what type of scroll-bar the adjacent
30319 windows (on either side) have... But we don't :-(
30320 However, I think this works ok. ++KFS 2003-04-25 */
30322 /* Redraw borders between horizontally adjacent windows. Don't
30323 do it for frames with vertical scroll bars because either the
30324 right scroll bar of a window, or the left scroll bar of its
30325 neighbor will suffice as a border. */
30326 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30329 /* Note: It is necessary to redraw both the left and the right
30330 borders, for when only this single window W is being
30332 if (!WINDOW_RIGHTMOST_P (w
)
30333 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30335 int x0
, x1
, y0
, y1
;
30337 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30340 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30343 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30346 if (!WINDOW_LEFTMOST_P (w
)
30347 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30349 int x0
, x1
, y0
, y1
;
30351 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30354 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30357 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30362 /* Draw window dividers for window W. */
30365 x_draw_right_divider (struct window
*w
)
30367 struct frame
*f
= WINDOW_XFRAME (w
);
30369 if (w
->mini
|| w
->pseudo_window_p
)
30371 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30373 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30374 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30375 int y0
= WINDOW_TOP_EDGE_Y (w
);
30376 /* The bottom divider prevails. */
30377 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30379 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30384 x_draw_bottom_divider (struct window
*w
)
30386 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30388 if (w
->mini
|| w
->pseudo_window_p
)
30390 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30392 int x0
= WINDOW_LEFT_EDGE_X (w
);
30393 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30394 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30395 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30397 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30401 /* Redraw the part of window W intersection rectangle FR. Pixel
30402 coordinates in FR are frame-relative. Call this function with
30403 input blocked. Value is non-zero if the exposure overwrites
30407 expose_window (struct window
*w
, XRectangle
*fr
)
30409 struct frame
*f
= XFRAME (w
->frame
);
30411 int mouse_face_overwritten_p
= 0;
30413 /* If window is not yet fully initialized, do nothing. This can
30414 happen when toolkit scroll bars are used and a window is split.
30415 Reconfiguring the scroll bar will generate an expose for a newly
30417 if (w
->current_matrix
== NULL
)
30420 /* When we're currently updating the window, display and current
30421 matrix usually don't agree. Arrange for a thorough display
30423 if (w
->must_be_updated_p
)
30425 SET_FRAME_GARBAGED (f
);
30429 /* Frame-relative pixel rectangle of W. */
30430 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30431 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30432 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30433 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30435 if (x_intersect_rectangles (fr
, &wr
, &r
))
30437 int yb
= window_text_bottom_y (w
);
30438 struct glyph_row
*row
;
30439 int cursor_cleared_p
, phys_cursor_on_p
;
30440 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30442 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30443 r
.x
, r
.y
, r
.width
, r
.height
));
30445 /* Convert to window coordinates. */
30446 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30447 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30449 /* Turn off the cursor. */
30450 if (!w
->pseudo_window_p
30451 && phys_cursor_in_rect_p (w
, &r
))
30453 x_clear_cursor (w
);
30454 cursor_cleared_p
= 1;
30457 cursor_cleared_p
= 0;
30459 /* If the row containing the cursor extends face to end of line,
30460 then expose_area might overwrite the cursor outside the
30461 rectangle and thus notice_overwritten_cursor might clear
30462 w->phys_cursor_on_p. We remember the original value and
30463 check later if it is changed. */
30464 phys_cursor_on_p
= w
->phys_cursor_on_p
;
30466 /* Update lines intersecting rectangle R. */
30467 first_overlapping_row
= last_overlapping_row
= NULL
;
30468 for (row
= w
->current_matrix
->rows
;
30473 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30475 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
30476 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
30477 || (r
.y
>= y0
&& r
.y
< y1
)
30478 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
30480 /* A header line may be overlapping, but there is no need
30481 to fix overlapping areas for them. KFS 2005-02-12 */
30482 if (row
->overlapping_p
&& !row
->mode_line_p
)
30484 if (first_overlapping_row
== NULL
)
30485 first_overlapping_row
= row
;
30486 last_overlapping_row
= row
;
30490 if (expose_line (w
, row
, &r
))
30491 mouse_face_overwritten_p
= 1;
30494 else if (row
->overlapping_p
)
30496 /* We must redraw a row overlapping the exposed area. */
30498 ? y0
+ row
->phys_height
> r
.y
30499 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30501 if (first_overlapping_row
== NULL
)
30502 first_overlapping_row
= row
;
30503 last_overlapping_row
= row
;
30511 /* Display the mode line if there is one. */
30512 if (WINDOW_WANTS_MODELINE_P (w
)
30513 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30515 && row
->y
< r
.y
+ r
.height
)
30517 if (expose_line (w
, row
, &r
))
30518 mouse_face_overwritten_p
= 1;
30521 if (!w
->pseudo_window_p
)
30523 /* Fix the display of overlapping rows. */
30524 if (first_overlapping_row
)
30525 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30528 /* Draw border between windows. */
30529 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30530 x_draw_right_divider (w
);
30532 x_draw_vertical_border (w
);
30534 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30535 x_draw_bottom_divider (w
);
30537 /* Turn the cursor on again. */
30538 if (cursor_cleared_p
30539 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30540 update_window_cursor (w
, 1);
30544 return mouse_face_overwritten_p
;
30549 /* Redraw (parts) of all windows in the window tree rooted at W that
30550 intersect R. R contains frame pixel coordinates. Value is
30551 non-zero if the exposure overwrites mouse-face. */
30554 expose_window_tree (struct window
*w
, XRectangle
*r
)
30556 struct frame
*f
= XFRAME (w
->frame
);
30557 int mouse_face_overwritten_p
= 0;
30559 while (w
&& !FRAME_GARBAGED_P (f
))
30561 if (WINDOWP (w
->contents
))
30562 mouse_face_overwritten_p
30563 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30565 mouse_face_overwritten_p
|= expose_window (w
, r
);
30567 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30570 return mouse_face_overwritten_p
;
30575 Redisplay an exposed area of frame F. X and Y are the upper-left
30576 corner of the exposed rectangle. W and H are width and height of
30577 the exposed area. All are pixel values. W or H zero means redraw
30578 the entire frame. */
30581 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30584 int mouse_face_overwritten_p
= 0;
30586 TRACE ((stderr
, "expose_frame "));
30588 /* No need to redraw if frame will be redrawn soon. */
30589 if (FRAME_GARBAGED_P (f
))
30591 TRACE ((stderr
, " garbaged\n"));
30595 /* If basic faces haven't been realized yet, there is no point in
30596 trying to redraw anything. This can happen when we get an expose
30597 event while Emacs is starting, e.g. by moving another window. */
30598 if (FRAME_FACE_CACHE (f
) == NULL
30599 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30601 TRACE ((stderr
, " no faces\n"));
30605 if (w
== 0 || h
== 0)
30608 r
.width
= FRAME_TEXT_WIDTH (f
);
30609 r
.height
= FRAME_TEXT_HEIGHT (f
);
30619 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30620 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30622 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30623 if (WINDOWP (f
->tool_bar_window
))
30624 mouse_face_overwritten_p
30625 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30628 #ifdef HAVE_X_WINDOWS
30630 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30631 if (WINDOWP (f
->menu_bar_window
))
30632 mouse_face_overwritten_p
30633 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30634 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30638 /* Some window managers support a focus-follows-mouse style with
30639 delayed raising of frames. Imagine a partially obscured frame,
30640 and moving the mouse into partially obscured mouse-face on that
30641 frame. The visible part of the mouse-face will be highlighted,
30642 then the WM raises the obscured frame. With at least one WM, KDE
30643 2.1, Emacs is not getting any event for the raising of the frame
30644 (even tried with SubstructureRedirectMask), only Expose events.
30645 These expose events will draw text normally, i.e. not
30646 highlighted. Which means we must redo the highlight here.
30647 Subsume it under ``we love X''. --gerd 2001-08-15 */
30648 /* Included in Windows version because Windows most likely does not
30649 do the right thing if any third party tool offers
30650 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30651 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30653 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30654 if (f
== hlinfo
->mouse_face_mouse_frame
)
30656 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30657 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30658 clear_mouse_face (hlinfo
);
30659 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30666 Determine the intersection of two rectangles R1 and R2. Return
30667 the intersection in *RESULT. Value is non-zero if RESULT is not
30671 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30673 XRectangle
*left
, *right
;
30674 XRectangle
*upper
, *lower
;
30675 int intersection_p
= 0;
30677 /* Rearrange so that R1 is the left-most rectangle. */
30679 left
= r1
, right
= r2
;
30681 left
= r2
, right
= r1
;
30683 /* X0 of the intersection is right.x0, if this is inside R1,
30684 otherwise there is no intersection. */
30685 if (right
->x
<= left
->x
+ left
->width
)
30687 result
->x
= right
->x
;
30689 /* The right end of the intersection is the minimum of
30690 the right ends of left and right. */
30691 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30694 /* Same game for Y. */
30696 upper
= r1
, lower
= r2
;
30698 upper
= r2
, lower
= r1
;
30700 /* The upper end of the intersection is lower.y0, if this is inside
30701 of upper. Otherwise, there is no intersection. */
30702 if (lower
->y
<= upper
->y
+ upper
->height
)
30704 result
->y
= lower
->y
;
30706 /* The lower end of the intersection is the minimum of the lower
30707 ends of upper and lower. */
30708 result
->height
= (min (lower
->y
+ lower
->height
,
30709 upper
->y
+ upper
->height
)
30711 intersection_p
= 1;
30715 return intersection_p
;
30718 #endif /* HAVE_WINDOW_SYSTEM */
30721 /***********************************************************************
30723 ***********************************************************************/
30726 syms_of_xdisp (void)
30728 Vwith_echo_area_save_vector
= Qnil
;
30729 staticpro (&Vwith_echo_area_save_vector
);
30731 Vmessage_stack
= Qnil
;
30732 staticpro (&Vmessage_stack
);
30734 /* Non-nil means don't actually do any redisplay. */
30735 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30737 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30739 message_dolog_marker1
= Fmake_marker ();
30740 staticpro (&message_dolog_marker1
);
30741 message_dolog_marker2
= Fmake_marker ();
30742 staticpro (&message_dolog_marker2
);
30743 message_dolog_marker3
= Fmake_marker ();
30744 staticpro (&message_dolog_marker3
);
30747 defsubr (&Sdump_frame_glyph_matrix
);
30748 defsubr (&Sdump_glyph_matrix
);
30749 defsubr (&Sdump_glyph_row
);
30750 defsubr (&Sdump_tool_bar_row
);
30751 defsubr (&Strace_redisplay
);
30752 defsubr (&Strace_to_stderr
);
30754 #ifdef HAVE_WINDOW_SYSTEM
30755 defsubr (&Stool_bar_height
);
30756 defsubr (&Slookup_image_map
);
30758 defsubr (&Sline_pixel_height
);
30759 defsubr (&Sformat_mode_line
);
30760 defsubr (&Sinvisible_p
);
30761 defsubr (&Scurrent_bidi_paragraph_direction
);
30762 defsubr (&Swindow_text_pixel_size
);
30763 defsubr (&Smove_point_visually
);
30764 defsubr (&Sbidi_find_overridden_directionality
);
30766 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30767 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30768 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30769 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30770 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30771 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30772 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30773 DEFSYM (Qeval
, "eval");
30774 DEFSYM (QCdata
, ":data");
30776 /* Names of text properties relevant for redisplay. */
30777 DEFSYM (Qdisplay
, "display");
30778 DEFSYM (Qspace_width
, "space-width");
30779 DEFSYM (Qraise
, "raise");
30780 DEFSYM (Qslice
, "slice");
30781 DEFSYM (Qspace
, "space");
30782 DEFSYM (Qmargin
, "margin");
30783 DEFSYM (Qpointer
, "pointer");
30784 DEFSYM (Qleft_margin
, "left-margin");
30785 DEFSYM (Qright_margin
, "right-margin");
30786 DEFSYM (Qcenter
, "center");
30787 DEFSYM (Qline_height
, "line-height");
30788 DEFSYM (QCalign_to
, ":align-to");
30789 DEFSYM (QCrelative_width
, ":relative-width");
30790 DEFSYM (QCrelative_height
, ":relative-height");
30791 DEFSYM (QCeval
, ":eval");
30792 DEFSYM (QCpropertize
, ":propertize");
30793 DEFSYM (QCfile
, ":file");
30794 DEFSYM (Qfontified
, "fontified");
30795 DEFSYM (Qfontification_functions
, "fontification-functions");
30797 /* Name of the face used to highlight trailing whitespace. */
30798 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30800 /* Name and number of the face used to highlight escape glyphs. */
30801 DEFSYM (Qescape_glyph
, "escape-glyph");
30803 /* Name and number of the face used to highlight non-breaking spaces. */
30804 DEFSYM (Qnobreak_space
, "nobreak-space");
30806 /* The symbol 'image' which is the car of the lists used to represent
30807 images in Lisp. Also a tool bar style. */
30808 DEFSYM (Qimage
, "image");
30810 /* Tool bar styles. */
30811 DEFSYM (Qtext
, "text");
30812 DEFSYM (Qboth
, "both");
30813 DEFSYM (Qboth_horiz
, "both-horiz");
30814 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30816 /* The image map types. */
30817 DEFSYM (QCmap
, ":map");
30818 DEFSYM (QCpointer
, ":pointer");
30819 DEFSYM (Qrect
, "rect");
30820 DEFSYM (Qcircle
, "circle");
30821 DEFSYM (Qpoly
, "poly");
30823 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
30824 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30825 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30827 DEFSYM (Qgrow_only
, "grow-only");
30828 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30829 DEFSYM (Qposition
, "position");
30830 DEFSYM (Qbuffer_position
, "buffer-position");
30831 DEFSYM (Qobject
, "object");
30833 /* Cursor shapes. */
30834 DEFSYM (Qbar
, "bar");
30835 DEFSYM (Qhbar
, "hbar");
30836 DEFSYM (Qbox
, "box");
30837 DEFSYM (Qhollow
, "hollow");
30839 /* Pointer shapes. */
30840 DEFSYM (Qhand
, "hand");
30841 DEFSYM (Qarrow
, "arrow");
30844 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30846 list_of_error
= list1 (list2 (intern_c_string ("error"),
30847 intern_c_string ("void-variable")));
30848 staticpro (&list_of_error
);
30850 /* Values of those variables at last redisplay are stored as
30851 properties on 'overlay-arrow-position' symbol. However, if
30852 Voverlay_arrow_position is a marker, last-arrow-position is its
30853 numerical position. */
30854 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30855 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30857 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30858 properties on a symbol in overlay-arrow-variable-list. */
30859 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30860 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30862 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30863 staticpro (&echo_buffer
[0]);
30864 staticpro (&echo_buffer
[1]);
30866 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30867 staticpro (&echo_area_buffer
[0]);
30868 staticpro (&echo_area_buffer
[1]);
30870 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30871 staticpro (&Vmessages_buffer_name
);
30873 mode_line_proptrans_alist
= Qnil
;
30874 staticpro (&mode_line_proptrans_alist
);
30875 mode_line_string_list
= Qnil
;
30876 staticpro (&mode_line_string_list
);
30877 mode_line_string_face
= Qnil
;
30878 staticpro (&mode_line_string_face
);
30879 mode_line_string_face_prop
= Qnil
;
30880 staticpro (&mode_line_string_face_prop
);
30881 Vmode_line_unwind_vector
= Qnil
;
30882 staticpro (&Vmode_line_unwind_vector
);
30884 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30886 help_echo_string
= Qnil
;
30887 staticpro (&help_echo_string
);
30888 help_echo_object
= Qnil
;
30889 staticpro (&help_echo_object
);
30890 help_echo_window
= Qnil
;
30891 staticpro (&help_echo_window
);
30892 previous_help_echo_string
= Qnil
;
30893 staticpro (&previous_help_echo_string
);
30894 help_echo_pos
= -1;
30896 DEFSYM (Qright_to_left
, "right-to-left");
30897 DEFSYM (Qleft_to_right
, "left-to-right");
30898 defsubr (&Sbidi_resolved_levels
);
30900 #ifdef HAVE_WINDOW_SYSTEM
30901 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30902 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30903 For example, if a block cursor is over a tab, it will be drawn as
30904 wide as that tab on the display. */);
30905 x_stretch_cursor_p
= 0;
30908 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30909 doc
: /* Non-nil means highlight trailing whitespace.
30910 The face used for trailing whitespace is `trailing-whitespace'. */);
30911 Vshow_trailing_whitespace
= Qnil
;
30913 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30914 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30915 If the value is t, Emacs highlights non-ASCII chars which have the
30916 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30917 or `escape-glyph' face respectively.
30919 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30920 U+2011 (non-breaking hyphen) are affected.
30922 Any other non-nil value means to display these characters as a escape
30923 glyph followed by an ordinary space or hyphen.
30925 A value of nil means no special handling of these characters. */);
30926 Vnobreak_char_display
= Qt
;
30928 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30929 doc
: /* The pointer shape to show in void text areas.
30930 A value of nil means to show the text pointer. Other options are
30931 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30933 Vvoid_text_area_pointer
= Qarrow
;
30935 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30936 doc
: /* Non-nil means don't actually do any redisplay.
30937 This is used for internal purposes. */);
30938 Vinhibit_redisplay
= Qnil
;
30940 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30941 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30942 Vglobal_mode_string
= Qnil
;
30944 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30945 doc
: /* Marker for where to display an arrow on top of the buffer text.
30946 This must be the beginning of a line in order to work.
30947 See also `overlay-arrow-string'. */);
30948 Voverlay_arrow_position
= Qnil
;
30950 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30951 doc
: /* String to display as an arrow in non-window frames.
30952 See also `overlay-arrow-position'. */);
30953 Voverlay_arrow_string
= build_pure_c_string ("=>");
30955 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30956 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30957 The symbols on this list are examined during redisplay to determine
30958 where to display overlay arrows. */);
30959 Voverlay_arrow_variable_list
30960 = list1 (intern_c_string ("overlay-arrow-position"));
30962 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30963 doc
: /* The number of lines to try scrolling a window by when point moves out.
30964 If that fails to bring point back on frame, point is centered instead.
30965 If this is zero, point is always centered after it moves off frame.
30966 If you want scrolling to always be a line at a time, you should set
30967 `scroll-conservatively' to a large value rather than set this to 1. */);
30969 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30970 doc
: /* Scroll up to this many lines, to bring point back on screen.
30971 If point moves off-screen, redisplay will scroll by up to
30972 `scroll-conservatively' lines in order to bring point just barely
30973 onto the screen again. If that cannot be done, then redisplay
30974 recenters point as usual.
30976 If the value is greater than 100, redisplay will never recenter point,
30977 but will always scroll just enough text to bring point into view, even
30978 if you move far away.
30980 A value of zero means always recenter point if it moves off screen. */);
30981 scroll_conservatively
= 0;
30983 DEFVAR_INT ("scroll-margin", scroll_margin
,
30984 doc
: /* Number of lines of margin at the top and bottom of a window.
30985 Recenter the window whenever point gets within this many lines
30986 of the top or bottom of the window. */);
30989 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30990 doc
: /* Pixels per inch value for non-window system displays.
30991 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30992 Vdisplay_pixels_per_inch
= make_float (72.0);
30995 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30998 DEFVAR_LISP ("truncate-partial-width-windows",
30999 Vtruncate_partial_width_windows
,
31000 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31001 For an integer value, truncate lines in each window narrower than the
31002 full frame width, provided the window width is less than that integer;
31003 otherwise, respect the value of `truncate-lines'.
31005 For any other non-nil value, truncate lines in all windows that do
31006 not span the full frame width.
31008 A value of nil means to respect the value of `truncate-lines'.
31010 If `word-wrap' is enabled, you might want to reduce this. */);
31011 Vtruncate_partial_width_windows
= make_number (50);
31013 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31014 doc
: /* Maximum buffer size for which line number should be displayed.
31015 If the buffer is bigger than this, the line number does not appear
31016 in the mode line. A value of nil means no limit. */);
31017 Vline_number_display_limit
= Qnil
;
31019 DEFVAR_INT ("line-number-display-limit-width",
31020 line_number_display_limit_width
,
31021 doc
: /* Maximum line width (in characters) for line number display.
31022 If the average length of the lines near point is bigger than this, then the
31023 line number may be omitted from the mode line. */);
31024 line_number_display_limit_width
= 200;
31026 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31027 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31028 highlight_nonselected_windows
= 0;
31030 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31031 doc
: /* Non-nil if more than one frame is visible on this display.
31032 Minibuffer-only frames don't count, but iconified frames do.
31033 This variable is not guaranteed to be accurate except while processing
31034 `frame-title-format' and `icon-title-format'. */);
31036 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31037 doc
: /* Template for displaying the title bar of visible frames.
31038 \(Assuming the window manager supports this feature.)
31040 This variable has the same structure as `mode-line-format', except that
31041 the %c and %l constructs are ignored. It is used only on frames for
31042 which no explicit name has been set \(see `modify-frame-parameters'). */);
31044 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31045 doc
: /* Template for displaying the title bar of an iconified frame.
31046 \(Assuming the window manager supports this feature.)
31047 This variable has the same structure as `mode-line-format' (which see),
31048 and is used only on frames for which no explicit name has been set
31049 \(see `modify-frame-parameters'). */);
31051 = Vframe_title_format
31052 = listn (CONSTYPE_PURE
, 3,
31053 intern_c_string ("multiple-frames"),
31054 build_pure_c_string ("%b"),
31055 listn (CONSTYPE_PURE
, 4,
31056 empty_unibyte_string
,
31057 intern_c_string ("invocation-name"),
31058 build_pure_c_string ("@"),
31059 intern_c_string ("system-name")));
31061 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31062 doc
: /* Maximum number of lines to keep in the message log buffer.
31063 If nil, disable message logging. If t, log messages but don't truncate
31064 the buffer when it becomes large. */);
31065 Vmessage_log_max
= make_number (1000);
31067 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31068 doc
: /* Functions called before redisplay, if window sizes have changed.
31069 The value should be a list of functions that take one argument.
31070 Just before redisplay, for each frame, if any of its windows have changed
31071 size since the last redisplay, or have been split or deleted,
31072 all the functions in the list are called, with the frame as argument. */);
31073 Vwindow_size_change_functions
= Qnil
;
31075 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31076 doc
: /* List of functions to call before redisplaying a window with scrolling.
31077 Each function is called with two arguments, the window and its new
31078 display-start position.
31079 These functions are called whenever the `window-start' marker is modified,
31080 either to point into another buffer (e.g. via `set-window-buffer') or another
31081 place in the same buffer.
31082 Note that the value of `window-end' is not valid when these functions are
31085 Warning: Do not use this feature to alter the way the window
31086 is scrolled. It is not designed for that, and such use probably won't
31088 Vwindow_scroll_functions
= Qnil
;
31090 DEFVAR_LISP ("window-text-change-functions",
31091 Vwindow_text_change_functions
,
31092 doc
: /* Functions to call in redisplay when text in the window might change. */);
31093 Vwindow_text_change_functions
= Qnil
;
31095 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31096 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31097 Each function is called with two arguments, the window and the end trigger value.
31098 See `set-window-redisplay-end-trigger'. */);
31099 Vredisplay_end_trigger_functions
= Qnil
;
31101 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31102 doc
: /* Non-nil means autoselect window with mouse pointer.
31103 If nil, do not autoselect windows.
31104 A positive number means delay autoselection by that many seconds: a
31105 window is autoselected only after the mouse has remained in that
31106 window for the duration of the delay.
31107 A negative number has a similar effect, but causes windows to be
31108 autoselected only after the mouse has stopped moving. \(Because of
31109 the way Emacs compares mouse events, you will occasionally wait twice
31110 that time before the window gets selected.\)
31111 Any other value means to autoselect window instantaneously when the
31112 mouse pointer enters it.
31114 Autoselection selects the minibuffer only if it is active, and never
31115 unselects the minibuffer if it is active.
31117 When customizing this variable make sure that the actual value of
31118 `focus-follows-mouse' matches the behavior of your window manager. */);
31119 Vmouse_autoselect_window
= Qnil
;
31121 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31122 doc
: /* Non-nil means automatically resize tool-bars.
31123 This dynamically changes the tool-bar's height to the minimum height
31124 that is needed to make all tool-bar items visible.
31125 If value is `grow-only', the tool-bar's height is only increased
31126 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31127 Vauto_resize_tool_bars
= Qt
;
31129 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31130 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31131 auto_raise_tool_bar_buttons_p
= 1;
31133 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31134 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31135 make_cursor_line_fully_visible_p
= 1;
31137 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31138 doc
: /* Border below tool-bar in pixels.
31139 If an integer, use it as the height of the border.
31140 If it is one of `internal-border-width' or `border-width', use the
31141 value of the corresponding frame parameter.
31142 Otherwise, no border is added below the tool-bar. */);
31143 Vtool_bar_border
= Qinternal_border_width
;
31145 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31146 doc
: /* Margin around tool-bar buttons in pixels.
31147 If an integer, use that for both horizontal and vertical margins.
31148 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31149 HORZ specifying the horizontal margin, and VERT specifying the
31150 vertical margin. */);
31151 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31153 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31154 doc
: /* Relief thickness of tool-bar buttons. */);
31155 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31157 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31158 doc
: /* Tool bar style to use.
31160 image - show images only
31161 text - show text only
31162 both - show both, text below image
31163 both-horiz - show text to the right of the image
31164 text-image-horiz - show text to the left of the image
31165 any other - use system default or image if no system default.
31167 This variable only affects the GTK+ toolkit version of Emacs. */);
31168 Vtool_bar_style
= Qnil
;
31170 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31171 doc
: /* Maximum number of characters a label can have to be shown.
31172 The tool bar style must also show labels for this to have any effect, see
31173 `tool-bar-style'. */);
31174 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31176 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31177 doc
: /* List of functions to call to fontify regions of text.
31178 Each function is called with one argument POS. Functions must
31179 fontify a region starting at POS in the current buffer, and give
31180 fontified regions the property `fontified'. */);
31181 Vfontification_functions
= Qnil
;
31182 Fmake_variable_buffer_local (Qfontification_functions
);
31184 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31185 unibyte_display_via_language_environment
,
31186 doc
: /* Non-nil means display unibyte text according to language environment.
31187 Specifically, this means that raw bytes in the range 160-255 decimal
31188 are displayed by converting them to the equivalent multibyte characters
31189 according to the current language environment. As a result, they are
31190 displayed according to the current fontset.
31192 Note that this variable affects only how these bytes are displayed,
31193 but does not change the fact they are interpreted as raw bytes. */);
31194 unibyte_display_via_language_environment
= 0;
31196 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31197 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31198 If a float, it specifies a fraction of the mini-window frame's height.
31199 If an integer, it specifies a number of lines. */);
31200 Vmax_mini_window_height
= make_float (0.25);
31202 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31203 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31204 A value of nil means don't automatically resize mini-windows.
31205 A value of t means resize them to fit the text displayed in them.
31206 A value of `grow-only', the default, means let mini-windows grow only;
31207 they return to their normal size when the minibuffer is closed, or the
31208 echo area becomes empty. */);
31209 Vresize_mini_windows
= Qgrow_only
;
31211 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31212 doc
: /* Alist specifying how to blink the cursor off.
31213 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31214 `cursor-type' frame-parameter or variable equals ON-STATE,
31215 comparing using `equal', Emacs uses OFF-STATE to specify
31216 how to blink it off. ON-STATE and OFF-STATE are values for
31217 the `cursor-type' frame parameter.
31219 If a frame's ON-STATE has no entry in this list,
31220 the frame's other specifications determine how to blink the cursor off. */);
31221 Vblink_cursor_alist
= Qnil
;
31223 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31224 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31225 If non-nil, windows are automatically scrolled horizontally to make
31226 point visible. */);
31227 automatic_hscrolling_p
= 1;
31228 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31230 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31231 doc
: /* How many columns away from the window edge point is allowed to get
31232 before automatic hscrolling will horizontally scroll the window. */);
31233 hscroll_margin
= 5;
31235 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31236 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31237 When point is less than `hscroll-margin' columns from the window
31238 edge, automatic hscrolling will scroll the window by the amount of columns
31239 determined by this variable. If its value is a positive integer, scroll that
31240 many columns. If it's a positive floating-point number, it specifies the
31241 fraction of the window's width to scroll. If it's nil or zero, point will be
31242 centered horizontally after the scroll. Any other value, including negative
31243 numbers, are treated as if the value were zero.
31245 Automatic hscrolling always moves point outside the scroll margin, so if
31246 point was more than scroll step columns inside the margin, the window will
31247 scroll more than the value given by the scroll step.
31249 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31250 and `scroll-right' overrides this variable's effect. */);
31251 Vhscroll_step
= make_number (0);
31253 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31254 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31255 Bind this around calls to `message' to let it take effect. */);
31256 message_truncate_lines
= 0;
31258 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31259 doc
: /* Normal hook run to update the menu bar definitions.
31260 Redisplay runs this hook before it redisplays the menu bar.
31261 This is used to update menus such as Buffers, whose contents depend on
31263 Vmenu_bar_update_hook
= Qnil
;
31265 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31266 doc
: /* Frame for which we are updating a menu.
31267 The enable predicate for a menu binding should check this variable. */);
31268 Vmenu_updating_frame
= Qnil
;
31270 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31271 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31272 inhibit_menubar_update
= 0;
31274 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31275 doc
: /* Prefix prepended to all continuation lines at display time.
31276 The value may be a string, an image, or a stretch-glyph; it is
31277 interpreted in the same way as the value of a `display' text property.
31279 This variable is overridden by any `wrap-prefix' text or overlay
31282 To add a prefix to non-continuation lines, use `line-prefix'. */);
31283 Vwrap_prefix
= Qnil
;
31284 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31285 Fmake_variable_buffer_local (Qwrap_prefix
);
31287 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31288 doc
: /* Prefix prepended to all non-continuation lines at display time.
31289 The value may be a string, an image, or a stretch-glyph; it is
31290 interpreted in the same way as the value of a `display' text property.
31292 This variable is overridden by any `line-prefix' text or overlay
31295 To add a prefix to continuation lines, use `wrap-prefix'. */);
31296 Vline_prefix
= Qnil
;
31297 DEFSYM (Qline_prefix
, "line-prefix");
31298 Fmake_variable_buffer_local (Qline_prefix
);
31300 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31301 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31302 inhibit_eval_during_redisplay
= 0;
31304 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31305 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31306 inhibit_free_realized_faces
= 0;
31308 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31309 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31310 Intended for use during debugging and for testing bidi display;
31311 see biditest.el in the test suite. */);
31312 inhibit_bidi_mirroring
= 0;
31315 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31316 doc
: /* Inhibit try_window_id display optimization. */);
31317 inhibit_try_window_id
= 0;
31319 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31320 doc
: /* Inhibit try_window_reusing display optimization. */);
31321 inhibit_try_window_reusing
= 0;
31323 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31324 doc
: /* Inhibit try_cursor_movement display optimization. */);
31325 inhibit_try_cursor_movement
= 0;
31326 #endif /* GLYPH_DEBUG */
31328 DEFVAR_INT ("overline-margin", overline_margin
,
31329 doc
: /* Space between overline and text, in pixels.
31330 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31331 margin to the character height. */);
31332 overline_margin
= 2;
31334 DEFVAR_INT ("underline-minimum-offset",
31335 underline_minimum_offset
,
31336 doc
: /* Minimum distance between baseline and underline.
31337 This can improve legibility of underlined text at small font sizes,
31338 particularly when using variable `x-use-underline-position-properties'
31339 with fonts that specify an UNDERLINE_POSITION relatively close to the
31340 baseline. The default value is 1. */);
31341 underline_minimum_offset
= 1;
31343 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31344 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31345 This feature only works when on a window system that can change
31346 cursor shapes. */);
31347 display_hourglass_p
= 1;
31349 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31350 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31351 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31353 #ifdef HAVE_WINDOW_SYSTEM
31354 hourglass_atimer
= NULL
;
31355 hourglass_shown_p
= 0;
31356 #endif /* HAVE_WINDOW_SYSTEM */
31358 /* Name of the face used to display glyphless characters. */
31359 DEFSYM (Qglyphless_char
, "glyphless-char");
31361 /* Method symbols for Vglyphless_char_display. */
31362 DEFSYM (Qhex_code
, "hex-code");
31363 DEFSYM (Qempty_box
, "empty-box");
31364 DEFSYM (Qthin_space
, "thin-space");
31365 DEFSYM (Qzero_width
, "zero-width");
31367 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31368 doc
: /* Function run just before redisplay.
31369 It is called with one argument, which is the set of windows that are to
31370 be redisplayed. This set can be nil (meaning, only the selected window),
31371 or t (meaning all windows). */);
31372 Vpre_redisplay_function
= intern ("ignore");
31374 /* Symbol for the purpose of Vglyphless_char_display. */
31375 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31376 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31378 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31379 doc
: /* Char-table defining glyphless characters.
31380 Each element, if non-nil, should be one of the following:
31381 an ASCII acronym string: display this string in a box
31382 `hex-code': display the hexadecimal code of a character in a box
31383 `empty-box': display as an empty box
31384 `thin-space': display as 1-pixel width space
31385 `zero-width': don't display
31386 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31387 display method for graphical terminals and text terminals respectively.
31388 GRAPHICAL and TEXT should each have one of the values listed above.
31390 The char-table has one extra slot to control the display of a character for
31391 which no font is found. This slot only takes effect on graphical terminals.
31392 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31393 `thin-space'. The default is `empty-box'.
31395 If a character has a non-nil entry in an active display table, the
31396 display table takes effect; in this case, Emacs does not consult
31397 `glyphless-char-display' at all. */);
31398 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31399 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31402 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31403 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31404 Vdebug_on_message
= Qnil
;
31406 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31408 Vredisplay__all_windows_cause
31409 = Fmake_vector (make_number (100), make_number (0));
31411 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31413 Vredisplay__mode_lines_cause
31414 = Fmake_vector (make_number (100), make_number (0));
31418 /* Initialize this module when Emacs starts. */
31423 CHARPOS (this_line_start_pos
) = 0;
31425 if (!noninteractive
)
31427 struct window
*m
= XWINDOW (minibuf_window
);
31428 Lisp_Object frame
= m
->frame
;
31429 struct frame
*f
= XFRAME (frame
);
31430 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31431 struct window
*r
= XWINDOW (root
);
31434 echo_area_window
= minibuf_window
;
31436 r
->top_line
= FRAME_TOP_MARGIN (f
);
31437 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31438 r
->total_cols
= FRAME_COLS (f
);
31439 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31440 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31441 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31443 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31444 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31445 m
->total_cols
= FRAME_COLS (f
);
31446 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31447 m
->total_lines
= 1;
31448 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31450 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31451 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31452 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31454 /* The default ellipsis glyphs `...'. */
31455 for (i
= 0; i
< 3; ++i
)
31456 default_invis_vector
[i
] = make_number ('.');
31460 /* Allocate the buffer for frame titles.
31461 Also used for `format-mode-line'. */
31463 mode_line_noprop_buf
= xmalloc (size
);
31464 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31465 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31466 mode_line_target
= MODE_LINE_DISPLAY
;
31469 help_echo_showing_p
= 0;
31472 #ifdef HAVE_WINDOW_SYSTEM
31474 /* Platform-independent portion of hourglass implementation. */
31476 /* Timer function of hourglass_atimer. */
31479 show_hourglass (struct atimer
*timer
)
31481 /* The timer implementation will cancel this timer automatically
31482 after this function has run. Set hourglass_atimer to null
31483 so that we know the timer doesn't have to be canceled. */
31484 hourglass_atimer
= NULL
;
31486 if (!hourglass_shown_p
)
31488 Lisp_Object tail
, frame
;
31492 FOR_EACH_FRAME (tail
, frame
)
31494 struct frame
*f
= XFRAME (frame
);
31496 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31497 && FRAME_RIF (f
)->show_hourglass
)
31498 FRAME_RIF (f
)->show_hourglass (f
);
31501 hourglass_shown_p
= 1;
31506 /* Cancel a currently active hourglass timer, and start a new one. */
31509 start_hourglass (void)
31511 struct timespec delay
;
31513 cancel_hourglass ();
31515 if (INTEGERP (Vhourglass_delay
)
31516 && XINT (Vhourglass_delay
) > 0)
31517 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31518 TYPE_MAXIMUM (time_t)),
31520 else if (FLOATP (Vhourglass_delay
)
31521 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31522 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31524 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31526 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31527 show_hourglass
, NULL
);
31530 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31534 cancel_hourglass (void)
31536 if (hourglass_atimer
)
31538 cancel_atimer (hourglass_atimer
);
31539 hourglass_atimer
= NULL
;
31542 if (hourglass_shown_p
)
31544 Lisp_Object tail
, frame
;
31548 FOR_EACH_FRAME (tail
, frame
)
31550 struct frame
*f
= XFRAME (frame
);
31552 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31553 && FRAME_RIF (f
)->hide_hourglass
)
31554 FRAME_RIF (f
)->hide_hourglass (f
);
31556 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31557 else if (!FRAME_W32_P (f
))
31558 w32_arrow_cursor ();
31562 hourglass_shown_p
= 0;
31567 #endif /* HAVE_WINDOW_SYSTEM */