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
);
2757 /* The code assumes it->object and other Lisp_Object components are
2758 set to nil, so verify that memset does this. */
2759 verify (NIL_IS_ZERO
);
2760 memset (it
, 0, sizeof *it
);
2762 it
->current
.overlay_string_index
= -1;
2763 it
->current
.dpvec_index
= -1;
2764 it
->base_face_id
= remapped_base_face_id
;
2765 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2766 it
->paragraph_embedding
= L2R
;
2769 /* The window in which we iterate over current_buffer: */
2770 XSETWINDOW (it
->window
, w
);
2772 it
->f
= XFRAME (w
->frame
);
2776 /* Extra space between lines (on window systems only). */
2777 if (base_face_id
== DEFAULT_FACE_ID
2778 && FRAME_WINDOW_P (it
->f
))
2780 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2781 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2782 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2783 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2784 * FRAME_LINE_HEIGHT (it
->f
));
2785 else if (it
->f
->extra_line_spacing
> 0)
2786 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
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 it
->override_ascent
= -1;
2800 /* Are control characters displayed as `^C'? */
2801 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2803 /* -1 means everything between a CR and the following line end
2804 is invisible. >0 means lines indented more than this value are
2806 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2808 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2810 : (!NILP (BVAR (current_buffer
, selective_display
))
2812 it
->selective_display_ellipsis_p
2813 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2815 /* Display table to use. */
2816 it
->dp
= window_display_table (w
);
2818 /* Are multibyte characters enabled in current_buffer? */
2819 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2821 /* Get the position at which the redisplay_end_trigger hook should
2822 be run, if it is to be run at all. */
2823 if (MARKERP (w
->redisplay_end_trigger
)
2824 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2825 it
->redisplay_end_trigger_charpos
2826 = marker_position (w
->redisplay_end_trigger
);
2827 else if (INTEGERP (w
->redisplay_end_trigger
))
2828 it
->redisplay_end_trigger_charpos
2829 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2832 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2834 /* Are lines in the display truncated? */
2836 it
->line_wrap
= TRUNCATE
;
2837 if (base_face_id
== DEFAULT_FACE_ID
2839 && (WINDOW_FULL_WIDTH_P (it
->w
)
2840 || NILP (Vtruncate_partial_width_windows
)
2841 || (INTEGERP (Vtruncate_partial_width_windows
)
2842 /* PXW: Shall we do something about this? */
2843 && (XINT (Vtruncate_partial_width_windows
)
2844 <= WINDOW_TOTAL_COLS (it
->w
))))
2845 && NILP (BVAR (current_buffer
, truncate_lines
)))
2846 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2847 ? WINDOW_WRAP
: WORD_WRAP
;
2849 /* Get dimensions of truncation and continuation glyphs. These are
2850 displayed as fringe bitmaps under X, but we need them for such
2851 frames when the fringes are turned off. But leave the dimensions
2852 zero for tooltip frames, as these glyphs look ugly there and also
2853 sabotage calculations of tooltip dimensions in x-show-tip. */
2854 #ifdef HAVE_WINDOW_SYSTEM
2855 if (!(FRAME_WINDOW_P (it
->f
)
2856 && FRAMEP (tip_frame
)
2857 && it
->f
== XFRAME (tip_frame
)))
2860 if (it
->line_wrap
== TRUNCATE
)
2862 /* We will need the truncation glyph. */
2863 eassert (it
->glyph_row
== NULL
);
2864 produce_special_glyphs (it
, IT_TRUNCATION
);
2865 it
->truncation_pixel_width
= it
->pixel_width
;
2869 /* We will need the continuation glyph. */
2870 eassert (it
->glyph_row
== NULL
);
2871 produce_special_glyphs (it
, IT_CONTINUATION
);
2872 it
->continuation_pixel_width
= it
->pixel_width
;
2876 /* Reset these values to zero because the produce_special_glyphs
2877 above has changed them. */
2878 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2879 it
->phys_ascent
= it
->phys_descent
= 0;
2881 /* Set this after getting the dimensions of truncation and
2882 continuation glyphs, so that we don't produce glyphs when calling
2883 produce_special_glyphs, above. */
2884 it
->glyph_row
= row
;
2885 it
->area
= TEXT_AREA
;
2887 /* Get the dimensions of the display area. The display area
2888 consists of the visible window area plus a horizontally scrolled
2889 part to the left of the window. All x-values are relative to the
2890 start of this total display area. */
2891 if (base_face_id
!= DEFAULT_FACE_ID
)
2893 /* Mode lines, menu bar in terminal frames. */
2894 it
->first_visible_x
= 0;
2895 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2900 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2901 it
->last_visible_x
= (it
->first_visible_x
2902 + window_box_width (w
, TEXT_AREA
));
2904 /* If we truncate lines, leave room for the truncation glyph(s) at
2905 the right margin. Otherwise, leave room for the continuation
2906 glyph(s). Done only if the window has no right fringe. */
2907 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2909 if (it
->line_wrap
== TRUNCATE
)
2910 it
->last_visible_x
-= it
->truncation_pixel_width
;
2912 it
->last_visible_x
-= it
->continuation_pixel_width
;
2915 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2916 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2919 /* Leave room for a border glyph. */
2920 if (!FRAME_WINDOW_P (it
->f
)
2921 && !WINDOW_RIGHTMOST_P (it
->w
))
2922 it
->last_visible_x
-= 1;
2924 it
->last_visible_y
= window_text_bottom_y (w
);
2926 /* For mode lines and alike, arrange for the first glyph having a
2927 left box line if the face specifies a box. */
2928 if (base_face_id
!= DEFAULT_FACE_ID
)
2932 it
->face_id
= remapped_base_face_id
;
2934 /* If we have a boxed mode line, make the first character appear
2935 with a left box line. */
2936 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2937 if (face
&& face
->box
!= FACE_NO_BOX
)
2938 it
->start_of_box_run_p
= true;
2941 /* If a buffer position was specified, set the iterator there,
2942 getting overlays and face properties from that position. */
2943 if (charpos
>= BUF_BEG (current_buffer
))
2945 it
->stop_charpos
= charpos
;
2946 it
->end_charpos
= ZV
;
2947 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2948 IT_CHARPOS (*it
) = charpos
;
2949 IT_BYTEPOS (*it
) = bytepos
;
2951 /* We will rely on `reseat' to set this up properly, via
2952 handle_face_prop. */
2953 it
->face_id
= it
->base_face_id
;
2955 it
->start
= it
->current
;
2956 /* Do we need to reorder bidirectional text? Not if this is a
2957 unibyte buffer: by definition, none of the single-byte
2958 characters are strong R2L, so no reordering is needed. And
2959 bidi.c doesn't support unibyte buffers anyway. Also, don't
2960 reorder while we are loading loadup.el, since the tables of
2961 character properties needed for reordering are not yet
2965 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2968 /* If we are to reorder bidirectional text, init the bidi
2972 /* Since we don't know at this point whether there will be
2973 any R2L lines in the window, we reserve space for
2974 truncation/continuation glyphs even if only the left
2975 fringe is absent. */
2976 if (base_face_id
== DEFAULT_FACE_ID
2977 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2978 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2980 if (it
->line_wrap
== TRUNCATE
)
2981 it
->last_visible_x
-= it
->truncation_pixel_width
;
2983 it
->last_visible_x
-= it
->continuation_pixel_width
;
2985 /* Note the paragraph direction that this buffer wants to
2987 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2989 it
->paragraph_embedding
= L2R
;
2990 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2992 it
->paragraph_embedding
= R2L
;
2994 it
->paragraph_embedding
= NEUTRAL_DIR
;
2995 bidi_unshelve_cache (NULL
, 0);
2996 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3000 /* Compute faces etc. */
3001 reseat (it
, it
->current
.pos
, 1);
3008 /* Initialize IT for the display of window W with window start POS. */
3011 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3013 struct glyph_row
*row
;
3014 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3016 row
= w
->desired_matrix
->rows
+ first_vpos
;
3017 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3018 it
->first_vpos
= first_vpos
;
3020 /* Don't reseat to previous visible line start if current start
3021 position is in a string or image. */
3022 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3024 int start_at_line_beg_p
;
3025 int first_y
= it
->current_y
;
3027 /* If window start is not at a line start, skip forward to POS to
3028 get the correct continuation lines width. */
3029 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3030 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3031 if (!start_at_line_beg_p
)
3035 reseat_at_previous_visible_line_start (it
);
3036 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3038 new_x
= it
->current_x
+ it
->pixel_width
;
3040 /* If lines are continued, this line may end in the middle
3041 of a multi-glyph character (e.g. a control character
3042 displayed as \003, or in the middle of an overlay
3043 string). In this case move_it_to above will not have
3044 taken us to the start of the continuation line but to the
3045 end of the continued line. */
3046 if (it
->current_x
> 0
3047 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3048 && (/* And glyph doesn't fit on the line. */
3049 new_x
> it
->last_visible_x
3050 /* Or it fits exactly and we're on a window
3052 || (new_x
== it
->last_visible_x
3053 && FRAME_WINDOW_P (it
->f
)
3054 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3055 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3056 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3058 if ((it
->current
.dpvec_index
>= 0
3059 || it
->current
.overlay_string_index
>= 0)
3060 /* If we are on a newline from a display vector or
3061 overlay string, then we are already at the end of
3062 a screen line; no need to go to the next line in
3063 that case, as this line is not really continued.
3064 (If we do go to the next line, C-e will not DTRT.) */
3067 set_iterator_to_next (it
, 1);
3068 move_it_in_display_line_to (it
, -1, -1, 0);
3071 it
->continuation_lines_width
+= it
->current_x
;
3073 /* If the character at POS is displayed via a display
3074 vector, move_it_to above stops at the final glyph of
3075 IT->dpvec. To make the caller redisplay that character
3076 again (a.k.a. start at POS), we need to reset the
3077 dpvec_index to the beginning of IT->dpvec. */
3078 else if (it
->current
.dpvec_index
>= 0)
3079 it
->current
.dpvec_index
= 0;
3081 /* We're starting a new display line, not affected by the
3082 height of the continued line, so clear the appropriate
3083 fields in the iterator structure. */
3084 it
->max_ascent
= it
->max_descent
= 0;
3085 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3087 it
->current_y
= first_y
;
3089 it
->current_x
= it
->hpos
= 0;
3095 /* Return 1 if POS is a position in ellipses displayed for invisible
3096 text. W is the window we display, for text property lookup. */
3099 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3101 Lisp_Object prop
, window
;
3103 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3105 /* If POS specifies a position in a display vector, this might
3106 be for an ellipsis displayed for invisible text. We won't
3107 get the iterator set up for delivering that ellipsis unless
3108 we make sure that it gets aware of the invisible text. */
3109 if (pos
->dpvec_index
>= 0
3110 && pos
->overlay_string_index
< 0
3111 && CHARPOS (pos
->string_pos
) < 0
3113 && (XSETWINDOW (window
, w
),
3114 prop
= Fget_char_property (make_number (charpos
),
3115 Qinvisible
, window
),
3116 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3118 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3120 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3127 /* Initialize IT for stepping through current_buffer in window W,
3128 starting at position POS that includes overlay string and display
3129 vector/ control character translation position information. Value
3130 is zero if there are overlay strings with newlines at POS. */
3133 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3135 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3136 int i
, overlay_strings_with_newlines
= 0;
3138 /* If POS specifies a position in a display vector, this might
3139 be for an ellipsis displayed for invisible text. We won't
3140 get the iterator set up for delivering that ellipsis unless
3141 we make sure that it gets aware of the invisible text. */
3142 if (in_ellipses_for_invisible_text_p (pos
, w
))
3148 /* Keep in mind: the call to reseat in init_iterator skips invisible
3149 text, so we might end up at a position different from POS. This
3150 is only a problem when POS is a row start after a newline and an
3151 overlay starts there with an after-string, and the overlay has an
3152 invisible property. Since we don't skip invisible text in
3153 display_line and elsewhere immediately after consuming the
3154 newline before the row start, such a POS will not be in a string,
3155 but the call to init_iterator below will move us to the
3157 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3159 /* This only scans the current chunk -- it should scan all chunks.
3160 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3161 to 16 in 22.1 to make this a lesser problem. */
3162 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3164 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3165 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3167 while (s
< e
&& *s
!= '\n')
3172 overlay_strings_with_newlines
= 1;
3177 /* If position is within an overlay string, set up IT to the right
3179 if (pos
->overlay_string_index
>= 0)
3183 /* If the first overlay string happens to have a `display'
3184 property for an image, the iterator will be set up for that
3185 image, and we have to undo that setup first before we can
3186 correct the overlay string index. */
3187 if (it
->method
== GET_FROM_IMAGE
)
3190 /* We already have the first chunk of overlay strings in
3191 IT->overlay_strings. Load more until the one for
3192 pos->overlay_string_index is in IT->overlay_strings. */
3193 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3195 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3196 it
->current
.overlay_string_index
= 0;
3199 load_overlay_strings (it
, 0);
3200 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3204 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3205 relative_index
= (it
->current
.overlay_string_index
3206 % OVERLAY_STRING_CHUNK_SIZE
);
3207 it
->string
= it
->overlay_strings
[relative_index
];
3208 eassert (STRINGP (it
->string
));
3209 it
->current
.string_pos
= pos
->string_pos
;
3210 it
->method
= GET_FROM_STRING
;
3211 it
->end_charpos
= SCHARS (it
->string
);
3212 /* Set up the bidi iterator for this overlay string. */
3215 it
->bidi_it
.string
.lstring
= it
->string
;
3216 it
->bidi_it
.string
.s
= NULL
;
3217 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3218 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3219 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3220 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3221 it
->bidi_it
.w
= it
->w
;
3222 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3223 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3225 /* Synchronize the state of the bidi iterator with
3226 pos->string_pos. For any string position other than
3227 zero, this will be done automagically when we resume
3228 iteration over the string and get_visually_first_element
3229 is called. But if string_pos is zero, and the string is
3230 to be reordered for display, we need to resync manually,
3231 since it could be that the iteration state recorded in
3232 pos ended at string_pos of 0 moving backwards in string. */
3233 if (CHARPOS (pos
->string_pos
) == 0)
3235 get_visually_first_element (it
);
3236 if (IT_STRING_CHARPOS (*it
) != 0)
3239 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3240 bidi_move_to_visually_next (&it
->bidi_it
);
3241 } while (it
->bidi_it
.charpos
!= 0);
3243 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3244 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3248 if (CHARPOS (pos
->string_pos
) >= 0)
3250 /* Recorded position is not in an overlay string, but in another
3251 string. This can only be a string from a `display' property.
3252 IT should already be filled with that string. */
3253 it
->current
.string_pos
= pos
->string_pos
;
3254 eassert (STRINGP (it
->string
));
3256 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3257 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3260 /* Restore position in display vector translations, control
3261 character translations or ellipses. */
3262 if (pos
->dpvec_index
>= 0)
3264 if (it
->dpvec
== NULL
)
3265 get_next_display_element (it
);
3266 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3267 it
->current
.dpvec_index
= pos
->dpvec_index
;
3271 return !overlay_strings_with_newlines
;
3275 /* Initialize IT for stepping through current_buffer in window W
3276 starting at ROW->start. */
3279 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3281 init_from_display_pos (it
, w
, &row
->start
);
3282 it
->start
= row
->start
;
3283 it
->continuation_lines_width
= row
->continuation_lines_width
;
3288 /* Initialize IT for stepping through current_buffer in window W
3289 starting in the line following ROW, i.e. starting at ROW->end.
3290 Value is zero if there are overlay strings with newlines at ROW's
3294 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3298 if (init_from_display_pos (it
, w
, &row
->end
))
3300 if (row
->continued_p
)
3301 it
->continuation_lines_width
3302 = row
->continuation_lines_width
+ row
->pixel_width
;
3313 /***********************************************************************
3315 ***********************************************************************/
3317 /* Called when IT reaches IT->stop_charpos. Handle text property and
3318 overlay changes. Set IT->stop_charpos to the next position where
3322 handle_stop (struct it
*it
)
3324 enum prop_handled handled
;
3325 int handle_overlay_change_p
;
3329 it
->current
.dpvec_index
= -1;
3330 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3331 it
->ignore_overlay_strings_at_pos_p
= 0;
3334 /* Use face of preceding text for ellipsis (if invisible) */
3335 if (it
->selective_display_ellipsis_p
)
3336 it
->saved_face_id
= it
->face_id
;
3338 /* Here's the description of the semantics of, and the logic behind,
3339 the various HANDLED_* statuses:
3341 HANDLED_NORMALLY means the handler did its job, and the loop
3342 should proceed to calling the next handler in order.
3344 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3345 change in the properties and overlays at current position, so the
3346 loop should be restarted, to re-invoke the handlers that were
3347 already called. This happens when fontification-functions were
3348 called by handle_fontified_prop, and actually fontified
3349 something. Another case where HANDLED_RECOMPUTE_PROPS is
3350 returned is when we discover overlay strings that need to be
3351 displayed right away. The loop below will continue for as long
3352 as the status is HANDLED_RECOMPUTE_PROPS.
3354 HANDLED_RETURN means return immediately to the caller, to
3355 continue iteration without calling any further handlers. This is
3356 used when we need to act on some property right away, for example
3357 when we need to display the ellipsis or a replacing display
3358 property, such as display string or image.
3360 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3361 consumed, and the handler switched to the next overlay string.
3362 This signals the loop below to refrain from looking for more
3363 overlays before all the overlay strings of the current overlay
3366 Some of the handlers called by the loop push the iterator state
3367 onto the stack (see 'push_it'), and arrange for the iteration to
3368 continue with another object, such as an image, a display string,
3369 or an overlay string. In most such cases, it->stop_charpos is
3370 set to the first character of the string, so that when the
3371 iteration resumes, this function will immediately be called
3372 again, to examine the properties at the beginning of the string.
3374 When a display or overlay string is exhausted, the iterator state
3375 is popped (see 'pop_it'), and iteration continues with the
3376 previous object. Again, in many such cases this function is
3377 called again to find the next position where properties might
3382 handled
= HANDLED_NORMALLY
;
3384 /* Call text property handlers. */
3385 for (p
= it_props
; p
->handler
; ++p
)
3387 handled
= p
->handler (it
);
3389 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3391 else if (handled
== HANDLED_RETURN
)
3393 /* We still want to show before and after strings from
3394 overlays even if the actual buffer text is replaced. */
3395 if (!handle_overlay_change_p
3397 /* Don't call get_overlay_strings_1 if we already
3398 have overlay strings loaded, because doing so
3399 will load them again and push the iterator state
3400 onto the stack one more time, which is not
3401 expected by the rest of the code that processes
3403 || (it
->current
.overlay_string_index
< 0
3404 ? !get_overlay_strings_1 (it
, 0, 0)
3408 setup_for_ellipsis (it
, 0);
3409 /* When handling a display spec, we might load an
3410 empty string. In that case, discard it here. We
3411 used to discard it in handle_single_display_spec,
3412 but that causes get_overlay_strings_1, above, to
3413 ignore overlay strings that we must check. */
3414 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3418 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3422 it
->ignore_overlay_strings_at_pos_p
= true;
3423 it
->string_from_display_prop_p
= 0;
3424 it
->from_disp_prop_p
= 0;
3425 handle_overlay_change_p
= 0;
3427 handled
= HANDLED_RECOMPUTE_PROPS
;
3430 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3431 handle_overlay_change_p
= 0;
3434 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3436 /* Don't check for overlay strings below when set to deliver
3437 characters from a display vector. */
3438 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3439 handle_overlay_change_p
= 0;
3441 /* Handle overlay changes.
3442 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3443 if it finds overlays. */
3444 if (handle_overlay_change_p
)
3445 handled
= handle_overlay_change (it
);
3450 setup_for_ellipsis (it
, 0);
3454 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3456 /* Determine where to stop next. */
3457 if (handled
== HANDLED_NORMALLY
)
3458 compute_stop_pos (it
);
3462 /* Compute IT->stop_charpos from text property and overlay change
3463 information for IT's current position. */
3466 compute_stop_pos (struct it
*it
)
3468 register INTERVAL iv
, next_iv
;
3469 Lisp_Object object
, limit
, position
;
3470 ptrdiff_t charpos
, bytepos
;
3472 if (STRINGP (it
->string
))
3474 /* Strings are usually short, so don't limit the search for
3476 it
->stop_charpos
= it
->end_charpos
;
3477 object
= it
->string
;
3479 charpos
= IT_STRING_CHARPOS (*it
);
3480 bytepos
= IT_STRING_BYTEPOS (*it
);
3486 /* If end_charpos is out of range for some reason, such as a
3487 misbehaving display function, rationalize it (Bug#5984). */
3488 if (it
->end_charpos
> ZV
)
3489 it
->end_charpos
= ZV
;
3490 it
->stop_charpos
= it
->end_charpos
;
3492 /* If next overlay change is in front of the current stop pos
3493 (which is IT->end_charpos), stop there. Note: value of
3494 next_overlay_change is point-max if no overlay change
3496 charpos
= IT_CHARPOS (*it
);
3497 bytepos
= IT_BYTEPOS (*it
);
3498 pos
= next_overlay_change (charpos
);
3499 if (pos
< it
->stop_charpos
)
3500 it
->stop_charpos
= pos
;
3502 /* Set up variables for computing the stop position from text
3503 property changes. */
3504 XSETBUFFER (object
, current_buffer
);
3505 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3508 /* Get the interval containing IT's position. Value is a null
3509 interval if there isn't such an interval. */
3510 position
= make_number (charpos
);
3511 iv
= validate_interval_range (object
, &position
, &position
, 0);
3514 Lisp_Object values_here
[LAST_PROP_IDX
];
3517 /* Get properties here. */
3518 for (p
= it_props
; p
->handler
; ++p
)
3519 values_here
[p
->idx
] = textget (iv
->plist
,
3520 builtin_lisp_symbol (p
->name
));
3522 /* Look for an interval following iv that has different
3524 for (next_iv
= next_interval (iv
);
3527 || XFASTINT (limit
) > next_iv
->position
));
3528 next_iv
= next_interval (next_iv
))
3530 for (p
= it_props
; p
->handler
; ++p
)
3532 Lisp_Object new_value
= textget (next_iv
->plist
,
3533 builtin_lisp_symbol (p
->name
));
3534 if (!EQ (values_here
[p
->idx
], new_value
))
3544 if (INTEGERP (limit
)
3545 && next_iv
->position
>= XFASTINT (limit
))
3546 /* No text property change up to limit. */
3547 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3549 /* Text properties change in next_iv. */
3550 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3554 if (it
->cmp_it
.id
< 0)
3556 ptrdiff_t stoppos
= it
->end_charpos
;
3558 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3560 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3561 stoppos
, it
->string
);
3564 eassert (STRINGP (it
->string
)
3565 || (it
->stop_charpos
>= BEGV
3566 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3570 /* Return the position of the next overlay change after POS in
3571 current_buffer. Value is point-max if no overlay change
3572 follows. This is like `next-overlay-change' but doesn't use
3576 next_overlay_change (ptrdiff_t pos
)
3578 ptrdiff_t i
, noverlays
;
3580 Lisp_Object
*overlays
;
3583 /* Get all overlays at the given position. */
3584 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3586 /* If any of these overlays ends before endpos,
3587 use its ending point instead. */
3588 for (i
= 0; i
< noverlays
; ++i
)
3593 oend
= OVERLAY_END (overlays
[i
]);
3594 oendpos
= OVERLAY_POSITION (oend
);
3595 endpos
= min (endpos
, oendpos
);
3602 /* How many characters forward to search for a display property or
3603 display string. Searching too far forward makes the bidi display
3604 sluggish, especially in small windows. */
3605 #define MAX_DISP_SCAN 250
3607 /* Return the character position of a display string at or after
3608 position specified by POSITION. If no display string exists at or
3609 after POSITION, return ZV. A display string is either an overlay
3610 with `display' property whose value is a string, or a `display'
3611 text property whose value is a string. STRING is data about the
3612 string to iterate; if STRING->lstring is nil, we are iterating a
3613 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3614 on a GUI frame. DISP_PROP is set to zero if we searched
3615 MAX_DISP_SCAN characters forward without finding any display
3616 strings, non-zero otherwise. It is set to 2 if the display string
3617 uses any kind of `(space ...)' spec that will produce a stretch of
3618 white space in the text area. */
3620 compute_display_string_pos (struct text_pos
*position
,
3621 struct bidi_string_data
*string
,
3623 int frame_window_p
, int *disp_prop
)
3625 /* OBJECT = nil means current buffer. */
3626 Lisp_Object object
, object1
;
3627 Lisp_Object pos
, spec
, limpos
;
3628 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3629 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3630 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3631 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3633 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3634 struct text_pos tpos
;
3637 if (string
&& STRINGP (string
->lstring
))
3638 object1
= object
= string
->lstring
;
3639 else if (w
&& !string_p
)
3641 XSETWINDOW (object
, w
);
3645 object1
= object
= Qnil
;
3650 /* We don't support display properties whose values are strings
3651 that have display string properties. */
3652 || string
->from_disp_str
3653 /* C strings cannot have display properties. */
3654 || (string
->s
&& !STRINGP (object
)))
3660 /* If the character at CHARPOS is where the display string begins,
3662 pos
= make_number (charpos
);
3663 if (STRINGP (object
))
3664 bufpos
= string
->bufpos
;
3668 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3670 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3673 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3681 /* Look forward for the first character with a `display' property
3682 that will replace the underlying text when displayed. */
3683 limpos
= make_number (lim
);
3685 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3686 CHARPOS (tpos
) = XFASTINT (pos
);
3687 if (CHARPOS (tpos
) >= lim
)
3692 if (STRINGP (object
))
3693 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3695 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3696 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3697 if (!STRINGP (object
))
3698 bufpos
= CHARPOS (tpos
);
3699 } while (NILP (spec
)
3700 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3701 bufpos
, frame_window_p
)));
3705 return CHARPOS (tpos
);
3708 /* Return the character position of the end of the display string that
3709 started at CHARPOS. If there's no display string at CHARPOS,
3710 return -1. A display string is either an overlay with `display'
3711 property whose value is a string or a `display' text property whose
3712 value is a string. */
3714 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3716 /* OBJECT = nil means current buffer. */
3717 Lisp_Object object
=
3718 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3719 Lisp_Object pos
= make_number (charpos
);
3721 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3723 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3726 /* It could happen that the display property or overlay was removed
3727 since we found it in compute_display_string_pos above. One way
3728 this can happen is if JIT font-lock was called (through
3729 handle_fontified_prop), and jit-lock-functions remove text
3730 properties or overlays from the portion of buffer that includes
3731 CHARPOS. Muse mode is known to do that, for example. In this
3732 case, we return -1 to the caller, to signal that no display
3733 string is actually present at CHARPOS. See bidi_fetch_char for
3734 how this is handled.
3736 An alternative would be to never look for display properties past
3737 it->stop_charpos. But neither compute_display_string_pos nor
3738 bidi_fetch_char that calls it know or care where the next
3740 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3743 /* Look forward for the first character where the `display' property
3745 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3747 return XFASTINT (pos
);
3752 /***********************************************************************
3754 ***********************************************************************/
3756 /* Handle changes in the `fontified' property of the current buffer by
3757 calling hook functions from Qfontification_functions to fontify
3760 static enum prop_handled
3761 handle_fontified_prop (struct it
*it
)
3763 Lisp_Object prop
, pos
;
3764 enum prop_handled handled
= HANDLED_NORMALLY
;
3766 if (!NILP (Vmemory_full
))
3769 /* Get the value of the `fontified' property at IT's current buffer
3770 position. (The `fontified' property doesn't have a special
3771 meaning in strings.) If the value is nil, call functions from
3772 Qfontification_functions. */
3773 if (!STRINGP (it
->string
)
3775 && !NILP (Vfontification_functions
)
3776 && !NILP (Vrun_hooks
)
3777 && (pos
= make_number (IT_CHARPOS (*it
)),
3778 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3779 /* Ignore the special cased nil value always present at EOB since
3780 no amount of fontifying will be able to change it. */
3781 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3783 ptrdiff_t count
= SPECPDL_INDEX ();
3785 struct buffer
*obuf
= current_buffer
;
3786 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3787 bool old_clip_changed
= current_buffer
->clip_changed
;
3789 val
= Vfontification_functions
;
3790 specbind (Qfontification_functions
, Qnil
);
3792 eassert (it
->end_charpos
== ZV
);
3794 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3795 safe_call1 (val
, pos
);
3798 Lisp_Object fns
, fn
;
3799 struct gcpro gcpro1
, gcpro2
;
3804 for (; CONSP (val
); val
= XCDR (val
))
3810 /* A value of t indicates this hook has a local
3811 binding; it means to run the global binding too.
3812 In a global value, t should not occur. If it
3813 does, we must ignore it to avoid an endless
3815 for (fns
= Fdefault_value (Qfontification_functions
);
3821 safe_call1 (fn
, pos
);
3825 safe_call1 (fn
, pos
);
3831 unbind_to (count
, Qnil
);
3833 /* Fontification functions routinely call `save-restriction'.
3834 Normally, this tags clip_changed, which can confuse redisplay
3835 (see discussion in Bug#6671). Since we don't perform any
3836 special handling of fontification changes in the case where
3837 `save-restriction' isn't called, there's no point doing so in
3838 this case either. So, if the buffer's restrictions are
3839 actually left unchanged, reset clip_changed. */
3840 if (obuf
== current_buffer
)
3842 if (begv
== BEGV
&& zv
== ZV
)
3843 current_buffer
->clip_changed
= old_clip_changed
;
3845 /* There isn't much we can reasonably do to protect against
3846 misbehaving fontification, but here's a fig leaf. */
3847 else if (BUFFER_LIVE_P (obuf
))
3848 set_buffer_internal_1 (obuf
);
3850 /* The fontification code may have added/removed text.
3851 It could do even a lot worse, but let's at least protect against
3852 the most obvious case where only the text past `pos' gets changed',
3853 as is/was done in grep.el where some escapes sequences are turned
3854 into face properties (bug#7876). */
3855 it
->end_charpos
= ZV
;
3857 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3858 something. This avoids an endless loop if they failed to
3859 fontify the text for which reason ever. */
3860 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3861 handled
= HANDLED_RECOMPUTE_PROPS
;
3869 /***********************************************************************
3871 ***********************************************************************/
3873 /* Set up iterator IT from face properties at its current position.
3874 Called from handle_stop. */
3876 static enum prop_handled
3877 handle_face_prop (struct it
*it
)
3880 ptrdiff_t next_stop
;
3882 if (!STRINGP (it
->string
))
3885 = face_at_buffer_position (it
->w
,
3889 + TEXT_PROP_DISTANCE_LIMIT
),
3890 0, it
->base_face_id
);
3892 /* Is this a start of a run of characters with box face?
3893 Caveat: this can be called for a freshly initialized
3894 iterator; face_id is -1 in this case. We know that the new
3895 face will not change until limit, i.e. if the new face has a
3896 box, all characters up to limit will have one. But, as
3897 usual, we don't know whether limit is really the end. */
3898 if (new_face_id
!= it
->face_id
)
3900 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3901 /* If it->face_id is -1, old_face below will be NULL, see
3902 the definition of FACE_FROM_ID. This will happen if this
3903 is the initial call that gets the face. */
3904 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3906 /* If the value of face_id of the iterator is -1, we have to
3907 look in front of IT's position and see whether there is a
3908 face there that's different from new_face_id. */
3909 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3911 int prev_face_id
= face_before_it_pos (it
);
3913 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3916 /* If the new face has a box, but the old face does not,
3917 this is the start of a run of characters with box face,
3918 i.e. this character has a shadow on the left side. */
3919 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3920 && (old_face
== NULL
|| !old_face
->box
));
3921 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3929 Lisp_Object from_overlay
3930 = (it
->current
.overlay_string_index
>= 0
3931 ? it
->string_overlays
[it
->current
.overlay_string_index
3932 % OVERLAY_STRING_CHUNK_SIZE
]
3935 /* See if we got to this string directly or indirectly from
3936 an overlay property. That includes the before-string or
3937 after-string of an overlay, strings in display properties
3938 provided by an overlay, their text properties, etc.
3940 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3941 if (! NILP (from_overlay
))
3942 for (i
= it
->sp
- 1; i
>= 0; i
--)
3944 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3946 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3947 % OVERLAY_STRING_CHUNK_SIZE
];
3948 else if (! NILP (it
->stack
[i
].from_overlay
))
3949 from_overlay
= it
->stack
[i
].from_overlay
;
3951 if (!NILP (from_overlay
))
3955 if (! NILP (from_overlay
))
3957 bufpos
= IT_CHARPOS (*it
);
3958 /* For a string from an overlay, the base face depends
3959 only on text properties and ignores overlays. */
3961 = face_for_overlay_string (it
->w
,
3965 + TEXT_PROP_DISTANCE_LIMIT
),
3973 /* For strings from a `display' property, use the face at
3974 IT's current buffer position as the base face to merge
3975 with, so that overlay strings appear in the same face as
3976 surrounding text, unless they specify their own faces.
3977 For strings from wrap-prefix and line-prefix properties,
3978 use the default face, possibly remapped via
3979 Vface_remapping_alist. */
3980 /* Note that the fact that we use the face at _buffer_
3981 position means that a 'display' property on an overlay
3982 string will not inherit the face of that overlay string,
3983 but will instead revert to the face of buffer text
3984 covered by the overlay. This is visible, e.g., when the
3985 overlay specifies a box face, but neither the buffer nor
3986 the display string do. This sounds like a design bug,
3987 but Emacs always did that since v21.1, so changing that
3988 might be a big deal. */
3989 base_face_id
= it
->string_from_prefix_prop_p
3990 ? (!NILP (Vface_remapping_alist
)
3991 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3993 : underlying_face_id (it
);
3996 new_face_id
= face_at_string_position (it
->w
,
3998 IT_STRING_CHARPOS (*it
),
4003 /* Is this a start of a run of characters with box? Caveat:
4004 this can be called for a freshly allocated iterator; face_id
4005 is -1 is this case. We know that the new face will not
4006 change until the next check pos, i.e. if the new face has a
4007 box, all characters up to that position will have a
4008 box. But, as usual, we don't know whether that position
4009 is really the end. */
4010 if (new_face_id
!= it
->face_id
)
4012 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4013 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4015 /* If new face has a box but old face hasn't, this is the
4016 start of a run of characters with box, i.e. it has a
4017 shadow on the left side. */
4018 it
->start_of_box_run_p
4019 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4020 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4024 it
->face_id
= new_face_id
;
4025 return HANDLED_NORMALLY
;
4029 /* Return the ID of the face ``underlying'' IT's current position,
4030 which is in a string. If the iterator is associated with a
4031 buffer, return the face at IT's current buffer position.
4032 Otherwise, use the iterator's base_face_id. */
4035 underlying_face_id (struct it
*it
)
4037 int face_id
= it
->base_face_id
, i
;
4039 eassert (STRINGP (it
->string
));
4041 for (i
= it
->sp
- 1; i
>= 0; --i
)
4042 if (NILP (it
->stack
[i
].string
))
4043 face_id
= it
->stack
[i
].face_id
;
4049 /* Compute the face one character before or after the current position
4050 of IT, in the visual order. BEFORE_P non-zero means get the face
4051 in front (to the left in L2R paragraphs, to the right in R2L
4052 paragraphs) of IT's screen position. Value is the ID of the face. */
4055 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4058 ptrdiff_t next_check_charpos
;
4060 void *it_copy_data
= NULL
;
4062 eassert (it
->s
== NULL
);
4064 if (STRINGP (it
->string
))
4066 ptrdiff_t bufpos
, charpos
;
4069 /* No face change past the end of the string (for the case
4070 we are padding with spaces). No face change before the
4072 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4073 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4078 /* Set charpos to the position before or after IT's current
4079 position, in the logical order, which in the non-bidi
4080 case is the same as the visual order. */
4082 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4083 else if (it
->what
== IT_COMPOSITION
)
4084 /* For composition, we must check the character after the
4086 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4088 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4094 /* With bidi iteration, the character before the current
4095 in the visual order cannot be found by simple
4096 iteration, because "reverse" reordering is not
4097 supported. Instead, we need to use the move_it_*
4098 family of functions. */
4099 /* Ignore face changes before the first visible
4100 character on this display line. */
4101 if (it
->current_x
<= it
->first_visible_x
)
4103 SAVE_IT (it_copy
, *it
, it_copy_data
);
4104 /* Implementation note: Since move_it_in_display_line
4105 works in the iterator geometry, and thinks the first
4106 character is always the leftmost, even in R2L lines,
4107 we don't need to distinguish between the R2L and L2R
4109 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4110 it_copy
.current_x
- 1, MOVE_TO_X
);
4111 charpos
= IT_STRING_CHARPOS (it_copy
);
4112 RESTORE_IT (it
, it
, it_copy_data
);
4116 /* Set charpos to the string position of the character
4117 that comes after IT's current position in the visual
4119 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4123 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4125 charpos
= it_copy
.bidi_it
.charpos
;
4128 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4130 if (it
->current
.overlay_string_index
>= 0)
4131 bufpos
= IT_CHARPOS (*it
);
4135 base_face_id
= underlying_face_id (it
);
4137 /* Get the face for ASCII, or unibyte. */
4138 face_id
= face_at_string_position (it
->w
,
4142 &next_check_charpos
,
4145 /* Correct the face for charsets different from ASCII. Do it
4146 for the multibyte case only. The face returned above is
4147 suitable for unibyte text if IT->string is unibyte. */
4148 if (STRING_MULTIBYTE (it
->string
))
4150 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4151 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4153 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4155 c
= string_char_and_length (p
, &len
);
4156 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4161 struct text_pos pos
;
4163 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4164 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4167 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4168 pos
= it
->current
.pos
;
4173 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4176 if (it
->what
== IT_COMPOSITION
)
4178 /* For composition, we must check the position after
4180 pos
.charpos
+= it
->cmp_it
.nchars
;
4181 pos
.bytepos
+= it
->len
;
4184 INC_TEXT_POS (pos
, it
->multibyte_p
);
4191 /* With bidi iteration, the character before the current
4192 in the visual order cannot be found by simple
4193 iteration, because "reverse" reordering is not
4194 supported. Instead, we need to use the move_it_*
4195 family of functions. */
4196 /* Ignore face changes before the first visible
4197 character on this display line. */
4198 if (it
->current_x
<= it
->first_visible_x
)
4200 SAVE_IT (it_copy
, *it
, it_copy_data
);
4201 /* Implementation note: Since move_it_in_display_line
4202 works in the iterator geometry, and thinks the first
4203 character is always the leftmost, even in R2L lines,
4204 we don't need to distinguish between the R2L and L2R
4206 move_it_in_display_line (&it_copy
, ZV
,
4207 it_copy
.current_x
- 1, MOVE_TO_X
);
4208 pos
= it_copy
.current
.pos
;
4209 RESTORE_IT (it
, it
, it_copy_data
);
4213 /* Set charpos to the buffer position of the character
4214 that comes after IT's current position in the visual
4216 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4220 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4223 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4226 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4228 /* Determine face for CHARSET_ASCII, or unibyte. */
4229 face_id
= face_at_buffer_position (it
->w
,
4231 &next_check_charpos
,
4234 /* Correct the face for charsets different from ASCII. Do it
4235 for the multibyte case only. The face returned above is
4236 suitable for unibyte text if current_buffer is unibyte. */
4237 if (it
->multibyte_p
)
4239 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4240 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4241 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4250 /***********************************************************************
4252 ***********************************************************************/
4254 /* Set up iterator IT from invisible properties at its current
4255 position. Called from handle_stop. */
4257 static enum prop_handled
4258 handle_invisible_prop (struct it
*it
)
4260 enum prop_handled handled
= HANDLED_NORMALLY
;
4264 if (STRINGP (it
->string
))
4266 Lisp_Object end_charpos
, limit
, charpos
;
4268 /* Get the value of the invisible text property at the
4269 current position. Value will be nil if there is no such
4271 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4272 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4273 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4275 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4277 /* Record whether we have to display an ellipsis for the
4279 int display_ellipsis_p
= (invis_p
== 2);
4280 ptrdiff_t len
, endpos
;
4282 handled
= HANDLED_RECOMPUTE_PROPS
;
4284 /* Get the position at which the next visible text can be
4285 found in IT->string, if any. */
4286 endpos
= len
= SCHARS (it
->string
);
4287 XSETINT (limit
, len
);
4290 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4292 if (INTEGERP (end_charpos
))
4294 endpos
= XFASTINT (end_charpos
);
4295 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4296 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4298 display_ellipsis_p
= true;
4301 while (invis_p
&& endpos
< len
);
4303 if (display_ellipsis_p
)
4304 it
->ellipsis_p
= true;
4308 /* Text at END_CHARPOS is visible. Move IT there. */
4309 struct text_pos old
;
4312 old
= it
->current
.string_pos
;
4313 oldpos
= CHARPOS (old
);
4316 if (it
->bidi_it
.first_elt
4317 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4318 bidi_paragraph_init (it
->paragraph_embedding
,
4320 /* Bidi-iterate out of the invisible text. */
4323 bidi_move_to_visually_next (&it
->bidi_it
);
4325 while (oldpos
<= it
->bidi_it
.charpos
4326 && it
->bidi_it
.charpos
< endpos
);
4328 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4329 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4330 if (IT_CHARPOS (*it
) >= endpos
)
4331 it
->prev_stop
= endpos
;
4335 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4336 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4341 /* The rest of the string is invisible. If this is an
4342 overlay string, proceed with the next overlay string
4343 or whatever comes and return a character from there. */
4344 if (it
->current
.overlay_string_index
>= 0
4345 && !display_ellipsis_p
)
4347 next_overlay_string (it
);
4348 /* Don't check for overlay strings when we just
4349 finished processing them. */
4350 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4354 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4355 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4362 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4363 Lisp_Object pos
, overlay
;
4365 /* First of all, is there invisible text at this position? */
4366 tem
= start_charpos
= IT_CHARPOS (*it
);
4367 pos
= make_number (tem
);
4368 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4370 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4372 /* If we are on invisible text, skip over it. */
4373 if (invis_p
&& start_charpos
< it
->end_charpos
)
4375 /* Record whether we have to display an ellipsis for the
4377 int display_ellipsis_p
= invis_p
== 2;
4379 handled
= HANDLED_RECOMPUTE_PROPS
;
4381 /* Loop skipping over invisible text. The loop is left at
4382 ZV or with IT on the first char being visible again. */
4385 /* Try to skip some invisible text. Return value is the
4386 position reached which can be equal to where we start
4387 if there is nothing invisible there. This skips both
4388 over invisible text properties and overlays with
4389 invisible property. */
4390 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4392 /* If we skipped nothing at all we weren't at invisible
4393 text in the first place. If everything to the end of
4394 the buffer was skipped, end the loop. */
4395 if (newpos
== tem
|| newpos
>= ZV
)
4399 /* We skipped some characters but not necessarily
4400 all there are. Check if we ended up on visible
4401 text. Fget_char_property returns the property of
4402 the char before the given position, i.e. if we
4403 get invis_p = 0, this means that the char at
4404 newpos is visible. */
4405 pos
= make_number (newpos
);
4406 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4407 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4410 /* If we ended up on invisible text, proceed to
4411 skip starting with next_stop. */
4415 /* If there are adjacent invisible texts, don't lose the
4416 second one's ellipsis. */
4418 display_ellipsis_p
= true;
4422 /* The position newpos is now either ZV or on visible text. */
4425 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4427 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4429 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4431 /* If the invisible text ends on a newline or on a
4432 character after a newline, we can avoid the costly,
4433 character by character, bidi iteration to NEWPOS, and
4434 instead simply reseat the iterator there. That's
4435 because all bidi reordering information is tossed at
4436 the newline. This is a big win for modes that hide
4437 complete lines, like Outline, Org, etc. */
4438 if (on_newline
|| after_newline
)
4440 struct text_pos tpos
;
4441 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4443 SET_TEXT_POS (tpos
, newpos
, bpos
);
4444 reseat_1 (it
, tpos
, 0);
4445 /* If we reseat on a newline/ZV, we need to prep the
4446 bidi iterator for advancing to the next character
4447 after the newline/EOB, keeping the current paragraph
4448 direction (so that PRODUCE_GLYPHS does TRT wrt
4449 prepending/appending glyphs to a glyph row). */
4452 it
->bidi_it
.first_elt
= 0;
4453 it
->bidi_it
.paragraph_dir
= pdir
;
4454 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4455 it
->bidi_it
.nchars
= 1;
4456 it
->bidi_it
.ch_len
= 1;
4459 else /* Must use the slow method. */
4461 /* With bidi iteration, the region of invisible text
4462 could start and/or end in the middle of a
4463 non-base embedding level. Therefore, we need to
4464 skip invisible text using the bidi iterator,
4465 starting at IT's current position, until we find
4466 ourselves outside of the invisible text.
4467 Skipping invisible text _after_ bidi iteration
4468 avoids affecting the visual order of the
4469 displayed text when invisible properties are
4470 added or removed. */
4471 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4473 /* If we were `reseat'ed to a new paragraph,
4474 determine the paragraph base direction. We
4475 need to do it now because
4476 next_element_from_buffer may not have a
4477 chance to do it, if we are going to skip any
4478 text at the beginning, which resets the
4480 bidi_paragraph_init (it
->paragraph_embedding
,
4485 bidi_move_to_visually_next (&it
->bidi_it
);
4487 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4488 && it
->bidi_it
.charpos
< newpos
);
4489 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4490 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4491 /* If we overstepped NEWPOS, record its position in
4492 the iterator, so that we skip invisible text if
4493 later the bidi iteration lands us in the
4494 invisible region again. */
4495 if (IT_CHARPOS (*it
) >= newpos
)
4496 it
->prev_stop
= newpos
;
4501 IT_CHARPOS (*it
) = newpos
;
4502 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4505 /* If there are before-strings at the start of invisible
4506 text, and the text is invisible because of a text
4507 property, arrange to show before-strings because 20.x did
4508 it that way. (If the text is invisible because of an
4509 overlay property instead of a text property, this is
4510 already handled in the overlay code.) */
4512 && get_overlay_strings (it
, it
->stop_charpos
))
4514 handled
= HANDLED_RECOMPUTE_PROPS
;
4517 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4518 /* The call to get_overlay_strings above recomputes
4519 it->stop_charpos, but it only considers changes
4520 in properties and overlays beyond iterator's
4521 current position. This causes us to miss changes
4522 that happen exactly where the invisible property
4523 ended. So we play it safe here and force the
4524 iterator to check for potential stop positions
4525 immediately after the invisible text. Note that
4526 if get_overlay_strings returns non-zero, it
4527 normally also pushed the iterator stack, so we
4528 need to update the stop position in the slot
4529 below the current one. */
4530 it
->stack
[it
->sp
- 1].stop_charpos
4531 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4534 else if (display_ellipsis_p
)
4536 /* Make sure that the glyphs of the ellipsis will get
4537 correct `charpos' values. If we would not update
4538 it->position here, the glyphs would belong to the
4539 last visible character _before_ the invisible
4540 text, which confuses `set_cursor_from_row'.
4542 We use the last invisible position instead of the
4543 first because this way the cursor is always drawn on
4544 the first "." of the ellipsis, whenever PT is inside
4545 the invisible text. Otherwise the cursor would be
4546 placed _after_ the ellipsis when the point is after the
4547 first invisible character. */
4548 if (!STRINGP (it
->object
))
4550 it
->position
.charpos
= newpos
- 1;
4551 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4553 it
->ellipsis_p
= true;
4554 /* Let the ellipsis display before
4555 considering any properties of the following char.
4556 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4557 handled
= HANDLED_RETURN
;
4566 /* Make iterator IT return `...' next.
4567 Replaces LEN characters from buffer. */
4570 setup_for_ellipsis (struct it
*it
, int len
)
4572 /* Use the display table definition for `...'. Invalid glyphs
4573 will be handled by the method returning elements from dpvec. */
4574 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4576 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4577 it
->dpvec
= v
->contents
;
4578 it
->dpend
= v
->contents
+ v
->header
.size
;
4582 /* Default `...'. */
4583 it
->dpvec
= default_invis_vector
;
4584 it
->dpend
= default_invis_vector
+ 3;
4587 it
->dpvec_char_len
= len
;
4588 it
->current
.dpvec_index
= 0;
4589 it
->dpvec_face_id
= -1;
4591 /* Remember the current face id in case glyphs specify faces.
4592 IT's face is restored in set_iterator_to_next.
4593 saved_face_id was set to preceding char's face in handle_stop. */
4594 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4595 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4597 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4598 it
->ellipsis_p
= true;
4603 /***********************************************************************
4605 ***********************************************************************/
4607 /* Set up iterator IT from `display' property at its current position.
4608 Called from handle_stop.
4609 We return HANDLED_RETURN if some part of the display property
4610 overrides the display of the buffer text itself.
4611 Otherwise we return HANDLED_NORMALLY. */
4613 static enum prop_handled
4614 handle_display_prop (struct it
*it
)
4616 Lisp_Object propval
, object
, overlay
;
4617 struct text_pos
*position
;
4619 /* Nonzero if some property replaces the display of the text itself. */
4620 int display_replaced_p
= 0;
4622 if (STRINGP (it
->string
))
4624 object
= it
->string
;
4625 position
= &it
->current
.string_pos
;
4626 bufpos
= CHARPOS (it
->current
.pos
);
4630 XSETWINDOW (object
, it
->w
);
4631 position
= &it
->current
.pos
;
4632 bufpos
= CHARPOS (*position
);
4635 /* Reset those iterator values set from display property values. */
4636 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4637 it
->space_width
= Qnil
;
4638 it
->font_height
= Qnil
;
4641 /* We don't support recursive `display' properties, i.e. string
4642 values that have a string `display' property, that have a string
4643 `display' property etc. */
4644 if (!it
->string_from_display_prop_p
)
4645 it
->area
= TEXT_AREA
;
4647 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4648 Qdisplay
, object
, &overlay
);
4650 return HANDLED_NORMALLY
;
4651 /* Now OVERLAY is the overlay that gave us this property, or nil
4652 if it was a text property. */
4654 if (!STRINGP (it
->string
))
4655 object
= it
->w
->contents
;
4657 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4659 FRAME_WINDOW_P (it
->f
));
4661 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4664 /* Subroutine of handle_display_prop. Returns non-zero if the display
4665 specification in SPEC is a replacing specification, i.e. it would
4666 replace the text covered by `display' property with something else,
4667 such as an image or a display string. If SPEC includes any kind or
4668 `(space ...) specification, the value is 2; this is used by
4669 compute_display_string_pos, which see.
4671 See handle_single_display_spec for documentation of arguments.
4672 frame_window_p is non-zero if the window being redisplayed is on a
4673 GUI frame; this argument is used only if IT is NULL, see below.
4675 IT can be NULL, if this is called by the bidi reordering code
4676 through compute_display_string_pos, which see. In that case, this
4677 function only examines SPEC, but does not otherwise "handle" it, in
4678 the sense that it doesn't set up members of IT from the display
4681 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4682 Lisp_Object overlay
, struct text_pos
*position
,
4683 ptrdiff_t bufpos
, int frame_window_p
)
4685 int replacing_p
= 0;
4689 /* Simple specifications. */
4690 && !EQ (XCAR (spec
), Qimage
)
4691 #ifdef HAVE_XWIDGETS
4692 && !EQ (XCAR (spec
), Qxwidget
)
4694 && !EQ (XCAR (spec
), Qspace
)
4695 && !EQ (XCAR (spec
), Qwhen
)
4696 && !EQ (XCAR (spec
), Qslice
)
4697 && !EQ (XCAR (spec
), Qspace_width
)
4698 && !EQ (XCAR (spec
), Qheight
)
4699 && !EQ (XCAR (spec
), Qraise
)
4700 /* Marginal area specifications. */
4701 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4702 && !EQ (XCAR (spec
), Qleft_fringe
)
4703 && !EQ (XCAR (spec
), Qright_fringe
)
4704 && !NILP (XCAR (spec
)))
4706 for (; CONSP (spec
); spec
= XCDR (spec
))
4708 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4709 overlay
, position
, bufpos
,
4710 replacing_p
, frame_window_p
)))
4713 /* If some text in a string is replaced, `position' no
4714 longer points to the position of `object'. */
4715 if (!it
|| STRINGP (object
))
4720 else if (VECTORP (spec
))
4723 for (i
= 0; i
< ASIZE (spec
); ++i
)
4724 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4725 overlay
, position
, bufpos
,
4726 replacing_p
, frame_window_p
)))
4729 /* If some text in a string is replaced, `position' no
4730 longer points to the position of `object'. */
4731 if (!it
|| STRINGP (object
))
4737 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4738 position
, bufpos
, 0,
4746 /* Value is the position of the end of the `display' property starting
4747 at START_POS in OBJECT. */
4749 static struct text_pos
4750 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4753 struct text_pos end_pos
;
4755 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4756 Qdisplay
, object
, Qnil
);
4757 CHARPOS (end_pos
) = XFASTINT (end
);
4758 if (STRINGP (object
))
4759 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4761 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4767 /* Set up IT from a single `display' property specification SPEC. OBJECT
4768 is the object in which the `display' property was found. *POSITION
4769 is the position in OBJECT at which the `display' property was found.
4770 BUFPOS is the buffer position of OBJECT (different from POSITION if
4771 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4772 previously saw a display specification which already replaced text
4773 display with something else, for example an image; we ignore such
4774 properties after the first one has been processed.
4776 OVERLAY is the overlay this `display' property came from,
4777 or nil if it was a text property.
4779 If SPEC is a `space' or `image' specification, and in some other
4780 cases too, set *POSITION to the position where the `display'
4783 If IT is NULL, only examine the property specification in SPEC, but
4784 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4785 is intended to be displayed in a window on a GUI frame.
4787 Value is non-zero if something was found which replaces the display
4788 of buffer or string text. */
4791 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4792 Lisp_Object overlay
, struct text_pos
*position
,
4793 ptrdiff_t bufpos
, int display_replaced_p
,
4797 Lisp_Object location
, value
;
4798 struct text_pos start_pos
= *position
;
4801 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4802 If the result is non-nil, use VALUE instead of SPEC. */
4804 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4813 if (!NILP (form
) && !EQ (form
, Qt
))
4815 ptrdiff_t count
= SPECPDL_INDEX ();
4816 struct gcpro gcpro1
;
4818 /* Bind `object' to the object having the `display' property, a
4819 buffer or string. Bind `position' to the position in the
4820 object where the property was found, and `buffer-position'
4821 to the current position in the buffer. */
4824 XSETBUFFER (object
, current_buffer
);
4825 specbind (Qobject
, object
);
4826 specbind (Qposition
, make_number (CHARPOS (*position
)));
4827 specbind (Qbuffer_position
, make_number (bufpos
));
4829 form
= safe_eval (form
);
4831 unbind_to (count
, Qnil
);
4837 /* Handle `(height HEIGHT)' specifications. */
4839 && EQ (XCAR (spec
), Qheight
)
4840 && CONSP (XCDR (spec
)))
4844 if (!FRAME_WINDOW_P (it
->f
))
4847 it
->font_height
= XCAR (XCDR (spec
));
4848 if (!NILP (it
->font_height
))
4850 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4851 int new_height
= -1;
4853 if (CONSP (it
->font_height
)
4854 && (EQ (XCAR (it
->font_height
), Qplus
)
4855 || EQ (XCAR (it
->font_height
), Qminus
))
4856 && CONSP (XCDR (it
->font_height
))
4857 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4859 /* `(+ N)' or `(- N)' where N is an integer. */
4860 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4861 if (EQ (XCAR (it
->font_height
), Qplus
))
4863 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4865 else if (FUNCTIONP (it
->font_height
))
4867 /* Call function with current height as argument.
4868 Value is the new height. */
4870 height
= safe_call1 (it
->font_height
,
4871 face
->lface
[LFACE_HEIGHT_INDEX
]);
4872 if (NUMBERP (height
))
4873 new_height
= XFLOATINT (height
);
4875 else if (NUMBERP (it
->font_height
))
4877 /* Value is a multiple of the canonical char height. */
4880 f
= FACE_FROM_ID (it
->f
,
4881 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4882 new_height
= (XFLOATINT (it
->font_height
)
4883 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4887 /* Evaluate IT->font_height with `height' bound to the
4888 current specified height to get the new height. */
4889 ptrdiff_t count
= SPECPDL_INDEX ();
4891 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4892 value
= safe_eval (it
->font_height
);
4893 unbind_to (count
, Qnil
);
4895 if (NUMBERP (value
))
4896 new_height
= XFLOATINT (value
);
4900 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4907 /* Handle `(space-width WIDTH)'. */
4909 && EQ (XCAR (spec
), Qspace_width
)
4910 && CONSP (XCDR (spec
)))
4914 if (!FRAME_WINDOW_P (it
->f
))
4917 value
= XCAR (XCDR (spec
));
4918 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4919 it
->space_width
= value
;
4925 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4927 && EQ (XCAR (spec
), Qslice
))
4933 if (!FRAME_WINDOW_P (it
->f
))
4936 if (tem
= XCDR (spec
), CONSP (tem
))
4938 it
->slice
.x
= XCAR (tem
);
4939 if (tem
= XCDR (tem
), CONSP (tem
))
4941 it
->slice
.y
= XCAR (tem
);
4942 if (tem
= XCDR (tem
), CONSP (tem
))
4944 it
->slice
.width
= XCAR (tem
);
4945 if (tem
= XCDR (tem
), CONSP (tem
))
4946 it
->slice
.height
= XCAR (tem
);
4955 /* Handle `(raise FACTOR)'. */
4957 && EQ (XCAR (spec
), Qraise
)
4958 && CONSP (XCDR (spec
)))
4962 if (!FRAME_WINDOW_P (it
->f
))
4965 #ifdef HAVE_WINDOW_SYSTEM
4966 value
= XCAR (XCDR (spec
));
4967 if (NUMBERP (value
))
4969 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4970 it
->voffset
= - (XFLOATINT (value
)
4971 * (FONT_HEIGHT (face
->font
)));
4973 #endif /* HAVE_WINDOW_SYSTEM */
4979 /* Don't handle the other kinds of display specifications
4980 inside a string that we got from a `display' property. */
4981 if (it
&& it
->string_from_display_prop_p
)
4984 /* Characters having this form of property are not displayed, so
4985 we have to find the end of the property. */
4988 start_pos
= *position
;
4989 *position
= display_prop_end (it
, object
, start_pos
);
4993 /* Stop the scan at that end position--we assume that all
4994 text properties change there. */
4996 it
->stop_charpos
= position
->charpos
;
4998 /* Handle `(left-fringe BITMAP [FACE])'
4999 and `(right-fringe BITMAP [FACE])'. */
5001 && (EQ (XCAR (spec
), Qleft_fringe
)
5002 || EQ (XCAR (spec
), Qright_fringe
))
5003 && CONSP (XCDR (spec
)))
5009 if (!FRAME_WINDOW_P (it
->f
))
5010 /* If we return here, POSITION has been advanced
5011 across the text with this property. */
5013 /* Synchronize the bidi iterator with POSITION. This is
5014 needed because we are not going to push the iterator
5015 on behalf of this display property, so there will be
5016 no pop_it call to do this synchronization for us. */
5019 it
->position
= *position
;
5020 iterate_out_of_display_property (it
);
5021 *position
= it
->position
;
5023 /* If we were to display this fringe bitmap,
5024 next_element_from_image would have reset this flag.
5025 Do the same, to avoid affecting overlays that
5027 it
->ignore_overlay_strings_at_pos_p
= 0;
5031 else if (!frame_window_p
)
5034 #ifdef HAVE_WINDOW_SYSTEM
5035 value
= XCAR (XCDR (spec
));
5036 if (!SYMBOLP (value
)
5037 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5038 /* If we return here, POSITION has been advanced
5039 across the text with this property. */
5041 if (it
&& it
->bidi_p
)
5043 it
->position
= *position
;
5044 iterate_out_of_display_property (it
);
5045 *position
= it
->position
;
5048 /* Reset this flag like next_element_from_image would. */
5049 it
->ignore_overlay_strings_at_pos_p
= 0;
5055 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5057 if (CONSP (XCDR (XCDR (spec
))))
5059 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5060 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5066 /* Save current settings of IT so that we can restore them
5067 when we are finished with the glyph property value. */
5068 push_it (it
, position
);
5070 it
->area
= TEXT_AREA
;
5071 it
->what
= IT_IMAGE
;
5072 it
->image_id
= -1; /* no image */
5073 it
->position
= start_pos
;
5074 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5075 it
->method
= GET_FROM_IMAGE
;
5076 it
->from_overlay
= Qnil
;
5077 it
->face_id
= face_id
;
5078 it
->from_disp_prop_p
= true;
5080 /* Say that we haven't consumed the characters with
5081 `display' property yet. The call to pop_it in
5082 set_iterator_to_next will clean this up. */
5083 *position
= start_pos
;
5085 if (EQ (XCAR (spec
), Qleft_fringe
))
5087 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5088 it
->left_user_fringe_face_id
= face_id
;
5092 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5093 it
->right_user_fringe_face_id
= face_id
;
5096 #endif /* HAVE_WINDOW_SYSTEM */
5100 /* Prepare to handle `((margin left-margin) ...)',
5101 `((margin right-margin) ...)' and `((margin nil) ...)'
5102 prefixes for display specifications. */
5103 location
= Qunbound
;
5104 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5108 value
= XCDR (spec
);
5110 value
= XCAR (value
);
5113 if (EQ (XCAR (tem
), Qmargin
)
5114 && (tem
= XCDR (tem
),
5115 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5117 || EQ (tem
, Qleft_margin
)
5118 || EQ (tem
, Qright_margin
))))
5122 if (EQ (location
, Qunbound
))
5128 /* After this point, VALUE is the property after any
5129 margin prefix has been stripped. It must be a string,
5130 an image specification, or `(space ...)'.
5132 LOCATION specifies where to display: `left-margin',
5133 `right-margin' or nil. */
5135 valid_p
= (STRINGP (value
)
5136 #ifdef HAVE_WINDOW_SYSTEM
5137 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5138 && valid_image_p (value
))
5139 #endif /* not HAVE_WINDOW_SYSTEM */
5140 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5141 #ifdef HAVE_XWIDGETS
5142 || valid_xwidget_spec_p(value
)
5146 if (valid_p
&& !display_replaced_p
)
5152 /* Callers need to know whether the display spec is any kind
5153 of `(space ...)' spec that is about to affect text-area
5155 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5160 /* Save current settings of IT so that we can restore them
5161 when we are finished with the glyph property value. */
5162 push_it (it
, position
);
5163 it
->from_overlay
= overlay
;
5164 it
->from_disp_prop_p
= true;
5166 if (NILP (location
))
5167 it
->area
= TEXT_AREA
;
5168 else if (EQ (location
, Qleft_margin
))
5169 it
->area
= LEFT_MARGIN_AREA
;
5171 it
->area
= RIGHT_MARGIN_AREA
;
5173 if (STRINGP (value
))
5176 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5177 it
->current
.overlay_string_index
= -1;
5178 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5179 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5180 it
->method
= GET_FROM_STRING
;
5181 it
->stop_charpos
= 0;
5183 it
->base_level_stop
= 0;
5184 it
->string_from_display_prop_p
= true;
5185 /* Say that we haven't consumed the characters with
5186 `display' property yet. The call to pop_it in
5187 set_iterator_to_next will clean this up. */
5188 if (BUFFERP (object
))
5189 *position
= start_pos
;
5191 /* Force paragraph direction to be that of the parent
5192 object. If the parent object's paragraph direction is
5193 not yet determined, default to L2R. */
5194 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5195 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5197 it
->paragraph_embedding
= L2R
;
5199 /* Set up the bidi iterator for this display string. */
5202 it
->bidi_it
.string
.lstring
= it
->string
;
5203 it
->bidi_it
.string
.s
= NULL
;
5204 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5205 it
->bidi_it
.string
.bufpos
= bufpos
;
5206 it
->bidi_it
.string
.from_disp_str
= 1;
5207 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5208 it
->bidi_it
.w
= it
->w
;
5209 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5212 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5214 it
->method
= GET_FROM_STRETCH
;
5216 *position
= it
->position
= start_pos
;
5217 retval
= 1 + (it
->area
== TEXT_AREA
);
5219 #ifdef HAVE_XWIDGETS
5220 else if (valid_xwidget_spec_p(value
))
5222 //printf("handle_single_display_spec: im an xwidget!!\n");
5223 it
->what
= IT_XWIDGET
;
5224 it
->method
= GET_FROM_XWIDGET
;
5225 it
->position
= start_pos
;
5226 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5227 *position
= start_pos
;
5229 it
->xwidget
= lookup_xwidget(value
);
5232 #ifdef HAVE_WINDOW_SYSTEM
5235 it
->what
= IT_IMAGE
;
5236 it
->image_id
= lookup_image (it
->f
, value
);
5237 it
->position
= start_pos
;
5238 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5239 it
->method
= GET_FROM_IMAGE
;
5241 /* Say that we haven't consumed the characters with
5242 `display' property yet. The call to pop_it in
5243 set_iterator_to_next will clean this up. */
5244 *position
= start_pos
;
5246 #endif /* HAVE_WINDOW_SYSTEM */
5251 /* Invalid property or property not supported. Restore
5252 POSITION to what it was before. */
5253 *position
= start_pos
;
5257 /* Check if PROP is a display property value whose text should be
5258 treated as intangible. OVERLAY is the overlay from which PROP
5259 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5260 specify the buffer position covered by PROP. */
5263 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5264 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5266 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5267 struct text_pos position
;
5269 SET_TEXT_POS (position
, charpos
, bytepos
);
5270 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5271 &position
, charpos
, frame_window_p
);
5275 /* Return 1 if PROP is a display sub-property value containing STRING.
5277 Implementation note: this and the following function are really
5278 special cases of handle_display_spec and
5279 handle_single_display_spec, and should ideally use the same code.
5280 Until they do, these two pairs must be consistent and must be
5281 modified in sync. */
5284 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5286 if (EQ (string
, prop
))
5289 /* Skip over `when FORM'. */
5290 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5295 /* Actually, the condition following `when' should be eval'ed,
5296 like handle_single_display_spec does, and we should return
5297 zero if it evaluates to nil. However, this function is
5298 called only when the buffer was already displayed and some
5299 glyph in the glyph matrix was found to come from a display
5300 string. Therefore, the condition was already evaluated, and
5301 the result was non-nil, otherwise the display string wouldn't
5302 have been displayed and we would have never been called for
5303 this property. Thus, we can skip the evaluation and assume
5304 its result is non-nil. */
5309 /* Skip over `margin LOCATION'. */
5310 if (EQ (XCAR (prop
), Qmargin
))
5321 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5325 /* Return 1 if STRING appears in the `display' property PROP. */
5328 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5331 && !EQ (XCAR (prop
), Qwhen
)
5332 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5334 /* A list of sub-properties. */
5335 while (CONSP (prop
))
5337 if (single_display_spec_string_p (XCAR (prop
), string
))
5342 else if (VECTORP (prop
))
5344 /* A vector of sub-properties. */
5346 for (i
= 0; i
< ASIZE (prop
); ++i
)
5347 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5351 return single_display_spec_string_p (prop
, string
);
5356 /* Look for STRING in overlays and text properties in the current
5357 buffer, between character positions FROM and TO (excluding TO).
5358 BACK_P non-zero means look back (in this case, TO is supposed to be
5360 Value is the first character position where STRING was found, or
5361 zero if it wasn't found before hitting TO.
5363 This function may only use code that doesn't eval because it is
5364 called asynchronously from note_mouse_highlight. */
5367 string_buffer_position_lim (Lisp_Object string
,
5368 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5370 Lisp_Object limit
, prop
, pos
;
5373 pos
= make_number (max (from
, BEGV
));
5375 if (!back_p
) /* looking forward */
5377 limit
= make_number (min (to
, ZV
));
5378 while (!found
&& !EQ (pos
, limit
))
5380 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5381 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5384 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5388 else /* looking back */
5390 limit
= make_number (max (to
, BEGV
));
5391 while (!found
&& !EQ (pos
, limit
))
5393 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5394 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5397 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5402 return found
? XINT (pos
) : 0;
5405 /* Determine which buffer position in current buffer STRING comes from.
5406 AROUND_CHARPOS is an approximate position where it could come from.
5407 Value is the buffer position or 0 if it couldn't be determined.
5409 This function is necessary because we don't record buffer positions
5410 in glyphs generated from strings (to keep struct glyph small).
5411 This function may only use code that doesn't eval because it is
5412 called asynchronously from note_mouse_highlight. */
5415 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5417 const int MAX_DISTANCE
= 1000;
5418 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5419 around_charpos
+ MAX_DISTANCE
,
5423 found
= string_buffer_position_lim (string
, around_charpos
,
5424 around_charpos
- MAX_DISTANCE
, 1);
5430 /***********************************************************************
5431 `composition' property
5432 ***********************************************************************/
5434 /* Set up iterator IT from `composition' property at its current
5435 position. Called from handle_stop. */
5437 static enum prop_handled
5438 handle_composition_prop (struct it
*it
)
5440 Lisp_Object prop
, string
;
5441 ptrdiff_t pos
, pos_byte
, start
, end
;
5443 if (STRINGP (it
->string
))
5447 pos
= IT_STRING_CHARPOS (*it
);
5448 pos_byte
= IT_STRING_BYTEPOS (*it
);
5449 string
= it
->string
;
5450 s
= SDATA (string
) + pos_byte
;
5451 it
->c
= STRING_CHAR (s
);
5455 pos
= IT_CHARPOS (*it
);
5456 pos_byte
= IT_BYTEPOS (*it
);
5458 it
->c
= FETCH_CHAR (pos_byte
);
5461 /* If there's a valid composition and point is not inside of the
5462 composition (in the case that the composition is from the current
5463 buffer), draw a glyph composed from the composition components. */
5464 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5465 && composition_valid_p (start
, end
, prop
)
5466 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5469 /* As we can't handle this situation (perhaps font-lock added
5470 a new composition), we just return here hoping that next
5471 redisplay will detect this composition much earlier. */
5472 return HANDLED_NORMALLY
;
5475 if (STRINGP (it
->string
))
5476 pos_byte
= string_char_to_byte (it
->string
, start
);
5478 pos_byte
= CHAR_TO_BYTE (start
);
5480 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5483 if (it
->cmp_it
.id
>= 0)
5486 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5487 it
->cmp_it
.nglyphs
= -1;
5491 return HANDLED_NORMALLY
;
5496 /***********************************************************************
5498 ***********************************************************************/
5500 /* The following structure is used to record overlay strings for
5501 later sorting in load_overlay_strings. */
5503 struct overlay_entry
5505 Lisp_Object overlay
;
5512 /* Set up iterator IT from overlay strings at its current position.
5513 Called from handle_stop. */
5515 static enum prop_handled
5516 handle_overlay_change (struct it
*it
)
5518 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5519 return HANDLED_RECOMPUTE_PROPS
;
5521 return HANDLED_NORMALLY
;
5525 /* Set up the next overlay string for delivery by IT, if there is an
5526 overlay string to deliver. Called by set_iterator_to_next when the
5527 end of the current overlay string is reached. If there are more
5528 overlay strings to display, IT->string and
5529 IT->current.overlay_string_index are set appropriately here.
5530 Otherwise IT->string is set to nil. */
5533 next_overlay_string (struct it
*it
)
5535 ++it
->current
.overlay_string_index
;
5536 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5538 /* No more overlay strings. Restore IT's settings to what
5539 they were before overlay strings were processed, and
5540 continue to deliver from current_buffer. */
5542 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5545 || (NILP (it
->string
)
5546 && it
->method
== GET_FROM_BUFFER
5547 && it
->stop_charpos
>= BEGV
5548 && it
->stop_charpos
<= it
->end_charpos
));
5549 it
->current
.overlay_string_index
= -1;
5550 it
->n_overlay_strings
= 0;
5551 it
->overlay_strings_charpos
= -1;
5552 /* If there's an empty display string on the stack, pop the
5553 stack, to resync the bidi iterator with IT's position. Such
5554 empty strings are pushed onto the stack in
5555 get_overlay_strings_1. */
5556 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5559 /* If we're at the end of the buffer, record that we have
5560 processed the overlay strings there already, so that
5561 next_element_from_buffer doesn't try it again. */
5562 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5563 it
->overlay_strings_at_end_processed_p
= true;
5567 /* There are more overlay strings to process. If
5568 IT->current.overlay_string_index has advanced to a position
5569 where we must load IT->overlay_strings with more strings, do
5570 it. We must load at the IT->overlay_strings_charpos where
5571 IT->n_overlay_strings was originally computed; when invisible
5572 text is present, this might not be IT_CHARPOS (Bug#7016). */
5573 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5575 if (it
->current
.overlay_string_index
&& i
== 0)
5576 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5578 /* Initialize IT to deliver display elements from the overlay
5580 it
->string
= it
->overlay_strings
[i
];
5581 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5582 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5583 it
->method
= GET_FROM_STRING
;
5584 it
->stop_charpos
= 0;
5585 it
->end_charpos
= SCHARS (it
->string
);
5586 if (it
->cmp_it
.stop_pos
>= 0)
5587 it
->cmp_it
.stop_pos
= 0;
5589 it
->base_level_stop
= 0;
5591 /* Set up the bidi iterator for this overlay string. */
5594 it
->bidi_it
.string
.lstring
= it
->string
;
5595 it
->bidi_it
.string
.s
= NULL
;
5596 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5597 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5598 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5599 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5600 it
->bidi_it
.w
= it
->w
;
5601 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5609 /* Compare two overlay_entry structures E1 and E2. Used as a
5610 comparison function for qsort in load_overlay_strings. Overlay
5611 strings for the same position are sorted so that
5613 1. All after-strings come in front of before-strings, except
5614 when they come from the same overlay.
5616 2. Within after-strings, strings are sorted so that overlay strings
5617 from overlays with higher priorities come first.
5619 2. Within before-strings, strings are sorted so that overlay
5620 strings from overlays with higher priorities come last.
5622 Value is analogous to strcmp. */
5626 compare_overlay_entries (const void *e1
, const void *e2
)
5628 struct overlay_entry
const *entry1
= e1
;
5629 struct overlay_entry
const *entry2
= e2
;
5632 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5634 /* Let after-strings appear in front of before-strings if
5635 they come from different overlays. */
5636 if (EQ (entry1
->overlay
, entry2
->overlay
))
5637 result
= entry1
->after_string_p
? 1 : -1;
5639 result
= entry1
->after_string_p
? -1 : 1;
5641 else if (entry1
->priority
!= entry2
->priority
)
5643 if (entry1
->after_string_p
)
5644 /* After-strings sorted in order of decreasing priority. */
5645 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5647 /* Before-strings sorted in order of increasing priority. */
5648 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5657 /* Load the vector IT->overlay_strings with overlay strings from IT's
5658 current buffer position, or from CHARPOS if that is > 0. Set
5659 IT->n_overlays to the total number of overlay strings found.
5661 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5662 a time. On entry into load_overlay_strings,
5663 IT->current.overlay_string_index gives the number of overlay
5664 strings that have already been loaded by previous calls to this
5667 IT->add_overlay_start contains an additional overlay start
5668 position to consider for taking overlay strings from, if non-zero.
5669 This position comes into play when the overlay has an `invisible'
5670 property, and both before and after-strings. When we've skipped to
5671 the end of the overlay, because of its `invisible' property, we
5672 nevertheless want its before-string to appear.
5673 IT->add_overlay_start will contain the overlay start position
5676 Overlay strings are sorted so that after-string strings come in
5677 front of before-string strings. Within before and after-strings,
5678 strings are sorted by overlay priority. See also function
5679 compare_overlay_entries. */
5682 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5684 Lisp_Object overlay
, window
, str
, invisible
;
5685 struct Lisp_Overlay
*ov
;
5686 ptrdiff_t start
, end
;
5687 ptrdiff_t n
= 0, i
, j
;
5689 struct overlay_entry entriesbuf
[20];
5690 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5691 struct overlay_entry
*entries
= entriesbuf
;
5695 charpos
= IT_CHARPOS (*it
);
5697 /* Append the overlay string STRING of overlay OVERLAY to vector
5698 `entries' which has size `size' and currently contains `n'
5699 elements. AFTER_P non-zero means STRING is an after-string of
5701 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5704 Lisp_Object priority; \
5708 struct overlay_entry *old = entries; \
5709 SAFE_NALLOCA (entries, 2, size); \
5710 memcpy (entries, old, size * sizeof *entries); \
5714 entries[n].string = (STRING); \
5715 entries[n].overlay = (OVERLAY); \
5716 priority = Foverlay_get ((OVERLAY), Qpriority); \
5717 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5718 entries[n].after_string_p = (AFTER_P); \
5723 /* Process overlay before the overlay center. */
5724 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5726 XSETMISC (overlay
, ov
);
5727 eassert (OVERLAYP (overlay
));
5728 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5729 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5734 /* Skip this overlay if it doesn't start or end at IT's current
5736 if (end
!= charpos
&& start
!= charpos
)
5739 /* Skip this overlay if it doesn't apply to IT->w. */
5740 window
= Foverlay_get (overlay
, Qwindow
);
5741 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5744 /* If the text ``under'' the overlay is invisible, both before-
5745 and after-strings from this overlay are visible; start and
5746 end position are indistinguishable. */
5747 invisible
= Foverlay_get (overlay
, Qinvisible
);
5748 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5750 /* If overlay has a non-empty before-string, record it. */
5751 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5752 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5754 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5756 /* If overlay has a non-empty after-string, record it. */
5757 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5758 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5760 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5763 /* Process overlays after the overlay center. */
5764 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5766 XSETMISC (overlay
, ov
);
5767 eassert (OVERLAYP (overlay
));
5768 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5769 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5771 if (start
> charpos
)
5774 /* Skip this overlay if it doesn't start or end at IT's current
5776 if (end
!= charpos
&& start
!= charpos
)
5779 /* Skip this overlay if it doesn't apply to IT->w. */
5780 window
= Foverlay_get (overlay
, Qwindow
);
5781 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5784 /* If the text ``under'' the overlay is invisible, it has a zero
5785 dimension, and both before- and after-strings apply. */
5786 invisible
= Foverlay_get (overlay
, Qinvisible
);
5787 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5789 /* If overlay has a non-empty before-string, record it. */
5790 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5791 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5793 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5795 /* If overlay has a non-empty after-string, record it. */
5796 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5797 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5799 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5802 #undef RECORD_OVERLAY_STRING
5806 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5808 /* Record number of overlay strings, and where we computed it. */
5809 it
->n_overlay_strings
= n
;
5810 it
->overlay_strings_charpos
= charpos
;
5812 /* IT->current.overlay_string_index is the number of overlay strings
5813 that have already been consumed by IT. Copy some of the
5814 remaining overlay strings to IT->overlay_strings. */
5816 j
= it
->current
.overlay_string_index
;
5817 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5819 it
->overlay_strings
[i
] = entries
[j
].string
;
5820 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5828 /* Get the first chunk of overlay strings at IT's current buffer
5829 position, or at CHARPOS if that is > 0. Value is non-zero if at
5830 least one overlay string was found. */
5833 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5835 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5836 process. This fills IT->overlay_strings with strings, and sets
5837 IT->n_overlay_strings to the total number of strings to process.
5838 IT->pos.overlay_string_index has to be set temporarily to zero
5839 because load_overlay_strings needs this; it must be set to -1
5840 when no overlay strings are found because a zero value would
5841 indicate a position in the first overlay string. */
5842 it
->current
.overlay_string_index
= 0;
5843 load_overlay_strings (it
, charpos
);
5845 /* If we found overlay strings, set up IT to deliver display
5846 elements from the first one. Otherwise set up IT to deliver
5847 from current_buffer. */
5848 if (it
->n_overlay_strings
)
5850 /* Make sure we know settings in current_buffer, so that we can
5851 restore meaningful values when we're done with the overlay
5854 compute_stop_pos (it
);
5855 eassert (it
->face_id
>= 0);
5857 /* Save IT's settings. They are restored after all overlay
5858 strings have been processed. */
5859 eassert (!compute_stop_p
|| it
->sp
== 0);
5861 /* When called from handle_stop, there might be an empty display
5862 string loaded. In that case, don't bother saving it. But
5863 don't use this optimization with the bidi iterator, since we
5864 need the corresponding pop_it call to resync the bidi
5865 iterator's position with IT's position, after we are done
5866 with the overlay strings. (The corresponding call to pop_it
5867 in case of an empty display string is in
5868 next_overlay_string.) */
5870 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5873 /* Set up IT to deliver display elements from the first overlay
5875 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5876 it
->string
= it
->overlay_strings
[0];
5877 it
->from_overlay
= Qnil
;
5878 it
->stop_charpos
= 0;
5879 eassert (STRINGP (it
->string
));
5880 it
->end_charpos
= SCHARS (it
->string
);
5882 it
->base_level_stop
= 0;
5883 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5884 it
->method
= GET_FROM_STRING
;
5885 it
->from_disp_prop_p
= 0;
5887 /* Force paragraph direction to be that of the parent
5889 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5890 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5892 it
->paragraph_embedding
= L2R
;
5894 /* Set up the bidi iterator for this overlay string. */
5897 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5899 it
->bidi_it
.string
.lstring
= it
->string
;
5900 it
->bidi_it
.string
.s
= NULL
;
5901 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5902 it
->bidi_it
.string
.bufpos
= pos
;
5903 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5904 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5905 it
->bidi_it
.w
= it
->w
;
5906 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5911 it
->current
.overlay_string_index
= -1;
5916 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5919 it
->method
= GET_FROM_BUFFER
;
5921 (void) get_overlay_strings_1 (it
, charpos
, 1);
5925 /* Value is non-zero if we found at least one overlay string. */
5926 return STRINGP (it
->string
);
5931 /***********************************************************************
5932 Saving and restoring state
5933 ***********************************************************************/
5935 /* Save current settings of IT on IT->stack. Called, for example,
5936 before setting up IT for an overlay string, to be able to restore
5937 IT's settings to what they were after the overlay string has been
5938 processed. If POSITION is non-NULL, it is the position to save on
5939 the stack instead of IT->position. */
5942 push_it (struct it
*it
, struct text_pos
*position
)
5944 struct iterator_stack_entry
*p
;
5946 eassert (it
->sp
< IT_STACK_SIZE
);
5947 p
= it
->stack
+ it
->sp
;
5949 p
->stop_charpos
= it
->stop_charpos
;
5950 p
->prev_stop
= it
->prev_stop
;
5951 p
->base_level_stop
= it
->base_level_stop
;
5952 p
->cmp_it
= it
->cmp_it
;
5953 eassert (it
->face_id
>= 0);
5954 p
->face_id
= it
->face_id
;
5955 p
->string
= it
->string
;
5956 p
->method
= it
->method
;
5957 p
->from_overlay
= it
->from_overlay
;
5960 case GET_FROM_IMAGE
:
5961 p
->u
.image
.object
= it
->object
;
5962 p
->u
.image
.image_id
= it
->image_id
;
5963 p
->u
.image
.slice
= it
->slice
;
5965 case GET_FROM_STRETCH
:
5966 p
->u
.stretch
.object
= it
->object
;
5968 #ifdef HAVE_XWIDGETS
5969 case GET_FROM_XWIDGET
:
5970 p
->u
.xwidget
.object
= it
->object
;
5974 p
->position
= position
? *position
: it
->position
;
5975 p
->current
= it
->current
;
5976 p
->end_charpos
= it
->end_charpos
;
5977 p
->string_nchars
= it
->string_nchars
;
5979 p
->multibyte_p
= it
->multibyte_p
;
5980 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5981 p
->space_width
= it
->space_width
;
5982 p
->font_height
= it
->font_height
;
5983 p
->voffset
= it
->voffset
;
5984 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5985 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5986 p
->display_ellipsis_p
= 0;
5987 p
->line_wrap
= it
->line_wrap
;
5988 p
->bidi_p
= it
->bidi_p
;
5989 p
->paragraph_embedding
= it
->paragraph_embedding
;
5990 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5993 /* Save the state of the bidi iterator as well. */
5995 bidi_push_it (&it
->bidi_it
);
5999 iterate_out_of_display_property (struct it
*it
)
6001 int buffer_p
= !STRINGP (it
->string
);
6002 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6003 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6005 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6007 /* Maybe initialize paragraph direction. If we are at the beginning
6008 of a new paragraph, next_element_from_buffer may not have a
6009 chance to do that. */
6010 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6011 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6012 /* prev_stop can be zero, so check against BEGV as well. */
6013 while (it
->bidi_it
.charpos
>= bob
6014 && it
->prev_stop
<= it
->bidi_it
.charpos
6015 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6016 && it
->bidi_it
.charpos
< eob
)
6017 bidi_move_to_visually_next (&it
->bidi_it
);
6018 /* Record the stop_pos we just crossed, for when we cross it
6020 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6021 it
->prev_stop
= CHARPOS (it
->position
);
6022 /* If we ended up not where pop_it put us, resync IT's
6023 positional members with the bidi iterator. */
6024 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6025 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6027 it
->current
.pos
= it
->position
;
6029 it
->current
.string_pos
= it
->position
;
6032 /* Restore IT's settings from IT->stack. Called, for example, when no
6033 more overlay strings must be processed, and we return to delivering
6034 display elements from a buffer, or when the end of a string from a
6035 `display' property is reached and we return to delivering display
6036 elements from an overlay string, or from a buffer. */
6039 pop_it (struct it
*it
)
6041 struct iterator_stack_entry
*p
;
6042 int from_display_prop
= it
->from_disp_prop_p
;
6044 eassert (it
->sp
> 0);
6046 p
= it
->stack
+ it
->sp
;
6047 it
->stop_charpos
= p
->stop_charpos
;
6048 it
->prev_stop
= p
->prev_stop
;
6049 it
->base_level_stop
= p
->base_level_stop
;
6050 it
->cmp_it
= p
->cmp_it
;
6051 it
->face_id
= p
->face_id
;
6052 it
->current
= p
->current
;
6053 it
->position
= p
->position
;
6054 it
->string
= p
->string
;
6055 it
->from_overlay
= p
->from_overlay
;
6056 if (NILP (it
->string
))
6057 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6058 it
->method
= p
->method
;
6061 case GET_FROM_IMAGE
:
6062 it
->image_id
= p
->u
.image
.image_id
;
6063 it
->object
= p
->u
.image
.object
;
6064 it
->slice
= p
->u
.image
.slice
;
6066 #ifdef HAVE_XWIDGETS
6067 case GET_FROM_XWIDGET
:
6068 it
->object
= p
->u
.xwidget
.object
;
6071 case GET_FROM_STRETCH
:
6072 it
->object
= p
->u
.stretch
.object
;
6074 case GET_FROM_BUFFER
:
6075 it
->object
= it
->w
->contents
;
6077 case GET_FROM_STRING
:
6079 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6081 /* Restore the face_box_p flag, since it could have been
6082 overwritten by the face of the object that we just finished
6085 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6086 it
->object
= it
->string
;
6089 case GET_FROM_DISPLAY_VECTOR
:
6091 it
->method
= GET_FROM_C_STRING
;
6092 else if (STRINGP (it
->string
))
6093 it
->method
= GET_FROM_STRING
;
6096 it
->method
= GET_FROM_BUFFER
;
6097 it
->object
= it
->w
->contents
;
6100 it
->end_charpos
= p
->end_charpos
;
6101 it
->string_nchars
= p
->string_nchars
;
6103 it
->multibyte_p
= p
->multibyte_p
;
6104 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6105 it
->space_width
= p
->space_width
;
6106 it
->font_height
= p
->font_height
;
6107 it
->voffset
= p
->voffset
;
6108 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6109 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6110 it
->line_wrap
= p
->line_wrap
;
6111 it
->bidi_p
= p
->bidi_p
;
6112 it
->paragraph_embedding
= p
->paragraph_embedding
;
6113 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6116 bidi_pop_it (&it
->bidi_it
);
6117 /* Bidi-iterate until we get out of the portion of text, if any,
6118 covered by a `display' text property or by an overlay with
6119 `display' property. (We cannot just jump there, because the
6120 internal coherency of the bidi iterator state can not be
6121 preserved across such jumps.) We also must determine the
6122 paragraph base direction if the overlay we just processed is
6123 at the beginning of a new paragraph. */
6124 if (from_display_prop
6125 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6126 iterate_out_of_display_property (it
);
6128 eassert ((BUFFERP (it
->object
)
6129 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6130 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6131 || (STRINGP (it
->object
)
6132 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6133 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6134 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6140 /***********************************************************************
6142 ***********************************************************************/
6144 /* Set IT's current position to the previous line start. */
6147 back_to_previous_line_start (struct it
*it
)
6149 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6152 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6156 /* Move IT to the next line start.
6158 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6159 we skipped over part of the text (as opposed to moving the iterator
6160 continuously over the text). Otherwise, don't change the value
6163 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6164 iterator on the newline, if it was found.
6166 Newlines may come from buffer text, overlay strings, or strings
6167 displayed via the `display' property. That's the reason we can't
6168 simply use find_newline_no_quit.
6170 Note that this function may not skip over invisible text that is so
6171 because of text properties and immediately follows a newline. If
6172 it would, function reseat_at_next_visible_line_start, when called
6173 from set_iterator_to_next, would effectively make invisible
6174 characters following a newline part of the wrong glyph row, which
6175 leads to wrong cursor motion. */
6178 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6179 struct bidi_it
*bidi_it_prev
)
6181 ptrdiff_t old_selective
;
6182 int newline_found_p
, n
;
6183 const int MAX_NEWLINE_DISTANCE
= 500;
6185 /* If already on a newline, just consume it to avoid unintended
6186 skipping over invisible text below. */
6187 if (it
->what
== IT_CHARACTER
6189 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6191 if (it
->bidi_p
&& bidi_it_prev
)
6192 *bidi_it_prev
= it
->bidi_it
;
6193 set_iterator_to_next (it
, 0);
6198 /* Don't handle selective display in the following. It's (a)
6199 unnecessary because it's done by the caller, and (b) leads to an
6200 infinite recursion because next_element_from_ellipsis indirectly
6201 calls this function. */
6202 old_selective
= it
->selective
;
6205 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6206 from buffer text. */
6207 for (n
= newline_found_p
= 0;
6208 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6209 n
+= STRINGP (it
->string
) ? 0 : 1)
6211 if (!get_next_display_element (it
))
6213 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6214 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6215 *bidi_it_prev
= it
->bidi_it
;
6216 set_iterator_to_next (it
, 0);
6219 /* If we didn't find a newline near enough, see if we can use a
6221 if (!newline_found_p
)
6223 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6224 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6228 eassert (!STRINGP (it
->string
));
6230 /* If there isn't any `display' property in sight, and no
6231 overlays, we can just use the position of the newline in
6233 if (it
->stop_charpos
>= limit
6234 || ((pos
= Fnext_single_property_change (make_number (start
),
6236 make_number (limit
)),
6238 && next_overlay_change (start
) == ZV
))
6242 IT_CHARPOS (*it
) = limit
;
6243 IT_BYTEPOS (*it
) = bytepos
;
6247 struct bidi_it bprev
;
6249 /* Help bidi.c avoid expensive searches for display
6250 properties and overlays, by telling it that there are
6251 none up to `limit'. */
6252 if (it
->bidi_it
.disp_pos
< limit
)
6254 it
->bidi_it
.disp_pos
= limit
;
6255 it
->bidi_it
.disp_prop
= 0;
6258 bprev
= it
->bidi_it
;
6259 bidi_move_to_visually_next (&it
->bidi_it
);
6260 } while (it
->bidi_it
.charpos
!= limit
);
6261 IT_CHARPOS (*it
) = limit
;
6262 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6264 *bidi_it_prev
= bprev
;
6266 *skipped_p
= newline_found_p
= true;
6270 while (get_next_display_element (it
)
6271 && !newline_found_p
)
6273 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6274 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6275 *bidi_it_prev
= it
->bidi_it
;
6276 set_iterator_to_next (it
, 0);
6281 it
->selective
= old_selective
;
6282 return newline_found_p
;
6286 /* Set IT's current position to the previous visible line start. Skip
6287 invisible text that is so either due to text properties or due to
6288 selective display. Caution: this does not change IT->current_x and
6292 back_to_previous_visible_line_start (struct it
*it
)
6294 while (IT_CHARPOS (*it
) > BEGV
)
6296 back_to_previous_line_start (it
);
6298 if (IT_CHARPOS (*it
) <= BEGV
)
6301 /* If selective > 0, then lines indented more than its value are
6303 if (it
->selective
> 0
6304 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6308 /* Check the newline before point for invisibility. */
6311 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6312 Qinvisible
, it
->window
);
6313 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6317 if (IT_CHARPOS (*it
) <= BEGV
)
6322 void *it2data
= NULL
;
6325 Lisp_Object val
, overlay
;
6327 SAVE_IT (it2
, *it
, it2data
);
6329 /* If newline is part of a composition, continue from start of composition */
6330 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6331 && beg
< IT_CHARPOS (*it
))
6334 /* If newline is replaced by a display property, find start of overlay
6335 or interval and continue search from that point. */
6336 pos
= --IT_CHARPOS (it2
);
6339 bidi_unshelve_cache (NULL
, 0);
6340 it2
.string_from_display_prop_p
= 0;
6341 it2
.from_disp_prop_p
= 0;
6342 if (handle_display_prop (&it2
) == HANDLED_RETURN
6343 && !NILP (val
= get_char_property_and_overlay
6344 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6345 && (OVERLAYP (overlay
)
6346 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6347 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6349 RESTORE_IT (it
, it
, it2data
);
6353 /* Newline is not replaced by anything -- so we are done. */
6354 RESTORE_IT (it
, it
, it2data
);
6360 IT_CHARPOS (*it
) = beg
;
6361 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6365 it
->continuation_lines_width
= 0;
6367 eassert (IT_CHARPOS (*it
) >= BEGV
);
6368 eassert (IT_CHARPOS (*it
) == BEGV
6369 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6374 /* Reseat iterator IT at the previous visible line start. Skip
6375 invisible text that is so either due to text properties or due to
6376 selective display. At the end, update IT's overlay information,
6377 face information etc. */
6380 reseat_at_previous_visible_line_start (struct it
*it
)
6382 back_to_previous_visible_line_start (it
);
6383 reseat (it
, it
->current
.pos
, 1);
6388 /* Reseat iterator IT on the next visible line start in the current
6389 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6390 preceding the line start. Skip over invisible text that is so
6391 because of selective display. Compute faces, overlays etc at the
6392 new position. Note that this function does not skip over text that
6393 is invisible because of text properties. */
6396 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6398 int newline_found_p
, skipped_p
= 0;
6399 struct bidi_it bidi_it_prev
;
6401 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6403 /* Skip over lines that are invisible because they are indented
6404 more than the value of IT->selective. */
6405 if (it
->selective
> 0)
6406 while (IT_CHARPOS (*it
) < ZV
6407 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6410 eassert (IT_BYTEPOS (*it
) == BEGV
6411 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6413 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6416 /* Position on the newline if that's what's requested. */
6417 if (on_newline_p
&& newline_found_p
)
6419 if (STRINGP (it
->string
))
6421 if (IT_STRING_CHARPOS (*it
) > 0)
6425 --IT_STRING_CHARPOS (*it
);
6426 --IT_STRING_BYTEPOS (*it
);
6430 /* We need to restore the bidi iterator to the state
6431 it had on the newline, and resync the IT's
6432 position with that. */
6433 it
->bidi_it
= bidi_it_prev
;
6434 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6435 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6439 else if (IT_CHARPOS (*it
) > BEGV
)
6448 /* We need to restore the bidi iterator to the state it
6449 had on the newline and resync IT with that. */
6450 it
->bidi_it
= bidi_it_prev
;
6451 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6452 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6454 reseat (it
, it
->current
.pos
, 0);
6458 reseat (it
, it
->current
.pos
, 0);
6465 /***********************************************************************
6466 Changing an iterator's position
6467 ***********************************************************************/
6469 /* Change IT's current position to POS in current_buffer. If FORCE_P
6470 is non-zero, always check for text properties at the new position.
6471 Otherwise, text properties are only looked up if POS >=
6472 IT->check_charpos of a property. */
6475 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6477 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6479 reseat_1 (it
, pos
, 0);
6481 /* Determine where to check text properties. Avoid doing it
6482 where possible because text property lookup is very expensive. */
6484 || CHARPOS (pos
) > it
->stop_charpos
6485 || CHARPOS (pos
) < original_pos
)
6489 /* For bidi iteration, we need to prime prev_stop and
6490 base_level_stop with our best estimations. */
6491 /* Implementation note: Of course, POS is not necessarily a
6492 stop position, so assigning prev_pos to it is a lie; we
6493 should have called compute_stop_backwards. However, if
6494 the current buffer does not include any R2L characters,
6495 that call would be a waste of cycles, because the
6496 iterator will never move back, and thus never cross this
6497 "fake" stop position. So we delay that backward search
6498 until the time we really need it, in next_element_from_buffer. */
6499 if (CHARPOS (pos
) != it
->prev_stop
)
6500 it
->prev_stop
= CHARPOS (pos
);
6501 if (CHARPOS (pos
) < it
->base_level_stop
)
6502 it
->base_level_stop
= 0; /* meaning it's unknown */
6508 it
->prev_stop
= it
->base_level_stop
= 0;
6517 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6518 IT->stop_pos to POS, also. */
6521 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6523 /* Don't call this function when scanning a C string. */
6524 eassert (it
->s
== NULL
);
6526 /* POS must be a reasonable value. */
6527 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6529 it
->current
.pos
= it
->position
= pos
;
6530 it
->end_charpos
= ZV
;
6532 it
->current
.dpvec_index
= -1;
6533 it
->current
.overlay_string_index
= -1;
6534 IT_STRING_CHARPOS (*it
) = -1;
6535 IT_STRING_BYTEPOS (*it
) = -1;
6537 it
->method
= GET_FROM_BUFFER
;
6538 it
->object
= it
->w
->contents
;
6539 it
->area
= TEXT_AREA
;
6540 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6542 it
->string_from_display_prop_p
= 0;
6543 it
->string_from_prefix_prop_p
= 0;
6545 it
->from_disp_prop_p
= 0;
6546 it
->face_before_selective_p
= 0;
6549 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6551 bidi_unshelve_cache (NULL
, 0);
6552 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6553 it
->bidi_it
.string
.s
= NULL
;
6554 it
->bidi_it
.string
.lstring
= Qnil
;
6555 it
->bidi_it
.string
.bufpos
= 0;
6556 it
->bidi_it
.string
.from_disp_str
= 0;
6557 it
->bidi_it
.string
.unibyte
= 0;
6558 it
->bidi_it
.w
= it
->w
;
6563 it
->stop_charpos
= CHARPOS (pos
);
6564 it
->base_level_stop
= CHARPOS (pos
);
6566 /* This make the information stored in it->cmp_it invalidate. */
6571 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6572 If S is non-null, it is a C string to iterate over. Otherwise,
6573 STRING gives a Lisp string to iterate over.
6575 If PRECISION > 0, don't return more then PRECISION number of
6576 characters from the string.
6578 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6579 characters have been returned. FIELD_WIDTH < 0 means an infinite
6582 MULTIBYTE = 0 means disable processing of multibyte characters,
6583 MULTIBYTE > 0 means enable it,
6584 MULTIBYTE < 0 means use IT->multibyte_p.
6586 IT must be initialized via a prior call to init_iterator before
6587 calling this function. */
6590 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6591 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6594 /* No text property checks performed by default, but see below. */
6595 it
->stop_charpos
= -1;
6597 /* Set iterator position and end position. */
6598 memset (&it
->current
, 0, sizeof it
->current
);
6599 it
->current
.overlay_string_index
= -1;
6600 it
->current
.dpvec_index
= -1;
6601 eassert (charpos
>= 0);
6603 /* If STRING is specified, use its multibyteness, otherwise use the
6604 setting of MULTIBYTE, if specified. */
6606 it
->multibyte_p
= multibyte
> 0;
6608 /* Bidirectional reordering of strings is controlled by the default
6609 value of bidi-display-reordering. Don't try to reorder while
6610 loading loadup.el, as the necessary character property tables are
6611 not yet available. */
6614 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6618 eassert (STRINGP (string
));
6619 it
->string
= string
;
6621 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6622 it
->method
= GET_FROM_STRING
;
6623 it
->current
.string_pos
= string_pos (charpos
, string
);
6627 it
->bidi_it
.string
.lstring
= string
;
6628 it
->bidi_it
.string
.s
= NULL
;
6629 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6630 it
->bidi_it
.string
.bufpos
= 0;
6631 it
->bidi_it
.string
.from_disp_str
= 0;
6632 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6633 it
->bidi_it
.w
= it
->w
;
6634 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6635 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6640 it
->s
= (const unsigned char *) s
;
6643 /* Note that we use IT->current.pos, not it->current.string_pos,
6644 for displaying C strings. */
6645 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6646 if (it
->multibyte_p
)
6648 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6649 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6653 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6654 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6659 it
->bidi_it
.string
.lstring
= Qnil
;
6660 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6661 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6662 it
->bidi_it
.string
.bufpos
= 0;
6663 it
->bidi_it
.string
.from_disp_str
= 0;
6664 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6665 it
->bidi_it
.w
= it
->w
;
6666 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6669 it
->method
= GET_FROM_C_STRING
;
6672 /* PRECISION > 0 means don't return more than PRECISION characters
6674 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6676 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6678 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6681 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6682 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6683 FIELD_WIDTH < 0 means infinite field width. This is useful for
6684 padding with `-' at the end of a mode line. */
6685 if (field_width
< 0)
6686 field_width
= INFINITY
;
6687 /* Implementation note: We deliberately don't enlarge
6688 it->bidi_it.string.schars here to fit it->end_charpos, because
6689 the bidi iterator cannot produce characters out of thin air. */
6690 if (field_width
> it
->end_charpos
- charpos
)
6691 it
->end_charpos
= charpos
+ field_width
;
6693 /* Use the standard display table for displaying strings. */
6694 if (DISP_TABLE_P (Vstandard_display_table
))
6695 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6697 it
->stop_charpos
= charpos
;
6698 it
->prev_stop
= charpos
;
6699 it
->base_level_stop
= 0;
6702 it
->bidi_it
.first_elt
= 1;
6703 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6704 it
->bidi_it
.disp_pos
= -1;
6706 if (s
== NULL
&& it
->multibyte_p
)
6708 ptrdiff_t endpos
= SCHARS (it
->string
);
6709 if (endpos
> it
->end_charpos
)
6710 endpos
= it
->end_charpos
;
6711 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6719 /***********************************************************************
6721 ***********************************************************************/
6723 /* Map enum it_method value to corresponding next_element_from_* function. */
6725 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6727 next_element_from_buffer
,
6728 next_element_from_display_vector
,
6729 next_element_from_string
,
6730 next_element_from_c_string
,
6731 next_element_from_image
,
6732 next_element_from_stretch
6733 #ifdef HAVE_XWIDGETS
6734 ,next_element_from_xwidget
6738 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6741 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6742 (possibly with the following characters). */
6744 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6745 ((IT)->cmp_it.id >= 0 \
6746 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6747 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6748 END_CHARPOS, (IT)->w, \
6749 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6753 /* Lookup the char-table Vglyphless_char_display for character C (-1
6754 if we want information for no-font case), and return the display
6755 method symbol. By side-effect, update it->what and
6756 it->glyphless_method. This function is called from
6757 get_next_display_element for each character element, and from
6758 x_produce_glyphs when no suitable font was found. */
6761 lookup_glyphless_char_display (int c
, struct it
*it
)
6763 Lisp_Object glyphless_method
= Qnil
;
6765 if (CHAR_TABLE_P (Vglyphless_char_display
)
6766 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6770 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6771 if (CONSP (glyphless_method
))
6772 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6773 ? XCAR (glyphless_method
)
6774 : XCDR (glyphless_method
);
6777 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6781 if (NILP (glyphless_method
))
6784 /* The default is to display the character by a proper font. */
6786 /* The default for the no-font case is to display an empty box. */
6787 glyphless_method
= Qempty_box
;
6789 if (EQ (glyphless_method
, Qzero_width
))
6792 return glyphless_method
;
6793 /* This method can't be used for the no-font case. */
6794 glyphless_method
= Qempty_box
;
6796 if (EQ (glyphless_method
, Qthin_space
))
6797 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6798 else if (EQ (glyphless_method
, Qempty_box
))
6799 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6800 else if (EQ (glyphless_method
, Qhex_code
))
6801 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6802 else if (STRINGP (glyphless_method
))
6803 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6806 /* Invalid value. We use the default method. */
6807 glyphless_method
= Qnil
;
6810 it
->what
= IT_GLYPHLESS
;
6811 return glyphless_method
;
6814 /* Merge escape glyph face and cache the result. */
6816 static struct frame
*last_escape_glyph_frame
= NULL
;
6817 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6818 static int last_escape_glyph_merged_face_id
= 0;
6821 merge_escape_glyph_face (struct it
*it
)
6825 if (it
->f
== last_escape_glyph_frame
6826 && it
->face_id
== last_escape_glyph_face_id
)
6827 face_id
= last_escape_glyph_merged_face_id
;
6830 /* Merge the `escape-glyph' face into the current face. */
6831 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6832 last_escape_glyph_frame
= it
->f
;
6833 last_escape_glyph_face_id
= it
->face_id
;
6834 last_escape_glyph_merged_face_id
= face_id
;
6839 /* Likewise for glyphless glyph face. */
6841 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6842 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6843 static int last_glyphless_glyph_merged_face_id
= 0;
6846 merge_glyphless_glyph_face (struct it
*it
)
6850 if (it
->f
== last_glyphless_glyph_frame
6851 && it
->face_id
== last_glyphless_glyph_face_id
)
6852 face_id
= last_glyphless_glyph_merged_face_id
;
6855 /* Merge the `glyphless-char' face into the current face. */
6856 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6857 last_glyphless_glyph_frame
= it
->f
;
6858 last_glyphless_glyph_face_id
= it
->face_id
;
6859 last_glyphless_glyph_merged_face_id
= face_id
;
6864 /* Load IT's display element fields with information about the next
6865 display element from the current position of IT. Value is zero if
6866 end of buffer (or C string) is reached. */
6869 get_next_display_element (struct it
*it
)
6871 /* Non-zero means that we found a display element. Zero means that
6872 we hit the end of what we iterate over. Performance note: the
6873 function pointer `method' used here turns out to be faster than
6874 using a sequence of if-statements. */
6878 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6880 if (it
->what
== IT_CHARACTER
)
6882 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6883 and only if (a) the resolved directionality of that character
6885 /* FIXME: Do we need an exception for characters from display
6887 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6888 && !inhibit_bidi_mirroring
)
6889 it
->c
= bidi_mirror_char (it
->c
);
6890 /* Map via display table or translate control characters.
6891 IT->c, IT->len etc. have been set to the next character by
6892 the function call above. If we have a display table, and it
6893 contains an entry for IT->c, translate it. Don't do this if
6894 IT->c itself comes from a display table, otherwise we could
6895 end up in an infinite recursion. (An alternative could be to
6896 count the recursion depth of this function and signal an
6897 error when a certain maximum depth is reached.) Is it worth
6899 if (success_p
&& it
->dpvec
== NULL
)
6902 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6903 int nonascii_space_p
= 0;
6904 int nonascii_hyphen_p
= 0;
6905 int c
= it
->c
; /* This is the character to display. */
6907 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6909 eassert (SINGLE_BYTE_CHAR_P (c
));
6910 if (unibyte_display_via_language_environment
)
6912 c
= DECODE_CHAR (unibyte
, c
);
6914 c
= BYTE8_TO_CHAR (it
->c
);
6917 c
= BYTE8_TO_CHAR (it
->c
);
6921 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6924 struct Lisp_Vector
*v
= XVECTOR (dv
);
6926 /* Return the first character from the display table
6927 entry, if not empty. If empty, don't display the
6928 current character. */
6931 it
->dpvec_char_len
= it
->len
;
6932 it
->dpvec
= v
->contents
;
6933 it
->dpend
= v
->contents
+ v
->header
.size
;
6934 it
->current
.dpvec_index
= 0;
6935 it
->dpvec_face_id
= -1;
6936 it
->saved_face_id
= it
->face_id
;
6937 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6942 set_iterator_to_next (it
, 0);
6947 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6949 if (it
->what
== IT_GLYPHLESS
)
6951 /* Don't display this character. */
6952 set_iterator_to_next (it
, 0);
6956 /* If `nobreak-char-display' is non-nil, we display
6957 non-ASCII spaces and hyphens specially. */
6958 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6961 nonascii_space_p
= true;
6962 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6963 nonascii_hyphen_p
= true;
6966 /* Translate control characters into `\003' or `^C' form.
6967 Control characters coming from a display table entry are
6968 currently not translated because we use IT->dpvec to hold
6969 the translation. This could easily be changed but I
6970 don't believe that it is worth doing.
6972 The characters handled by `nobreak-char-display' must be
6975 Non-printable characters and raw-byte characters are also
6976 translated to octal form. */
6977 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6978 ? (it
->area
!= TEXT_AREA
6979 /* In mode line, treat \n, \t like other crl chars. */
6982 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6983 || (c
!= '\n' && c
!= '\t'))
6985 || nonascii_hyphen_p
6987 || ! CHAR_PRINTABLE_P (c
))))
6989 /* C is a control character, non-ASCII space/hyphen,
6990 raw-byte, or a non-printable character which must be
6991 displayed either as '\003' or as `^C' where the '\\'
6992 and '^' can be defined in the display table. Fill
6993 IT->ctl_chars with glyphs for what we have to
6994 display. Then, set IT->dpvec to these glyphs. */
7001 /* Handle control characters with ^. */
7003 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7007 g
= '^'; /* default glyph for Control */
7008 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7010 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7012 g
= GLYPH_CODE_CHAR (gc
);
7013 lface_id
= GLYPH_CODE_FACE (gc
);
7017 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7018 : merge_escape_glyph_face (it
));
7020 XSETINT (it
->ctl_chars
[0], g
);
7021 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7023 goto display_control
;
7026 /* Handle non-ascii space in the mode where it only gets
7029 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7031 /* Merge `nobreak-space' into the current face. */
7032 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7034 XSETINT (it
->ctl_chars
[0], ' ');
7036 goto display_control
;
7039 /* Handle sequences that start with the "escape glyph". */
7041 /* the default escape glyph is \. */
7042 escape_glyph
= '\\';
7045 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7047 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7048 lface_id
= GLYPH_CODE_FACE (gc
);
7052 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7053 : merge_escape_glyph_face (it
));
7055 /* Draw non-ASCII hyphen with just highlighting: */
7057 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7059 XSETINT (it
->ctl_chars
[0], '-');
7061 goto display_control
;
7064 /* Draw non-ASCII space/hyphen with escape glyph: */
7066 if (nonascii_space_p
|| nonascii_hyphen_p
)
7068 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7069 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7071 goto display_control
;
7078 if (CHAR_BYTE8_P (c
))
7079 /* Display \200 instead of \17777600. */
7080 c
= CHAR_TO_BYTE8 (c
);
7081 len
= sprintf (str
, "%03o", c
);
7083 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7084 for (i
= 0; i
< len
; i
++)
7085 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7090 /* Set up IT->dpvec and return first character from it. */
7091 it
->dpvec_char_len
= it
->len
;
7092 it
->dpvec
= it
->ctl_chars
;
7093 it
->dpend
= it
->dpvec
+ ctl_len
;
7094 it
->current
.dpvec_index
= 0;
7095 it
->dpvec_face_id
= face_id
;
7096 it
->saved_face_id
= it
->face_id
;
7097 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7101 it
->char_to_display
= c
;
7105 it
->char_to_display
= it
->c
;
7109 #ifdef HAVE_WINDOW_SYSTEM
7110 /* Adjust face id for a multibyte character. There are no multibyte
7111 character in unibyte text. */
7112 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7115 && FRAME_WINDOW_P (it
->f
))
7117 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7119 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7121 /* Automatic composition with glyph-string. */
7122 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7124 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7128 ptrdiff_t pos
= (it
->s
? -1
7129 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7130 : IT_CHARPOS (*it
));
7133 if (it
->what
== IT_CHARACTER
)
7134 c
= it
->char_to_display
;
7137 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7141 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7142 /* TAB in a composition means display glyphs with
7143 padding space on the left or right. */
7144 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7147 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7150 #endif /* HAVE_WINDOW_SYSTEM */
7153 /* Is this character the last one of a run of characters with
7154 box? If yes, set IT->end_of_box_run_p to 1. */
7158 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7160 int face_id
= underlying_face_id (it
);
7161 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7165 if (face
->box
== FACE_NO_BOX
)
7167 /* If the box comes from face properties in a
7168 display string, check faces in that string. */
7169 int string_face_id
= face_after_it_pos (it
);
7170 it
->end_of_box_run_p
7171 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7174 /* Otherwise, the box comes from the underlying face.
7175 If this is the last string character displayed, check
7176 the next buffer location. */
7177 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7178 /* n_overlay_strings is unreliable unless
7179 overlay_string_index is non-negative. */
7180 && ((it
->current
.overlay_string_index
>= 0
7181 && (it
->current
.overlay_string_index
7182 == it
->n_overlay_strings
- 1))
7183 /* A string from display property. */
7184 || it
->from_disp_prop_p
))
7188 struct text_pos pos
= it
->current
.pos
;
7190 /* For a string from a display property, the next
7191 buffer position is stored in the 'position'
7192 member of the iteration stack slot below the
7193 current one, see handle_single_display_spec. By
7194 contrast, it->current.pos was is not yet updated
7195 to point to that buffer position; that will
7196 happen in pop_it, after we finish displaying the
7197 current string. Note that we already checked
7198 above that it->sp is positive, so subtracting one
7200 if (it
->from_disp_prop_p
)
7201 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7203 INC_TEXT_POS (pos
, it
->multibyte_p
);
7205 if (CHARPOS (pos
) >= ZV
)
7206 it
->end_of_box_run_p
= true;
7209 next_face_id
= face_at_buffer_position
7210 (it
->w
, CHARPOS (pos
), &ignore
,
7211 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7212 it
->end_of_box_run_p
7213 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7219 /* next_element_from_display_vector sets this flag according to
7220 faces of the display vector glyphs, see there. */
7221 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7223 int face_id
= face_after_it_pos (it
);
7224 it
->end_of_box_run_p
7225 = (face_id
!= it
->face_id
7226 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7229 /* If we reached the end of the object we've been iterating (e.g., a
7230 display string or an overlay string), and there's something on
7231 IT->stack, proceed with what's on the stack. It doesn't make
7232 sense to return zero if there's unprocessed stuff on the stack,
7233 because otherwise that stuff will never be displayed. */
7234 if (!success_p
&& it
->sp
> 0)
7236 set_iterator_to_next (it
, 0);
7237 success_p
= get_next_display_element (it
);
7240 /* Value is 0 if end of buffer or string reached. */
7245 /* Move IT to the next display element.
7247 RESEAT_P non-zero means if called on a newline in buffer text,
7248 skip to the next visible line start.
7250 Functions get_next_display_element and set_iterator_to_next are
7251 separate because I find this arrangement easier to handle than a
7252 get_next_display_element function that also increments IT's
7253 position. The way it is we can first look at an iterator's current
7254 display element, decide whether it fits on a line, and if it does,
7255 increment the iterator position. The other way around we probably
7256 would either need a flag indicating whether the iterator has to be
7257 incremented the next time, or we would have to implement a
7258 decrement position function which would not be easy to write. */
7261 set_iterator_to_next (struct it
*it
, int reseat_p
)
7263 /* Reset flags indicating start and end of a sequence of characters
7264 with box. Reset them at the start of this function because
7265 moving the iterator to a new position might set them. */
7266 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7270 case GET_FROM_BUFFER
:
7271 /* The current display element of IT is a character from
7272 current_buffer. Advance in the buffer, and maybe skip over
7273 invisible lines that are so because of selective display. */
7274 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7275 reseat_at_next_visible_line_start (it
, 0);
7276 else if (it
->cmp_it
.id
>= 0)
7278 /* We are currently getting glyphs from a composition. */
7281 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7282 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7288 /* Update IT's char/byte positions to point to the first
7289 character of the next grapheme cluster, or to the
7290 character visually after the current composition. */
7291 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7292 bidi_move_to_visually_next (&it
->bidi_it
);
7293 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7294 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7297 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7298 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7300 /* Composition created while scanning forward. Proceed
7301 to the next grapheme cluster. */
7302 it
->cmp_it
.from
= it
->cmp_it
.to
;
7304 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7305 && it
->cmp_it
.from
> 0)
7307 /* Composition created while scanning backward. Proceed
7308 to the previous grapheme cluster. */
7309 it
->cmp_it
.to
= it
->cmp_it
.from
;
7313 /* No more grapheme clusters in this composition.
7314 Find the next stop position. */
7315 ptrdiff_t stop
= it
->end_charpos
;
7317 if (it
->bidi_it
.scan_dir
< 0)
7318 /* Now we are scanning backward and don't know
7321 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7322 IT_BYTEPOS (*it
), stop
, Qnil
);
7327 eassert (it
->len
!= 0);
7331 IT_BYTEPOS (*it
) += it
->len
;
7332 IT_CHARPOS (*it
) += 1;
7336 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7337 /* If this is a new paragraph, determine its base
7338 direction (a.k.a. its base embedding level). */
7339 if (it
->bidi_it
.new_paragraph
)
7340 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7341 bidi_move_to_visually_next (&it
->bidi_it
);
7342 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7343 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7344 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7346 /* As the scan direction was changed, we must
7347 re-compute the stop position for composition. */
7348 ptrdiff_t stop
= it
->end_charpos
;
7349 if (it
->bidi_it
.scan_dir
< 0)
7351 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7352 IT_BYTEPOS (*it
), stop
, Qnil
);
7355 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7359 case GET_FROM_C_STRING
:
7360 /* Current display element of IT is from a C string. */
7362 /* If the string position is beyond string's end, it means
7363 next_element_from_c_string is padding the string with
7364 blanks, in which case we bypass the bidi iterator,
7365 because it cannot deal with such virtual characters. */
7366 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7368 IT_BYTEPOS (*it
) += it
->len
;
7369 IT_CHARPOS (*it
) += 1;
7373 bidi_move_to_visually_next (&it
->bidi_it
);
7374 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7375 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7379 case GET_FROM_DISPLAY_VECTOR
:
7380 /* Current display element of IT is from a display table entry.
7381 Advance in the display table definition. Reset it to null if
7382 end reached, and continue with characters from buffers/
7384 ++it
->current
.dpvec_index
;
7386 /* Restore face of the iterator to what they were before the
7387 display vector entry (these entries may contain faces). */
7388 it
->face_id
= it
->saved_face_id
;
7390 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7392 int recheck_faces
= it
->ellipsis_p
;
7395 it
->method
= GET_FROM_C_STRING
;
7396 else if (STRINGP (it
->string
))
7397 it
->method
= GET_FROM_STRING
;
7400 it
->method
= GET_FROM_BUFFER
;
7401 it
->object
= it
->w
->contents
;
7405 it
->current
.dpvec_index
= -1;
7407 /* Skip over characters which were displayed via IT->dpvec. */
7408 if (it
->dpvec_char_len
< 0)
7409 reseat_at_next_visible_line_start (it
, 1);
7410 else if (it
->dpvec_char_len
> 0)
7412 if (it
->method
== GET_FROM_STRING
7413 && it
->current
.overlay_string_index
>= 0
7414 && it
->n_overlay_strings
> 0)
7415 it
->ignore_overlay_strings_at_pos_p
= true;
7416 it
->len
= it
->dpvec_char_len
;
7417 set_iterator_to_next (it
, reseat_p
);
7420 /* Maybe recheck faces after display vector. */
7422 it
->stop_charpos
= IT_CHARPOS (*it
);
7426 case GET_FROM_STRING
:
7427 /* Current display element is a character from a Lisp string. */
7428 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7429 /* Don't advance past string end. These conditions are true
7430 when set_iterator_to_next is called at the end of
7431 get_next_display_element, in which case the Lisp string is
7432 already exhausted, and all we want is pop the iterator
7434 if (it
->current
.overlay_string_index
>= 0)
7436 /* This is an overlay string, so there's no padding with
7437 spaces, and the number of characters in the string is
7438 where the string ends. */
7439 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7440 goto consider_string_end
;
7444 /* Not an overlay string. There could be padding, so test
7445 against it->end_charpos. */
7446 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7447 goto consider_string_end
;
7449 if (it
->cmp_it
.id
>= 0)
7451 /* We are delivering display elements from a composition.
7452 Update the string position past the grapheme cluster
7453 we've just processed. */
7456 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7457 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7463 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7464 bidi_move_to_visually_next (&it
->bidi_it
);
7465 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7466 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7469 /* Did we exhaust all the grapheme clusters of this
7471 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7472 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7474 /* Not all the grapheme clusters were processed yet;
7475 advance to the next cluster. */
7476 it
->cmp_it
.from
= it
->cmp_it
.to
;
7478 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7479 && it
->cmp_it
.from
> 0)
7481 /* Likewise: advance to the next cluster, but going in
7482 the reverse direction. */
7483 it
->cmp_it
.to
= it
->cmp_it
.from
;
7487 /* This composition was fully processed; find the next
7488 candidate place for checking for composed
7490 /* Always limit string searches to the string length;
7491 any padding spaces are not part of the string, and
7492 there cannot be any compositions in that padding. */
7493 ptrdiff_t stop
= SCHARS (it
->string
);
7495 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7497 else if (it
->end_charpos
< stop
)
7499 /* Cf. PRECISION in reseat_to_string: we might be
7500 limited in how many of the string characters we
7502 stop
= it
->end_charpos
;
7504 composition_compute_stop_pos (&it
->cmp_it
,
7505 IT_STRING_CHARPOS (*it
),
7506 IT_STRING_BYTEPOS (*it
), stop
,
7513 /* If the string position is beyond string's end, it
7514 means next_element_from_string is padding the string
7515 with blanks, in which case we bypass the bidi
7516 iterator, because it cannot deal with such virtual
7518 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7520 IT_STRING_BYTEPOS (*it
) += it
->len
;
7521 IT_STRING_CHARPOS (*it
) += 1;
7525 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7527 bidi_move_to_visually_next (&it
->bidi_it
);
7528 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7529 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7530 /* If the scan direction changes, we may need to update
7531 the place where to check for composed characters. */
7532 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7534 ptrdiff_t stop
= SCHARS (it
->string
);
7536 if (it
->bidi_it
.scan_dir
< 0)
7538 else if (it
->end_charpos
< stop
)
7539 stop
= it
->end_charpos
;
7541 composition_compute_stop_pos (&it
->cmp_it
,
7542 IT_STRING_CHARPOS (*it
),
7543 IT_STRING_BYTEPOS (*it
), stop
,
7549 consider_string_end
:
7551 if (it
->current
.overlay_string_index
>= 0)
7553 /* IT->string is an overlay string. Advance to the
7554 next, if there is one. */
7555 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7558 next_overlay_string (it
);
7560 setup_for_ellipsis (it
, 0);
7565 /* IT->string is not an overlay string. If we reached
7566 its end, and there is something on IT->stack, proceed
7567 with what is on the stack. This can be either another
7568 string, this time an overlay string, or a buffer. */
7569 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7573 if (it
->method
== GET_FROM_STRING
)
7574 goto consider_string_end
;
7579 case GET_FROM_IMAGE
:
7580 case GET_FROM_STRETCH
:
7581 #ifdef HAVE_XWIDGETS
7582 case GET_FROM_XWIDGET
:
7585 /* The position etc with which we have to proceed are on
7586 the stack. The position may be at the end of a string,
7587 if the `display' property takes up the whole string. */
7588 eassert (it
->sp
> 0);
7590 if (it
->method
== GET_FROM_STRING
)
7591 goto consider_string_end
;
7595 /* There are no other methods defined, so this should be a bug. */
7599 eassert (it
->method
!= GET_FROM_STRING
7600 || (STRINGP (it
->string
)
7601 && IT_STRING_CHARPOS (*it
) >= 0));
7604 /* Load IT's display element fields with information about the next
7605 display element which comes from a display table entry or from the
7606 result of translating a control character to one of the forms `^C'
7609 IT->dpvec holds the glyphs to return as characters.
7610 IT->saved_face_id holds the face id before the display vector--it
7611 is restored into IT->face_id in set_iterator_to_next. */
7614 next_element_from_display_vector (struct it
*it
)
7617 int prev_face_id
= it
->face_id
;
7621 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7623 it
->face_id
= it
->saved_face_id
;
7625 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7626 That seemed totally bogus - so I changed it... */
7627 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7629 if (GLYPH_CODE_P (gc
))
7631 struct face
*this_face
, *prev_face
, *next_face
;
7633 it
->c
= GLYPH_CODE_CHAR (gc
);
7634 it
->len
= CHAR_BYTES (it
->c
);
7636 /* The entry may contain a face id to use. Such a face id is
7637 the id of a Lisp face, not a realized face. A face id of
7638 zero means no face is specified. */
7639 if (it
->dpvec_face_id
>= 0)
7640 it
->face_id
= it
->dpvec_face_id
;
7643 int lface_id
= GLYPH_CODE_FACE (gc
);
7645 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7649 /* Glyphs in the display vector could have the box face, so we
7650 need to set the related flags in the iterator, as
7652 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7653 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7655 /* Is this character the first character of a box-face run? */
7656 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7658 || prev_face
->box
== FACE_NO_BOX
));
7660 /* For the last character of the box-face run, we need to look
7661 either at the next glyph from the display vector, or at the
7662 face we saw before the display vector. */
7663 next_face_id
= it
->saved_face_id
;
7664 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7666 if (it
->dpvec_face_id
>= 0)
7667 next_face_id
= it
->dpvec_face_id
;
7671 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7674 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7678 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7679 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7681 || next_face
->box
== FACE_NO_BOX
));
7682 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7685 /* Display table entry is invalid. Return a space. */
7686 it
->c
= ' ', it
->len
= 1;
7688 /* Don't change position and object of the iterator here. They are
7689 still the values of the character that had this display table
7690 entry or was translated, and that's what we want. */
7691 it
->what
= IT_CHARACTER
;
7695 /* Get the first element of string/buffer in the visual order, after
7696 being reseated to a new position in a string or a buffer. */
7698 get_visually_first_element (struct it
*it
)
7700 int string_p
= STRINGP (it
->string
) || it
->s
;
7701 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7702 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7704 if (STRINGP (it
->string
))
7706 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7707 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7711 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7712 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7715 if (it
->bidi_it
.charpos
== eob
)
7717 /* Nothing to do, but reset the FIRST_ELT flag, like
7718 bidi_paragraph_init does, because we are not going to
7720 it
->bidi_it
.first_elt
= 0;
7722 else if (it
->bidi_it
.charpos
== bob
7724 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7725 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7727 /* If we are at the beginning of a line/string, we can produce
7728 the next element right away. */
7729 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7730 bidi_move_to_visually_next (&it
->bidi_it
);
7734 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7736 /* We need to prime the bidi iterator starting at the line's or
7737 string's beginning, before we will be able to produce the
7740 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7742 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7743 IT_BYTEPOS (*it
), -1,
7744 &it
->bidi_it
.bytepos
);
7745 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7748 /* Now return to buffer/string position where we were asked
7749 to get the next display element, and produce that. */
7750 bidi_move_to_visually_next (&it
->bidi_it
);
7752 while (it
->bidi_it
.bytepos
!= orig_bytepos
7753 && it
->bidi_it
.charpos
< eob
);
7756 /* Adjust IT's position information to where we ended up. */
7757 if (STRINGP (it
->string
))
7759 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7760 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7764 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7765 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7768 if (STRINGP (it
->string
) || !it
->s
)
7770 ptrdiff_t stop
, charpos
, bytepos
;
7772 if (STRINGP (it
->string
))
7775 stop
= SCHARS (it
->string
);
7776 if (stop
> it
->end_charpos
)
7777 stop
= it
->end_charpos
;
7778 charpos
= IT_STRING_CHARPOS (*it
);
7779 bytepos
= IT_STRING_BYTEPOS (*it
);
7783 stop
= it
->end_charpos
;
7784 charpos
= IT_CHARPOS (*it
);
7785 bytepos
= IT_BYTEPOS (*it
);
7787 if (it
->bidi_it
.scan_dir
< 0)
7789 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7794 /* Load IT with the next display element from Lisp string IT->string.
7795 IT->current.string_pos is the current position within the string.
7796 If IT->current.overlay_string_index >= 0, the Lisp string is an
7800 next_element_from_string (struct it
*it
)
7802 struct text_pos position
;
7804 eassert (STRINGP (it
->string
));
7805 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7806 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7807 position
= it
->current
.string_pos
;
7809 /* With bidi reordering, the character to display might not be the
7810 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7811 that we were reseat()ed to a new string, whose paragraph
7812 direction is not known. */
7813 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7815 get_visually_first_element (it
);
7816 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7819 /* Time to check for invisible text? */
7820 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7822 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7825 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7826 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7828 /* With bidi non-linear iteration, we could find
7829 ourselves far beyond the last computed stop_charpos,
7830 with several other stop positions in between that we
7831 missed. Scan them all now, in buffer's logical
7832 order, until we find and handle the last stop_charpos
7833 that precedes our current position. */
7834 handle_stop_backwards (it
, it
->stop_charpos
);
7835 return GET_NEXT_DISPLAY_ELEMENT (it
);
7841 /* Take note of the stop position we just moved
7842 across, for when we will move back across it. */
7843 it
->prev_stop
= it
->stop_charpos
;
7844 /* If we are at base paragraph embedding level, take
7845 note of the last stop position seen at this
7847 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7848 it
->base_level_stop
= it
->stop_charpos
;
7852 /* Since a handler may have changed IT->method, we must
7854 return GET_NEXT_DISPLAY_ELEMENT (it
);
7858 /* If we are before prev_stop, we may have overstepped
7859 on our way backwards a stop_pos, and if so, we need
7860 to handle that stop_pos. */
7861 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7862 /* We can sometimes back up for reasons that have nothing
7863 to do with bidi reordering. E.g., compositions. The
7864 code below is only needed when we are above the base
7865 embedding level, so test for that explicitly. */
7866 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7868 /* If we lost track of base_level_stop, we have no better
7869 place for handle_stop_backwards to start from than string
7870 beginning. This happens, e.g., when we were reseated to
7871 the previous screenful of text by vertical-motion. */
7872 if (it
->base_level_stop
<= 0
7873 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7874 it
->base_level_stop
= 0;
7875 handle_stop_backwards (it
, it
->base_level_stop
);
7876 return GET_NEXT_DISPLAY_ELEMENT (it
);
7880 if (it
->current
.overlay_string_index
>= 0)
7882 /* Get the next character from an overlay string. In overlay
7883 strings, there is no field width or padding with spaces to
7885 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7890 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7891 IT_STRING_BYTEPOS (*it
),
7892 it
->bidi_it
.scan_dir
< 0
7894 : SCHARS (it
->string
))
7895 && next_element_from_composition (it
))
7899 else if (STRING_MULTIBYTE (it
->string
))
7901 const unsigned char *s
= (SDATA (it
->string
)
7902 + IT_STRING_BYTEPOS (*it
));
7903 it
->c
= string_char_and_length (s
, &it
->len
);
7907 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7913 /* Get the next character from a Lisp string that is not an
7914 overlay string. Such strings come from the mode line, for
7915 example. We may have to pad with spaces, or truncate the
7916 string. See also next_element_from_c_string. */
7917 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7922 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7924 /* Pad with spaces. */
7925 it
->c
= ' ', it
->len
= 1;
7926 CHARPOS (position
) = BYTEPOS (position
) = -1;
7928 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7929 IT_STRING_BYTEPOS (*it
),
7930 it
->bidi_it
.scan_dir
< 0
7932 : it
->string_nchars
)
7933 && next_element_from_composition (it
))
7937 else if (STRING_MULTIBYTE (it
->string
))
7939 const unsigned char *s
= (SDATA (it
->string
)
7940 + IT_STRING_BYTEPOS (*it
));
7941 it
->c
= string_char_and_length (s
, &it
->len
);
7945 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7950 /* Record what we have and where it came from. */
7951 it
->what
= IT_CHARACTER
;
7952 it
->object
= it
->string
;
7953 it
->position
= position
;
7958 /* Load IT with next display element from C string IT->s.
7959 IT->string_nchars is the maximum number of characters to return
7960 from the string. IT->end_charpos may be greater than
7961 IT->string_nchars when this function is called, in which case we
7962 may have to return padding spaces. Value is zero if end of string
7963 reached, including padding spaces. */
7966 next_element_from_c_string (struct it
*it
)
7968 bool success_p
= true;
7971 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7972 it
->what
= IT_CHARACTER
;
7973 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7974 it
->object
= make_number (0);
7976 /* With bidi reordering, the character to display might not be the
7977 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7978 we were reseated to a new string, whose paragraph direction is
7980 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7981 get_visually_first_element (it
);
7983 /* IT's position can be greater than IT->string_nchars in case a
7984 field width or precision has been specified when the iterator was
7986 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7988 /* End of the game. */
7992 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7994 /* Pad with spaces. */
7995 it
->c
= ' ', it
->len
= 1;
7996 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7998 else if (it
->multibyte_p
)
7999 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8001 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8007 /* Set up IT to return characters from an ellipsis, if appropriate.
8008 The definition of the ellipsis glyphs may come from a display table
8009 entry. This function fills IT with the first glyph from the
8010 ellipsis if an ellipsis is to be displayed. */
8013 next_element_from_ellipsis (struct it
*it
)
8015 if (it
->selective_display_ellipsis_p
)
8016 setup_for_ellipsis (it
, it
->len
);
8019 /* The face at the current position may be different from the
8020 face we find after the invisible text. Remember what it
8021 was in IT->saved_face_id, and signal that it's there by
8022 setting face_before_selective_p. */
8023 it
->saved_face_id
= it
->face_id
;
8024 it
->method
= GET_FROM_BUFFER
;
8025 it
->object
= it
->w
->contents
;
8026 reseat_at_next_visible_line_start (it
, 1);
8027 it
->face_before_selective_p
= true;
8030 return GET_NEXT_DISPLAY_ELEMENT (it
);
8034 /* Deliver an image display element. The iterator IT is already
8035 filled with image information (done in handle_display_prop). Value
8040 next_element_from_image (struct it
*it
)
8042 it
->what
= IT_IMAGE
;
8043 it
->ignore_overlay_strings_at_pos_p
= 0;
8047 #ifdef HAVE_XWIDGETS
8048 /* im not sure about this FIXME JAVE*/
8050 next_element_from_xwidget (struct it
*it
)
8052 it
->what
= IT_XWIDGET
;
8053 //assert_valid_xwidget_id(it->xwidget_id,"next_element_from_xwidget");
8054 //this is shaky because why do we set "what" if we dont set the other parts??
8055 //printf("xwidget_id %d: in next_element_from_xwidget: FIXME \n", it->xwidget_id);
8061 /* Fill iterator IT with next display element from a stretch glyph
8062 property. IT->object is the value of the text property. Value is
8066 next_element_from_stretch (struct it
*it
)
8068 it
->what
= IT_STRETCH
;
8072 /* Scan backwards from IT's current position until we find a stop
8073 position, or until BEGV. This is called when we find ourself
8074 before both the last known prev_stop and base_level_stop while
8075 reordering bidirectional text. */
8078 compute_stop_pos_backwards (struct it
*it
)
8080 const int SCAN_BACK_LIMIT
= 1000;
8081 struct text_pos pos
;
8082 struct display_pos save_current
= it
->current
;
8083 struct text_pos save_position
= it
->position
;
8084 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8085 ptrdiff_t where_we_are
= charpos
;
8086 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8087 ptrdiff_t save_end_pos
= it
->end_charpos
;
8089 eassert (NILP (it
->string
) && !it
->s
);
8090 eassert (it
->bidi_p
);
8094 it
->end_charpos
= min (charpos
+ 1, ZV
);
8095 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8096 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8097 reseat_1 (it
, pos
, 0);
8098 compute_stop_pos (it
);
8099 /* We must advance forward, right? */
8100 if (it
->stop_charpos
<= charpos
)
8103 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8105 if (it
->stop_charpos
<= where_we_are
)
8106 it
->prev_stop
= it
->stop_charpos
;
8108 it
->prev_stop
= BEGV
;
8110 it
->current
= save_current
;
8111 it
->position
= save_position
;
8112 it
->stop_charpos
= save_stop_pos
;
8113 it
->end_charpos
= save_end_pos
;
8116 /* Scan forward from CHARPOS in the current buffer/string, until we
8117 find a stop position > current IT's position. Then handle the stop
8118 position before that. This is called when we bump into a stop
8119 position while reordering bidirectional text. CHARPOS should be
8120 the last previously processed stop_pos (or BEGV/0, if none were
8121 processed yet) whose position is less that IT's current
8125 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8127 int bufp
= !STRINGP (it
->string
);
8128 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8129 struct display_pos save_current
= it
->current
;
8130 struct text_pos save_position
= it
->position
;
8131 struct text_pos pos1
;
8132 ptrdiff_t next_stop
;
8134 /* Scan in strict logical order. */
8135 eassert (it
->bidi_p
);
8139 it
->prev_stop
= charpos
;
8142 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8143 reseat_1 (it
, pos1
, 0);
8146 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8147 compute_stop_pos (it
);
8148 /* We must advance forward, right? */
8149 if (it
->stop_charpos
<= it
->prev_stop
)
8151 charpos
= it
->stop_charpos
;
8153 while (charpos
<= where_we_are
);
8156 it
->current
= save_current
;
8157 it
->position
= save_position
;
8158 next_stop
= it
->stop_charpos
;
8159 it
->stop_charpos
= it
->prev_stop
;
8161 it
->stop_charpos
= next_stop
;
8164 /* Load IT with the next display element from current_buffer. Value
8165 is zero if end of buffer reached. IT->stop_charpos is the next
8166 position at which to stop and check for text properties or buffer
8170 next_element_from_buffer (struct it
*it
)
8172 bool success_p
= true;
8174 eassert (IT_CHARPOS (*it
) >= BEGV
);
8175 eassert (NILP (it
->string
) && !it
->s
);
8176 eassert (!it
->bidi_p
8177 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8178 && it
->bidi_it
.string
.s
== NULL
));
8180 /* With bidi reordering, the character to display might not be the
8181 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8182 we were reseat()ed to a new buffer position, which is potentially
8183 a different paragraph. */
8184 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8186 get_visually_first_element (it
);
8187 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8190 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8192 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8194 int overlay_strings_follow_p
;
8196 /* End of the game, except when overlay strings follow that
8197 haven't been returned yet. */
8198 if (it
->overlay_strings_at_end_processed_p
)
8199 overlay_strings_follow_p
= 0;
8202 it
->overlay_strings_at_end_processed_p
= true;
8203 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8206 if (overlay_strings_follow_p
)
8207 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8211 it
->position
= it
->current
.pos
;
8215 else if (!(!it
->bidi_p
8216 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8217 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8219 /* With bidi non-linear iteration, we could find ourselves
8220 far beyond the last computed stop_charpos, with several
8221 other stop positions in between that we missed. Scan
8222 them all now, in buffer's logical order, until we find
8223 and handle the last stop_charpos that precedes our
8224 current position. */
8225 handle_stop_backwards (it
, it
->stop_charpos
);
8226 return GET_NEXT_DISPLAY_ELEMENT (it
);
8232 /* Take note of the stop position we just moved across,
8233 for when we will move back across it. */
8234 it
->prev_stop
= it
->stop_charpos
;
8235 /* If we are at base paragraph embedding level, take
8236 note of the last stop position seen at this
8238 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8239 it
->base_level_stop
= it
->stop_charpos
;
8242 return GET_NEXT_DISPLAY_ELEMENT (it
);
8246 /* If we are before prev_stop, we may have overstepped on
8247 our way backwards a stop_pos, and if so, we need to
8248 handle that stop_pos. */
8249 && IT_CHARPOS (*it
) < it
->prev_stop
8250 /* We can sometimes back up for reasons that have nothing
8251 to do with bidi reordering. E.g., compositions. The
8252 code below is only needed when we are above the base
8253 embedding level, so test for that explicitly. */
8254 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8256 if (it
->base_level_stop
<= 0
8257 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8259 /* If we lost track of base_level_stop, we need to find
8260 prev_stop by looking backwards. This happens, e.g., when
8261 we were reseated to the previous screenful of text by
8263 it
->base_level_stop
= BEGV
;
8264 compute_stop_pos_backwards (it
);
8265 handle_stop_backwards (it
, it
->prev_stop
);
8268 handle_stop_backwards (it
, it
->base_level_stop
);
8269 return GET_NEXT_DISPLAY_ELEMENT (it
);
8273 /* No face changes, overlays etc. in sight, so just return a
8274 character from current_buffer. */
8278 /* We moved to the next buffer position, so any info about
8279 previously seen overlays is no longer valid. */
8280 it
->ignore_overlay_strings_at_pos_p
= 0;
8282 /* Maybe run the redisplay end trigger hook. Performance note:
8283 This doesn't seem to cost measurable time. */
8284 if (it
->redisplay_end_trigger_charpos
8286 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8287 run_redisplay_end_trigger_hook (it
);
8289 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8290 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8292 && next_element_from_composition (it
))
8297 /* Get the next character, maybe multibyte. */
8298 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8299 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8300 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8302 it
->c
= *p
, it
->len
= 1;
8304 /* Record what we have and where it came from. */
8305 it
->what
= IT_CHARACTER
;
8306 it
->object
= it
->w
->contents
;
8307 it
->position
= it
->current
.pos
;
8309 /* Normally we return the character found above, except when we
8310 really want to return an ellipsis for selective display. */
8315 /* A value of selective > 0 means hide lines indented more
8316 than that number of columns. */
8317 if (it
->selective
> 0
8318 && IT_CHARPOS (*it
) + 1 < ZV
8319 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8320 IT_BYTEPOS (*it
) + 1,
8323 success_p
= next_element_from_ellipsis (it
);
8324 it
->dpvec_char_len
= -1;
8327 else if (it
->c
== '\r' && it
->selective
== -1)
8329 /* A value of selective == -1 means that everything from the
8330 CR to the end of the line is invisible, with maybe an
8331 ellipsis displayed for it. */
8332 success_p
= next_element_from_ellipsis (it
);
8333 it
->dpvec_char_len
= -1;
8338 /* Value is zero if end of buffer reached. */
8339 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8344 /* Run the redisplay end trigger hook for IT. */
8347 run_redisplay_end_trigger_hook (struct it
*it
)
8349 Lisp_Object args
[3];
8351 /* IT->glyph_row should be non-null, i.e. we should be actually
8352 displaying something, or otherwise we should not run the hook. */
8353 eassert (it
->glyph_row
);
8355 /* Set up hook arguments. */
8356 args
[0] = Qredisplay_end_trigger_functions
;
8357 args
[1] = it
->window
;
8358 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8359 it
->redisplay_end_trigger_charpos
= 0;
8361 /* Since we are *trying* to run these functions, don't try to run
8362 them again, even if they get an error. */
8363 wset_redisplay_end_trigger (it
->w
, Qnil
);
8364 Frun_hook_with_args (3, args
);
8366 /* Notice if it changed the face of the character we are on. */
8367 handle_face_prop (it
);
8371 /* Deliver a composition display element. Unlike the other
8372 next_element_from_XXX, this function is not registered in the array
8373 get_next_element[]. It is called from next_element_from_buffer and
8374 next_element_from_string when necessary. */
8377 next_element_from_composition (struct it
*it
)
8379 it
->what
= IT_COMPOSITION
;
8380 it
->len
= it
->cmp_it
.nbytes
;
8381 if (STRINGP (it
->string
))
8385 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8386 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8389 it
->position
= it
->current
.string_pos
;
8390 it
->object
= it
->string
;
8391 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8392 IT_STRING_BYTEPOS (*it
), it
->string
);
8398 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8399 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8402 if (it
->bidi_it
.new_paragraph
)
8403 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8404 /* Resync the bidi iterator with IT's new position.
8405 FIXME: this doesn't support bidirectional text. */
8406 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8407 bidi_move_to_visually_next (&it
->bidi_it
);
8411 it
->position
= it
->current
.pos
;
8412 it
->object
= it
->w
->contents
;
8413 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8414 IT_BYTEPOS (*it
), Qnil
);
8421 /***********************************************************************
8422 Moving an iterator without producing glyphs
8423 ***********************************************************************/
8425 /* Check if iterator is at a position corresponding to a valid buffer
8426 position after some move_it_ call. */
8428 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8429 ((it)->method == GET_FROM_STRING \
8430 ? IT_STRING_CHARPOS (*it) == 0 \
8434 /* Move iterator IT to a specified buffer or X position within one
8435 line on the display without producing glyphs.
8437 OP should be a bit mask including some or all of these bits:
8438 MOVE_TO_X: Stop upon reaching x-position TO_X.
8439 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8440 Regardless of OP's value, stop upon reaching the end of the display line.
8442 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8443 This means, in particular, that TO_X includes window's horizontal
8446 The return value has several possible values that
8447 say what condition caused the scan to stop:
8449 MOVE_POS_MATCH_OR_ZV
8450 - when TO_POS or ZV was reached.
8453 -when TO_X was reached before TO_POS or ZV were reached.
8456 - when we reached the end of the display area and the line must
8460 - when we reached the end of the display area and the line is
8464 - when we stopped at a line end, i.e. a newline or a CR and selective
8467 static enum move_it_result
8468 move_it_in_display_line_to (struct it
*it
,
8469 ptrdiff_t to_charpos
, int to_x
,
8470 enum move_operation_enum op
)
8472 enum move_it_result result
= MOVE_UNDEFINED
;
8473 struct glyph_row
*saved_glyph_row
;
8474 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8475 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8476 void *ppos_data
= NULL
;
8478 enum it_method prev_method
= it
->method
;
8479 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8480 int saw_smaller_pos
= prev_pos
< to_charpos
;
8482 /* Don't produce glyphs in produce_glyphs. */
8483 saved_glyph_row
= it
->glyph_row
;
8484 it
->glyph_row
= NULL
;
8486 /* Use wrap_it to save a copy of IT wherever a word wrap could
8487 occur. Use atpos_it to save a copy of IT at the desired buffer
8488 position, if found, so that we can scan ahead and check if the
8489 word later overshoots the window edge. Use atx_it similarly, for
8495 /* Use ppos_it under bidi reordering to save a copy of IT for the
8496 initial position. We restore that position in IT when we have
8497 scanned the entire display line without finding a match for
8498 TO_CHARPOS and all the character positions are greater than
8499 TO_CHARPOS. We then restart the scan from the initial position,
8500 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8501 the closest to TO_CHARPOS. */
8504 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8506 SAVE_IT (ppos_it
, *it
, ppos_data
);
8507 closest_pos
= IT_CHARPOS (*it
);
8513 #define BUFFER_POS_REACHED_P() \
8514 ((op & MOVE_TO_POS) != 0 \
8515 && BUFFERP (it->object) \
8516 && (IT_CHARPOS (*it) == to_charpos \
8518 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8519 && IT_CHARPOS (*it) > to_charpos) \
8520 || (it->what == IT_COMPOSITION \
8521 && ((IT_CHARPOS (*it) > to_charpos \
8522 && to_charpos >= it->cmp_it.charpos) \
8523 || (IT_CHARPOS (*it) < to_charpos \
8524 && to_charpos <= it->cmp_it.charpos)))) \
8525 && (it->method == GET_FROM_BUFFER \
8526 || (it->method == GET_FROM_DISPLAY_VECTOR \
8527 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8529 /* If there's a line-/wrap-prefix, handle it. */
8530 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8531 && it
->current_y
< it
->last_visible_y
)
8532 handle_line_prefix (it
);
8534 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8535 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8539 int x
, i
, ascent
= 0, descent
= 0;
8541 /* Utility macro to reset an iterator with x, ascent, and descent. */
8542 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8543 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8544 (IT)->max_descent = descent)
8546 /* Stop if we move beyond TO_CHARPOS (after an image or a
8547 display string or stretch glyph). */
8548 if ((op
& MOVE_TO_POS
) != 0
8549 && BUFFERP (it
->object
)
8550 && it
->method
== GET_FROM_BUFFER
8552 /* When the iterator is at base embedding level, we
8553 are guaranteed that characters are delivered for
8554 display in strictly increasing order of their
8555 buffer positions. */
8556 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8557 && IT_CHARPOS (*it
) > to_charpos
)
8559 && (prev_method
== GET_FROM_IMAGE
8560 || prev_method
== GET_FROM_STRETCH
8561 || prev_method
== GET_FROM_STRING
)
8562 /* Passed TO_CHARPOS from left to right. */
8563 && ((prev_pos
< to_charpos
8564 && IT_CHARPOS (*it
) > to_charpos
)
8565 /* Passed TO_CHARPOS from right to left. */
8566 || (prev_pos
> to_charpos
8567 && IT_CHARPOS (*it
) < to_charpos
)))))
8569 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8571 result
= MOVE_POS_MATCH_OR_ZV
;
8574 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8575 /* If wrap_it is valid, the current position might be in a
8576 word that is wrapped. So, save the iterator in
8577 atpos_it and continue to see if wrapping happens. */
8578 SAVE_IT (atpos_it
, *it
, atpos_data
);
8581 /* Stop when ZV reached.
8582 We used to stop here when TO_CHARPOS reached as well, but that is
8583 too soon if this glyph does not fit on this line. So we handle it
8584 explicitly below. */
8585 if (!get_next_display_element (it
))
8587 result
= MOVE_POS_MATCH_OR_ZV
;
8591 if (it
->line_wrap
== TRUNCATE
)
8593 if (BUFFER_POS_REACHED_P ())
8595 result
= MOVE_POS_MATCH_OR_ZV
;
8601 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8603 if (IT_DISPLAYING_WHITESPACE (it
))
8607 /* We have reached a glyph that follows one or more
8608 whitespace characters. If the position is
8609 already found, we are done. */
8610 if (atpos_it
.sp
>= 0)
8612 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8613 result
= MOVE_POS_MATCH_OR_ZV
;
8618 RESTORE_IT (it
, &atx_it
, atx_data
);
8619 result
= MOVE_X_REACHED
;
8622 /* Otherwise, we can wrap here. */
8623 SAVE_IT (wrap_it
, *it
, wrap_data
);
8629 /* Remember the line height for the current line, in case
8630 the next element doesn't fit on the line. */
8631 ascent
= it
->max_ascent
;
8632 descent
= it
->max_descent
;
8634 /* The call to produce_glyphs will get the metrics of the
8635 display element IT is loaded with. Record the x-position
8636 before this display element, in case it doesn't fit on the
8640 PRODUCE_GLYPHS (it
);
8642 if (it
->area
!= TEXT_AREA
)
8644 prev_method
= it
->method
;
8645 if (it
->method
== GET_FROM_BUFFER
)
8646 prev_pos
= IT_CHARPOS (*it
);
8647 set_iterator_to_next (it
, 1);
8648 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8649 SET_TEXT_POS (this_line_min_pos
,
8650 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8652 && (op
& MOVE_TO_POS
)
8653 && IT_CHARPOS (*it
) > to_charpos
8654 && IT_CHARPOS (*it
) < closest_pos
)
8655 closest_pos
= IT_CHARPOS (*it
);
8659 /* The number of glyphs we get back in IT->nglyphs will normally
8660 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8661 character on a terminal frame, or (iii) a line end. For the
8662 second case, IT->nglyphs - 1 padding glyphs will be present.
8663 (On X frames, there is only one glyph produced for a
8664 composite character.)
8666 The behavior implemented below means, for continuation lines,
8667 that as many spaces of a TAB as fit on the current line are
8668 displayed there. For terminal frames, as many glyphs of a
8669 multi-glyph character are displayed in the current line, too.
8670 This is what the old redisplay code did, and we keep it that
8671 way. Under X, the whole shape of a complex character must
8672 fit on the line or it will be completely displayed in the
8675 Note that both for tabs and padding glyphs, all glyphs have
8679 /* More than one glyph or glyph doesn't fit on line. All
8680 glyphs have the same width. */
8681 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8683 int x_before_this_char
= x
;
8684 int hpos_before_this_char
= it
->hpos
;
8686 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8688 new_x
= x
+ single_glyph_width
;
8690 /* We want to leave anything reaching TO_X to the caller. */
8691 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8693 if (BUFFER_POS_REACHED_P ())
8695 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8696 goto buffer_pos_reached
;
8697 if (atpos_it
.sp
< 0)
8699 SAVE_IT (atpos_it
, *it
, atpos_data
);
8700 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8705 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8708 result
= MOVE_X_REACHED
;
8713 SAVE_IT (atx_it
, *it
, atx_data
);
8714 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8719 if (/* Lines are continued. */
8720 it
->line_wrap
!= TRUNCATE
8721 && (/* And glyph doesn't fit on the line. */
8722 new_x
> it
->last_visible_x
8723 /* Or it fits exactly and we're on a window
8725 || (new_x
== it
->last_visible_x
8726 && FRAME_WINDOW_P (it
->f
)
8727 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8728 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8729 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8731 if (/* IT->hpos == 0 means the very first glyph
8732 doesn't fit on the line, e.g. a wide image. */
8734 || (new_x
== it
->last_visible_x
8735 && FRAME_WINDOW_P (it
->f
)))
8738 it
->current_x
= new_x
;
8740 /* The character's last glyph just barely fits
8742 if (i
== it
->nglyphs
- 1)
8744 /* If this is the destination position,
8745 return a position *before* it in this row,
8746 now that we know it fits in this row. */
8747 if (BUFFER_POS_REACHED_P ())
8749 if (it
->line_wrap
!= WORD_WRAP
8752 it
->hpos
= hpos_before_this_char
;
8753 it
->current_x
= x_before_this_char
;
8754 result
= MOVE_POS_MATCH_OR_ZV
;
8757 if (it
->line_wrap
== WORD_WRAP
8760 SAVE_IT (atpos_it
, *it
, atpos_data
);
8761 atpos_it
.current_x
= x_before_this_char
;
8762 atpos_it
.hpos
= hpos_before_this_char
;
8766 prev_method
= it
->method
;
8767 if (it
->method
== GET_FROM_BUFFER
)
8768 prev_pos
= IT_CHARPOS (*it
);
8769 set_iterator_to_next (it
, 1);
8770 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8771 SET_TEXT_POS (this_line_min_pos
,
8772 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8773 /* On graphical terminals, newlines may
8774 "overflow" into the fringe if
8775 overflow-newline-into-fringe is non-nil.
8776 On text terminals, and on graphical
8777 terminals with no right margin, newlines
8778 may overflow into the last glyph on the
8780 if (!FRAME_WINDOW_P (it
->f
)
8782 && it
->bidi_it
.paragraph_dir
== R2L
)
8783 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8784 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8785 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8787 if (!get_next_display_element (it
))
8789 result
= MOVE_POS_MATCH_OR_ZV
;
8792 if (BUFFER_POS_REACHED_P ())
8794 if (ITERATOR_AT_END_OF_LINE_P (it
))
8795 result
= MOVE_POS_MATCH_OR_ZV
;
8797 result
= MOVE_LINE_CONTINUED
;
8800 if (ITERATOR_AT_END_OF_LINE_P (it
)
8801 && (it
->line_wrap
!= WORD_WRAP
8803 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8805 result
= MOVE_NEWLINE_OR_CR
;
8812 IT_RESET_X_ASCENT_DESCENT (it
);
8814 if (wrap_it
.sp
>= 0)
8816 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8821 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8823 result
= MOVE_LINE_CONTINUED
;
8827 if (BUFFER_POS_REACHED_P ())
8829 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8830 goto buffer_pos_reached
;
8831 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8833 SAVE_IT (atpos_it
, *it
, atpos_data
);
8834 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8838 if (new_x
> it
->first_visible_x
)
8840 /* Glyph is visible. Increment number of glyphs that
8841 would be displayed. */
8846 if (result
!= MOVE_UNDEFINED
)
8849 else if (BUFFER_POS_REACHED_P ())
8852 IT_RESET_X_ASCENT_DESCENT (it
);
8853 result
= MOVE_POS_MATCH_OR_ZV
;
8856 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8858 /* Stop when TO_X specified and reached. This check is
8859 necessary here because of lines consisting of a line end,
8860 only. The line end will not produce any glyphs and we
8861 would never get MOVE_X_REACHED. */
8862 eassert (it
->nglyphs
== 0);
8863 result
= MOVE_X_REACHED
;
8867 /* Is this a line end? If yes, we're done. */
8868 if (ITERATOR_AT_END_OF_LINE_P (it
))
8870 /* If we are past TO_CHARPOS, but never saw any character
8871 positions smaller than TO_CHARPOS, return
8872 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8874 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8876 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8878 if (closest_pos
< ZV
)
8880 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8881 /* Don't recurse if closest_pos is equal to
8882 to_charpos, since we have just tried that. */
8883 if (closest_pos
!= to_charpos
)
8884 move_it_in_display_line_to (it
, closest_pos
, -1,
8886 result
= MOVE_POS_MATCH_OR_ZV
;
8889 goto buffer_pos_reached
;
8891 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8892 && IT_CHARPOS (*it
) > to_charpos
)
8893 goto buffer_pos_reached
;
8895 result
= MOVE_NEWLINE_OR_CR
;
8898 result
= MOVE_NEWLINE_OR_CR
;
8902 prev_method
= it
->method
;
8903 if (it
->method
== GET_FROM_BUFFER
)
8904 prev_pos
= IT_CHARPOS (*it
);
8905 /* The current display element has been consumed. Advance
8907 set_iterator_to_next (it
, 1);
8908 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8909 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8910 if (IT_CHARPOS (*it
) < to_charpos
)
8911 saw_smaller_pos
= 1;
8913 && (op
& MOVE_TO_POS
)
8914 && IT_CHARPOS (*it
) >= to_charpos
8915 && IT_CHARPOS (*it
) < closest_pos
)
8916 closest_pos
= IT_CHARPOS (*it
);
8918 /* Stop if lines are truncated and IT's current x-position is
8919 past the right edge of the window now. */
8920 if (it
->line_wrap
== TRUNCATE
8921 && it
->current_x
>= it
->last_visible_x
)
8923 if (!FRAME_WINDOW_P (it
->f
)
8924 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8925 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8926 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8927 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8931 if ((at_eob_p
= !get_next_display_element (it
))
8932 || BUFFER_POS_REACHED_P ()
8933 /* If we are past TO_CHARPOS, but never saw any
8934 character positions smaller than TO_CHARPOS,
8935 return MOVE_POS_MATCH_OR_ZV, like the
8936 unidirectional display did. */
8937 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8939 && IT_CHARPOS (*it
) > to_charpos
))
8942 && !BUFFER_POS_REACHED_P ()
8943 && !at_eob_p
&& closest_pos
< ZV
)
8945 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8946 if (closest_pos
!= to_charpos
)
8947 move_it_in_display_line_to (it
, closest_pos
, -1,
8950 result
= MOVE_POS_MATCH_OR_ZV
;
8953 if (ITERATOR_AT_END_OF_LINE_P (it
))
8955 result
= MOVE_NEWLINE_OR_CR
;
8959 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8961 && IT_CHARPOS (*it
) > to_charpos
)
8963 if (closest_pos
< ZV
)
8965 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8966 if (closest_pos
!= to_charpos
)
8967 move_it_in_display_line_to (it
, closest_pos
, -1,
8970 result
= MOVE_POS_MATCH_OR_ZV
;
8973 result
= MOVE_LINE_TRUNCATED
;
8976 #undef IT_RESET_X_ASCENT_DESCENT
8979 #undef BUFFER_POS_REACHED_P
8981 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8982 restore the saved iterator. */
8983 if (atpos_it
.sp
>= 0)
8984 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8985 else if (atx_it
.sp
>= 0)
8986 RESTORE_IT (it
, &atx_it
, atx_data
);
8991 bidi_unshelve_cache (atpos_data
, 1);
8993 bidi_unshelve_cache (atx_data
, 1);
8995 bidi_unshelve_cache (wrap_data
, 1);
8997 bidi_unshelve_cache (ppos_data
, 1);
8999 /* Restore the iterator settings altered at the beginning of this
9001 it
->glyph_row
= saved_glyph_row
;
9005 /* For external use. */
9007 move_it_in_display_line (struct it
*it
,
9008 ptrdiff_t to_charpos
, int to_x
,
9009 enum move_operation_enum op
)
9011 if (it
->line_wrap
== WORD_WRAP
9012 && (op
& MOVE_TO_X
))
9015 void *save_data
= NULL
;
9018 SAVE_IT (save_it
, *it
, save_data
);
9019 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9020 /* When word-wrap is on, TO_X may lie past the end
9021 of a wrapped line. Then it->current is the
9022 character on the next line, so backtrack to the
9023 space before the wrap point. */
9024 if (skip
== MOVE_LINE_CONTINUED
)
9026 int prev_x
= max (it
->current_x
- 1, 0);
9027 RESTORE_IT (it
, &save_it
, save_data
);
9028 move_it_in_display_line_to
9029 (it
, -1, prev_x
, MOVE_TO_X
);
9032 bidi_unshelve_cache (save_data
, 1);
9035 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9039 /* Move IT forward until it satisfies one or more of the criteria in
9040 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9042 OP is a bit-mask that specifies where to stop, and in particular,
9043 which of those four position arguments makes a difference. See the
9044 description of enum move_operation_enum.
9046 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9047 screen line, this function will set IT to the next position that is
9048 displayed to the right of TO_CHARPOS on the screen.
9050 Return the maximum pixel length of any line scanned but never more
9051 than it.last_visible_x. */
9054 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9056 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9057 int line_height
, line_start_x
= 0, reached
= 0;
9058 int max_current_x
= 0;
9059 void *backup_data
= NULL
;
9063 if (op
& MOVE_TO_VPOS
)
9065 /* If no TO_CHARPOS and no TO_X specified, stop at the
9066 start of the line TO_VPOS. */
9067 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9069 if (it
->vpos
== to_vpos
)
9075 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9079 /* TO_VPOS >= 0 means stop at TO_X in the line at
9080 TO_VPOS, or at TO_POS, whichever comes first. */
9081 if (it
->vpos
== to_vpos
)
9087 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9089 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9094 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9096 /* We have reached TO_X but not in the line we want. */
9097 skip
= move_it_in_display_line_to (it
, to_charpos
,
9099 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9107 else if (op
& MOVE_TO_Y
)
9109 struct it it_backup
;
9111 if (it
->line_wrap
== WORD_WRAP
)
9112 SAVE_IT (it_backup
, *it
, backup_data
);
9114 /* TO_Y specified means stop at TO_X in the line containing
9115 TO_Y---or at TO_CHARPOS if this is reached first. The
9116 problem is that we can't really tell whether the line
9117 contains TO_Y before we have completely scanned it, and
9118 this may skip past TO_X. What we do is to first scan to
9121 If TO_X is not specified, use a TO_X of zero. The reason
9122 is to make the outcome of this function more predictable.
9123 If we didn't use TO_X == 0, we would stop at the end of
9124 the line which is probably not what a caller would expect
9126 skip
= move_it_in_display_line_to
9127 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9128 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9130 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9131 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9133 else if (skip
== MOVE_X_REACHED
)
9135 /* If TO_X was reached, we want to know whether TO_Y is
9136 in the line. We know this is the case if the already
9137 scanned glyphs make the line tall enough. Otherwise,
9138 we must check by scanning the rest of the line. */
9139 line_height
= it
->max_ascent
+ it
->max_descent
;
9140 if (to_y
>= it
->current_y
9141 && to_y
< it
->current_y
+ line_height
)
9146 SAVE_IT (it_backup
, *it
, backup_data
);
9147 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9148 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9150 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9151 line_height
= it
->max_ascent
+ it
->max_descent
;
9152 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9154 if (to_y
>= it
->current_y
9155 && to_y
< it
->current_y
+ line_height
)
9157 /* If TO_Y is in this line and TO_X was reached
9158 above, we scanned too far. We have to restore
9159 IT's settings to the ones before skipping. But
9160 keep the more accurate values of max_ascent and
9161 max_descent we've found while skipping the rest
9162 of the line, for the sake of callers, such as
9163 pos_visible_p, that need to know the line
9165 int max_ascent
= it
->max_ascent
;
9166 int max_descent
= it
->max_descent
;
9168 RESTORE_IT (it
, &it_backup
, backup_data
);
9169 it
->max_ascent
= max_ascent
;
9170 it
->max_descent
= max_descent
;
9176 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9182 /* Check whether TO_Y is in this line. */
9183 line_height
= it
->max_ascent
+ it
->max_descent
;
9184 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9186 if (to_y
>= it
->current_y
9187 && to_y
< it
->current_y
+ line_height
)
9189 if (to_y
> it
->current_y
)
9190 max_current_x
= max (it
->current_x
, max_current_x
);
9192 /* When word-wrap is on, TO_X may lie past the end
9193 of a wrapped line. Then it->current is the
9194 character on the next line, so backtrack to the
9195 space before the wrap point. */
9196 if (skip
== MOVE_LINE_CONTINUED
9197 && it
->line_wrap
== WORD_WRAP
)
9199 int prev_x
= max (it
->current_x
- 1, 0);
9200 RESTORE_IT (it
, &it_backup
, backup_data
);
9201 skip
= move_it_in_display_line_to
9202 (it
, -1, prev_x
, MOVE_TO_X
);
9211 max_current_x
= max (it
->current_x
, max_current_x
);
9215 else if (BUFFERP (it
->object
)
9216 && (it
->method
== GET_FROM_BUFFER
9217 || it
->method
== GET_FROM_STRETCH
)
9218 && IT_CHARPOS (*it
) >= to_charpos
9219 /* Under bidi iteration, a call to set_iterator_to_next
9220 can scan far beyond to_charpos if the initial
9221 portion of the next line needs to be reordered. In
9222 that case, give move_it_in_display_line_to another
9225 && it
->bidi_it
.scan_dir
== -1))
9226 skip
= MOVE_POS_MATCH_OR_ZV
;
9228 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9232 case MOVE_POS_MATCH_OR_ZV
:
9233 max_current_x
= max (it
->current_x
, max_current_x
);
9237 case MOVE_NEWLINE_OR_CR
:
9238 max_current_x
= max (it
->current_x
, max_current_x
);
9239 set_iterator_to_next (it
, 1);
9240 it
->continuation_lines_width
= 0;
9243 case MOVE_LINE_TRUNCATED
:
9244 max_current_x
= it
->last_visible_x
;
9245 it
->continuation_lines_width
= 0;
9246 reseat_at_next_visible_line_start (it
, 0);
9247 if ((op
& MOVE_TO_POS
) != 0
9248 && IT_CHARPOS (*it
) > to_charpos
)
9255 case MOVE_LINE_CONTINUED
:
9256 max_current_x
= it
->last_visible_x
;
9257 /* For continued lines ending in a tab, some of the glyphs
9258 associated with the tab are displayed on the current
9259 line. Since it->current_x does not include these glyphs,
9260 we use it->last_visible_x instead. */
9263 it
->continuation_lines_width
+= it
->last_visible_x
;
9264 /* When moving by vpos, ensure that the iterator really
9265 advances to the next line (bug#847, bug#969). Fixme:
9266 do we need to do this in other circumstances? */
9267 if (it
->current_x
!= it
->last_visible_x
9268 && (op
& MOVE_TO_VPOS
)
9269 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9271 line_start_x
= it
->current_x
+ it
->pixel_width
9272 - it
->last_visible_x
;
9273 if (FRAME_WINDOW_P (it
->f
))
9275 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9276 struct font
*face_font
= face
->font
;
9278 /* When display_line produces a continued line
9279 that ends in a TAB, it skips a tab stop that
9280 is closer than the font's space character
9281 width (see x_produce_glyphs where it produces
9282 the stretch glyph which represents a TAB).
9283 We need to reproduce the same logic here. */
9284 eassert (face_font
);
9287 if (line_start_x
< face_font
->space_width
)
9289 += it
->tab_width
* face_font
->space_width
;
9292 set_iterator_to_next (it
, 0);
9296 it
->continuation_lines_width
+= it
->current_x
;
9303 /* Reset/increment for the next run. */
9304 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9305 it
->current_x
= line_start_x
;
9308 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9310 last_height
= it
->max_ascent
+ it
->max_descent
;
9311 it
->max_ascent
= it
->max_descent
= 0;
9316 /* On text terminals, we may stop at the end of a line in the middle
9317 of a multi-character glyph. If the glyph itself is continued,
9318 i.e. it is actually displayed on the next line, don't treat this
9319 stopping point as valid; move to the next line instead (unless
9320 that brings us offscreen). */
9321 if (!FRAME_WINDOW_P (it
->f
)
9323 && IT_CHARPOS (*it
) == to_charpos
9324 && it
->what
== IT_CHARACTER
9326 && it
->line_wrap
== WINDOW_WRAP
9327 && it
->current_x
== it
->last_visible_x
- 1
9330 && it
->vpos
< it
->w
->window_end_vpos
)
9332 it
->continuation_lines_width
+= it
->current_x
;
9333 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9334 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9336 last_height
= it
->max_ascent
+ it
->max_descent
;
9340 bidi_unshelve_cache (backup_data
, 1);
9342 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9344 return max_current_x
;
9348 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9350 If DY > 0, move IT backward at least that many pixels. DY = 0
9351 means move IT backward to the preceding line start or BEGV. This
9352 function may move over more than DY pixels if IT->current_y - DY
9353 ends up in the middle of a line; in this case IT->current_y will be
9354 set to the top of the line moved to. */
9357 move_it_vertically_backward (struct it
*it
, int dy
)
9361 void *it2data
= NULL
, *it3data
= NULL
;
9362 ptrdiff_t start_pos
;
9364 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9365 ptrdiff_t pos_limit
;
9370 start_pos
= IT_CHARPOS (*it
);
9372 /* Estimate how many newlines we must move back. */
9373 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9374 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9377 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9379 /* Set the iterator's position that many lines back. But don't go
9380 back more than NLINES full screen lines -- this wins a day with
9381 buffers which have very long lines. */
9382 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9383 back_to_previous_visible_line_start (it
);
9385 /* Reseat the iterator here. When moving backward, we don't want
9386 reseat to skip forward over invisible text, set up the iterator
9387 to deliver from overlay strings at the new position etc. So,
9388 use reseat_1 here. */
9389 reseat_1 (it
, it
->current
.pos
, 1);
9391 /* We are now surely at a line start. */
9392 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9393 reordering is in effect. */
9394 it
->continuation_lines_width
= 0;
9396 /* Move forward and see what y-distance we moved. First move to the
9397 start of the next line so that we get its height. We need this
9398 height to be able to tell whether we reached the specified
9400 SAVE_IT (it2
, *it
, it2data
);
9401 it2
.max_ascent
= it2
.max_descent
= 0;
9404 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9405 MOVE_TO_POS
| MOVE_TO_VPOS
);
9407 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9408 /* If we are in a display string which starts at START_POS,
9409 and that display string includes a newline, and we are
9410 right after that newline (i.e. at the beginning of a
9411 display line), exit the loop, because otherwise we will
9412 infloop, since move_it_to will see that it is already at
9413 START_POS and will not move. */
9414 || (it2
.method
== GET_FROM_STRING
9415 && IT_CHARPOS (it2
) == start_pos
9416 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9417 eassert (IT_CHARPOS (*it
) >= BEGV
);
9418 SAVE_IT (it3
, it2
, it3data
);
9420 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9421 eassert (IT_CHARPOS (*it
) >= BEGV
);
9422 /* H is the actual vertical distance from the position in *IT
9423 and the starting position. */
9424 h
= it2
.current_y
- it
->current_y
;
9425 /* NLINES is the distance in number of lines. */
9426 nlines
= it2
.vpos
- it
->vpos
;
9428 /* Correct IT's y and vpos position
9429 so that they are relative to the starting point. */
9435 /* DY == 0 means move to the start of the screen line. The
9436 value of nlines is > 0 if continuation lines were involved,
9437 or if the original IT position was at start of a line. */
9438 RESTORE_IT (it
, it
, it2data
);
9440 move_it_by_lines (it
, nlines
);
9441 /* The above code moves us to some position NLINES down,
9442 usually to its first glyph (leftmost in an L2R line), but
9443 that's not necessarily the start of the line, under bidi
9444 reordering. We want to get to the character position
9445 that is immediately after the newline of the previous
9448 && !it
->continuation_lines_width
9449 && !STRINGP (it
->string
)
9450 && IT_CHARPOS (*it
) > BEGV
9451 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9453 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9456 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9457 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9459 bidi_unshelve_cache (it3data
, 1);
9463 /* The y-position we try to reach, relative to *IT.
9464 Note that H has been subtracted in front of the if-statement. */
9465 int target_y
= it
->current_y
+ h
- dy
;
9466 int y0
= it3
.current_y
;
9470 RESTORE_IT (&it3
, &it3
, it3data
);
9471 y1
= line_bottom_y (&it3
);
9472 line_height
= y1
- y0
;
9473 RESTORE_IT (it
, it
, it2data
);
9474 /* If we did not reach target_y, try to move further backward if
9475 we can. If we moved too far backward, try to move forward. */
9476 if (target_y
< it
->current_y
9477 /* This is heuristic. In a window that's 3 lines high, with
9478 a line height of 13 pixels each, recentering with point
9479 on the bottom line will try to move -39/2 = 19 pixels
9480 backward. Try to avoid moving into the first line. */
9481 && (it
->current_y
- target_y
9482 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9483 && IT_CHARPOS (*it
) > BEGV
)
9485 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9486 target_y
- it
->current_y
));
9487 dy
= it
->current_y
- target_y
;
9488 goto move_further_back
;
9490 else if (target_y
>= it
->current_y
+ line_height
9491 && IT_CHARPOS (*it
) < ZV
)
9493 /* Should move forward by at least one line, maybe more.
9495 Note: Calling move_it_by_lines can be expensive on
9496 terminal frames, where compute_motion is used (via
9497 vmotion) to do the job, when there are very long lines
9498 and truncate-lines is nil. That's the reason for
9499 treating terminal frames specially here. */
9501 if (!FRAME_WINDOW_P (it
->f
))
9502 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9507 move_it_by_lines (it
, 1);
9509 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9516 /* Move IT by a specified amount of pixel lines DY. DY negative means
9517 move backwards. DY = 0 means move to start of screen line. At the
9518 end, IT will be on the start of a screen line. */
9521 move_it_vertically (struct it
*it
, int dy
)
9524 move_it_vertically_backward (it
, -dy
);
9527 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9528 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9529 MOVE_TO_POS
| MOVE_TO_Y
);
9530 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9532 /* If buffer ends in ZV without a newline, move to the start of
9533 the line to satisfy the post-condition. */
9534 if (IT_CHARPOS (*it
) == ZV
9536 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9537 move_it_by_lines (it
, 0);
9542 /* Move iterator IT past the end of the text line it is in. */
9545 move_it_past_eol (struct it
*it
)
9547 enum move_it_result rc
;
9549 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9550 if (rc
== MOVE_NEWLINE_OR_CR
)
9551 set_iterator_to_next (it
, 0);
9555 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9556 negative means move up. DVPOS == 0 means move to the start of the
9559 Optimization idea: If we would know that IT->f doesn't use
9560 a face with proportional font, we could be faster for
9561 truncate-lines nil. */
9564 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9567 /* The commented-out optimization uses vmotion on terminals. This
9568 gives bad results, because elements like it->what, on which
9569 callers such as pos_visible_p rely, aren't updated. */
9570 /* struct position pos;
9571 if (!FRAME_WINDOW_P (it->f))
9573 struct text_pos textpos;
9575 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9576 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9577 reseat (it, textpos, 1);
9578 it->vpos += pos.vpos;
9579 it->current_y += pos.vpos;
9585 /* DVPOS == 0 means move to the start of the screen line. */
9586 move_it_vertically_backward (it
, 0);
9587 /* Let next call to line_bottom_y calculate real line height. */
9592 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9593 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9595 /* Only move to the next buffer position if we ended up in a
9596 string from display property, not in an overlay string
9597 (before-string or after-string). That is because the
9598 latter don't conceal the underlying buffer position, so
9599 we can ask to move the iterator to the exact position we
9600 are interested in. Note that, even if we are already at
9601 IT_CHARPOS (*it), the call below is not a no-op, as it
9602 will detect that we are at the end of the string, pop the
9603 iterator, and compute it->current_x and it->hpos
9605 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9606 -1, -1, -1, MOVE_TO_POS
);
9612 void *it2data
= NULL
;
9613 ptrdiff_t start_charpos
, i
;
9615 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9616 bool hit_pos_limit
= false;
9617 ptrdiff_t pos_limit
;
9619 /* Start at the beginning of the screen line containing IT's
9620 position. This may actually move vertically backwards,
9621 in case of overlays, so adjust dvpos accordingly. */
9623 move_it_vertically_backward (it
, 0);
9626 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9627 screen lines, and reseat the iterator there. */
9628 start_charpos
= IT_CHARPOS (*it
);
9629 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9632 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9634 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9635 back_to_previous_visible_line_start (it
);
9636 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9637 hit_pos_limit
= true;
9638 reseat (it
, it
->current
.pos
, 1);
9640 /* Move further back if we end up in a string or an image. */
9641 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9643 /* First try to move to start of display line. */
9645 move_it_vertically_backward (it
, 0);
9647 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9649 /* If start of line is still in string or image,
9650 move further back. */
9651 back_to_previous_visible_line_start (it
);
9652 reseat (it
, it
->current
.pos
, 1);
9656 it
->current_x
= it
->hpos
= 0;
9658 /* Above call may have moved too far if continuation lines
9659 are involved. Scan forward and see if it did. */
9660 SAVE_IT (it2
, *it
, it2data
);
9661 it2
.vpos
= it2
.current_y
= 0;
9662 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9663 it
->vpos
-= it2
.vpos
;
9664 it
->current_y
-= it2
.current_y
;
9665 it
->current_x
= it
->hpos
= 0;
9667 /* If we moved too far back, move IT some lines forward. */
9668 if (it2
.vpos
> -dvpos
)
9670 int delta
= it2
.vpos
+ dvpos
;
9672 RESTORE_IT (&it2
, &it2
, it2data
);
9673 SAVE_IT (it2
, *it
, it2data
);
9674 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9675 /* Move back again if we got too far ahead. */
9676 if (IT_CHARPOS (*it
) >= start_charpos
)
9677 RESTORE_IT (it
, &it2
, it2data
);
9679 bidi_unshelve_cache (it2data
, 1);
9681 else if (hit_pos_limit
&& pos_limit
> BEGV
9682 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9684 /* If we hit the limit, but still didn't make it far enough
9685 back, that means there's a display string with a newline
9686 covering a large chunk of text, and that caused
9687 back_to_previous_visible_line_start try to go too far.
9688 Punish those who commit such atrocities by going back
9689 until we've reached DVPOS, after lifting the limit, which
9690 could make it slow for very long lines. "If it hurts,
9693 RESTORE_IT (it
, it
, it2data
);
9694 for (i
= -dvpos
; i
> 0; --i
)
9696 back_to_previous_visible_line_start (it
);
9699 reseat_1 (it
, it
->current
.pos
, 1);
9702 RESTORE_IT (it
, it
, it2data
);
9706 /* Return true if IT points into the middle of a display vector. */
9709 in_display_vector_p (struct it
*it
)
9711 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9712 && it
->current
.dpvec_index
> 0
9713 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9716 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9717 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9718 WINDOW must be a live window and defaults to the selected one. The
9719 return value is a cons of the maximum pixel-width of any text line and
9720 the maximum pixel-height of all text lines.
9722 The optional argument FROM, if non-nil, specifies the first text
9723 position and defaults to the minimum accessible position of the buffer.
9724 If FROM is t, use the minimum accessible position that is not a newline
9725 character. TO, if non-nil, specifies the last text position and
9726 defaults to the maximum accessible position of the buffer. If TO is t,
9727 use the maximum accessible position that is not a newline character.
9729 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9730 width that can be returned. X-LIMIT nil or omitted, means to use the
9731 pixel-width of WINDOW's body; use this if you do not intend to change
9732 the width of WINDOW. Use the maximum width WINDOW may assume if you
9733 intend to change WINDOW's width. In any case, text whose x-coordinate
9734 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9735 can take some time, it's always a good idea to make this argument as
9736 small as possible; in particular, if the buffer contains long lines that
9737 shall be truncated anyway.
9739 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9740 height that can be returned. Text lines whose y-coordinate is beyond
9741 Y-LIMIT are ignored. Since calculating the text height of a large
9742 buffer can take some time, it makes sense to specify this argument if
9743 the size of the buffer is unknown.
9745 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9746 include the height of the mode- or header-line of WINDOW in the return
9747 value. If it is either the symbol `mode-line' or `header-line', include
9748 only the height of that line, if present, in the return value. If t,
9749 include the height of both, if present, in the return value. */)
9750 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9751 Lisp_Object mode_and_header_line
)
9753 struct window
*w
= decode_live_window (window
);
9757 struct buffer
*old_buffer
= NULL
;
9758 ptrdiff_t start
, end
, pos
;
9759 struct text_pos startp
;
9760 void *itdata
= NULL
;
9761 int c
, max_y
= -1, x
= 0, y
= 0;
9767 if (b
!= current_buffer
)
9769 old_buffer
= current_buffer
;
9770 set_buffer_internal (b
);
9775 else if (EQ (from
, Qt
))
9778 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9779 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9781 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9786 CHECK_NUMBER_COERCE_MARKER (from
);
9787 start
= min (max (XINT (from
), BEGV
), ZV
);
9792 else if (EQ (to
, Qt
))
9795 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9796 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9798 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9803 CHECK_NUMBER_COERCE_MARKER (to
);
9804 end
= max (start
, min (XINT (to
), ZV
));
9807 if (!NILP (y_limit
))
9809 CHECK_NUMBER (y_limit
);
9810 max_y
= min (XINT (y_limit
), INT_MAX
);
9813 itdata
= bidi_shelve_cache ();
9814 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9815 start_display (&it
, w
, startp
);
9818 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9821 CHECK_NUMBER (x_limit
);
9822 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9823 /* Actually, we never want move_it_to stop at to_x. But to make
9824 sure that move_it_in_display_line_to always moves far enough,
9825 we set it to INT_MAX and specify MOVE_TO_X. */
9826 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9827 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9830 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9832 if (!EQ (mode_and_header_line
, Qheader_line
)
9833 && !EQ (mode_and_header_line
, Qt
))
9834 /* Do not count the header-line which was counted automatically by
9836 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9838 if (EQ (mode_and_header_line
, Qmode_line
)
9839 || EQ (mode_and_header_line
, Qt
))
9840 /* Do count the mode-line which is not included automatically by
9842 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9844 bidi_unshelve_cache (itdata
, 0);
9847 set_buffer_internal (old_buffer
);
9849 return Fcons (make_number (x
), make_number (y
));
9852 /***********************************************************************
9854 ***********************************************************************/
9857 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9861 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9863 Lisp_Object args
[3];
9864 Lisp_Object msg
, fmt
;
9867 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9871 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9873 args
[0] = fmt
= build_string (format
);
9876 msg
= Fformat (3, args
);
9878 len
= SBYTES (msg
) + 1;
9879 buffer
= SAFE_ALLOCA (len
);
9880 memcpy (buffer
, SDATA (msg
), len
);
9882 message_dolog (buffer
, len
- 1, 1, 0);
9889 /* Output a newline in the *Messages* buffer if "needs" one. */
9892 message_log_maybe_newline (void)
9894 if (message_log_need_newline
)
9895 message_dolog ("", 0, 1, 0);
9899 /* Add a string M of length NBYTES to the message log, optionally
9900 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9901 true, means interpret the contents of M as multibyte. This
9902 function calls low-level routines in order to bypass text property
9903 hooks, etc. which might not be safe to run.
9905 This may GC (insert may run before/after change hooks),
9906 so the buffer M must NOT point to a Lisp string. */
9909 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9911 const unsigned char *msg
= (const unsigned char *) m
;
9913 if (!NILP (Vmemory_full
))
9916 if (!NILP (Vmessage_log_max
))
9918 struct buffer
*oldbuf
;
9919 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9920 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9921 ptrdiff_t point_at_end
= 0;
9922 ptrdiff_t zv_at_end
= 0;
9923 Lisp_Object old_deactivate_mark
;
9924 struct gcpro gcpro1
;
9926 old_deactivate_mark
= Vdeactivate_mark
;
9927 oldbuf
= current_buffer
;
9929 /* Ensure the Messages buffer exists, and switch to it.
9930 If we created it, set the major-mode. */
9933 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9935 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9938 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9939 call0 (intern ("messages-buffer-mode"));
9942 bset_undo_list (current_buffer
, Qt
);
9943 bset_cache_long_scans (current_buffer
, Qnil
);
9945 oldpoint
= message_dolog_marker1
;
9946 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9947 oldbegv
= message_dolog_marker2
;
9948 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9949 oldzv
= message_dolog_marker3
;
9950 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9951 GCPRO1 (old_deactivate_mark
);
9959 BEGV_BYTE
= BEG_BYTE
;
9962 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9964 /* Insert the string--maybe converting multibyte to single byte
9965 or vice versa, so that all the text fits the buffer. */
9967 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9973 /* Convert a multibyte string to single-byte
9974 for the *Message* buffer. */
9975 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9977 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9978 work
[0] = CHAR_TO_BYTE8 (c
);
9979 insert_1_both (work
, 1, 1, 1, 0, 0);
9982 else if (! multibyte
9983 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9987 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9988 /* Convert a single-byte string to multibyte
9989 for the *Message* buffer. */
9990 for (i
= 0; i
< nbytes
; i
++)
9993 MAKE_CHAR_MULTIBYTE (c
);
9994 char_bytes
= CHAR_STRING (c
, str
);
9995 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9999 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
10003 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10006 insert_1_both ("\n", 1, 1, 1, 0, 0);
10008 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10010 this_bol_byte
= PT_BYTE
;
10012 /* See if this line duplicates the previous one.
10013 If so, combine duplicates. */
10014 if (this_bol
> BEG
)
10016 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10018 prev_bol_byte
= PT_BYTE
;
10020 dups
= message_log_check_duplicate (prev_bol_byte
,
10024 del_range_both (prev_bol
, prev_bol_byte
,
10025 this_bol
, this_bol_byte
, 0);
10028 char dupstr
[sizeof " [ times]"
10029 + INT_STRLEN_BOUND (printmax_t
)];
10031 /* If you change this format, don't forget to also
10032 change message_log_check_duplicate. */
10033 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10034 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10035 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10040 /* If we have more than the desired maximum number of lines
10041 in the *Messages* buffer now, delete the oldest ones.
10042 This is safe because we don't have undo in this buffer. */
10044 if (NATNUMP (Vmessage_log_max
))
10046 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10047 -XFASTINT (Vmessage_log_max
) - 1, 0);
10048 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10051 BEGV
= marker_position (oldbegv
);
10052 BEGV_BYTE
= marker_byte_position (oldbegv
);
10061 ZV
= marker_position (oldzv
);
10062 ZV_BYTE
= marker_byte_position (oldzv
);
10066 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10068 /* We can't do Fgoto_char (oldpoint) because it will run some
10070 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10071 marker_byte_position (oldpoint
));
10074 unchain_marker (XMARKER (oldpoint
));
10075 unchain_marker (XMARKER (oldbegv
));
10076 unchain_marker (XMARKER (oldzv
));
10078 /* We called insert_1_both above with its 5th argument (PREPARE)
10079 zero, which prevents insert_1_both from calling
10080 prepare_to_modify_buffer, which in turns prevents us from
10081 incrementing windows_or_buffers_changed even if *Messages* is
10082 shown in some window. So we must manually set
10083 windows_or_buffers_changed here to make up for that. */
10084 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10085 bset_redisplay (current_buffer
);
10087 set_buffer_internal (oldbuf
);
10089 message_log_need_newline
= !nlflag
;
10090 Vdeactivate_mark
= old_deactivate_mark
;
10095 /* We are at the end of the buffer after just having inserted a newline.
10096 (Note: We depend on the fact we won't be crossing the gap.)
10097 Check to see if the most recent message looks a lot like the previous one.
10098 Return 0 if different, 1 if the new one should just replace it, or a
10099 value N > 1 if we should also append " [N times]". */
10102 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10105 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10107 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10108 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10110 for (i
= 0; i
< len
; i
++)
10112 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10114 if (p1
[i
] != p2
[i
])
10120 if (*p1
++ == ' ' && *p1
++ == '[')
10123 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10124 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10131 /* Display an echo area message M with a specified length of NBYTES
10132 bytes. The string may include null characters. If M is not a
10133 string, clear out any existing message, and let the mini-buffer
10136 This function cancels echoing. */
10139 message3 (Lisp_Object m
)
10141 struct gcpro gcpro1
;
10144 clear_message (true, true);
10147 /* First flush out any partial line written with print. */
10148 message_log_maybe_newline ();
10151 ptrdiff_t nbytes
= SBYTES (m
);
10152 bool multibyte
= STRING_MULTIBYTE (m
);
10155 SAFE_ALLOCA_STRING (buffer
, m
);
10156 message_dolog (buffer
, nbytes
, 1, multibyte
);
10159 message3_nolog (m
);
10165 /* The non-logging version of message3.
10166 This does not cancel echoing, because it is used for echoing.
10167 Perhaps we need to make a separate function for echoing
10168 and make this cancel echoing. */
10171 message3_nolog (Lisp_Object m
)
10173 struct frame
*sf
= SELECTED_FRAME ();
10175 if (FRAME_INITIAL_P (sf
))
10177 if (noninteractive_need_newline
)
10178 putc ('\n', stderr
);
10179 noninteractive_need_newline
= 0;
10182 Lisp_Object s
= ENCODE_SYSTEM (m
);
10184 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10186 if (cursor_in_echo_area
== 0)
10187 fprintf (stderr
, "\n");
10190 /* Error messages get reported properly by cmd_error, so this must be just an
10191 informative message; if the frame hasn't really been initialized yet, just
10193 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10195 /* Get the frame containing the mini-buffer
10196 that the selected frame is using. */
10197 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10198 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10199 struct frame
*f
= XFRAME (frame
);
10201 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10202 Fmake_frame_visible (frame
);
10204 if (STRINGP (m
) && SCHARS (m
) > 0)
10207 if (minibuffer_auto_raise
)
10208 Fraise_frame (frame
);
10209 /* Assume we are not echoing.
10210 (If we are, echo_now will override this.) */
10211 echo_message_buffer
= Qnil
;
10214 clear_message (true, true);
10216 do_pending_window_change (false);
10217 echo_area_display (true);
10218 do_pending_window_change (false);
10219 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10220 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10225 /* Display a null-terminated echo area message M. If M is 0, clear
10226 out any existing message, and let the mini-buffer text show through.
10228 The buffer M must continue to exist until after the echo area gets
10229 cleared or some other message gets displayed there. Do not pass
10230 text that is stored in a Lisp string. Do not pass text in a buffer
10231 that was alloca'd. */
10234 message1 (const char *m
)
10236 message3 (m
? build_unibyte_string (m
) : Qnil
);
10240 /* The non-logging counterpart of message1. */
10243 message1_nolog (const char *m
)
10245 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10248 /* Display a message M which contains a single %s
10249 which gets replaced with STRING. */
10252 message_with_string (const char *m
, Lisp_Object string
, int log
)
10254 CHECK_STRING (string
);
10256 if (noninteractive
)
10260 /* ENCODE_SYSTEM below can GC and/or relocate the
10261 Lisp data, so make sure we don't use it here. */
10262 eassert (relocatable_string_data_p (m
) != 1);
10264 if (noninteractive_need_newline
)
10265 putc ('\n', stderr
);
10266 noninteractive_need_newline
= 0;
10267 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10268 if (!cursor_in_echo_area
)
10269 fprintf (stderr
, "\n");
10273 else if (INTERACTIVE
)
10275 /* The frame whose minibuffer we're going to display the message on.
10276 It may be larger than the selected frame, so we need
10277 to use its buffer, not the selected frame's buffer. */
10278 Lisp_Object mini_window
;
10279 struct frame
*f
, *sf
= SELECTED_FRAME ();
10281 /* Get the frame containing the minibuffer
10282 that the selected frame is using. */
10283 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10284 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10286 /* Error messages get reported properly by cmd_error, so this must be
10287 just an informative message; if the frame hasn't really been
10288 initialized yet, just toss it. */
10289 if (f
->glyphs_initialized_p
)
10291 Lisp_Object args
[2], msg
;
10292 struct gcpro gcpro1
, gcpro2
;
10294 args
[0] = build_string (m
);
10295 args
[1] = msg
= string
;
10296 GCPRO2 (args
[0], msg
);
10299 msg
= Fformat (2, args
);
10304 message3_nolog (msg
);
10308 /* Print should start at the beginning of the message
10309 buffer next time. */
10310 message_buf_print
= 0;
10316 /* Dump an informative message to the minibuf. If M is 0, clear out
10317 any existing message, and let the mini-buffer text show through. */
10320 vmessage (const char *m
, va_list ap
)
10322 if (noninteractive
)
10326 if (noninteractive_need_newline
)
10327 putc ('\n', stderr
);
10328 noninteractive_need_newline
= 0;
10329 vfprintf (stderr
, m
, ap
);
10330 if (cursor_in_echo_area
== 0)
10331 fprintf (stderr
, "\n");
10335 else if (INTERACTIVE
)
10337 /* The frame whose mini-buffer we're going to display the message
10338 on. It may be larger than the selected frame, so we need to
10339 use its buffer, not the selected frame's buffer. */
10340 Lisp_Object mini_window
;
10341 struct frame
*f
, *sf
= SELECTED_FRAME ();
10343 /* Get the frame containing the mini-buffer
10344 that the selected frame is using. */
10345 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10346 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10348 /* Error messages get reported properly by cmd_error, so this must be
10349 just an informative message; if the frame hasn't really been
10350 initialized yet, just toss it. */
10351 if (f
->glyphs_initialized_p
)
10356 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10358 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10360 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10362 message3 (make_string (message_buf
, len
));
10368 /* Print should start at the beginning of the message
10369 buffer next time. */
10370 message_buf_print
= 0;
10376 message (const char *m
, ...)
10386 /* The non-logging version of message. */
10389 message_nolog (const char *m
, ...)
10391 Lisp_Object old_log_max
;
10394 old_log_max
= Vmessage_log_max
;
10395 Vmessage_log_max
= Qnil
;
10397 Vmessage_log_max
= old_log_max
;
10403 /* Display the current message in the current mini-buffer. This is
10404 only called from error handlers in process.c, and is not time
10408 update_echo_area (void)
10410 if (!NILP (echo_area_buffer
[0]))
10412 Lisp_Object string
;
10413 string
= Fcurrent_message ();
10419 /* Make sure echo area buffers in `echo_buffers' are live.
10420 If they aren't, make new ones. */
10423 ensure_echo_area_buffers (void)
10427 for (i
= 0; i
< 2; ++i
)
10428 if (!BUFFERP (echo_buffer
[i
])
10429 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10432 Lisp_Object old_buffer
;
10435 old_buffer
= echo_buffer
[i
];
10436 echo_buffer
[i
] = Fget_buffer_create
10437 (make_formatted_string (name
, " *Echo Area %d*", i
));
10438 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10439 /* to force word wrap in echo area -
10440 it was decided to postpone this*/
10441 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10443 for (j
= 0; j
< 2; ++j
)
10444 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10445 echo_area_buffer
[j
] = echo_buffer
[i
];
10450 /* Call FN with args A1..A2 with either the current or last displayed
10451 echo_area_buffer as current buffer.
10453 WHICH zero means use the current message buffer
10454 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10455 from echo_buffer[] and clear it.
10457 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10458 suitable buffer from echo_buffer[] and clear it.
10460 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10461 that the current message becomes the last displayed one, make
10462 choose a suitable buffer for echo_area_buffer[0], and clear it.
10464 Value is what FN returns. */
10467 with_echo_area_buffer (struct window
*w
, int which
,
10468 int (*fn
) (ptrdiff_t, Lisp_Object
),
10469 ptrdiff_t a1
, Lisp_Object a2
)
10471 Lisp_Object buffer
;
10472 int this_one
, the_other
, clear_buffer_p
, rc
;
10473 ptrdiff_t count
= SPECPDL_INDEX ();
10475 /* If buffers aren't live, make new ones. */
10476 ensure_echo_area_buffers ();
10478 clear_buffer_p
= 0;
10481 this_one
= 0, the_other
= 1;
10482 else if (which
> 0)
10483 this_one
= 1, the_other
= 0;
10486 this_one
= 0, the_other
= 1;
10487 clear_buffer_p
= true;
10489 /* We need a fresh one in case the current echo buffer equals
10490 the one containing the last displayed echo area message. */
10491 if (!NILP (echo_area_buffer
[this_one
])
10492 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10493 echo_area_buffer
[this_one
] = Qnil
;
10496 /* Choose a suitable buffer from echo_buffer[] is we don't
10498 if (NILP (echo_area_buffer
[this_one
]))
10500 echo_area_buffer
[this_one
]
10501 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10502 ? echo_buffer
[the_other
]
10503 : echo_buffer
[this_one
]);
10504 clear_buffer_p
= true;
10507 buffer
= echo_area_buffer
[this_one
];
10509 /* Don't get confused by reusing the buffer used for echoing
10510 for a different purpose. */
10511 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10514 record_unwind_protect (unwind_with_echo_area_buffer
,
10515 with_echo_area_buffer_unwind_data (w
));
10517 /* Make the echo area buffer current. Note that for display
10518 purposes, it is not necessary that the displayed window's buffer
10519 == current_buffer, except for text property lookup. So, let's
10520 only set that buffer temporarily here without doing a full
10521 Fset_window_buffer. We must also change w->pointm, though,
10522 because otherwise an assertions in unshow_buffer fails, and Emacs
10524 set_buffer_internal_1 (XBUFFER (buffer
));
10527 wset_buffer (w
, buffer
);
10528 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10529 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10532 bset_undo_list (current_buffer
, Qt
);
10533 bset_read_only (current_buffer
, Qnil
);
10534 specbind (Qinhibit_read_only
, Qt
);
10535 specbind (Qinhibit_modification_hooks
, Qt
);
10537 if (clear_buffer_p
&& Z
> BEG
)
10538 del_range (BEG
, Z
);
10540 eassert (BEGV
>= BEG
);
10541 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10545 eassert (BEGV
>= BEG
);
10546 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10548 unbind_to (count
, Qnil
);
10553 /* Save state that should be preserved around the call to the function
10554 FN called in with_echo_area_buffer. */
10557 with_echo_area_buffer_unwind_data (struct window
*w
)
10560 Lisp_Object vector
, tmp
;
10562 /* Reduce consing by keeping one vector in
10563 Vwith_echo_area_save_vector. */
10564 vector
= Vwith_echo_area_save_vector
;
10565 Vwith_echo_area_save_vector
= Qnil
;
10568 vector
= Fmake_vector (make_number (11), Qnil
);
10570 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10571 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10572 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10576 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10577 ASET (vector
, i
, w
->contents
); ++i
;
10578 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10579 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10580 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10581 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10582 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10583 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10588 for (; i
< end
; ++i
)
10589 ASET (vector
, i
, Qnil
);
10592 eassert (i
== ASIZE (vector
));
10597 /* Restore global state from VECTOR which was created by
10598 with_echo_area_buffer_unwind_data. */
10601 unwind_with_echo_area_buffer (Lisp_Object vector
)
10603 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10604 Vdeactivate_mark
= AREF (vector
, 1);
10605 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10607 if (WINDOWP (AREF (vector
, 3)))
10610 Lisp_Object buffer
;
10612 w
= XWINDOW (AREF (vector
, 3));
10613 buffer
= AREF (vector
, 4);
10615 wset_buffer (w
, buffer
);
10616 set_marker_both (w
->pointm
, buffer
,
10617 XFASTINT (AREF (vector
, 5)),
10618 XFASTINT (AREF (vector
, 6)));
10619 set_marker_both (w
->old_pointm
, buffer
,
10620 XFASTINT (AREF (vector
, 7)),
10621 XFASTINT (AREF (vector
, 8)));
10622 set_marker_both (w
->start
, buffer
,
10623 XFASTINT (AREF (vector
, 9)),
10624 XFASTINT (AREF (vector
, 10)));
10627 Vwith_echo_area_save_vector
= vector
;
10631 /* Set up the echo area for use by print functions. MULTIBYTE_P
10632 non-zero means we will print multibyte. */
10635 setup_echo_area_for_printing (int multibyte_p
)
10637 /* If we can't find an echo area any more, exit. */
10638 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10639 Fkill_emacs (Qnil
);
10641 ensure_echo_area_buffers ();
10643 if (!message_buf_print
)
10645 /* A message has been output since the last time we printed.
10646 Choose a fresh echo area buffer. */
10647 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10648 echo_area_buffer
[0] = echo_buffer
[1];
10650 echo_area_buffer
[0] = echo_buffer
[0];
10652 /* Switch to that buffer and clear it. */
10653 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10654 bset_truncate_lines (current_buffer
, Qnil
);
10658 ptrdiff_t count
= SPECPDL_INDEX ();
10659 specbind (Qinhibit_read_only
, Qt
);
10660 /* Note that undo recording is always disabled. */
10661 del_range (BEG
, Z
);
10662 unbind_to (count
, Qnil
);
10664 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10666 /* Set up the buffer for the multibyteness we need. */
10668 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10669 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10671 /* Raise the frame containing the echo area. */
10672 if (minibuffer_auto_raise
)
10674 struct frame
*sf
= SELECTED_FRAME ();
10675 Lisp_Object mini_window
;
10676 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10677 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10680 message_log_maybe_newline ();
10681 message_buf_print
= 1;
10685 if (NILP (echo_area_buffer
[0]))
10687 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10688 echo_area_buffer
[0] = echo_buffer
[1];
10690 echo_area_buffer
[0] = echo_buffer
[0];
10693 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10695 /* Someone switched buffers between print requests. */
10696 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10697 bset_truncate_lines (current_buffer
, Qnil
);
10703 /* Display an echo area message in window W. Value is non-zero if W's
10704 height is changed. If display_last_displayed_message_p is
10705 non-zero, display the message that was last displayed, otherwise
10706 display the current message. */
10709 display_echo_area (struct window
*w
)
10711 int i
, no_message_p
, window_height_changed_p
;
10713 /* Temporarily disable garbage collections while displaying the echo
10714 area. This is done because a GC can print a message itself.
10715 That message would modify the echo area buffer's contents while a
10716 redisplay of the buffer is going on, and seriously confuse
10718 ptrdiff_t count
= inhibit_garbage_collection ();
10720 /* If there is no message, we must call display_echo_area_1
10721 nevertheless because it resizes the window. But we will have to
10722 reset the echo_area_buffer in question to nil at the end because
10723 with_echo_area_buffer will sets it to an empty buffer. */
10724 i
= display_last_displayed_message_p
? 1 : 0;
10725 no_message_p
= NILP (echo_area_buffer
[i
]);
10727 window_height_changed_p
10728 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10729 display_echo_area_1
,
10730 (intptr_t) w
, Qnil
);
10733 echo_area_buffer
[i
] = Qnil
;
10735 unbind_to (count
, Qnil
);
10736 return window_height_changed_p
;
10740 /* Helper for display_echo_area. Display the current buffer which
10741 contains the current echo area message in window W, a mini-window,
10742 a pointer to which is passed in A1. A2..A4 are currently not used.
10743 Change the height of W so that all of the message is displayed.
10744 Value is non-zero if height of W was changed. */
10747 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10750 struct window
*w
= (struct window
*) i1
;
10751 Lisp_Object window
;
10752 struct text_pos start
;
10753 int window_height_changed_p
= 0;
10755 /* Do this before displaying, so that we have a large enough glyph
10756 matrix for the display. If we can't get enough space for the
10757 whole text, display the last N lines. That works by setting w->start. */
10758 window_height_changed_p
= resize_mini_window (w
, 0);
10760 /* Use the starting position chosen by resize_mini_window. */
10761 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10764 clear_glyph_matrix (w
->desired_matrix
);
10765 XSETWINDOW (window
, w
);
10766 try_window (window
, start
, 0);
10768 return window_height_changed_p
;
10772 /* Resize the echo area window to exactly the size needed for the
10773 currently displayed message, if there is one. If a mini-buffer
10774 is active, don't shrink it. */
10777 resize_echo_area_exactly (void)
10779 if (BUFFERP (echo_area_buffer
[0])
10780 && WINDOWP (echo_area_window
))
10782 struct window
*w
= XWINDOW (echo_area_window
);
10783 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10784 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10785 (intptr_t) w
, resize_exactly
);
10788 windows_or_buffers_changed
= 42;
10789 update_mode_lines
= 30;
10790 redisplay_internal ();
10796 /* Callback function for with_echo_area_buffer, when used from
10797 resize_echo_area_exactly. A1 contains a pointer to the window to
10798 resize, EXACTLY non-nil means resize the mini-window exactly to the
10799 size of the text displayed. A3 and A4 are not used. Value is what
10800 resize_mini_window returns. */
10803 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10806 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10810 /* Resize mini-window W to fit the size of its contents. EXACT_P
10811 means size the window exactly to the size needed. Otherwise, it's
10812 only enlarged until W's buffer is empty.
10814 Set W->start to the right place to begin display. If the whole
10815 contents fit, start at the beginning. Otherwise, start so as
10816 to make the end of the contents appear. This is particularly
10817 important for y-or-n-p, but seems desirable generally.
10819 Value is non-zero if the window height has been changed. */
10822 resize_mini_window (struct window
*w
, int exact_p
)
10824 struct frame
*f
= XFRAME (w
->frame
);
10825 int window_height_changed_p
= 0;
10827 eassert (MINI_WINDOW_P (w
));
10829 /* By default, start display at the beginning. */
10830 set_marker_both (w
->start
, w
->contents
,
10831 BUF_BEGV (XBUFFER (w
->contents
)),
10832 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10834 /* Don't resize windows while redisplaying a window; it would
10835 confuse redisplay functions when the size of the window they are
10836 displaying changes from under them. Such a resizing can happen,
10837 for instance, when which-func prints a long message while
10838 we are running fontification-functions. We're running these
10839 functions with safe_call which binds inhibit-redisplay to t. */
10840 if (!NILP (Vinhibit_redisplay
))
10843 /* Nil means don't try to resize. */
10844 if (NILP (Vresize_mini_windows
)
10845 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10848 if (!FRAME_MINIBUF_ONLY_P (f
))
10851 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10852 + WINDOW_PIXEL_HEIGHT (w
));
10853 int unit
= FRAME_LINE_HEIGHT (f
);
10854 int height
, max_height
;
10855 struct text_pos start
;
10856 struct buffer
*old_current_buffer
= NULL
;
10858 if (current_buffer
!= XBUFFER (w
->contents
))
10860 old_current_buffer
= current_buffer
;
10861 set_buffer_internal (XBUFFER (w
->contents
));
10864 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10866 /* Compute the max. number of lines specified by the user. */
10867 if (FLOATP (Vmax_mini_window_height
))
10868 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10869 else if (INTEGERP (Vmax_mini_window_height
))
10870 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10872 max_height
= total_height
/ 4;
10874 /* Correct that max. height if it's bogus. */
10875 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10877 /* Find out the height of the text in the window. */
10878 if (it
.line_wrap
== TRUNCATE
)
10883 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10884 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10885 height
= it
.current_y
+ last_height
;
10887 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10888 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10891 /* Compute a suitable window start. */
10892 if (height
> max_height
)
10894 height
= (max_height
/ unit
) * unit
;
10895 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10896 move_it_vertically_backward (&it
, height
- unit
);
10897 start
= it
.current
.pos
;
10900 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10901 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10903 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10905 /* Let it grow only, until we display an empty message, in which
10906 case the window shrinks again. */
10907 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10909 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10911 FRAME_WINDOWS_FROZEN (f
) = 1;
10912 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10913 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10915 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10916 && (exact_p
|| BEGV
== ZV
))
10918 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10920 FRAME_WINDOWS_FROZEN (f
) = 0;
10921 shrink_mini_window (w
, 1);
10922 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10927 /* Always resize to exact size needed. */
10928 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10930 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10932 FRAME_WINDOWS_FROZEN (f
) = 1;
10933 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10934 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10936 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10938 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10940 FRAME_WINDOWS_FROZEN (f
) = 0;
10941 shrink_mini_window (w
, 1);
10945 FRAME_WINDOWS_FROZEN (f
) = 1;
10946 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10949 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10953 if (old_current_buffer
)
10954 set_buffer_internal (old_current_buffer
);
10957 return window_height_changed_p
;
10961 /* Value is the current message, a string, or nil if there is no
10962 current message. */
10965 current_message (void)
10969 if (!BUFFERP (echo_area_buffer
[0]))
10973 with_echo_area_buffer (0, 0, current_message_1
,
10974 (intptr_t) &msg
, Qnil
);
10976 echo_area_buffer
[0] = Qnil
;
10984 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10987 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10990 *msg
= make_buffer_string (BEG
, Z
, 1);
10997 /* Push the current message on Vmessage_stack for later restoration
10998 by restore_message. Value is non-zero if the current message isn't
10999 empty. This is a relatively infrequent operation, so it's not
11000 worth optimizing. */
11003 push_message (void)
11005 Lisp_Object msg
= current_message ();
11006 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11007 return STRINGP (msg
);
11011 /* Restore message display from the top of Vmessage_stack. */
11014 restore_message (void)
11016 eassert (CONSP (Vmessage_stack
));
11017 message3_nolog (XCAR (Vmessage_stack
));
11021 /* Handler for unwind-protect calling pop_message. */
11024 pop_message_unwind (void)
11026 /* Pop the top-most entry off Vmessage_stack. */
11027 eassert (CONSP (Vmessage_stack
));
11028 Vmessage_stack
= XCDR (Vmessage_stack
);
11032 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11033 exits. If the stack is not empty, we have a missing pop_message
11037 check_message_stack (void)
11039 if (!NILP (Vmessage_stack
))
11044 /* Truncate to NCHARS what will be displayed in the echo area the next
11045 time we display it---but don't redisplay it now. */
11048 truncate_echo_area (ptrdiff_t nchars
)
11051 echo_area_buffer
[0] = Qnil
;
11052 else if (!noninteractive
11054 && !NILP (echo_area_buffer
[0]))
11056 struct frame
*sf
= SELECTED_FRAME ();
11057 /* Error messages get reported properly by cmd_error, so this must be
11058 just an informative message; if the frame hasn't really been
11059 initialized yet, just toss it. */
11060 if (sf
->glyphs_initialized_p
)
11061 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11066 /* Helper function for truncate_echo_area. Truncate the current
11067 message to at most NCHARS characters. */
11070 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11072 if (BEG
+ nchars
< Z
)
11073 del_range (BEG
+ nchars
, Z
);
11075 echo_area_buffer
[0] = Qnil
;
11079 /* Set the current message to STRING. */
11082 set_message (Lisp_Object string
)
11084 eassert (STRINGP (string
));
11086 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11088 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11089 message_buf_print
= 0;
11090 help_echo_showing_p
= 0;
11092 if (STRINGP (Vdebug_on_message
)
11093 && STRINGP (string
)
11094 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11095 call_debugger (list2 (Qerror
, string
));
11099 /* Helper function for set_message. First argument is ignored and second
11100 argument has the same meaning as for set_message.
11101 This function is called with the echo area buffer being current. */
11104 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11106 eassert (STRINGP (string
));
11108 /* Change multibyteness of the echo buffer appropriately. */
11109 if (message_enable_multibyte
11110 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11111 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11113 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11114 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11115 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11117 /* Insert new message at BEG. */
11118 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11120 /* This function takes care of single/multibyte conversion.
11121 We just have to ensure that the echo area buffer has the right
11122 setting of enable_multibyte_characters. */
11123 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11129 /* Clear messages. CURRENT_P non-zero means clear the current
11130 message. LAST_DISPLAYED_P non-zero means clear the message
11134 clear_message (bool current_p
, bool last_displayed_p
)
11138 echo_area_buffer
[0] = Qnil
;
11139 message_cleared_p
= true;
11142 if (last_displayed_p
)
11143 echo_area_buffer
[1] = Qnil
;
11145 message_buf_print
= 0;
11148 /* Clear garbaged frames.
11150 This function is used where the old redisplay called
11151 redraw_garbaged_frames which in turn called redraw_frame which in
11152 turn called clear_frame. The call to clear_frame was a source of
11153 flickering. I believe a clear_frame is not necessary. It should
11154 suffice in the new redisplay to invalidate all current matrices,
11155 and ensure a complete redisplay of all windows. */
11158 clear_garbaged_frames (void)
11160 if (frame_garbaged
)
11162 Lisp_Object tail
, frame
;
11164 FOR_EACH_FRAME (tail
, frame
)
11166 struct frame
*f
= XFRAME (frame
);
11168 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11173 clear_current_matrices (f
);
11174 fset_redisplay (f
);
11175 f
->garbaged
= false;
11176 f
->resized_p
= false;
11180 frame_garbaged
= false;
11185 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11186 is non-zero update selected_frame. Value is non-zero if the
11187 mini-windows height has been changed. */
11190 echo_area_display (bool update_frame_p
)
11192 Lisp_Object mini_window
;
11195 bool window_height_changed_p
= false;
11196 struct frame
*sf
= SELECTED_FRAME ();
11198 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11199 w
= XWINDOW (mini_window
);
11200 f
= XFRAME (WINDOW_FRAME (w
));
11202 /* Don't display if frame is invisible or not yet initialized. */
11203 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11206 #ifdef HAVE_WINDOW_SYSTEM
11207 /* When Emacs starts, selected_frame may be the initial terminal
11208 frame. If we let this through, a message would be displayed on
11210 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11212 #endif /* HAVE_WINDOW_SYSTEM */
11214 /* Redraw garbaged frames. */
11215 clear_garbaged_frames ();
11217 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11219 echo_area_window
= mini_window
;
11220 window_height_changed_p
= display_echo_area (w
);
11221 w
->must_be_updated_p
= true;
11223 /* Update the display, unless called from redisplay_internal.
11224 Also don't update the screen during redisplay itself. The
11225 update will happen at the end of redisplay, and an update
11226 here could cause confusion. */
11227 if (update_frame_p
&& !redisplaying_p
)
11231 /* If the display update has been interrupted by pending
11232 input, update mode lines in the frame. Due to the
11233 pending input, it might have been that redisplay hasn't
11234 been called, so that mode lines above the echo area are
11235 garbaged. This looks odd, so we prevent it here. */
11236 if (!display_completed
)
11237 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11239 if (window_height_changed_p
11240 /* Don't do this if Emacs is shutting down. Redisplay
11241 needs to run hooks. */
11242 && !NILP (Vrun_hooks
))
11244 /* Must update other windows. Likewise as in other
11245 cases, don't let this update be interrupted by
11247 ptrdiff_t count
= SPECPDL_INDEX ();
11248 specbind (Qredisplay_dont_pause
, Qt
);
11249 windows_or_buffers_changed
= 44;
11250 redisplay_internal ();
11251 unbind_to (count
, Qnil
);
11253 else if (FRAME_WINDOW_P (f
) && n
== 0)
11255 /* Window configuration is the same as before.
11256 Can do with a display update of the echo area,
11257 unless we displayed some mode lines. */
11258 update_single_window (w
);
11262 update_frame (f
, true, true);
11264 /* If cursor is in the echo area, make sure that the next
11265 redisplay displays the minibuffer, so that the cursor will
11266 be replaced with what the minibuffer wants. */
11267 if (cursor_in_echo_area
)
11268 wset_redisplay (XWINDOW (mini_window
));
11271 else if (!EQ (mini_window
, selected_window
))
11272 wset_redisplay (XWINDOW (mini_window
));
11274 /* Last displayed message is now the current message. */
11275 echo_area_buffer
[1] = echo_area_buffer
[0];
11276 /* Inform read_char that we're not echoing. */
11277 echo_message_buffer
= Qnil
;
11279 /* Prevent redisplay optimization in redisplay_internal by resetting
11280 this_line_start_pos. This is done because the mini-buffer now
11281 displays the message instead of its buffer text. */
11282 if (EQ (mini_window
, selected_window
))
11283 CHARPOS (this_line_start_pos
) = 0;
11285 return window_height_changed_p
;
11288 /* Nonzero if W's buffer was changed but not saved. */
11291 window_buffer_changed (struct window
*w
)
11293 struct buffer
*b
= XBUFFER (w
->contents
);
11295 eassert (BUFFER_LIVE_P (b
));
11297 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11300 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11303 mode_line_update_needed (struct window
*w
)
11305 return (w
->column_number_displayed
!= -1
11306 && !(PT
== w
->last_point
&& !window_outdated (w
))
11307 && (w
->column_number_displayed
!= current_column ()));
11310 /* Nonzero if window start of W is frozen and may not be changed during
11314 window_frozen_p (struct window
*w
)
11316 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11318 Lisp_Object window
;
11320 XSETWINDOW (window
, w
);
11321 if (MINI_WINDOW_P (w
))
11323 else if (EQ (window
, selected_window
))
11325 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11326 && EQ (window
, Vminibuf_scroll_window
))
11327 /* This special window can't be frozen too. */
11335 /***********************************************************************
11336 Mode Lines and Frame Titles
11337 ***********************************************************************/
11339 /* A buffer for constructing non-propertized mode-line strings and
11340 frame titles in it; allocated from the heap in init_xdisp and
11341 resized as needed in store_mode_line_noprop_char. */
11343 static char *mode_line_noprop_buf
;
11345 /* The buffer's end, and a current output position in it. */
11347 static char *mode_line_noprop_buf_end
;
11348 static char *mode_line_noprop_ptr
;
11350 #define MODE_LINE_NOPROP_LEN(start) \
11351 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11354 MODE_LINE_DISPLAY
= 0,
11358 } mode_line_target
;
11360 /* Alist that caches the results of :propertize.
11361 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11362 static Lisp_Object mode_line_proptrans_alist
;
11364 /* List of strings making up the mode-line. */
11365 static Lisp_Object mode_line_string_list
;
11367 /* Base face property when building propertized mode line string. */
11368 static Lisp_Object mode_line_string_face
;
11369 static Lisp_Object mode_line_string_face_prop
;
11372 /* Unwind data for mode line strings */
11374 static Lisp_Object Vmode_line_unwind_vector
;
11377 format_mode_line_unwind_data (struct frame
*target_frame
,
11378 struct buffer
*obuf
,
11380 int save_proptrans
)
11382 Lisp_Object vector
, tmp
;
11384 /* Reduce consing by keeping one vector in
11385 Vwith_echo_area_save_vector. */
11386 vector
= Vmode_line_unwind_vector
;
11387 Vmode_line_unwind_vector
= Qnil
;
11390 vector
= Fmake_vector (make_number (10), Qnil
);
11392 ASET (vector
, 0, make_number (mode_line_target
));
11393 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11394 ASET (vector
, 2, mode_line_string_list
);
11395 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11396 ASET (vector
, 4, mode_line_string_face
);
11397 ASET (vector
, 5, mode_line_string_face_prop
);
11400 XSETBUFFER (tmp
, obuf
);
11403 ASET (vector
, 6, tmp
);
11404 ASET (vector
, 7, owin
);
11407 /* Similarly to `with-selected-window', if the operation selects
11408 a window on another frame, we must restore that frame's
11409 selected window, and (for a tty) the top-frame. */
11410 ASET (vector
, 8, target_frame
->selected_window
);
11411 if (FRAME_TERMCAP_P (target_frame
))
11412 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11419 unwind_format_mode_line (Lisp_Object vector
)
11421 Lisp_Object old_window
= AREF (vector
, 7);
11422 Lisp_Object target_frame_window
= AREF (vector
, 8);
11423 Lisp_Object old_top_frame
= AREF (vector
, 9);
11425 mode_line_target
= XINT (AREF (vector
, 0));
11426 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11427 mode_line_string_list
= AREF (vector
, 2);
11428 if (! EQ (AREF (vector
, 3), Qt
))
11429 mode_line_proptrans_alist
= AREF (vector
, 3);
11430 mode_line_string_face
= AREF (vector
, 4);
11431 mode_line_string_face_prop
= AREF (vector
, 5);
11433 /* Select window before buffer, since it may change the buffer. */
11434 if (!NILP (old_window
))
11436 /* If the operation that we are unwinding had selected a window
11437 on a different frame, reset its frame-selected-window. For a
11438 text terminal, reset its top-frame if necessary. */
11439 if (!NILP (target_frame_window
))
11442 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11444 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11445 Fselect_window (target_frame_window
, Qt
);
11447 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11448 Fselect_frame (old_top_frame
, Qt
);
11451 Fselect_window (old_window
, Qt
);
11454 if (!NILP (AREF (vector
, 6)))
11456 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11457 ASET (vector
, 6, Qnil
);
11460 Vmode_line_unwind_vector
= vector
;
11464 /* Store a single character C for the frame title in mode_line_noprop_buf.
11465 Re-allocate mode_line_noprop_buf if necessary. */
11468 store_mode_line_noprop_char (char c
)
11470 /* If output position has reached the end of the allocated buffer,
11471 increase the buffer's size. */
11472 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11474 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11475 ptrdiff_t size
= len
;
11476 mode_line_noprop_buf
=
11477 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11478 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11479 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11482 *mode_line_noprop_ptr
++ = c
;
11486 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11487 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11488 characters that yield more columns than PRECISION; PRECISION <= 0
11489 means copy the whole string. Pad with spaces until FIELD_WIDTH
11490 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11491 pad. Called from display_mode_element when it is used to build a
11495 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11497 const unsigned char *str
= (const unsigned char *) string
;
11499 ptrdiff_t dummy
, nbytes
;
11501 /* Copy at most PRECISION chars from STR. */
11502 nbytes
= strlen (string
);
11503 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11505 store_mode_line_noprop_char (*str
++);
11507 /* Fill up with spaces until FIELD_WIDTH reached. */
11508 while (field_width
> 0
11509 && n
< field_width
)
11511 store_mode_line_noprop_char (' ');
11518 /***********************************************************************
11520 ***********************************************************************/
11522 #ifdef HAVE_WINDOW_SYSTEM
11524 /* Set the title of FRAME, if it has changed. The title format is
11525 Vicon_title_format if FRAME is iconified, otherwise it is
11526 frame_title_format. */
11529 x_consider_frame_title (Lisp_Object frame
)
11531 struct frame
*f
= XFRAME (frame
);
11533 if (FRAME_WINDOW_P (f
)
11534 || FRAME_MINIBUF_ONLY_P (f
)
11535 || f
->explicit_name
)
11537 /* Do we have more than one visible frame on this X display? */
11538 Lisp_Object tail
, other_frame
, fmt
;
11539 ptrdiff_t title_start
;
11543 ptrdiff_t count
= SPECPDL_INDEX ();
11545 FOR_EACH_FRAME (tail
, other_frame
)
11547 struct frame
*tf
= XFRAME (other_frame
);
11550 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11551 && !FRAME_MINIBUF_ONLY_P (tf
)
11552 && !EQ (other_frame
, tip_frame
)
11553 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11557 /* Set global variable indicating that multiple frames exist. */
11558 multiple_frames
= CONSP (tail
);
11560 /* Switch to the buffer of selected window of the frame. Set up
11561 mode_line_target so that display_mode_element will output into
11562 mode_line_noprop_buf; then display the title. */
11563 record_unwind_protect (unwind_format_mode_line
,
11564 format_mode_line_unwind_data
11565 (f
, current_buffer
, selected_window
, 0));
11567 Fselect_window (f
->selected_window
, Qt
);
11568 set_buffer_internal_1
11569 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11570 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11572 mode_line_target
= MODE_LINE_TITLE
;
11573 title_start
= MODE_LINE_NOPROP_LEN (0);
11574 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11575 NULL
, DEFAULT_FACE_ID
);
11576 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11577 len
= MODE_LINE_NOPROP_LEN (title_start
);
11578 title
= mode_line_noprop_buf
+ title_start
;
11579 unbind_to (count
, Qnil
);
11581 /* Set the title only if it's changed. This avoids consing in
11582 the common case where it hasn't. (If it turns out that we've
11583 already wasted too much time by walking through the list with
11584 display_mode_element, then we might need to optimize at a
11585 higher level than this.) */
11586 if (! STRINGP (f
->name
)
11587 || SBYTES (f
->name
) != len
11588 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11589 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11593 #endif /* not HAVE_WINDOW_SYSTEM */
11596 /***********************************************************************
11598 ***********************************************************************/
11600 /* Non-zero if we will not redisplay all visible windows. */
11601 #define REDISPLAY_SOME_P() \
11602 ((windows_or_buffers_changed == 0 \
11603 || windows_or_buffers_changed == REDISPLAY_SOME) \
11604 && (update_mode_lines == 0 \
11605 || update_mode_lines == REDISPLAY_SOME))
11607 /* Prepare for redisplay by updating menu-bar item lists when
11608 appropriate. This can call eval. */
11611 prepare_menu_bars (void)
11613 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11614 bool some_windows
= REDISPLAY_SOME_P ();
11615 struct gcpro gcpro1
, gcpro2
;
11616 Lisp_Object tooltip_frame
;
11618 #ifdef HAVE_WINDOW_SYSTEM
11619 tooltip_frame
= tip_frame
;
11621 tooltip_frame
= Qnil
;
11624 if (FUNCTIONP (Vpre_redisplay_function
))
11626 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11627 if (all_windows
&& some_windows
)
11629 Lisp_Object ws
= window_list ();
11630 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11632 Lisp_Object
this = XCAR (ws
);
11633 struct window
*w
= XWINDOW (this);
11635 || XFRAME (w
->frame
)->redisplay
11636 || XBUFFER (w
->contents
)->text
->redisplay
)
11638 windows
= Fcons (this, windows
);
11642 safe__call1 (true, Vpre_redisplay_function
, windows
);
11645 /* Update all frame titles based on their buffer names, etc. We do
11646 this before the menu bars so that the buffer-menu will show the
11647 up-to-date frame titles. */
11648 #ifdef HAVE_WINDOW_SYSTEM
11651 Lisp_Object tail
, frame
;
11653 FOR_EACH_FRAME (tail
, frame
)
11655 struct frame
*f
= XFRAME (frame
);
11656 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11660 && !XBUFFER (w
->contents
)->text
->redisplay
)
11663 if (!EQ (frame
, tooltip_frame
)
11664 && (FRAME_ICONIFIED_P (f
)
11665 || FRAME_VISIBLE_P (f
) == 1
11666 /* Exclude TTY frames that are obscured because they
11667 are not the top frame on their console. This is
11668 because x_consider_frame_title actually switches
11669 to the frame, which for TTY frames means it is
11670 marked as garbaged, and will be completely
11671 redrawn on the next redisplay cycle. This causes
11672 TTY frames to be completely redrawn, when there
11673 are more than one of them, even though nothing
11674 should be changed on display. */
11675 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11676 x_consider_frame_title (frame
);
11679 #endif /* HAVE_WINDOW_SYSTEM */
11681 /* Update the menu bar item lists, if appropriate. This has to be
11682 done before any actual redisplay or generation of display lines. */
11686 Lisp_Object tail
, frame
;
11687 ptrdiff_t count
= SPECPDL_INDEX ();
11688 /* 1 means that update_menu_bar has run its hooks
11689 so any further calls to update_menu_bar shouldn't do so again. */
11690 int menu_bar_hooks_run
= 0;
11692 record_unwind_save_match_data ();
11694 FOR_EACH_FRAME (tail
, frame
)
11696 struct frame
*f
= XFRAME (frame
);
11697 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11699 /* Ignore tooltip frame. */
11700 if (EQ (frame
, tooltip_frame
))
11706 && !XBUFFER (w
->contents
)->text
->redisplay
)
11709 /* If a window on this frame changed size, report that to
11710 the user and clear the size-change flag. */
11711 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11713 Lisp_Object functions
;
11715 /* Clear flag first in case we get an error below. */
11716 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11717 functions
= Vwindow_size_change_functions
;
11718 GCPRO2 (tail
, functions
);
11720 while (CONSP (functions
))
11722 if (!EQ (XCAR (functions
), Qt
))
11723 call1 (XCAR (functions
), frame
);
11724 functions
= XCDR (functions
);
11730 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11731 #ifdef HAVE_WINDOW_SYSTEM
11732 update_tool_bar (f
, 0);
11737 unbind_to (count
, Qnil
);
11741 struct frame
*sf
= SELECTED_FRAME ();
11742 update_menu_bar (sf
, 1, 0);
11743 #ifdef HAVE_WINDOW_SYSTEM
11744 update_tool_bar (sf
, 1);
11750 /* Update the menu bar item list for frame F. This has to be done
11751 before we start to fill in any display lines, because it can call
11754 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11756 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11757 already ran the menu bar hooks for this redisplay, so there
11758 is no need to run them again. The return value is the
11759 updated value of this flag, to pass to the next call. */
11762 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11764 Lisp_Object window
;
11765 register struct window
*w
;
11767 /* If called recursively during a menu update, do nothing. This can
11768 happen when, for instance, an activate-menubar-hook causes a
11770 if (inhibit_menubar_update
)
11773 window
= FRAME_SELECTED_WINDOW (f
);
11774 w
= XWINDOW (window
);
11776 if (FRAME_WINDOW_P (f
)
11778 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11779 || defined (HAVE_NS) || defined (USE_GTK)
11780 FRAME_EXTERNAL_MENU_BAR (f
)
11782 FRAME_MENU_BAR_LINES (f
) > 0
11784 : FRAME_MENU_BAR_LINES (f
) > 0)
11786 /* If the user has switched buffers or windows, we need to
11787 recompute to reflect the new bindings. But we'll
11788 recompute when update_mode_lines is set too; that means
11789 that people can use force-mode-line-update to request
11790 that the menu bar be recomputed. The adverse effect on
11791 the rest of the redisplay algorithm is about the same as
11792 windows_or_buffers_changed anyway. */
11793 if (windows_or_buffers_changed
11794 /* This used to test w->update_mode_line, but we believe
11795 there is no need to recompute the menu in that case. */
11796 || update_mode_lines
11797 || window_buffer_changed (w
))
11799 struct buffer
*prev
= current_buffer
;
11800 ptrdiff_t count
= SPECPDL_INDEX ();
11802 specbind (Qinhibit_menubar_update
, Qt
);
11804 set_buffer_internal_1 (XBUFFER (w
->contents
));
11805 if (save_match_data
)
11806 record_unwind_save_match_data ();
11807 if (NILP (Voverriding_local_map_menu_flag
))
11809 specbind (Qoverriding_terminal_local_map
, Qnil
);
11810 specbind (Qoverriding_local_map
, Qnil
);
11815 /* Run the Lucid hook. */
11816 safe_run_hooks (Qactivate_menubar_hook
);
11818 /* If it has changed current-menubar from previous value,
11819 really recompute the menu-bar from the value. */
11820 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11821 call0 (Qrecompute_lucid_menubar
);
11823 safe_run_hooks (Qmenu_bar_update_hook
);
11828 XSETFRAME (Vmenu_updating_frame
, f
);
11829 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11831 /* Redisplay the menu bar in case we changed it. */
11832 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11833 || defined (HAVE_NS) || defined (USE_GTK)
11834 if (FRAME_WINDOW_P (f
))
11836 #if defined (HAVE_NS)
11837 /* All frames on Mac OS share the same menubar. So only
11838 the selected frame should be allowed to set it. */
11839 if (f
== SELECTED_FRAME ())
11841 set_frame_menubar (f
, 0, 0);
11844 /* On a terminal screen, the menu bar is an ordinary screen
11845 line, and this makes it get updated. */
11846 w
->update_mode_line
= 1;
11847 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11848 /* In the non-toolkit version, the menu bar is an ordinary screen
11849 line, and this makes it get updated. */
11850 w
->update_mode_line
= 1;
11851 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11853 unbind_to (count
, Qnil
);
11854 set_buffer_internal_1 (prev
);
11861 /***********************************************************************
11863 ***********************************************************************/
11865 #ifdef HAVE_WINDOW_SYSTEM
11867 /* Select `frame' temporarily without running all the code in
11869 FIXME: Maybe do_switch_frame should be trimmed down similarly
11870 when `norecord' is set. */
11872 fast_set_selected_frame (Lisp_Object frame
)
11874 if (!EQ (selected_frame
, frame
))
11876 selected_frame
= frame
;
11877 selected_window
= XFRAME (frame
)->selected_window
;
11881 /* Update the tool-bar item list for frame F. This has to be done
11882 before we start to fill in any display lines. Called from
11883 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11884 and restore it here. */
11887 update_tool_bar (struct frame
*f
, int save_match_data
)
11889 #if defined (USE_GTK) || defined (HAVE_NS)
11890 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11892 int do_update
= (WINDOWP (f
->tool_bar_window
)
11893 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11898 Lisp_Object window
;
11901 window
= FRAME_SELECTED_WINDOW (f
);
11902 w
= XWINDOW (window
);
11904 /* If the user has switched buffers or windows, we need to
11905 recompute to reflect the new bindings. But we'll
11906 recompute when update_mode_lines is set too; that means
11907 that people can use force-mode-line-update to request
11908 that the menu bar be recomputed. The adverse effect on
11909 the rest of the redisplay algorithm is about the same as
11910 windows_or_buffers_changed anyway. */
11911 if (windows_or_buffers_changed
11912 || w
->update_mode_line
11913 || update_mode_lines
11914 || window_buffer_changed (w
))
11916 struct buffer
*prev
= current_buffer
;
11917 ptrdiff_t count
= SPECPDL_INDEX ();
11918 Lisp_Object frame
, new_tool_bar
;
11919 int new_n_tool_bar
;
11920 struct gcpro gcpro1
;
11922 /* Set current_buffer to the buffer of the selected
11923 window of the frame, so that we get the right local
11925 set_buffer_internal_1 (XBUFFER (w
->contents
));
11927 /* Save match data, if we must. */
11928 if (save_match_data
)
11929 record_unwind_save_match_data ();
11931 /* Make sure that we don't accidentally use bogus keymaps. */
11932 if (NILP (Voverriding_local_map_menu_flag
))
11934 specbind (Qoverriding_terminal_local_map
, Qnil
);
11935 specbind (Qoverriding_local_map
, Qnil
);
11938 GCPRO1 (new_tool_bar
);
11940 /* We must temporarily set the selected frame to this frame
11941 before calling tool_bar_items, because the calculation of
11942 the tool-bar keymap uses the selected frame (see
11943 `tool-bar-make-keymap' in tool-bar.el). */
11944 eassert (EQ (selected_window
,
11945 /* Since we only explicitly preserve selected_frame,
11946 check that selected_window would be redundant. */
11947 XFRAME (selected_frame
)->selected_window
));
11948 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11949 XSETFRAME (frame
, f
);
11950 fast_set_selected_frame (frame
);
11952 /* Build desired tool-bar items from keymaps. */
11954 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11957 /* Redisplay the tool-bar if we changed it. */
11958 if (new_n_tool_bar
!= f
->n_tool_bar_items
11959 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11961 /* Redisplay that happens asynchronously due to an expose event
11962 may access f->tool_bar_items. Make sure we update both
11963 variables within BLOCK_INPUT so no such event interrupts. */
11965 fset_tool_bar_items (f
, new_tool_bar
);
11966 f
->n_tool_bar_items
= new_n_tool_bar
;
11967 w
->update_mode_line
= 1;
11973 unbind_to (count
, Qnil
);
11974 set_buffer_internal_1 (prev
);
11979 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11981 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11982 F's desired tool-bar contents. F->tool_bar_items must have
11983 been set up previously by calling prepare_menu_bars. */
11986 build_desired_tool_bar_string (struct frame
*f
)
11988 int i
, size
, size_needed
;
11989 struct gcpro gcpro1
, gcpro2
;
11990 Lisp_Object image
, plist
;
11992 image
= plist
= Qnil
;
11993 GCPRO2 (image
, plist
);
11995 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11996 Otherwise, make a new string. */
11998 /* The size of the string we might be able to reuse. */
11999 size
= (STRINGP (f
->desired_tool_bar_string
)
12000 ? SCHARS (f
->desired_tool_bar_string
)
12003 /* We need one space in the string for each image. */
12004 size_needed
= f
->n_tool_bar_items
;
12006 /* Reuse f->desired_tool_bar_string, if possible. */
12007 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12008 fset_desired_tool_bar_string
12009 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12012 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12013 struct gcpro gcpro1
;
12015 Fremove_text_properties (make_number (0), make_number (size
),
12016 props
, f
->desired_tool_bar_string
);
12020 /* Put a `display' property on the string for the images to display,
12021 put a `menu_item' property on tool-bar items with a value that
12022 is the index of the item in F's tool-bar item vector. */
12023 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12025 #define PROP(IDX) \
12026 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12028 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12029 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12030 int hmargin
, vmargin
, relief
, idx
, end
;
12032 /* If image is a vector, choose the image according to the
12034 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12035 if (VECTORP (image
))
12039 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12040 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12043 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12044 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12046 eassert (ASIZE (image
) >= idx
);
12047 image
= AREF (image
, idx
);
12052 /* Ignore invalid image specifications. */
12053 if (!valid_image_p (image
))
12056 /* Display the tool-bar button pressed, or depressed. */
12057 plist
= Fcopy_sequence (XCDR (image
));
12059 /* Compute margin and relief to draw. */
12060 relief
= (tool_bar_button_relief
>= 0
12061 ? tool_bar_button_relief
12062 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12063 hmargin
= vmargin
= relief
;
12065 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12066 INT_MAX
- max (hmargin
, vmargin
)))
12068 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12069 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12071 else if (CONSP (Vtool_bar_button_margin
))
12073 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12074 INT_MAX
- hmargin
))
12075 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12077 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12078 INT_MAX
- vmargin
))
12079 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12082 if (auto_raise_tool_bar_buttons_p
)
12084 /* Add a `:relief' property to the image spec if the item is
12088 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12095 /* If image is selected, display it pressed, i.e. with a
12096 negative relief. If it's not selected, display it with a
12098 plist
= Fplist_put (plist
, QCrelief
,
12100 ? make_number (-relief
)
12101 : make_number (relief
)));
12106 /* Put a margin around the image. */
12107 if (hmargin
|| vmargin
)
12109 if (hmargin
== vmargin
)
12110 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12112 plist
= Fplist_put (plist
, QCmargin
,
12113 Fcons (make_number (hmargin
),
12114 make_number (vmargin
)));
12117 /* If button is not enabled, and we don't have special images
12118 for the disabled state, make the image appear disabled by
12119 applying an appropriate algorithm to it. */
12120 if (!enabled_p
&& idx
< 0)
12121 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12123 /* Put a `display' text property on the string for the image to
12124 display. Put a `menu-item' property on the string that gives
12125 the start of this item's properties in the tool-bar items
12127 image
= Fcons (Qimage
, plist
);
12128 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12129 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12130 struct gcpro gcpro1
;
12133 /* Let the last image hide all remaining spaces in the tool bar
12134 string. The string can be longer than needed when we reuse a
12135 previous string. */
12136 if (i
+ 1 == f
->n_tool_bar_items
)
12137 end
= SCHARS (f
->desired_tool_bar_string
);
12140 Fadd_text_properties (make_number (i
), make_number (end
),
12141 props
, f
->desired_tool_bar_string
);
12150 /* Display one line of the tool-bar of frame IT->f.
12152 HEIGHT specifies the desired height of the tool-bar line.
12153 If the actual height of the glyph row is less than HEIGHT, the
12154 row's height is increased to HEIGHT, and the icons are centered
12155 vertically in the new height.
12157 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12158 count a final empty row in case the tool-bar width exactly matches
12163 display_tool_bar_line (struct it
*it
, int height
)
12165 struct glyph_row
*row
= it
->glyph_row
;
12166 int max_x
= it
->last_visible_x
;
12167 struct glyph
*last
;
12169 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12170 clear_glyph_row (row
);
12171 row
->enabled_p
= true;
12172 row
->y
= it
->current_y
;
12174 /* Note that this isn't made use of if the face hasn't a box,
12175 so there's no need to check the face here. */
12176 it
->start_of_box_run_p
= 1;
12178 while (it
->current_x
< max_x
)
12180 int x
, n_glyphs_before
, i
, nglyphs
;
12181 struct it it_before
;
12183 /* Get the next display element. */
12184 if (!get_next_display_element (it
))
12186 /* Don't count empty row if we are counting needed tool-bar lines. */
12187 if (height
< 0 && !it
->hpos
)
12192 /* Produce glyphs. */
12193 n_glyphs_before
= row
->used
[TEXT_AREA
];
12196 PRODUCE_GLYPHS (it
);
12198 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12200 x
= it_before
.current_x
;
12201 while (i
< nglyphs
)
12203 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12205 if (x
+ glyph
->pixel_width
> max_x
)
12207 /* Glyph doesn't fit on line. Backtrack. */
12208 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12210 /* If this is the only glyph on this line, it will never fit on the
12211 tool-bar, so skip it. But ensure there is at least one glyph,
12212 so we don't accidentally disable the tool-bar. */
12213 if (n_glyphs_before
== 0
12214 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12220 x
+= glyph
->pixel_width
;
12224 /* Stop at line end. */
12225 if (ITERATOR_AT_END_OF_LINE_P (it
))
12228 set_iterator_to_next (it
, 1);
12233 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12235 /* Use default face for the border below the tool bar.
12237 FIXME: When auto-resize-tool-bars is grow-only, there is
12238 no additional border below the possibly empty tool-bar lines.
12239 So to make the extra empty lines look "normal", we have to
12240 use the tool-bar face for the border too. */
12241 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12242 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12243 it
->face_id
= DEFAULT_FACE_ID
;
12245 extend_face_to_end_of_line (it
);
12246 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12247 last
->right_box_line_p
= 1;
12248 if (last
== row
->glyphs
[TEXT_AREA
])
12249 last
->left_box_line_p
= 1;
12251 /* Make line the desired height and center it vertically. */
12252 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12254 /* Don't add more than one line height. */
12255 height
%= FRAME_LINE_HEIGHT (it
->f
);
12256 it
->max_ascent
+= height
/ 2;
12257 it
->max_descent
+= (height
+ 1) / 2;
12260 compute_line_metrics (it
);
12262 /* If line is empty, make it occupy the rest of the tool-bar. */
12263 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12265 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12266 row
->visible_height
= row
->height
;
12267 row
->ascent
= row
->phys_ascent
= 0;
12268 row
->extra_line_spacing
= 0;
12271 row
->full_width_p
= 1;
12272 row
->continued_p
= 0;
12273 row
->truncated_on_left_p
= 0;
12274 row
->truncated_on_right_p
= 0;
12276 it
->current_x
= it
->hpos
= 0;
12277 it
->current_y
+= row
->height
;
12283 /* Value is the number of pixels needed to make all tool-bar items of
12284 frame F visible. The actual number of glyph rows needed is
12285 returned in *N_ROWS if non-NULL. */
12287 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12289 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12291 /* tool_bar_height is called from redisplay_tool_bar after building
12292 the desired matrix, so use (unused) mode-line row as temporary row to
12293 avoid destroying the first tool-bar row. */
12294 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12296 /* Initialize an iterator for iteration over
12297 F->desired_tool_bar_string in the tool-bar window of frame F. */
12298 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12299 temp_row
->reversed_p
= false;
12300 it
.first_visible_x
= 0;
12301 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12302 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12303 it
.paragraph_embedding
= L2R
;
12305 while (!ITERATOR_AT_END_P (&it
))
12307 clear_glyph_row (temp_row
);
12308 it
.glyph_row
= temp_row
;
12309 display_tool_bar_line (&it
, -1);
12311 clear_glyph_row (temp_row
);
12313 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12315 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12318 return it
.current_y
;
12320 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12323 #endif /* !USE_GTK && !HAVE_NS */
12325 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12327 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12328 If FRAME is nil or omitted, use the selected frame. Optional argument
12329 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12330 (Lisp_Object frame
, Lisp_Object pixelwise
)
12334 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12335 struct frame
*f
= decode_any_frame (frame
);
12337 if (WINDOWP (f
->tool_bar_window
)
12338 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12340 update_tool_bar (f
, 1);
12341 if (f
->n_tool_bar_items
)
12343 build_desired_tool_bar_string (f
);
12344 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12349 return make_number (height
);
12353 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12354 height should be changed. */
12356 redisplay_tool_bar (struct frame
*f
)
12358 #if defined (USE_GTK) || defined (HAVE_NS)
12360 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12361 update_frame_tool_bar (f
);
12364 #else /* !USE_GTK && !HAVE_NS */
12368 struct glyph_row
*row
;
12370 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12371 do anything. This means you must start with tool-bar-lines
12372 non-zero to get the auto-sizing effect. Or in other words, you
12373 can turn off tool-bars by specifying tool-bar-lines zero. */
12374 if (!WINDOWP (f
->tool_bar_window
)
12375 || (w
= XWINDOW (f
->tool_bar_window
),
12376 WINDOW_TOTAL_LINES (w
) == 0))
12379 /* Set up an iterator for the tool-bar window. */
12380 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12381 it
.first_visible_x
= 0;
12382 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12383 row
= it
.glyph_row
;
12384 row
->reversed_p
= false;
12386 /* Build a string that represents the contents of the tool-bar. */
12387 build_desired_tool_bar_string (f
);
12388 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12389 /* FIXME: This should be controlled by a user option. But it
12390 doesn't make sense to have an R2L tool bar if the menu bar cannot
12391 be drawn also R2L, and making the menu bar R2L is tricky due
12392 toolkit-specific code that implements it. If an R2L tool bar is
12393 ever supported, display_tool_bar_line should also be augmented to
12394 call unproduce_glyphs like display_line and display_string
12396 it
.paragraph_embedding
= L2R
;
12398 if (f
->n_tool_bar_rows
== 0)
12400 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12402 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12404 x_change_tool_bar_height (f
, new_height
);
12405 frame_default_tool_bar_height
= new_height
;
12406 /* Always do that now. */
12407 clear_glyph_matrix (w
->desired_matrix
);
12408 f
->fonts_changed
= 1;
12413 /* Display as many lines as needed to display all tool-bar items. */
12415 if (f
->n_tool_bar_rows
> 0)
12417 int border
, rows
, height
, extra
;
12419 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12420 border
= XINT (Vtool_bar_border
);
12421 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12422 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12423 else if (EQ (Vtool_bar_border
, Qborder_width
))
12424 border
= f
->border_width
;
12430 rows
= f
->n_tool_bar_rows
;
12431 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12432 extra
= it
.last_visible_y
- border
- height
* rows
;
12434 while (it
.current_y
< it
.last_visible_y
)
12437 if (extra
> 0 && rows
-- > 0)
12439 h
= (extra
+ rows
- 1) / rows
;
12442 display_tool_bar_line (&it
, height
+ h
);
12447 while (it
.current_y
< it
.last_visible_y
)
12448 display_tool_bar_line (&it
, 0);
12451 /* It doesn't make much sense to try scrolling in the tool-bar
12452 window, so don't do it. */
12453 w
->desired_matrix
->no_scrolling_p
= 1;
12454 w
->must_be_updated_p
= 1;
12456 if (!NILP (Vauto_resize_tool_bars
))
12458 int change_height_p
= 0;
12460 /* If we couldn't display everything, change the tool-bar's
12461 height if there is room for more. */
12462 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12463 change_height_p
= 1;
12465 /* We subtract 1 because display_tool_bar_line advances the
12466 glyph_row pointer before returning to its caller. We want to
12467 examine the last glyph row produced by
12468 display_tool_bar_line. */
12469 row
= it
.glyph_row
- 1;
12471 /* If there are blank lines at the end, except for a partially
12472 visible blank line at the end that is smaller than
12473 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12474 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12475 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12476 change_height_p
= 1;
12478 /* If row displays tool-bar items, but is partially visible,
12479 change the tool-bar's height. */
12480 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12481 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12482 change_height_p
= 1;
12484 /* Resize windows as needed by changing the `tool-bar-lines'
12485 frame parameter. */
12486 if (change_height_p
)
12489 int new_height
= tool_bar_height (f
, &nrows
, 1);
12491 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12492 && !f
->minimize_tool_bar_window_p
)
12493 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12494 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12495 f
->minimize_tool_bar_window_p
= 0;
12497 if (change_height_p
)
12499 x_change_tool_bar_height (f
, new_height
);
12500 frame_default_tool_bar_height
= new_height
;
12501 clear_glyph_matrix (w
->desired_matrix
);
12502 f
->n_tool_bar_rows
= nrows
;
12503 f
->fonts_changed
= 1;
12510 f
->minimize_tool_bar_window_p
= 0;
12513 #endif /* USE_GTK || HAVE_NS */
12516 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12518 /* Get information about the tool-bar item which is displayed in GLYPH
12519 on frame F. Return in *PROP_IDX the index where tool-bar item
12520 properties start in F->tool_bar_items. Value is zero if
12521 GLYPH doesn't display a tool-bar item. */
12524 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12530 /* This function can be called asynchronously, which means we must
12531 exclude any possibility that Fget_text_property signals an
12533 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12534 charpos
= max (0, charpos
);
12536 /* Get the text property `menu-item' at pos. The value of that
12537 property is the start index of this item's properties in
12538 F->tool_bar_items. */
12539 prop
= Fget_text_property (make_number (charpos
),
12540 Qmenu_item
, f
->current_tool_bar_string
);
12541 if (INTEGERP (prop
))
12543 *prop_idx
= XINT (prop
);
12553 /* Get information about the tool-bar item at position X/Y on frame F.
12554 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12555 the current matrix of the tool-bar window of F, or NULL if not
12556 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12557 item in F->tool_bar_items. Value is
12559 -1 if X/Y is not on a tool-bar item
12560 0 if X/Y is on the same item that was highlighted before.
12564 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12565 int *hpos
, int *vpos
, int *prop_idx
)
12567 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12568 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12571 /* Find the glyph under X/Y. */
12572 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12573 if (*glyph
== NULL
)
12576 /* Get the start of this tool-bar item's properties in
12577 f->tool_bar_items. */
12578 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12581 /* Is mouse on the highlighted item? */
12582 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12583 && *vpos
>= hlinfo
->mouse_face_beg_row
12584 && *vpos
<= hlinfo
->mouse_face_end_row
12585 && (*vpos
> hlinfo
->mouse_face_beg_row
12586 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12587 && (*vpos
< hlinfo
->mouse_face_end_row
12588 || *hpos
< hlinfo
->mouse_face_end_col
12589 || hlinfo
->mouse_face_past_end
))
12597 Handle mouse button event on the tool-bar of frame F, at
12598 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12599 0 for button release. MODIFIERS is event modifiers for button
12603 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12606 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12607 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12608 int hpos
, vpos
, prop_idx
;
12609 struct glyph
*glyph
;
12610 Lisp_Object enabled_p
;
12613 /* If not on the highlighted tool-bar item, and mouse-highlight is
12614 non-nil, return. This is so we generate the tool-bar button
12615 click only when the mouse button is released on the same item as
12616 where it was pressed. However, when mouse-highlight is disabled,
12617 generate the click when the button is released regardless of the
12618 highlight, since tool-bar items are not highlighted in that
12620 frame_to_window_pixel_xy (w
, &x
, &y
);
12621 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12623 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12626 /* When mouse-highlight is off, generate the click for the item
12627 where the button was pressed, disregarding where it was
12629 if (NILP (Vmouse_highlight
) && !down_p
)
12630 prop_idx
= f
->last_tool_bar_item
;
12632 /* If item is disabled, do nothing. */
12633 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12634 if (NILP (enabled_p
))
12639 /* Show item in pressed state. */
12640 if (!NILP (Vmouse_highlight
))
12641 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12642 f
->last_tool_bar_item
= prop_idx
;
12646 Lisp_Object key
, frame
;
12647 struct input_event event
;
12648 EVENT_INIT (event
);
12650 /* Show item in released state. */
12651 if (!NILP (Vmouse_highlight
))
12652 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12654 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12656 XSETFRAME (frame
, f
);
12657 event
.kind
= TOOL_BAR_EVENT
;
12658 event
.frame_or_window
= frame
;
12660 kbd_buffer_store_event (&event
);
12662 event
.kind
= TOOL_BAR_EVENT
;
12663 event
.frame_or_window
= frame
;
12665 event
.modifiers
= modifiers
;
12666 kbd_buffer_store_event (&event
);
12667 f
->last_tool_bar_item
= -1;
12672 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12673 tool-bar window-relative coordinates X/Y. Called from
12674 note_mouse_highlight. */
12677 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12679 Lisp_Object window
= f
->tool_bar_window
;
12680 struct window
*w
= XWINDOW (window
);
12681 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12682 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12684 struct glyph
*glyph
;
12685 struct glyph_row
*row
;
12687 Lisp_Object enabled_p
;
12689 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12690 int mouse_down_p
, rc
;
12692 /* Function note_mouse_highlight is called with negative X/Y
12693 values when mouse moves outside of the frame. */
12694 if (x
<= 0 || y
<= 0)
12696 clear_mouse_face (hlinfo
);
12700 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12703 /* Not on tool-bar item. */
12704 clear_mouse_face (hlinfo
);
12708 /* On same tool-bar item as before. */
12709 goto set_help_echo
;
12711 clear_mouse_face (hlinfo
);
12713 /* Mouse is down, but on different tool-bar item? */
12714 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12715 && f
== dpyinfo
->last_mouse_frame
);
12717 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12720 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12722 /* If tool-bar item is not enabled, don't highlight it. */
12723 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12724 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12726 /* Compute the x-position of the glyph. In front and past the
12727 image is a space. We include this in the highlighted area. */
12728 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12729 for (i
= x
= 0; i
< hpos
; ++i
)
12730 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12732 /* Record this as the current active region. */
12733 hlinfo
->mouse_face_beg_col
= hpos
;
12734 hlinfo
->mouse_face_beg_row
= vpos
;
12735 hlinfo
->mouse_face_beg_x
= x
;
12736 hlinfo
->mouse_face_past_end
= 0;
12738 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12739 hlinfo
->mouse_face_end_row
= vpos
;
12740 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12741 hlinfo
->mouse_face_window
= window
;
12742 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12744 /* Display it as active. */
12745 show_mouse_face (hlinfo
, draw
);
12750 /* Set help_echo_string to a help string to display for this tool-bar item.
12751 XTread_socket does the rest. */
12752 help_echo_object
= help_echo_window
= Qnil
;
12753 help_echo_pos
= -1;
12754 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12755 if (NILP (help_echo_string
))
12756 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12759 #endif /* !USE_GTK && !HAVE_NS */
12761 #endif /* HAVE_WINDOW_SYSTEM */
12765 /************************************************************************
12766 Horizontal scrolling
12767 ************************************************************************/
12769 static int hscroll_window_tree (Lisp_Object
);
12770 static int hscroll_windows (Lisp_Object
);
12772 /* For all leaf windows in the window tree rooted at WINDOW, set their
12773 hscroll value so that PT is (i) visible in the window, and (ii) so
12774 that it is not within a certain margin at the window's left and
12775 right border. Value is non-zero if any window's hscroll has been
12779 hscroll_window_tree (Lisp_Object window
)
12781 int hscrolled_p
= 0;
12782 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12783 int hscroll_step_abs
= 0;
12784 double hscroll_step_rel
= 0;
12786 if (hscroll_relative_p
)
12788 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12789 if (hscroll_step_rel
< 0)
12791 hscroll_relative_p
= 0;
12792 hscroll_step_abs
= 0;
12795 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12797 hscroll_step_abs
= XINT (Vhscroll_step
);
12798 if (hscroll_step_abs
< 0)
12799 hscroll_step_abs
= 0;
12802 hscroll_step_abs
= 0;
12804 while (WINDOWP (window
))
12806 struct window
*w
= XWINDOW (window
);
12808 if (WINDOWP (w
->contents
))
12809 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12810 else if (w
->cursor
.vpos
>= 0)
12813 int text_area_width
;
12814 struct glyph_row
*cursor_row
;
12815 struct glyph_row
*bottom_row
;
12818 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12819 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12820 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12822 cursor_row
= bottom_row
- 1;
12824 if (!cursor_row
->enabled_p
)
12826 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12827 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12828 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12830 cursor_row
= bottom_row
- 1;
12832 row_r2l_p
= cursor_row
->reversed_p
;
12834 text_area_width
= window_box_width (w
, TEXT_AREA
);
12836 /* Scroll when cursor is inside this scroll margin. */
12837 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12839 /* If the position of this window's point has explicitly
12840 changed, no more suspend auto hscrolling. */
12841 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12842 w
->suspend_auto_hscroll
= 0;
12844 /* Remember window point. */
12845 Fset_marker (w
->old_pointm
,
12846 ((w
== XWINDOW (selected_window
))
12847 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12848 : Fmarker_position (w
->pointm
)),
12851 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12852 && w
->suspend_auto_hscroll
== 0
12853 /* In some pathological cases, like restoring a window
12854 configuration into a frame that is much smaller than
12855 the one from which the configuration was saved, we
12856 get glyph rows whose start and end have zero buffer
12857 positions, which we cannot handle below. Just skip
12859 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12860 /* For left-to-right rows, hscroll when cursor is either
12861 (i) inside the right hscroll margin, or (ii) if it is
12862 inside the left margin and the window is already
12865 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12866 || (cursor_row
->enabled_p
12867 && cursor_row
->truncated_on_right_p
12868 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12869 /* For right-to-left rows, the logic is similar,
12870 except that rules for scrolling to left and right
12871 are reversed. E.g., if cursor.x <= h_margin, we
12872 need to hscroll "to the right" unconditionally,
12873 and that will scroll the screen to the left so as
12874 to reveal the next portion of the row. */
12876 && ((cursor_row
->enabled_p
12877 /* FIXME: It is confusing to set the
12878 truncated_on_right_p flag when R2L rows
12879 are actually truncated on the left. */
12880 && cursor_row
->truncated_on_right_p
12881 && w
->cursor
.x
<= h_margin
)
12883 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12887 struct buffer
*saved_current_buffer
;
12891 /* Find point in a display of infinite width. */
12892 saved_current_buffer
= current_buffer
;
12893 current_buffer
= XBUFFER (w
->contents
);
12895 if (w
== XWINDOW (selected_window
))
12898 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12900 /* Move iterator to pt starting at cursor_row->start in
12901 a line with infinite width. */
12902 init_to_row_start (&it
, w
, cursor_row
);
12903 it
.last_visible_x
= INFINITY
;
12904 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12905 current_buffer
= saved_current_buffer
;
12907 /* Position cursor in window. */
12908 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12909 hscroll
= max (0, (it
.current_x
12910 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12911 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12912 : (text_area_width
/ 2))))
12913 / FRAME_COLUMN_WIDTH (it
.f
);
12914 else if ((!row_r2l_p
12915 && w
->cursor
.x
>= text_area_width
- h_margin
)
12916 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12918 if (hscroll_relative_p
)
12919 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12922 wanted_x
= text_area_width
12923 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12926 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12930 if (hscroll_relative_p
)
12931 wanted_x
= text_area_width
* hscroll_step_rel
12934 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12937 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12939 hscroll
= max (hscroll
, w
->min_hscroll
);
12941 /* Don't prevent redisplay optimizations if hscroll
12942 hasn't changed, as it will unnecessarily slow down
12944 if (w
->hscroll
!= hscroll
)
12946 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12947 w
->hscroll
= hscroll
;
12956 /* Value is non-zero if hscroll of any leaf window has been changed. */
12957 return hscrolled_p
;
12961 /* Set hscroll so that cursor is visible and not inside horizontal
12962 scroll margins for all windows in the tree rooted at WINDOW. See
12963 also hscroll_window_tree above. Value is non-zero if any window's
12964 hscroll has been changed. If it has, desired matrices on the frame
12965 of WINDOW are cleared. */
12968 hscroll_windows (Lisp_Object window
)
12970 int hscrolled_p
= hscroll_window_tree (window
);
12972 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12973 return hscrolled_p
;
12978 /************************************************************************
12980 ************************************************************************/
12982 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12983 to a non-zero value. This is sometimes handy to have in a debugger
12988 /* First and last unchanged row for try_window_id. */
12990 static int debug_first_unchanged_at_end_vpos
;
12991 static int debug_last_unchanged_at_beg_vpos
;
12993 /* Delta vpos and y. */
12995 static int debug_dvpos
, debug_dy
;
12997 /* Delta in characters and bytes for try_window_id. */
12999 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13001 /* Values of window_end_pos and window_end_vpos at the end of
13004 static ptrdiff_t debug_end_vpos
;
13006 /* Append a string to W->desired_matrix->method. FMT is a printf
13007 format string. If trace_redisplay_p is true also printf the
13008 resulting string to stderr. */
13010 static void debug_method_add (struct window
*, char const *, ...)
13011 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13014 debug_method_add (struct window
*w
, char const *fmt
, ...)
13017 char *method
= w
->desired_matrix
->method
;
13018 int len
= strlen (method
);
13019 int size
= sizeof w
->desired_matrix
->method
;
13020 int remaining
= size
- len
- 1;
13023 if (len
&& remaining
)
13026 --remaining
, ++len
;
13029 va_start (ap
, fmt
);
13030 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13033 if (trace_redisplay_p
)
13034 fprintf (stderr
, "%p (%s): %s\n",
13036 ((BUFFERP (w
->contents
)
13037 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13038 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13043 #endif /* GLYPH_DEBUG */
13046 /* Value is non-zero if all changes in window W, which displays
13047 current_buffer, are in the text between START and END. START is a
13048 buffer position, END is given as a distance from Z. Used in
13049 redisplay_internal for display optimization. */
13052 text_outside_line_unchanged_p (struct window
*w
,
13053 ptrdiff_t start
, ptrdiff_t end
)
13055 int unchanged_p
= 1;
13057 /* If text or overlays have changed, see where. */
13058 if (window_outdated (w
))
13060 /* Gap in the line? */
13061 if (GPT
< start
|| Z
- GPT
< end
)
13064 /* Changes start in front of the line, or end after it? */
13066 && (BEG_UNCHANGED
< start
- 1
13067 || END_UNCHANGED
< end
))
13070 /* If selective display, can't optimize if changes start at the
13071 beginning of the line. */
13073 && INTEGERP (BVAR (current_buffer
, selective_display
))
13074 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13075 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13078 /* If there are overlays at the start or end of the line, these
13079 may have overlay strings with newlines in them. A change at
13080 START, for instance, may actually concern the display of such
13081 overlay strings as well, and they are displayed on different
13082 lines. So, quickly rule out this case. (For the future, it
13083 might be desirable to implement something more telling than
13084 just BEG/END_UNCHANGED.) */
13087 if (BEG
+ BEG_UNCHANGED
== start
13088 && overlay_touches_p (start
))
13090 if (END_UNCHANGED
== end
13091 && overlay_touches_p (Z
- end
))
13095 /* Under bidi reordering, adding or deleting a character in the
13096 beginning of a paragraph, before the first strong directional
13097 character, can change the base direction of the paragraph (unless
13098 the buffer specifies a fixed paragraph direction), which will
13099 require to redisplay the whole paragraph. It might be worthwhile
13100 to find the paragraph limits and widen the range of redisplayed
13101 lines to that, but for now just give up this optimization. */
13102 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13103 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13107 return unchanged_p
;
13111 /* Do a frame update, taking possible shortcuts into account. This is
13112 the main external entry point for redisplay.
13114 If the last redisplay displayed an echo area message and that message
13115 is no longer requested, we clear the echo area or bring back the
13116 mini-buffer if that is in use. */
13121 redisplay_internal ();
13126 overlay_arrow_string_or_property (Lisp_Object var
)
13130 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13133 return Voverlay_arrow_string
;
13136 /* Return 1 if there are any overlay-arrows in current_buffer. */
13138 overlay_arrow_in_current_buffer_p (void)
13142 for (vlist
= Voverlay_arrow_variable_list
;
13144 vlist
= XCDR (vlist
))
13146 Lisp_Object var
= XCAR (vlist
);
13149 if (!SYMBOLP (var
))
13151 val
= find_symbol_value (var
);
13153 && current_buffer
== XMARKER (val
)->buffer
)
13160 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13164 overlay_arrows_changed_p (void)
13168 for (vlist
= Voverlay_arrow_variable_list
;
13170 vlist
= XCDR (vlist
))
13172 Lisp_Object var
= XCAR (vlist
);
13173 Lisp_Object val
, pstr
;
13175 if (!SYMBOLP (var
))
13177 val
= find_symbol_value (var
);
13178 if (!MARKERP (val
))
13180 if (! EQ (COERCE_MARKER (val
),
13181 Fget (var
, Qlast_arrow_position
))
13182 || ! (pstr
= overlay_arrow_string_or_property (var
),
13183 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13189 /* Mark overlay arrows to be updated on next redisplay. */
13192 update_overlay_arrows (int up_to_date
)
13196 for (vlist
= Voverlay_arrow_variable_list
;
13198 vlist
= XCDR (vlist
))
13200 Lisp_Object var
= XCAR (vlist
);
13202 if (!SYMBOLP (var
))
13205 if (up_to_date
> 0)
13207 Lisp_Object val
= find_symbol_value (var
);
13208 Fput (var
, Qlast_arrow_position
,
13209 COERCE_MARKER (val
));
13210 Fput (var
, Qlast_arrow_string
,
13211 overlay_arrow_string_or_property (var
));
13213 else if (up_to_date
< 0
13214 || !NILP (Fget (var
, Qlast_arrow_position
)))
13216 Fput (var
, Qlast_arrow_position
, Qt
);
13217 Fput (var
, Qlast_arrow_string
, Qt
);
13223 /* Return overlay arrow string to display at row.
13224 Return integer (bitmap number) for arrow bitmap in left fringe.
13225 Return nil if no overlay arrow. */
13228 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13232 for (vlist
= Voverlay_arrow_variable_list
;
13234 vlist
= XCDR (vlist
))
13236 Lisp_Object var
= XCAR (vlist
);
13239 if (!SYMBOLP (var
))
13242 val
= find_symbol_value (var
);
13245 && current_buffer
== XMARKER (val
)->buffer
13246 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13248 if (FRAME_WINDOW_P (it
->f
)
13249 /* FIXME: if ROW->reversed_p is set, this should test
13250 the right fringe, not the left one. */
13251 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13253 #ifdef HAVE_WINDOW_SYSTEM
13254 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13257 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13258 return make_number (fringe_bitmap
);
13261 return make_number (-1); /* Use default arrow bitmap. */
13263 return overlay_arrow_string_or_property (var
);
13270 /* Return 1 if point moved out of or into a composition. Otherwise
13271 return 0. PREV_BUF and PREV_PT are the last point buffer and
13272 position. BUF and PT are the current point buffer and position. */
13275 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13276 struct buffer
*buf
, ptrdiff_t pt
)
13278 ptrdiff_t start
, end
;
13280 Lisp_Object buffer
;
13282 XSETBUFFER (buffer
, buf
);
13283 /* Check a composition at the last point if point moved within the
13285 if (prev_buf
== buf
)
13288 /* Point didn't move. */
13291 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13292 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13293 && composition_valid_p (start
, end
, prop
)
13294 && start
< prev_pt
&& end
> prev_pt
)
13295 /* The last point was within the composition. Return 1 iff
13296 point moved out of the composition. */
13297 return (pt
<= start
|| pt
>= end
);
13300 /* Check a composition at the current point. */
13301 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13302 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13303 && composition_valid_p (start
, end
, prop
)
13304 && start
< pt
&& end
> pt
);
13307 /* Reconsider the clip changes of buffer which is displayed in W. */
13310 reconsider_clip_changes (struct window
*w
)
13312 struct buffer
*b
= XBUFFER (w
->contents
);
13314 if (b
->clip_changed
13315 && w
->window_end_valid
13316 && w
->current_matrix
->buffer
== b
13317 && w
->current_matrix
->zv
== BUF_ZV (b
)
13318 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13319 b
->clip_changed
= 0;
13321 /* If display wasn't paused, and W is not a tool bar window, see if
13322 point has been moved into or out of a composition. In that case,
13323 we set b->clip_changed to 1 to force updating the screen. If
13324 b->clip_changed has already been set to 1, we can skip this
13326 if (!b
->clip_changed
&& w
->window_end_valid
)
13328 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13329 ? PT
: marker_position (w
->pointm
));
13331 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13332 && check_point_in_composition (w
->current_matrix
->buffer
,
13333 w
->last_point
, b
, pt
))
13334 b
->clip_changed
= 1;
13339 propagate_buffer_redisplay (void)
13340 { /* Resetting b->text->redisplay is problematic!
13341 We can't just reset it in the case that some window that displays
13342 it has not been redisplayed; and such a window can stay
13343 unredisplayed for a long time if it's currently invisible.
13344 But we do want to reset it at the end of redisplay otherwise
13345 its displayed windows will keep being redisplayed over and over
13347 So we copy all b->text->redisplay flags up to their windows here,
13348 such that mark_window_display_accurate can safely reset
13349 b->text->redisplay. */
13350 Lisp_Object ws
= window_list ();
13351 for (; CONSP (ws
); ws
= XCDR (ws
))
13353 struct window
*thisw
= XWINDOW (XCAR (ws
));
13354 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13355 if (thisb
->text
->redisplay
)
13356 thisw
->redisplay
= true;
13360 #define STOP_POLLING \
13361 do { if (! polling_stopped_here) stop_polling (); \
13362 polling_stopped_here = 1; } while (0)
13364 #define RESUME_POLLING \
13365 do { if (polling_stopped_here) start_polling (); \
13366 polling_stopped_here = 0; } while (0)
13369 /* Perhaps in the future avoid recentering windows if it
13370 is not necessary; currently that causes some problems. */
13373 redisplay_internal (void)
13375 struct window
*w
= XWINDOW (selected_window
);
13379 bool must_finish
= 0, match_p
;
13380 struct text_pos tlbufpos
, tlendpos
;
13381 int number_of_visible_frames
;
13384 int polling_stopped_here
= 0;
13385 Lisp_Object tail
, frame
;
13387 /* True means redisplay has to consider all windows on all
13388 frames. False, only selected_window is considered. */
13389 bool consider_all_windows_p
;
13391 /* True means redisplay has to redisplay the miniwindow. */
13392 bool update_miniwindow_p
= false;
13394 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13396 /* No redisplay if running in batch mode or frame is not yet fully
13397 initialized, or redisplay is explicitly turned off by setting
13398 Vinhibit_redisplay. */
13399 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13400 || !NILP (Vinhibit_redisplay
))
13403 /* Don't examine these until after testing Vinhibit_redisplay.
13404 When Emacs is shutting down, perhaps because its connection to
13405 X has dropped, we should not look at them at all. */
13406 fr
= XFRAME (w
->frame
);
13407 sf
= SELECTED_FRAME ();
13409 if (!fr
->glyphs_initialized_p
)
13412 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13413 if (popup_activated ())
13417 /* I don't think this happens but let's be paranoid. */
13418 if (redisplaying_p
)
13421 /* Record a function that clears redisplaying_p
13422 when we leave this function. */
13423 count
= SPECPDL_INDEX ();
13424 record_unwind_protect_void (unwind_redisplay
);
13425 redisplaying_p
= 1;
13426 specbind (Qinhibit_free_realized_faces
, Qnil
);
13428 /* Record this function, so it appears on the profiler's backtraces. */
13429 record_in_backtrace (Qredisplay_internal
, 0, 0);
13431 FOR_EACH_FRAME (tail
, frame
)
13432 XFRAME (frame
)->already_hscrolled_p
= 0;
13435 /* Remember the currently selected window. */
13439 last_escape_glyph_frame
= NULL
;
13440 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13441 last_glyphless_glyph_frame
= NULL
;
13442 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13444 /* If face_change_count is non-zero, init_iterator will free all
13445 realized faces, which includes the faces referenced from current
13446 matrices. So, we can't reuse current matrices in this case. */
13447 if (face_change_count
)
13448 windows_or_buffers_changed
= 47;
13450 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13451 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13453 /* Since frames on a single ASCII terminal share the same
13454 display area, displaying a different frame means redisplay
13455 the whole thing. */
13456 SET_FRAME_GARBAGED (sf
);
13458 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13460 FRAME_TTY (sf
)->previous_frame
= sf
;
13463 /* Set the visible flags for all frames. Do this before checking for
13464 resized or garbaged frames; they want to know if their frames are
13465 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13466 number_of_visible_frames
= 0;
13468 FOR_EACH_FRAME (tail
, frame
)
13470 struct frame
*f
= XFRAME (frame
);
13472 if (FRAME_VISIBLE_P (f
))
13474 ++number_of_visible_frames
;
13475 /* Adjust matrices for visible frames only. */
13476 if (f
->fonts_changed
)
13478 adjust_frame_glyphs (f
);
13479 f
->fonts_changed
= 0;
13481 /* If cursor type has been changed on the frame
13482 other than selected, consider all frames. */
13483 if (f
!= sf
&& f
->cursor_type_changed
)
13484 update_mode_lines
= 31;
13486 clear_desired_matrices (f
);
13489 /* Notice any pending interrupt request to change frame size. */
13490 do_pending_window_change (true);
13492 /* do_pending_window_change could change the selected_window due to
13493 frame resizing which makes the selected window too small. */
13494 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13497 /* Clear frames marked as garbaged. */
13498 clear_garbaged_frames ();
13500 /* Build menubar and tool-bar items. */
13501 if (NILP (Vmemory_full
))
13502 prepare_menu_bars ();
13504 reconsider_clip_changes (w
);
13506 /* In most cases selected window displays current buffer. */
13507 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13510 /* Detect case that we need to write or remove a star in the mode line. */
13511 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13512 w
->update_mode_line
= 1;
13514 if (mode_line_update_needed (w
))
13515 w
->update_mode_line
= 1;
13517 /* If reconsider_clip_changes above decided that the narrowing
13518 in the current buffer changed, make sure all other windows
13519 showing that buffer will be redisplayed. */
13520 if (current_buffer
->clip_changed
)
13521 bset_update_mode_line (current_buffer
);
13524 /* Normally the message* functions will have already displayed and
13525 updated the echo area, but the frame may have been trashed, or
13526 the update may have been preempted, so display the echo area
13527 again here. Checking message_cleared_p captures the case that
13528 the echo area should be cleared. */
13529 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13530 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13531 || (message_cleared_p
13532 && minibuf_level
== 0
13533 /* If the mini-window is currently selected, this means the
13534 echo-area doesn't show through. */
13535 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13537 int window_height_changed_p
= echo_area_display (false);
13539 if (message_cleared_p
)
13540 update_miniwindow_p
= true;
13544 /* If we don't display the current message, don't clear the
13545 message_cleared_p flag, because, if we did, we wouldn't clear
13546 the echo area in the next redisplay which doesn't preserve
13548 if (!display_last_displayed_message_p
)
13549 message_cleared_p
= 0;
13551 if (window_height_changed_p
)
13553 windows_or_buffers_changed
= 50;
13555 /* If window configuration was changed, frames may have been
13556 marked garbaged. Clear them or we will experience
13557 surprises wrt scrolling. */
13558 clear_garbaged_frames ();
13561 else if (EQ (selected_window
, minibuf_window
)
13562 && (current_buffer
->clip_changed
|| window_outdated (w
))
13563 && resize_mini_window (w
, 0))
13565 /* Resized active mini-window to fit the size of what it is
13566 showing if its contents might have changed. */
13569 /* If window configuration was changed, frames may have been
13570 marked garbaged. Clear them or we will experience
13571 surprises wrt scrolling. */
13572 clear_garbaged_frames ();
13575 if (windows_or_buffers_changed
&& !update_mode_lines
)
13576 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13577 only the windows's contents needs to be refreshed, or whether the
13578 mode-lines also need a refresh. */
13579 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13580 ? REDISPLAY_SOME
: 32);
13582 /* If specs for an arrow have changed, do thorough redisplay
13583 to ensure we remove any arrow that should no longer exist. */
13584 if (overlay_arrows_changed_p ())
13585 /* Apparently, this is the only case where we update other windows,
13586 without updating other mode-lines. */
13587 windows_or_buffers_changed
= 49;
13589 consider_all_windows_p
= (update_mode_lines
13590 || windows_or_buffers_changed
);
13592 #define AINC(a,i) \
13593 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13594 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13596 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13597 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13599 /* Optimize the case that only the line containing the cursor in the
13600 selected window has changed. Variables starting with this_ are
13601 set in display_line and record information about the line
13602 containing the cursor. */
13603 tlbufpos
= this_line_start_pos
;
13604 tlendpos
= this_line_end_pos
;
13605 if (!consider_all_windows_p
13606 && CHARPOS (tlbufpos
) > 0
13607 && !w
->update_mode_line
13608 && !current_buffer
->clip_changed
13609 && !current_buffer
->prevent_redisplay_optimizations_p
13610 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13611 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13612 && !XFRAME (w
->frame
)->cursor_type_changed
13613 /* Make sure recorded data applies to current buffer, etc. */
13614 && this_line_buffer
== current_buffer
13617 && !w
->optional_new_start
13618 /* Point must be on the line that we have info recorded about. */
13619 && PT
>= CHARPOS (tlbufpos
)
13620 && PT
<= Z
- CHARPOS (tlendpos
)
13621 /* All text outside that line, including its final newline,
13622 must be unchanged. */
13623 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13624 CHARPOS (tlendpos
)))
13626 if (CHARPOS (tlbufpos
) > BEGV
13627 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13628 && (CHARPOS (tlbufpos
) == ZV
13629 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13630 /* Former continuation line has disappeared by becoming empty. */
13632 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13634 /* We have to handle the case of continuation around a
13635 wide-column character (see the comment in indent.c around
13638 For instance, in the following case:
13640 -------- Insert --------
13641 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13642 J_I_ ==> J_I_ `^^' are cursors.
13646 As we have to redraw the line above, we cannot use this
13650 int line_height_before
= this_line_pixel_height
;
13652 /* Note that start_display will handle the case that the
13653 line starting at tlbufpos is a continuation line. */
13654 start_display (&it
, w
, tlbufpos
);
13656 /* Implementation note: It this still necessary? */
13657 if (it
.current_x
!= this_line_start_x
)
13660 TRACE ((stderr
, "trying display optimization 1\n"));
13661 w
->cursor
.vpos
= -1;
13662 overlay_arrow_seen
= 0;
13663 it
.vpos
= this_line_vpos
;
13664 it
.current_y
= this_line_y
;
13665 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13666 display_line (&it
);
13668 /* If line contains point, is not continued,
13669 and ends at same distance from eob as before, we win. */
13670 if (w
->cursor
.vpos
>= 0
13671 /* Line is not continued, otherwise this_line_start_pos
13672 would have been set to 0 in display_line. */
13673 && CHARPOS (this_line_start_pos
)
13674 /* Line ends as before. */
13675 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13676 /* Line has same height as before. Otherwise other lines
13677 would have to be shifted up or down. */
13678 && this_line_pixel_height
== line_height_before
)
13680 /* If this is not the window's last line, we must adjust
13681 the charstarts of the lines below. */
13682 if (it
.current_y
< it
.last_visible_y
)
13684 struct glyph_row
*row
13685 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13686 ptrdiff_t delta
, delta_bytes
;
13688 /* We used to distinguish between two cases here,
13689 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13690 when the line ends in a newline or the end of the
13691 buffer's accessible portion. But both cases did
13692 the same, so they were collapsed. */
13694 - CHARPOS (tlendpos
)
13695 - MATRIX_ROW_START_CHARPOS (row
));
13696 delta_bytes
= (Z_BYTE
13697 - BYTEPOS (tlendpos
)
13698 - MATRIX_ROW_START_BYTEPOS (row
));
13700 increment_matrix_positions (w
->current_matrix
,
13701 this_line_vpos
+ 1,
13702 w
->current_matrix
->nrows
,
13703 delta
, delta_bytes
);
13706 /* If this row displays text now but previously didn't,
13707 or vice versa, w->window_end_vpos may have to be
13709 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13711 if (w
->window_end_vpos
< this_line_vpos
)
13712 w
->window_end_vpos
= this_line_vpos
;
13714 else if (w
->window_end_vpos
== this_line_vpos
13715 && this_line_vpos
> 0)
13716 w
->window_end_vpos
= this_line_vpos
- 1;
13717 w
->window_end_valid
= 0;
13719 /* Update hint: No need to try to scroll in update_window. */
13720 w
->desired_matrix
->no_scrolling_p
= 1;
13723 *w
->desired_matrix
->method
= 0;
13724 debug_method_add (w
, "optimization 1");
13726 #ifdef HAVE_WINDOW_SYSTEM
13727 update_window_fringes (w
, 0);
13734 else if (/* Cursor position hasn't changed. */
13735 PT
== w
->last_point
13736 /* Make sure the cursor was last displayed
13737 in this window. Otherwise we have to reposition it. */
13739 /* PXW: Must be converted to pixels, probably. */
13740 && 0 <= w
->cursor
.vpos
13741 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13745 do_pending_window_change (true);
13746 /* If selected_window changed, redisplay again. */
13747 if (WINDOWP (selected_window
)
13748 && (w
= XWINDOW (selected_window
)) != sw
)
13751 /* We used to always goto end_of_redisplay here, but this
13752 isn't enough if we have a blinking cursor. */
13753 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13754 goto end_of_redisplay
;
13758 /* If highlighting the region, or if the cursor is in the echo area,
13759 then we can't just move the cursor. */
13760 else if (NILP (Vshow_trailing_whitespace
)
13761 && !cursor_in_echo_area
)
13764 struct glyph_row
*row
;
13766 /* Skip from tlbufpos to PT and see where it is. Note that
13767 PT may be in invisible text. If so, we will end at the
13768 next visible position. */
13769 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13770 NULL
, DEFAULT_FACE_ID
);
13771 it
.current_x
= this_line_start_x
;
13772 it
.current_y
= this_line_y
;
13773 it
.vpos
= this_line_vpos
;
13775 /* The call to move_it_to stops in front of PT, but
13776 moves over before-strings. */
13777 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13779 if (it
.vpos
== this_line_vpos
13780 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13783 eassert (this_line_vpos
== it
.vpos
);
13784 eassert (this_line_y
== it
.current_y
);
13785 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13787 *w
->desired_matrix
->method
= 0;
13788 debug_method_add (w
, "optimization 3");
13797 /* Text changed drastically or point moved off of line. */
13798 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13801 CHARPOS (this_line_start_pos
) = 0;
13802 ++clear_face_cache_count
;
13803 #ifdef HAVE_WINDOW_SYSTEM
13804 ++clear_image_cache_count
;
13807 /* Build desired matrices, and update the display. If
13808 consider_all_windows_p is non-zero, do it for all windows on all
13809 frames. Otherwise do it for selected_window, only. */
13811 if (consider_all_windows_p
)
13813 FOR_EACH_FRAME (tail
, frame
)
13814 XFRAME (frame
)->updated_p
= 0;
13816 propagate_buffer_redisplay ();
13818 FOR_EACH_FRAME (tail
, frame
)
13820 struct frame
*f
= XFRAME (frame
);
13822 /* We don't have to do anything for unselected terminal
13824 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13825 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13830 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_GTK) && !defined (HAVE_NS)
13831 /* Redisplay internal tool bar if this is the first time so we
13832 can adjust the frame height right now, if necessary. */
13833 if (!f
->tool_bar_redisplayed_once
)
13835 if (redisplay_tool_bar (f
))
13836 adjust_frame_glyphs (f
);
13837 f
->tool_bar_redisplayed_once
= true;
13841 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13844 /* Only GC scrollbars when we redisplay the whole frame. */
13845 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13846 /* Mark all the scroll bars to be removed; we'll redeem
13847 the ones we want when we redisplay their windows. */
13848 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13849 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13851 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13852 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13853 /* Remember that the invisible frames need to be redisplayed next
13854 time they're visible. */
13855 else if (!REDISPLAY_SOME_P ())
13856 f
->redisplay
= true;
13858 /* The X error handler may have deleted that frame. */
13859 if (!FRAME_LIVE_P (f
))
13862 /* Any scroll bars which redisplay_windows should have
13863 nuked should now go away. */
13864 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13865 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13867 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13869 /* If fonts changed on visible frame, display again. */
13870 if (f
->fonts_changed
)
13872 adjust_frame_glyphs (f
);
13873 f
->fonts_changed
= false;
13877 /* See if we have to hscroll. */
13878 if (!f
->already_hscrolled_p
)
13880 f
->already_hscrolled_p
= true;
13881 if (hscroll_windows (f
->root_window
))
13885 /* Prevent various kinds of signals during display
13886 update. stdio is not robust about handling
13887 signals, which can cause an apparent I/O error. */
13888 if (interrupt_input
)
13889 unrequest_sigio ();
13892 pending
|= update_frame (f
, false, false);
13893 f
->cursor_type_changed
= false;
13894 f
->updated_p
= true;
13899 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13903 /* Do the mark_window_display_accurate after all windows have
13904 been redisplayed because this call resets flags in buffers
13905 which are needed for proper redisplay. */
13906 FOR_EACH_FRAME (tail
, frame
)
13908 struct frame
*f
= XFRAME (frame
);
13911 f
->redisplay
= false;
13912 mark_window_display_accurate (f
->root_window
, 1);
13913 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13914 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13919 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13921 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13922 struct frame
*mini_frame
;
13924 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13925 /* Use list_of_error, not Qerror, so that
13926 we catch only errors and don't run the debugger. */
13927 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13929 redisplay_window_error
);
13930 if (update_miniwindow_p
)
13931 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13933 redisplay_window_error
);
13935 /* Compare desired and current matrices, perform output. */
13938 /* If fonts changed, display again. */
13939 if (sf
->fonts_changed
)
13942 /* Prevent various kinds of signals during display update.
13943 stdio is not robust about handling signals,
13944 which can cause an apparent I/O error. */
13945 if (interrupt_input
)
13946 unrequest_sigio ();
13949 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13951 if (hscroll_windows (selected_window
))
13954 XWINDOW (selected_window
)->must_be_updated_p
= true;
13955 pending
= update_frame (sf
, false, false);
13956 sf
->cursor_type_changed
= false;
13959 /* We may have called echo_area_display at the top of this
13960 function. If the echo area is on another frame, that may
13961 have put text on a frame other than the selected one, so the
13962 above call to update_frame would not have caught it. Catch
13964 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13965 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13967 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13969 XWINDOW (mini_window
)->must_be_updated_p
= true;
13970 pending
|= update_frame (mini_frame
, false, false);
13971 mini_frame
->cursor_type_changed
= false;
13972 if (!pending
&& hscroll_windows (mini_window
))
13977 /* If display was paused because of pending input, make sure we do a
13978 thorough update the next time. */
13981 /* Prevent the optimization at the beginning of
13982 redisplay_internal that tries a single-line update of the
13983 line containing the cursor in the selected window. */
13984 CHARPOS (this_line_start_pos
) = 0;
13986 /* Let the overlay arrow be updated the next time. */
13987 update_overlay_arrows (0);
13989 /* If we pause after scrolling, some rows in the current
13990 matrices of some windows are not valid. */
13991 if (!WINDOW_FULL_WIDTH_P (w
)
13992 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13993 update_mode_lines
= 36;
13997 if (!consider_all_windows_p
)
13999 /* This has already been done above if
14000 consider_all_windows_p is set. */
14001 if (XBUFFER (w
->contents
)->text
->redisplay
14002 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14003 /* This can happen if b->text->redisplay was set during
14005 propagate_buffer_redisplay ();
14006 mark_window_display_accurate_1 (w
, 1);
14008 /* Say overlay arrows are up to date. */
14009 update_overlay_arrows (1);
14011 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14012 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14015 update_mode_lines
= 0;
14016 windows_or_buffers_changed
= 0;
14019 /* Start SIGIO interrupts coming again. Having them off during the
14020 code above makes it less likely one will discard output, but not
14021 impossible, since there might be stuff in the system buffer here.
14022 But it is much hairier to try to do anything about that. */
14023 if (interrupt_input
)
14027 /* If a frame has become visible which was not before, redisplay
14028 again, so that we display it. Expose events for such a frame
14029 (which it gets when becoming visible) don't call the parts of
14030 redisplay constructing glyphs, so simply exposing a frame won't
14031 display anything in this case. So, we have to display these
14032 frames here explicitly. */
14037 FOR_EACH_FRAME (tail
, frame
)
14039 if (XFRAME (frame
)->visible
)
14043 if (new_count
!= number_of_visible_frames
)
14044 windows_or_buffers_changed
= 52;
14047 /* Change frame size now if a change is pending. */
14048 do_pending_window_change (true);
14050 /* If we just did a pending size change, or have additional
14051 visible frames, or selected_window changed, redisplay again. */
14052 if ((windows_or_buffers_changed
&& !pending
)
14053 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14056 /* Clear the face and image caches.
14058 We used to do this only if consider_all_windows_p. But the cache
14059 needs to be cleared if a timer creates images in the current
14060 buffer (e.g. the test case in Bug#6230). */
14062 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14064 clear_face_cache (false);
14065 clear_face_cache_count
= 0;
14068 #ifdef HAVE_WINDOW_SYSTEM
14069 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14071 clear_image_caches (Qnil
);
14072 clear_image_cache_count
= 0;
14074 #endif /* HAVE_WINDOW_SYSTEM */
14078 ns_set_doc_edited ();
14080 if (interrupt_input
&& interrupts_deferred
)
14083 unbind_to (count
, Qnil
);
14088 /* Redisplay, but leave alone any recent echo area message unless
14089 another message has been requested in its place.
14091 This is useful in situations where you need to redisplay but no
14092 user action has occurred, making it inappropriate for the message
14093 area to be cleared. See tracking_off and
14094 wait_reading_process_output for examples of these situations.
14096 FROM_WHERE is an integer saying from where this function was
14097 called. This is useful for debugging. */
14100 redisplay_preserve_echo_area (int from_where
)
14102 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14104 if (!NILP (echo_area_buffer
[1]))
14106 /* We have a previously displayed message, but no current
14107 message. Redisplay the previous message. */
14108 display_last_displayed_message_p
= true;
14109 redisplay_internal ();
14110 display_last_displayed_message_p
= false;
14113 redisplay_internal ();
14115 flush_frame (SELECTED_FRAME ());
14119 /* Function registered with record_unwind_protect in redisplay_internal. */
14122 unwind_redisplay (void)
14124 redisplaying_p
= 0;
14128 /* Mark the display of leaf window W as accurate or inaccurate.
14129 If ACCURATE_P is non-zero mark display of W as accurate. If
14130 ACCURATE_P is zero, arrange for W to be redisplayed the next
14131 time redisplay_internal is called. */
14134 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14136 struct buffer
*b
= XBUFFER (w
->contents
);
14138 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14139 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14140 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14144 b
->clip_changed
= false;
14145 b
->prevent_redisplay_optimizations_p
= false;
14146 eassert (buffer_window_count (b
) > 0);
14147 /* Resetting b->text->redisplay is problematic!
14148 In order to make it safer to do it here, redisplay_internal must
14149 have copied all b->text->redisplay to their respective windows. */
14150 b
->text
->redisplay
= false;
14152 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14153 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14154 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14155 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14157 w
->current_matrix
->buffer
= b
;
14158 w
->current_matrix
->begv
= BUF_BEGV (b
);
14159 w
->current_matrix
->zv
= BUF_ZV (b
);
14161 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14162 w
->last_cursor_off_p
= w
->cursor_off_p
;
14164 if (w
== XWINDOW (selected_window
))
14165 w
->last_point
= BUF_PT (b
);
14167 w
->last_point
= marker_position (w
->pointm
);
14169 w
->window_end_valid
= true;
14170 w
->update_mode_line
= false;
14173 w
->redisplay
= !accurate_p
;
14177 /* Mark the display of windows in the window tree rooted at WINDOW as
14178 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14179 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14180 be redisplayed the next time redisplay_internal is called. */
14183 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14187 for (; !NILP (window
); window
= w
->next
)
14189 w
= XWINDOW (window
);
14190 if (WINDOWP (w
->contents
))
14191 mark_window_display_accurate (w
->contents
, accurate_p
);
14193 mark_window_display_accurate_1 (w
, accurate_p
);
14197 update_overlay_arrows (1);
14199 /* Force a thorough redisplay the next time by setting
14200 last_arrow_position and last_arrow_string to t, which is
14201 unequal to any useful value of Voverlay_arrow_... */
14202 update_overlay_arrows (-1);
14206 /* Return value in display table DP (Lisp_Char_Table *) for character
14207 C. Since a display table doesn't have any parent, we don't have to
14208 follow parent. Do not call this function directly but use the
14209 macro DISP_CHAR_VECTOR. */
14212 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14216 if (ASCII_CHAR_P (c
))
14219 if (SUB_CHAR_TABLE_P (val
))
14220 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14226 XSETCHAR_TABLE (table
, dp
);
14227 val
= char_table_ref (table
, c
);
14236 /***********************************************************************
14238 ***********************************************************************/
14240 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14243 redisplay_windows (Lisp_Object window
)
14245 while (!NILP (window
))
14247 struct window
*w
= XWINDOW (window
);
14249 if (WINDOWP (w
->contents
))
14250 redisplay_windows (w
->contents
);
14251 else if (BUFFERP (w
->contents
))
14253 displayed_buffer
= XBUFFER (w
->contents
);
14254 /* Use list_of_error, not Qerror, so that
14255 we catch only errors and don't run the debugger. */
14256 internal_condition_case_1 (redisplay_window_0
, window
,
14258 redisplay_window_error
);
14266 redisplay_window_error (Lisp_Object ignore
)
14268 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14273 redisplay_window_0 (Lisp_Object window
)
14275 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14276 redisplay_window (window
, false);
14281 redisplay_window_1 (Lisp_Object window
)
14283 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14284 redisplay_window (window
, true);
14289 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14290 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14291 which positions recorded in ROW differ from current buffer
14294 Return 0 if cursor is not on this row, 1 otherwise. */
14297 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14298 struct glyph_matrix
*matrix
,
14299 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14302 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14303 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14304 struct glyph
*cursor
= NULL
;
14305 /* The last known character position in row. */
14306 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14308 ptrdiff_t pt_old
= PT
- delta
;
14309 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14310 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14311 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14312 /* A glyph beyond the edge of TEXT_AREA which we should never
14314 struct glyph
*glyphs_end
= end
;
14315 /* Non-zero means we've found a match for cursor position, but that
14316 glyph has the avoid_cursor_p flag set. */
14317 int match_with_avoid_cursor
= 0;
14318 /* Non-zero means we've seen at least one glyph that came from a
14320 int string_seen
= 0;
14321 /* Largest and smallest buffer positions seen so far during scan of
14323 ptrdiff_t bpos_max
= pos_before
;
14324 ptrdiff_t bpos_min
= pos_after
;
14325 /* Last buffer position covered by an overlay string with an integer
14326 `cursor' property. */
14327 ptrdiff_t bpos_covered
= 0;
14328 /* Non-zero means the display string on which to display the cursor
14329 comes from a text property, not from an overlay. */
14330 int string_from_text_prop
= 0;
14332 /* Don't even try doing anything if called for a mode-line or
14333 header-line row, since the rest of the code isn't prepared to
14334 deal with such calamities. */
14335 eassert (!row
->mode_line_p
);
14336 if (row
->mode_line_p
)
14339 /* Skip over glyphs not having an object at the start and the end of
14340 the row. These are special glyphs like truncation marks on
14341 terminal frames. */
14342 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14344 if (!row
->reversed_p
)
14347 && NILP (glyph
->object
)
14348 && glyph
->charpos
< 0)
14350 x
+= glyph
->pixel_width
;
14354 && NILP ((end
- 1)->object
)
14355 /* CHARPOS is zero for blanks and stretch glyphs
14356 inserted by extend_face_to_end_of_line. */
14357 && (end
- 1)->charpos
<= 0)
14359 glyph_before
= glyph
- 1;
14366 /* If the glyph row is reversed, we need to process it from back
14367 to front, so swap the edge pointers. */
14368 glyphs_end
= end
= glyph
- 1;
14369 glyph
+= row
->used
[TEXT_AREA
] - 1;
14371 while (glyph
> end
+ 1
14372 && NILP (glyph
->object
)
14373 && glyph
->charpos
< 0)
14376 x
-= glyph
->pixel_width
;
14378 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14380 /* By default, in reversed rows we put the cursor on the
14381 rightmost (first in the reading order) glyph. */
14382 for (g
= end
+ 1; g
< glyph
; g
++)
14383 x
+= g
->pixel_width
;
14385 && NILP ((end
+ 1)->object
)
14386 && (end
+ 1)->charpos
<= 0)
14388 glyph_before
= glyph
+ 1;
14392 else if (row
->reversed_p
)
14394 /* In R2L rows that don't display text, put the cursor on the
14395 rightmost glyph. Case in point: an empty last line that is
14396 part of an R2L paragraph. */
14398 /* Avoid placing the cursor on the last glyph of the row, where
14399 on terminal frames we hold the vertical border between
14400 adjacent windows. */
14401 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14402 && !WINDOW_RIGHTMOST_P (w
)
14403 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14405 x
= -1; /* will be computed below, at label compute_x */
14408 /* Step 1: Try to find the glyph whose character position
14409 corresponds to point. If that's not possible, find 2 glyphs
14410 whose character positions are the closest to point, one before
14411 point, the other after it. */
14412 if (!row
->reversed_p
)
14413 while (/* not marched to end of glyph row */
14415 /* glyph was not inserted by redisplay for internal purposes */
14416 && !NILP (glyph
->object
))
14418 if (BUFFERP (glyph
->object
))
14420 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14422 if (glyph
->charpos
> bpos_max
)
14423 bpos_max
= glyph
->charpos
;
14424 if (glyph
->charpos
< bpos_min
)
14425 bpos_min
= glyph
->charpos
;
14426 if (!glyph
->avoid_cursor_p
)
14428 /* If we hit point, we've found the glyph on which to
14429 display the cursor. */
14432 match_with_avoid_cursor
= 0;
14435 /* See if we've found a better approximation to
14436 POS_BEFORE or to POS_AFTER. */
14437 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14439 pos_before
= glyph
->charpos
;
14440 glyph_before
= glyph
;
14442 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14444 pos_after
= glyph
->charpos
;
14445 glyph_after
= glyph
;
14448 else if (dpos
== 0)
14449 match_with_avoid_cursor
= 1;
14451 else if (STRINGP (glyph
->object
))
14453 Lisp_Object chprop
;
14454 ptrdiff_t glyph_pos
= glyph
->charpos
;
14456 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14458 if (!NILP (chprop
))
14460 /* If the string came from a `display' text property,
14461 look up the buffer position of that property and
14462 use that position to update bpos_max, as if we
14463 actually saw such a position in one of the row's
14464 glyphs. This helps with supporting integer values
14465 of `cursor' property on the display string in
14466 situations where most or all of the row's buffer
14467 text is completely covered by display properties,
14468 so that no glyph with valid buffer positions is
14469 ever seen in the row. */
14470 ptrdiff_t prop_pos
=
14471 string_buffer_position_lim (glyph
->object
, pos_before
,
14474 if (prop_pos
>= pos_before
)
14475 bpos_max
= prop_pos
;
14477 if (INTEGERP (chprop
))
14479 bpos_covered
= bpos_max
+ XINT (chprop
);
14480 /* If the `cursor' property covers buffer positions up
14481 to and including point, we should display cursor on
14482 this glyph. Note that, if a `cursor' property on one
14483 of the string's characters has an integer value, we
14484 will break out of the loop below _before_ we get to
14485 the position match above. IOW, integer values of
14486 the `cursor' property override the "exact match for
14487 point" strategy of positioning the cursor. */
14488 /* Implementation note: bpos_max == pt_old when, e.g.,
14489 we are in an empty line, where bpos_max is set to
14490 MATRIX_ROW_START_CHARPOS, see above. */
14491 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14500 x
+= glyph
->pixel_width
;
14503 else if (glyph
> end
) /* row is reversed */
14504 while (!NILP (glyph
->object
))
14506 if (BUFFERP (glyph
->object
))
14508 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14510 if (glyph
->charpos
> bpos_max
)
14511 bpos_max
= glyph
->charpos
;
14512 if (glyph
->charpos
< bpos_min
)
14513 bpos_min
= glyph
->charpos
;
14514 if (!glyph
->avoid_cursor_p
)
14518 match_with_avoid_cursor
= 0;
14521 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14523 pos_before
= glyph
->charpos
;
14524 glyph_before
= glyph
;
14526 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14528 pos_after
= glyph
->charpos
;
14529 glyph_after
= glyph
;
14532 else if (dpos
== 0)
14533 match_with_avoid_cursor
= 1;
14535 else if (STRINGP (glyph
->object
))
14537 Lisp_Object chprop
;
14538 ptrdiff_t glyph_pos
= glyph
->charpos
;
14540 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14542 if (!NILP (chprop
))
14544 ptrdiff_t prop_pos
=
14545 string_buffer_position_lim (glyph
->object
, pos_before
,
14548 if (prop_pos
>= pos_before
)
14549 bpos_max
= prop_pos
;
14551 if (INTEGERP (chprop
))
14553 bpos_covered
= bpos_max
+ XINT (chprop
);
14554 /* If the `cursor' property covers buffer positions up
14555 to and including point, we should display cursor on
14557 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14566 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14568 x
--; /* can't use any pixel_width */
14571 x
-= glyph
->pixel_width
;
14574 /* Step 2: If we didn't find an exact match for point, we need to
14575 look for a proper place to put the cursor among glyphs between
14576 GLYPH_BEFORE and GLYPH_AFTER. */
14577 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14578 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14579 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14581 /* An empty line has a single glyph whose OBJECT is nil and
14582 whose CHARPOS is the position of a newline on that line.
14583 Note that on a TTY, there are more glyphs after that, which
14584 were produced by extend_face_to_end_of_line, but their
14585 CHARPOS is zero or negative. */
14587 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14588 && NILP (glyph
->object
) && glyph
->charpos
> 0
14589 /* On a TTY, continued and truncated rows also have a glyph at
14590 their end whose OBJECT is nil and whose CHARPOS is
14591 positive (the continuation and truncation glyphs), but such
14592 rows are obviously not "empty". */
14593 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14595 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14597 ptrdiff_t ellipsis_pos
;
14599 /* Scan back over the ellipsis glyphs. */
14600 if (!row
->reversed_p
)
14602 ellipsis_pos
= (glyph
- 1)->charpos
;
14603 while (glyph
> row
->glyphs
[TEXT_AREA
]
14604 && (glyph
- 1)->charpos
== ellipsis_pos
)
14605 glyph
--, x
-= glyph
->pixel_width
;
14606 /* That loop always goes one position too far, including
14607 the glyph before the ellipsis. So scan forward over
14609 x
+= glyph
->pixel_width
;
14612 else /* row is reversed */
14614 ellipsis_pos
= (glyph
+ 1)->charpos
;
14615 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14616 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14617 glyph
++, x
+= glyph
->pixel_width
;
14618 x
-= glyph
->pixel_width
;
14622 else if (match_with_avoid_cursor
)
14624 cursor
= glyph_after
;
14627 else if (string_seen
)
14629 int incr
= row
->reversed_p
? -1 : +1;
14631 /* Need to find the glyph that came out of a string which is
14632 present at point. That glyph is somewhere between
14633 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14634 positioned between POS_BEFORE and POS_AFTER in the
14636 struct glyph
*start
, *stop
;
14637 ptrdiff_t pos
= pos_before
;
14641 /* If the row ends in a newline from a display string,
14642 reordering could have moved the glyphs belonging to the
14643 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14644 in this case we extend the search to the last glyph in
14645 the row that was not inserted by redisplay. */
14646 if (row
->ends_in_newline_from_string_p
)
14649 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14652 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14653 correspond to POS_BEFORE and POS_AFTER, respectively. We
14654 need START and STOP in the order that corresponds to the
14655 row's direction as given by its reversed_p flag. If the
14656 directionality of characters between POS_BEFORE and
14657 POS_AFTER is the opposite of the row's base direction,
14658 these characters will have been reordered for display,
14659 and we need to reverse START and STOP. */
14660 if (!row
->reversed_p
)
14662 start
= min (glyph_before
, glyph_after
);
14663 stop
= max (glyph_before
, glyph_after
);
14667 start
= max (glyph_before
, glyph_after
);
14668 stop
= min (glyph_before
, glyph_after
);
14670 for (glyph
= start
+ incr
;
14671 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14674 /* Any glyphs that come from the buffer are here because
14675 of bidi reordering. Skip them, and only pay
14676 attention to glyphs that came from some string. */
14677 if (STRINGP (glyph
->object
))
14681 /* If the display property covers the newline, we
14682 need to search for it one position farther. */
14683 ptrdiff_t lim
= pos_after
14684 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14686 string_from_text_prop
= 0;
14687 str
= glyph
->object
;
14688 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14689 if (tem
== 0 /* from overlay */
14692 /* If the string from which this glyph came is
14693 found in the buffer at point, or at position
14694 that is closer to point than pos_after, then
14695 we've found the glyph we've been looking for.
14696 If it comes from an overlay (tem == 0), and
14697 it has the `cursor' property on one of its
14698 glyphs, record that glyph as a candidate for
14699 displaying the cursor. (As in the
14700 unidirectional version, we will display the
14701 cursor on the last candidate we find.) */
14704 || (tem
- pt_old
> 0 && tem
< pos_after
))
14706 /* The glyphs from this string could have
14707 been reordered. Find the one with the
14708 smallest string position. Or there could
14709 be a character in the string with the
14710 `cursor' property, which means display
14711 cursor on that character's glyph. */
14712 ptrdiff_t strpos
= glyph
->charpos
;
14717 string_from_text_prop
= 1;
14720 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14721 && EQ (glyph
->object
, str
);
14725 ptrdiff_t gpos
= glyph
->charpos
;
14727 cprop
= Fget_char_property (make_number (gpos
),
14735 if (tem
&& glyph
->charpos
< strpos
)
14737 strpos
= glyph
->charpos
;
14743 || (tem
- pt_old
> 0 && tem
< pos_after
))
14747 pos
= tem
+ 1; /* don't find previous instances */
14749 /* This string is not what we want; skip all of the
14750 glyphs that came from it. */
14751 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14752 && EQ (glyph
->object
, str
))
14759 /* If we reached the end of the line, and END was from a string,
14760 the cursor is not on this line. */
14762 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14763 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14764 && STRINGP (end
->object
)
14765 && row
->continued_p
)
14768 /* A truncated row may not include PT among its character positions.
14769 Setting the cursor inside the scroll margin will trigger
14770 recalculation of hscroll in hscroll_window_tree. But if a
14771 display string covers point, defer to the string-handling
14772 code below to figure this out. */
14773 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14775 cursor
= glyph_before
;
14778 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14779 /* Zero-width characters produce no glyphs. */
14781 && (row
->reversed_p
14782 ? glyph_after
> glyphs_end
14783 : glyph_after
< glyphs_end
)))
14785 cursor
= glyph_after
;
14791 if (cursor
!= NULL
)
14793 else if (glyph
== glyphs_end
14794 && pos_before
== pos_after
14795 && STRINGP ((row
->reversed_p
14796 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14797 : row
->glyphs
[TEXT_AREA
])->object
))
14799 /* If all the glyphs of this row came from strings, put the
14800 cursor on the first glyph of the row. This avoids having the
14801 cursor outside of the text area in this very rare and hard
14805 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14806 : row
->glyphs
[TEXT_AREA
];
14812 /* Need to compute x that corresponds to GLYPH. */
14813 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14815 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14817 x
+= g
->pixel_width
;
14821 /* ROW could be part of a continued line, which, under bidi
14822 reordering, might have other rows whose start and end charpos
14823 occlude point. Only set w->cursor if we found a better
14824 approximation to the cursor position than we have from previously
14825 examined candidate rows belonging to the same continued line. */
14826 if (/* We already have a candidate row. */
14827 w
->cursor
.vpos
>= 0
14828 /* That candidate is not the row we are processing. */
14829 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14830 /* Make sure cursor.vpos specifies a row whose start and end
14831 charpos occlude point, and it is valid candidate for being a
14832 cursor-row. This is because some callers of this function
14833 leave cursor.vpos at the row where the cursor was displayed
14834 during the last redisplay cycle. */
14835 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14836 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14837 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14840 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14842 /* Don't consider glyphs that are outside TEXT_AREA. */
14843 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14845 /* Keep the candidate whose buffer position is the closest to
14846 point or has the `cursor' property. */
14847 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14848 w
->cursor
.hpos
>= 0
14849 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14850 && ((BUFFERP (g1
->object
)
14851 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14852 || (BUFFERP (glyph
->object
)
14853 && eabs (g1
->charpos
- pt_old
)
14854 < eabs (glyph
->charpos
- pt_old
))))
14855 /* Previous candidate is a glyph from a string that has
14856 a non-nil `cursor' property. */
14857 || (STRINGP (g1
->object
)
14858 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14859 Qcursor
, g1
->object
))
14860 /* Previous candidate is from the same display
14861 string as this one, and the display string
14862 came from a text property. */
14863 || (EQ (g1
->object
, glyph
->object
)
14864 && string_from_text_prop
)
14865 /* this candidate is from newline and its
14866 position is not an exact match */
14867 || (NILP (glyph
->object
)
14868 && glyph
->charpos
!= pt_old
)))))
14870 /* If this candidate gives an exact match, use that. */
14871 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14872 /* If this candidate is a glyph created for the
14873 terminating newline of a line, and point is on that
14874 newline, it wins because it's an exact match. */
14875 || (!row
->continued_p
14876 && NILP (glyph
->object
)
14877 && glyph
->charpos
== 0
14878 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14879 /* Otherwise, keep the candidate that comes from a row
14880 spanning less buffer positions. This may win when one or
14881 both candidate positions are on glyphs that came from
14882 display strings, for which we cannot compare buffer
14884 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14885 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14886 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14889 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14891 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14892 w
->cursor
.y
= row
->y
+ dy
;
14894 if (w
== XWINDOW (selected_window
))
14896 if (!row
->continued_p
14897 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14900 this_line_buffer
= XBUFFER (w
->contents
);
14902 CHARPOS (this_line_start_pos
)
14903 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14904 BYTEPOS (this_line_start_pos
)
14905 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14907 CHARPOS (this_line_end_pos
)
14908 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14909 BYTEPOS (this_line_end_pos
)
14910 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14912 this_line_y
= w
->cursor
.y
;
14913 this_line_pixel_height
= row
->height
;
14914 this_line_vpos
= w
->cursor
.vpos
;
14915 this_line_start_x
= row
->x
;
14918 CHARPOS (this_line_start_pos
) = 0;
14925 /* Run window scroll functions, if any, for WINDOW with new window
14926 start STARTP. Sets the window start of WINDOW to that position.
14928 We assume that the window's buffer is really current. */
14930 static struct text_pos
14931 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14933 struct window
*w
= XWINDOW (window
);
14934 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14936 eassert (current_buffer
== XBUFFER (w
->contents
));
14938 if (!NILP (Vwindow_scroll_functions
))
14940 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14941 make_number (CHARPOS (startp
)));
14942 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14943 /* In case the hook functions switch buffers. */
14944 set_buffer_internal (XBUFFER (w
->contents
));
14951 /* Make sure the line containing the cursor is fully visible.
14952 A value of 1 means there is nothing to be done.
14953 (Either the line is fully visible, or it cannot be made so,
14954 or we cannot tell.)
14956 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14957 is higher than window.
14959 If CURRENT_MATRIX_P is non-zero, use the information from the
14960 window's current glyph matrix; otherwise use the desired glyph
14963 A value of 0 means the caller should do scrolling
14964 as if point had gone off the screen. */
14967 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14969 struct glyph_matrix
*matrix
;
14970 struct glyph_row
*row
;
14973 if (!make_cursor_line_fully_visible_p
)
14976 /* It's not always possible to find the cursor, e.g, when a window
14977 is full of overlay strings. Don't do anything in that case. */
14978 if (w
->cursor
.vpos
< 0)
14981 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14982 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14984 /* If the cursor row is not partially visible, there's nothing to do. */
14985 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14988 /* If the row the cursor is in is taller than the window's height,
14989 it's not clear what to do, so do nothing. */
14990 window_height
= window_box_height (w
);
14991 if (row
->height
>= window_height
)
14993 if (!force_p
|| MINI_WINDOW_P (w
)
14994 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15001 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15002 non-zero means only WINDOW is redisplayed in redisplay_internal.
15003 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15004 in redisplay_window to bring a partially visible line into view in
15005 the case that only the cursor has moved.
15007 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15008 last screen line's vertical height extends past the end of the screen.
15012 1 if scrolling succeeded
15014 0 if scrolling didn't find point.
15016 -1 if new fonts have been loaded so that we must interrupt
15017 redisplay, adjust glyph matrices, and try again. */
15023 SCROLLING_NEED_LARGER_MATRICES
15026 /* If scroll-conservatively is more than this, never recenter.
15028 If you change this, don't forget to update the doc string of
15029 `scroll-conservatively' and the Emacs manual. */
15030 #define SCROLL_LIMIT 100
15033 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15034 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15035 int temp_scroll_step
, int last_line_misfit
)
15037 struct window
*w
= XWINDOW (window
);
15038 struct frame
*f
= XFRAME (w
->frame
);
15039 struct text_pos pos
, startp
;
15041 int this_scroll_margin
, scroll_max
, rc
, height
;
15042 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15043 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15044 Lisp_Object aggressive
;
15045 /* We will never try scrolling more than this number of lines. */
15046 int scroll_limit
= SCROLL_LIMIT
;
15047 int frame_line_height
= default_line_pixel_height (w
);
15048 int window_total_lines
15049 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15052 debug_method_add (w
, "try_scrolling");
15055 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15057 /* Compute scroll margin height in pixels. We scroll when point is
15058 within this distance from the top or bottom of the window. */
15059 if (scroll_margin
> 0)
15060 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15061 * frame_line_height
;
15063 this_scroll_margin
= 0;
15065 /* Force arg_scroll_conservatively to have a reasonable value, to
15066 avoid scrolling too far away with slow move_it_* functions. Note
15067 that the user can supply scroll-conservatively equal to
15068 `most-positive-fixnum', which can be larger than INT_MAX. */
15069 if (arg_scroll_conservatively
> scroll_limit
)
15071 arg_scroll_conservatively
= scroll_limit
+ 1;
15072 scroll_max
= scroll_limit
* frame_line_height
;
15074 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15075 /* Compute how much we should try to scroll maximally to bring
15076 point into view. */
15077 scroll_max
= (max (scroll_step
,
15078 max (arg_scroll_conservatively
, temp_scroll_step
))
15079 * frame_line_height
);
15080 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15081 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15082 /* We're trying to scroll because of aggressive scrolling but no
15083 scroll_step is set. Choose an arbitrary one. */
15084 scroll_max
= 10 * frame_line_height
;
15090 /* Decide whether to scroll down. */
15091 if (PT
> CHARPOS (startp
))
15093 int scroll_margin_y
;
15095 /* Compute the pixel ypos of the scroll margin, then move IT to
15096 either that ypos or PT, whichever comes first. */
15097 start_display (&it
, w
, startp
);
15098 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15099 - frame_line_height
* extra_scroll_margin_lines
;
15100 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15101 (MOVE_TO_POS
| MOVE_TO_Y
));
15103 if (PT
> CHARPOS (it
.current
.pos
))
15105 int y0
= line_bottom_y (&it
);
15106 /* Compute how many pixels below window bottom to stop searching
15107 for PT. This avoids costly search for PT that is far away if
15108 the user limited scrolling by a small number of lines, but
15109 always finds PT if scroll_conservatively is set to a large
15110 number, such as most-positive-fixnum. */
15111 int slack
= max (scroll_max
, 10 * frame_line_height
);
15112 int y_to_move
= it
.last_visible_y
+ slack
;
15114 /* Compute the distance from the scroll margin to PT or to
15115 the scroll limit, whichever comes first. This should
15116 include the height of the cursor line, to make that line
15118 move_it_to (&it
, PT
, -1, y_to_move
,
15119 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15120 dy
= line_bottom_y (&it
) - y0
;
15122 if (dy
> scroll_max
)
15123 return SCROLLING_FAILED
;
15132 /* Point is in or below the bottom scroll margin, so move the
15133 window start down. If scrolling conservatively, move it just
15134 enough down to make point visible. If scroll_step is set,
15135 move it down by scroll_step. */
15136 if (arg_scroll_conservatively
)
15138 = min (max (dy
, frame_line_height
),
15139 frame_line_height
* arg_scroll_conservatively
);
15140 else if (scroll_step
|| temp_scroll_step
)
15141 amount_to_scroll
= scroll_max
;
15144 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15145 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15146 if (NUMBERP (aggressive
))
15148 double float_amount
= XFLOATINT (aggressive
) * height
;
15149 int aggressive_scroll
= float_amount
;
15150 if (aggressive_scroll
== 0 && float_amount
> 0)
15151 aggressive_scroll
= 1;
15152 /* Don't let point enter the scroll margin near top of
15153 the window. This could happen if the value of
15154 scroll_up_aggressively is too large and there are
15155 non-zero margins, because scroll_up_aggressively
15156 means put point that fraction of window height
15157 _from_the_bottom_margin_. */
15158 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15159 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15160 amount_to_scroll
= dy
+ aggressive_scroll
;
15164 if (amount_to_scroll
<= 0)
15165 return SCROLLING_FAILED
;
15167 start_display (&it
, w
, startp
);
15168 if (arg_scroll_conservatively
<= scroll_limit
)
15169 move_it_vertically (&it
, amount_to_scroll
);
15172 /* Extra precision for users who set scroll-conservatively
15173 to a large number: make sure the amount we scroll
15174 the window start is never less than amount_to_scroll,
15175 which was computed as distance from window bottom to
15176 point. This matters when lines at window top and lines
15177 below window bottom have different height. */
15179 void *it1data
= NULL
;
15180 /* We use a temporary it1 because line_bottom_y can modify
15181 its argument, if it moves one line down; see there. */
15184 SAVE_IT (it1
, it
, it1data
);
15185 start_y
= line_bottom_y (&it1
);
15187 RESTORE_IT (&it
, &it
, it1data
);
15188 move_it_by_lines (&it
, 1);
15189 SAVE_IT (it1
, it
, it1data
);
15190 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15193 /* If STARTP is unchanged, move it down another screen line. */
15194 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15195 move_it_by_lines (&it
, 1);
15196 startp
= it
.current
.pos
;
15200 struct text_pos scroll_margin_pos
= startp
;
15203 /* See if point is inside the scroll margin at the top of the
15205 if (this_scroll_margin
)
15209 start_display (&it
, w
, startp
);
15210 y_start
= it
.current_y
;
15211 move_it_vertically (&it
, this_scroll_margin
);
15212 scroll_margin_pos
= it
.current
.pos
;
15213 /* If we didn't move enough before hitting ZV, request
15214 additional amount of scroll, to move point out of the
15216 if (IT_CHARPOS (it
) == ZV
15217 && it
.current_y
- y_start
< this_scroll_margin
)
15218 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15221 if (PT
< CHARPOS (scroll_margin_pos
))
15223 /* Point is in the scroll margin at the top of the window or
15224 above what is displayed in the window. */
15227 /* Compute the vertical distance from PT to the scroll
15228 margin position. Move as far as scroll_max allows, or
15229 one screenful, or 10 screen lines, whichever is largest.
15230 Give up if distance is greater than scroll_max or if we
15231 didn't reach the scroll margin position. */
15232 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15233 start_display (&it
, w
, pos
);
15235 y_to_move
= max (it
.last_visible_y
,
15236 max (scroll_max
, 10 * frame_line_height
));
15237 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15239 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15240 dy
= it
.current_y
- y0
;
15241 if (dy
> scroll_max
15242 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15243 return SCROLLING_FAILED
;
15245 /* Additional scroll for when ZV was too close to point. */
15248 /* Compute new window start. */
15249 start_display (&it
, w
, startp
);
15251 if (arg_scroll_conservatively
)
15252 amount_to_scroll
= max (dy
, frame_line_height
15253 * max (scroll_step
, temp_scroll_step
));
15254 else if (scroll_step
|| temp_scroll_step
)
15255 amount_to_scroll
= scroll_max
;
15258 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15259 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15260 if (NUMBERP (aggressive
))
15262 double float_amount
= XFLOATINT (aggressive
) * height
;
15263 int aggressive_scroll
= float_amount
;
15264 if (aggressive_scroll
== 0 && float_amount
> 0)
15265 aggressive_scroll
= 1;
15266 /* Don't let point enter the scroll margin near
15267 bottom of the window, if the value of
15268 scroll_down_aggressively happens to be too
15270 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15271 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15272 amount_to_scroll
= dy
+ aggressive_scroll
;
15276 if (amount_to_scroll
<= 0)
15277 return SCROLLING_FAILED
;
15279 move_it_vertically_backward (&it
, amount_to_scroll
);
15280 startp
= it
.current
.pos
;
15284 /* Run window scroll functions. */
15285 startp
= run_window_scroll_functions (window
, startp
);
15287 /* Display the window. Give up if new fonts are loaded, or if point
15289 if (!try_window (window
, startp
, 0))
15290 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15291 else if (w
->cursor
.vpos
< 0)
15293 clear_glyph_matrix (w
->desired_matrix
);
15294 rc
= SCROLLING_FAILED
;
15298 /* Maybe forget recorded base line for line number display. */
15299 if (!just_this_one_p
15300 || current_buffer
->clip_changed
15301 || BEG_UNCHANGED
< CHARPOS (startp
))
15302 w
->base_line_number
= 0;
15304 /* If cursor ends up on a partially visible line,
15305 treat that as being off the bottom of the screen. */
15306 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15307 /* It's possible that the cursor is on the first line of the
15308 buffer, which is partially obscured due to a vscroll
15309 (Bug#7537). In that case, avoid looping forever. */
15310 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15312 clear_glyph_matrix (w
->desired_matrix
);
15313 ++extra_scroll_margin_lines
;
15316 rc
= SCROLLING_SUCCESS
;
15323 /* Compute a suitable window start for window W if display of W starts
15324 on a continuation line. Value is non-zero if a new window start
15327 The new window start will be computed, based on W's width, starting
15328 from the start of the continued line. It is the start of the
15329 screen line with the minimum distance from the old start W->start. */
15332 compute_window_start_on_continuation_line (struct window
*w
)
15334 struct text_pos pos
, start_pos
;
15335 int window_start_changed_p
= 0;
15337 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15339 /* If window start is on a continuation line... Window start may be
15340 < BEGV in case there's invisible text at the start of the
15341 buffer (M-x rmail, for example). */
15342 if (CHARPOS (start_pos
) > BEGV
15343 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15346 struct glyph_row
*row
;
15348 /* Handle the case that the window start is out of range. */
15349 if (CHARPOS (start_pos
) < BEGV
)
15350 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15351 else if (CHARPOS (start_pos
) > ZV
)
15352 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15354 /* Find the start of the continued line. This should be fast
15355 because find_newline is fast (newline cache). */
15356 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15357 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15358 row
, DEFAULT_FACE_ID
);
15359 reseat_at_previous_visible_line_start (&it
);
15361 /* If the line start is "too far" away from the window start,
15362 say it takes too much time to compute a new window start. */
15363 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15364 /* PXW: Do we need upper bounds here? */
15365 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15367 int min_distance
, distance
;
15369 /* Move forward by display lines to find the new window
15370 start. If window width was enlarged, the new start can
15371 be expected to be > the old start. If window width was
15372 decreased, the new window start will be < the old start.
15373 So, we're looking for the display line start with the
15374 minimum distance from the old window start. */
15375 pos
= it
.current
.pos
;
15376 min_distance
= INFINITY
;
15377 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15378 distance
< min_distance
)
15380 min_distance
= distance
;
15381 pos
= it
.current
.pos
;
15382 if (it
.line_wrap
== WORD_WRAP
)
15384 /* Under WORD_WRAP, move_it_by_lines is likely to
15385 overshoot and stop not at the first, but the
15386 second character from the left margin. So in
15387 that case, we need a more tight control on the X
15388 coordinate of the iterator than move_it_by_lines
15389 promises in its contract. The method is to first
15390 go to the last (rightmost) visible character of a
15391 line, then move to the leftmost character on the
15392 next line in a separate call. */
15393 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15394 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15395 move_it_to (&it
, ZV
, 0,
15396 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15397 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15400 move_it_by_lines (&it
, 1);
15403 /* Set the window start there. */
15404 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15405 window_start_changed_p
= 1;
15409 return window_start_changed_p
;
15413 /* Try cursor movement in case text has not changed in window WINDOW,
15414 with window start STARTP. Value is
15416 CURSOR_MOVEMENT_SUCCESS if successful
15418 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15420 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15421 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15422 we want to scroll as if scroll-step were set to 1. See the code.
15424 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15425 which case we have to abort this redisplay, and adjust matrices
15430 CURSOR_MOVEMENT_SUCCESS
,
15431 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15432 CURSOR_MOVEMENT_MUST_SCROLL
,
15433 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15437 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15439 struct window
*w
= XWINDOW (window
);
15440 struct frame
*f
= XFRAME (w
->frame
);
15441 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15444 if (inhibit_try_cursor_movement
)
15448 /* Previously, there was a check for Lisp integer in the
15449 if-statement below. Now, this field is converted to
15450 ptrdiff_t, thus zero means invalid position in a buffer. */
15451 eassert (w
->last_point
> 0);
15452 /* Likewise there was a check whether window_end_vpos is nil or larger
15453 than the window. Now window_end_vpos is int and so never nil, but
15454 let's leave eassert to check whether it fits in the window. */
15455 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15457 /* Handle case where text has not changed, only point, and it has
15458 not moved off the frame. */
15459 if (/* Point may be in this window. */
15460 PT
>= CHARPOS (startp
)
15461 /* Selective display hasn't changed. */
15462 && !current_buffer
->clip_changed
15463 /* Function force-mode-line-update is used to force a thorough
15464 redisplay. It sets either windows_or_buffers_changed or
15465 update_mode_lines. So don't take a shortcut here for these
15467 && !update_mode_lines
15468 && !windows_or_buffers_changed
15469 && !f
->cursor_type_changed
15470 && NILP (Vshow_trailing_whitespace
)
15471 /* This code is not used for mini-buffer for the sake of the case
15472 of redisplaying to replace an echo area message; since in
15473 that case the mini-buffer contents per se are usually
15474 unchanged. This code is of no real use in the mini-buffer
15475 since the handling of this_line_start_pos, etc., in redisplay
15476 handles the same cases. */
15477 && !EQ (window
, minibuf_window
)
15478 && (FRAME_WINDOW_P (f
)
15479 || !overlay_arrow_in_current_buffer_p ()))
15481 int this_scroll_margin
, top_scroll_margin
;
15482 struct glyph_row
*row
= NULL
;
15483 int frame_line_height
= default_line_pixel_height (w
);
15484 int window_total_lines
15485 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15488 debug_method_add (w
, "cursor movement");
15491 /* Scroll if point within this distance from the top or bottom
15492 of the window. This is a pixel value. */
15493 if (scroll_margin
> 0)
15495 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15496 this_scroll_margin
*= frame_line_height
;
15499 this_scroll_margin
= 0;
15501 top_scroll_margin
= this_scroll_margin
;
15502 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15503 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15505 /* Start with the row the cursor was displayed during the last
15506 not paused redisplay. Give up if that row is not valid. */
15507 if (w
->last_cursor_vpos
< 0
15508 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15509 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15512 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15513 if (row
->mode_line_p
)
15515 if (!row
->enabled_p
)
15516 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15519 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15521 int scroll_p
= 0, must_scroll
= 0;
15522 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15524 if (PT
> w
->last_point
)
15526 /* Point has moved forward. */
15527 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15528 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15530 eassert (row
->enabled_p
);
15534 /* If the end position of a row equals the start
15535 position of the next row, and PT is at that position,
15536 we would rather display cursor in the next line. */
15537 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15538 && MATRIX_ROW_END_CHARPOS (row
) == PT
15539 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15540 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15541 && !cursor_row_p (row
))
15544 /* If within the scroll margin, scroll. Note that
15545 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15546 the next line would be drawn, and that
15547 this_scroll_margin can be zero. */
15548 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15549 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15550 /* Line is completely visible last line in window
15551 and PT is to be set in the next line. */
15552 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15553 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15554 && !row
->ends_at_zv_p
15555 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15558 else if (PT
< w
->last_point
)
15560 /* Cursor has to be moved backward. Note that PT >=
15561 CHARPOS (startp) because of the outer if-statement. */
15562 while (!row
->mode_line_p
15563 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15564 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15565 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15566 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15567 row
> w
->current_matrix
->rows
15568 && (row
-1)->ends_in_newline_from_string_p
))))
15569 && (row
->y
> top_scroll_margin
15570 || CHARPOS (startp
) == BEGV
))
15572 eassert (row
->enabled_p
);
15576 /* Consider the following case: Window starts at BEGV,
15577 there is invisible, intangible text at BEGV, so that
15578 display starts at some point START > BEGV. It can
15579 happen that we are called with PT somewhere between
15580 BEGV and START. Try to handle that case. */
15581 if (row
< w
->current_matrix
->rows
15582 || row
->mode_line_p
)
15584 row
= w
->current_matrix
->rows
;
15585 if (row
->mode_line_p
)
15589 /* Due to newlines in overlay strings, we may have to
15590 skip forward over overlay strings. */
15591 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15592 && MATRIX_ROW_END_CHARPOS (row
) == PT
15593 && !cursor_row_p (row
))
15596 /* If within the scroll margin, scroll. */
15597 if (row
->y
< top_scroll_margin
15598 && CHARPOS (startp
) != BEGV
)
15603 /* Cursor did not move. So don't scroll even if cursor line
15604 is partially visible, as it was so before. */
15605 rc
= CURSOR_MOVEMENT_SUCCESS
;
15608 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15609 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15611 /* if PT is not in the glyph row, give up. */
15612 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15615 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15616 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15618 struct glyph_row
*row1
;
15620 /* If rows are bidi-reordered and point moved, back up
15621 until we find a row that does not belong to a
15622 continuation line. This is because we must consider
15623 all rows of a continued line as candidates for the
15624 new cursor positioning, since row start and end
15625 positions change non-linearly with vertical position
15627 /* FIXME: Revisit this when glyph ``spilling'' in
15628 continuation lines' rows is implemented for
15629 bidi-reordered rows. */
15630 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15631 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15634 /* If we hit the beginning of the displayed portion
15635 without finding the first row of a continued
15639 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15642 eassert (row
->enabled_p
);
15647 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15648 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15649 /* Make sure this isn't a header line by any chance, since
15650 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15651 && !row
->mode_line_p
15652 && make_cursor_line_fully_visible_p
)
15654 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15655 && !row
->ends_at_zv_p
15656 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15657 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15658 else if (row
->height
> window_box_height (w
))
15660 /* If we end up in a partially visible line, let's
15661 make it fully visible, except when it's taller
15662 than the window, in which case we can't do much
15665 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15669 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15670 if (!cursor_row_fully_visible_p (w
, 0, 1))
15671 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15673 rc
= CURSOR_MOVEMENT_SUCCESS
;
15677 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15678 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15679 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15681 /* With bidi-reordered rows, there could be more than
15682 one candidate row whose start and end positions
15683 occlude point. We need to let set_cursor_from_row
15684 find the best candidate. */
15685 /* FIXME: Revisit this when glyph ``spilling'' in
15686 continuation lines' rows is implemented for
15687 bidi-reordered rows. */
15692 int at_zv_p
= 0, exact_match_p
= 0;
15694 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15695 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15696 && cursor_row_p (row
))
15697 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15699 /* As soon as we've found the exact match for point,
15700 or the first suitable row whose ends_at_zv_p flag
15701 is set, we are done. */
15704 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15705 w
->cursor
.vpos
)->ends_at_zv_p
;
15707 && w
->cursor
.hpos
>= 0
15708 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15711 struct glyph_row
*candidate
=
15712 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15714 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15715 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15718 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15719 || (NILP (g
->object
)
15720 && (g
->charpos
== PT
15721 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15723 if (at_zv_p
|| exact_match_p
)
15725 rc
= CURSOR_MOVEMENT_SUCCESS
;
15729 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15733 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15734 || row
->continued_p
)
15735 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15736 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15737 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15738 /* If we didn't find any candidate rows, or exited the
15739 loop before all the candidates were examined, signal
15740 to the caller that this method failed. */
15741 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15743 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15744 && !row
->continued_p
))
15745 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15747 rc
= CURSOR_MOVEMENT_SUCCESS
;
15753 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15755 rc
= CURSOR_MOVEMENT_SUCCESS
;
15760 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15761 && MATRIX_ROW_START_CHARPOS (row
) == PT
15762 && cursor_row_p (row
));
15772 set_vertical_scroll_bar (struct window
*w
)
15774 ptrdiff_t start
, end
, whole
;
15776 /* Calculate the start and end positions for the current window.
15777 At some point, it would be nice to choose between scrollbars
15778 which reflect the whole buffer size, with special markers
15779 indicating narrowing, and scrollbars which reflect only the
15782 Note that mini-buffers sometimes aren't displaying any text. */
15783 if (!MINI_WINDOW_P (w
)
15784 || (w
== XWINDOW (minibuf_window
)
15785 && NILP (echo_area_buffer
[0])))
15787 struct buffer
*buf
= XBUFFER (w
->contents
);
15788 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15789 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15790 /* I don't think this is guaranteed to be right. For the
15791 moment, we'll pretend it is. */
15792 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15796 if (whole
< (end
- start
))
15797 whole
= end
- start
;
15800 start
= end
= whole
= 0;
15802 /* Indicate what this scroll bar ought to be displaying now. */
15803 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15804 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15805 (w
, end
- start
, whole
, start
);
15810 set_horizontal_scroll_bar (struct window
*w
)
15812 int start
, end
, whole
, portion
;
15814 if (!MINI_WINDOW_P (w
)
15815 || (w
== XWINDOW (minibuf_window
)
15816 && NILP (echo_area_buffer
[0])))
15818 struct buffer
*b
= XBUFFER (w
->contents
);
15819 struct buffer
*old_buffer
= NULL
;
15821 struct text_pos startp
;
15823 if (b
!= current_buffer
)
15825 old_buffer
= current_buffer
;
15826 set_buffer_internal (b
);
15829 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15830 start_display (&it
, w
, startp
);
15831 it
.last_visible_x
= INT_MAX
;
15832 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15833 MOVE_TO_X
| MOVE_TO_Y
);
15834 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15835 window_box_height (w), -1,
15836 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15838 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15839 end
= start
+ window_box_width (w
, TEXT_AREA
);
15840 portion
= end
- start
;
15841 /* After enlarging a horizontally scrolled window such that it
15842 gets at least as wide as the text it contains, make sure that
15843 the thumb doesn't fill the entire scroll bar so we can still
15844 drag it back to see the entire text. */
15845 whole
= max (whole
, end
);
15851 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15852 if (EQ (pdir
, Qright_to_left
))
15854 start
= whole
- end
;
15855 end
= start
+ portion
;
15860 set_buffer_internal (old_buffer
);
15863 start
= end
= whole
= portion
= 0;
15865 w
->hscroll_whole
= whole
;
15867 /* Indicate what this scroll bar ought to be displaying now. */
15868 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15869 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15870 (w
, portion
, whole
, start
);
15874 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15875 selected_window is redisplayed.
15877 We can return without actually redisplaying the window if fonts has been
15878 changed on window's frame. In that case, redisplay_internal will retry.
15880 As one of the important parts of redisplaying a window, we need to
15881 decide whether the previous window-start position (stored in the
15882 window's w->start marker position) is still valid, and if it isn't,
15883 recompute it. Some details about that:
15885 . The previous window-start could be in a continuation line, in
15886 which case we need to recompute it when the window width
15887 changes. See compute_window_start_on_continuation_line and its
15890 . The text that changed since last redisplay could include the
15891 previous window-start position. In that case, we try to salvage
15892 what we can from the current glyph matrix by calling
15893 try_scrolling, which see.
15895 . Some Emacs command could force us to use a specific window-start
15896 position by setting the window's force_start flag, or gently
15897 propose doing that by setting the window's optional_new_start
15898 flag. In these cases, we try using the specified start point if
15899 that succeeds (i.e. the window desired matrix is successfully
15900 recomputed, and point location is within the window). In case
15901 of optional_new_start, we first check if the specified start
15902 position is feasible, i.e. if it will allow point to be
15903 displayed in the window. If using the specified start point
15904 fails, e.g., if new fonts are needed to be loaded, we abort the
15905 redisplay cycle and leave it up to the next cycle to figure out
15908 . Note that the window's force_start flag is sometimes set by
15909 redisplay itself, when it decides that the previous window start
15910 point is fine and should be kept. Search for "goto force_start"
15911 below to see the details. Like the values of window-start
15912 specified outside of redisplay, these internally-deduced values
15913 are tested for feasibility, and ignored if found to be
15916 . Note that the function try_window, used to completely redisplay
15917 a window, accepts the window's start point as its argument.
15918 This is used several times in the redisplay code to control
15919 where the window start will be, according to user options such
15920 as scroll-conservatively, and also to ensure the screen line
15921 showing point will be fully (as opposed to partially) visible on
15925 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15927 struct window
*w
= XWINDOW (window
);
15928 struct frame
*f
= XFRAME (w
->frame
);
15929 struct buffer
*buffer
= XBUFFER (w
->contents
);
15930 struct buffer
*old
= current_buffer
;
15931 struct text_pos lpoint
, opoint
, startp
;
15932 int update_mode_line
;
15935 /* Record it now because it's overwritten. */
15936 bool current_matrix_up_to_date_p
= false;
15937 bool used_current_matrix_p
= false;
15938 /* This is less strict than current_matrix_up_to_date_p.
15939 It indicates that the buffer contents and narrowing are unchanged. */
15940 bool buffer_unchanged_p
= false;
15941 int temp_scroll_step
= 0;
15942 ptrdiff_t count
= SPECPDL_INDEX ();
15944 int centering_position
= -1;
15945 int last_line_misfit
= 0;
15946 ptrdiff_t beg_unchanged
, end_unchanged
;
15947 int frame_line_height
;
15949 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15953 *w
->desired_matrix
->method
= 0;
15956 if (!just_this_one_p
15957 && REDISPLAY_SOME_P ()
15960 && !buffer
->text
->redisplay
15961 && BUF_PT (buffer
) == w
->last_point
)
15964 /* Make sure that both W's markers are valid. */
15965 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15966 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15968 /* We come here again if we need to run window-text-change-functions
15971 reconsider_clip_changes (w
);
15972 frame_line_height
= default_line_pixel_height (w
);
15974 /* Has the mode line to be updated? */
15975 update_mode_line
= (w
->update_mode_line
15976 || update_mode_lines
15977 || buffer
->clip_changed
15978 || buffer
->prevent_redisplay_optimizations_p
);
15980 if (!just_this_one_p
)
15981 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15982 cleverly elsewhere. */
15983 w
->must_be_updated_p
= true;
15985 if (MINI_WINDOW_P (w
))
15987 if (w
== XWINDOW (echo_area_window
)
15988 && !NILP (echo_area_buffer
[0]))
15990 if (update_mode_line
)
15991 /* We may have to update a tty frame's menu bar or a
15992 tool-bar. Example `M-x C-h C-h C-g'. */
15993 goto finish_menu_bars
;
15995 /* We've already displayed the echo area glyphs in this window. */
15996 goto finish_scroll_bars
;
15998 else if ((w
!= XWINDOW (minibuf_window
)
15999 || minibuf_level
== 0)
16000 /* When buffer is nonempty, redisplay window normally. */
16001 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16002 /* Quail displays non-mini buffers in minibuffer window.
16003 In that case, redisplay the window normally. */
16004 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16006 /* W is a mini-buffer window, but it's not active, so clear
16008 int yb
= window_text_bottom_y (w
);
16009 struct glyph_row
*row
;
16012 for (y
= 0, row
= w
->desired_matrix
->rows
;
16014 y
+= row
->height
, ++row
)
16015 blank_row (w
, row
, y
);
16016 goto finish_scroll_bars
;
16019 clear_glyph_matrix (w
->desired_matrix
);
16022 /* Otherwise set up data on this window; select its buffer and point
16024 /* Really select the buffer, for the sake of buffer-local
16026 set_buffer_internal_1 (XBUFFER (w
->contents
));
16028 current_matrix_up_to_date_p
16029 = (w
->window_end_valid
16030 && !current_buffer
->clip_changed
16031 && !current_buffer
->prevent_redisplay_optimizations_p
16032 && !window_outdated (w
));
16034 /* Run the window-text-change-functions
16035 if it is possible that the text on the screen has changed
16036 (either due to modification of the text, or any other reason). */
16037 if (!current_matrix_up_to_date_p
16038 && !NILP (Vwindow_text_change_functions
))
16040 safe_run_hooks (Qwindow_text_change_functions
);
16044 beg_unchanged
= BEG_UNCHANGED
;
16045 end_unchanged
= END_UNCHANGED
;
16047 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16049 specbind (Qinhibit_point_motion_hooks
, Qt
);
16052 = (w
->window_end_valid
16053 && !current_buffer
->clip_changed
16054 && !window_outdated (w
));
16056 /* When windows_or_buffers_changed is non-zero, we can't rely
16057 on the window end being valid, so set it to zero there. */
16058 if (windows_or_buffers_changed
)
16060 /* If window starts on a continuation line, maybe adjust the
16061 window start in case the window's width changed. */
16062 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16063 compute_window_start_on_continuation_line (w
);
16065 w
->window_end_valid
= false;
16066 /* If so, we also can't rely on current matrix
16067 and should not fool try_cursor_movement below. */
16068 current_matrix_up_to_date_p
= false;
16071 /* Some sanity checks. */
16072 CHECK_WINDOW_END (w
);
16073 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16075 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16078 if (mode_line_update_needed (w
))
16079 update_mode_line
= 1;
16081 /* Point refers normally to the selected window. For any other
16082 window, set up appropriate value. */
16083 if (!EQ (window
, selected_window
))
16085 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16086 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16091 new_pt_byte
= BEGV_BYTE
;
16092 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16094 else if (new_pt
> (ZV
- 1))
16097 new_pt_byte
= ZV_BYTE
;
16098 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16101 /* We don't use SET_PT so that the point-motion hooks don't run. */
16102 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16105 /* If any of the character widths specified in the display table
16106 have changed, invalidate the width run cache. It's true that
16107 this may be a bit late to catch such changes, but the rest of
16108 redisplay goes (non-fatally) haywire when the display table is
16109 changed, so why should we worry about doing any better? */
16110 if (current_buffer
->width_run_cache
16111 || (current_buffer
->base_buffer
16112 && current_buffer
->base_buffer
->width_run_cache
))
16114 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16116 if (! disptab_matches_widthtab
16117 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16119 struct buffer
*buf
= current_buffer
;
16121 if (buf
->base_buffer
)
16122 buf
= buf
->base_buffer
;
16123 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16124 recompute_width_table (current_buffer
, disptab
);
16128 /* If window-start is screwed up, choose a new one. */
16129 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16132 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16134 /* If someone specified a new starting point but did not insist,
16135 check whether it can be used. */
16136 if ((w
->optional_new_start
|| window_frozen_p (w
))
16137 && CHARPOS (startp
) >= BEGV
16138 && CHARPOS (startp
) <= ZV
)
16140 ptrdiff_t it_charpos
;
16142 w
->optional_new_start
= 0;
16143 start_display (&it
, w
, startp
);
16144 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16145 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16146 /* Record IT's position now, since line_bottom_y might change
16148 it_charpos
= IT_CHARPOS (it
);
16149 /* Make sure we set the force_start flag only if the cursor row
16150 will be fully visible. Otherwise, the code under force_start
16151 label below will try to move point back into view, which is
16152 not what the code which sets optional_new_start wants. */
16153 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16154 && !w
->force_start
)
16156 if (it_charpos
== PT
)
16157 w
->force_start
= 1;
16158 /* IT may overshoot PT if text at PT is invisible. */
16159 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16160 w
->force_start
= 1;
16162 if (w
->force_start
)
16164 if (window_frozen_p (w
))
16165 debug_method_add (w
, "set force_start from frozen window start");
16167 debug_method_add (w
, "set force_start from optional_new_start");
16175 /* Handle case where place to start displaying has been specified,
16176 unless the specified location is outside the accessible range. */
16177 if (w
->force_start
)
16179 /* We set this later on if we have to adjust point. */
16182 w
->force_start
= 0;
16184 w
->window_end_valid
= 0;
16186 /* Forget any recorded base line for line number display. */
16187 if (!buffer_unchanged_p
)
16188 w
->base_line_number
= 0;
16190 /* Redisplay the mode line. Select the buffer properly for that.
16191 Also, run the hook window-scroll-functions
16192 because we have scrolled. */
16193 /* Note, we do this after clearing force_start because
16194 if there's an error, it is better to forget about force_start
16195 than to get into an infinite loop calling the hook functions
16196 and having them get more errors. */
16197 if (!update_mode_line
16198 || ! NILP (Vwindow_scroll_functions
))
16200 update_mode_line
= 1;
16201 w
->update_mode_line
= 1;
16202 startp
= run_window_scroll_functions (window
, startp
);
16205 if (CHARPOS (startp
) < BEGV
)
16206 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16207 else if (CHARPOS (startp
) > ZV
)
16208 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16210 /* Redisplay, then check if cursor has been set during the
16211 redisplay. Give up if new fonts were loaded. */
16212 /* We used to issue a CHECK_MARGINS argument to try_window here,
16213 but this causes scrolling to fail when point begins inside
16214 the scroll margin (bug#148) -- cyd */
16215 if (!try_window (window
, startp
, 0))
16217 w
->force_start
= 1;
16218 clear_glyph_matrix (w
->desired_matrix
);
16219 goto need_larger_matrices
;
16222 if (w
->cursor
.vpos
< 0)
16224 /* If point does not appear, try to move point so it does
16225 appear. The desired matrix has been built above, so we
16226 can use it here. */
16227 new_vpos
= window_box_height (w
) / 2;
16230 if (!cursor_row_fully_visible_p (w
, 0, 0))
16232 /* Point does appear, but on a line partly visible at end of window.
16233 Move it back to a fully-visible line. */
16234 new_vpos
= window_box_height (w
);
16235 /* But if window_box_height suggests a Y coordinate that is
16236 not less than we already have, that line will clearly not
16237 be fully visible, so give up and scroll the display.
16238 This can happen when the default face uses a font whose
16239 dimensions are different from the frame's default
16241 if (new_vpos
>= w
->cursor
.y
)
16243 w
->cursor
.vpos
= -1;
16244 clear_glyph_matrix (w
->desired_matrix
);
16245 goto try_to_scroll
;
16248 else if (w
->cursor
.vpos
>= 0)
16250 /* Some people insist on not letting point enter the scroll
16251 margin, even though this part handles windows that didn't
16253 int window_total_lines
16254 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16255 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16256 int pixel_margin
= margin
* frame_line_height
;
16257 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16259 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16260 below, which finds the row to move point to, advances by
16261 the Y coordinate of the _next_ row, see the definition of
16262 MATRIX_ROW_BOTTOM_Y. */
16263 if (w
->cursor
.vpos
< margin
+ header_line
)
16265 w
->cursor
.vpos
= -1;
16266 clear_glyph_matrix (w
->desired_matrix
);
16267 goto try_to_scroll
;
16271 int window_height
= window_box_height (w
);
16274 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16275 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16277 w
->cursor
.vpos
= -1;
16278 clear_glyph_matrix (w
->desired_matrix
);
16279 goto try_to_scroll
;
16284 /* If we need to move point for either of the above reasons,
16285 now actually do it. */
16288 struct glyph_row
*row
;
16290 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16291 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16294 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16295 MATRIX_ROW_START_BYTEPOS (row
));
16297 if (w
!= XWINDOW (selected_window
))
16298 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16299 else if (current_buffer
== old
)
16300 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16302 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16304 /* Re-run pre-redisplay-function so it can update the region
16305 according to the new position of point. */
16306 /* Other than the cursor, w's redisplay is done so we can set its
16307 redisplay to false. Also the buffer's redisplay can be set to
16308 false, since propagate_buffer_redisplay should have already
16309 propagated its info to `w' anyway. */
16310 w
->redisplay
= false;
16311 XBUFFER (w
->contents
)->text
->redisplay
= false;
16312 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16314 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16316 /* pre-redisplay-function made changes (e.g. move the region)
16317 that require another round of redisplay. */
16318 clear_glyph_matrix (w
->desired_matrix
);
16319 if (!try_window (window
, startp
, 0))
16320 goto need_larger_matrices
;
16323 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, 0, 0))
16325 clear_glyph_matrix (w
->desired_matrix
);
16326 goto try_to_scroll
;
16330 debug_method_add (w
, "forced window start");
16335 /* Handle case where text has not changed, only point, and it has
16336 not moved off the frame, and we are not retrying after hscroll.
16337 (current_matrix_up_to_date_p is nonzero when retrying.) */
16338 if (current_matrix_up_to_date_p
16339 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16340 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16344 case CURSOR_MOVEMENT_SUCCESS
:
16345 used_current_matrix_p
= 1;
16348 case CURSOR_MOVEMENT_MUST_SCROLL
:
16349 goto try_to_scroll
;
16355 /* If current starting point was originally the beginning of a line
16356 but no longer is, find a new starting point. */
16357 else if (w
->start_at_line_beg
16358 && !(CHARPOS (startp
) <= BEGV
16359 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16362 debug_method_add (w
, "recenter 1");
16367 /* Try scrolling with try_window_id. Value is > 0 if update has
16368 been done, it is -1 if we know that the same window start will
16369 not work. It is 0 if unsuccessful for some other reason. */
16370 else if ((tem
= try_window_id (w
)) != 0)
16373 debug_method_add (w
, "try_window_id %d", tem
);
16376 if (f
->fonts_changed
)
16377 goto need_larger_matrices
;
16381 /* Otherwise try_window_id has returned -1 which means that we
16382 don't want the alternative below this comment to execute. */
16384 else if (CHARPOS (startp
) >= BEGV
16385 && CHARPOS (startp
) <= ZV
16386 && PT
>= CHARPOS (startp
)
16387 && (CHARPOS (startp
) < ZV
16388 /* Avoid starting at end of buffer. */
16389 || CHARPOS (startp
) == BEGV
16390 || !window_outdated (w
)))
16392 int d1
, d2
, d5
, d6
;
16395 /* If first window line is a continuation line, and window start
16396 is inside the modified region, but the first change is before
16397 current window start, we must select a new window start.
16399 However, if this is the result of a down-mouse event (e.g. by
16400 extending the mouse-drag-overlay), we don't want to select a
16401 new window start, since that would change the position under
16402 the mouse, resulting in an unwanted mouse-movement rather
16403 than a simple mouse-click. */
16404 if (!w
->start_at_line_beg
16405 && NILP (do_mouse_tracking
)
16406 && CHARPOS (startp
) > BEGV
16407 && CHARPOS (startp
) > BEG
+ beg_unchanged
16408 && CHARPOS (startp
) <= Z
- end_unchanged
16409 /* Even if w->start_at_line_beg is nil, a new window may
16410 start at a line_beg, since that's how set_buffer_window
16411 sets it. So, we need to check the return value of
16412 compute_window_start_on_continuation_line. (See also
16414 && XMARKER (w
->start
)->buffer
== current_buffer
16415 && compute_window_start_on_continuation_line (w
)
16416 /* It doesn't make sense to force the window start like we
16417 do at label force_start if it is already known that point
16418 will not be fully visible in the resulting window, because
16419 doing so will move point from its correct position
16420 instead of scrolling the window to bring point into view.
16422 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16423 /* A very tall row could need more than the window height,
16424 in which case we accept that it is partially visible. */
16425 && (rtop
!= 0) == (rbot
!= 0))
16427 w
->force_start
= 1;
16428 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16430 debug_method_add (w
, "recomputed window start in continuation line");
16436 debug_method_add (w
, "same window start");
16439 /* Try to redisplay starting at same place as before.
16440 If point has not moved off frame, accept the results. */
16441 if (!current_matrix_up_to_date_p
16442 /* Don't use try_window_reusing_current_matrix in this case
16443 because a window scroll function can have changed the
16445 || !NILP (Vwindow_scroll_functions
)
16446 || MINI_WINDOW_P (w
)
16447 || !(used_current_matrix_p
16448 = try_window_reusing_current_matrix (w
)))
16450 IF_DEBUG (debug_method_add (w
, "1"));
16451 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16452 /* -1 means we need to scroll.
16453 0 means we need new matrices, but fonts_changed
16454 is set in that case, so we will detect it below. */
16455 goto try_to_scroll
;
16458 if (f
->fonts_changed
)
16459 goto need_larger_matrices
;
16461 if (w
->cursor
.vpos
>= 0)
16463 if (!just_this_one_p
16464 || current_buffer
->clip_changed
16465 || BEG_UNCHANGED
< CHARPOS (startp
))
16466 /* Forget any recorded base line for line number display. */
16467 w
->base_line_number
= 0;
16469 if (!cursor_row_fully_visible_p (w
, 1, 0))
16471 clear_glyph_matrix (w
->desired_matrix
);
16472 last_line_misfit
= 1;
16474 /* Drop through and scroll. */
16479 clear_glyph_matrix (w
->desired_matrix
);
16484 /* Redisplay the mode line. Select the buffer properly for that. */
16485 if (!update_mode_line
)
16487 update_mode_line
= 1;
16488 w
->update_mode_line
= 1;
16491 /* Try to scroll by specified few lines. */
16492 if ((scroll_conservatively
16493 || emacs_scroll_step
16494 || temp_scroll_step
16495 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16496 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16497 && CHARPOS (startp
) >= BEGV
16498 && CHARPOS (startp
) <= ZV
)
16500 /* The function returns -1 if new fonts were loaded, 1 if
16501 successful, 0 if not successful. */
16502 int ss
= try_scrolling (window
, just_this_one_p
,
16503 scroll_conservatively
,
16505 temp_scroll_step
, last_line_misfit
);
16508 case SCROLLING_SUCCESS
:
16511 case SCROLLING_NEED_LARGER_MATRICES
:
16512 goto need_larger_matrices
;
16514 case SCROLLING_FAILED
:
16522 /* Finally, just choose a place to start which positions point
16523 according to user preferences. */
16528 debug_method_add (w
, "recenter");
16531 /* Forget any previously recorded base line for line number display. */
16532 if (!buffer_unchanged_p
)
16533 w
->base_line_number
= 0;
16535 /* Determine the window start relative to point. */
16536 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16537 it
.current_y
= it
.last_visible_y
;
16538 if (centering_position
< 0)
16540 int window_total_lines
16541 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16543 = scroll_margin
> 0
16544 ? min (scroll_margin
, window_total_lines
/ 4)
16546 ptrdiff_t margin_pos
= CHARPOS (startp
);
16547 Lisp_Object aggressive
;
16550 /* If there is a scroll margin at the top of the window, find
16551 its character position. */
16553 /* Cannot call start_display if startp is not in the
16554 accessible region of the buffer. This can happen when we
16555 have just switched to a different buffer and/or changed
16556 its restriction. In that case, startp is initialized to
16557 the character position 1 (BEGV) because we did not yet
16558 have chance to display the buffer even once. */
16559 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16562 void *it1data
= NULL
;
16564 SAVE_IT (it1
, it
, it1data
);
16565 start_display (&it1
, w
, startp
);
16566 move_it_vertically (&it1
, margin
* frame_line_height
);
16567 margin_pos
= IT_CHARPOS (it1
);
16568 RESTORE_IT (&it
, &it
, it1data
);
16570 scrolling_up
= PT
> margin_pos
;
16573 ? BVAR (current_buffer
, scroll_up_aggressively
)
16574 : BVAR (current_buffer
, scroll_down_aggressively
);
16576 if (!MINI_WINDOW_P (w
)
16577 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16581 /* Setting scroll-conservatively overrides
16582 scroll-*-aggressively. */
16583 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16585 double float_amount
= XFLOATINT (aggressive
);
16587 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16588 if (pt_offset
== 0 && float_amount
> 0)
16590 if (pt_offset
&& margin
> 0)
16593 /* Compute how much to move the window start backward from
16594 point so that point will be displayed where the user
16598 centering_position
= it
.last_visible_y
;
16600 centering_position
-= pt_offset
;
16601 centering_position
-=
16602 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16603 + WINDOW_HEADER_LINE_HEIGHT (w
);
16604 /* Don't let point enter the scroll margin near top of
16606 if (centering_position
< margin
* frame_line_height
)
16607 centering_position
= margin
* frame_line_height
;
16610 centering_position
= margin
* frame_line_height
+ pt_offset
;
16613 /* Set the window start half the height of the window backward
16615 centering_position
= window_box_height (w
) / 2;
16617 move_it_vertically_backward (&it
, centering_position
);
16619 eassert (IT_CHARPOS (it
) >= BEGV
);
16621 /* The function move_it_vertically_backward may move over more
16622 than the specified y-distance. If it->w is small, e.g. a
16623 mini-buffer window, we may end up in front of the window's
16624 display area. Start displaying at the start of the line
16625 containing PT in this case. */
16626 if (it
.current_y
<= 0)
16628 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16629 move_it_vertically_backward (&it
, 0);
16633 it
.current_x
= it
.hpos
= 0;
16635 /* Set the window start position here explicitly, to avoid an
16636 infinite loop in case the functions in window-scroll-functions
16638 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16640 /* Run scroll hooks. */
16641 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16643 /* Redisplay the window. */
16644 if (!current_matrix_up_to_date_p
16645 || windows_or_buffers_changed
16646 || f
->cursor_type_changed
16647 /* Don't use try_window_reusing_current_matrix in this case
16648 because it can have changed the buffer. */
16649 || !NILP (Vwindow_scroll_functions
)
16650 || !just_this_one_p
16651 || MINI_WINDOW_P (w
)
16652 || !(used_current_matrix_p
16653 = try_window_reusing_current_matrix (w
)))
16654 try_window (window
, startp
, 0);
16656 /* If new fonts have been loaded (due to fontsets), give up. We
16657 have to start a new redisplay since we need to re-adjust glyph
16659 if (f
->fonts_changed
)
16660 goto need_larger_matrices
;
16662 /* If cursor did not appear assume that the middle of the window is
16663 in the first line of the window. Do it again with the next line.
16664 (Imagine a window of height 100, displaying two lines of height
16665 60. Moving back 50 from it->last_visible_y will end in the first
16667 if (w
->cursor
.vpos
< 0)
16669 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16671 clear_glyph_matrix (w
->desired_matrix
);
16672 move_it_by_lines (&it
, 1);
16673 try_window (window
, it
.current
.pos
, 0);
16675 else if (PT
< IT_CHARPOS (it
))
16677 clear_glyph_matrix (w
->desired_matrix
);
16678 move_it_by_lines (&it
, -1);
16679 try_window (window
, it
.current
.pos
, 0);
16683 /* Not much we can do about it. */
16687 /* Consider the following case: Window starts at BEGV, there is
16688 invisible, intangible text at BEGV, so that display starts at
16689 some point START > BEGV. It can happen that we are called with
16690 PT somewhere between BEGV and START. Try to handle that case,
16691 and similar ones. */
16692 if (w
->cursor
.vpos
< 0)
16694 /* First, try locating the proper glyph row for PT. */
16695 struct glyph_row
*row
=
16696 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16698 /* Sometimes point is at the beginning of invisible text that is
16699 before the 1st character displayed in the row. In that case,
16700 row_containing_pos fails to find the row, because no glyphs
16701 with appropriate buffer positions are present in the row.
16702 Therefore, we next try to find the row which shows the 1st
16703 position after the invisible text. */
16707 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16710 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16713 Lisp_Object invis_end
=
16714 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16717 if (NATNUMP (invis_end
))
16718 alt_pos
= XFASTINT (invis_end
);
16721 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16725 /* Finally, fall back on the first row of the window after the
16726 header line (if any). This is slightly better than not
16727 displaying the cursor at all. */
16730 row
= w
->current_matrix
->rows
;
16731 if (row
->mode_line_p
)
16734 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16737 if (!cursor_row_fully_visible_p (w
, 0, 0))
16739 /* If vscroll is enabled, disable it and try again. */
16743 clear_glyph_matrix (w
->desired_matrix
);
16747 /* Users who set scroll-conservatively to a large number want
16748 point just above/below the scroll margin. If we ended up
16749 with point's row partially visible, move the window start to
16750 make that row fully visible and out of the margin. */
16751 if (scroll_conservatively
> SCROLL_LIMIT
)
16753 int window_total_lines
16754 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16757 ? min (scroll_margin
, window_total_lines
/ 4)
16759 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16761 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16762 clear_glyph_matrix (w
->desired_matrix
);
16763 if (1 == try_window (window
, it
.current
.pos
,
16764 TRY_WINDOW_CHECK_MARGINS
))
16768 /* If centering point failed to make the whole line visible,
16769 put point at the top instead. That has to make the whole line
16770 visible, if it can be done. */
16771 if (centering_position
== 0)
16774 clear_glyph_matrix (w
->desired_matrix
);
16775 centering_position
= 0;
16781 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16782 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16783 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16785 /* Display the mode line, if we must. */
16786 if ((update_mode_line
16787 /* If window not full width, must redo its mode line
16788 if (a) the window to its side is being redone and
16789 (b) we do a frame-based redisplay. This is a consequence
16790 of how inverted lines are drawn in frame-based redisplay. */
16791 || (!just_this_one_p
16792 && !FRAME_WINDOW_P (f
)
16793 && !WINDOW_FULL_WIDTH_P (w
))
16794 /* Line number to display. */
16795 || w
->base_line_pos
> 0
16796 /* Column number is displayed and different from the one displayed. */
16797 || (w
->column_number_displayed
!= -1
16798 && (w
->column_number_displayed
!= current_column ())))
16799 /* This means that the window has a mode line. */
16800 && (WINDOW_WANTS_MODELINE_P (w
)
16801 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16804 display_mode_lines (w
);
16806 /* If mode line height has changed, arrange for a thorough
16807 immediate redisplay using the correct mode line height. */
16808 if (WINDOW_WANTS_MODELINE_P (w
)
16809 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16811 f
->fonts_changed
= 1;
16812 w
->mode_line_height
= -1;
16813 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16814 = DESIRED_MODE_LINE_HEIGHT (w
);
16817 /* If header line height has changed, arrange for a thorough
16818 immediate redisplay using the correct header line height. */
16819 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16820 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16822 f
->fonts_changed
= 1;
16823 w
->header_line_height
= -1;
16824 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16825 = DESIRED_HEADER_LINE_HEIGHT (w
);
16828 if (f
->fonts_changed
)
16829 goto need_larger_matrices
;
16832 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16834 w
->base_line_pos
= 0;
16835 w
->base_line_number
= 0;
16840 /* When we reach a frame's selected window, redo the frame's menu bar. */
16841 if (update_mode_line
16842 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16844 int redisplay_menu_p
= 0;
16846 if (FRAME_WINDOW_P (f
))
16848 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16849 || defined (HAVE_NS) || defined (USE_GTK)
16850 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16852 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16856 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16858 if (redisplay_menu_p
)
16859 display_menu_bar (w
);
16861 #ifdef HAVE_WINDOW_SYSTEM
16862 if (FRAME_WINDOW_P (f
))
16864 #if defined (USE_GTK) || defined (HAVE_NS)
16865 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16866 redisplay_tool_bar (f
);
16868 if (WINDOWP (f
->tool_bar_window
)
16869 && (FRAME_TOOL_BAR_LINES (f
) > 0
16870 || !NILP (Vauto_resize_tool_bars
))
16871 && redisplay_tool_bar (f
))
16872 ignore_mouse_drag_p
= 1;
16878 #ifdef HAVE_WINDOW_SYSTEM
16879 if (FRAME_WINDOW_P (f
)
16880 && update_window_fringes (w
, (just_this_one_p
16881 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16882 || w
->pseudo_window_p
)))
16886 if (draw_window_fringes (w
, 1))
16888 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16889 x_draw_right_divider (w
);
16891 x_draw_vertical_border (w
);
16897 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16898 x_draw_bottom_divider (w
);
16899 #endif /* HAVE_WINDOW_SYSTEM */
16901 /* We go to this label, with fonts_changed set, if it is
16902 necessary to try again using larger glyph matrices.
16903 We have to redeem the scroll bar even in this case,
16904 because the loop in redisplay_internal expects that. */
16905 need_larger_matrices
:
16907 finish_scroll_bars
:
16909 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16911 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16912 /* Set the thumb's position and size. */
16913 set_vertical_scroll_bar (w
);
16915 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16916 /* Set the thumb's position and size. */
16917 set_horizontal_scroll_bar (w
);
16919 /* Note that we actually used the scroll bar attached to this
16920 window, so it shouldn't be deleted at the end of redisplay. */
16921 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16922 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16925 /* Restore current_buffer and value of point in it. The window
16926 update may have changed the buffer, so first make sure `opoint'
16927 is still valid (Bug#6177). */
16928 if (CHARPOS (opoint
) < BEGV
)
16929 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16930 else if (CHARPOS (opoint
) > ZV
)
16931 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16933 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16935 set_buffer_internal_1 (old
);
16936 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16937 shorter. This can be caused by log truncation in *Messages*. */
16938 if (CHARPOS (lpoint
) <= ZV
)
16939 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16941 unbind_to (count
, Qnil
);
16945 /* Build the complete desired matrix of WINDOW with a window start
16946 buffer position POS.
16948 Value is 1 if successful. It is zero if fonts were loaded during
16949 redisplay which makes re-adjusting glyph matrices necessary, and -1
16950 if point would appear in the scroll margins.
16951 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16952 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16956 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16958 struct window
*w
= XWINDOW (window
);
16960 struct glyph_row
*last_text_row
= NULL
;
16961 struct frame
*f
= XFRAME (w
->frame
);
16962 int frame_line_height
= default_line_pixel_height (w
);
16964 /* Make POS the new window start. */
16965 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16967 /* Mark cursor position as unknown. No overlay arrow seen. */
16968 w
->cursor
.vpos
= -1;
16969 overlay_arrow_seen
= 0;
16971 /* Initialize iterator and info to start at POS. */
16972 start_display (&it
, w
, pos
);
16973 it
.glyph_row
->reversed_p
= false;
16975 /* Display all lines of W. */
16976 while (it
.current_y
< it
.last_visible_y
)
16978 if (display_line (&it
))
16979 last_text_row
= it
.glyph_row
- 1;
16980 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16984 /* Don't let the cursor end in the scroll margins. */
16985 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16986 && !MINI_WINDOW_P (w
))
16988 int this_scroll_margin
;
16989 int window_total_lines
16990 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16992 if (scroll_margin
> 0)
16994 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16995 this_scroll_margin
*= frame_line_height
;
16998 this_scroll_margin
= 0;
17000 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17001 && w
->cursor
.y
< this_scroll_margin
17002 && CHARPOS (pos
) > BEGV
17003 && IT_CHARPOS (it
) < ZV
)
17004 /* rms: considering make_cursor_line_fully_visible_p here
17005 seems to give wrong results. We don't want to recenter
17006 when the last line is partly visible, we want to allow
17007 that case to be handled in the usual way. */
17008 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17010 w
->cursor
.vpos
= -1;
17011 clear_glyph_matrix (w
->desired_matrix
);
17016 /* If bottom moved off end of frame, change mode line percentage. */
17017 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17018 w
->update_mode_line
= 1;
17020 /* Set window_end_pos to the offset of the last character displayed
17021 on the window from the end of current_buffer. Set
17022 window_end_vpos to its row number. */
17025 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17026 adjust_window_ends (w
, last_text_row
, 0);
17028 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17029 w
->window_end_vpos
)));
17033 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17034 w
->window_end_pos
= Z
- ZV
;
17035 w
->window_end_vpos
= 0;
17038 /* But that is not valid info until redisplay finishes. */
17039 w
->window_end_valid
= 0;
17045 /************************************************************************
17046 Window redisplay reusing current matrix when buffer has not changed
17047 ************************************************************************/
17049 /* Try redisplay of window W showing an unchanged buffer with a
17050 different window start than the last time it was displayed by
17051 reusing its current matrix. Value is non-zero if successful.
17052 W->start is the new window start. */
17055 try_window_reusing_current_matrix (struct window
*w
)
17057 struct frame
*f
= XFRAME (w
->frame
);
17058 struct glyph_row
*bottom_row
;
17061 struct text_pos start
, new_start
;
17062 int nrows_scrolled
, i
;
17063 struct glyph_row
*last_text_row
;
17064 struct glyph_row
*last_reused_text_row
;
17065 struct glyph_row
*start_row
;
17066 int start_vpos
, min_y
, max_y
;
17069 if (inhibit_try_window_reusing
)
17073 #ifdef HAVE_XWIDGETS_xxx
17074 //currently this is needed to detect xwidget movement reliably. or probably not.
17075 printf("try_window_reusing_current_matrix\n");
17080 if (/* This function doesn't handle terminal frames. */
17081 !FRAME_WINDOW_P (f
)
17082 /* Don't try to reuse the display if windows have been split
17084 || windows_or_buffers_changed
17085 || f
->cursor_type_changed
)
17088 /* Can't do this if showing trailing whitespace. */
17089 if (!NILP (Vshow_trailing_whitespace
))
17092 /* If top-line visibility has changed, give up. */
17093 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17094 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17097 /* Give up if old or new display is scrolled vertically. We could
17098 make this function handle this, but right now it doesn't. */
17099 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17100 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17103 /* The variable new_start now holds the new window start. The old
17104 start `start' can be determined from the current matrix. */
17105 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17106 start
= start_row
->minpos
;
17107 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17109 /* Clear the desired matrix for the display below. */
17110 clear_glyph_matrix (w
->desired_matrix
);
17112 if (CHARPOS (new_start
) <= CHARPOS (start
))
17114 /* Don't use this method if the display starts with an ellipsis
17115 displayed for invisible text. It's not easy to handle that case
17116 below, and it's certainly not worth the effort since this is
17117 not a frequent case. */
17118 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17121 IF_DEBUG (debug_method_add (w
, "twu1"));
17123 /* Display up to a row that can be reused. The variable
17124 last_text_row is set to the last row displayed that displays
17125 text. Note that it.vpos == 0 if or if not there is a
17126 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17127 start_display (&it
, w
, new_start
);
17128 w
->cursor
.vpos
= -1;
17129 last_text_row
= last_reused_text_row
= NULL
;
17131 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17133 /* If we have reached into the characters in the START row,
17134 that means the line boundaries have changed. So we
17135 can't start copying with the row START. Maybe it will
17136 work to start copying with the following row. */
17137 while (IT_CHARPOS (it
) > CHARPOS (start
))
17139 /* Advance to the next row as the "start". */
17141 start
= start_row
->minpos
;
17142 /* If there are no more rows to try, or just one, give up. */
17143 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17144 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17145 || CHARPOS (start
) == ZV
)
17147 clear_glyph_matrix (w
->desired_matrix
);
17151 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17153 /* If we have reached alignment, we can copy the rest of the
17155 if (IT_CHARPOS (it
) == CHARPOS (start
)
17156 /* Don't accept "alignment" inside a display vector,
17157 since start_row could have started in the middle of
17158 that same display vector (thus their character
17159 positions match), and we have no way of telling if
17160 that is the case. */
17161 && it
.current
.dpvec_index
< 0)
17164 it
.glyph_row
->reversed_p
= false;
17165 if (display_line (&it
))
17166 last_text_row
= it
.glyph_row
- 1;
17170 /* A value of current_y < last_visible_y means that we stopped
17171 at the previous window start, which in turn means that we
17172 have at least one reusable row. */
17173 if (it
.current_y
< it
.last_visible_y
)
17175 struct glyph_row
*row
;
17177 /* IT.vpos always starts from 0; it counts text lines. */
17178 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17180 /* Find PT if not already found in the lines displayed. */
17181 if (w
->cursor
.vpos
< 0)
17183 int dy
= it
.current_y
- start_row
->y
;
17185 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17186 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17188 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17189 dy
, nrows_scrolled
);
17192 clear_glyph_matrix (w
->desired_matrix
);
17197 /* Scroll the display. Do it before the current matrix is
17198 changed. The problem here is that update has not yet
17199 run, i.e. part of the current matrix is not up to date.
17200 scroll_run_hook will clear the cursor, and use the
17201 current matrix to get the height of the row the cursor is
17203 run
.current_y
= start_row
->y
;
17204 run
.desired_y
= it
.current_y
;
17205 run
.height
= it
.last_visible_y
- it
.current_y
;
17207 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17210 FRAME_RIF (f
)->update_window_begin_hook (w
);
17211 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17212 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17213 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17217 /* Shift current matrix down by nrows_scrolled lines. */
17218 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17219 rotate_matrix (w
->current_matrix
,
17221 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17224 /* Disable lines that must be updated. */
17225 for (i
= 0; i
< nrows_scrolled
; ++i
)
17226 (start_row
+ i
)->enabled_p
= false;
17228 /* Re-compute Y positions. */
17229 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17230 max_y
= it
.last_visible_y
;
17231 for (row
= start_row
+ nrows_scrolled
;
17235 row
->y
= it
.current_y
;
17236 row
->visible_height
= row
->height
;
17238 if (row
->y
< min_y
)
17239 row
->visible_height
-= min_y
- row
->y
;
17240 if (row
->y
+ row
->height
> max_y
)
17241 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17242 if (row
->fringe_bitmap_periodic_p
)
17243 row
->redraw_fringe_bitmaps_p
= 1;
17245 it
.current_y
+= row
->height
;
17247 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17248 last_reused_text_row
= row
;
17249 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17253 /* Disable lines in the current matrix which are now
17254 below the window. */
17255 for (++row
; row
< bottom_row
; ++row
)
17256 row
->enabled_p
= row
->mode_line_p
= 0;
17259 /* Update window_end_pos etc.; last_reused_text_row is the last
17260 reused row from the current matrix containing text, if any.
17261 The value of last_text_row is the last displayed line
17262 containing text. */
17263 if (last_reused_text_row
)
17264 adjust_window_ends (w
, last_reused_text_row
, 1);
17265 else if (last_text_row
)
17266 adjust_window_ends (w
, last_text_row
, 0);
17269 /* This window must be completely empty. */
17270 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17271 w
->window_end_pos
= Z
- ZV
;
17272 w
->window_end_vpos
= 0;
17274 w
->window_end_valid
= 0;
17276 /* Update hint: don't try scrolling again in update_window. */
17277 w
->desired_matrix
->no_scrolling_p
= 1;
17280 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17284 else if (CHARPOS (new_start
) > CHARPOS (start
))
17286 struct glyph_row
*pt_row
, *row
;
17287 struct glyph_row
*first_reusable_row
;
17288 struct glyph_row
*first_row_to_display
;
17290 int yb
= window_text_bottom_y (w
);
17292 /* Find the row starting at new_start, if there is one. Don't
17293 reuse a partially visible line at the end. */
17294 first_reusable_row
= start_row
;
17295 while (first_reusable_row
->enabled_p
17296 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17297 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17298 < CHARPOS (new_start
)))
17299 ++first_reusable_row
;
17301 /* Give up if there is no row to reuse. */
17302 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17303 || !first_reusable_row
->enabled_p
17304 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17305 != CHARPOS (new_start
)))
17308 /* We can reuse fully visible rows beginning with
17309 first_reusable_row to the end of the window. Set
17310 first_row_to_display to the first row that cannot be reused.
17311 Set pt_row to the row containing point, if there is any. */
17313 for (first_row_to_display
= first_reusable_row
;
17314 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17315 ++first_row_to_display
)
17317 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17318 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17319 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17320 && first_row_to_display
->ends_at_zv_p
17321 && pt_row
== NULL
)))
17322 pt_row
= first_row_to_display
;
17325 /* Start displaying at the start of first_row_to_display. */
17326 eassert (first_row_to_display
->y
< yb
);
17327 init_to_row_start (&it
, w
, first_row_to_display
);
17329 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17331 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17333 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17334 + WINDOW_HEADER_LINE_HEIGHT (w
));
17336 /* Display lines beginning with first_row_to_display in the
17337 desired matrix. Set last_text_row to the last row displayed
17338 that displays text. */
17339 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17340 if (pt_row
== NULL
)
17341 w
->cursor
.vpos
= -1;
17342 last_text_row
= NULL
;
17343 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17344 if (display_line (&it
))
17345 last_text_row
= it
.glyph_row
- 1;
17347 /* If point is in a reused row, adjust y and vpos of the cursor
17351 w
->cursor
.vpos
-= nrows_scrolled
;
17352 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17355 /* Give up if point isn't in a row displayed or reused. (This
17356 also handles the case where w->cursor.vpos < nrows_scrolled
17357 after the calls to display_line, which can happen with scroll
17358 margins. See bug#1295.) */
17359 if (w
->cursor
.vpos
< 0)
17361 clear_glyph_matrix (w
->desired_matrix
);
17365 /* Scroll the display. */
17366 run
.current_y
= first_reusable_row
->y
;
17367 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17368 run
.height
= it
.last_visible_y
- run
.current_y
;
17369 dy
= run
.current_y
- run
.desired_y
;
17374 FRAME_RIF (f
)->update_window_begin_hook (w
);
17375 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17376 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17377 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17381 /* Adjust Y positions of reused rows. */
17382 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17383 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17384 max_y
= it
.last_visible_y
;
17385 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17388 row
->visible_height
= row
->height
;
17389 if (row
->y
< min_y
)
17390 row
->visible_height
-= min_y
- row
->y
;
17391 if (row
->y
+ row
->height
> max_y
)
17392 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17393 if (row
->fringe_bitmap_periodic_p
)
17394 row
->redraw_fringe_bitmaps_p
= 1;
17397 /* Scroll the current matrix. */
17398 eassert (nrows_scrolled
> 0);
17399 rotate_matrix (w
->current_matrix
,
17401 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17404 /* Disable rows not reused. */
17405 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17406 row
->enabled_p
= false;
17408 /* Point may have moved to a different line, so we cannot assume that
17409 the previous cursor position is valid; locate the correct row. */
17412 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17414 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17415 && !row
->ends_at_zv_p
;
17419 w
->cursor
.y
= row
->y
;
17421 if (row
< bottom_row
)
17423 /* Can't simply scan the row for point with
17424 bidi-reordered glyph rows. Let set_cursor_from_row
17425 figure out where to put the cursor, and if it fails,
17427 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17429 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17432 clear_glyph_matrix (w
->desired_matrix
);
17438 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17439 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17442 && (!BUFFERP (glyph
->object
)
17443 || glyph
->charpos
< PT
);
17447 w
->cursor
.x
+= glyph
->pixel_width
;
17453 /* Adjust window end. A null value of last_text_row means that
17454 the window end is in reused rows which in turn means that
17455 only its vpos can have changed. */
17457 adjust_window_ends (w
, last_text_row
, 0);
17459 w
->window_end_vpos
-= nrows_scrolled
;
17461 w
->window_end_valid
= 0;
17462 w
->desired_matrix
->no_scrolling_p
= 1;
17465 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17475 /************************************************************************
17476 Window redisplay reusing current matrix when buffer has changed
17477 ************************************************************************/
17479 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17480 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17481 ptrdiff_t *, ptrdiff_t *);
17482 static struct glyph_row
*
17483 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17484 struct glyph_row
*);
17487 /* Return the last row in MATRIX displaying text. If row START is
17488 non-null, start searching with that row. IT gives the dimensions
17489 of the display. Value is null if matrix is empty; otherwise it is
17490 a pointer to the row found. */
17492 static struct glyph_row
*
17493 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17494 struct glyph_row
*start
)
17496 struct glyph_row
*row
, *row_found
;
17498 /* Set row_found to the last row in IT->w's current matrix
17499 displaying text. The loop looks funny but think of partially
17502 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17503 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17505 eassert (row
->enabled_p
);
17507 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17516 /* Return the last row in the current matrix of W that is not affected
17517 by changes at the start of current_buffer that occurred since W's
17518 current matrix was built. Value is null if no such row exists.
17520 BEG_UNCHANGED us the number of characters unchanged at the start of
17521 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17522 first changed character in current_buffer. Characters at positions <
17523 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17524 when the current matrix was built. */
17526 static struct glyph_row
*
17527 find_last_unchanged_at_beg_row (struct window
*w
)
17529 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17530 struct glyph_row
*row
;
17531 struct glyph_row
*row_found
= NULL
;
17532 int yb
= window_text_bottom_y (w
);
17534 /* Find the last row displaying unchanged text. */
17535 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17536 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17537 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17540 if (/* If row ends before first_changed_pos, it is unchanged,
17541 except in some case. */
17542 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17543 /* When row ends in ZV and we write at ZV it is not
17545 && !row
->ends_at_zv_p
17546 /* When first_changed_pos is the end of a continued line,
17547 row is not unchanged because it may be no longer
17549 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17550 && (row
->continued_p
17551 || row
->exact_window_width_line_p
))
17552 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17553 needs to be recomputed, so don't consider this row as
17554 unchanged. This happens when the last line was
17555 bidi-reordered and was killed immediately before this
17556 redisplay cycle. In that case, ROW->end stores the
17557 buffer position of the first visual-order character of
17558 the killed text, which is now beyond ZV. */
17559 && CHARPOS (row
->end
.pos
) <= ZV
)
17562 /* Stop if last visible row. */
17563 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17571 /* Find the first glyph row in the current matrix of W that is not
17572 affected by changes at the end of current_buffer since the
17573 time W's current matrix was built.
17575 Return in *DELTA the number of chars by which buffer positions in
17576 unchanged text at the end of current_buffer must be adjusted.
17578 Return in *DELTA_BYTES the corresponding number of bytes.
17580 Value is null if no such row exists, i.e. all rows are affected by
17583 static struct glyph_row
*
17584 find_first_unchanged_at_end_row (struct window
*w
,
17585 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17587 struct glyph_row
*row
;
17588 struct glyph_row
*row_found
= NULL
;
17590 *delta
= *delta_bytes
= 0;
17592 /* Display must not have been paused, otherwise the current matrix
17593 is not up to date. */
17594 eassert (w
->window_end_valid
);
17596 /* A value of window_end_pos >= END_UNCHANGED means that the window
17597 end is in the range of changed text. If so, there is no
17598 unchanged row at the end of W's current matrix. */
17599 if (w
->window_end_pos
>= END_UNCHANGED
)
17602 /* Set row to the last row in W's current matrix displaying text. */
17603 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17605 /* If matrix is entirely empty, no unchanged row exists. */
17606 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17608 /* The value of row is the last glyph row in the matrix having a
17609 meaningful buffer position in it. The end position of row
17610 corresponds to window_end_pos. This allows us to translate
17611 buffer positions in the current matrix to current buffer
17612 positions for characters not in changed text. */
17614 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17615 ptrdiff_t Z_BYTE_old
=
17616 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17617 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17618 struct glyph_row
*first_text_row
17619 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17621 *delta
= Z
- Z_old
;
17622 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17624 /* Set last_unchanged_pos to the buffer position of the last
17625 character in the buffer that has not been changed. Z is the
17626 index + 1 of the last character in current_buffer, i.e. by
17627 subtracting END_UNCHANGED we get the index of the last
17628 unchanged character, and we have to add BEG to get its buffer
17630 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17631 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17633 /* Search backward from ROW for a row displaying a line that
17634 starts at a minimum position >= last_unchanged_pos_old. */
17635 for (; row
> first_text_row
; --row
)
17637 /* This used to abort, but it can happen.
17638 It is ok to just stop the search instead here. KFS. */
17639 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17642 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17647 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17653 /* Make sure that glyph rows in the current matrix of window W
17654 reference the same glyph memory as corresponding rows in the
17655 frame's frame matrix. This function is called after scrolling W's
17656 current matrix on a terminal frame in try_window_id and
17657 try_window_reusing_current_matrix. */
17660 sync_frame_with_window_matrix_rows (struct window
*w
)
17662 struct frame
*f
= XFRAME (w
->frame
);
17663 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17665 /* Preconditions: W must be a leaf window and full-width. Its frame
17666 must have a frame matrix. */
17667 eassert (BUFFERP (w
->contents
));
17668 eassert (WINDOW_FULL_WIDTH_P (w
));
17669 eassert (!FRAME_WINDOW_P (f
));
17671 /* If W is a full-width window, glyph pointers in W's current matrix
17672 have, by definition, to be the same as glyph pointers in the
17673 corresponding frame matrix. Note that frame matrices have no
17674 marginal areas (see build_frame_matrix). */
17675 window_row
= w
->current_matrix
->rows
;
17676 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17677 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17678 while (window_row
< window_row_end
)
17680 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17681 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17683 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17684 frame_row
->glyphs
[TEXT_AREA
] = start
;
17685 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17686 frame_row
->glyphs
[LAST_AREA
] = end
;
17688 /* Disable frame rows whose corresponding window rows have
17689 been disabled in try_window_id. */
17690 if (!window_row
->enabled_p
)
17691 frame_row
->enabled_p
= false;
17693 ++window_row
, ++frame_row
;
17698 /* Find the glyph row in window W containing CHARPOS. Consider all
17699 rows between START and END (not inclusive). END null means search
17700 all rows to the end of the display area of W. Value is the row
17701 containing CHARPOS or null. */
17704 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17705 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17707 struct glyph_row
*row
= start
;
17708 struct glyph_row
*best_row
= NULL
;
17709 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17712 /* If we happen to start on a header-line, skip that. */
17713 if (row
->mode_line_p
)
17716 if ((end
&& row
>= end
) || !row
->enabled_p
)
17719 last_y
= window_text_bottom_y (w
) - dy
;
17723 /* Give up if we have gone too far. */
17724 if (end
&& row
>= end
)
17726 /* This formerly returned if they were equal.
17727 I think that both quantities are of a "last plus one" type;
17728 if so, when they are equal, the row is within the screen. -- rms. */
17729 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17732 /* If it is in this row, return this row. */
17733 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17734 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17735 /* The end position of a row equals the start
17736 position of the next row. If CHARPOS is there, we
17737 would rather consider it displayed in the next
17738 line, except when this line ends in ZV. */
17739 && !row_for_charpos_p (row
, charpos
)))
17740 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17744 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17745 || (!best_row
&& !row
->continued_p
))
17747 /* In bidi-reordered rows, there could be several rows whose
17748 edges surround CHARPOS, all of these rows belonging to
17749 the same continued line. We need to find the row which
17750 fits CHARPOS the best. */
17751 for (g
= row
->glyphs
[TEXT_AREA
];
17752 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17755 if (!STRINGP (g
->object
))
17757 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17759 mindif
= eabs (g
->charpos
- charpos
);
17761 /* Exact match always wins. */
17768 else if (best_row
&& !row
->continued_p
)
17775 /* Try to redisplay window W by reusing its existing display. W's
17776 current matrix must be up to date when this function is called,
17777 i.e. window_end_valid must be nonzero.
17781 >= 1 if successful, i.e. display has been updated
17783 1 means the changes were in front of a newline that precedes
17784 the window start, and the whole current matrix was reused
17785 2 means the changes were after the last position displayed
17786 in the window, and the whole current matrix was reused
17787 3 means portions of the current matrix were reused, while
17788 some of the screen lines were redrawn
17789 -1 if redisplay with same window start is known not to succeed
17790 0 if otherwise unsuccessful
17792 The following steps are performed:
17794 1. Find the last row in the current matrix of W that is not
17795 affected by changes at the start of current_buffer. If no such row
17798 2. Find the first row in W's current matrix that is not affected by
17799 changes at the end of current_buffer. Maybe there is no such row.
17801 3. Display lines beginning with the row + 1 found in step 1 to the
17802 row found in step 2 or, if step 2 didn't find a row, to the end of
17805 4. If cursor is not known to appear on the window, give up.
17807 5. If display stopped at the row found in step 2, scroll the
17808 display and current matrix as needed.
17810 6. Maybe display some lines at the end of W, if we must. This can
17811 happen under various circumstances, like a partially visible line
17812 becoming fully visible, or because newly displayed lines are displayed
17813 in smaller font sizes.
17815 7. Update W's window end information. */
17818 try_window_id (struct window
*w
)
17820 struct frame
*f
= XFRAME (w
->frame
);
17821 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17822 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17823 struct glyph_row
*last_unchanged_at_beg_row
;
17824 struct glyph_row
*first_unchanged_at_end_row
;
17825 struct glyph_row
*row
;
17826 struct glyph_row
*bottom_row
;
17829 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17831 struct text_pos start_pos
;
17833 int first_unchanged_at_end_vpos
= 0;
17834 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17835 struct text_pos start
;
17836 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17839 if (inhibit_try_window_id
)
17843 /* This is handy for debugging. */
17845 #define GIVE_UP(X) \
17847 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17851 #define GIVE_UP(X) return 0
17854 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17856 /* Don't use this for mini-windows because these can show
17857 messages and mini-buffers, and we don't handle that here. */
17858 if (MINI_WINDOW_P (w
))
17861 /* This flag is used to prevent redisplay optimizations. */
17862 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17865 /* This function's optimizations cannot be used if overlays have
17866 changed in the buffer displayed by the window, so give up if they
17868 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17871 /* Verify that narrowing has not changed.
17872 Also verify that we were not told to prevent redisplay optimizations.
17873 It would be nice to further
17874 reduce the number of cases where this prevents try_window_id. */
17875 if (current_buffer
->clip_changed
17876 || current_buffer
->prevent_redisplay_optimizations_p
)
17879 /* Window must either use window-based redisplay or be full width. */
17880 if (!FRAME_WINDOW_P (f
)
17881 && (!FRAME_LINE_INS_DEL_OK (f
)
17882 || !WINDOW_FULL_WIDTH_P (w
)))
17885 /* Give up if point is known NOT to appear in W. */
17886 if (PT
< CHARPOS (start
))
17889 /* Another way to prevent redisplay optimizations. */
17890 if (w
->last_modified
== 0)
17893 /* Verify that window is not hscrolled. */
17894 if (w
->hscroll
!= 0)
17897 /* Verify that display wasn't paused. */
17898 if (!w
->window_end_valid
)
17901 /* Likewise if highlighting trailing whitespace. */
17902 if (!NILP (Vshow_trailing_whitespace
))
17905 /* Can't use this if overlay arrow position and/or string have
17907 if (overlay_arrows_changed_p ())
17910 /* When word-wrap is on, adding a space to the first word of a
17911 wrapped line can change the wrap position, altering the line
17912 above it. It might be worthwhile to handle this more
17913 intelligently, but for now just redisplay from scratch. */
17914 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17917 /* Under bidi reordering, adding or deleting a character in the
17918 beginning of a paragraph, before the first strong directional
17919 character, can change the base direction of the paragraph (unless
17920 the buffer specifies a fixed paragraph direction), which will
17921 require to redisplay the whole paragraph. It might be worthwhile
17922 to find the paragraph limits and widen the range of redisplayed
17923 lines to that, but for now just give up this optimization and
17924 redisplay from scratch. */
17925 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17926 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17929 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17930 only if buffer has really changed. The reason is that the gap is
17931 initially at Z for freshly visited files. The code below would
17932 set end_unchanged to 0 in that case. */
17933 if (MODIFF
> SAVE_MODIFF
17934 /* This seems to happen sometimes after saving a buffer. */
17935 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17937 if (GPT
- BEG
< BEG_UNCHANGED
)
17938 BEG_UNCHANGED
= GPT
- BEG
;
17939 if (Z
- GPT
< END_UNCHANGED
)
17940 END_UNCHANGED
= Z
- GPT
;
17943 /* The position of the first and last character that has been changed. */
17944 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17945 last_changed_charpos
= Z
- END_UNCHANGED
;
17947 /* If window starts after a line end, and the last change is in
17948 front of that newline, then changes don't affect the display.
17949 This case happens with stealth-fontification. Note that although
17950 the display is unchanged, glyph positions in the matrix have to
17951 be adjusted, of course. */
17952 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17953 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17954 && ((last_changed_charpos
< CHARPOS (start
)
17955 && CHARPOS (start
) == BEGV
)
17956 || (last_changed_charpos
< CHARPOS (start
) - 1
17957 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17959 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17960 struct glyph_row
*r0
;
17962 /* Compute how many chars/bytes have been added to or removed
17963 from the buffer. */
17964 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17965 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17966 Z_delta
= Z
- Z_old
;
17967 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17969 /* Give up if PT is not in the window. Note that it already has
17970 been checked at the start of try_window_id that PT is not in
17971 front of the window start. */
17972 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17975 /* If window start is unchanged, we can reuse the whole matrix
17976 as is, after adjusting glyph positions. No need to compute
17977 the window end again, since its offset from Z hasn't changed. */
17978 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17979 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17980 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17981 /* PT must not be in a partially visible line. */
17982 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17983 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17985 /* Adjust positions in the glyph matrix. */
17986 if (Z_delta
|| Z_delta_bytes
)
17988 struct glyph_row
*r1
17989 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17990 increment_matrix_positions (w
->current_matrix
,
17991 MATRIX_ROW_VPOS (r0
, current_matrix
),
17992 MATRIX_ROW_VPOS (r1
, current_matrix
),
17993 Z_delta
, Z_delta_bytes
);
17996 /* Set the cursor. */
17997 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17999 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18004 /* Handle the case that changes are all below what is displayed in
18005 the window, and that PT is in the window. This shortcut cannot
18006 be taken if ZV is visible in the window, and text has been added
18007 there that is visible in the window. */
18008 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18009 /* ZV is not visible in the window, or there are no
18010 changes at ZV, actually. */
18011 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18012 || first_changed_charpos
== last_changed_charpos
))
18014 struct glyph_row
*r0
;
18016 /* Give up if PT is not in the window. Note that it already has
18017 been checked at the start of try_window_id that PT is not in
18018 front of the window start. */
18019 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18022 /* If window start is unchanged, we can reuse the whole matrix
18023 as is, without changing glyph positions since no text has
18024 been added/removed in front of the window end. */
18025 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18026 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18027 /* PT must not be in a partially visible line. */
18028 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18029 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18031 /* We have to compute the window end anew since text
18032 could have been added/removed after it. */
18033 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18034 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18036 /* Set the cursor. */
18037 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18039 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18044 /* Give up if window start is in the changed area.
18046 The condition used to read
18048 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18050 but why that was tested escapes me at the moment. */
18051 if (CHARPOS (start
) >= first_changed_charpos
18052 && CHARPOS (start
) <= last_changed_charpos
)
18055 /* Check that window start agrees with the start of the first glyph
18056 row in its current matrix. Check this after we know the window
18057 start is not in changed text, otherwise positions would not be
18059 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18060 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18063 /* Give up if the window ends in strings. Overlay strings
18064 at the end are difficult to handle, so don't try. */
18065 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18066 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18069 /* Compute the position at which we have to start displaying new
18070 lines. Some of the lines at the top of the window might be
18071 reusable because they are not displaying changed text. Find the
18072 last row in W's current matrix not affected by changes at the
18073 start of current_buffer. Value is null if changes start in the
18074 first line of window. */
18075 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18076 if (last_unchanged_at_beg_row
)
18078 /* Avoid starting to display in the middle of a character, a TAB
18079 for instance. This is easier than to set up the iterator
18080 exactly, and it's not a frequent case, so the additional
18081 effort wouldn't really pay off. */
18082 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18083 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18084 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18085 --last_unchanged_at_beg_row
;
18087 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18090 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18092 start_pos
= it
.current
.pos
;
18094 /* Start displaying new lines in the desired matrix at the same
18095 vpos we would use in the current matrix, i.e. below
18096 last_unchanged_at_beg_row. */
18097 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18099 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18100 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18102 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18106 /* There are no reusable lines at the start of the window.
18107 Start displaying in the first text line. */
18108 start_display (&it
, w
, start
);
18109 it
.vpos
= it
.first_vpos
;
18110 start_pos
= it
.current
.pos
;
18113 /* Find the first row that is not affected by changes at the end of
18114 the buffer. Value will be null if there is no unchanged row, in
18115 which case we must redisplay to the end of the window. delta
18116 will be set to the value by which buffer positions beginning with
18117 first_unchanged_at_end_row have to be adjusted due to text
18119 first_unchanged_at_end_row
18120 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18121 IF_DEBUG (debug_delta
= delta
);
18122 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18124 /* Set stop_pos to the buffer position up to which we will have to
18125 display new lines. If first_unchanged_at_end_row != NULL, this
18126 is the buffer position of the start of the line displayed in that
18127 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18128 that we don't stop at a buffer position. */
18130 if (first_unchanged_at_end_row
)
18132 eassert (last_unchanged_at_beg_row
== NULL
18133 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18135 /* If this is a continuation line, move forward to the next one
18136 that isn't. Changes in lines above affect this line.
18137 Caution: this may move first_unchanged_at_end_row to a row
18138 not displaying text. */
18139 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18140 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18141 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18142 < it
.last_visible_y
))
18143 ++first_unchanged_at_end_row
;
18145 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18146 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18147 >= it
.last_visible_y
))
18148 first_unchanged_at_end_row
= NULL
;
18151 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18153 first_unchanged_at_end_vpos
18154 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18155 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18158 else if (last_unchanged_at_beg_row
== NULL
)
18164 /* Either there is no unchanged row at the end, or the one we have
18165 now displays text. This is a necessary condition for the window
18166 end pos calculation at the end of this function. */
18167 eassert (first_unchanged_at_end_row
== NULL
18168 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18170 debug_last_unchanged_at_beg_vpos
18171 = (last_unchanged_at_beg_row
18172 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18174 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18176 #endif /* GLYPH_DEBUG */
18179 /* Display new lines. Set last_text_row to the last new line
18180 displayed which has text on it, i.e. might end up as being the
18181 line where the window_end_vpos is. */
18182 w
->cursor
.vpos
= -1;
18183 last_text_row
= NULL
;
18184 overlay_arrow_seen
= 0;
18185 if (it
.current_y
< it
.last_visible_y
18186 && !f
->fonts_changed
18187 && (first_unchanged_at_end_row
== NULL
18188 || IT_CHARPOS (it
) < stop_pos
))
18189 it
.glyph_row
->reversed_p
= false;
18190 while (it
.current_y
< it
.last_visible_y
18191 && !f
->fonts_changed
18192 && (first_unchanged_at_end_row
== NULL
18193 || IT_CHARPOS (it
) < stop_pos
))
18195 if (display_line (&it
))
18196 last_text_row
= it
.glyph_row
- 1;
18199 if (f
->fonts_changed
)
18203 /* Compute differences in buffer positions, y-positions etc. for
18204 lines reused at the bottom of the window. Compute what we can
18206 if (first_unchanged_at_end_row
18207 /* No lines reused because we displayed everything up to the
18208 bottom of the window. */
18209 && it
.current_y
< it
.last_visible_y
)
18212 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18214 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18215 run
.current_y
= first_unchanged_at_end_row
->y
;
18216 run
.desired_y
= run
.current_y
+ dy
;
18217 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18221 delta
= delta_bytes
= dvpos
= dy
18222 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18223 first_unchanged_at_end_row
= NULL
;
18225 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18228 /* Find the cursor if not already found. We have to decide whether
18229 PT will appear on this window (it sometimes doesn't, but this is
18230 not a very frequent case.) This decision has to be made before
18231 the current matrix is altered. A value of cursor.vpos < 0 means
18232 that PT is either in one of the lines beginning at
18233 first_unchanged_at_end_row or below the window. Don't care for
18234 lines that might be displayed later at the window end; as
18235 mentioned, this is not a frequent case. */
18236 if (w
->cursor
.vpos
< 0)
18238 /* Cursor in unchanged rows at the top? */
18239 if (PT
< CHARPOS (start_pos
)
18240 && last_unchanged_at_beg_row
)
18242 row
= row_containing_pos (w
, PT
,
18243 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18244 last_unchanged_at_beg_row
+ 1, 0);
18246 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18249 /* Start from first_unchanged_at_end_row looking for PT. */
18250 else if (first_unchanged_at_end_row
)
18252 row
= row_containing_pos (w
, PT
- delta
,
18253 first_unchanged_at_end_row
, NULL
, 0);
18255 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18256 delta_bytes
, dy
, dvpos
);
18259 /* Give up if cursor was not found. */
18260 if (w
->cursor
.vpos
< 0)
18262 clear_glyph_matrix (w
->desired_matrix
);
18267 /* Don't let the cursor end in the scroll margins. */
18269 int this_scroll_margin
, cursor_height
;
18270 int frame_line_height
= default_line_pixel_height (w
);
18271 int window_total_lines
18272 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18274 this_scroll_margin
=
18275 max (0, min (scroll_margin
, window_total_lines
/ 4));
18276 this_scroll_margin
*= frame_line_height
;
18277 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18279 if ((w
->cursor
.y
< this_scroll_margin
18280 && CHARPOS (start
) > BEGV
)
18281 /* Old redisplay didn't take scroll margin into account at the bottom,
18282 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18283 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18284 ? cursor_height
+ this_scroll_margin
18285 : 1)) > it
.last_visible_y
)
18287 w
->cursor
.vpos
= -1;
18288 clear_glyph_matrix (w
->desired_matrix
);
18293 /* Scroll the display. Do it before changing the current matrix so
18294 that xterm.c doesn't get confused about where the cursor glyph is
18296 if (dy
&& run
.height
)
18300 if (FRAME_WINDOW_P (f
))
18302 FRAME_RIF (f
)->update_window_begin_hook (w
);
18303 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18304 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18305 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18309 /* Terminal frame. In this case, dvpos gives the number of
18310 lines to scroll by; dvpos < 0 means scroll up. */
18312 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18313 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18314 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18315 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18316 + window_internal_height (w
));
18318 #if defined (HAVE_GPM) || defined (MSDOS)
18319 x_clear_window_mouse_face (w
);
18321 /* Perform the operation on the screen. */
18324 /* Scroll last_unchanged_at_beg_row to the end of the
18325 window down dvpos lines. */
18326 set_terminal_window (f
, end
);
18328 /* On dumb terminals delete dvpos lines at the end
18329 before inserting dvpos empty lines. */
18330 if (!FRAME_SCROLL_REGION_OK (f
))
18331 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18333 /* Insert dvpos empty lines in front of
18334 last_unchanged_at_beg_row. */
18335 ins_del_lines (f
, from
, dvpos
);
18337 else if (dvpos
< 0)
18339 /* Scroll up last_unchanged_at_beg_vpos to the end of
18340 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18341 set_terminal_window (f
, end
);
18343 /* Delete dvpos lines in front of
18344 last_unchanged_at_beg_vpos. ins_del_lines will set
18345 the cursor to the given vpos and emit |dvpos| delete
18347 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18349 /* On a dumb terminal insert dvpos empty lines at the
18351 if (!FRAME_SCROLL_REGION_OK (f
))
18352 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18355 set_terminal_window (f
, 0);
18361 /* Shift reused rows of the current matrix to the right position.
18362 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18364 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18365 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18368 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18369 bottom_vpos
, dvpos
);
18370 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18373 else if (dvpos
> 0)
18375 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18376 bottom_vpos
, dvpos
);
18377 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18378 first_unchanged_at_end_vpos
+ dvpos
);
18381 /* For frame-based redisplay, make sure that current frame and window
18382 matrix are in sync with respect to glyph memory. */
18383 if (!FRAME_WINDOW_P (f
))
18384 sync_frame_with_window_matrix_rows (w
);
18386 /* Adjust buffer positions in reused rows. */
18387 if (delta
|| delta_bytes
)
18388 increment_matrix_positions (current_matrix
,
18389 first_unchanged_at_end_vpos
+ dvpos
,
18390 bottom_vpos
, delta
, delta_bytes
);
18392 /* Adjust Y positions. */
18394 shift_glyph_matrix (w
, current_matrix
,
18395 first_unchanged_at_end_vpos
+ dvpos
,
18398 if (first_unchanged_at_end_row
)
18400 first_unchanged_at_end_row
+= dvpos
;
18401 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18402 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18403 first_unchanged_at_end_row
= NULL
;
18406 /* If scrolling up, there may be some lines to display at the end of
18408 last_text_row_at_end
= NULL
;
18411 /* Scrolling up can leave for example a partially visible line
18412 at the end of the window to be redisplayed. */
18413 /* Set last_row to the glyph row in the current matrix where the
18414 window end line is found. It has been moved up or down in
18415 the matrix by dvpos. */
18416 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18417 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18419 /* If last_row is the window end line, it should display text. */
18420 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18422 /* If window end line was partially visible before, begin
18423 displaying at that line. Otherwise begin displaying with the
18424 line following it. */
18425 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18427 init_to_row_start (&it
, w
, last_row
);
18428 it
.vpos
= last_vpos
;
18429 it
.current_y
= last_row
->y
;
18433 init_to_row_end (&it
, w
, last_row
);
18434 it
.vpos
= 1 + last_vpos
;
18435 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18439 /* We may start in a continuation line. If so, we have to
18440 get the right continuation_lines_width and current_x. */
18441 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18442 it
.hpos
= it
.current_x
= 0;
18444 /* Display the rest of the lines at the window end. */
18445 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18446 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18448 /* Is it always sure that the display agrees with lines in
18449 the current matrix? I don't think so, so we mark rows
18450 displayed invalid in the current matrix by setting their
18451 enabled_p flag to zero. */
18452 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18453 if (display_line (&it
))
18454 last_text_row_at_end
= it
.glyph_row
- 1;
18458 /* Update window_end_pos and window_end_vpos. */
18459 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18461 /* Window end line if one of the preserved rows from the current
18462 matrix. Set row to the last row displaying text in current
18463 matrix starting at first_unchanged_at_end_row, after
18465 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18466 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18467 first_unchanged_at_end_row
);
18468 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18469 adjust_window_ends (w
, row
, 1);
18470 eassert (w
->window_end_bytepos
>= 0);
18471 IF_DEBUG (debug_method_add (w
, "A"));
18473 else if (last_text_row_at_end
)
18475 adjust_window_ends (w
, last_text_row_at_end
, 0);
18476 eassert (w
->window_end_bytepos
>= 0);
18477 IF_DEBUG (debug_method_add (w
, "B"));
18479 else if (last_text_row
)
18481 /* We have displayed either to the end of the window or at the
18482 end of the window, i.e. the last row with text is to be found
18483 in the desired matrix. */
18484 adjust_window_ends (w
, last_text_row
, 0);
18485 eassert (w
->window_end_bytepos
>= 0);
18487 else if (first_unchanged_at_end_row
== NULL
18488 && last_text_row
== NULL
18489 && last_text_row_at_end
== NULL
)
18491 /* Displayed to end of window, but no line containing text was
18492 displayed. Lines were deleted at the end of the window. */
18493 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18494 int vpos
= w
->window_end_vpos
;
18495 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18496 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18499 row
== NULL
&& vpos
>= first_vpos
;
18500 --vpos
, --current_row
, --desired_row
)
18502 if (desired_row
->enabled_p
)
18504 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18507 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18511 eassert (row
!= NULL
);
18512 w
->window_end_vpos
= vpos
+ 1;
18513 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18514 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18515 eassert (w
->window_end_bytepos
>= 0);
18516 IF_DEBUG (debug_method_add (w
, "C"));
18521 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18522 debug_end_vpos
= w
->window_end_vpos
));
18524 /* Record that display has not been completed. */
18525 w
->window_end_valid
= 0;
18526 w
->desired_matrix
->no_scrolling_p
= 1;
18534 /***********************************************************************
18535 More debugging support
18536 ***********************************************************************/
18540 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18541 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18542 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18545 /* Dump the contents of glyph matrix MATRIX on stderr.
18547 GLYPHS 0 means don't show glyph contents.
18548 GLYPHS 1 means show glyphs in short form
18549 GLYPHS > 1 means show glyphs in long form. */
18552 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18555 for (i
= 0; i
< matrix
->nrows
; ++i
)
18556 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18560 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18561 the glyph row and area where the glyph comes from. */
18564 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18566 if (glyph
->type
== CHAR_GLYPH
18567 || glyph
->type
== GLYPHLESS_GLYPH
)
18570 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18571 glyph
- row
->glyphs
[TEXT_AREA
],
18572 (glyph
->type
== CHAR_GLYPH
18576 (BUFFERP (glyph
->object
)
18578 : (STRINGP (glyph
->object
)
18580 : (NILP (glyph
->object
)
18583 glyph
->pixel_width
,
18585 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18589 glyph
->left_box_line_p
,
18590 glyph
->right_box_line_p
);
18592 else if (glyph
->type
== STRETCH_GLYPH
)
18595 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18596 glyph
- row
->glyphs
[TEXT_AREA
],
18599 (BUFFERP (glyph
->object
)
18601 : (STRINGP (glyph
->object
)
18603 : (NILP (glyph
->object
)
18606 glyph
->pixel_width
,
18610 glyph
->left_box_line_p
,
18611 glyph
->right_box_line_p
);
18613 else if (glyph
->type
== IMAGE_GLYPH
)
18616 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18617 glyph
- row
->glyphs
[TEXT_AREA
],
18620 (BUFFERP (glyph
->object
)
18622 : (STRINGP (glyph
->object
)
18624 : (NILP (glyph
->object
)
18627 glyph
->pixel_width
,
18631 glyph
->left_box_line_p
,
18632 glyph
->right_box_line_p
);
18634 else if (glyph
->type
== COMPOSITE_GLYPH
)
18637 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18638 glyph
- row
->glyphs
[TEXT_AREA
],
18641 (BUFFERP (glyph
->object
)
18643 : (STRINGP (glyph
->object
)
18645 : (NILP (glyph
->object
)
18648 glyph
->pixel_width
,
18650 if (glyph
->u
.cmp
.automatic
)
18653 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18654 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18656 glyph
->left_box_line_p
,
18657 glyph
->right_box_line_p
);
18659 #ifdef HAVE_XWIDGETS
18660 else if (glyph
->type
== XWIDGET_GLYPH
)
18663 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18664 glyph
- row
->glyphs
[TEXT_AREA
],
18667 (BUFFERP (glyph
->object
)
18669 : (STRINGP (glyph
->object
)
18672 glyph
->pixel_width
,
18676 glyph
->left_box_line_p
,
18677 glyph
->right_box_line_p
);
18679 // printf("dump xwidget glyph\n");
18685 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18686 GLYPHS 0 means don't show glyph contents.
18687 GLYPHS 1 means show glyphs in short form
18688 GLYPHS > 1 means show glyphs in long form. */
18691 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18695 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18696 fprintf (stderr
, "==============================================================================\n");
18698 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18699 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18701 MATRIX_ROW_START_CHARPOS (row
),
18702 MATRIX_ROW_END_CHARPOS (row
),
18703 row
->used
[TEXT_AREA
],
18704 row
->contains_overlapping_glyphs_p
,
18706 row
->truncated_on_left_p
,
18707 row
->truncated_on_right_p
,
18709 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18710 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18713 row
->ends_in_middle_of_char_p
,
18714 row
->starts_in_middle_of_char_p
,
18720 row
->visible_height
,
18723 /* The next 3 lines should align to "Start" in the header. */
18724 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18725 row
->end
.overlay_string_index
,
18726 row
->continuation_lines_width
);
18727 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18728 CHARPOS (row
->start
.string_pos
),
18729 CHARPOS (row
->end
.string_pos
));
18730 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18731 row
->end
.dpvec_index
);
18738 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18740 struct glyph
*glyph
= row
->glyphs
[area
];
18741 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18743 /* Glyph for a line end in text. */
18744 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18747 if (glyph
< glyph_end
)
18748 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18750 for (; glyph
< glyph_end
; ++glyph
)
18751 dump_glyph (row
, glyph
, area
);
18754 else if (glyphs
== 1)
18757 char s
[SHRT_MAX
+ 4];
18759 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18763 for (i
= 0; i
< row
->used
[area
]; ++i
)
18765 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18766 if (i
== row
->used
[area
] - 1
18767 && area
== TEXT_AREA
18768 && NILP (glyph
->object
)
18769 && glyph
->type
== CHAR_GLYPH
18770 && glyph
->u
.ch
== ' ')
18772 strcpy (&s
[i
], "[\\n]");
18775 else if (glyph
->type
== CHAR_GLYPH
18776 && glyph
->u
.ch
< 0x80
18777 && glyph
->u
.ch
>= ' ')
18778 s
[i
] = glyph
->u
.ch
;
18784 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18790 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18791 Sdump_glyph_matrix
, 0, 1, "p",
18792 doc
: /* Dump the current matrix of the selected window to stderr.
18793 Shows contents of glyph row structures. With non-nil
18794 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18795 glyphs in short form, otherwise show glyphs in long form.
18797 Interactively, no argument means show glyphs in short form;
18798 with numeric argument, its value is passed as the GLYPHS flag. */)
18799 (Lisp_Object glyphs
)
18801 struct window
*w
= XWINDOW (selected_window
);
18802 struct buffer
*buffer
= XBUFFER (w
->contents
);
18804 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18805 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18806 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18807 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18808 fprintf (stderr
, "=============================================\n");
18809 dump_glyph_matrix (w
->current_matrix
,
18810 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18815 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18816 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18817 Only text-mode frames have frame glyph matrices. */)
18820 struct frame
*f
= XFRAME (selected_frame
);
18822 if (f
->current_matrix
)
18823 dump_glyph_matrix (f
->current_matrix
, 1);
18825 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18830 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18831 doc
: /* Dump glyph row ROW to stderr.
18832 GLYPH 0 means don't dump glyphs.
18833 GLYPH 1 means dump glyphs in short form.
18834 GLYPH > 1 or omitted means dump glyphs in long form. */)
18835 (Lisp_Object row
, Lisp_Object glyphs
)
18837 struct glyph_matrix
*matrix
;
18840 CHECK_NUMBER (row
);
18841 matrix
= XWINDOW (selected_window
)->current_matrix
;
18843 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18844 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18846 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18851 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18852 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18853 GLYPH 0 means don't dump glyphs.
18854 GLYPH 1 means dump glyphs in short form.
18855 GLYPH > 1 or omitted means dump glyphs in long form.
18857 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18859 (Lisp_Object row
, Lisp_Object glyphs
)
18861 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18862 struct frame
*sf
= SELECTED_FRAME ();
18863 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18866 CHECK_NUMBER (row
);
18868 if (vpos
>= 0 && vpos
< m
->nrows
)
18869 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18870 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18876 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18877 doc
: /* Toggle tracing of redisplay.
18878 With ARG, turn tracing on if and only if ARG is positive. */)
18882 trace_redisplay_p
= !trace_redisplay_p
;
18885 arg
= Fprefix_numeric_value (arg
);
18886 trace_redisplay_p
= XINT (arg
) > 0;
18893 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18894 doc
: /* Like `format', but print result to stderr.
18895 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18896 (ptrdiff_t nargs
, Lisp_Object
*args
)
18898 Lisp_Object s
= Fformat (nargs
, args
);
18899 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18903 #endif /* GLYPH_DEBUG */
18907 /***********************************************************************
18908 Building Desired Matrix Rows
18909 ***********************************************************************/
18911 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18912 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18914 static struct glyph_row
*
18915 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18917 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18918 struct buffer
*buffer
= XBUFFER (w
->contents
);
18919 struct buffer
*old
= current_buffer
;
18920 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18921 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18922 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18923 const unsigned char *p
;
18926 int n_glyphs_before
;
18928 set_buffer_temp (buffer
);
18929 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18930 scratch_glyph_row
.reversed_p
= false;
18931 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18932 SET_TEXT_POS (it
.position
, 0, 0);
18934 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18936 while (p
< arrow_end
)
18938 Lisp_Object face
, ilisp
;
18940 /* Get the next character. */
18942 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18945 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18946 if (! ASCII_CHAR_P (it
.c
))
18947 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18951 /* Get its face. */
18952 ilisp
= make_number (p
- arrow_string
);
18953 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18954 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18956 /* Compute its width, get its glyphs. */
18957 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18958 SET_TEXT_POS (it
.position
, -1, -1);
18959 PRODUCE_GLYPHS (&it
);
18961 /* If this character doesn't fit any more in the line, we have
18962 to remove some glyphs. */
18963 if (it
.current_x
> it
.last_visible_x
)
18965 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18970 set_buffer_temp (old
);
18971 return it
.glyph_row
;
18975 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18976 glyphs to insert is determined by produce_special_glyphs. */
18979 insert_left_trunc_glyphs (struct it
*it
)
18981 struct it truncate_it
;
18982 struct glyph
*from
, *end
, *to
, *toend
;
18984 eassert (!FRAME_WINDOW_P (it
->f
)
18985 || (!it
->glyph_row
->reversed_p
18986 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18987 || (it
->glyph_row
->reversed_p
18988 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18990 /* Get the truncation glyphs. */
18992 truncate_it
.current_x
= 0;
18993 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18994 truncate_it
.glyph_row
= &scratch_glyph_row
;
18995 truncate_it
.area
= TEXT_AREA
;
18996 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18997 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18998 truncate_it
.object
= Qnil
;
18999 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19001 /* Overwrite glyphs from IT with truncation glyphs. */
19002 if (!it
->glyph_row
->reversed_p
)
19004 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19006 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19007 end
= from
+ tused
;
19008 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19009 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19010 if (FRAME_WINDOW_P (it
->f
))
19012 /* On GUI frames, when variable-size fonts are displayed,
19013 the truncation glyphs may need more pixels than the row's
19014 glyphs they overwrite. We overwrite more glyphs to free
19015 enough screen real estate, and enlarge the stretch glyph
19016 on the right (see display_line), if there is one, to
19017 preserve the screen position of the truncation glyphs on
19020 struct glyph
*g
= to
;
19023 /* The first glyph could be partially visible, in which case
19024 it->glyph_row->x will be negative. But we want the left
19025 truncation glyphs to be aligned at the left margin of the
19026 window, so we override the x coordinate at which the row
19028 it
->glyph_row
->x
= 0;
19029 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19031 w
+= g
->pixel_width
;
19034 if (g
- to
- tused
> 0)
19036 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19037 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19039 used
= it
->glyph_row
->used
[TEXT_AREA
];
19040 if (it
->glyph_row
->truncated_on_right_p
19041 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19042 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19045 int extra
= w
- it
->truncation_pixel_width
;
19047 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19054 /* There may be padding glyphs left over. Overwrite them too. */
19055 if (!FRAME_WINDOW_P (it
->f
))
19057 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19059 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19066 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19070 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19072 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19073 that back to front. */
19074 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19075 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19076 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19077 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19078 if (FRAME_WINDOW_P (it
->f
))
19081 struct glyph
*g
= to
;
19083 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19085 w
+= g
->pixel_width
;
19088 if (to
- g
- tused
> 0)
19090 if (it
->glyph_row
->truncated_on_right_p
19091 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19092 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19094 int extra
= w
- it
->truncation_pixel_width
;
19096 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19100 while (from
>= end
&& to
>= toend
)
19102 if (!FRAME_WINDOW_P (it
->f
))
19104 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19107 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19108 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19109 while (from
>= end
&& to
>= toend
)
19115 /* Need to free some room before prepending additional
19117 int move_by
= from
- end
+ 1;
19118 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19119 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19121 for ( ; g
>= g0
; g
--)
19123 while (from
>= end
)
19125 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19130 /* Compute the hash code for ROW. */
19132 row_hash (struct glyph_row
*row
)
19135 unsigned hashval
= 0;
19137 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19138 for (k
= 0; k
< row
->used
[area
]; ++k
)
19139 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19140 + row
->glyphs
[area
][k
].u
.val
19141 + row
->glyphs
[area
][k
].face_id
19142 + row
->glyphs
[area
][k
].padding_p
19143 + (row
->glyphs
[area
][k
].type
<< 2));
19148 /* Compute the pixel height and width of IT->glyph_row.
19150 Most of the time, ascent and height of a display line will be equal
19151 to the max_ascent and max_height values of the display iterator
19152 structure. This is not the case if
19154 1. We hit ZV without displaying anything. In this case, max_ascent
19155 and max_height will be zero.
19157 2. We have some glyphs that don't contribute to the line height.
19158 (The glyph row flag contributes_to_line_height_p is for future
19159 pixmap extensions).
19161 The first case is easily covered by using default values because in
19162 these cases, the line height does not really matter, except that it
19163 must not be zero. */
19166 compute_line_metrics (struct it
*it
)
19168 struct glyph_row
*row
= it
->glyph_row
;
19170 if (FRAME_WINDOW_P (it
->f
))
19172 int i
, min_y
, max_y
;
19174 /* The line may consist of one space only, that was added to
19175 place the cursor on it. If so, the row's height hasn't been
19177 if (row
->height
== 0)
19179 if (it
->max_ascent
+ it
->max_descent
== 0)
19180 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19181 row
->ascent
= it
->max_ascent
;
19182 row
->height
= it
->max_ascent
+ it
->max_descent
;
19183 row
->phys_ascent
= it
->max_phys_ascent
;
19184 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19185 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19188 /* Compute the width of this line. */
19189 row
->pixel_width
= row
->x
;
19190 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19191 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19193 eassert (row
->pixel_width
>= 0);
19194 eassert (row
->ascent
>= 0 && row
->height
> 0);
19196 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19197 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19199 /* If first line's physical ascent is larger than its logical
19200 ascent, use the physical ascent, and make the row taller.
19201 This makes accented characters fully visible. */
19202 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19203 && row
->phys_ascent
> row
->ascent
)
19205 row
->height
+= row
->phys_ascent
- row
->ascent
;
19206 row
->ascent
= row
->phys_ascent
;
19209 /* Compute how much of the line is visible. */
19210 row
->visible_height
= row
->height
;
19212 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19213 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19215 if (row
->y
< min_y
)
19216 row
->visible_height
-= min_y
- row
->y
;
19217 if (row
->y
+ row
->height
> max_y
)
19218 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19222 row
->pixel_width
= row
->used
[TEXT_AREA
];
19223 if (row
->continued_p
)
19224 row
->pixel_width
-= it
->continuation_pixel_width
;
19225 else if (row
->truncated_on_right_p
)
19226 row
->pixel_width
-= it
->truncation_pixel_width
;
19227 row
->ascent
= row
->phys_ascent
= 0;
19228 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19229 row
->extra_line_spacing
= 0;
19232 /* Compute a hash code for this row. */
19233 row
->hash
= row_hash (row
);
19235 it
->max_ascent
= it
->max_descent
= 0;
19236 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19240 /* Append one space to the glyph row of iterator IT if doing a
19241 window-based redisplay. The space has the same face as
19242 IT->face_id. Value is non-zero if a space was added.
19244 This function is called to make sure that there is always one glyph
19245 at the end of a glyph row that the cursor can be set on under
19246 window-systems. (If there weren't such a glyph we would not know
19247 how wide and tall a box cursor should be displayed).
19249 At the same time this space let's a nicely handle clearing to the
19250 end of the line if the row ends in italic text. */
19253 append_space_for_newline (struct it
*it
, int default_face_p
)
19255 if (FRAME_WINDOW_P (it
->f
))
19257 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19259 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19260 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19262 /* Save some values that must not be changed.
19263 Must save IT->c and IT->len because otherwise
19264 ITERATOR_AT_END_P wouldn't work anymore after
19265 append_space_for_newline has been called. */
19266 enum display_element_type saved_what
= it
->what
;
19267 int saved_c
= it
->c
, saved_len
= it
->len
;
19268 int saved_char_to_display
= it
->char_to_display
;
19269 int saved_x
= it
->current_x
;
19270 int saved_face_id
= it
->face_id
;
19271 int saved_box_end
= it
->end_of_box_run_p
;
19272 struct text_pos saved_pos
;
19273 Lisp_Object saved_object
;
19276 saved_object
= it
->object
;
19277 saved_pos
= it
->position
;
19279 it
->what
= IT_CHARACTER
;
19280 memset (&it
->position
, 0, sizeof it
->position
);
19282 it
->c
= it
->char_to_display
= ' ';
19285 /* If the default face was remapped, be sure to use the
19286 remapped face for the appended newline. */
19287 if (default_face_p
)
19288 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19289 else if (it
->face_before_selective_p
)
19290 it
->face_id
= it
->saved_face_id
;
19291 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19292 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19293 /* In R2L rows, we will prepend a stretch glyph that will
19294 have the end_of_box_run_p flag set for it, so there's no
19295 need for the appended newline glyph to have that flag
19297 if (it
->glyph_row
->reversed_p
19298 /* But if the appended newline glyph goes all the way to
19299 the end of the row, there will be no stretch glyph,
19300 so leave the box flag set. */
19301 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19302 it
->end_of_box_run_p
= 0;
19304 PRODUCE_GLYPHS (it
);
19306 it
->override_ascent
= -1;
19307 it
->constrain_row_ascent_descent_p
= 0;
19308 it
->current_x
= saved_x
;
19309 it
->object
= saved_object
;
19310 it
->position
= saved_pos
;
19311 it
->what
= saved_what
;
19312 it
->face_id
= saved_face_id
;
19313 it
->len
= saved_len
;
19315 it
->char_to_display
= saved_char_to_display
;
19316 it
->end_of_box_run_p
= saved_box_end
;
19325 /* Extend the face of the last glyph in the text area of IT->glyph_row
19326 to the end of the display line. Called from display_line. If the
19327 glyph row is empty, add a space glyph to it so that we know the
19328 face to draw. Set the glyph row flag fill_line_p. If the glyph
19329 row is R2L, prepend a stretch glyph to cover the empty space to the
19330 left of the leftmost glyph. */
19333 extend_face_to_end_of_line (struct it
*it
)
19335 struct face
*face
, *default_face
;
19336 struct frame
*f
= it
->f
;
19338 /* If line is already filled, do nothing. Non window-system frames
19339 get a grace of one more ``pixel'' because their characters are
19340 1-``pixel'' wide, so they hit the equality too early. This grace
19341 is needed only for R2L rows that are not continued, to produce
19342 one extra blank where we could display the cursor. */
19343 if ((it
->current_x
>= it
->last_visible_x
19344 + (!FRAME_WINDOW_P (f
)
19345 && it
->glyph_row
->reversed_p
19346 && !it
->glyph_row
->continued_p
))
19347 /* If the window has display margins, we will need to extend
19348 their face even if the text area is filled. */
19349 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19350 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19353 /* The default face, possibly remapped. */
19354 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19356 /* Face extension extends the background and box of IT->face_id
19357 to the end of the line. If the background equals the background
19358 of the frame, we don't have to do anything. */
19359 if (it
->face_before_selective_p
)
19360 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19362 face
= FACE_FROM_ID (f
, it
->face_id
);
19364 if (FRAME_WINDOW_P (f
)
19365 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19366 && face
->box
== FACE_NO_BOX
19367 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19368 #ifdef HAVE_WINDOW_SYSTEM
19371 && !it
->glyph_row
->reversed_p
)
19374 /* Set the glyph row flag indicating that the face of the last glyph
19375 in the text area has to be drawn to the end of the text area. */
19376 it
->glyph_row
->fill_line_p
= 1;
19378 /* If current character of IT is not ASCII, make sure we have the
19379 ASCII face. This will be automatically undone the next time
19380 get_next_display_element returns a multibyte character. Note
19381 that the character will always be single byte in unibyte
19383 if (!ASCII_CHAR_P (it
->c
))
19385 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19388 if (FRAME_WINDOW_P (f
))
19390 /* If the row is empty, add a space with the current face of IT,
19391 so that we know which face to draw. */
19392 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19394 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19395 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19396 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19398 /* Mode line and the header line don't have margins, and
19399 likewise the frame's tool-bar window, if there is any. */
19400 if (!(it
->glyph_row
->mode_line_p
19401 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19402 || (WINDOWP (f
->tool_bar_window
)
19403 && it
->w
== XWINDOW (f
->tool_bar_window
))
19407 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19408 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19410 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19411 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19413 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19415 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19416 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19418 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19419 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19421 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19424 #ifdef HAVE_WINDOW_SYSTEM
19425 if (it
->glyph_row
->reversed_p
)
19427 /* Prepend a stretch glyph to the row, such that the
19428 rightmost glyph will be drawn flushed all the way to the
19429 right margin of the window. The stretch glyph that will
19430 occupy the empty space, if any, to the left of the
19432 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19433 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19434 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19436 int row_width
, stretch_ascent
, stretch_width
;
19437 struct text_pos saved_pos
;
19438 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19440 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19441 row_width
+= g
->pixel_width
;
19443 /* FIXME: There are various minor display glitches in R2L
19444 rows when only one of the fringes is missing. The
19445 strange condition below produces the least bad effect. */
19446 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19447 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19448 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19449 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19451 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19452 stretch_width
-= row_width
;
19454 if (stretch_width
> 0)
19457 (((it
->ascent
+ it
->descent
)
19458 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19459 saved_pos
= it
->position
;
19460 memset (&it
->position
, 0, sizeof it
->position
);
19461 saved_avoid_cursor
= it
->avoid_cursor_p
;
19462 it
->avoid_cursor_p
= 1;
19463 saved_face_id
= it
->face_id
;
19464 saved_box_start
= it
->start_of_box_run_p
;
19465 /* The last row's stretch glyph should get the default
19466 face, to avoid painting the rest of the window with
19467 the region face, if the region ends at ZV. */
19468 if (it
->glyph_row
->ends_at_zv_p
)
19469 it
->face_id
= default_face
->id
;
19471 it
->face_id
= face
->id
;
19472 it
->start_of_box_run_p
= 0;
19473 append_stretch_glyph (it
, Qnil
, stretch_width
,
19474 it
->ascent
+ it
->descent
, stretch_ascent
);
19475 it
->position
= saved_pos
;
19476 it
->avoid_cursor_p
= saved_avoid_cursor
;
19477 it
->face_id
= saved_face_id
;
19478 it
->start_of_box_run_p
= saved_box_start
;
19480 /* If stretch_width comes out negative, it means that the
19481 last glyph is only partially visible. In R2L rows, we
19482 want the leftmost glyph to be partially visible, so we
19483 need to give the row the corresponding left offset. */
19484 if (stretch_width
< 0)
19485 it
->glyph_row
->x
= stretch_width
;
19487 #endif /* HAVE_WINDOW_SYSTEM */
19491 /* Save some values that must not be changed. */
19492 int saved_x
= it
->current_x
;
19493 struct text_pos saved_pos
;
19494 Lisp_Object saved_object
;
19495 enum display_element_type saved_what
= it
->what
;
19496 int saved_face_id
= it
->face_id
;
19498 saved_object
= it
->object
;
19499 saved_pos
= it
->position
;
19501 it
->what
= IT_CHARACTER
;
19502 memset (&it
->position
, 0, sizeof it
->position
);
19504 it
->c
= it
->char_to_display
= ' ';
19507 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19508 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19509 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19510 && !it
->glyph_row
->mode_line_p
19511 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19513 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19514 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19516 for (it
->current_x
= 0; g
< e
; g
++)
19517 it
->current_x
+= g
->pixel_width
;
19519 it
->area
= LEFT_MARGIN_AREA
;
19520 it
->face_id
= default_face
->id
;
19521 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19522 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19524 PRODUCE_GLYPHS (it
);
19525 /* term.c:produce_glyphs advances it->current_x only for
19527 it
->current_x
+= it
->pixel_width
;
19530 it
->current_x
= saved_x
;
19531 it
->area
= TEXT_AREA
;
19534 /* The last row's blank glyphs should get the default face, to
19535 avoid painting the rest of the window with the region face,
19536 if the region ends at ZV. */
19537 if (it
->glyph_row
->ends_at_zv_p
)
19538 it
->face_id
= default_face
->id
;
19540 it
->face_id
= face
->id
;
19541 PRODUCE_GLYPHS (it
);
19543 while (it
->current_x
<= it
->last_visible_x
)
19544 PRODUCE_GLYPHS (it
);
19546 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19547 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19548 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19549 && !it
->glyph_row
->mode_line_p
19550 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19552 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19553 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19555 for ( ; g
< e
; g
++)
19556 it
->current_x
+= g
->pixel_width
;
19558 it
->area
= RIGHT_MARGIN_AREA
;
19559 it
->face_id
= default_face
->id
;
19560 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19561 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19563 PRODUCE_GLYPHS (it
);
19564 it
->current_x
+= it
->pixel_width
;
19567 it
->area
= TEXT_AREA
;
19570 /* Don't count these blanks really. It would let us insert a left
19571 truncation glyph below and make us set the cursor on them, maybe. */
19572 it
->current_x
= saved_x
;
19573 it
->object
= saved_object
;
19574 it
->position
= saved_pos
;
19575 it
->what
= saved_what
;
19576 it
->face_id
= saved_face_id
;
19581 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19582 trailing whitespace. */
19585 trailing_whitespace_p (ptrdiff_t charpos
)
19587 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19590 while (bytepos
< ZV_BYTE
19591 && (c
= FETCH_CHAR (bytepos
),
19592 c
== ' ' || c
== '\t'))
19595 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19597 if (bytepos
!= PT_BYTE
)
19604 /* Highlight trailing whitespace, if any, in ROW. */
19607 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19609 int used
= row
->used
[TEXT_AREA
];
19613 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19614 struct glyph
*glyph
= start
+ used
- 1;
19616 if (row
->reversed_p
)
19618 /* Right-to-left rows need to be processed in the opposite
19619 direction, so swap the edge pointers. */
19621 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19624 /* Skip over glyphs inserted to display the cursor at the
19625 end of a line, for extending the face of the last glyph
19626 to the end of the line on terminals, and for truncation
19627 and continuation glyphs. */
19628 if (!row
->reversed_p
)
19630 while (glyph
>= start
19631 && glyph
->type
== CHAR_GLYPH
19632 && NILP (glyph
->object
))
19637 while (glyph
<= start
19638 && glyph
->type
== CHAR_GLYPH
19639 && NILP (glyph
->object
))
19643 /* If last glyph is a space or stretch, and it's trailing
19644 whitespace, set the face of all trailing whitespace glyphs in
19645 IT->glyph_row to `trailing-whitespace'. */
19646 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19647 && BUFFERP (glyph
->object
)
19648 && (glyph
->type
== STRETCH_GLYPH
19649 || (glyph
->type
== CHAR_GLYPH
19650 && glyph
->u
.ch
== ' '))
19651 && trailing_whitespace_p (glyph
->charpos
))
19653 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19657 if (!row
->reversed_p
)
19659 while (glyph
>= start
19660 && BUFFERP (glyph
->object
)
19661 && (glyph
->type
== STRETCH_GLYPH
19662 || (glyph
->type
== CHAR_GLYPH
19663 && glyph
->u
.ch
== ' ')))
19664 (glyph
--)->face_id
= face_id
;
19668 while (glyph
<= start
19669 && BUFFERP (glyph
->object
)
19670 && (glyph
->type
== STRETCH_GLYPH
19671 || (glyph
->type
== CHAR_GLYPH
19672 && glyph
->u
.ch
== ' ')))
19673 (glyph
++)->face_id
= face_id
;
19680 /* Value is non-zero if glyph row ROW should be
19681 considered to hold the buffer position CHARPOS. */
19684 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19688 if (charpos
== CHARPOS (row
->end
.pos
)
19689 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19691 /* Suppose the row ends on a string.
19692 Unless the row is continued, that means it ends on a newline
19693 in the string. If it's anything other than a display string
19694 (e.g., a before-string from an overlay), we don't want the
19695 cursor there. (This heuristic seems to give the optimal
19696 behavior for the various types of multi-line strings.)
19697 One exception: if the string has `cursor' property on one of
19698 its characters, we _do_ want the cursor there. */
19699 if (CHARPOS (row
->end
.string_pos
) >= 0)
19701 if (row
->continued_p
)
19705 /* Check for `display' property. */
19706 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19707 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19708 struct glyph
*glyph
;
19711 for (glyph
= end
; glyph
>= beg
; --glyph
)
19712 if (STRINGP (glyph
->object
))
19715 = Fget_char_property (make_number (charpos
),
19719 && display_prop_string_p (prop
, glyph
->object
));
19720 /* If there's a `cursor' property on one of the
19721 string's characters, this row is a cursor row,
19722 even though this is not a display string. */
19725 Lisp_Object s
= glyph
->object
;
19727 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19729 ptrdiff_t gpos
= glyph
->charpos
;
19731 if (!NILP (Fget_char_property (make_number (gpos
),
19743 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19745 /* If the row ends in middle of a real character,
19746 and the line is continued, we want the cursor here.
19747 That's because CHARPOS (ROW->end.pos) would equal
19748 PT if PT is before the character. */
19749 if (!row
->ends_in_ellipsis_p
)
19750 result
= row
->continued_p
;
19752 /* If the row ends in an ellipsis, then
19753 CHARPOS (ROW->end.pos) will equal point after the
19754 invisible text. We want that position to be displayed
19755 after the ellipsis. */
19758 /* If the row ends at ZV, display the cursor at the end of that
19759 row instead of at the start of the row below. */
19760 else if (row
->ends_at_zv_p
)
19769 /* Value is non-zero if glyph row ROW should be
19770 used to hold the cursor. */
19773 cursor_row_p (struct glyph_row
*row
)
19775 return row_for_charpos_p (row
, PT
);
19780 /* Push the property PROP so that it will be rendered at the current
19781 position in IT. Return 1 if PROP was successfully pushed, 0
19782 otherwise. Called from handle_line_prefix to handle the
19783 `line-prefix' and `wrap-prefix' properties. */
19786 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19788 struct text_pos pos
=
19789 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19791 eassert (it
->method
== GET_FROM_BUFFER
19792 || it
->method
== GET_FROM_DISPLAY_VECTOR
19793 || it
->method
== GET_FROM_STRING
);
19795 /* We need to save the current buffer/string position, so it will be
19796 restored by pop_it, because iterate_out_of_display_property
19797 depends on that being set correctly, but some situations leave
19798 it->position not yet set when this function is called. */
19799 push_it (it
, &pos
);
19801 if (STRINGP (prop
))
19803 if (SCHARS (prop
) == 0)
19810 it
->string_from_prefix_prop_p
= 1;
19811 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19812 it
->current
.overlay_string_index
= -1;
19813 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19814 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19815 it
->method
= GET_FROM_STRING
;
19816 it
->stop_charpos
= 0;
19818 it
->base_level_stop
= 0;
19820 /* Force paragraph direction to be that of the parent
19822 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19823 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19825 it
->paragraph_embedding
= L2R
;
19827 /* Set up the bidi iterator for this display string. */
19830 it
->bidi_it
.string
.lstring
= it
->string
;
19831 it
->bidi_it
.string
.s
= NULL
;
19832 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19833 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19834 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19835 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19836 it
->bidi_it
.w
= it
->w
;
19837 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19840 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19842 it
->method
= GET_FROM_STRETCH
;
19845 #ifdef HAVE_WINDOW_SYSTEM
19846 else if (IMAGEP (prop
))
19848 it
->what
= IT_IMAGE
;
19849 it
->image_id
= lookup_image (it
->f
, prop
);
19850 it
->method
= GET_FROM_IMAGE
;
19852 #endif /* HAVE_WINDOW_SYSTEM */
19855 pop_it (it
); /* bogus display property, give up */
19862 /* Return the character-property PROP at the current position in IT. */
19865 get_it_property (struct it
*it
, Lisp_Object prop
)
19867 Lisp_Object position
, object
= it
->object
;
19869 if (STRINGP (object
))
19870 position
= make_number (IT_STRING_CHARPOS (*it
));
19871 else if (BUFFERP (object
))
19873 position
= make_number (IT_CHARPOS (*it
));
19874 object
= it
->window
;
19879 return Fget_char_property (position
, prop
, object
);
19882 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19885 handle_line_prefix (struct it
*it
)
19887 Lisp_Object prefix
;
19889 if (it
->continuation_lines_width
> 0)
19891 prefix
= get_it_property (it
, Qwrap_prefix
);
19893 prefix
= Vwrap_prefix
;
19897 prefix
= get_it_property (it
, Qline_prefix
);
19899 prefix
= Vline_prefix
;
19901 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19903 /* If the prefix is wider than the window, and we try to wrap
19904 it, it would acquire its own wrap prefix, and so on till the
19905 iterator stack overflows. So, don't wrap the prefix. */
19906 it
->line_wrap
= TRUNCATE
;
19907 it
->avoid_cursor_p
= 1;
19913 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19914 only for R2L lines from display_line and display_string, when they
19915 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19916 the line/string needs to be continued on the next glyph row. */
19918 unproduce_glyphs (struct it
*it
, int n
)
19920 struct glyph
*glyph
, *end
;
19922 eassert (it
->glyph_row
);
19923 eassert (it
->glyph_row
->reversed_p
);
19924 eassert (it
->area
== TEXT_AREA
);
19925 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19927 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19928 n
= it
->glyph_row
->used
[TEXT_AREA
];
19929 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19930 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19931 for ( ; glyph
< end
; glyph
++)
19932 glyph
[-n
] = *glyph
;
19935 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19936 and ROW->maxpos. */
19938 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19939 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19940 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19942 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19943 lines' rows is implemented for bidi-reordered rows. */
19945 /* ROW->minpos is the value of min_pos, the minimal buffer position
19946 we have in ROW, or ROW->start.pos if that is smaller. */
19947 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19948 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19950 /* We didn't find buffer positions smaller than ROW->start, or
19951 didn't find _any_ valid buffer positions in any of the glyphs,
19952 so we must trust the iterator's computed positions. */
19953 row
->minpos
= row
->start
.pos
;
19956 max_pos
= CHARPOS (it
->current
.pos
);
19957 max_bpos
= BYTEPOS (it
->current
.pos
);
19960 /* Here are the various use-cases for ending the row, and the
19961 corresponding values for ROW->maxpos:
19963 Line ends in a newline from buffer eol_pos + 1
19964 Line is continued from buffer max_pos + 1
19965 Line is truncated on right it->current.pos
19966 Line ends in a newline from string max_pos + 1(*)
19967 (*) + 1 only when line ends in a forward scan
19968 Line is continued from string max_pos
19969 Line is continued from display vector max_pos
19970 Line is entirely from a string min_pos == max_pos
19971 Line is entirely from a display vector min_pos == max_pos
19972 Line that ends at ZV ZV
19974 If you discover other use-cases, please add them here as
19976 if (row
->ends_at_zv_p
)
19977 row
->maxpos
= it
->current
.pos
;
19978 else if (row
->used
[TEXT_AREA
])
19980 int seen_this_string
= 0;
19981 struct glyph_row
*r1
= row
- 1;
19983 /* Did we see the same display string on the previous row? */
19984 if (STRINGP (it
->object
)
19985 /* this is not the first row */
19986 && row
> it
->w
->desired_matrix
->rows
19987 /* previous row is not the header line */
19988 && !r1
->mode_line_p
19989 /* previous row also ends in a newline from a string */
19990 && r1
->ends_in_newline_from_string_p
)
19992 struct glyph
*start
, *end
;
19994 /* Search for the last glyph of the previous row that came
19995 from buffer or string. Depending on whether the row is
19996 L2R or R2L, we need to process it front to back or the
19997 other way round. */
19998 if (!r1
->reversed_p
)
20000 start
= r1
->glyphs
[TEXT_AREA
];
20001 end
= start
+ r1
->used
[TEXT_AREA
];
20002 /* Glyphs inserted by redisplay have nil as their object. */
20004 && NILP ((end
- 1)->object
)
20005 && (end
- 1)->charpos
<= 0)
20009 if (EQ ((end
- 1)->object
, it
->object
))
20010 seen_this_string
= 1;
20013 /* If all the glyphs of the previous row were inserted
20014 by redisplay, it means the previous row was
20015 produced from a single newline, which is only
20016 possible if that newline came from the same string
20017 as the one which produced this ROW. */
20018 seen_this_string
= 1;
20022 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20023 start
= end
+ r1
->used
[TEXT_AREA
];
20025 && NILP ((end
+ 1)->object
)
20026 && (end
+ 1)->charpos
<= 0)
20030 if (EQ ((end
+ 1)->object
, it
->object
))
20031 seen_this_string
= 1;
20034 seen_this_string
= 1;
20037 /* Take note of each display string that covers a newline only
20038 once, the first time we see it. This is for when a display
20039 string includes more than one newline in it. */
20040 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20042 /* If we were scanning the buffer forward when we displayed
20043 the string, we want to account for at least one buffer
20044 position that belongs to this row (position covered by
20045 the display string), so that cursor positioning will
20046 consider this row as a candidate when point is at the end
20047 of the visual line represented by this row. This is not
20048 required when scanning back, because max_pos will already
20049 have a much larger value. */
20050 if (CHARPOS (row
->end
.pos
) > max_pos
)
20051 INC_BOTH (max_pos
, max_bpos
);
20052 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20054 else if (CHARPOS (it
->eol_pos
) > 0)
20055 SET_TEXT_POS (row
->maxpos
,
20056 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20057 else if (row
->continued_p
)
20059 /* If max_pos is different from IT's current position, it
20060 means IT->method does not belong to the display element
20061 at max_pos. However, it also means that the display
20062 element at max_pos was displayed in its entirety on this
20063 line, which is equivalent to saying that the next line
20064 starts at the next buffer position. */
20065 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20066 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20069 INC_BOTH (max_pos
, max_bpos
);
20070 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20073 else if (row
->truncated_on_right_p
)
20074 /* display_line already called reseat_at_next_visible_line_start,
20075 which puts the iterator at the beginning of the next line, in
20076 the logical order. */
20077 row
->maxpos
= it
->current
.pos
;
20078 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20079 /* A line that is entirely from a string/image/stretch... */
20080 row
->maxpos
= row
->minpos
;
20085 row
->maxpos
= it
->current
.pos
;
20088 /* Construct the glyph row IT->glyph_row in the desired matrix of
20089 IT->w from text at the current position of IT. See dispextern.h
20090 for an overview of struct it. Value is non-zero if
20091 IT->glyph_row displays text, as opposed to a line displaying ZV
20095 display_line (struct it
*it
)
20097 struct glyph_row
*row
= it
->glyph_row
;
20098 Lisp_Object overlay_arrow_string
;
20100 void *wrap_data
= NULL
;
20101 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20102 int wrap_row_used
= -1;
20103 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20104 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20105 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20106 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20107 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20109 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20110 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20111 bool pending_handle_line_prefix
= false;
20113 /* We always start displaying at hpos zero even if hscrolled. */
20114 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20116 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20117 >= it
->w
->desired_matrix
->nrows
)
20119 it
->w
->nrows_scale_factor
++;
20120 it
->f
->fonts_changed
= 1;
20124 /* Clear the result glyph row and enable it. */
20125 prepare_desired_row (it
->w
, row
, false);
20127 row
->y
= it
->current_y
;
20128 row
->start
= it
->start
;
20129 row
->continuation_lines_width
= it
->continuation_lines_width
;
20130 row
->displays_text_p
= 1;
20131 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20132 it
->starts_in_middle_of_char_p
= 0;
20134 /* Arrange the overlays nicely for our purposes. Usually, we call
20135 display_line on only one line at a time, in which case this
20136 can't really hurt too much, or we call it on lines which appear
20137 one after another in the buffer, in which case all calls to
20138 recenter_overlay_lists but the first will be pretty cheap. */
20139 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20141 /* Move over display elements that are not visible because we are
20142 hscrolled. This may stop at an x-position < IT->first_visible_x
20143 if the first glyph is partially visible or if we hit a line end. */
20144 if (it
->current_x
< it
->first_visible_x
)
20146 enum move_it_result move_result
;
20148 this_line_min_pos
= row
->start
.pos
;
20149 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20150 MOVE_TO_POS
| MOVE_TO_X
);
20151 /* If we are under a large hscroll, move_it_in_display_line_to
20152 could hit the end of the line without reaching
20153 it->first_visible_x. Pretend that we did reach it. This is
20154 especially important on a TTY, where we will call
20155 extend_face_to_end_of_line, which needs to know how many
20156 blank glyphs to produce. */
20157 if (it
->current_x
< it
->first_visible_x
20158 && (move_result
== MOVE_NEWLINE_OR_CR
20159 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20160 it
->current_x
= it
->first_visible_x
;
20162 /* Record the smallest positions seen while we moved over
20163 display elements that are not visible. This is needed by
20164 redisplay_internal for optimizing the case where the cursor
20165 stays inside the same line. The rest of this function only
20166 considers positions that are actually displayed, so
20167 RECORD_MAX_MIN_POS will not otherwise record positions that
20168 are hscrolled to the left of the left edge of the window. */
20169 min_pos
= CHARPOS (this_line_min_pos
);
20170 min_bpos
= BYTEPOS (this_line_min_pos
);
20172 else if (it
->area
== TEXT_AREA
)
20174 /* We only do this when not calling move_it_in_display_line_to
20175 above, because that function calls itself handle_line_prefix. */
20176 handle_line_prefix (it
);
20180 /* Line-prefix and wrap-prefix are always displayed in the text
20181 area. But if this is the first call to display_line after
20182 init_iterator, the iterator might have been set up to write
20183 into a marginal area, e.g. if the line begins with some
20184 display property that writes to the margins. So we need to
20185 wait with the call to handle_line_prefix until whatever
20186 writes to the margin has done its job. */
20187 pending_handle_line_prefix
= true;
20190 /* Get the initial row height. This is either the height of the
20191 text hscrolled, if there is any, or zero. */
20192 row
->ascent
= it
->max_ascent
;
20193 row
->height
= it
->max_ascent
+ it
->max_descent
;
20194 row
->phys_ascent
= it
->max_phys_ascent
;
20195 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20196 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20198 /* Utility macro to record max and min buffer positions seen until now. */
20199 #define RECORD_MAX_MIN_POS(IT) \
20202 int composition_p = !STRINGP ((IT)->string) \
20203 && ((IT)->what == IT_COMPOSITION); \
20204 ptrdiff_t current_pos = \
20205 composition_p ? (IT)->cmp_it.charpos \
20206 : IT_CHARPOS (*(IT)); \
20207 ptrdiff_t current_bpos = \
20208 composition_p ? CHAR_TO_BYTE (current_pos) \
20209 : IT_BYTEPOS (*(IT)); \
20210 if (current_pos < min_pos) \
20212 min_pos = current_pos; \
20213 min_bpos = current_bpos; \
20215 if (IT_CHARPOS (*it) > max_pos) \
20217 max_pos = IT_CHARPOS (*it); \
20218 max_bpos = IT_BYTEPOS (*it); \
20223 /* Loop generating characters. The loop is left with IT on the next
20224 character to display. */
20227 int n_glyphs_before
, hpos_before
, x_before
;
20229 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20231 /* Retrieve the next thing to display. Value is zero if end of
20233 if (!get_next_display_element (it
))
20235 /* Maybe add a space at the end of this line that is used to
20236 display the cursor there under X. Set the charpos of the
20237 first glyph of blank lines not corresponding to any text
20239 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20240 row
->exact_window_width_line_p
= 1;
20241 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20242 || row
->used
[TEXT_AREA
] == 0)
20244 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20245 row
->displays_text_p
= 0;
20247 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20248 && (!MINI_WINDOW_P (it
->w
)
20249 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20250 row
->indicate_empty_line_p
= 1;
20253 it
->continuation_lines_width
= 0;
20254 row
->ends_at_zv_p
= 1;
20255 /* A row that displays right-to-left text must always have
20256 its last face extended all the way to the end of line,
20257 even if this row ends in ZV, because we still write to
20258 the screen left to right. We also need to extend the
20259 last face if the default face is remapped to some
20260 different face, otherwise the functions that clear
20261 portions of the screen will clear with the default face's
20262 background color. */
20263 if (row
->reversed_p
20264 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20265 extend_face_to_end_of_line (it
);
20269 /* Now, get the metrics of what we want to display. This also
20270 generates glyphs in `row' (which is IT->glyph_row). */
20271 n_glyphs_before
= row
->used
[TEXT_AREA
];
20274 /* Remember the line height so far in case the next element doesn't
20275 fit on the line. */
20276 if (it
->line_wrap
!= TRUNCATE
)
20278 ascent
= it
->max_ascent
;
20279 descent
= it
->max_descent
;
20280 phys_ascent
= it
->max_phys_ascent
;
20281 phys_descent
= it
->max_phys_descent
;
20283 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20285 if (IT_DISPLAYING_WHITESPACE (it
))
20289 SAVE_IT (wrap_it
, *it
, wrap_data
);
20291 wrap_row_used
= row
->used
[TEXT_AREA
];
20292 wrap_row_ascent
= row
->ascent
;
20293 wrap_row_height
= row
->height
;
20294 wrap_row_phys_ascent
= row
->phys_ascent
;
20295 wrap_row_phys_height
= row
->phys_height
;
20296 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20297 wrap_row_min_pos
= min_pos
;
20298 wrap_row_min_bpos
= min_bpos
;
20299 wrap_row_max_pos
= max_pos
;
20300 wrap_row_max_bpos
= max_bpos
;
20306 PRODUCE_GLYPHS (it
);
20308 /* If this display element was in marginal areas, continue with
20310 if (it
->area
!= TEXT_AREA
)
20312 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20313 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20314 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20315 row
->phys_height
= max (row
->phys_height
,
20316 it
->max_phys_ascent
+ it
->max_phys_descent
);
20317 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20318 it
->max_extra_line_spacing
);
20319 set_iterator_to_next (it
, 1);
20320 /* If we didn't handle the line/wrap prefix above, and the
20321 call to set_iterator_to_next just switched to TEXT_AREA,
20322 process the prefix now. */
20323 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20325 pending_handle_line_prefix
= false;
20326 handle_line_prefix (it
);
20331 /* Does the display element fit on the line? If we truncate
20332 lines, we should draw past the right edge of the window. If
20333 we don't truncate, we want to stop so that we can display the
20334 continuation glyph before the right margin. If lines are
20335 continued, there are two possible strategies for characters
20336 resulting in more than 1 glyph (e.g. tabs): Display as many
20337 glyphs as possible in this line and leave the rest for the
20338 continuation line, or display the whole element in the next
20339 line. Original redisplay did the former, so we do it also. */
20340 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20341 hpos_before
= it
->hpos
;
20344 if (/* Not a newline. */
20346 /* Glyphs produced fit entirely in the line. */
20347 && it
->current_x
< it
->last_visible_x
)
20349 it
->hpos
+= nglyphs
;
20350 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20351 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20352 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20353 row
->phys_height
= max (row
->phys_height
,
20354 it
->max_phys_ascent
+ it
->max_phys_descent
);
20355 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20356 it
->max_extra_line_spacing
);
20357 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20358 /* In R2L rows, we arrange in extend_face_to_end_of_line
20359 to add a right offset to the line, by a suitable
20360 change to the stretch glyph that is the leftmost
20361 glyph of the line. */
20362 && !row
->reversed_p
)
20363 row
->x
= x
- it
->first_visible_x
;
20364 /* Record the maximum and minimum buffer positions seen so
20365 far in glyphs that will be displayed by this row. */
20367 RECORD_MAX_MIN_POS (it
);
20372 struct glyph
*glyph
;
20374 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20376 /* Identify the glyphs added by the last call to
20377 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20378 the previous glyphs. */
20379 if (!row
->reversed_p
)
20380 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20382 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20383 new_x
= x
+ glyph
->pixel_width
;
20385 if (/* Lines are continued. */
20386 it
->line_wrap
!= TRUNCATE
20387 && (/* Glyph doesn't fit on the line. */
20388 new_x
> it
->last_visible_x
20389 /* Or it fits exactly on a window system frame. */
20390 || (new_x
== it
->last_visible_x
20391 && FRAME_WINDOW_P (it
->f
)
20392 && (row
->reversed_p
20393 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20394 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20396 /* End of a continued line. */
20399 || (new_x
== it
->last_visible_x
20400 && FRAME_WINDOW_P (it
->f
)
20401 && (row
->reversed_p
20402 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20403 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20405 /* Current glyph is the only one on the line or
20406 fits exactly on the line. We must continue
20407 the line because we can't draw the cursor
20408 after the glyph. */
20409 row
->continued_p
= 1;
20410 it
->current_x
= new_x
;
20411 it
->continuation_lines_width
+= new_x
;
20413 if (i
== nglyphs
- 1)
20415 /* If line-wrap is on, check if a previous
20416 wrap point was found. */
20417 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20418 && wrap_row_used
> 0
20419 /* Even if there is a previous wrap
20420 point, continue the line here as
20421 usual, if (i) the previous character
20422 was a space or tab AND (ii) the
20423 current character is not. */
20425 || IT_DISPLAYING_WHITESPACE (it
)))
20428 /* Record the maximum and minimum buffer
20429 positions seen so far in glyphs that will be
20430 displayed by this row. */
20432 RECORD_MAX_MIN_POS (it
);
20433 set_iterator_to_next (it
, 1);
20434 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20436 if (!get_next_display_element (it
))
20438 row
->exact_window_width_line_p
= 1;
20439 it
->continuation_lines_width
= 0;
20440 row
->continued_p
= 0;
20441 row
->ends_at_zv_p
= 1;
20443 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20445 row
->continued_p
= 0;
20446 row
->exact_window_width_line_p
= 1;
20448 /* If line-wrap is on, check if a
20449 previous wrap point was found. */
20450 else if (wrap_row_used
> 0
20451 /* Even if there is a previous wrap
20452 point, continue the line here as
20453 usual, if (i) the previous character
20454 was a space or tab AND (ii) the
20455 current character is not. */
20457 || IT_DISPLAYING_WHITESPACE (it
)))
20462 else if (it
->bidi_p
)
20463 RECORD_MAX_MIN_POS (it
);
20464 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20465 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20466 extend_face_to_end_of_line (it
);
20468 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20469 && !FRAME_WINDOW_P (it
->f
))
20471 /* A padding glyph that doesn't fit on this line.
20472 This means the whole character doesn't fit
20474 if (row
->reversed_p
)
20475 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20476 - n_glyphs_before
);
20477 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20479 /* Fill the rest of the row with continuation
20480 glyphs like in 20.x. */
20481 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20482 < row
->glyphs
[1 + TEXT_AREA
])
20483 produce_special_glyphs (it
, IT_CONTINUATION
);
20485 row
->continued_p
= 1;
20486 it
->current_x
= x_before
;
20487 it
->continuation_lines_width
+= x_before
;
20489 /* Restore the height to what it was before the
20490 element not fitting on the line. */
20491 it
->max_ascent
= ascent
;
20492 it
->max_descent
= descent
;
20493 it
->max_phys_ascent
= phys_ascent
;
20494 it
->max_phys_descent
= phys_descent
;
20495 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20496 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20497 extend_face_to_end_of_line (it
);
20499 else if (wrap_row_used
> 0)
20502 if (row
->reversed_p
)
20503 unproduce_glyphs (it
,
20504 row
->used
[TEXT_AREA
] - wrap_row_used
);
20505 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20506 it
->continuation_lines_width
+= wrap_x
;
20507 row
->used
[TEXT_AREA
] = wrap_row_used
;
20508 row
->ascent
= wrap_row_ascent
;
20509 row
->height
= wrap_row_height
;
20510 row
->phys_ascent
= wrap_row_phys_ascent
;
20511 row
->phys_height
= wrap_row_phys_height
;
20512 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20513 min_pos
= wrap_row_min_pos
;
20514 min_bpos
= wrap_row_min_bpos
;
20515 max_pos
= wrap_row_max_pos
;
20516 max_bpos
= wrap_row_max_bpos
;
20517 row
->continued_p
= 1;
20518 row
->ends_at_zv_p
= 0;
20519 row
->exact_window_width_line_p
= 0;
20520 it
->continuation_lines_width
+= x
;
20522 /* Make sure that a non-default face is extended
20523 up to the right margin of the window. */
20524 extend_face_to_end_of_line (it
);
20526 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20528 /* A TAB that extends past the right edge of the
20529 window. This produces a single glyph on
20530 window system frames. We leave the glyph in
20531 this row and let it fill the row, but don't
20532 consume the TAB. */
20533 if ((row
->reversed_p
20534 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20535 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20536 produce_special_glyphs (it
, IT_CONTINUATION
);
20537 it
->continuation_lines_width
+= it
->last_visible_x
;
20538 row
->ends_in_middle_of_char_p
= 1;
20539 row
->continued_p
= 1;
20540 glyph
->pixel_width
= it
->last_visible_x
- x
;
20541 it
->starts_in_middle_of_char_p
= 1;
20542 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20543 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20544 extend_face_to_end_of_line (it
);
20548 /* Something other than a TAB that draws past
20549 the right edge of the window. Restore
20550 positions to values before the element. */
20551 if (row
->reversed_p
)
20552 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20553 - (n_glyphs_before
+ i
));
20554 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20556 /* Display continuation glyphs. */
20557 it
->current_x
= x_before
;
20558 it
->continuation_lines_width
+= x
;
20559 if (!FRAME_WINDOW_P (it
->f
)
20560 || (row
->reversed_p
20561 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20562 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20563 produce_special_glyphs (it
, IT_CONTINUATION
);
20564 row
->continued_p
= 1;
20566 extend_face_to_end_of_line (it
);
20568 if (nglyphs
> 1 && i
> 0)
20570 row
->ends_in_middle_of_char_p
= 1;
20571 it
->starts_in_middle_of_char_p
= 1;
20574 /* Restore the height to what it was before the
20575 element not fitting on the line. */
20576 it
->max_ascent
= ascent
;
20577 it
->max_descent
= descent
;
20578 it
->max_phys_ascent
= phys_ascent
;
20579 it
->max_phys_descent
= phys_descent
;
20584 else if (new_x
> it
->first_visible_x
)
20586 /* Increment number of glyphs actually displayed. */
20589 /* Record the maximum and minimum buffer positions
20590 seen so far in glyphs that will be displayed by
20593 RECORD_MAX_MIN_POS (it
);
20595 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20596 /* Glyph is partially visible, i.e. row starts at
20597 negative X position. Don't do that in R2L
20598 rows, where we arrange to add a right offset to
20599 the line in extend_face_to_end_of_line, by a
20600 suitable change to the stretch glyph that is
20601 the leftmost glyph of the line. */
20602 row
->x
= x
- it
->first_visible_x
;
20603 /* When the last glyph of an R2L row only fits
20604 partially on the line, we need to set row->x to a
20605 negative offset, so that the leftmost glyph is
20606 the one that is partially visible. But if we are
20607 going to produce the truncation glyph, this will
20608 be taken care of in produce_special_glyphs. */
20609 if (row
->reversed_p
20610 && new_x
> it
->last_visible_x
20611 && !(it
->line_wrap
== TRUNCATE
20612 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20614 eassert (FRAME_WINDOW_P (it
->f
));
20615 row
->x
= it
->last_visible_x
- new_x
;
20620 /* Glyph is completely off the left margin of the
20621 window. This should not happen because of the
20622 move_it_in_display_line at the start of this
20623 function, unless the text display area of the
20624 window is empty. */
20625 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20628 /* Even if this display element produced no glyphs at all,
20629 we want to record its position. */
20630 if (it
->bidi_p
&& nglyphs
== 0)
20631 RECORD_MAX_MIN_POS (it
);
20633 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20634 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20635 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20636 row
->phys_height
= max (row
->phys_height
,
20637 it
->max_phys_ascent
+ it
->max_phys_descent
);
20638 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20639 it
->max_extra_line_spacing
);
20641 /* End of this display line if row is continued. */
20642 if (row
->continued_p
|| row
->ends_at_zv_p
)
20647 /* Is this a line end? If yes, we're also done, after making
20648 sure that a non-default face is extended up to the right
20649 margin of the window. */
20650 if (ITERATOR_AT_END_OF_LINE_P (it
))
20652 int used_before
= row
->used
[TEXT_AREA
];
20654 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20656 /* Add a space at the end of the line that is used to
20657 display the cursor there. */
20658 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20659 append_space_for_newline (it
, 0);
20661 /* Extend the face to the end of the line. */
20662 extend_face_to_end_of_line (it
);
20664 /* Make sure we have the position. */
20665 if (used_before
== 0)
20666 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20668 /* Record the position of the newline, for use in
20670 it
->eol_pos
= it
->current
.pos
;
20672 /* Consume the line end. This skips over invisible lines. */
20673 set_iterator_to_next (it
, 1);
20674 it
->continuation_lines_width
= 0;
20678 /* Proceed with next display element. Note that this skips
20679 over lines invisible because of selective display. */
20680 set_iterator_to_next (it
, 1);
20682 /* If we truncate lines, we are done when the last displayed
20683 glyphs reach past the right margin of the window. */
20684 if (it
->line_wrap
== TRUNCATE
20685 && ((FRAME_WINDOW_P (it
->f
)
20686 /* Images are preprocessed in produce_image_glyph such
20687 that they are cropped at the right edge of the
20688 window, so an image glyph will always end exactly at
20689 last_visible_x, even if there's no right fringe. */
20690 && ((row
->reversed_p
20691 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20692 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20693 || it
->what
== IT_IMAGE
))
20694 ? (it
->current_x
>= it
->last_visible_x
)
20695 : (it
->current_x
> it
->last_visible_x
)))
20697 /* Maybe add truncation glyphs. */
20698 if (!FRAME_WINDOW_P (it
->f
)
20699 || (row
->reversed_p
20700 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20701 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20705 if (!row
->reversed_p
)
20707 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20708 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20713 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20714 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20716 /* Remove any padding glyphs at the front of ROW, to
20717 make room for the truncation glyphs we will be
20718 adding below. The loop below always inserts at
20719 least one truncation glyph, so also remove the
20720 last glyph added to ROW. */
20721 unproduce_glyphs (it
, i
+ 1);
20722 /* Adjust i for the loop below. */
20723 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20726 /* produce_special_glyphs overwrites the last glyph, so
20727 we don't want that if we want to keep that last
20728 glyph, which means it's an image. */
20729 if (it
->current_x
> it
->last_visible_x
)
20731 it
->current_x
= x_before
;
20732 if (!FRAME_WINDOW_P (it
->f
))
20734 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20736 row
->used
[TEXT_AREA
] = i
;
20737 produce_special_glyphs (it
, IT_TRUNCATION
);
20742 row
->used
[TEXT_AREA
] = i
;
20743 produce_special_glyphs (it
, IT_TRUNCATION
);
20745 it
->hpos
= hpos_before
;
20748 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20750 /* Don't truncate if we can overflow newline into fringe. */
20751 if (!get_next_display_element (it
))
20753 it
->continuation_lines_width
= 0;
20754 row
->ends_at_zv_p
= 1;
20755 row
->exact_window_width_line_p
= 1;
20758 if (ITERATOR_AT_END_OF_LINE_P (it
))
20760 row
->exact_window_width_line_p
= 1;
20761 goto at_end_of_line
;
20763 it
->current_x
= x_before
;
20764 it
->hpos
= hpos_before
;
20767 row
->truncated_on_right_p
= 1;
20768 it
->continuation_lines_width
= 0;
20769 reseat_at_next_visible_line_start (it
, 0);
20770 /* We insist below that IT's position be at ZV because in
20771 bidi-reordered lines the character at visible line start
20772 might not be the character that follows the newline in
20773 the logical order. */
20774 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20775 row
->ends_at_zv_p
=
20776 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20778 row
->ends_at_zv_p
= false;
20784 bidi_unshelve_cache (wrap_data
, 1);
20786 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20787 at the left window margin. */
20788 if (it
->first_visible_x
20789 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20791 if (!FRAME_WINDOW_P (it
->f
)
20792 || (((row
->reversed_p
20793 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20794 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20795 /* Don't let insert_left_trunc_glyphs overwrite the
20796 first glyph of the row if it is an image. */
20797 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20798 insert_left_trunc_glyphs (it
);
20799 row
->truncated_on_left_p
= 1;
20802 /* Remember the position at which this line ends.
20804 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20805 cannot be before the call to find_row_edges below, since that is
20806 where these positions are determined. */
20807 row
->end
= it
->current
;
20810 row
->minpos
= row
->start
.pos
;
20811 row
->maxpos
= row
->end
.pos
;
20815 /* ROW->minpos and ROW->maxpos must be the smallest and
20816 `1 + the largest' buffer positions in ROW. But if ROW was
20817 bidi-reordered, these two positions can be anywhere in the
20818 row, so we must determine them now. */
20819 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20822 /* If the start of this line is the overlay arrow-position, then
20823 mark this glyph row as the one containing the overlay arrow.
20824 This is clearly a mess with variable size fonts. It would be
20825 better to let it be displayed like cursors under X. */
20826 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20827 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20828 !NILP (overlay_arrow_string
)))
20830 /* Overlay arrow in window redisplay is a fringe bitmap. */
20831 if (STRINGP (overlay_arrow_string
))
20833 struct glyph_row
*arrow_row
20834 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20835 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20836 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20837 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20838 struct glyph
*p2
, *end
;
20840 /* Copy the arrow glyphs. */
20841 while (glyph
< arrow_end
)
20844 /* Throw away padding glyphs. */
20846 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20847 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20853 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20858 eassert (INTEGERP (overlay_arrow_string
));
20859 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20861 overlay_arrow_seen
= 1;
20864 /* Highlight trailing whitespace. */
20865 if (!NILP (Vshow_trailing_whitespace
))
20866 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20868 /* Compute pixel dimensions of this line. */
20869 compute_line_metrics (it
);
20871 /* Implementation note: No changes in the glyphs of ROW or in their
20872 faces can be done past this point, because compute_line_metrics
20873 computes ROW's hash value and stores it within the glyph_row
20876 /* Record whether this row ends inside an ellipsis. */
20877 row
->ends_in_ellipsis_p
20878 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20879 && it
->ellipsis_p
);
20881 /* Save fringe bitmaps in this row. */
20882 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20883 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20884 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20885 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20887 it
->left_user_fringe_bitmap
= 0;
20888 it
->left_user_fringe_face_id
= 0;
20889 it
->right_user_fringe_bitmap
= 0;
20890 it
->right_user_fringe_face_id
= 0;
20892 /* Maybe set the cursor. */
20893 cvpos
= it
->w
->cursor
.vpos
;
20895 /* In bidi-reordered rows, keep checking for proper cursor
20896 position even if one has been found already, because buffer
20897 positions in such rows change non-linearly with ROW->VPOS,
20898 when a line is continued. One exception: when we are at ZV,
20899 display cursor on the first suitable glyph row, since all
20900 the empty rows after that also have their position set to ZV. */
20901 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20902 lines' rows is implemented for bidi-reordered rows. */
20904 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20905 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20906 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20907 && cursor_row_p (row
))
20908 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20910 /* Prepare for the next line. This line starts horizontally at (X
20911 HPOS) = (0 0). Vertical positions are incremented. As a
20912 convenience for the caller, IT->glyph_row is set to the next
20914 it
->current_x
= it
->hpos
= 0;
20915 it
->current_y
+= row
->height
;
20916 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20919 /* The next row should by default use the same value of the
20920 reversed_p flag as this one. set_iterator_to_next decides when
20921 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20922 the flag accordingly. */
20923 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20924 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20925 it
->start
= row
->end
;
20926 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20928 #undef RECORD_MAX_MIN_POS
20931 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20932 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20933 doc
: /* Return paragraph direction at point in BUFFER.
20934 Value is either `left-to-right' or `right-to-left'.
20935 If BUFFER is omitted or nil, it defaults to the current buffer.
20937 Paragraph direction determines how the text in the paragraph is displayed.
20938 In left-to-right paragraphs, text begins at the left margin of the window
20939 and the reading direction is generally left to right. In right-to-left
20940 paragraphs, text begins at the right margin and is read from right to left.
20942 See also `bidi-paragraph-direction'. */)
20943 (Lisp_Object buffer
)
20945 struct buffer
*buf
= current_buffer
;
20946 struct buffer
*old
= buf
;
20948 if (! NILP (buffer
))
20950 CHECK_BUFFER (buffer
);
20951 buf
= XBUFFER (buffer
);
20954 if (NILP (BVAR (buf
, bidi_display_reordering
))
20955 || NILP (BVAR (buf
, enable_multibyte_characters
))
20956 /* When we are loading loadup.el, the character property tables
20957 needed for bidi iteration are not yet available. */
20958 || !NILP (Vpurify_flag
))
20959 return Qleft_to_right
;
20960 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20961 return BVAR (buf
, bidi_paragraph_direction
);
20964 /* Determine the direction from buffer text. We could try to
20965 use current_matrix if it is up to date, but this seems fast
20966 enough as it is. */
20967 struct bidi_it itb
;
20968 ptrdiff_t pos
= BUF_PT (buf
);
20969 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20971 void *itb_data
= bidi_shelve_cache ();
20973 set_buffer_temp (buf
);
20974 /* bidi_paragraph_init finds the base direction of the paragraph
20975 by searching forward from paragraph start. We need the base
20976 direction of the current or _previous_ paragraph, so we need
20977 to make sure we are within that paragraph. To that end, find
20978 the previous non-empty line. */
20979 if (pos
>= ZV
&& pos
> BEGV
)
20980 DEC_BOTH (pos
, bytepos
);
20981 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
20982 if (fast_looking_at (trailing_white_space
,
20983 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20985 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20986 || c
== ' ' || c
== '\t' || c
== '\f')
20988 if (bytepos
<= BEGV_BYTE
)
20993 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20996 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20997 itb
.paragraph_dir
= NEUTRAL_DIR
;
20998 itb
.string
.s
= NULL
;
20999 itb
.string
.lstring
= Qnil
;
21000 itb
.string
.bufpos
= 0;
21001 itb
.string
.from_disp_str
= 0;
21002 itb
.string
.unibyte
= 0;
21003 /* We have no window to use here for ignoring window-specific
21004 overlays. Using NULL for window pointer will cause
21005 compute_display_string_pos to use the current buffer. */
21007 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
21008 bidi_unshelve_cache (itb_data
, 0);
21009 set_buffer_temp (old
);
21010 switch (itb
.paragraph_dir
)
21013 return Qleft_to_right
;
21016 return Qright_to_left
;
21024 DEFUN ("bidi-find-overridden-directionality",
21025 Fbidi_find_overridden_directionality
,
21026 Sbidi_find_overridden_directionality
, 2, 3, 0,
21027 doc
: /* Return position between FROM and TO where directionality was overridden.
21029 This function returns the first character position in the specified
21030 region of OBJECT where there is a character whose `bidi-class' property
21031 is `L', but which was forced to display as `R' by a directional
21032 override, and likewise with characters whose `bidi-class' is `R'
21033 or `AL' that were forced to display as `L'.
21035 If no such character is found, the function returns nil.
21037 OBJECT is a Lisp string or buffer to search for overridden
21038 directionality, and defaults to the current buffer if nil or omitted.
21039 OBJECT can also be a window, in which case the function will search
21040 the buffer displayed in that window. Passing the window instead of
21041 a buffer is preferable when the buffer is displayed in some window,
21042 because this function will then be able to correctly account for
21043 window-specific overlays, which can affect the results.
21045 Strong directional characters `L', `R', and `AL' can have their
21046 intrinsic directionality overridden by directional override
21047 control characters RLO \(u+202e) and LRO \(u+202d). See the
21048 function `get-char-code-property' for a way to inquire about
21049 the `bidi-class' property of a character. */)
21050 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21052 struct buffer
*buf
= current_buffer
;
21053 struct buffer
*old
= buf
;
21054 struct window
*w
= NULL
;
21055 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21056 struct bidi_it itb
;
21057 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21060 if (!NILP (object
))
21062 if (BUFFERP (object
))
21063 buf
= XBUFFER (object
);
21064 else if (WINDOWP (object
))
21066 w
= decode_live_window (object
);
21067 buf
= XBUFFER (w
->contents
);
21068 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21071 CHECK_STRING (object
);
21074 if (STRINGP (object
))
21076 /* Characters in unibyte strings are always treated by bidi.c as
21078 if (!STRING_MULTIBYTE (object
)
21079 /* When we are loading loadup.el, the character property
21080 tables needed for bidi iteration are not yet
21082 || !NILP (Vpurify_flag
))
21085 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21086 if (from_pos
>= SCHARS (object
))
21089 /* Set up the bidi iterator. */
21090 itb_data
= bidi_shelve_cache ();
21091 itb
.paragraph_dir
= NEUTRAL_DIR
;
21092 itb
.string
.lstring
= object
;
21093 itb
.string
.s
= NULL
;
21094 itb
.string
.schars
= SCHARS (object
);
21095 itb
.string
.bufpos
= 0;
21096 itb
.string
.from_disp_str
= 0;
21097 itb
.string
.unibyte
= 0;
21099 bidi_init_it (0, 0, frame_window_p
, &itb
);
21103 /* Nothing this fancy can happen in unibyte buffers, or in a
21104 buffer that disabled reordering, or if FROM is at EOB. */
21105 if (NILP (BVAR (buf
, bidi_display_reordering
))
21106 || NILP (BVAR (buf
, enable_multibyte_characters
))
21107 /* When we are loading loadup.el, the character property
21108 tables needed for bidi iteration are not yet
21110 || !NILP (Vpurify_flag
))
21113 set_buffer_temp (buf
);
21114 validate_region (&from
, &to
);
21115 from_pos
= XINT (from
);
21116 to_pos
= XINT (to
);
21117 if (from_pos
>= ZV
)
21120 /* Set up the bidi iterator. */
21121 itb_data
= bidi_shelve_cache ();
21122 from_bpos
= CHAR_TO_BYTE (from_pos
);
21123 if (from_pos
== BEGV
)
21125 itb
.charpos
= BEGV
;
21126 itb
.bytepos
= BEGV_BYTE
;
21128 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21130 itb
.charpos
= from_pos
;
21131 itb
.bytepos
= from_bpos
;
21134 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21136 itb
.paragraph_dir
= NEUTRAL_DIR
;
21137 itb
.string
.s
= NULL
;
21138 itb
.string
.lstring
= Qnil
;
21139 itb
.string
.bufpos
= 0;
21140 itb
.string
.from_disp_str
= 0;
21141 itb
.string
.unibyte
= 0;
21143 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21148 /* For the purposes of this function, the actual base direction of
21149 the paragraph doesn't matter, so just set it to L2R. */
21150 bidi_paragraph_init (L2R
, &itb
, 0);
21151 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21153 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21155 bidi_unshelve_cache (itb_data
, 0);
21156 set_buffer_temp (old
);
21158 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21161 DEFUN ("move-point-visually", Fmove_point_visually
,
21162 Smove_point_visually
, 1, 1, 0,
21163 doc
: /* Move point in the visual order in the specified DIRECTION.
21164 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21167 Value is the new character position of point. */)
21168 (Lisp_Object direction
)
21170 struct window
*w
= XWINDOW (selected_window
);
21171 struct buffer
*b
= XBUFFER (w
->contents
);
21172 struct glyph_row
*row
;
21174 Lisp_Object paragraph_dir
;
21176 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21177 (!(ROW)->continued_p \
21178 && NILP ((GLYPH)->object) \
21179 && (GLYPH)->type == CHAR_GLYPH \
21180 && (GLYPH)->u.ch == ' ' \
21181 && (GLYPH)->charpos >= 0 \
21182 && !(GLYPH)->avoid_cursor_p)
21184 CHECK_NUMBER (direction
);
21185 dir
= XINT (direction
);
21191 /* If current matrix is up-to-date, we can use the information
21192 recorded in the glyphs, at least as long as the goal is on the
21194 if (w
->window_end_valid
21195 && !windows_or_buffers_changed
21197 && !b
->clip_changed
21198 && !b
->prevent_redisplay_optimizations_p
21199 && !window_outdated (w
)
21200 /* We rely below on the cursor coordinates to be up to date, but
21201 we cannot trust them if some command moved point since the
21202 last complete redisplay. */
21203 && w
->last_point
== BUF_PT (b
)
21204 && w
->cursor
.vpos
>= 0
21205 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21206 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21208 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21209 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21210 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21212 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21214 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21216 SET_PT (g
->charpos
);
21217 w
->cursor
.vpos
= -1;
21218 return make_number (PT
);
21220 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21224 if (BUFFERP (gpt
->object
))
21227 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21228 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21230 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21232 else if (BUFFERP (g
->object
))
21233 new_pos
= g
->charpos
;
21237 w
->cursor
.vpos
= -1;
21238 return make_number (PT
);
21240 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21242 /* Glyphs inserted at the end of a non-empty line for
21243 positioning the cursor have zero charpos, so we must
21244 deduce the value of point by other means. */
21245 if (g
->charpos
> 0)
21246 SET_PT (g
->charpos
);
21247 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21249 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21250 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21253 w
->cursor
.vpos
= -1;
21254 return make_number (PT
);
21257 if (g
== e
|| NILP (g
->object
))
21259 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21260 goto simulate_display
;
21261 if (!row
->reversed_p
)
21265 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21266 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21267 goto simulate_display
;
21271 if (row
->reversed_p
&& !row
->continued_p
)
21273 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21274 w
->cursor
.vpos
= -1;
21275 return make_number (PT
);
21277 g
= row
->glyphs
[TEXT_AREA
];
21278 e
= g
+ row
->used
[TEXT_AREA
];
21279 for ( ; g
< e
; g
++)
21281 if (BUFFERP (g
->object
)
21282 /* Empty lines have only one glyph, which stands
21283 for the newline, and whose charpos is the
21284 buffer position of the newline. */
21285 || ROW_GLYPH_NEWLINE_P (row
, g
)
21286 /* When the buffer ends in a newline, the line at
21287 EOB also has one glyph, but its charpos is -1. */
21288 || (row
->ends_at_zv_p
21289 && !row
->reversed_p
21290 && NILP (g
->object
)
21291 && g
->type
== CHAR_GLYPH
21292 && g
->u
.ch
== ' '))
21294 if (g
->charpos
> 0)
21295 SET_PT (g
->charpos
);
21296 else if (!row
->reversed_p
21297 && row
->ends_at_zv_p
21302 w
->cursor
.vpos
= -1;
21303 return make_number (PT
);
21309 if (!row
->reversed_p
&& !row
->continued_p
)
21311 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21312 w
->cursor
.vpos
= -1;
21313 return make_number (PT
);
21315 e
= row
->glyphs
[TEXT_AREA
];
21316 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21317 for ( ; g
>= e
; g
--)
21319 if (BUFFERP (g
->object
)
21320 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21322 /* Empty R2L lines on GUI frames have the buffer
21323 position of the newline stored in the stretch
21325 || g
->type
== STRETCH_GLYPH
21326 || (row
->ends_at_zv_p
21328 && NILP (g
->object
)
21329 && g
->type
== CHAR_GLYPH
21330 && g
->u
.ch
== ' '))
21332 if (g
->charpos
> 0)
21333 SET_PT (g
->charpos
);
21334 else if (row
->reversed_p
21335 && row
->ends_at_zv_p
21340 w
->cursor
.vpos
= -1;
21341 return make_number (PT
);
21350 /* If we wind up here, we failed to move by using the glyphs, so we
21351 need to simulate display instead. */
21354 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21356 paragraph_dir
= Qleft_to_right
;
21357 if (EQ (paragraph_dir
, Qright_to_left
))
21359 if (PT
<= BEGV
&& dir
< 0)
21360 xsignal0 (Qbeginning_of_buffer
);
21361 else if (PT
>= ZV
&& dir
> 0)
21362 xsignal0 (Qend_of_buffer
);
21365 struct text_pos pt
;
21367 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21369 bool overshoot_expected
= false;
21370 bool target_is_eol_p
= false;
21372 /* Setup the arena. */
21373 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21374 start_display (&it
, w
, pt
);
21376 if (it
.cmp_it
.id
< 0
21377 && it
.method
== GET_FROM_STRING
21378 && it
.area
== TEXT_AREA
21379 && it
.string_from_display_prop_p
21380 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21381 overshoot_expected
= true;
21383 /* Find the X coordinate of point. We start from the beginning
21384 of this or previous line to make sure we are before point in
21385 the logical order (since the move_it_* functions can only
21388 reseat_at_previous_visible_line_start (&it
);
21389 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21390 if (IT_CHARPOS (it
) != PT
)
21392 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21393 -1, -1, -1, MOVE_TO_POS
);
21394 /* If we missed point because the character there is
21395 displayed out of a display vector that has more than one
21396 glyph, retry expecting overshoot. */
21397 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21398 && it
.current
.dpvec_index
> 0
21399 && !overshoot_expected
)
21401 overshoot_expected
= true;
21404 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21405 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21407 pt_x
= it
.current_x
;
21409 if (dir
> 0 || overshoot_expected
)
21411 struct glyph_row
*row
= it
.glyph_row
;
21413 /* When point is at beginning of line, we don't have
21414 information about the glyph there loaded into struct
21415 it. Calling get_next_display_element fixes that. */
21417 get_next_display_element (&it
);
21418 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21419 it
.glyph_row
= NULL
;
21420 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21421 it
.glyph_row
= row
;
21422 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21423 it, lest it will become out of sync with it's buffer
21425 it
.current_x
= pt_x
;
21428 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21429 pixel_width
= it
.pixel_width
;
21430 if (overshoot_expected
&& at_eol_p
)
21432 else if (pixel_width
<= 0)
21435 /* If there's a display string (or something similar) at point,
21436 we are actually at the glyph to the left of point, so we need
21437 to correct the X coordinate. */
21438 if (overshoot_expected
)
21441 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21443 pt_x
+= pixel_width
;
21446 /* Compute target X coordinate, either to the left or to the
21447 right of point. On TTY frames, all characters have the same
21448 pixel width of 1, so we can use that. On GUI frames we don't
21449 have an easy way of getting at the pixel width of the
21450 character to the left of point, so we use a different method
21451 of getting to that place. */
21453 target_x
= pt_x
+ pixel_width
;
21455 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21457 /* Target X coordinate could be one line above or below the line
21458 of point, in which case we need to adjust the target X
21459 coordinate. Also, if moving to the left, we need to begin at
21460 the left edge of the point's screen line. */
21465 start_display (&it
, w
, pt
);
21466 reseat_at_previous_visible_line_start (&it
);
21467 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21469 move_it_by_lines (&it
, pt_vpos
);
21473 move_it_by_lines (&it
, -1);
21474 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21475 target_is_eol_p
= true;
21476 /* Under word-wrap, we don't know the x coordinate of
21477 the last character displayed on the previous line,
21478 which immediately precedes the wrap point. To find
21479 out its x coordinate, we try moving to the right
21480 margin of the window, which will stop at the wrap
21481 point, and then reset target_x to point at the
21482 character that precedes the wrap point. This is not
21483 needed on GUI frames, because (see below) there we
21484 move from the left margin one grapheme cluster at a
21485 time, and stop when we hit the wrap point. */
21486 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21488 void *it_data
= NULL
;
21491 SAVE_IT (it2
, it
, it_data
);
21492 move_it_in_display_line_to (&it
, ZV
, target_x
,
21493 MOVE_TO_POS
| MOVE_TO_X
);
21494 /* If we arrived at target_x, that _is_ the last
21495 character on the previous line. */
21496 if (it
.current_x
!= target_x
)
21497 target_x
= it
.current_x
- 1;
21498 RESTORE_IT (&it
, &it2
, it_data
);
21505 || (target_x
>= it
.last_visible_x
21506 && it
.line_wrap
!= TRUNCATE
))
21509 move_it_by_lines (&it
, 0);
21510 move_it_by_lines (&it
, 1);
21515 /* Move to the target X coordinate. */
21516 #ifdef HAVE_WINDOW_SYSTEM
21517 /* On GUI frames, as we don't know the X coordinate of the
21518 character to the left of point, moving point to the left
21519 requires walking, one grapheme cluster at a time, until we
21520 find ourself at a place immediately to the left of the
21521 character at point. */
21522 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21524 struct text_pos new_pos
;
21525 enum move_it_result rc
= MOVE_X_REACHED
;
21527 if (it
.current_x
== 0)
21528 get_next_display_element (&it
);
21529 if (it
.what
== IT_COMPOSITION
)
21531 new_pos
.charpos
= it
.cmp_it
.charpos
;
21532 new_pos
.bytepos
= -1;
21535 new_pos
= it
.current
.pos
;
21537 while (it
.current_x
+ it
.pixel_width
<= target_x
21538 && (rc
== MOVE_X_REACHED
21539 /* Under word-wrap, move_it_in_display_line_to
21540 stops at correct coordinates, but sometimes
21541 returns MOVE_POS_MATCH_OR_ZV. */
21542 || (it
.line_wrap
== WORD_WRAP
21543 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21545 int new_x
= it
.current_x
+ it
.pixel_width
;
21547 /* For composed characters, we want the position of the
21548 first character in the grapheme cluster (usually, the
21549 composition's base character), whereas it.current
21550 might give us the position of the _last_ one, e.g. if
21551 the composition is rendered in reverse due to bidi
21553 if (it
.what
== IT_COMPOSITION
)
21555 new_pos
.charpos
= it
.cmp_it
.charpos
;
21556 new_pos
.bytepos
= -1;
21559 new_pos
= it
.current
.pos
;
21560 if (new_x
== it
.current_x
)
21562 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21563 MOVE_TO_POS
| MOVE_TO_X
);
21564 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21567 /* The previous position we saw in the loop is the one we
21569 if (new_pos
.bytepos
== -1)
21570 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21571 it
.current
.pos
= new_pos
;
21575 if (it
.current_x
!= target_x
)
21576 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21578 /* When lines are truncated, the above loop will stop at the
21579 window edge. But we want to get to the end of line, even if
21580 it is beyond the window edge; automatic hscroll will then
21581 scroll the window to show point as appropriate. */
21582 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21583 && get_next_display_element (&it
))
21585 struct text_pos new_pos
= it
.current
.pos
;
21587 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21589 set_iterator_to_next (&it
, 0);
21590 if (it
.method
== GET_FROM_BUFFER
)
21591 new_pos
= it
.current
.pos
;
21592 if (!get_next_display_element (&it
))
21596 it
.current
.pos
= new_pos
;
21599 /* If we ended up in a display string that covers point, move to
21600 buffer position to the right in the visual order. */
21603 while (IT_CHARPOS (it
) == PT
)
21605 set_iterator_to_next (&it
, 0);
21606 if (!get_next_display_element (&it
))
21611 /* Move point to that position. */
21612 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21615 return make_number (PT
);
21617 #undef ROW_GLYPH_NEWLINE_P
21620 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21621 Sbidi_resolved_levels
, 0, 1, 0,
21622 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21624 The resolved levels are produced by the Emacs bidi reordering engine
21625 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21626 read the Unicode Standard Annex 9 (UAX#9) for background information
21627 about these levels.
21629 VPOS is the zero-based number of the current window's screen line
21630 for which to produce the resolved levels. If VPOS is nil or omitted,
21631 it defaults to the screen line of point. If the window displays a
21632 header line, VPOS of zero will report on the header line, and first
21633 line of text in the window will have VPOS of 1.
21635 Value is an array of resolved levels, indexed by glyph number.
21636 Glyphs are numbered from zero starting from the beginning of the
21637 screen line, i.e. the left edge of the window for left-to-right lines
21638 and from the right edge for right-to-left lines. The resolved levels
21639 are produced only for the window's text area; text in display margins
21642 If the selected window's display is not up-to-date, or if the specified
21643 screen line does not display text, this function returns nil. It is
21644 highly recommended to bind this function to some simple key, like F8,
21645 in order to avoid these problems.
21647 This function exists mainly for testing the correctness of the
21648 Emacs UBA implementation, in particular with the test suite. */)
21651 struct window
*w
= XWINDOW (selected_window
);
21652 struct buffer
*b
= XBUFFER (w
->contents
);
21654 struct glyph_row
*row
;
21658 int d1
, d2
, d3
, d4
, d5
;
21660 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21664 CHECK_NUMBER_COERCE_MARKER (vpos
);
21665 nrow
= XINT (vpos
);
21668 /* We require up-to-date glyph matrix for this window. */
21669 if (w
->window_end_valid
21670 && !windows_or_buffers_changed
21672 && !b
->clip_changed
21673 && !b
->prevent_redisplay_optimizations_p
21674 && !window_outdated (w
)
21676 && nrow
< w
->current_matrix
->nrows
21677 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21678 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21680 struct glyph
*g
, *e
, *g1
;
21682 Lisp_Object levels
;
21684 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21686 g
= g1
= row
->glyphs
[TEXT_AREA
];
21687 e
= g
+ row
->used
[TEXT_AREA
];
21689 /* Skip over glyphs at the start of the row that was
21690 generated by redisplay for its own needs. */
21692 && NILP (g
->object
)
21697 /* Count the "interesting" glyphs in this row. */
21698 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21701 /* Create and fill the array. */
21702 levels
= make_uninit_vector (nglyphs
);
21703 for (i
= 0; g1
< g
; i
++, g1
++)
21704 ASET (levels
, i
, make_number (g1
->resolved_level
));
21706 else /* Right-to-left glyph row. */
21708 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21709 e
= row
->glyphs
[TEXT_AREA
] - 1;
21711 && NILP (g
->object
)
21715 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21717 levels
= make_uninit_vector (nglyphs
);
21718 for (i
= 0; g1
> g
; i
++, g1
--)
21719 ASET (levels
, i
, make_number (g1
->resolved_level
));
21729 /***********************************************************************
21731 ***********************************************************************/
21733 /* Redisplay the menu bar in the frame for window W.
21735 The menu bar of X frames that don't have X toolkit support is
21736 displayed in a special window W->frame->menu_bar_window.
21738 The menu bar of terminal frames is treated specially as far as
21739 glyph matrices are concerned. Menu bar lines are not part of
21740 windows, so the update is done directly on the frame matrix rows
21741 for the menu bar. */
21744 display_menu_bar (struct window
*w
)
21746 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21751 /* Don't do all this for graphical frames. */
21753 if (FRAME_W32_P (f
))
21756 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21762 if (FRAME_NS_P (f
))
21764 #endif /* HAVE_NS */
21766 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21767 eassert (!FRAME_WINDOW_P (f
));
21768 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21769 it
.first_visible_x
= 0;
21770 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21771 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21772 if (FRAME_WINDOW_P (f
))
21774 /* Menu bar lines are displayed in the desired matrix of the
21775 dummy window menu_bar_window. */
21776 struct window
*menu_w
;
21777 menu_w
= XWINDOW (f
->menu_bar_window
);
21778 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21780 it
.first_visible_x
= 0;
21781 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21784 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21786 /* This is a TTY frame, i.e. character hpos/vpos are used as
21788 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21790 it
.first_visible_x
= 0;
21791 it
.last_visible_x
= FRAME_COLS (f
);
21794 /* FIXME: This should be controlled by a user option. See the
21795 comments in redisplay_tool_bar and display_mode_line about
21797 it
.paragraph_embedding
= L2R
;
21799 /* Clear all rows of the menu bar. */
21800 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21802 struct glyph_row
*row
= it
.glyph_row
+ i
;
21803 clear_glyph_row (row
);
21804 row
->enabled_p
= true;
21805 row
->full_width_p
= 1;
21806 row
->reversed_p
= false;
21809 /* Display all items of the menu bar. */
21810 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21811 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21813 Lisp_Object string
;
21815 /* Stop at nil string. */
21816 string
= AREF (items
, i
+ 1);
21820 /* Remember where item was displayed. */
21821 ASET (items
, i
+ 3, make_number (it
.hpos
));
21823 /* Display the item, pad with one space. */
21824 if (it
.current_x
< it
.last_visible_x
)
21825 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21826 SCHARS (string
) + 1, 0, 0, -1);
21829 /* Fill out the line with spaces. */
21830 if (it
.current_x
< it
.last_visible_x
)
21831 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21833 /* Compute the total height of the lines. */
21834 compute_line_metrics (&it
);
21837 /* Deep copy of a glyph row, including the glyphs. */
21839 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21841 struct glyph
*pointers
[1 + LAST_AREA
];
21842 int to_used
= to
->used
[TEXT_AREA
];
21844 /* Save glyph pointers of TO. */
21845 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21847 /* Do a structure assignment. */
21850 /* Restore original glyph pointers of TO. */
21851 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21853 /* Copy the glyphs. */
21854 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21855 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21857 /* If we filled only part of the TO row, fill the rest with
21858 space_glyph (which will display as empty space). */
21859 if (to_used
> from
->used
[TEXT_AREA
])
21860 fill_up_frame_row_with_spaces (to
, to_used
);
21863 /* Display one menu item on a TTY, by overwriting the glyphs in the
21864 frame F's desired glyph matrix with glyphs produced from the menu
21865 item text. Called from term.c to display TTY drop-down menus one
21868 ITEM_TEXT is the menu item text as a C string.
21870 FACE_ID is the face ID to be used for this menu item. FACE_ID
21871 could specify one of 3 faces: a face for an enabled item, a face
21872 for a disabled item, or a face for a selected item.
21874 X and Y are coordinates of the first glyph in the frame's desired
21875 matrix to be overwritten by the menu item. Since this is a TTY, Y
21876 is the zero-based number of the glyph row and X is the zero-based
21877 glyph number in the row, starting from left, where to start
21878 displaying the item.
21880 SUBMENU non-zero means this menu item drops down a submenu, which
21881 should be indicated by displaying a proper visual cue after the
21885 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21886 int x
, int y
, int submenu
)
21889 struct frame
*f
= SELECTED_FRAME ();
21890 struct window
*w
= XWINDOW (f
->selected_window
);
21891 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21892 struct glyph_row
*row
;
21893 size_t item_len
= strlen (item_text
);
21895 eassert (FRAME_TERMCAP_P (f
));
21897 /* Don't write beyond the matrix's last row. This can happen for
21898 TTY screens that are not high enough to show the entire menu.
21899 (This is actually a bit of defensive programming, as
21900 tty_menu_display already limits the number of menu items to one
21901 less than the number of screen lines.) */
21902 if (y
>= f
->desired_matrix
->nrows
)
21905 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21906 it
.first_visible_x
= 0;
21907 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21908 row
= it
.glyph_row
;
21909 /* Start with the row contents from the current matrix. */
21910 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21911 saved_width
= row
->full_width_p
;
21912 row
->full_width_p
= 1;
21913 saved_reversed
= row
->reversed_p
;
21914 row
->reversed_p
= 0;
21915 row
->enabled_p
= true;
21917 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21919 eassert (x
< f
->desired_matrix
->matrix_w
);
21920 it
.current_x
= it
.hpos
= x
;
21921 it
.current_y
= it
.vpos
= y
;
21922 saved_used
= row
->used
[TEXT_AREA
];
21923 saved_truncated
= row
->truncated_on_right_p
;
21924 row
->used
[TEXT_AREA
] = x
;
21925 it
.face_id
= face_id
;
21926 it
.line_wrap
= TRUNCATE
;
21928 /* FIXME: This should be controlled by a user option. See the
21929 comments in redisplay_tool_bar and display_mode_line about this.
21930 Also, if paragraph_embedding could ever be R2L, changes will be
21931 needed to avoid shifting to the right the row characters in
21932 term.c:append_glyph. */
21933 it
.paragraph_embedding
= L2R
;
21935 /* Pad with a space on the left. */
21936 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21938 /* Display the menu item, pad with spaces to WIDTH. */
21941 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21942 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21944 /* Indicate with " >" that there's a submenu. */
21945 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21946 FRAME_COLS (f
) - 1, -1);
21949 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21950 width
, 0, FRAME_COLS (f
) - 1, -1);
21952 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21953 row
->truncated_on_right_p
= saved_truncated
;
21954 row
->hash
= row_hash (row
);
21955 row
->full_width_p
= saved_width
;
21956 row
->reversed_p
= saved_reversed
;
21959 /***********************************************************************
21961 ***********************************************************************/
21963 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21964 FORCE is non-zero, redisplay mode lines unconditionally.
21965 Otherwise, redisplay only mode lines that are garbaged. Value is
21966 the number of windows whose mode lines were redisplayed. */
21969 redisplay_mode_lines (Lisp_Object window
, bool force
)
21973 while (!NILP (window
))
21975 struct window
*w
= XWINDOW (window
);
21977 if (WINDOWP (w
->contents
))
21978 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21980 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21981 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21983 struct text_pos lpoint
;
21984 struct buffer
*old
= current_buffer
;
21986 /* Set the window's buffer for the mode line display. */
21987 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21988 set_buffer_internal_1 (XBUFFER (w
->contents
));
21990 /* Point refers normally to the selected window. For any
21991 other window, set up appropriate value. */
21992 if (!EQ (window
, selected_window
))
21994 struct text_pos pt
;
21996 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21997 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22000 /* Display mode lines. */
22001 clear_glyph_matrix (w
->desired_matrix
);
22002 if (display_mode_lines (w
))
22005 /* Restore old settings. */
22006 set_buffer_internal_1 (old
);
22007 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22017 /* Display the mode and/or header line of window W. Value is the
22018 sum number of mode lines and header lines displayed. */
22021 display_mode_lines (struct window
*w
)
22023 Lisp_Object old_selected_window
= selected_window
;
22024 Lisp_Object old_selected_frame
= selected_frame
;
22025 Lisp_Object new_frame
= w
->frame
;
22026 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22029 selected_frame
= new_frame
;
22030 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22031 or window's point, then we'd need select_window_1 here as well. */
22032 XSETWINDOW (selected_window
, w
);
22033 XFRAME (new_frame
)->selected_window
= selected_window
;
22035 /* These will be set while the mode line specs are processed. */
22036 line_number_displayed
= 0;
22037 w
->column_number_displayed
= -1;
22039 if (WINDOW_WANTS_MODELINE_P (w
))
22041 struct window
*sel_w
= XWINDOW (old_selected_window
);
22043 /* Select mode line face based on the real selected window. */
22044 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22045 BVAR (current_buffer
, mode_line_format
));
22049 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22051 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22052 BVAR (current_buffer
, header_line_format
));
22056 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22057 selected_frame
= old_selected_frame
;
22058 selected_window
= old_selected_window
;
22060 w
->must_be_updated_p
= true;
22065 /* Display mode or header line of window W. FACE_ID specifies which
22066 line to display; it is either MODE_LINE_FACE_ID or
22067 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22068 display. Value is the pixel height of the mode/header line
22072 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22076 ptrdiff_t count
= SPECPDL_INDEX ();
22078 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22079 /* Don't extend on a previously drawn mode-line.
22080 This may happen if called from pos_visible_p. */
22081 it
.glyph_row
->enabled_p
= false;
22082 prepare_desired_row (w
, it
.glyph_row
, true);
22084 it
.glyph_row
->mode_line_p
= 1;
22086 /* FIXME: This should be controlled by a user option. But
22087 supporting such an option is not trivial, since the mode line is
22088 made up of many separate strings. */
22089 it
.paragraph_embedding
= L2R
;
22091 record_unwind_protect (unwind_format_mode_line
,
22092 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
22094 mode_line_target
= MODE_LINE_DISPLAY
;
22096 /* Temporarily make frame's keyboard the current kboard so that
22097 kboard-local variables in the mode_line_format will get the right
22099 push_kboard (FRAME_KBOARD (it
.f
));
22100 record_unwind_save_match_data ();
22101 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22104 unbind_to (count
, Qnil
);
22106 /* Fill up with spaces. */
22107 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22109 compute_line_metrics (&it
);
22110 it
.glyph_row
->full_width_p
= 1;
22111 it
.glyph_row
->continued_p
= 0;
22112 it
.glyph_row
->truncated_on_left_p
= 0;
22113 it
.glyph_row
->truncated_on_right_p
= 0;
22115 /* Make a 3D mode-line have a shadow at its right end. */
22116 face
= FACE_FROM_ID (it
.f
, face_id
);
22117 extend_face_to_end_of_line (&it
);
22118 if (face
->box
!= FACE_NO_BOX
)
22120 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22121 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22122 last
->right_box_line_p
= 1;
22125 return it
.glyph_row
->height
;
22128 /* Move element ELT in LIST to the front of LIST.
22129 Return the updated list. */
22132 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22134 register Lisp_Object tail
, prev
;
22135 register Lisp_Object tem
;
22139 while (CONSP (tail
))
22145 /* Splice out the link TAIL. */
22147 list
= XCDR (tail
);
22149 Fsetcdr (prev
, XCDR (tail
));
22151 /* Now make it the first. */
22152 Fsetcdr (tail
, list
);
22157 tail
= XCDR (tail
);
22161 /* Not found--return unchanged LIST. */
22165 /* Contribute ELT to the mode line for window IT->w. How it
22166 translates into text depends on its data type.
22168 IT describes the display environment in which we display, as usual.
22170 DEPTH is the depth in recursion. It is used to prevent
22171 infinite recursion here.
22173 FIELD_WIDTH is the number of characters the display of ELT should
22174 occupy in the mode line, and PRECISION is the maximum number of
22175 characters to display from ELT's representation. See
22176 display_string for details.
22178 Returns the hpos of the end of the text generated by ELT.
22180 PROPS is a property list to add to any string we encounter.
22182 If RISKY is nonzero, remove (disregard) any properties in any string
22183 we encounter, and ignore :eval and :propertize.
22185 The global variable `mode_line_target' determines whether the
22186 output is passed to `store_mode_line_noprop',
22187 `store_mode_line_string', or `display_string'. */
22190 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22191 Lisp_Object elt
, Lisp_Object props
, int risky
)
22193 int n
= 0, field
, prec
;
22198 elt
= build_string ("*too-deep*");
22202 switch (XTYPE (elt
))
22206 /* A string: output it and check for %-constructs within it. */
22208 ptrdiff_t offset
= 0;
22210 if (SCHARS (elt
) > 0
22211 && (!NILP (props
) || risky
))
22213 Lisp_Object oprops
, aelt
;
22214 oprops
= Ftext_properties_at (make_number (0), elt
);
22216 /* If the starting string's properties are not what
22217 we want, translate the string. Also, if the string
22218 is risky, do that anyway. */
22220 if (NILP (Fequal (props
, oprops
)) || risky
)
22222 /* If the starting string has properties,
22223 merge the specified ones onto the existing ones. */
22224 if (! NILP (oprops
) && !risky
)
22228 oprops
= Fcopy_sequence (oprops
);
22230 while (CONSP (tem
))
22232 oprops
= Fplist_put (oprops
, XCAR (tem
),
22233 XCAR (XCDR (tem
)));
22234 tem
= XCDR (XCDR (tem
));
22239 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22240 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22242 /* AELT is what we want. Move it to the front
22243 without consing. */
22245 mode_line_proptrans_alist
22246 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22252 /* If AELT has the wrong props, it is useless.
22253 so get rid of it. */
22255 mode_line_proptrans_alist
22256 = Fdelq (aelt
, mode_line_proptrans_alist
);
22258 elt
= Fcopy_sequence (elt
);
22259 Fset_text_properties (make_number (0), Flength (elt
),
22261 /* Add this item to mode_line_proptrans_alist. */
22262 mode_line_proptrans_alist
22263 = Fcons (Fcons (elt
, props
),
22264 mode_line_proptrans_alist
);
22265 /* Truncate mode_line_proptrans_alist
22266 to at most 50 elements. */
22267 tem
= Fnthcdr (make_number (50),
22268 mode_line_proptrans_alist
);
22270 XSETCDR (tem
, Qnil
);
22279 prec
= precision
- n
;
22280 switch (mode_line_target
)
22282 case MODE_LINE_NOPROP
:
22283 case MODE_LINE_TITLE
:
22284 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22286 case MODE_LINE_STRING
:
22287 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
22289 case MODE_LINE_DISPLAY
:
22290 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22291 0, prec
, 0, STRING_MULTIBYTE (elt
));
22298 /* Handle the non-literal case. */
22300 while ((precision
<= 0 || n
< precision
)
22301 && SREF (elt
, offset
) != 0
22302 && (mode_line_target
!= MODE_LINE_DISPLAY
22303 || it
->current_x
< it
->last_visible_x
))
22305 ptrdiff_t last_offset
= offset
;
22307 /* Advance to end of string or next format specifier. */
22308 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22311 if (offset
- 1 != last_offset
)
22313 ptrdiff_t nchars
, nbytes
;
22315 /* Output to end of string or up to '%'. Field width
22316 is length of string. Don't output more than
22317 PRECISION allows us. */
22320 prec
= c_string_width (SDATA (elt
) + last_offset
,
22321 offset
- last_offset
, precision
- n
,
22324 switch (mode_line_target
)
22326 case MODE_LINE_NOPROP
:
22327 case MODE_LINE_TITLE
:
22328 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22330 case MODE_LINE_STRING
:
22332 ptrdiff_t bytepos
= last_offset
;
22333 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22334 ptrdiff_t endpos
= (precision
<= 0
22335 ? string_byte_to_char (elt
, offset
)
22336 : charpos
+ nchars
);
22338 n
+= store_mode_line_string (NULL
,
22339 Fsubstring (elt
, make_number (charpos
),
22340 make_number (endpos
)),
22344 case MODE_LINE_DISPLAY
:
22346 ptrdiff_t bytepos
= last_offset
;
22347 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22349 if (precision
<= 0)
22350 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22351 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22353 STRING_MULTIBYTE (elt
));
22358 else /* c == '%' */
22360 ptrdiff_t percent_position
= offset
;
22362 /* Get the specified minimum width. Zero means
22365 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22366 field
= field
* 10 + c
- '0';
22368 /* Don't pad beyond the total padding allowed. */
22369 if (field_width
- n
> 0 && field
> field_width
- n
)
22370 field
= field_width
- n
;
22372 /* Note that either PRECISION <= 0 or N < PRECISION. */
22373 prec
= precision
- n
;
22376 n
+= display_mode_element (it
, depth
, field
, prec
,
22377 Vglobal_mode_string
, props
,
22382 ptrdiff_t bytepos
, charpos
;
22384 Lisp_Object string
;
22386 bytepos
= percent_position
;
22387 charpos
= (STRING_MULTIBYTE (elt
)
22388 ? string_byte_to_char (elt
, bytepos
)
22390 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22391 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22393 switch (mode_line_target
)
22395 case MODE_LINE_NOPROP
:
22396 case MODE_LINE_TITLE
:
22397 n
+= store_mode_line_noprop (spec
, field
, prec
);
22399 case MODE_LINE_STRING
:
22401 Lisp_Object tem
= build_string (spec
);
22402 props
= Ftext_properties_at (make_number (charpos
), elt
);
22403 /* Should only keep face property in props */
22404 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22407 case MODE_LINE_DISPLAY
:
22409 int nglyphs_before
, nwritten
;
22411 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22412 nwritten
= display_string (spec
, string
, elt
,
22417 /* Assign to the glyphs written above the
22418 string where the `%x' came from, position
22422 struct glyph
*glyph
22423 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22427 for (i
= 0; i
< nwritten
; ++i
)
22429 glyph
[i
].object
= elt
;
22430 glyph
[i
].charpos
= charpos
;
22447 /* A symbol: process the value of the symbol recursively
22448 as if it appeared here directly. Avoid error if symbol void.
22449 Special case: if value of symbol is a string, output the string
22452 register Lisp_Object tem
;
22454 /* If the variable is not marked as risky to set
22455 then its contents are risky to use. */
22456 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22459 tem
= Fboundp (elt
);
22462 tem
= Fsymbol_value (elt
);
22463 /* If value is a string, output that string literally:
22464 don't check for % within it. */
22468 if (!EQ (tem
, elt
))
22470 /* Give up right away for nil or t. */
22480 register Lisp_Object car
, tem
;
22482 /* A cons cell: five distinct cases.
22483 If first element is :eval or :propertize, do something special.
22484 If first element is a string or a cons, process all the elements
22485 and effectively concatenate them.
22486 If first element is a negative number, truncate displaying cdr to
22487 at most that many characters. If positive, pad (with spaces)
22488 to at least that many characters.
22489 If first element is a symbol, process the cadr or caddr recursively
22490 according to whether the symbol's value is non-nil or nil. */
22492 if (EQ (car
, QCeval
))
22494 /* An element of the form (:eval FORM) means evaluate FORM
22495 and use the result as mode line elements. */
22500 if (CONSP (XCDR (elt
)))
22503 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22504 n
+= display_mode_element (it
, depth
, field_width
- n
,
22505 precision
- n
, spec
, props
,
22509 else if (EQ (car
, QCpropertize
))
22511 /* An element of the form (:propertize ELT PROPS...)
22512 means display ELT but applying properties PROPS. */
22517 if (CONSP (XCDR (elt
)))
22518 n
+= display_mode_element (it
, depth
, field_width
- n
,
22519 precision
- n
, XCAR (XCDR (elt
)),
22520 XCDR (XCDR (elt
)), risky
);
22522 else if (SYMBOLP (car
))
22524 tem
= Fboundp (car
);
22528 /* elt is now the cdr, and we know it is a cons cell.
22529 Use its car if CAR has a non-nil value. */
22532 tem
= Fsymbol_value (car
);
22539 /* Symbol's value is nil (or symbol is unbound)
22540 Get the cddr of the original list
22541 and if possible find the caddr and use that. */
22545 else if (!CONSP (elt
))
22550 else if (INTEGERP (car
))
22552 register int lim
= XINT (car
);
22556 /* Negative int means reduce maximum width. */
22557 if (precision
<= 0)
22560 precision
= min (precision
, -lim
);
22564 /* Padding specified. Don't let it be more than
22565 current maximum. */
22567 lim
= min (precision
, lim
);
22569 /* If that's more padding than already wanted, queue it.
22570 But don't reduce padding already specified even if
22571 that is beyond the current truncation point. */
22572 field_width
= max (lim
, field_width
);
22576 else if (STRINGP (car
) || CONSP (car
))
22578 Lisp_Object halftail
= elt
;
22582 && (precision
<= 0 || n
< precision
))
22584 n
+= display_mode_element (it
, depth
,
22585 /* Do padding only after the last
22586 element in the list. */
22587 (! CONSP (XCDR (elt
))
22590 precision
- n
, XCAR (elt
),
22594 if ((len
& 1) == 0)
22595 halftail
= XCDR (halftail
);
22596 /* Check for cycle. */
22597 if (EQ (halftail
, elt
))
22606 elt
= build_string ("*invalid*");
22610 /* Pad to FIELD_WIDTH. */
22611 if (field_width
> 0 && n
< field_width
)
22613 switch (mode_line_target
)
22615 case MODE_LINE_NOPROP
:
22616 case MODE_LINE_TITLE
:
22617 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22619 case MODE_LINE_STRING
:
22620 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22622 case MODE_LINE_DISPLAY
:
22623 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22632 /* Store a mode-line string element in mode_line_string_list.
22634 If STRING is non-null, display that C string. Otherwise, the Lisp
22635 string LISP_STRING is displayed.
22637 FIELD_WIDTH is the minimum number of output glyphs to produce.
22638 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22639 with spaces. FIELD_WIDTH <= 0 means don't pad.
22641 PRECISION is the maximum number of characters to output from
22642 STRING. PRECISION <= 0 means don't truncate the string.
22644 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22645 properties to the string.
22647 PROPS are the properties to add to the string.
22648 The mode_line_string_face face property is always added to the string.
22652 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22653 int field_width
, int precision
, Lisp_Object props
)
22658 if (string
!= NULL
)
22660 len
= strlen (string
);
22661 if (precision
> 0 && len
> precision
)
22663 lisp_string
= make_string (string
, len
);
22665 props
= mode_line_string_face_prop
;
22666 else if (!NILP (mode_line_string_face
))
22668 Lisp_Object face
= Fplist_get (props
, Qface
);
22669 props
= Fcopy_sequence (props
);
22671 face
= mode_line_string_face
;
22673 face
= list2 (face
, mode_line_string_face
);
22674 props
= Fplist_put (props
, Qface
, face
);
22676 Fadd_text_properties (make_number (0), make_number (len
),
22677 props
, lisp_string
);
22681 len
= XFASTINT (Flength (lisp_string
));
22682 if (precision
> 0 && len
> precision
)
22685 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22688 if (!NILP (mode_line_string_face
))
22692 props
= Ftext_properties_at (make_number (0), lisp_string
);
22693 face
= Fplist_get (props
, Qface
);
22695 face
= mode_line_string_face
;
22697 face
= list2 (face
, mode_line_string_face
);
22698 props
= list2 (Qface
, face
);
22700 lisp_string
= Fcopy_sequence (lisp_string
);
22703 Fadd_text_properties (make_number (0), make_number (len
),
22704 props
, lisp_string
);
22709 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22713 if (field_width
> len
)
22715 field_width
-= len
;
22716 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22718 Fadd_text_properties (make_number (0), make_number (field_width
),
22719 props
, lisp_string
);
22720 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22728 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22730 doc
: /* Format a string out of a mode line format specification.
22731 First arg FORMAT specifies the mode line format (see `mode-line-format'
22732 for details) to use.
22734 By default, the format is evaluated for the currently selected window.
22736 Optional second arg FACE specifies the face property to put on all
22737 characters for which no face is specified. The value nil means the
22738 default face. The value t means whatever face the window's mode line
22739 currently uses (either `mode-line' or `mode-line-inactive',
22740 depending on whether the window is the selected window or not).
22741 An integer value means the value string has no text
22744 Optional third and fourth args WINDOW and BUFFER specify the window
22745 and buffer to use as the context for the formatting (defaults
22746 are the selected window and the WINDOW's buffer). */)
22747 (Lisp_Object format
, Lisp_Object face
,
22748 Lisp_Object window
, Lisp_Object buffer
)
22753 struct buffer
*old_buffer
= NULL
;
22755 int no_props
= INTEGERP (face
);
22756 ptrdiff_t count
= SPECPDL_INDEX ();
22758 int string_start
= 0;
22760 w
= decode_any_window (window
);
22761 XSETWINDOW (window
, w
);
22764 buffer
= w
->contents
;
22765 CHECK_BUFFER (buffer
);
22767 /* Make formatting the modeline a non-op when noninteractive, otherwise
22768 there will be problems later caused by a partially initialized frame. */
22769 if (NILP (format
) || noninteractive
)
22770 return empty_unibyte_string
;
22775 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22776 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22777 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22778 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22779 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22780 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22781 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22784 old_buffer
= current_buffer
;
22786 /* Save things including mode_line_proptrans_alist,
22787 and set that to nil so that we don't alter the outer value. */
22788 record_unwind_protect (unwind_format_mode_line
,
22789 format_mode_line_unwind_data
22790 (XFRAME (WINDOW_FRAME (w
)),
22791 old_buffer
, selected_window
, 1));
22792 mode_line_proptrans_alist
= Qnil
;
22794 Fselect_window (window
, Qt
);
22795 set_buffer_internal_1 (XBUFFER (buffer
));
22797 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22801 mode_line_target
= MODE_LINE_NOPROP
;
22802 mode_line_string_face_prop
= Qnil
;
22803 mode_line_string_list
= Qnil
;
22804 string_start
= MODE_LINE_NOPROP_LEN (0);
22808 mode_line_target
= MODE_LINE_STRING
;
22809 mode_line_string_list
= Qnil
;
22810 mode_line_string_face
= face
;
22811 mode_line_string_face_prop
22812 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22815 push_kboard (FRAME_KBOARD (it
.f
));
22816 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22821 len
= MODE_LINE_NOPROP_LEN (string_start
);
22822 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22826 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22827 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22828 empty_unibyte_string
);
22831 unbind_to (count
, Qnil
);
22835 /* Write a null-terminated, right justified decimal representation of
22836 the positive integer D to BUF using a minimal field width WIDTH. */
22839 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22841 register char *p
= buf
;
22849 *p
++ = d
% 10 + '0';
22854 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22865 /* Write a null-terminated, right justified decimal and "human
22866 readable" representation of the nonnegative integer D to BUF using
22867 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22869 static const char power_letter
[] =
22883 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22885 /* We aim to represent the nonnegative integer D as
22886 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22887 ptrdiff_t quotient
= d
;
22889 /* -1 means: do not use TENTHS. */
22893 /* Length of QUOTIENT.TENTHS as a string. */
22899 if (quotient
>= 1000)
22901 /* Scale to the appropriate EXPONENT. */
22904 remainder
= quotient
% 1000;
22908 while (quotient
>= 1000);
22910 /* Round to nearest and decide whether to use TENTHS or not. */
22913 tenths
= remainder
/ 100;
22914 if (remainder
% 100 >= 50)
22921 if (quotient
== 10)
22929 if (remainder
>= 500)
22931 if (quotient
< 999)
22942 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22943 if (tenths
== -1 && quotient
<= 99)
22950 p
= psuffix
= buf
+ max (width
, length
);
22952 /* Print EXPONENT. */
22953 *psuffix
++ = power_letter
[exponent
];
22956 /* Print TENTHS. */
22959 *--p
= '0' + tenths
;
22963 /* Print QUOTIENT. */
22966 int digit
= quotient
% 10;
22967 *--p
= '0' + digit
;
22969 while ((quotient
/= 10) != 0);
22971 /* Print leading spaces. */
22976 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22977 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22978 type of CODING_SYSTEM. Return updated pointer into BUF. */
22980 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22983 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22986 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22987 const unsigned char *eol_str
;
22989 /* The EOL conversion we are using. */
22990 Lisp_Object eoltype
;
22992 val
= CODING_SYSTEM_SPEC (coding_system
);
22995 if (!VECTORP (val
)) /* Not yet decided. */
22997 *buf
++ = multibyte
? '-' : ' ';
22999 eoltype
= eol_mnemonic_undecided
;
23000 /* Don't mention EOL conversion if it isn't decided. */
23005 Lisp_Object eolvalue
;
23007 attrs
= AREF (val
, 0);
23008 eolvalue
= AREF (val
, 2);
23011 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23016 /* The EOL conversion that is normal on this system. */
23018 if (NILP (eolvalue
)) /* Not yet decided. */
23019 eoltype
= eol_mnemonic_undecided
;
23020 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23021 eoltype
= eol_mnemonic_undecided
;
23022 else /* eolvalue is Qunix, Qdos, or Qmac. */
23023 eoltype
= (EQ (eolvalue
, Qunix
)
23024 ? eol_mnemonic_unix
23025 : (EQ (eolvalue
, Qdos
) == 1
23026 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
23032 /* Mention the EOL conversion if it is not the usual one. */
23033 if (STRINGP (eoltype
))
23035 eol_str
= SDATA (eoltype
);
23036 eol_str_len
= SBYTES (eoltype
);
23038 else if (CHARACTERP (eoltype
))
23040 int c
= XFASTINT (eoltype
);
23041 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23045 eol_str
= invalid_eol_type
;
23046 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23048 memcpy (buf
, eol_str
, eol_str_len
);
23049 buf
+= eol_str_len
;
23055 /* Return a string for the output of a mode line %-spec for window W,
23056 generated by character C. FIELD_WIDTH > 0 means pad the string
23057 returned with spaces to that value. Return a Lisp string in
23058 *STRING if the resulting string is taken from that Lisp string.
23060 Note we operate on the current buffer for most purposes. */
23062 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23064 static const char *
23065 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23066 Lisp_Object
*string
)
23069 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23070 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23071 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23072 produce strings from numerical values, so limit preposterously
23073 large values of FIELD_WIDTH to avoid overrunning the buffer's
23074 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23075 bytes plus the terminating null. */
23076 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23077 struct buffer
*b
= current_buffer
;
23085 if (!NILP (BVAR (b
, read_only
)))
23087 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23092 /* This differs from %* only for a modified read-only buffer. */
23093 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23095 if (!NILP (BVAR (b
, read_only
)))
23100 /* This differs from %* in ignoring read-only-ness. */
23101 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23113 if (command_loop_level
> 5)
23115 p
= decode_mode_spec_buf
;
23116 for (i
= 0; i
< command_loop_level
; i
++)
23119 return decode_mode_spec_buf
;
23127 if (command_loop_level
> 5)
23129 p
= decode_mode_spec_buf
;
23130 for (i
= 0; i
< command_loop_level
; i
++)
23133 return decode_mode_spec_buf
;
23140 /* Let lots_of_dashes be a string of infinite length. */
23141 if (mode_line_target
== MODE_LINE_NOPROP
23142 || mode_line_target
== MODE_LINE_STRING
)
23144 if (field_width
<= 0
23145 || field_width
> sizeof (lots_of_dashes
))
23147 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23148 decode_mode_spec_buf
[i
] = '-';
23149 decode_mode_spec_buf
[i
] = '\0';
23150 return decode_mode_spec_buf
;
23153 return lots_of_dashes
;
23157 obj
= BVAR (b
, name
);
23161 /* %c and %l are ignored in `frame-title-format'.
23162 (In redisplay_internal, the frame title is drawn _before_ the
23163 windows are updated, so the stuff which depends on actual
23164 window contents (such as %l) may fail to render properly, or
23165 even crash emacs.) */
23166 if (mode_line_target
== MODE_LINE_TITLE
)
23170 ptrdiff_t col
= current_column ();
23171 w
->column_number_displayed
= col
;
23172 pint2str (decode_mode_spec_buf
, width
, col
);
23173 return decode_mode_spec_buf
;
23177 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23179 if (NILP (Vmemory_full
))
23182 return "!MEM FULL! ";
23189 /* %F displays the frame name. */
23190 if (!NILP (f
->title
))
23191 return SSDATA (f
->title
);
23192 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23193 return SSDATA (f
->name
);
23197 obj
= BVAR (b
, filename
);
23202 ptrdiff_t size
= ZV
- BEGV
;
23203 pint2str (decode_mode_spec_buf
, width
, size
);
23204 return decode_mode_spec_buf
;
23209 ptrdiff_t size
= ZV
- BEGV
;
23210 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23211 return decode_mode_spec_buf
;
23216 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23217 ptrdiff_t topline
, nlines
, height
;
23220 /* %c and %l are ignored in `frame-title-format'. */
23221 if (mode_line_target
== MODE_LINE_TITLE
)
23224 startpos
= marker_position (w
->start
);
23225 startpos_byte
= marker_byte_position (w
->start
);
23226 height
= WINDOW_TOTAL_LINES (w
);
23228 /* If we decided that this buffer isn't suitable for line numbers,
23229 don't forget that too fast. */
23230 if (w
->base_line_pos
== -1)
23233 /* If the buffer is very big, don't waste time. */
23234 if (INTEGERP (Vline_number_display_limit
)
23235 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23237 w
->base_line_pos
= 0;
23238 w
->base_line_number
= 0;
23242 if (w
->base_line_number
> 0
23243 && w
->base_line_pos
> 0
23244 && w
->base_line_pos
<= startpos
)
23246 line
= w
->base_line_number
;
23247 linepos
= w
->base_line_pos
;
23248 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23253 linepos
= BUF_BEGV (b
);
23254 linepos_byte
= BUF_BEGV_BYTE (b
);
23257 /* Count lines from base line to window start position. */
23258 nlines
= display_count_lines (linepos_byte
,
23262 topline
= nlines
+ line
;
23264 /* Determine a new base line, if the old one is too close
23265 or too far away, or if we did not have one.
23266 "Too close" means it's plausible a scroll-down would
23267 go back past it. */
23268 if (startpos
== BUF_BEGV (b
))
23270 w
->base_line_number
= topline
;
23271 w
->base_line_pos
= BUF_BEGV (b
);
23273 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23274 || linepos
== BUF_BEGV (b
))
23276 ptrdiff_t limit
= BUF_BEGV (b
);
23277 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23278 ptrdiff_t position
;
23279 ptrdiff_t distance
=
23280 (height
* 2 + 30) * line_number_display_limit_width
;
23282 if (startpos
- distance
> limit
)
23284 limit
= startpos
- distance
;
23285 limit_byte
= CHAR_TO_BYTE (limit
);
23288 nlines
= display_count_lines (startpos_byte
,
23290 - (height
* 2 + 30),
23292 /* If we couldn't find the lines we wanted within
23293 line_number_display_limit_width chars per line,
23294 give up on line numbers for this window. */
23295 if (position
== limit_byte
&& limit
== startpos
- distance
)
23297 w
->base_line_pos
= -1;
23298 w
->base_line_number
= 0;
23302 w
->base_line_number
= topline
- nlines
;
23303 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23306 /* Now count lines from the start pos to point. */
23307 nlines
= display_count_lines (startpos_byte
,
23308 PT_BYTE
, PT
, &junk
);
23310 /* Record that we did display the line number. */
23311 line_number_displayed
= 1;
23313 /* Make the string to show. */
23314 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23315 return decode_mode_spec_buf
;
23318 char *p
= decode_mode_spec_buf
;
23319 int pad
= width
- 2;
23325 return decode_mode_spec_buf
;
23331 obj
= BVAR (b
, mode_name
);
23335 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23341 ptrdiff_t pos
= marker_position (w
->start
);
23342 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23344 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23346 if (pos
<= BUF_BEGV (b
))
23351 else if (pos
<= BUF_BEGV (b
))
23355 if (total
> 1000000)
23356 /* Do it differently for a large value, to avoid overflow. */
23357 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23359 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23360 /* We can't normally display a 3-digit number,
23361 so get us a 2-digit number that is close. */
23364 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23365 return decode_mode_spec_buf
;
23369 /* Display percentage of size above the bottom of the screen. */
23372 ptrdiff_t toppos
= marker_position (w
->start
);
23373 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23374 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23376 if (botpos
>= BUF_ZV (b
))
23378 if (toppos
<= BUF_BEGV (b
))
23385 if (total
> 1000000)
23386 /* Do it differently for a large value, to avoid overflow. */
23387 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23389 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23390 /* We can't normally display a 3-digit number,
23391 so get us a 2-digit number that is close. */
23394 if (toppos
<= BUF_BEGV (b
))
23395 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23397 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23398 return decode_mode_spec_buf
;
23403 /* status of process */
23404 obj
= Fget_buffer_process (Fcurrent_buffer ());
23406 return "no process";
23408 obj
= Fsymbol_name (Fprocess_status (obj
));
23414 ptrdiff_t count
= inhibit_garbage_collection ();
23415 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23416 Lisp_Object val
= Qnil
;
23418 if (STRINGP (curdir
))
23419 val
= call1 (intern ("file-remote-p"), curdir
);
23421 unbind_to (count
, Qnil
);
23430 /* coding-system (not including end-of-line format) */
23432 /* coding-system (including end-of-line type) */
23434 int eol_flag
= (c
== 'Z');
23435 char *p
= decode_mode_spec_buf
;
23437 if (! FRAME_WINDOW_P (f
))
23439 /* No need to mention EOL here--the terminal never needs
23440 to do EOL conversion. */
23441 p
= decode_mode_spec_coding (CODING_ID_NAME
23442 (FRAME_KEYBOARD_CODING (f
)->id
),
23444 p
= decode_mode_spec_coding (CODING_ID_NAME
23445 (FRAME_TERMINAL_CODING (f
)->id
),
23448 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23451 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23452 #ifdef subprocesses
23453 obj
= Fget_buffer_process (Fcurrent_buffer ());
23454 if (PROCESSP (obj
))
23456 p
= decode_mode_spec_coding
23457 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23458 p
= decode_mode_spec_coding
23459 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23461 #endif /* subprocesses */
23464 return decode_mode_spec_buf
;
23471 return SSDATA (obj
);
23478 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23479 means count lines back from START_BYTE. But don't go beyond
23480 LIMIT_BYTE. Return the number of lines thus found (always
23483 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23484 either the position COUNT lines after/before START_BYTE, if we
23485 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23489 display_count_lines (ptrdiff_t start_byte
,
23490 ptrdiff_t limit_byte
, ptrdiff_t count
,
23491 ptrdiff_t *byte_pos_ptr
)
23493 register unsigned char *cursor
;
23494 unsigned char *base
;
23496 register ptrdiff_t ceiling
;
23497 register unsigned char *ceiling_addr
;
23498 ptrdiff_t orig_count
= count
;
23500 /* If we are not in selective display mode,
23501 check only for newlines. */
23502 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23503 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23507 while (start_byte
< limit_byte
)
23509 ceiling
= BUFFER_CEILING_OF (start_byte
);
23510 ceiling
= min (limit_byte
- 1, ceiling
);
23511 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23512 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23516 if (selective_display
)
23518 while (*cursor
!= '\n' && *cursor
!= 015
23519 && ++cursor
!= ceiling_addr
)
23521 if (cursor
== ceiling_addr
)
23526 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23535 start_byte
+= cursor
- base
;
23536 *byte_pos_ptr
= start_byte
;
23540 while (cursor
< ceiling_addr
);
23542 start_byte
+= ceiling_addr
- base
;
23547 while (start_byte
> limit_byte
)
23549 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23550 ceiling
= max (limit_byte
, ceiling
);
23551 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23552 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23555 if (selective_display
)
23557 while (--cursor
>= ceiling_addr
23558 && *cursor
!= '\n' && *cursor
!= 015)
23560 if (cursor
< ceiling_addr
)
23565 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23572 start_byte
+= cursor
- base
+ 1;
23573 *byte_pos_ptr
= start_byte
;
23574 /* When scanning backwards, we should
23575 not count the newline posterior to which we stop. */
23576 return - orig_count
- 1;
23579 start_byte
+= ceiling_addr
- base
;
23583 *byte_pos_ptr
= limit_byte
;
23586 return - orig_count
+ count
;
23587 return orig_count
- count
;
23593 /***********************************************************************
23595 ***********************************************************************/
23597 /* Display a NUL-terminated string, starting with index START.
23599 If STRING is non-null, display that C string. Otherwise, the Lisp
23600 string LISP_STRING is displayed. There's a case that STRING is
23601 non-null and LISP_STRING is not nil. It means STRING is a string
23602 data of LISP_STRING. In that case, we display LISP_STRING while
23603 ignoring its text properties.
23605 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23606 FACE_STRING. Display STRING or LISP_STRING with the face at
23607 FACE_STRING_POS in FACE_STRING:
23609 Display the string in the environment given by IT, but use the
23610 standard display table, temporarily.
23612 FIELD_WIDTH is the minimum number of output glyphs to produce.
23613 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23614 with spaces. If STRING has more characters, more than FIELD_WIDTH
23615 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23617 PRECISION is the maximum number of characters to output from
23618 STRING. PRECISION < 0 means don't truncate the string.
23620 This is roughly equivalent to printf format specifiers:
23622 FIELD_WIDTH PRECISION PRINTF
23623 ----------------------------------------
23629 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23630 display them, and < 0 means obey the current buffer's value of
23631 enable_multibyte_characters.
23633 Value is the number of columns displayed. */
23636 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23637 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23638 int field_width
, int precision
, int max_x
, int multibyte
)
23640 int hpos_at_start
= it
->hpos
;
23641 int saved_face_id
= it
->face_id
;
23642 struct glyph_row
*row
= it
->glyph_row
;
23643 ptrdiff_t it_charpos
;
23645 /* Initialize the iterator IT for iteration over STRING beginning
23646 with index START. */
23647 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23648 precision
, field_width
, multibyte
);
23649 if (string
&& STRINGP (lisp_string
))
23650 /* LISP_STRING is the one returned by decode_mode_spec. We should
23651 ignore its text properties. */
23652 it
->stop_charpos
= it
->end_charpos
;
23654 /* If displaying STRING, set up the face of the iterator from
23655 FACE_STRING, if that's given. */
23656 if (STRINGP (face_string
))
23662 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23663 0, &endptr
, it
->base_face_id
, 0);
23664 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23665 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23668 /* Set max_x to the maximum allowed X position. Don't let it go
23669 beyond the right edge of the window. */
23671 max_x
= it
->last_visible_x
;
23673 max_x
= min (max_x
, it
->last_visible_x
);
23675 /* Skip over display elements that are not visible. because IT->w is
23677 if (it
->current_x
< it
->first_visible_x
)
23678 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23679 MOVE_TO_POS
| MOVE_TO_X
);
23681 row
->ascent
= it
->max_ascent
;
23682 row
->height
= it
->max_ascent
+ it
->max_descent
;
23683 row
->phys_ascent
= it
->max_phys_ascent
;
23684 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23685 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23687 if (STRINGP (it
->string
))
23688 it_charpos
= IT_STRING_CHARPOS (*it
);
23690 it_charpos
= IT_CHARPOS (*it
);
23692 /* This condition is for the case that we are called with current_x
23693 past last_visible_x. */
23694 while (it
->current_x
< max_x
)
23696 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23698 /* Get the next display element. */
23699 if (!get_next_display_element (it
))
23702 /* Produce glyphs. */
23703 x_before
= it
->current_x
;
23704 n_glyphs_before
= row
->used
[TEXT_AREA
];
23705 PRODUCE_GLYPHS (it
);
23707 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23710 while (i
< nglyphs
)
23712 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23714 if (it
->line_wrap
!= TRUNCATE
23715 && x
+ glyph
->pixel_width
> max_x
)
23717 /* End of continued line or max_x reached. */
23718 if (CHAR_GLYPH_PADDING_P (*glyph
))
23720 /* A wide character is unbreakable. */
23721 if (row
->reversed_p
)
23722 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23723 - n_glyphs_before
);
23724 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23725 it
->current_x
= x_before
;
23729 if (row
->reversed_p
)
23730 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23731 - (n_glyphs_before
+ i
));
23732 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23737 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23739 /* Glyph is at least partially visible. */
23741 if (x
< it
->first_visible_x
)
23742 row
->x
= x
- it
->first_visible_x
;
23746 /* Glyph is off the left margin of the display area.
23747 Should not happen. */
23751 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23752 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23753 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23754 row
->phys_height
= max (row
->phys_height
,
23755 it
->max_phys_ascent
+ it
->max_phys_descent
);
23756 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23757 it
->max_extra_line_spacing
);
23758 x
+= glyph
->pixel_width
;
23762 /* Stop if max_x reached. */
23766 /* Stop at line ends. */
23767 if (ITERATOR_AT_END_OF_LINE_P (it
))
23769 it
->continuation_lines_width
= 0;
23773 set_iterator_to_next (it
, 1);
23774 if (STRINGP (it
->string
))
23775 it_charpos
= IT_STRING_CHARPOS (*it
);
23777 it_charpos
= IT_CHARPOS (*it
);
23779 /* Stop if truncating at the right edge. */
23780 if (it
->line_wrap
== TRUNCATE
23781 && it
->current_x
>= it
->last_visible_x
)
23783 /* Add truncation mark, but don't do it if the line is
23784 truncated at a padding space. */
23785 if (it_charpos
< it
->string_nchars
)
23787 if (!FRAME_WINDOW_P (it
->f
))
23791 if (it
->current_x
> it
->last_visible_x
)
23793 if (!row
->reversed_p
)
23795 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23796 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23801 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23802 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23804 unproduce_glyphs (it
, ii
+ 1);
23805 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23807 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23809 row
->used
[TEXT_AREA
] = ii
;
23810 produce_special_glyphs (it
, IT_TRUNCATION
);
23813 produce_special_glyphs (it
, IT_TRUNCATION
);
23815 row
->truncated_on_right_p
= 1;
23821 /* Maybe insert a truncation at the left. */
23822 if (it
->first_visible_x
23825 if (!FRAME_WINDOW_P (it
->f
)
23826 || (row
->reversed_p
23827 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23828 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23829 insert_left_trunc_glyphs (it
);
23830 row
->truncated_on_left_p
= 1;
23833 it
->face_id
= saved_face_id
;
23835 /* Value is number of columns displayed. */
23836 return it
->hpos
- hpos_at_start
;
23841 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23842 appears as an element of LIST or as the car of an element of LIST.
23843 If PROPVAL is a list, compare each element against LIST in that
23844 way, and return 1/2 if any element of PROPVAL is found in LIST.
23845 Otherwise return 0. This function cannot quit.
23846 The return value is 2 if the text is invisible but with an ellipsis
23847 and 1 if it's invisible and without an ellipsis. */
23850 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23852 register Lisp_Object tail
, proptail
;
23854 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23856 register Lisp_Object tem
;
23858 if (EQ (propval
, tem
))
23860 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23861 return NILP (XCDR (tem
)) ? 1 : 2;
23864 if (CONSP (propval
))
23866 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23868 Lisp_Object propelt
;
23869 propelt
= XCAR (proptail
);
23870 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23872 register Lisp_Object tem
;
23874 if (EQ (propelt
, tem
))
23876 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23877 return NILP (XCDR (tem
)) ? 1 : 2;
23885 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23886 doc
: /* Non-nil if the property makes the text invisible.
23887 POS-OR-PROP can be a marker or number, in which case it is taken to be
23888 a position in the current buffer and the value of the `invisible' property
23889 is checked; or it can be some other value, which is then presumed to be the
23890 value of the `invisible' property of the text of interest.
23891 The non-nil value returned can be t for truly invisible text or something
23892 else if the text is replaced by an ellipsis. */)
23893 (Lisp_Object pos_or_prop
)
23896 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23897 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23899 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23900 return (invis
== 0 ? Qnil
23902 : make_number (invis
));
23905 /* Calculate a width or height in pixels from a specification using
23906 the following elements:
23909 NUM - a (fractional) multiple of the default font width/height
23910 (NUM) - specifies exactly NUM pixels
23911 UNIT - a fixed number of pixels, see below.
23912 ELEMENT - size of a display element in pixels, see below.
23913 (NUM . SPEC) - equals NUM * SPEC
23914 (+ SPEC SPEC ...) - add pixel values
23915 (- SPEC SPEC ...) - subtract pixel values
23916 (- SPEC) - negate pixel value
23919 INT or FLOAT - a number constant
23920 SYMBOL - use symbol's (buffer local) variable binding.
23923 in - pixels per inch *)
23924 mm - pixels per 1/1000 meter *)
23925 cm - pixels per 1/100 meter *)
23926 width - width of current font in pixels.
23927 height - height of current font in pixels.
23929 *) using the ratio(s) defined in display-pixels-per-inch.
23933 left-fringe - left fringe width in pixels
23934 right-fringe - right fringe width in pixels
23936 left-margin - left margin width in pixels
23937 right-margin - right margin width in pixels
23939 scroll-bar - scroll-bar area width in pixels
23943 Pixels corresponding to 5 inches:
23946 Total width of non-text areas on left side of window (if scroll-bar is on left):
23947 '(space :width (+ left-fringe left-margin scroll-bar))
23949 Align to first text column (in header line):
23950 '(space :align-to 0)
23952 Align to middle of text area minus half the width of variable `my-image'
23953 containing a loaded image:
23954 '(space :align-to (0.5 . (- text my-image)))
23956 Width of left margin minus width of 1 character in the default font:
23957 '(space :width (- left-margin 1))
23959 Width of left margin minus width of 2 characters in the current font:
23960 '(space :width (- left-margin (2 . width)))
23962 Center 1 character over left-margin (in header line):
23963 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23965 Different ways to express width of left fringe plus left margin minus one pixel:
23966 '(space :width (- (+ left-fringe left-margin) (1)))
23967 '(space :width (+ left-fringe left-margin (- (1))))
23968 '(space :width (+ left-fringe left-margin (-1)))
23973 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23974 struct font
*font
, int width_p
, int *align_to
)
23978 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23979 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23982 return OK_PIXELS (0);
23984 eassert (FRAME_LIVE_P (it
->f
));
23986 if (SYMBOLP (prop
))
23988 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23990 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23992 if (unit
[0] == 'i' && unit
[1] == 'n')
23994 else if (unit
[0] == 'm' && unit
[1] == 'm')
23996 else if (unit
[0] == 'c' && unit
[1] == 'm')
24002 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24003 : FRAME_RES_Y (it
->f
));
24006 return OK_PIXELS (ppi
/ pixels
);
24011 #ifdef HAVE_WINDOW_SYSTEM
24012 if (EQ (prop
, Qheight
))
24013 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
24014 if (EQ (prop
, Qwidth
))
24015 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
24017 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24018 return OK_PIXELS (1);
24021 if (EQ (prop
, Qtext
))
24022 return OK_PIXELS (width_p
24023 ? window_box_width (it
->w
, TEXT_AREA
)
24024 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24026 if (align_to
&& *align_to
< 0)
24029 if (EQ (prop
, Qleft
))
24030 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24031 if (EQ (prop
, Qright
))
24032 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24033 if (EQ (prop
, Qcenter
))
24034 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24035 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24036 if (EQ (prop
, Qleft_fringe
))
24037 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24038 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24039 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24040 if (EQ (prop
, Qright_fringe
))
24041 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24042 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24043 : window_box_right_offset (it
->w
, TEXT_AREA
));
24044 if (EQ (prop
, Qleft_margin
))
24045 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24046 if (EQ (prop
, Qright_margin
))
24047 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24048 if (EQ (prop
, Qscroll_bar
))
24049 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24051 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24052 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24053 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24058 if (EQ (prop
, Qleft_fringe
))
24059 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24060 if (EQ (prop
, Qright_fringe
))
24061 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24062 if (EQ (prop
, Qleft_margin
))
24063 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24064 if (EQ (prop
, Qright_margin
))
24065 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24066 if (EQ (prop
, Qscroll_bar
))
24067 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24070 prop
= buffer_local_value (prop
, it
->w
->contents
);
24071 if (EQ (prop
, Qunbound
))
24075 if (INTEGERP (prop
) || FLOATP (prop
))
24077 int base_unit
= (width_p
24078 ? FRAME_COLUMN_WIDTH (it
->f
)
24079 : FRAME_LINE_HEIGHT (it
->f
));
24080 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24085 Lisp_Object car
= XCAR (prop
);
24086 Lisp_Object cdr
= XCDR (prop
);
24090 #ifdef HAVE_WINDOW_SYSTEM
24091 if (FRAME_WINDOW_P (it
->f
)
24092 && valid_image_p (prop
))
24094 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24095 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24097 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24099 #ifdef HAVE_XWIDGETS
24100 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24102 printf("calc_pixel_width_or_height: return dummy size FIXME\n");
24103 return OK_PIXELS (width_p
? 100 : 100);
24107 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24113 while (CONSP (cdr
))
24115 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24116 font
, width_p
, align_to
))
24119 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
24124 if (EQ (car
, Qminus
))
24126 return OK_PIXELS (pixels
);
24129 car
= buffer_local_value (car
, it
->w
->contents
);
24130 if (EQ (car
, Qunbound
))
24134 if (INTEGERP (car
) || FLOATP (car
))
24137 pixels
= XFLOATINT (car
);
24139 return OK_PIXELS (pixels
);
24140 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24141 font
, width_p
, align_to
))
24142 return OK_PIXELS (pixels
* fact
);
24153 /***********************************************************************
24155 ***********************************************************************/
24157 #ifdef HAVE_WINDOW_SYSTEM
24162 dump_glyph_string (struct glyph_string
*s
)
24164 fprintf (stderr
, "glyph string\n");
24165 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24166 s
->x
, s
->y
, s
->width
, s
->height
);
24167 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24168 fprintf (stderr
, " hl = %d\n", s
->hl
);
24169 fprintf (stderr
, " left overhang = %d, right = %d\n",
24170 s
->left_overhang
, s
->right_overhang
);
24171 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24172 fprintf (stderr
, " extends to end of line = %d\n",
24173 s
->extends_to_end_of_line_p
);
24174 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24175 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24178 #endif /* GLYPH_DEBUG */
24180 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24181 of XChar2b structures for S; it can't be allocated in
24182 init_glyph_string because it must be allocated via `alloca'. W
24183 is the window on which S is drawn. ROW and AREA are the glyph row
24184 and area within the row from which S is constructed. START is the
24185 index of the first glyph structure covered by S. HL is a
24186 face-override for drawing S. */
24189 #define OPTIONAL_HDC(hdc) HDC hdc,
24190 #define DECLARE_HDC(hdc) HDC hdc;
24191 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24192 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24195 #ifndef OPTIONAL_HDC
24196 #define OPTIONAL_HDC(hdc)
24197 #define DECLARE_HDC(hdc)
24198 #define ALLOCATE_HDC(hdc, f)
24199 #define RELEASE_HDC(hdc, f)
24203 init_glyph_string (struct glyph_string
*s
,
24205 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24206 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24208 memset (s
, 0, sizeof *s
);
24210 s
->f
= XFRAME (w
->frame
);
24214 s
->display
= FRAME_X_DISPLAY (s
->f
);
24215 s
->window
= FRAME_X_WINDOW (s
->f
);
24216 s
->char2b
= char2b
;
24220 s
->first_glyph
= row
->glyphs
[area
] + start
;
24221 s
->height
= row
->height
;
24222 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24223 s
->ybase
= s
->y
+ row
->ascent
;
24227 /* Append the list of glyph strings with head H and tail T to the list
24228 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24231 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24232 struct glyph_string
*h
, struct glyph_string
*t
)
24246 /* Prepend the list of glyph strings with head H and tail T to the
24247 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24251 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24252 struct glyph_string
*h
, struct glyph_string
*t
)
24266 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24267 Set *HEAD and *TAIL to the resulting list. */
24270 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24271 struct glyph_string
*s
)
24273 s
->next
= s
->prev
= NULL
;
24274 append_glyph_string_lists (head
, tail
, s
, s
);
24278 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24279 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
24280 make sure that X resources for the face returned are allocated.
24281 Value is a pointer to a realized face that is ready for display if
24282 DISPLAY_P is non-zero. */
24284 static struct face
*
24285 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24286 XChar2b
*char2b
, int display_p
)
24288 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24293 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24295 if (code
== FONT_INVALID_CODE
)
24298 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24300 /* Make sure X resources of the face are allocated. */
24301 #ifdef HAVE_X_WINDOWS
24305 eassert (face
!= NULL
);
24306 prepare_face_for_display (f
, face
);
24313 /* Get face and two-byte form of character glyph GLYPH on frame F.
24314 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24315 a pointer to a realized face that is ready for display. */
24317 static struct face
*
24318 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24319 XChar2b
*char2b
, int *two_byte_p
)
24324 eassert (glyph
->type
== CHAR_GLYPH
);
24325 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24327 /* Make sure X resources of the face are allocated. */
24328 eassert (face
!= NULL
);
24329 prepare_face_for_display (f
, face
);
24336 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24337 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24339 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24341 if (code
== FONT_INVALID_CODE
)
24345 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24350 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24351 Return 1 if FONT has a glyph for C, otherwise return 0. */
24354 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24358 if (CHAR_BYTE8_P (c
))
24359 code
= CHAR_TO_BYTE8 (c
);
24361 code
= font
->driver
->encode_char (font
, c
);
24363 if (code
== FONT_INVALID_CODE
)
24365 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24370 /* Fill glyph string S with composition components specified by S->cmp.
24372 BASE_FACE is the base face of the composition.
24373 S->cmp_from is the index of the first component for S.
24375 OVERLAPS non-zero means S should draw the foreground only, and use
24376 its physical height for clipping. See also draw_glyphs.
24378 Value is the index of a component not in S. */
24381 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24385 /* For all glyphs of this composition, starting at the offset
24386 S->cmp_from, until we reach the end of the definition or encounter a
24387 glyph that requires the different face, add it to S. */
24392 s
->for_overlaps
= overlaps
;
24395 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24397 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24399 /* TAB in a composition means display glyphs with padding space
24400 on the left or right. */
24403 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24406 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24413 s
->font
= s
->face
->font
;
24415 else if (s
->face
!= face
)
24423 if (s
->face
== NULL
)
24425 s
->face
= base_face
->ascii_face
;
24426 s
->font
= s
->face
->font
;
24429 /* All glyph strings for the same composition has the same width,
24430 i.e. the width set for the first component of the composition. */
24431 s
->width
= s
->first_glyph
->pixel_width
;
24433 /* If the specified font could not be loaded, use the frame's
24434 default font, but record the fact that we couldn't load it in
24435 the glyph string so that we can draw rectangles for the
24436 characters of the glyph string. */
24437 if (s
->font
== NULL
)
24439 s
->font_not_found_p
= 1;
24440 s
->font
= FRAME_FONT (s
->f
);
24443 /* Adjust base line for subscript/superscript text. */
24444 s
->ybase
+= s
->first_glyph
->voffset
;
24446 /* This glyph string must always be drawn with 16-bit functions. */
24453 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24454 int start
, int end
, int overlaps
)
24456 struct glyph
*glyph
, *last
;
24457 Lisp_Object lgstring
;
24460 s
->for_overlaps
= overlaps
;
24461 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24462 last
= s
->row
->glyphs
[s
->area
] + end
;
24463 s
->cmp_id
= glyph
->u
.cmp
.id
;
24464 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24465 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24466 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24467 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24468 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24470 while (glyph
< last
24471 && glyph
->u
.cmp
.automatic
24472 && glyph
->u
.cmp
.id
== s
->cmp_id
24473 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24474 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24476 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24478 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24479 unsigned code
= LGLYPH_CODE (lglyph
);
24481 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24483 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24484 return glyph
- s
->row
->glyphs
[s
->area
];
24488 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24489 See the comment of fill_glyph_string for arguments.
24490 Value is the index of the first glyph not in S. */
24494 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24495 int start
, int end
, int overlaps
)
24497 struct glyph
*glyph
, *last
;
24500 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24501 s
->for_overlaps
= overlaps
;
24502 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24503 last
= s
->row
->glyphs
[s
->area
] + end
;
24504 voffset
= glyph
->voffset
;
24505 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24506 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24508 s
->width
= glyph
->pixel_width
;
24510 while (glyph
< last
24511 && glyph
->type
== GLYPHLESS_GLYPH
24512 && glyph
->voffset
== voffset
24513 && glyph
->face_id
== face_id
)
24516 s
->width
+= glyph
->pixel_width
;
24519 s
->ybase
+= voffset
;
24520 return glyph
- s
->row
->glyphs
[s
->area
];
24524 /* Fill glyph string S from a sequence of character glyphs.
24526 FACE_ID is the face id of the string. START is the index of the
24527 first glyph to consider, END is the index of the last + 1.
24528 OVERLAPS non-zero means S should draw the foreground only, and use
24529 its physical height for clipping. See also draw_glyphs.
24531 Value is the index of the first glyph not in S. */
24534 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24535 int start
, int end
, int overlaps
)
24537 struct glyph
*glyph
, *last
;
24539 int glyph_not_available_p
;
24541 eassert (s
->f
== XFRAME (s
->w
->frame
));
24542 eassert (s
->nchars
== 0);
24543 eassert (start
>= 0 && end
> start
);
24545 s
->for_overlaps
= overlaps
;
24546 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24547 last
= s
->row
->glyphs
[s
->area
] + end
;
24548 voffset
= glyph
->voffset
;
24549 s
->padding_p
= glyph
->padding_p
;
24550 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24552 while (glyph
< last
24553 && glyph
->type
== CHAR_GLYPH
24554 && glyph
->voffset
== voffset
24555 /* Same face id implies same font, nowadays. */
24556 && glyph
->face_id
== face_id
24557 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24561 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24562 s
->char2b
+ s
->nchars
,
24564 s
->two_byte_p
= two_byte_p
;
24566 eassert (s
->nchars
<= end
- start
);
24567 s
->width
+= glyph
->pixel_width
;
24568 if (glyph
++->padding_p
!= s
->padding_p
)
24572 s
->font
= s
->face
->font
;
24574 /* If the specified font could not be loaded, use the frame's font,
24575 but record the fact that we couldn't load it in
24576 S->font_not_found_p so that we can draw rectangles for the
24577 characters of the glyph string. */
24578 if (s
->font
== NULL
|| glyph_not_available_p
)
24580 s
->font_not_found_p
= 1;
24581 s
->font
= FRAME_FONT (s
->f
);
24584 /* Adjust base line for subscript/superscript text. */
24585 s
->ybase
+= voffset
;
24587 eassert (s
->face
&& s
->face
->gc
);
24588 return glyph
- s
->row
->glyphs
[s
->area
];
24592 /* Fill glyph string S from image glyph S->first_glyph. */
24595 fill_image_glyph_string (struct glyph_string
*s
)
24597 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24598 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24600 s
->slice
= s
->first_glyph
->slice
.img
;
24601 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24602 s
->font
= s
->face
->font
;
24603 s
->width
= s
->first_glyph
->pixel_width
;
24605 /* Adjust base line for subscript/superscript text. */
24606 s
->ybase
+= s
->first_glyph
->voffset
;
24610 #ifdef HAVE_XWIDGETS
24612 fill_xwidget_glyph_string (struct glyph_string
*s
)
24614 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24615 printf("fill_xwidget_glyph_string: width:%d \n",s
->first_glyph
->pixel_width
);
24616 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24617 s
->font
= s
->face
->font
;
24618 s
->width
= s
->first_glyph
->pixel_width
;
24619 s
->ybase
+= s
->first_glyph
->voffset
;
24620 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24621 //assert_valid_xwidget_id ( s->xwidget, "fill_xwidget_glyph_string");
24624 /* Fill glyph string S from a sequence of stretch glyphs.
24626 START is the index of the first glyph to consider,
24627 END is the index of the last + 1.
24629 Value is the index of the first glyph not in S. */
24632 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24634 struct glyph
*glyph
, *last
;
24635 int voffset
, face_id
;
24637 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24639 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24640 last
= s
->row
->glyphs
[s
->area
] + end
;
24641 face_id
= glyph
->face_id
;
24642 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24643 s
->font
= s
->face
->font
;
24644 s
->width
= glyph
->pixel_width
;
24646 voffset
= glyph
->voffset
;
24650 && glyph
->type
== STRETCH_GLYPH
24651 && glyph
->voffset
== voffset
24652 && glyph
->face_id
== face_id
);
24654 s
->width
+= glyph
->pixel_width
;
24656 /* Adjust base line for subscript/superscript text. */
24657 s
->ybase
+= voffset
;
24659 /* The case that face->gc == 0 is handled when drawing the glyph
24660 string by calling prepare_face_for_display. */
24662 return glyph
- s
->row
->glyphs
[s
->area
];
24665 static struct font_metrics
*
24666 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24668 static struct font_metrics metrics
;
24673 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24674 if (code
== FONT_INVALID_CODE
)
24676 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24681 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24682 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24683 assumed to be zero. */
24686 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24688 *left
= *right
= 0;
24690 if (glyph
->type
== CHAR_GLYPH
)
24694 struct font_metrics
*pcm
;
24696 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24697 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24699 if (pcm
->rbearing
> pcm
->width
)
24700 *right
= pcm
->rbearing
- pcm
->width
;
24701 if (pcm
->lbearing
< 0)
24702 *left
= -pcm
->lbearing
;
24705 else if (glyph
->type
== COMPOSITE_GLYPH
)
24707 if (! glyph
->u
.cmp
.automatic
)
24709 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24711 if (cmp
->rbearing
> cmp
->pixel_width
)
24712 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24713 if (cmp
->lbearing
< 0)
24714 *left
= - cmp
->lbearing
;
24718 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24719 struct font_metrics metrics
;
24721 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24722 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24723 if (metrics
.rbearing
> metrics
.width
)
24724 *right
= metrics
.rbearing
- metrics
.width
;
24725 if (metrics
.lbearing
< 0)
24726 *left
= - metrics
.lbearing
;
24732 /* Return the index of the first glyph preceding glyph string S that
24733 is overwritten by S because of S's left overhang. Value is -1
24734 if no glyphs are overwritten. */
24737 left_overwritten (struct glyph_string
*s
)
24741 if (s
->left_overhang
)
24744 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24745 int first
= s
->first_glyph
- glyphs
;
24747 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24748 x
-= glyphs
[i
].pixel_width
;
24759 /* Return the index of the first glyph preceding glyph string S that
24760 is overwriting S because of its right overhang. Value is -1 if no
24761 glyph in front of S overwrites S. */
24764 left_overwriting (struct glyph_string
*s
)
24767 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24768 int first
= s
->first_glyph
- glyphs
;
24772 for (i
= first
- 1; i
>= 0; --i
)
24775 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24778 x
-= glyphs
[i
].pixel_width
;
24785 /* Return the index of the last glyph following glyph string S that is
24786 overwritten by S because of S's right overhang. Value is -1 if
24787 no such glyph is found. */
24790 right_overwritten (struct glyph_string
*s
)
24794 if (s
->right_overhang
)
24797 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24798 int first
= (s
->first_glyph
- glyphs
24799 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24800 int end
= s
->row
->used
[s
->area
];
24802 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24803 x
+= glyphs
[i
].pixel_width
;
24812 /* Return the index of the last glyph following glyph string S that
24813 overwrites S because of its left overhang. Value is negative
24814 if no such glyph is found. */
24817 right_overwriting (struct glyph_string
*s
)
24820 int end
= s
->row
->used
[s
->area
];
24821 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24822 int first
= (s
->first_glyph
- glyphs
24823 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24827 for (i
= first
; i
< end
; ++i
)
24830 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24833 x
+= glyphs
[i
].pixel_width
;
24840 /* Set background width of glyph string S. START is the index of the
24841 first glyph following S. LAST_X is the right-most x-position + 1
24842 in the drawing area. */
24845 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24847 /* If the face of this glyph string has to be drawn to the end of
24848 the drawing area, set S->extends_to_end_of_line_p. */
24850 if (start
== s
->row
->used
[s
->area
]
24851 && ((s
->row
->fill_line_p
24852 && (s
->hl
== DRAW_NORMAL_TEXT
24853 || s
->hl
== DRAW_IMAGE_RAISED
24854 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24855 || s
->hl
== DRAW_MOUSE_FACE
))
24856 s
->extends_to_end_of_line_p
= 1;
24858 /* If S extends its face to the end of the line, set its
24859 background_width to the distance to the right edge of the drawing
24861 if (s
->extends_to_end_of_line_p
)
24862 s
->background_width
= last_x
- s
->x
+ 1;
24864 s
->background_width
= s
->width
;
24868 /* Compute overhangs and x-positions for glyph string S and its
24869 predecessors, or successors. X is the starting x-position for S.
24870 BACKWARD_P non-zero means process predecessors. */
24873 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24879 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24880 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24890 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24891 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24901 /* The following macros are only called from draw_glyphs below.
24902 They reference the following parameters of that function directly:
24903 `w', `row', `area', and `overlap_p'
24904 as well as the following local variables:
24905 `s', `f', and `hdc' (in W32) */
24908 /* On W32, silently add local `hdc' variable to argument list of
24909 init_glyph_string. */
24910 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24911 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24913 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24914 init_glyph_string (s, char2b, w, row, area, start, hl)
24917 /* Add a glyph string for a stretch glyph to the list of strings
24918 between HEAD and TAIL. START is the index of the stretch glyph in
24919 row area AREA of glyph row ROW. END is the index of the last glyph
24920 in that glyph row area. X is the current output position assigned
24921 to the new glyph string constructed. HL overrides that face of the
24922 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24923 is the right-most x-position of the drawing area. */
24925 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24926 and below -- keep them on one line. */
24927 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24930 s = alloca (sizeof *s); \
24931 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24932 START = fill_stretch_glyph_string (s, START, END); \
24933 append_glyph_string (&HEAD, &TAIL, s); \
24939 /* Add a glyph string for an image glyph to the list of strings
24940 between HEAD and TAIL. START is the index of the image glyph in
24941 row area AREA of glyph row ROW. END is the index of the last glyph
24942 in that glyph row area. X is the current output position assigned
24943 to the new glyph string constructed. HL overrides that face of the
24944 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24945 is the right-most x-position of the drawing area. */
24947 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24950 s = alloca (sizeof *s); \
24951 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24952 fill_image_glyph_string (s); \
24953 append_glyph_string (&HEAD, &TAIL, s); \
24959 #ifdef HAVE_XWIDGETS
24960 #define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24963 printf("BUILD_XWIDGET_GLYPH_STRING\n"); \
24964 s = (struct glyph_string *) alloca (sizeof *s); \
24965 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24966 fill_xwidget_glyph_string (s); \
24967 append_glyph_string (&HEAD, &TAIL, s); \
24975 /* Add a glyph string for a sequence of character glyphs to the list
24976 of strings between HEAD and TAIL. START is the index of the first
24977 glyph in row area AREA of glyph row ROW that is part of the new
24978 glyph string. END is the index of the last glyph in that glyph row
24979 area. X is the current output position assigned to the new glyph
24980 string constructed. HL overrides that face of the glyph; e.g. it
24981 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24982 right-most x-position of the drawing area. */
24984 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24990 face_id = (row)->glyphs[area][START].face_id; \
24992 s = alloca (sizeof *s); \
24993 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
24994 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24995 append_glyph_string (&HEAD, &TAIL, s); \
24997 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25002 /* Add a glyph string for a composite sequence to the list of strings
25003 between HEAD and TAIL. START is the index of the first glyph in
25004 row area AREA of glyph row ROW that is part of the new glyph
25005 string. END is the index of the last glyph in that glyph row area.
25006 X is the current output position assigned to the new glyph string
25007 constructed. HL overrides that face of the glyph; e.g. it is
25008 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25009 x-position of the drawing area. */
25011 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25013 int face_id = (row)->glyphs[area][START].face_id; \
25014 struct face *base_face = FACE_FROM_ID (f, face_id); \
25015 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25016 struct composition *cmp = composition_table[cmp_id]; \
25018 struct glyph_string *first_s = NULL; \
25021 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25023 /* Make glyph_strings for each glyph sequence that is drawable by \
25024 the same face, and append them to HEAD/TAIL. */ \
25025 for (n = 0; n < cmp->glyph_len;) \
25027 s = alloca (sizeof *s); \
25028 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25029 append_glyph_string (&(HEAD), &(TAIL), s); \
25035 n = fill_composite_glyph_string (s, base_face, overlaps); \
25043 /* Add a glyph string for a glyph-string sequence to the list of strings
25044 between HEAD and TAIL. */
25046 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25050 Lisp_Object gstring; \
25052 face_id = (row)->glyphs[area][START].face_id; \
25053 gstring = (composition_gstring_from_id \
25054 ((row)->glyphs[area][START].u.cmp.id)); \
25055 s = alloca (sizeof *s); \
25056 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25057 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25058 append_glyph_string (&(HEAD), &(TAIL), s); \
25060 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25064 /* Add a glyph string for a sequence of glyphless character's glyphs
25065 to the list of strings between HEAD and TAIL. The meanings of
25066 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25068 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25073 face_id = (row)->glyphs[area][START].face_id; \
25075 s = alloca (sizeof *s); \
25076 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25077 append_glyph_string (&HEAD, &TAIL, s); \
25079 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25085 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25086 of AREA of glyph row ROW on window W between indices START and END.
25087 HL overrides the face for drawing glyph strings, e.g. it is
25088 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25089 x-positions of the drawing area.
25091 This is an ugly monster macro construct because we must use alloca
25092 to allocate glyph strings (because draw_glyphs can be called
25093 asynchronously). */
25095 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25098 HEAD = TAIL = NULL; \
25099 while (START < END) \
25101 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25102 switch (first_glyph->type) \
25105 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25109 case COMPOSITE_GLYPH: \
25110 if (first_glyph->u.cmp.automatic) \
25111 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25114 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25118 case STRETCH_GLYPH: \
25119 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25123 case IMAGE_GLYPH: \
25124 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25128 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25129 case XWIDGET_GLYPH: \
25130 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25134 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25135 case GLYPHLESS_GLYPH: \
25136 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25146 set_glyph_string_background_width (s, START, LAST_X); \
25153 #ifdef HAVE_XWIDGETS
25154 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25155 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25156 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25157 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25159 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25160 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25161 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25165 /* Draw glyphs between START and END in AREA of ROW on window W,
25166 starting at x-position X. X is relative to AREA in W. HL is a
25167 face-override with the following meaning:
25169 DRAW_NORMAL_TEXT draw normally
25170 DRAW_CURSOR draw in cursor face
25171 DRAW_MOUSE_FACE draw in mouse face.
25172 DRAW_INVERSE_VIDEO draw in mode line face
25173 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25174 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25176 If OVERLAPS is non-zero, draw only the foreground of characters and
25177 clip to the physical height of ROW. Non-zero value also defines
25178 the overlapping part to be drawn:
25180 OVERLAPS_PRED overlap with preceding rows
25181 OVERLAPS_SUCC overlap with succeeding rows
25182 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25183 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25185 Value is the x-position reached, relative to AREA of W. */
25188 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25189 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25190 enum draw_glyphs_face hl
, int overlaps
)
25192 struct glyph_string
*head
, *tail
;
25193 struct glyph_string
*s
;
25194 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25195 int i
, j
, x_reached
, last_x
, area_left
= 0;
25196 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25199 ALLOCATE_HDC (hdc
, f
);
25201 /* Let's rather be paranoid than getting a SEGV. */
25202 end
= min (end
, row
->used
[area
]);
25203 start
= clip_to_bounds (0, start
, end
);
25205 /* Translate X to frame coordinates. Set last_x to the right
25206 end of the drawing area. */
25207 if (row
->full_width_p
)
25209 /* X is relative to the left edge of W, without scroll bars
25211 area_left
= WINDOW_LEFT_EDGE_X (w
);
25212 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25213 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25217 area_left
= window_box_left (w
, area
);
25218 last_x
= area_left
+ window_box_width (w
, area
);
25222 /* Build a doubly-linked list of glyph_string structures between
25223 head and tail from what we have to draw. Note that the macro
25224 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25225 the reason we use a separate variable `i'. */
25228 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25230 x_reached
= tail
->x
+ tail
->background_width
;
25234 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25235 the row, redraw some glyphs in front or following the glyph
25236 strings built above. */
25237 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25239 struct glyph_string
*h
, *t
;
25240 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25241 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25242 int check_mouse_face
= 0;
25245 /* If mouse highlighting is on, we may need to draw adjacent
25246 glyphs using mouse-face highlighting. */
25247 if (area
== TEXT_AREA
&& row
->mouse_face_p
25248 && hlinfo
->mouse_face_beg_row
>= 0
25249 && hlinfo
->mouse_face_end_row
>= 0)
25251 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25253 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25254 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25256 check_mouse_face
= 1;
25257 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25258 ? hlinfo
->mouse_face_beg_col
: 0;
25259 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25260 ? hlinfo
->mouse_face_end_col
25261 : row
->used
[TEXT_AREA
];
25265 /* Compute overhangs for all glyph strings. */
25266 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25267 for (s
= head
; s
; s
= s
->next
)
25268 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25270 /* Prepend glyph strings for glyphs in front of the first glyph
25271 string that are overwritten because of the first glyph
25272 string's left overhang. The background of all strings
25273 prepended must be drawn because the first glyph string
25275 i
= left_overwritten (head
);
25278 enum draw_glyphs_face overlap_hl
;
25280 /* If this row contains mouse highlighting, attempt to draw
25281 the overlapped glyphs with the correct highlight. This
25282 code fails if the overlap encompasses more than one glyph
25283 and mouse-highlight spans only some of these glyphs.
25284 However, making it work perfectly involves a lot more
25285 code, and I don't know if the pathological case occurs in
25286 practice, so we'll stick to this for now. --- cyd */
25287 if (check_mouse_face
25288 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25289 overlap_hl
= DRAW_MOUSE_FACE
;
25291 overlap_hl
= DRAW_NORMAL_TEXT
;
25293 if (hl
!= overlap_hl
)
25296 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25297 overlap_hl
, dummy_x
, last_x
);
25299 compute_overhangs_and_x (t
, head
->x
, 1);
25300 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25301 if (clip_head
== NULL
)
25305 /* Prepend glyph strings for glyphs in front of the first glyph
25306 string that overwrite that glyph string because of their
25307 right overhang. For these strings, only the foreground must
25308 be drawn, because it draws over the glyph string at `head'.
25309 The background must not be drawn because this would overwrite
25310 right overhangs of preceding glyphs for which no glyph
25312 i
= left_overwriting (head
);
25315 enum draw_glyphs_face overlap_hl
;
25317 if (check_mouse_face
25318 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25319 overlap_hl
= DRAW_MOUSE_FACE
;
25321 overlap_hl
= DRAW_NORMAL_TEXT
;
25323 if (hl
== overlap_hl
|| clip_head
== NULL
)
25325 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25326 overlap_hl
, dummy_x
, last_x
);
25327 for (s
= h
; s
; s
= s
->next
)
25328 s
->background_filled_p
= 1;
25329 compute_overhangs_and_x (t
, head
->x
, 1);
25330 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25333 /* Append glyphs strings for glyphs following the last glyph
25334 string tail that are overwritten by tail. The background of
25335 these strings has to be drawn because tail's foreground draws
25337 i
= right_overwritten (tail
);
25340 enum draw_glyphs_face overlap_hl
;
25342 if (check_mouse_face
25343 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25344 overlap_hl
= DRAW_MOUSE_FACE
;
25346 overlap_hl
= DRAW_NORMAL_TEXT
;
25348 if (hl
!= overlap_hl
)
25350 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25351 overlap_hl
, x
, last_x
);
25352 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25353 we don't have `end = i;' here. */
25354 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25355 append_glyph_string_lists (&head
, &tail
, h
, t
);
25356 if (clip_tail
== NULL
)
25360 /* Append glyph strings for glyphs following the last glyph
25361 string tail that overwrite tail. The foreground of such
25362 glyphs has to be drawn because it writes into the background
25363 of tail. The background must not be drawn because it could
25364 paint over the foreground of following glyphs. */
25365 i
= right_overwriting (tail
);
25368 enum draw_glyphs_face overlap_hl
;
25369 if (check_mouse_face
25370 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25371 overlap_hl
= DRAW_MOUSE_FACE
;
25373 overlap_hl
= DRAW_NORMAL_TEXT
;
25375 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25377 i
++; /* We must include the Ith glyph. */
25378 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25379 overlap_hl
, x
, last_x
);
25380 for (s
= h
; s
; s
= s
->next
)
25381 s
->background_filled_p
= 1;
25382 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25383 append_glyph_string_lists (&head
, &tail
, h
, t
);
25385 if (clip_head
|| clip_tail
)
25386 for (s
= head
; s
; s
= s
->next
)
25388 s
->clip_head
= clip_head
;
25389 s
->clip_tail
= clip_tail
;
25393 /* Draw all strings. */
25394 for (s
= head
; s
; s
= s
->next
)
25395 FRAME_RIF (f
)->draw_glyph_string (s
);
25398 /* When focus a sole frame and move horizontally, this sets on_p to 0
25399 causing a failure to erase prev cursor position. */
25400 if (area
== TEXT_AREA
25401 && !row
->full_width_p
25402 /* When drawing overlapping rows, only the glyph strings'
25403 foreground is drawn, which doesn't erase a cursor
25407 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25408 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25409 : (tail
? tail
->x
+ tail
->background_width
: x
));
25413 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25414 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25418 /* Value is the x-position up to which drawn, relative to AREA of W.
25419 This doesn't include parts drawn because of overhangs. */
25420 if (row
->full_width_p
)
25421 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25423 x_reached
-= area_left
;
25425 RELEASE_HDC (hdc
, f
);
25431 /* Expand row matrix if too narrow. Don't expand if area
25434 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25436 if (!it->f->fonts_changed \
25437 && (it->glyph_row->glyphs[area] \
25438 < it->glyph_row->glyphs[area + 1])) \
25440 it->w->ncols_scale_factor++; \
25441 it->f->fonts_changed = 1; \
25445 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25446 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25449 append_glyph (struct it
*it
)
25451 struct glyph
*glyph
;
25452 enum glyph_row_area area
= it
->area
;
25454 eassert (it
->glyph_row
);
25455 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25457 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25458 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25460 /* If the glyph row is reversed, we need to prepend the glyph
25461 rather than append it. */
25462 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25466 /* Make room for the additional glyph. */
25467 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25469 glyph
= it
->glyph_row
->glyphs
[area
];
25471 glyph
->charpos
= CHARPOS (it
->position
);
25472 glyph
->object
= it
->object
;
25473 if (it
->pixel_width
> 0)
25475 glyph
->pixel_width
= it
->pixel_width
;
25476 glyph
->padding_p
= 0;
25480 /* Assure at least 1-pixel width. Otherwise, cursor can't
25481 be displayed correctly. */
25482 glyph
->pixel_width
= 1;
25483 glyph
->padding_p
= 1;
25485 glyph
->ascent
= it
->ascent
;
25486 glyph
->descent
= it
->descent
;
25487 glyph
->voffset
= it
->voffset
;
25488 glyph
->type
= CHAR_GLYPH
;
25489 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25490 glyph
->multibyte_p
= it
->multibyte_p
;
25491 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25493 /* In R2L rows, the left and the right box edges need to be
25494 drawn in reverse direction. */
25495 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25496 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25500 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25501 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25503 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25504 || it
->phys_descent
> it
->descent
);
25505 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25506 glyph
->face_id
= it
->face_id
;
25507 glyph
->u
.ch
= it
->char_to_display
;
25508 glyph
->slice
.img
= null_glyph_slice
;
25509 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25512 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25513 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25514 glyph
->bidi_type
= it
->bidi_it
.type
;
25518 glyph
->resolved_level
= 0;
25519 glyph
->bidi_type
= UNKNOWN_BT
;
25521 ++it
->glyph_row
->used
[area
];
25524 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25527 /* Store one glyph for the composition IT->cmp_it.id in
25528 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25532 append_composite_glyph (struct it
*it
)
25534 struct glyph
*glyph
;
25535 enum glyph_row_area area
= it
->area
;
25537 eassert (it
->glyph_row
);
25539 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25540 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25542 /* If the glyph row is reversed, we need to prepend the glyph
25543 rather than append it. */
25544 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25548 /* Make room for the new glyph. */
25549 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25551 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25553 glyph
->charpos
= it
->cmp_it
.charpos
;
25554 glyph
->object
= it
->object
;
25555 glyph
->pixel_width
= it
->pixel_width
;
25556 glyph
->ascent
= it
->ascent
;
25557 glyph
->descent
= it
->descent
;
25558 glyph
->voffset
= it
->voffset
;
25559 glyph
->type
= COMPOSITE_GLYPH
;
25560 if (it
->cmp_it
.ch
< 0)
25562 glyph
->u
.cmp
.automatic
= 0;
25563 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25564 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25568 glyph
->u
.cmp
.automatic
= 1;
25569 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25570 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25571 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25573 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25574 glyph
->multibyte_p
= it
->multibyte_p
;
25575 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25577 /* In R2L rows, the left and the right box edges need to be
25578 drawn in reverse direction. */
25579 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25580 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25584 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25585 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25587 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25588 || it
->phys_descent
> it
->descent
);
25589 glyph
->padding_p
= 0;
25590 glyph
->glyph_not_available_p
= 0;
25591 glyph
->face_id
= it
->face_id
;
25592 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25595 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25596 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25597 glyph
->bidi_type
= it
->bidi_it
.type
;
25599 ++it
->glyph_row
->used
[area
];
25602 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25606 /* Change IT->ascent and IT->height according to the setting of
25610 take_vertical_position_into_account (struct it
*it
)
25614 if (it
->voffset
< 0)
25615 /* Increase the ascent so that we can display the text higher
25617 it
->ascent
-= it
->voffset
;
25619 /* Increase the descent so that we can display the text lower
25621 it
->descent
+= it
->voffset
;
25626 /* Produce glyphs/get display metrics for the image IT is loaded with.
25627 See the description of struct display_iterator in dispextern.h for
25628 an overview of struct display_iterator. */
25631 produce_image_glyph (struct it
*it
)
25635 int glyph_ascent
, crop
;
25636 struct glyph_slice slice
;
25638 eassert (it
->what
== IT_IMAGE
);
25640 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25642 /* Make sure X resources of the face is loaded. */
25643 prepare_face_for_display (it
->f
, face
);
25645 if (it
->image_id
< 0)
25647 /* Fringe bitmap. */
25648 it
->ascent
= it
->phys_ascent
= 0;
25649 it
->descent
= it
->phys_descent
= 0;
25650 it
->pixel_width
= 0;
25655 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25657 /* Make sure X resources of the image is loaded. */
25658 prepare_image_for_display (it
->f
, img
);
25660 slice
.x
= slice
.y
= 0;
25661 slice
.width
= img
->width
;
25662 slice
.height
= img
->height
;
25664 if (INTEGERP (it
->slice
.x
))
25665 slice
.x
= XINT (it
->slice
.x
);
25666 else if (FLOATP (it
->slice
.x
))
25667 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25669 if (INTEGERP (it
->slice
.y
))
25670 slice
.y
= XINT (it
->slice
.y
);
25671 else if (FLOATP (it
->slice
.y
))
25672 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25674 if (INTEGERP (it
->slice
.width
))
25675 slice
.width
= XINT (it
->slice
.width
);
25676 else if (FLOATP (it
->slice
.width
))
25677 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25679 if (INTEGERP (it
->slice
.height
))
25680 slice
.height
= XINT (it
->slice
.height
);
25681 else if (FLOATP (it
->slice
.height
))
25682 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25684 if (slice
.x
>= img
->width
)
25685 slice
.x
= img
->width
;
25686 if (slice
.y
>= img
->height
)
25687 slice
.y
= img
->height
;
25688 if (slice
.x
+ slice
.width
>= img
->width
)
25689 slice
.width
= img
->width
- slice
.x
;
25690 if (slice
.y
+ slice
.height
> img
->height
)
25691 slice
.height
= img
->height
- slice
.y
;
25693 if (slice
.width
== 0 || slice
.height
== 0)
25696 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25698 it
->descent
= slice
.height
- glyph_ascent
;
25700 it
->descent
+= img
->vmargin
;
25701 if (slice
.y
+ slice
.height
== img
->height
)
25702 it
->descent
+= img
->vmargin
;
25703 it
->phys_descent
= it
->descent
;
25705 it
->pixel_width
= slice
.width
;
25707 it
->pixel_width
+= img
->hmargin
;
25708 if (slice
.x
+ slice
.width
== img
->width
)
25709 it
->pixel_width
+= img
->hmargin
;
25711 /* It's quite possible for images to have an ascent greater than
25712 their height, so don't get confused in that case. */
25713 if (it
->descent
< 0)
25718 if (face
->box
!= FACE_NO_BOX
)
25720 if (face
->box_line_width
> 0)
25723 it
->ascent
+= face
->box_line_width
;
25724 if (slice
.y
+ slice
.height
== img
->height
)
25725 it
->descent
+= face
->box_line_width
;
25728 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25729 it
->pixel_width
+= eabs (face
->box_line_width
);
25730 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25731 it
->pixel_width
+= eabs (face
->box_line_width
);
25734 take_vertical_position_into_account (it
);
25736 /* Automatically crop wide image glyphs at right edge so we can
25737 draw the cursor on same display row. */
25738 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25739 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25741 it
->pixel_width
-= crop
;
25742 slice
.width
-= crop
;
25747 struct glyph
*glyph
;
25748 enum glyph_row_area area
= it
->area
;
25750 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25751 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25753 glyph
->charpos
= CHARPOS (it
->position
);
25754 glyph
->object
= it
->object
;
25755 glyph
->pixel_width
= it
->pixel_width
;
25756 glyph
->ascent
= glyph_ascent
;
25757 glyph
->descent
= it
->descent
;
25758 glyph
->voffset
= it
->voffset
;
25759 glyph
->type
= IMAGE_GLYPH
;
25760 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25761 glyph
->multibyte_p
= it
->multibyte_p
;
25762 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25764 /* In R2L rows, the left and the right box edges need to be
25765 drawn in reverse direction. */
25766 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25767 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25771 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25772 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25774 glyph
->overlaps_vertically_p
= 0;
25775 glyph
->padding_p
= 0;
25776 glyph
->glyph_not_available_p
= 0;
25777 glyph
->face_id
= it
->face_id
;
25778 glyph
->u
.img_id
= img
->id
;
25779 glyph
->slice
.img
= slice
;
25780 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25783 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25784 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25785 glyph
->bidi_type
= it
->bidi_it
.type
;
25787 ++it
->glyph_row
->used
[area
];
25790 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25794 #ifdef HAVE_XWIDGETS
25796 produce_xwidget_glyph (struct it
*it
)
25798 struct xwidget
* xw
;
25800 int glyph_ascent
, crop
;
25801 printf("produce_xwidget_glyph:\n");
25802 eassert (it
->what
== IT_XWIDGET
);
25804 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25806 /* Make sure X resources of the face is loaded. */
25807 prepare_face_for_display (it
->f
, face
);
25810 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
25811 it
->descent
= xw
->height
/2;
25812 it
->phys_descent
= it
->descent
;
25813 it
->pixel_width
= xw
->width
;
25814 /* It's quite possible for images to have an ascent greater than
25815 their height, so don't get confused in that case. */
25816 if (it
->descent
< 0)
25821 if (face
->box
!= FACE_NO_BOX
)
25823 if (face
->box_line_width
> 0)
25825 it
->ascent
+= face
->box_line_width
;
25826 it
->descent
+= face
->box_line_width
;
25829 if (it
->start_of_box_run_p
)
25830 it
->pixel_width
+= eabs (face
->box_line_width
);
25831 it
->pixel_width
+= eabs (face
->box_line_width
);
25834 take_vertical_position_into_account (it
);
25836 /* Automatically crop wide image glyphs at right edge so we can
25837 draw the cursor on same display row. */
25838 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25839 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25841 it
->pixel_width
-= crop
;
25846 struct glyph
*glyph
;
25847 enum glyph_row_area area
= it
->area
;
25849 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25850 if (it
->glyph_row
->reversed_p
)
25854 /* Make room for the new glyph. */
25855 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25857 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25859 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25861 glyph
->charpos
= CHARPOS (it
->position
);
25862 glyph
->object
= it
->object
;
25863 glyph
->pixel_width
= it
->pixel_width
;
25864 glyph
->ascent
= glyph_ascent
;
25865 glyph
->descent
= it
->descent
;
25866 glyph
->voffset
= it
->voffset
;
25867 glyph
->type
= XWIDGET_GLYPH
;
25868 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25869 glyph
->multibyte_p
= it
->multibyte_p
;
25870 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25872 /* In R2L rows, the left and the right box edges need to be
25873 drawn in reverse direction. */
25874 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25875 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25879 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25880 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25882 glyph
->overlaps_vertically_p
= 0;
25883 glyph
->padding_p
= 0;
25884 glyph
->glyph_not_available_p
= 0;
25885 glyph
->face_id
= it
->face_id
;
25886 glyph
->u
.xwidget
= it
->xwidget
;
25887 //assert_valid_xwidget_id(glyph->u.xwidget_id,"produce_xwidget_glyph");
25888 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25891 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25892 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25893 glyph
->bidi_type
= it
->bidi_it
.type
;
25895 ++it
->glyph_row
->used
[area
];
25898 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25903 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25904 of the glyph, WIDTH and HEIGHT are the width and height of the
25905 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25908 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25909 int width
, int height
, int ascent
)
25911 struct glyph
*glyph
;
25912 enum glyph_row_area area
= it
->area
;
25914 eassert (ascent
>= 0 && ascent
<= height
);
25916 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25917 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25919 /* If the glyph row is reversed, we need to prepend the glyph
25920 rather than append it. */
25921 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25925 /* Make room for the additional glyph. */
25926 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25928 glyph
= it
->glyph_row
->glyphs
[area
];
25930 /* Decrease the width of the first glyph of the row that
25931 begins before first_visible_x (e.g., due to hscroll).
25932 This is so the overall width of the row becomes smaller
25933 by the scroll amount, and the stretch glyph appended by
25934 extend_face_to_end_of_line will be wider, to shift the
25935 row glyphs to the right. (In L2R rows, the corresponding
25936 left-shift effect is accomplished by setting row->x to a
25937 negative value, which won't work with R2L rows.)
25939 This must leave us with a positive value of WIDTH, since
25940 otherwise the call to move_it_in_display_line_to at the
25941 beginning of display_line would have got past the entire
25942 first glyph, and then it->current_x would have been
25943 greater or equal to it->first_visible_x. */
25944 if (it
->current_x
< it
->first_visible_x
)
25945 width
-= it
->first_visible_x
- it
->current_x
;
25946 eassert (width
> 0);
25948 glyph
->charpos
= CHARPOS (it
->position
);
25949 glyph
->object
= object
;
25950 glyph
->pixel_width
= width
;
25951 glyph
->ascent
= ascent
;
25952 glyph
->descent
= height
- ascent
;
25953 glyph
->voffset
= it
->voffset
;
25954 glyph
->type
= STRETCH_GLYPH
;
25955 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25956 glyph
->multibyte_p
= it
->multibyte_p
;
25957 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25959 /* In R2L rows, the left and the right box edges need to be
25960 drawn in reverse direction. */
25961 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25962 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25966 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25967 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25969 glyph
->overlaps_vertically_p
= 0;
25970 glyph
->padding_p
= 0;
25971 glyph
->glyph_not_available_p
= 0;
25972 glyph
->face_id
= it
->face_id
;
25973 glyph
->u
.stretch
.ascent
= ascent
;
25974 glyph
->u
.stretch
.height
= height
;
25975 glyph
->slice
.img
= null_glyph_slice
;
25976 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25979 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25980 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25981 glyph
->bidi_type
= it
->bidi_it
.type
;
25985 glyph
->resolved_level
= 0;
25986 glyph
->bidi_type
= UNKNOWN_BT
;
25988 ++it
->glyph_row
->used
[area
];
25991 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25994 #endif /* HAVE_WINDOW_SYSTEM */
25996 /* Produce a stretch glyph for iterator IT. IT->object is the value
25997 of the glyph property displayed. The value must be a list
25998 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26001 1. `:width WIDTH' specifies that the space should be WIDTH *
26002 canonical char width wide. WIDTH may be an integer or floating
26005 2. `:relative-width FACTOR' specifies that the width of the stretch
26006 should be computed from the width of the first character having the
26007 `glyph' property, and should be FACTOR times that width.
26009 3. `:align-to HPOS' specifies that the space should be wide enough
26010 to reach HPOS, a value in canonical character units.
26012 Exactly one of the above pairs must be present.
26014 4. `:height HEIGHT' specifies that the height of the stretch produced
26015 should be HEIGHT, measured in canonical character units.
26017 5. `:relative-height FACTOR' specifies that the height of the
26018 stretch should be FACTOR times the height of the characters having
26019 the glyph property.
26021 Either none or exactly one of 4 or 5 must be present.
26023 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26024 of the stretch should be used for the ascent of the stretch.
26025 ASCENT must be in the range 0 <= ASCENT <= 100. */
26028 produce_stretch_glyph (struct it
*it
)
26030 /* (space :width WIDTH :height HEIGHT ...) */
26031 Lisp_Object prop
, plist
;
26032 int width
= 0, height
= 0, align_to
= -1;
26033 int zero_width_ok_p
= 0;
26035 struct font
*font
= NULL
;
26037 #ifdef HAVE_WINDOW_SYSTEM
26039 int zero_height_ok_p
= 0;
26041 if (FRAME_WINDOW_P (it
->f
))
26043 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26044 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26045 prepare_face_for_display (it
->f
, face
);
26049 /* List should start with `space'. */
26050 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26051 plist
= XCDR (it
->object
);
26053 /* Compute the width of the stretch. */
26054 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26055 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
26057 /* Absolute width `:width WIDTH' specified and valid. */
26058 zero_width_ok_p
= 1;
26061 #ifdef HAVE_WINDOW_SYSTEM
26062 else if (FRAME_WINDOW_P (it
->f
)
26063 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
26065 /* Relative width `:relative-width FACTOR' specified and valid.
26066 Compute the width of the characters having the `glyph'
26069 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26072 if (it
->multibyte_p
)
26073 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26076 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26077 if (! ASCII_CHAR_P (it2
.c
))
26078 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26081 it2
.glyph_row
= NULL
;
26082 it2
.what
= IT_CHARACTER
;
26083 x_produce_glyphs (&it2
);
26084 width
= NUMVAL (prop
) * it2
.pixel_width
;
26086 #endif /* HAVE_WINDOW_SYSTEM */
26087 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26088 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
26090 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26091 align_to
= (align_to
< 0
26093 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26094 else if (align_to
< 0)
26095 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26096 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26097 zero_width_ok_p
= 1;
26100 /* Nothing specified -> width defaults to canonical char width. */
26101 width
= FRAME_COLUMN_WIDTH (it
->f
);
26103 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26106 #ifdef HAVE_WINDOW_SYSTEM
26107 /* Compute height. */
26108 if (FRAME_WINDOW_P (it
->f
))
26110 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26111 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
26114 zero_height_ok_p
= 1;
26116 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26118 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
26120 height
= FONT_HEIGHT (font
);
26122 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26125 /* Compute percentage of height used for ascent. If
26126 `:ascent ASCENT' is present and valid, use that. Otherwise,
26127 derive the ascent from the font in use. */
26128 if (prop
= Fplist_get (plist
, QCascent
),
26129 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26130 ascent
= height
* NUMVAL (prop
) / 100.0;
26131 else if (!NILP (prop
)
26132 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
26133 ascent
= min (max (0, (int)tem
), height
);
26135 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26138 #endif /* HAVE_WINDOW_SYSTEM */
26141 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26142 && it
->current_x
+ width
> it
->last_visible_x
)
26144 width
= it
->last_visible_x
- it
->current_x
;
26145 #ifdef HAVE_WINDOW_SYSTEM
26146 /* Subtract one more pixel from the stretch width, but only on
26147 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26148 width
-= FRAME_WINDOW_P (it
->f
);
26152 if (width
> 0 && height
> 0 && it
->glyph_row
)
26154 Lisp_Object o_object
= it
->object
;
26155 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26158 if (!STRINGP (object
))
26159 object
= it
->w
->contents
;
26160 #ifdef HAVE_WINDOW_SYSTEM
26161 if (FRAME_WINDOW_P (it
->f
))
26162 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26166 it
->object
= object
;
26167 it
->char_to_display
= ' ';
26168 it
->pixel_width
= it
->len
= 1;
26170 tty_append_glyph (it
);
26171 it
->object
= o_object
;
26175 it
->pixel_width
= width
;
26176 #ifdef HAVE_WINDOW_SYSTEM
26177 if (FRAME_WINDOW_P (it
->f
))
26179 it
->ascent
= it
->phys_ascent
= ascent
;
26180 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26181 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
26182 take_vertical_position_into_account (it
);
26186 it
->nglyphs
= width
;
26189 /* Get information about special display element WHAT in an
26190 environment described by IT. WHAT is one of IT_TRUNCATION or
26191 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26192 non-null glyph_row member. This function ensures that fields like
26193 face_id, c, len of IT are left untouched. */
26196 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26203 temp_it
.object
= Qnil
;
26204 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26206 if (what
== IT_CONTINUATION
)
26208 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26209 if (it
->bidi_it
.paragraph_dir
== R2L
)
26210 SET_GLYPH_FROM_CHAR (glyph
, '/');
26212 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26214 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26216 /* FIXME: Should we mirror GC for R2L lines? */
26217 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26218 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26221 else if (what
== IT_TRUNCATION
)
26223 /* Truncation glyph. */
26224 SET_GLYPH_FROM_CHAR (glyph
, '$');
26226 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26228 /* FIXME: Should we mirror GC for R2L lines? */
26229 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26230 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26236 #ifdef HAVE_WINDOW_SYSTEM
26237 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26238 is turned off, we precede the truncation/continuation glyphs by a
26239 stretch glyph whose width is computed such that these special
26240 glyphs are aligned at the window margin, even when very different
26241 fonts are used in different glyph rows. */
26242 if (FRAME_WINDOW_P (temp_it
.f
)
26243 /* init_iterator calls this with it->glyph_row == NULL, and it
26244 wants only the pixel width of the truncation/continuation
26246 && temp_it
.glyph_row
26247 /* insert_left_trunc_glyphs calls us at the beginning of the
26248 row, and it has its own calculation of the stretch glyph
26250 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26251 && (temp_it
.glyph_row
->reversed_p
26252 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26253 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26255 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26257 if (stretch_width
> 0)
26259 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26260 struct font
*font
=
26261 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26262 int stretch_ascent
=
26263 (((temp_it
.ascent
+ temp_it
.descent
)
26264 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26266 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26267 temp_it
.ascent
+ temp_it
.descent
,
26274 temp_it
.what
= IT_CHARACTER
;
26275 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26276 temp_it
.face_id
= GLYPH_FACE (glyph
);
26277 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26279 PRODUCE_GLYPHS (&temp_it
);
26280 it
->pixel_width
= temp_it
.pixel_width
;
26281 it
->nglyphs
= temp_it
.nglyphs
;
26284 #ifdef HAVE_WINDOW_SYSTEM
26286 /* Calculate line-height and line-spacing properties.
26287 An integer value specifies explicit pixel value.
26288 A float value specifies relative value to current face height.
26289 A cons (float . face-name) specifies relative value to
26290 height of specified face font.
26292 Returns height in pixels, or nil. */
26296 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26297 int boff
, int override
)
26299 Lisp_Object face_name
= Qnil
;
26300 int ascent
, descent
, height
;
26302 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26307 face_name
= XCAR (val
);
26309 if (!NUMBERP (val
))
26310 val
= make_number (1);
26311 if (NILP (face_name
))
26313 height
= it
->ascent
+ it
->descent
;
26318 if (NILP (face_name
))
26320 font
= FRAME_FONT (it
->f
);
26321 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26323 else if (EQ (face_name
, Qt
))
26332 face_id
= lookup_named_face (it
->f
, face_name
, 0);
26334 return make_number (-1);
26336 face
= FACE_FROM_ID (it
->f
, face_id
);
26339 return make_number (-1);
26340 boff
= font
->baseline_offset
;
26341 if (font
->vertical_centering
)
26342 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26345 ascent
= FONT_BASE (font
) + boff
;
26346 descent
= FONT_DESCENT (font
) - boff
;
26350 it
->override_ascent
= ascent
;
26351 it
->override_descent
= descent
;
26352 it
->override_boff
= boff
;
26355 height
= ascent
+ descent
;
26359 height
= (int)(XFLOAT_DATA (val
) * height
);
26360 else if (INTEGERP (val
))
26361 height
*= XINT (val
);
26363 return make_number (height
);
26367 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26368 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
26369 and only if this is for a character for which no font was found.
26371 If the display method (it->glyphless_method) is
26372 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26373 length of the acronym or the hexadecimal string, UPPER_XOFF and
26374 UPPER_YOFF are pixel offsets for the upper part of the string,
26375 LOWER_XOFF and LOWER_YOFF are for the lower part.
26377 For the other display methods, LEN through LOWER_YOFF are zero. */
26380 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
26381 short upper_xoff
, short upper_yoff
,
26382 short lower_xoff
, short lower_yoff
)
26384 struct glyph
*glyph
;
26385 enum glyph_row_area area
= it
->area
;
26387 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26388 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26390 /* If the glyph row is reversed, we need to prepend the glyph
26391 rather than append it. */
26392 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26396 /* Make room for the additional glyph. */
26397 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26399 glyph
= it
->glyph_row
->glyphs
[area
];
26401 glyph
->charpos
= CHARPOS (it
->position
);
26402 glyph
->object
= it
->object
;
26403 glyph
->pixel_width
= it
->pixel_width
;
26404 glyph
->ascent
= it
->ascent
;
26405 glyph
->descent
= it
->descent
;
26406 glyph
->voffset
= it
->voffset
;
26407 glyph
->type
= GLYPHLESS_GLYPH
;
26408 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26409 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26410 glyph
->u
.glyphless
.len
= len
;
26411 glyph
->u
.glyphless
.ch
= it
->c
;
26412 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26413 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26414 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26415 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26416 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26417 glyph
->multibyte_p
= it
->multibyte_p
;
26418 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26420 /* In R2L rows, the left and the right box edges need to be
26421 drawn in reverse direction. */
26422 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26423 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26427 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26428 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26430 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26431 || it
->phys_descent
> it
->descent
);
26432 glyph
->padding_p
= 0;
26433 glyph
->glyph_not_available_p
= 0;
26434 glyph
->face_id
= face_id
;
26435 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26438 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26439 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26440 glyph
->bidi_type
= it
->bidi_it
.type
;
26442 ++it
->glyph_row
->used
[area
];
26445 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26449 /* Produce a glyph for a glyphless character for iterator IT.
26450 IT->glyphless_method specifies which method to use for displaying
26451 the character. See the description of enum
26452 glyphless_display_method in dispextern.h for the detail.
26454 FOR_NO_FONT is nonzero if and only if this is for a character for
26455 which no font was found. ACRONYM, if non-nil, is an acronym string
26456 for the character. */
26459 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
26464 int base_width
, base_height
, width
, height
;
26465 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26468 /* Get the metrics of the base font. We always refer to the current
26470 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26471 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26472 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
26473 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
26474 base_height
= it
->ascent
+ it
->descent
;
26475 base_width
= font
->average_width
;
26477 face_id
= merge_glyphless_glyph_face (it
);
26479 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26481 it
->pixel_width
= THIN_SPACE_WIDTH
;
26483 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26485 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26487 width
= CHAR_WIDTH (it
->c
);
26490 else if (width
> 4)
26492 it
->pixel_width
= base_width
* width
;
26494 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26500 unsigned int code
[6];
26502 int ascent
, descent
;
26503 struct font_metrics metrics_upper
, metrics_lower
;
26505 face
= FACE_FROM_ID (it
->f
, face_id
);
26506 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26507 prepare_face_for_display (it
->f
, face
);
26509 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26511 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26512 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26513 if (CONSP (acronym
))
26514 acronym
= XCAR (acronym
);
26515 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26519 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26520 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26523 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26524 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26525 upper_len
= (len
+ 1) / 2;
26526 font
->driver
->text_extents (font
, code
, upper_len
,
26528 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26533 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26534 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26535 upper_xoff
= upper_yoff
= 2; /* the typical case */
26536 if (base_width
>= width
)
26538 /* Align the upper to the left, the lower to the right. */
26539 it
->pixel_width
= base_width
;
26540 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26544 /* Center the shorter one. */
26545 it
->pixel_width
= width
;
26546 if (metrics_upper
.width
>= metrics_lower
.width
)
26547 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26550 /* FIXME: This code doesn't look right. It formerly was
26551 missing the "lower_xoff = 0;", which couldn't have
26552 been right since it left lower_xoff uninitialized. */
26554 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26558 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26559 top, bottom, and between upper and lower strings. */
26560 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26561 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26562 /* Center vertically.
26563 H:base_height, D:base_descent
26564 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26566 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26567 descent = D - H/2 + h/2;
26568 lower_yoff = descent - 2 - ld;
26569 upper_yoff = lower_yoff - la - 1 - ud; */
26570 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26571 descent
= it
->descent
- (base_height
- height
) / 2;
26572 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26573 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26574 - metrics_upper
.descent
);
26575 /* Don't make the height shorter than the base height. */
26576 if (height
> base_height
)
26578 it
->ascent
= ascent
;
26579 it
->descent
= descent
;
26583 it
->phys_ascent
= it
->ascent
;
26584 it
->phys_descent
= it
->descent
;
26586 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26587 upper_xoff
, upper_yoff
,
26588 lower_xoff
, lower_yoff
);
26590 take_vertical_position_into_account (it
);
26595 Produce glyphs/get display metrics for the display element IT is
26596 loaded with. See the description of struct it in dispextern.h
26597 for an overview of struct it. */
26600 x_produce_glyphs (struct it
*it
)
26602 int extra_line_spacing
= it
->extra_line_spacing
;
26604 it
->glyph_not_available_p
= 0;
26606 if (it
->what
== IT_CHARACTER
)
26609 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26610 struct font
*font
= face
->font
;
26611 struct font_metrics
*pcm
= NULL
;
26612 int boff
; /* Baseline offset. */
26616 /* When no suitable font is found, display this character by
26617 the method specified in the first extra slot of
26618 Vglyphless_char_display. */
26619 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26621 eassert (it
->what
== IT_GLYPHLESS
);
26622 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26626 boff
= font
->baseline_offset
;
26627 if (font
->vertical_centering
)
26628 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26630 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26636 if (it
->override_ascent
>= 0)
26638 it
->ascent
= it
->override_ascent
;
26639 it
->descent
= it
->override_descent
;
26640 boff
= it
->override_boff
;
26644 it
->ascent
= FONT_BASE (font
) + boff
;
26645 it
->descent
= FONT_DESCENT (font
) - boff
;
26648 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26650 pcm
= get_per_char_metric (font
, &char2b
);
26651 if (pcm
->width
== 0
26652 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26658 it
->phys_ascent
= pcm
->ascent
+ boff
;
26659 it
->phys_descent
= pcm
->descent
- boff
;
26660 it
->pixel_width
= pcm
->width
;
26664 it
->glyph_not_available_p
= 1;
26665 it
->phys_ascent
= it
->ascent
;
26666 it
->phys_descent
= it
->descent
;
26667 it
->pixel_width
= font
->space_width
;
26670 if (it
->constrain_row_ascent_descent_p
)
26672 if (it
->descent
> it
->max_descent
)
26674 it
->ascent
+= it
->descent
- it
->max_descent
;
26675 it
->descent
= it
->max_descent
;
26677 if (it
->ascent
> it
->max_ascent
)
26679 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26680 it
->ascent
= it
->max_ascent
;
26682 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26683 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26684 extra_line_spacing
= 0;
26687 /* If this is a space inside a region of text with
26688 `space-width' property, change its width. */
26689 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26691 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26693 /* If face has a box, add the box thickness to the character
26694 height. If character has a box line to the left and/or
26695 right, add the box line width to the character's width. */
26696 if (face
->box
!= FACE_NO_BOX
)
26698 int thick
= face
->box_line_width
;
26702 it
->ascent
+= thick
;
26703 it
->descent
+= thick
;
26708 if (it
->start_of_box_run_p
)
26709 it
->pixel_width
+= thick
;
26710 if (it
->end_of_box_run_p
)
26711 it
->pixel_width
+= thick
;
26714 /* If face has an overline, add the height of the overline
26715 (1 pixel) and a 1 pixel margin to the character height. */
26716 if (face
->overline_p
)
26717 it
->ascent
+= overline_margin
;
26719 if (it
->constrain_row_ascent_descent_p
)
26721 if (it
->ascent
> it
->max_ascent
)
26722 it
->ascent
= it
->max_ascent
;
26723 if (it
->descent
> it
->max_descent
)
26724 it
->descent
= it
->max_descent
;
26727 take_vertical_position_into_account (it
);
26729 /* If we have to actually produce glyphs, do it. */
26734 /* Translate a space with a `space-width' property
26735 into a stretch glyph. */
26736 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26737 / FONT_HEIGHT (font
));
26738 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26739 it
->ascent
+ it
->descent
, ascent
);
26744 /* If characters with lbearing or rbearing are displayed
26745 in this line, record that fact in a flag of the
26746 glyph row. This is used to optimize X output code. */
26747 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26748 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26750 if (! stretched_p
&& it
->pixel_width
== 0)
26751 /* We assure that all visible glyphs have at least 1-pixel
26753 it
->pixel_width
= 1;
26755 else if (it
->char_to_display
== '\n')
26757 /* A newline has no width, but we need the height of the
26758 line. But if previous part of the line sets a height,
26759 don't increase that height. */
26761 Lisp_Object height
;
26762 Lisp_Object total_height
= Qnil
;
26764 it
->override_ascent
= -1;
26765 it
->pixel_width
= 0;
26768 height
= get_it_property (it
, Qline_height
);
26769 /* Split (line-height total-height) list. */
26771 && CONSP (XCDR (height
))
26772 && NILP (XCDR (XCDR (height
))))
26774 total_height
= XCAR (XCDR (height
));
26775 height
= XCAR (height
);
26777 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26779 if (it
->override_ascent
>= 0)
26781 it
->ascent
= it
->override_ascent
;
26782 it
->descent
= it
->override_descent
;
26783 boff
= it
->override_boff
;
26787 it
->ascent
= FONT_BASE (font
) + boff
;
26788 it
->descent
= FONT_DESCENT (font
) - boff
;
26791 if (EQ (height
, Qt
))
26793 if (it
->descent
> it
->max_descent
)
26795 it
->ascent
+= it
->descent
- it
->max_descent
;
26796 it
->descent
= it
->max_descent
;
26798 if (it
->ascent
> it
->max_ascent
)
26800 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26801 it
->ascent
= it
->max_ascent
;
26803 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26804 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26805 it
->constrain_row_ascent_descent_p
= 1;
26806 extra_line_spacing
= 0;
26810 Lisp_Object spacing
;
26812 it
->phys_ascent
= it
->ascent
;
26813 it
->phys_descent
= it
->descent
;
26815 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26816 && face
->box
!= FACE_NO_BOX
26817 && face
->box_line_width
> 0)
26819 it
->ascent
+= face
->box_line_width
;
26820 it
->descent
+= face
->box_line_width
;
26823 && XINT (height
) > it
->ascent
+ it
->descent
)
26824 it
->ascent
= XINT (height
) - it
->descent
;
26826 if (!NILP (total_height
))
26827 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26830 spacing
= get_it_property (it
, Qline_spacing
);
26831 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26833 if (INTEGERP (spacing
))
26835 extra_line_spacing
= XINT (spacing
);
26836 if (!NILP (total_height
))
26837 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26841 else /* i.e. (it->char_to_display == '\t') */
26843 if (font
->space_width
> 0)
26845 int tab_width
= it
->tab_width
* font
->space_width
;
26846 int x
= it
->current_x
+ it
->continuation_lines_width
;
26847 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26849 /* If the distance from the current position to the next tab
26850 stop is less than a space character width, use the
26851 tab stop after that. */
26852 if (next_tab_x
- x
< font
->space_width
)
26853 next_tab_x
+= tab_width
;
26855 it
->pixel_width
= next_tab_x
- x
;
26857 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26858 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26862 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26863 it
->ascent
+ it
->descent
, it
->ascent
);
26868 it
->pixel_width
= 0;
26873 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26875 /* A static composition.
26877 Note: A composition is represented as one glyph in the
26878 glyph matrix. There are no padding glyphs.
26880 Important note: pixel_width, ascent, and descent are the
26881 values of what is drawn by draw_glyphs (i.e. the values of
26882 the overall glyphs composed). */
26883 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26884 int boff
; /* baseline offset */
26885 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26886 int glyph_len
= cmp
->glyph_len
;
26887 struct font
*font
= face
->font
;
26891 /* If we have not yet calculated pixel size data of glyphs of
26892 the composition for the current face font, calculate them
26893 now. Theoretically, we have to check all fonts for the
26894 glyphs, but that requires much time and memory space. So,
26895 here we check only the font of the first glyph. This may
26896 lead to incorrect display, but it's very rare, and C-l
26897 (recenter-top-bottom) can correct the display anyway. */
26898 if (! cmp
->font
|| cmp
->font
!= font
)
26900 /* Ascent and descent of the font of the first character
26901 of this composition (adjusted by baseline offset).
26902 Ascent and descent of overall glyphs should not be less
26903 than these, respectively. */
26904 int font_ascent
, font_descent
, font_height
;
26905 /* Bounding box of the overall glyphs. */
26906 int leftmost
, rightmost
, lowest
, highest
;
26907 int lbearing
, rbearing
;
26908 int i
, width
, ascent
, descent
;
26909 int left_padded
= 0, right_padded
= 0;
26910 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26912 struct font_metrics
*pcm
;
26913 int font_not_found_p
;
26916 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26917 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26919 if (glyph_len
< cmp
->glyph_len
)
26921 for (i
= 0; i
< glyph_len
; i
++)
26923 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26925 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26930 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26931 : IT_CHARPOS (*it
));
26932 /* If no suitable font is found, use the default font. */
26933 font_not_found_p
= font
== NULL
;
26934 if (font_not_found_p
)
26936 face
= face
->ascii_face
;
26939 boff
= font
->baseline_offset
;
26940 if (font
->vertical_centering
)
26941 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26942 font_ascent
= FONT_BASE (font
) + boff
;
26943 font_descent
= FONT_DESCENT (font
) - boff
;
26944 font_height
= FONT_HEIGHT (font
);
26949 if (! font_not_found_p
)
26951 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26953 pcm
= get_per_char_metric (font
, &char2b
);
26956 /* Initialize the bounding box. */
26959 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26960 ascent
= pcm
->ascent
;
26961 descent
= pcm
->descent
;
26962 lbearing
= pcm
->lbearing
;
26963 rbearing
= pcm
->rbearing
;
26967 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26968 ascent
= FONT_BASE (font
);
26969 descent
= FONT_DESCENT (font
);
26976 lowest
= - descent
+ boff
;
26977 highest
= ascent
+ boff
;
26979 if (! font_not_found_p
26980 && font
->default_ascent
26981 && CHAR_TABLE_P (Vuse_default_ascent
)
26982 && !NILP (Faref (Vuse_default_ascent
,
26983 make_number (it
->char_to_display
))))
26984 highest
= font
->default_ascent
+ boff
;
26986 /* Draw the first glyph at the normal position. It may be
26987 shifted to right later if some other glyphs are drawn
26989 cmp
->offsets
[i
* 2] = 0;
26990 cmp
->offsets
[i
* 2 + 1] = boff
;
26991 cmp
->lbearing
= lbearing
;
26992 cmp
->rbearing
= rbearing
;
26994 /* Set cmp->offsets for the remaining glyphs. */
26995 for (i
++; i
< glyph_len
; i
++)
26997 int left
, right
, btm
, top
;
26998 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27000 struct face
*this_face
;
27004 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27005 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27006 font
= this_face
->font
;
27012 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27014 pcm
= get_per_char_metric (font
, &char2b
);
27017 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27020 width
= pcm
->width
;
27021 ascent
= pcm
->ascent
;
27022 descent
= pcm
->descent
;
27023 lbearing
= pcm
->lbearing
;
27024 rbearing
= pcm
->rbearing
;
27025 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27027 /* Relative composition with or without
27028 alternate chars. */
27029 left
= (leftmost
+ rightmost
- width
) / 2;
27030 btm
= - descent
+ boff
;
27031 if (font
->relative_compose
27032 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27033 || NILP (Faref (Vignore_relative_composition
,
27034 make_number (ch
)))))
27037 if (- descent
>= font
->relative_compose
)
27038 /* One extra pixel between two glyphs. */
27040 else if (ascent
<= 0)
27041 /* One extra pixel between two glyphs. */
27042 btm
= lowest
- 1 - ascent
- descent
;
27047 /* A composition rule is specified by an integer
27048 value that encodes global and new reference
27049 points (GREF and NREF). GREF and NREF are
27050 specified by numbers as below:
27052 0---1---2 -- ascent
27056 9--10--11 -- center
27058 ---3---4---5--- baseline
27060 6---7---8 -- descent
27062 int rule
= COMPOSITION_RULE (cmp
, i
);
27063 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27065 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27066 grefx
= gref
% 3, nrefx
= nref
% 3;
27067 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27069 xoff
= font_height
* (xoff
- 128) / 256;
27071 yoff
= font_height
* (yoff
- 128) / 256;
27074 + grefx
* (rightmost
- leftmost
) / 2
27075 - nrefx
* width
/ 2
27078 btm
= ((grefy
== 0 ? highest
27080 : grefy
== 2 ? lowest
27081 : (highest
+ lowest
) / 2)
27082 - (nrefy
== 0 ? ascent
+ descent
27083 : nrefy
== 1 ? descent
- boff
27085 : (ascent
+ descent
) / 2)
27089 cmp
->offsets
[i
* 2] = left
;
27090 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27092 /* Update the bounding box of the overall glyphs. */
27095 right
= left
+ width
;
27096 if (left
< leftmost
)
27098 if (right
> rightmost
)
27101 top
= btm
+ descent
+ ascent
;
27107 if (cmp
->lbearing
> left
+ lbearing
)
27108 cmp
->lbearing
= left
+ lbearing
;
27109 if (cmp
->rbearing
< left
+ rbearing
)
27110 cmp
->rbearing
= left
+ rbearing
;
27114 /* If there are glyphs whose x-offsets are negative,
27115 shift all glyphs to the right and make all x-offsets
27119 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27120 cmp
->offsets
[i
* 2] -= leftmost
;
27121 rightmost
-= leftmost
;
27122 cmp
->lbearing
-= leftmost
;
27123 cmp
->rbearing
-= leftmost
;
27126 if (left_padded
&& cmp
->lbearing
< 0)
27128 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27129 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27130 rightmost
-= cmp
->lbearing
;
27131 cmp
->rbearing
-= cmp
->lbearing
;
27134 if (right_padded
&& rightmost
< cmp
->rbearing
)
27136 rightmost
= cmp
->rbearing
;
27139 cmp
->pixel_width
= rightmost
;
27140 cmp
->ascent
= highest
;
27141 cmp
->descent
= - lowest
;
27142 if (cmp
->ascent
< font_ascent
)
27143 cmp
->ascent
= font_ascent
;
27144 if (cmp
->descent
< font_descent
)
27145 cmp
->descent
= font_descent
;
27149 && (cmp
->lbearing
< 0
27150 || cmp
->rbearing
> cmp
->pixel_width
))
27151 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
27153 it
->pixel_width
= cmp
->pixel_width
;
27154 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27155 it
->descent
= it
->phys_descent
= cmp
->descent
;
27156 if (face
->box
!= FACE_NO_BOX
)
27158 int thick
= face
->box_line_width
;
27162 it
->ascent
+= thick
;
27163 it
->descent
+= thick
;
27168 if (it
->start_of_box_run_p
)
27169 it
->pixel_width
+= thick
;
27170 if (it
->end_of_box_run_p
)
27171 it
->pixel_width
+= thick
;
27174 /* If face has an overline, add the height of the overline
27175 (1 pixel) and a 1 pixel margin to the character height. */
27176 if (face
->overline_p
)
27177 it
->ascent
+= overline_margin
;
27179 take_vertical_position_into_account (it
);
27180 if (it
->ascent
< 0)
27182 if (it
->descent
< 0)
27185 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27186 append_composite_glyph (it
);
27188 else if (it
->what
== IT_COMPOSITION
)
27190 /* A dynamic (automatic) composition. */
27191 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27192 Lisp_Object gstring
;
27193 struct font_metrics metrics
;
27197 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27199 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27202 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27203 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
27204 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27205 it
->descent
= it
->phys_descent
= metrics
.descent
;
27206 if (face
->box
!= FACE_NO_BOX
)
27208 int thick
= face
->box_line_width
;
27212 it
->ascent
+= thick
;
27213 it
->descent
+= thick
;
27218 if (it
->start_of_box_run_p
)
27219 it
->pixel_width
+= thick
;
27220 if (it
->end_of_box_run_p
)
27221 it
->pixel_width
+= thick
;
27223 /* If face has an overline, add the height of the overline
27224 (1 pixel) and a 1 pixel margin to the character height. */
27225 if (face
->overline_p
)
27226 it
->ascent
+= overline_margin
;
27227 take_vertical_position_into_account (it
);
27228 if (it
->ascent
< 0)
27230 if (it
->descent
< 0)
27234 append_composite_glyph (it
);
27236 else if (it
->what
== IT_GLYPHLESS
)
27237 produce_glyphless_glyph (it
, 0, Qnil
);
27238 else if (it
->what
== IT_IMAGE
)
27239 produce_image_glyph (it
);
27240 else if (it
->what
== IT_STRETCH
)
27241 produce_stretch_glyph (it
);
27242 #ifdef HAVE_XWIDGETS
27243 else if (it
->what
== IT_XWIDGET
)
27244 produce_xwidget_glyph (it
);
27248 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27249 because this isn't true for images with `:ascent 100'. */
27250 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27251 if (it
->area
== TEXT_AREA
)
27252 it
->current_x
+= it
->pixel_width
;
27254 if (extra_line_spacing
> 0)
27256 it
->descent
+= extra_line_spacing
;
27257 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27258 it
->max_extra_line_spacing
= extra_line_spacing
;
27261 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27262 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27263 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27264 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27268 Output LEN glyphs starting at START at the nominal cursor position.
27269 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27270 being updated, and UPDATED_AREA is the area of that row being updated. */
27273 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27274 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27276 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27278 eassert (updated_row
);
27279 /* When the window is hscrolled, cursor hpos can legitimately be out
27280 of bounds, but we draw the cursor at the corresponding window
27281 margin in that case. */
27282 if (!updated_row
->reversed_p
&& chpos
< 0)
27284 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27285 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27289 /* Write glyphs. */
27291 hpos
= start
- updated_row
->glyphs
[updated_area
];
27292 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27293 updated_row
, updated_area
,
27295 DRAW_NORMAL_TEXT
, 0);
27297 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27298 if (updated_area
== TEXT_AREA
27299 && w
->phys_cursor_on_p
27300 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27302 && chpos
< hpos
+ len
)
27303 w
->phys_cursor_on_p
= 0;
27307 /* Advance the output cursor. */
27308 w
->output_cursor
.hpos
+= len
;
27309 w
->output_cursor
.x
= x
;
27314 Insert LEN glyphs from START at the nominal cursor position. */
27317 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27318 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27321 int line_height
, shift_by_width
, shifted_region_width
;
27322 struct glyph_row
*row
;
27323 struct glyph
*glyph
;
27324 int frame_x
, frame_y
;
27327 eassert (updated_row
);
27329 f
= XFRAME (WINDOW_FRAME (w
));
27331 /* Get the height of the line we are in. */
27333 line_height
= row
->height
;
27335 /* Get the width of the glyphs to insert. */
27336 shift_by_width
= 0;
27337 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27338 shift_by_width
+= glyph
->pixel_width
;
27340 /* Get the width of the region to shift right. */
27341 shifted_region_width
= (window_box_width (w
, updated_area
)
27342 - w
->output_cursor
.x
27346 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27347 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27349 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27350 line_height
, shift_by_width
);
27352 /* Write the glyphs. */
27353 hpos
= start
- row
->glyphs
[updated_area
];
27354 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27356 DRAW_NORMAL_TEXT
, 0);
27358 /* Advance the output cursor. */
27359 w
->output_cursor
.hpos
+= len
;
27360 w
->output_cursor
.x
+= shift_by_width
;
27366 Erase the current text line from the nominal cursor position
27367 (inclusive) to pixel column TO_X (exclusive). The idea is that
27368 everything from TO_X onward is already erased.
27370 TO_X is a pixel position relative to UPDATED_AREA of currently
27371 updated window W. TO_X == -1 means clear to the end of this area. */
27374 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27375 enum glyph_row_area updated_area
, int to_x
)
27378 int max_x
, min_y
, max_y
;
27379 int from_x
, from_y
, to_y
;
27381 eassert (updated_row
);
27382 f
= XFRAME (w
->frame
);
27384 if (updated_row
->full_width_p
)
27385 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27386 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27388 max_x
= window_box_width (w
, updated_area
);
27389 max_y
= window_text_bottom_y (w
);
27391 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27392 of window. For TO_X > 0, truncate to end of drawing area. */
27398 to_x
= min (to_x
, max_x
);
27400 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27402 /* Notice if the cursor will be cleared by this operation. */
27403 if (!updated_row
->full_width_p
)
27404 notice_overwritten_cursor (w
, updated_area
,
27405 w
->output_cursor
.x
, -1,
27407 MATRIX_ROW_BOTTOM_Y (updated_row
));
27409 from_x
= w
->output_cursor
.x
;
27411 /* Translate to frame coordinates. */
27412 if (updated_row
->full_width_p
)
27414 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27415 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27419 int area_left
= window_box_left (w
, updated_area
);
27420 from_x
+= area_left
;
27424 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27425 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27426 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27428 /* Prevent inadvertently clearing to end of the X window. */
27429 if (to_x
> from_x
&& to_y
> from_y
)
27432 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27433 to_x
- from_x
, to_y
- from_y
);
27438 #endif /* HAVE_WINDOW_SYSTEM */
27442 /***********************************************************************
27444 ***********************************************************************/
27446 /* Value is the internal representation of the specified cursor type
27447 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27448 of the bar cursor. */
27450 static enum text_cursor_kinds
27451 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27453 enum text_cursor_kinds type
;
27458 if (EQ (arg
, Qbox
))
27459 return FILLED_BOX_CURSOR
;
27461 if (EQ (arg
, Qhollow
))
27462 return HOLLOW_BOX_CURSOR
;
27464 if (EQ (arg
, Qbar
))
27471 && EQ (XCAR (arg
), Qbar
)
27472 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27474 *width
= XINT (XCDR (arg
));
27478 if (EQ (arg
, Qhbar
))
27481 return HBAR_CURSOR
;
27485 && EQ (XCAR (arg
), Qhbar
)
27486 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27488 *width
= XINT (XCDR (arg
));
27489 return HBAR_CURSOR
;
27492 /* Treat anything unknown as "hollow box cursor".
27493 It was bad to signal an error; people have trouble fixing
27494 .Xdefaults with Emacs, when it has something bad in it. */
27495 type
= HOLLOW_BOX_CURSOR
;
27500 /* Set the default cursor types for specified frame. */
27502 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27507 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27508 FRAME_CURSOR_WIDTH (f
) = width
;
27510 /* By default, set up the blink-off state depending on the on-state. */
27512 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27515 FRAME_BLINK_OFF_CURSOR (f
)
27516 = get_specified_cursor_type (XCDR (tem
), &width
);
27517 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27520 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27522 /* Make sure the cursor gets redrawn. */
27523 f
->cursor_type_changed
= 1;
27527 #ifdef HAVE_WINDOW_SYSTEM
27529 /* Return the cursor we want to be displayed in window W. Return
27530 width of bar/hbar cursor through WIDTH arg. Return with
27531 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27532 (i.e. if the `system caret' should track this cursor).
27534 In a mini-buffer window, we want the cursor only to appear if we
27535 are reading input from this window. For the selected window, we
27536 want the cursor type given by the frame parameter or buffer local
27537 setting of cursor-type. If explicitly marked off, draw no cursor.
27538 In all other cases, we want a hollow box cursor. */
27540 static enum text_cursor_kinds
27541 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27542 int *active_cursor
)
27544 struct frame
*f
= XFRAME (w
->frame
);
27545 struct buffer
*b
= XBUFFER (w
->contents
);
27546 int cursor_type
= DEFAULT_CURSOR
;
27547 Lisp_Object alt_cursor
;
27548 int non_selected
= 0;
27550 *active_cursor
= 1;
27553 if (cursor_in_echo_area
27554 && FRAME_HAS_MINIBUF_P (f
)
27555 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27557 if (w
== XWINDOW (echo_area_window
))
27559 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27561 *width
= FRAME_CURSOR_WIDTH (f
);
27562 return FRAME_DESIRED_CURSOR (f
);
27565 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27568 *active_cursor
= 0;
27572 /* Detect a nonselected window or nonselected frame. */
27573 else if (w
!= XWINDOW (f
->selected_window
)
27574 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27576 *active_cursor
= 0;
27578 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27584 /* Never display a cursor in a window in which cursor-type is nil. */
27585 if (NILP (BVAR (b
, cursor_type
)))
27588 /* Get the normal cursor type for this window. */
27589 if (EQ (BVAR (b
, cursor_type
), Qt
))
27591 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27592 *width
= FRAME_CURSOR_WIDTH (f
);
27595 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27597 /* Use cursor-in-non-selected-windows instead
27598 for non-selected window or frame. */
27601 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27602 if (!EQ (Qt
, alt_cursor
))
27603 return get_specified_cursor_type (alt_cursor
, width
);
27604 /* t means modify the normal cursor type. */
27605 if (cursor_type
== FILLED_BOX_CURSOR
)
27606 cursor_type
= HOLLOW_BOX_CURSOR
;
27607 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27609 return cursor_type
;
27612 /* Use normal cursor if not blinked off. */
27613 if (!w
->cursor_off_p
)
27616 #ifdef HAVE_XWIDGETS
27617 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
){
27618 //printf("attempt xwidget cursor avoidance in get_window_cursor_type\n");
27622 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27624 if (cursor_type
== FILLED_BOX_CURSOR
)
27626 /* Using a block cursor on large images can be very annoying.
27627 So use a hollow cursor for "large" images.
27628 If image is not transparent (no mask), also use hollow cursor. */
27629 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27630 if (img
!= NULL
&& IMAGEP (img
->spec
))
27632 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27633 where N = size of default frame font size.
27634 This should cover most of the "tiny" icons people may use. */
27636 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27637 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27638 cursor_type
= HOLLOW_BOX_CURSOR
;
27641 else if (cursor_type
!= NO_CURSOR
)
27643 /* Display current only supports BOX and HOLLOW cursors for images.
27644 So for now, unconditionally use a HOLLOW cursor when cursor is
27645 not a solid box cursor. */
27646 cursor_type
= HOLLOW_BOX_CURSOR
;
27649 return cursor_type
;
27652 /* Cursor is blinked off, so determine how to "toggle" it. */
27654 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27655 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27656 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27658 /* Then see if frame has specified a specific blink off cursor type. */
27659 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27661 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27662 return FRAME_BLINK_OFF_CURSOR (f
);
27666 /* Some people liked having a permanently visible blinking cursor,
27667 while others had very strong opinions against it. So it was
27668 decided to remove it. KFS 2003-09-03 */
27670 /* Finally perform built-in cursor blinking:
27671 filled box <-> hollow box
27672 wide [h]bar <-> narrow [h]bar
27673 narrow [h]bar <-> no cursor
27674 other type <-> no cursor */
27676 if (cursor_type
== FILLED_BOX_CURSOR
)
27677 return HOLLOW_BOX_CURSOR
;
27679 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27682 return cursor_type
;
27690 /* Notice when the text cursor of window W has been completely
27691 overwritten by a drawing operation that outputs glyphs in AREA
27692 starting at X0 and ending at X1 in the line starting at Y0 and
27693 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27694 the rest of the line after X0 has been written. Y coordinates
27695 are window-relative. */
27698 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27699 int x0
, int x1
, int y0
, int y1
)
27701 int cx0
, cx1
, cy0
, cy1
;
27702 struct glyph_row
*row
;
27704 if (!w
->phys_cursor_on_p
)
27706 if (area
!= TEXT_AREA
)
27709 if (w
->phys_cursor
.vpos
< 0
27710 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27711 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27712 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27715 if (row
->cursor_in_fringe_p
)
27717 row
->cursor_in_fringe_p
= 0;
27718 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27719 w
->phys_cursor_on_p
= 0;
27723 cx0
= w
->phys_cursor
.x
;
27724 cx1
= cx0
+ w
->phys_cursor_width
;
27725 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27728 /* The cursor image will be completely removed from the
27729 screen if the output area intersects the cursor area in
27730 y-direction. When we draw in [y0 y1[, and some part of
27731 the cursor is at y < y0, that part must have been drawn
27732 before. When scrolling, the cursor is erased before
27733 actually scrolling, so we don't come here. When not
27734 scrolling, the rows above the old cursor row must have
27735 changed, and in this case these rows must have written
27736 over the cursor image.
27738 Likewise if part of the cursor is below y1, with the
27739 exception of the cursor being in the first blank row at
27740 the buffer and window end because update_text_area
27741 doesn't draw that row. (Except when it does, but
27742 that's handled in update_text_area.) */
27744 cy0
= w
->phys_cursor
.y
;
27745 cy1
= cy0
+ w
->phys_cursor_height
;
27746 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27749 w
->phys_cursor_on_p
= 0;
27752 #endif /* HAVE_WINDOW_SYSTEM */
27755 /************************************************************************
27757 ************************************************************************/
27759 #ifdef HAVE_WINDOW_SYSTEM
27762 Fix the display of area AREA of overlapping row ROW in window W
27763 with respect to the overlapping part OVERLAPS. */
27766 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27767 enum glyph_row_area area
, int overlaps
)
27774 for (i
= 0; i
< row
->used
[area
];)
27776 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27778 int start
= i
, start_x
= x
;
27782 x
+= row
->glyphs
[area
][i
].pixel_width
;
27785 while (i
< row
->used
[area
]
27786 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27788 draw_glyphs (w
, start_x
, row
, area
,
27790 DRAW_NORMAL_TEXT
, overlaps
);
27794 x
+= row
->glyphs
[area
][i
].pixel_width
;
27804 Draw the cursor glyph of window W in glyph row ROW. See the
27805 comment of draw_glyphs for the meaning of HL. */
27808 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27809 enum draw_glyphs_face hl
)
27811 /* If cursor hpos is out of bounds, don't draw garbage. This can
27812 happen in mini-buffer windows when switching between echo area
27813 glyphs and mini-buffer. */
27814 if ((row
->reversed_p
27815 ? (w
->phys_cursor
.hpos
>= 0)
27816 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27818 int on_p
= w
->phys_cursor_on_p
;
27820 int hpos
= w
->phys_cursor
.hpos
;
27822 /* When the window is hscrolled, cursor hpos can legitimately be
27823 out of bounds, but we draw the cursor at the corresponding
27824 window margin in that case. */
27825 if (!row
->reversed_p
&& hpos
< 0)
27827 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27828 hpos
= row
->used
[TEXT_AREA
] - 1;
27830 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27832 w
->phys_cursor_on_p
= on_p
;
27834 if (hl
== DRAW_CURSOR
)
27835 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27836 /* When we erase the cursor, and ROW is overlapped by other
27837 rows, make sure that these overlapping parts of other rows
27839 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27841 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27843 if (row
> w
->current_matrix
->rows
27844 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27845 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27846 OVERLAPS_ERASED_CURSOR
);
27848 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27849 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27850 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27851 OVERLAPS_ERASED_CURSOR
);
27857 /* Erase the image of a cursor of window W from the screen. */
27860 erase_phys_cursor (struct window
*w
)
27862 struct frame
*f
= XFRAME (w
->frame
);
27863 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27864 int hpos
= w
->phys_cursor
.hpos
;
27865 int vpos
= w
->phys_cursor
.vpos
;
27866 int mouse_face_here_p
= 0;
27867 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27868 struct glyph_row
*cursor_row
;
27869 struct glyph
*cursor_glyph
;
27870 enum draw_glyphs_face hl
;
27872 /* No cursor displayed or row invalidated => nothing to do on the
27874 if (w
->phys_cursor_type
== NO_CURSOR
)
27875 goto mark_cursor_off
;
27877 /* VPOS >= active_glyphs->nrows means that window has been resized.
27878 Don't bother to erase the cursor. */
27879 if (vpos
>= active_glyphs
->nrows
)
27880 goto mark_cursor_off
;
27882 /* If row containing cursor is marked invalid, there is nothing we
27884 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27885 if (!cursor_row
->enabled_p
)
27886 goto mark_cursor_off
;
27888 /* If line spacing is > 0, old cursor may only be partially visible in
27889 window after split-window. So adjust visible height. */
27890 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27891 window_text_bottom_y (w
) - cursor_row
->y
);
27893 /* If row is completely invisible, don't attempt to delete a cursor which
27894 isn't there. This can happen if cursor is at top of a window, and
27895 we switch to a buffer with a header line in that window. */
27896 if (cursor_row
->visible_height
<= 0)
27897 goto mark_cursor_off
;
27899 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27900 if (cursor_row
->cursor_in_fringe_p
)
27902 cursor_row
->cursor_in_fringe_p
= 0;
27903 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27904 goto mark_cursor_off
;
27907 /* This can happen when the new row is shorter than the old one.
27908 In this case, either draw_glyphs or clear_end_of_line
27909 should have cleared the cursor. Note that we wouldn't be
27910 able to erase the cursor in this case because we don't have a
27911 cursor glyph at hand. */
27912 if ((cursor_row
->reversed_p
27913 ? (w
->phys_cursor
.hpos
< 0)
27914 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27915 goto mark_cursor_off
;
27917 /* When the window is hscrolled, cursor hpos can legitimately be out
27918 of bounds, but we draw the cursor at the corresponding window
27919 margin in that case. */
27920 if (!cursor_row
->reversed_p
&& hpos
< 0)
27922 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27923 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27925 /* If the cursor is in the mouse face area, redisplay that when
27926 we clear the cursor. */
27927 if (! NILP (hlinfo
->mouse_face_window
)
27928 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27929 /* Don't redraw the cursor's spot in mouse face if it is at the
27930 end of a line (on a newline). The cursor appears there, but
27931 mouse highlighting does not. */
27932 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27933 mouse_face_here_p
= 1;
27935 /* Maybe clear the display under the cursor. */
27936 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27939 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27942 cursor_glyph
= get_phys_cursor_glyph (w
);
27943 if (cursor_glyph
== NULL
)
27944 goto mark_cursor_off
;
27946 width
= cursor_glyph
->pixel_width
;
27947 x
= w
->phys_cursor
.x
;
27953 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27954 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27955 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27958 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27961 /* Erase the cursor by redrawing the character underneath it. */
27962 if (mouse_face_here_p
)
27963 hl
= DRAW_MOUSE_FACE
;
27965 hl
= DRAW_NORMAL_TEXT
;
27966 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27969 w
->phys_cursor_on_p
= 0;
27970 w
->phys_cursor_type
= NO_CURSOR
;
27975 Display or clear cursor of window W. If ON is zero, clear the
27976 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27977 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27980 display_and_set_cursor (struct window
*w
, bool on
,
27981 int hpos
, int vpos
, int x
, int y
)
27983 struct frame
*f
= XFRAME (w
->frame
);
27984 int new_cursor_type
;
27985 int new_cursor_width
;
27987 struct glyph_row
*glyph_row
;
27988 struct glyph
*glyph
;
27990 /* This is pointless on invisible frames, and dangerous on garbaged
27991 windows and frames; in the latter case, the frame or window may
27992 be in the midst of changing its size, and x and y may be off the
27994 if (! FRAME_VISIBLE_P (f
)
27995 || FRAME_GARBAGED_P (f
)
27996 || vpos
>= w
->current_matrix
->nrows
27997 || hpos
>= w
->current_matrix
->matrix_w
)
28000 /* If cursor is off and we want it off, return quickly. */
28001 if (!on
&& !w
->phys_cursor_on_p
)
28004 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28005 /* If cursor row is not enabled, we don't really know where to
28006 display the cursor. */
28007 if (!glyph_row
->enabled_p
)
28009 w
->phys_cursor_on_p
= 0;
28014 if (!glyph_row
->exact_window_width_line_p
28015 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28016 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28018 eassert (input_blocked_p ());
28020 /* Set new_cursor_type to the cursor we want to be displayed. */
28021 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28022 &new_cursor_width
, &active_cursor
);
28024 /* If cursor is currently being shown and we don't want it to be or
28025 it is in the wrong place, or the cursor type is not what we want,
28027 if (w
->phys_cursor_on_p
28029 || w
->phys_cursor
.x
!= x
28030 || w
->phys_cursor
.y
!= y
28031 /* HPOS can be negative in R2L rows whose
28032 exact_window_width_line_p flag is set (i.e. their newline
28033 would "overflow into the fringe"). */
28035 || new_cursor_type
!= w
->phys_cursor_type
28036 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28037 && new_cursor_width
!= w
->phys_cursor_width
)))
28038 erase_phys_cursor (w
);
28040 /* Don't check phys_cursor_on_p here because that flag is only set
28041 to zero in some cases where we know that the cursor has been
28042 completely erased, to avoid the extra work of erasing the cursor
28043 twice. In other words, phys_cursor_on_p can be 1 and the cursor
28044 still not be visible, or it has only been partly erased. */
28047 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28048 w
->phys_cursor_height
= glyph_row
->height
;
28050 /* Set phys_cursor_.* before x_draw_.* is called because some
28051 of them may need the information. */
28052 w
->phys_cursor
.x
= x
;
28053 w
->phys_cursor
.y
= glyph_row
->y
;
28054 w
->phys_cursor
.hpos
= hpos
;
28055 w
->phys_cursor
.vpos
= vpos
;
28058 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28059 new_cursor_type
, new_cursor_width
,
28060 on
, active_cursor
);
28064 /* Switch the display of W's cursor on or off, according to the value
28068 update_window_cursor (struct window
*w
, bool on
)
28070 /* Don't update cursor in windows whose frame is in the process
28071 of being deleted. */
28072 if (w
->current_matrix
)
28074 int hpos
= w
->phys_cursor
.hpos
;
28075 int vpos
= w
->phys_cursor
.vpos
;
28076 struct glyph_row
*row
;
28078 if (vpos
>= w
->current_matrix
->nrows
28079 || hpos
>= w
->current_matrix
->matrix_w
)
28082 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28084 /* When the window is hscrolled, cursor hpos can legitimately be
28085 out of bounds, but we draw the cursor at the corresponding
28086 window margin in that case. */
28087 if (!row
->reversed_p
&& hpos
< 0)
28089 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28090 hpos
= row
->used
[TEXT_AREA
] - 1;
28093 display_and_set_cursor (w
, on
, hpos
, vpos
,
28094 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28100 /* Call update_window_cursor with parameter ON_P on all leaf windows
28101 in the window tree rooted at W. */
28104 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28108 if (WINDOWP (w
->contents
))
28109 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28111 update_window_cursor (w
, on_p
);
28113 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28119 Display the cursor on window W, or clear it, according to ON_P.
28120 Don't change the cursor's position. */
28123 x_update_cursor (struct frame
*f
, bool on_p
)
28125 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28130 Clear the cursor of window W to background color, and mark the
28131 cursor as not shown. This is used when the text where the cursor
28132 is about to be rewritten. */
28135 x_clear_cursor (struct window
*w
)
28137 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28138 update_window_cursor (w
, 0);
28141 #endif /* HAVE_WINDOW_SYSTEM */
28143 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28146 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28147 int start_hpos
, int end_hpos
,
28148 enum draw_glyphs_face draw
)
28150 #ifdef HAVE_WINDOW_SYSTEM
28151 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28153 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28157 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28158 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28162 /* Display the active region described by mouse_face_* according to DRAW. */
28165 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28167 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28168 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28170 if (/* If window is in the process of being destroyed, don't bother
28172 w
->current_matrix
!= NULL
28173 /* Don't update mouse highlight if hidden. */
28174 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28175 /* Recognize when we are called to operate on rows that don't exist
28176 anymore. This can happen when a window is split. */
28177 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28179 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
28180 struct glyph_row
*row
, *first
, *last
;
28182 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28183 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28185 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28187 int start_hpos
, end_hpos
, start_x
;
28189 /* For all but the first row, the highlight starts at column 0. */
28192 /* R2L rows have BEG and END in reversed order, but the
28193 screen drawing geometry is always left to right. So
28194 we need to mirror the beginning and end of the
28195 highlighted area in R2L rows. */
28196 if (!row
->reversed_p
)
28198 start_hpos
= hlinfo
->mouse_face_beg_col
;
28199 start_x
= hlinfo
->mouse_face_beg_x
;
28201 else if (row
== last
)
28203 start_hpos
= hlinfo
->mouse_face_end_col
;
28204 start_x
= hlinfo
->mouse_face_end_x
;
28212 else if (row
->reversed_p
&& row
== last
)
28214 start_hpos
= hlinfo
->mouse_face_end_col
;
28215 start_x
= hlinfo
->mouse_face_end_x
;
28225 if (!row
->reversed_p
)
28226 end_hpos
= hlinfo
->mouse_face_end_col
;
28227 else if (row
== first
)
28228 end_hpos
= hlinfo
->mouse_face_beg_col
;
28231 end_hpos
= row
->used
[TEXT_AREA
];
28232 if (draw
== DRAW_NORMAL_TEXT
)
28233 row
->fill_line_p
= 1; /* Clear to end of line */
28236 else if (row
->reversed_p
&& row
== first
)
28237 end_hpos
= hlinfo
->mouse_face_beg_col
;
28240 end_hpos
= row
->used
[TEXT_AREA
];
28241 if (draw
== DRAW_NORMAL_TEXT
)
28242 row
->fill_line_p
= 1; /* Clear to end of line */
28245 if (end_hpos
> start_hpos
)
28247 draw_row_with_mouse_face (w
, start_x
, row
,
28248 start_hpos
, end_hpos
, draw
);
28251 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28255 #ifdef HAVE_WINDOW_SYSTEM
28256 /* When we've written over the cursor, arrange for it to
28257 be displayed again. */
28258 if (FRAME_WINDOW_P (f
)
28259 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28261 int hpos
= w
->phys_cursor
.hpos
;
28263 /* When the window is hscrolled, cursor hpos can legitimately be
28264 out of bounds, but we draw the cursor at the corresponding
28265 window margin in that case. */
28266 if (!row
->reversed_p
&& hpos
< 0)
28268 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28269 hpos
= row
->used
[TEXT_AREA
] - 1;
28272 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
28273 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28276 #endif /* HAVE_WINDOW_SYSTEM */
28279 #ifdef HAVE_WINDOW_SYSTEM
28280 /* Change the mouse cursor. */
28281 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28283 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28284 if (draw
== DRAW_NORMAL_TEXT
28285 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28286 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28289 if (draw
== DRAW_MOUSE_FACE
)
28290 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28292 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28294 #endif /* HAVE_WINDOW_SYSTEM */
28298 Clear out the mouse-highlighted active region.
28299 Redraw it un-highlighted first. Value is non-zero if mouse
28300 face was actually drawn unhighlighted. */
28303 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28307 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
28309 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28313 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28314 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28315 hlinfo
->mouse_face_window
= Qnil
;
28316 hlinfo
->mouse_face_overlay
= Qnil
;
28320 /* Return true if the coordinates HPOS and VPOS on windows W are
28321 within the mouse face on that window. */
28323 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28325 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28327 /* Quickly resolve the easy cases. */
28328 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28329 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28331 if (vpos
< hlinfo
->mouse_face_beg_row
28332 || vpos
> hlinfo
->mouse_face_end_row
)
28334 if (vpos
> hlinfo
->mouse_face_beg_row
28335 && vpos
< hlinfo
->mouse_face_end_row
)
28338 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28340 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28342 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28345 else if ((vpos
== hlinfo
->mouse_face_beg_row
28346 && hpos
>= hlinfo
->mouse_face_beg_col
)
28347 || (vpos
== hlinfo
->mouse_face_end_row
28348 && hpos
< hlinfo
->mouse_face_end_col
))
28353 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28355 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28358 else if ((vpos
== hlinfo
->mouse_face_beg_row
28359 && hpos
<= hlinfo
->mouse_face_beg_col
)
28360 || (vpos
== hlinfo
->mouse_face_end_row
28361 && hpos
> hlinfo
->mouse_face_end_col
))
28369 True if physical cursor of window W is within mouse face. */
28372 cursor_in_mouse_face_p (struct window
*w
)
28374 int hpos
= w
->phys_cursor
.hpos
;
28375 int vpos
= w
->phys_cursor
.vpos
;
28376 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28378 /* When the window is hscrolled, cursor hpos can legitimately be out
28379 of bounds, but we draw the cursor at the corresponding window
28380 margin in that case. */
28381 if (!row
->reversed_p
&& hpos
< 0)
28383 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28384 hpos
= row
->used
[TEXT_AREA
] - 1;
28386 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28391 /* Find the glyph rows START_ROW and END_ROW of window W that display
28392 characters between buffer positions START_CHARPOS and END_CHARPOS
28393 (excluding END_CHARPOS). DISP_STRING is a display string that
28394 covers these buffer positions. This is similar to
28395 row_containing_pos, but is more accurate when bidi reordering makes
28396 buffer positions change non-linearly with glyph rows. */
28398 rows_from_pos_range (struct window
*w
,
28399 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28400 Lisp_Object disp_string
,
28401 struct glyph_row
**start
, struct glyph_row
**end
)
28403 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28404 int last_y
= window_text_bottom_y (w
);
28405 struct glyph_row
*row
;
28410 while (!first
->enabled_p
28411 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28414 /* Find the START row. */
28416 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28419 /* A row can potentially be the START row if the range of the
28420 characters it displays intersects the range
28421 [START_CHARPOS..END_CHARPOS). */
28422 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28423 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28424 /* See the commentary in row_containing_pos, for the
28425 explanation of the complicated way to check whether
28426 some position is beyond the end of the characters
28427 displayed by a row. */
28428 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28429 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28430 && !row
->ends_at_zv_p
28431 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28432 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28433 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28434 && !row
->ends_at_zv_p
28435 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28437 /* Found a candidate row. Now make sure at least one of the
28438 glyphs it displays has a charpos from the range
28439 [START_CHARPOS..END_CHARPOS).
28441 This is not obvious because bidi reordering could make
28442 buffer positions of a row be 1,2,3,102,101,100, and if we
28443 want to highlight characters in [50..60), we don't want
28444 this row, even though [50..60) does intersect [1..103),
28445 the range of character positions given by the row's start
28446 and end positions. */
28447 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28448 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28452 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28453 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28454 /* A glyph that comes from DISP_STRING is by
28455 definition to be highlighted. */
28456 || EQ (g
->object
, disp_string
))
28465 /* Find the END row. */
28467 /* If the last row is partially visible, start looking for END
28468 from that row, instead of starting from FIRST. */
28469 && !(row
->enabled_p
28470 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28472 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28474 struct glyph_row
*next
= row
+ 1;
28475 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28477 if (!next
->enabled_p
28478 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28479 /* The first row >= START whose range of displayed characters
28480 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28481 is the row END + 1. */
28482 || (start_charpos
< next_start
28483 && end_charpos
< next_start
)
28484 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28485 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28486 && !next
->ends_at_zv_p
28487 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28488 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28489 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28490 && !next
->ends_at_zv_p
28491 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28498 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28499 but none of the characters it displays are in the range, it is
28501 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28502 struct glyph
*s
= g
;
28503 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28507 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28508 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28509 /* If the buffer position of the first glyph in
28510 the row is equal to END_CHARPOS, it means
28511 the last character to be highlighted is the
28512 newline of ROW, and we must consider NEXT as
28514 || (((!next
->reversed_p
&& g
== s
)
28515 || (next
->reversed_p
&& g
== e
- 1))
28516 && (g
->charpos
== end_charpos
28517 /* Special case for when NEXT is an
28518 empty line at ZV. */
28519 || (g
->charpos
== -1
28520 && !row
->ends_at_zv_p
28521 && next_start
== end_charpos
)))))
28522 /* A glyph that comes from DISP_STRING is by
28523 definition to be highlighted. */
28524 || EQ (g
->object
, disp_string
))
28533 /* The first row that ends at ZV must be the last to be
28535 else if (next
->ends_at_zv_p
)
28544 /* This function sets the mouse_face_* elements of HLINFO, assuming
28545 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28546 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28547 for the overlay or run of text properties specifying the mouse
28548 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28549 before-string and after-string that must also be highlighted.
28550 DISP_STRING, if non-nil, is a display string that may cover some
28551 or all of the highlighted text. */
28554 mouse_face_from_buffer_pos (Lisp_Object window
,
28555 Mouse_HLInfo
*hlinfo
,
28556 ptrdiff_t mouse_charpos
,
28557 ptrdiff_t start_charpos
,
28558 ptrdiff_t end_charpos
,
28559 Lisp_Object before_string
,
28560 Lisp_Object after_string
,
28561 Lisp_Object disp_string
)
28563 struct window
*w
= XWINDOW (window
);
28564 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28565 struct glyph_row
*r1
, *r2
;
28566 struct glyph
*glyph
, *end
;
28567 ptrdiff_t ignore
, pos
;
28570 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28571 eassert (NILP (before_string
) || STRINGP (before_string
));
28572 eassert (NILP (after_string
) || STRINGP (after_string
));
28574 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28575 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28577 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28578 /* If the before-string or display-string contains newlines,
28579 rows_from_pos_range skips to its last row. Move back. */
28580 if (!NILP (before_string
) || !NILP (disp_string
))
28582 struct glyph_row
*prev
;
28583 while ((prev
= r1
- 1, prev
>= first
)
28584 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28585 && prev
->used
[TEXT_AREA
] > 0)
28587 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28588 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28589 while (--glyph
>= beg
&& NILP (glyph
->object
));
28591 || !(EQ (glyph
->object
, before_string
)
28592 || EQ (glyph
->object
, disp_string
)))
28599 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28600 hlinfo
->mouse_face_past_end
= 1;
28602 else if (!NILP (after_string
))
28604 /* If the after-string has newlines, advance to its last row. */
28605 struct glyph_row
*next
;
28606 struct glyph_row
*last
28607 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28609 for (next
= r2
+ 1;
28611 && next
->used
[TEXT_AREA
] > 0
28612 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28616 /* The rest of the display engine assumes that mouse_face_beg_row is
28617 either above mouse_face_end_row or identical to it. But with
28618 bidi-reordered continued lines, the row for START_CHARPOS could
28619 be below the row for END_CHARPOS. If so, swap the rows and store
28620 them in correct order. */
28623 struct glyph_row
*tem
= r2
;
28629 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28630 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28632 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28633 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28634 could be anywhere in the row and in any order. The strategy
28635 below is to find the leftmost and the rightmost glyph that
28636 belongs to either of these 3 strings, or whose position is
28637 between START_CHARPOS and END_CHARPOS, and highlight all the
28638 glyphs between those two. This may cover more than just the text
28639 between START_CHARPOS and END_CHARPOS if the range of characters
28640 strides the bidi level boundary, e.g. if the beginning is in R2L
28641 text while the end is in L2R text or vice versa. */
28642 if (!r1
->reversed_p
)
28644 /* This row is in a left to right paragraph. Scan it left to
28646 glyph
= r1
->glyphs
[TEXT_AREA
];
28647 end
= glyph
+ r1
->used
[TEXT_AREA
];
28650 /* Skip truncation glyphs at the start of the glyph row. */
28651 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28653 && NILP (glyph
->object
)
28654 && glyph
->charpos
< 0;
28656 x
+= glyph
->pixel_width
;
28658 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28659 or DISP_STRING, and the first glyph from buffer whose
28660 position is between START_CHARPOS and END_CHARPOS. */
28662 && !NILP (glyph
->object
)
28663 && !EQ (glyph
->object
, disp_string
)
28664 && !(BUFFERP (glyph
->object
)
28665 && (glyph
->charpos
>= start_charpos
28666 && glyph
->charpos
< end_charpos
));
28669 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28670 are present at buffer positions between START_CHARPOS and
28671 END_CHARPOS, or if they come from an overlay. */
28672 if (EQ (glyph
->object
, before_string
))
28674 pos
= string_buffer_position (before_string
,
28676 /* If pos == 0, it means before_string came from an
28677 overlay, not from a buffer position. */
28678 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28681 else if (EQ (glyph
->object
, after_string
))
28683 pos
= string_buffer_position (after_string
, end_charpos
);
28684 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28687 x
+= glyph
->pixel_width
;
28689 hlinfo
->mouse_face_beg_x
= x
;
28690 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28694 /* This row is in a right to left paragraph. Scan it right to
28698 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28699 glyph
= end
+ r1
->used
[TEXT_AREA
];
28701 /* Skip truncation glyphs at the start of the glyph row. */
28702 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28704 && NILP (glyph
->object
)
28705 && glyph
->charpos
< 0;
28709 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28710 or DISP_STRING, and the first glyph from buffer whose
28711 position is between START_CHARPOS and END_CHARPOS. */
28713 && !NILP (glyph
->object
)
28714 && !EQ (glyph
->object
, disp_string
)
28715 && !(BUFFERP (glyph
->object
)
28716 && (glyph
->charpos
>= start_charpos
28717 && glyph
->charpos
< end_charpos
));
28720 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28721 are present at buffer positions between START_CHARPOS and
28722 END_CHARPOS, or if they come from an overlay. */
28723 if (EQ (glyph
->object
, before_string
))
28725 pos
= string_buffer_position (before_string
, start_charpos
);
28726 /* If pos == 0, it means before_string came from an
28727 overlay, not from a buffer position. */
28728 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28731 else if (EQ (glyph
->object
, after_string
))
28733 pos
= string_buffer_position (after_string
, end_charpos
);
28734 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28739 glyph
++; /* first glyph to the right of the highlighted area */
28740 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28741 x
+= g
->pixel_width
;
28742 hlinfo
->mouse_face_beg_x
= x
;
28743 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28746 /* If the highlight ends in a different row, compute GLYPH and END
28747 for the end row. Otherwise, reuse the values computed above for
28748 the row where the highlight begins. */
28751 if (!r2
->reversed_p
)
28753 glyph
= r2
->glyphs
[TEXT_AREA
];
28754 end
= glyph
+ r2
->used
[TEXT_AREA
];
28759 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28760 glyph
= end
+ r2
->used
[TEXT_AREA
];
28764 if (!r2
->reversed_p
)
28766 /* Skip truncation and continuation glyphs near the end of the
28767 row, and also blanks and stretch glyphs inserted by
28768 extend_face_to_end_of_line. */
28770 && NILP ((end
- 1)->object
))
28772 /* Scan the rest of the glyph row from the end, looking for the
28773 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28774 DISP_STRING, or whose position is between START_CHARPOS
28778 && !NILP (end
->object
)
28779 && !EQ (end
->object
, disp_string
)
28780 && !(BUFFERP (end
->object
)
28781 && (end
->charpos
>= start_charpos
28782 && end
->charpos
< end_charpos
));
28785 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28786 are present at buffer positions between START_CHARPOS and
28787 END_CHARPOS, or if they come from an overlay. */
28788 if (EQ (end
->object
, before_string
))
28790 pos
= string_buffer_position (before_string
, start_charpos
);
28791 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28794 else if (EQ (end
->object
, after_string
))
28796 pos
= string_buffer_position (after_string
, end_charpos
);
28797 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28801 /* Find the X coordinate of the last glyph to be highlighted. */
28802 for (; glyph
<= end
; ++glyph
)
28803 x
+= glyph
->pixel_width
;
28805 hlinfo
->mouse_face_end_x
= x
;
28806 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28810 /* Skip truncation and continuation glyphs near the end of the
28811 row, and also blanks and stretch glyphs inserted by
28812 extend_face_to_end_of_line. */
28816 && NILP (end
->object
))
28818 x
+= end
->pixel_width
;
28821 /* Scan the rest of the glyph row from the end, looking for the
28822 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28823 DISP_STRING, or whose position is between START_CHARPOS
28827 && !NILP (end
->object
)
28828 && !EQ (end
->object
, disp_string
)
28829 && !(BUFFERP (end
->object
)
28830 && (end
->charpos
>= start_charpos
28831 && end
->charpos
< end_charpos
));
28834 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28835 are present at buffer positions between START_CHARPOS and
28836 END_CHARPOS, or if they come from an overlay. */
28837 if (EQ (end
->object
, before_string
))
28839 pos
= string_buffer_position (before_string
, start_charpos
);
28840 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28843 else if (EQ (end
->object
, after_string
))
28845 pos
= string_buffer_position (after_string
, end_charpos
);
28846 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28849 x
+= end
->pixel_width
;
28851 /* If we exited the above loop because we arrived at the last
28852 glyph of the row, and its buffer position is still not in
28853 range, it means the last character in range is the preceding
28854 newline. Bump the end column and x values to get past the
28857 && BUFFERP (end
->object
)
28858 && (end
->charpos
< start_charpos
28859 || end
->charpos
>= end_charpos
))
28861 x
+= end
->pixel_width
;
28864 hlinfo
->mouse_face_end_x
= x
;
28865 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28868 hlinfo
->mouse_face_window
= window
;
28869 hlinfo
->mouse_face_face_id
28870 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28872 !hlinfo
->mouse_face_hidden
, -1);
28873 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28876 /* The following function is not used anymore (replaced with
28877 mouse_face_from_string_pos), but I leave it here for the time
28878 being, in case someone would. */
28880 #if 0 /* not used */
28882 /* Find the position of the glyph for position POS in OBJECT in
28883 window W's current matrix, and return in *X, *Y the pixel
28884 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28886 RIGHT_P non-zero means return the position of the right edge of the
28887 glyph, RIGHT_P zero means return the left edge position.
28889 If no glyph for POS exists in the matrix, return the position of
28890 the glyph with the next smaller position that is in the matrix, if
28891 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28892 exists in the matrix, return the position of the glyph with the
28893 next larger position in OBJECT.
28895 Value is non-zero if a glyph was found. */
28898 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28899 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28901 int yb
= window_text_bottom_y (w
);
28902 struct glyph_row
*r
;
28903 struct glyph
*best_glyph
= NULL
;
28904 struct glyph_row
*best_row
= NULL
;
28907 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28908 r
->enabled_p
&& r
->y
< yb
;
28911 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28912 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28915 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28916 if (EQ (g
->object
, object
))
28918 if (g
->charpos
== pos
)
28925 else if (best_glyph
== NULL
28926 || ((eabs (g
->charpos
- pos
)
28927 < eabs (best_glyph
->charpos
- pos
))
28930 : g
->charpos
> pos
)))
28944 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28948 *x
+= best_glyph
->pixel_width
;
28953 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28956 return best_glyph
!= NULL
;
28958 #endif /* not used */
28960 /* Find the positions of the first and the last glyphs in window W's
28961 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28962 (assumed to be a string), and return in HLINFO's mouse_face_*
28963 members the pixel and column/row coordinates of those glyphs. */
28966 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28967 Lisp_Object object
,
28968 ptrdiff_t startpos
, ptrdiff_t endpos
)
28970 int yb
= window_text_bottom_y (w
);
28971 struct glyph_row
*r
;
28972 struct glyph
*g
, *e
;
28976 /* Find the glyph row with at least one position in the range
28977 [STARTPOS..ENDPOS), and the first glyph in that row whose
28978 position belongs to that range. */
28979 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28980 r
->enabled_p
&& r
->y
< yb
;
28983 if (!r
->reversed_p
)
28985 g
= r
->glyphs
[TEXT_AREA
];
28986 e
= g
+ r
->used
[TEXT_AREA
];
28987 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28988 if (EQ (g
->object
, object
)
28989 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28991 hlinfo
->mouse_face_beg_row
28992 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28993 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28994 hlinfo
->mouse_face_beg_x
= gx
;
29003 e
= r
->glyphs
[TEXT_AREA
];
29004 g
= e
+ r
->used
[TEXT_AREA
];
29005 for ( ; g
> e
; --g
)
29006 if (EQ ((g
-1)->object
, object
)
29007 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29009 hlinfo
->mouse_face_beg_row
29010 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29011 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29012 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29013 gx
+= g1
->pixel_width
;
29014 hlinfo
->mouse_face_beg_x
= gx
;
29026 /* Starting with the next row, look for the first row which does NOT
29027 include any glyphs whose positions are in the range. */
29028 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29030 g
= r
->glyphs
[TEXT_AREA
];
29031 e
= g
+ r
->used
[TEXT_AREA
];
29033 for ( ; g
< e
; ++g
)
29034 if (EQ (g
->object
, object
)
29035 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29044 /* The highlighted region ends on the previous row. */
29047 /* Set the end row. */
29048 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29050 /* Compute and set the end column and the end column's horizontal
29051 pixel coordinate. */
29052 if (!r
->reversed_p
)
29054 g
= r
->glyphs
[TEXT_AREA
];
29055 e
= g
+ r
->used
[TEXT_AREA
];
29056 for ( ; e
> g
; --e
)
29057 if (EQ ((e
-1)->object
, object
)
29058 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29060 hlinfo
->mouse_face_end_col
= e
- g
;
29062 for (gx
= r
->x
; g
< e
; ++g
)
29063 gx
+= g
->pixel_width
;
29064 hlinfo
->mouse_face_end_x
= gx
;
29068 e
= r
->glyphs
[TEXT_AREA
];
29069 g
= e
+ r
->used
[TEXT_AREA
];
29070 for (gx
= r
->x
; e
< g
; ++e
)
29072 if (EQ (e
->object
, object
)
29073 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29075 gx
+= e
->pixel_width
;
29077 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29078 hlinfo
->mouse_face_end_x
= gx
;
29082 #ifdef HAVE_WINDOW_SYSTEM
29084 /* See if position X, Y is within a hot-spot of an image. */
29087 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29089 if (!CONSP (hot_spot
))
29092 if (EQ (XCAR (hot_spot
), Qrect
))
29094 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29095 Lisp_Object rect
= XCDR (hot_spot
);
29099 if (!CONSP (XCAR (rect
)))
29101 if (!CONSP (XCDR (rect
)))
29103 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29105 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29107 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29109 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29113 else if (EQ (XCAR (hot_spot
), Qcircle
))
29115 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29116 Lisp_Object circ
= XCDR (hot_spot
);
29117 Lisp_Object lr
, lx0
, ly0
;
29119 && CONSP (XCAR (circ
))
29120 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
29121 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29122 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29124 double r
= XFLOATINT (lr
);
29125 double dx
= XINT (lx0
) - x
;
29126 double dy
= XINT (ly0
) - y
;
29127 return (dx
* dx
+ dy
* dy
<= r
* r
);
29130 else if (EQ (XCAR (hot_spot
), Qpoly
))
29132 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29133 if (VECTORP (XCDR (hot_spot
)))
29135 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29136 Lisp_Object
*poly
= v
->contents
;
29137 ptrdiff_t n
= v
->header
.size
;
29140 Lisp_Object lx
, ly
;
29143 /* Need an even number of coordinates, and at least 3 edges. */
29144 if (n
< 6 || n
& 1)
29147 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29148 If count is odd, we are inside polygon. Pixels on edges
29149 may or may not be included depending on actual geometry of the
29151 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29152 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29154 x0
= XINT (lx
), y0
= XINT (ly
);
29155 for (i
= 0; i
< n
; i
+= 2)
29157 int x1
= x0
, y1
= y0
;
29158 if ((lx
= poly
[i
], !INTEGERP (lx
))
29159 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29161 x0
= XINT (lx
), y0
= XINT (ly
);
29163 /* Does this segment cross the X line? */
29171 if (y
> y0
&& y
> y1
)
29173 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29183 find_hot_spot (Lisp_Object map
, int x
, int y
)
29185 while (CONSP (map
))
29187 if (CONSP (XCAR (map
))
29188 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29196 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29198 doc
: /* Lookup in image map MAP coordinates X and Y.
29199 An image map is an alist where each element has the format (AREA ID PLIST).
29200 An AREA is specified as either a rectangle, a circle, or a polygon:
29201 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29202 pixel coordinates of the upper left and bottom right corners.
29203 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29204 and the radius of the circle; r may be a float or integer.
29205 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29206 vector describes one corner in the polygon.
29207 Returns the alist element for the first matching AREA in MAP. */)
29208 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29216 return find_hot_spot (map
,
29217 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29218 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29222 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29224 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29226 /* Do not change cursor shape while dragging mouse. */
29227 if (!NILP (do_mouse_tracking
))
29230 if (!NILP (pointer
))
29232 if (EQ (pointer
, Qarrow
))
29233 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29234 else if (EQ (pointer
, Qhand
))
29235 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29236 else if (EQ (pointer
, Qtext
))
29237 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29238 else if (EQ (pointer
, intern ("hdrag")))
29239 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29240 else if (EQ (pointer
, intern ("nhdrag")))
29241 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29242 #ifdef HAVE_X_WINDOWS
29243 else if (EQ (pointer
, intern ("vdrag")))
29244 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29246 else if (EQ (pointer
, intern ("hourglass")))
29247 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29248 else if (EQ (pointer
, Qmodeline
))
29249 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29251 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29254 if (cursor
!= No_Cursor
)
29255 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29258 #endif /* HAVE_WINDOW_SYSTEM */
29260 /* Take proper action when mouse has moved to the mode or header line
29261 or marginal area AREA of window W, x-position X and y-position Y.
29262 X is relative to the start of the text display area of W, so the
29263 width of bitmap areas and scroll bars must be subtracted to get a
29264 position relative to the start of the mode line. */
29267 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29268 enum window_part area
)
29270 struct window
*w
= XWINDOW (window
);
29271 struct frame
*f
= XFRAME (w
->frame
);
29272 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29273 #ifdef HAVE_WINDOW_SYSTEM
29274 Display_Info
*dpyinfo
;
29276 Cursor cursor
= No_Cursor
;
29277 Lisp_Object pointer
= Qnil
;
29278 int dx
, dy
, width
, height
;
29280 Lisp_Object string
, object
= Qnil
;
29281 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29283 Lisp_Object mouse_face
;
29284 int original_x_pixel
= x
;
29285 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29286 struct glyph_row
*row
IF_LINT (= 0);
29288 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29293 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29294 returns them in row/column units! */
29295 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29296 &object
, &dx
, &dy
, &width
, &height
);
29298 row
= (area
== ON_MODE_LINE
29299 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29300 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29302 /* Find the glyph under the mouse pointer. */
29303 if (row
->mode_line_p
&& row
->enabled_p
)
29305 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29306 end
= glyph
+ row
->used
[TEXT_AREA
];
29308 for (x0
= original_x_pixel
;
29309 glyph
< end
&& x0
>= glyph
->pixel_width
;
29311 x0
-= glyph
->pixel_width
;
29319 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29320 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29321 returns them in row/column units! */
29322 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29323 &object
, &dx
, &dy
, &width
, &height
);
29328 #ifdef HAVE_WINDOW_SYSTEM
29329 if (IMAGEP (object
))
29331 Lisp_Object image_map
, hotspot
;
29332 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29334 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29336 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29340 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29341 If so, we could look for mouse-enter, mouse-leave
29342 properties in PLIST (and do something...). */
29343 hotspot
= XCDR (hotspot
);
29344 if (CONSP (hotspot
)
29345 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29347 pointer
= Fplist_get (plist
, Qpointer
);
29348 if (NILP (pointer
))
29350 help
= Fplist_get (plist
, Qhelp_echo
);
29353 help_echo_string
= help
;
29354 XSETWINDOW (help_echo_window
, w
);
29355 help_echo_object
= w
->contents
;
29356 help_echo_pos
= charpos
;
29360 if (NILP (pointer
))
29361 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29363 #endif /* HAVE_WINDOW_SYSTEM */
29365 if (STRINGP (string
))
29366 pos
= make_number (charpos
);
29368 /* Set the help text and mouse pointer. If the mouse is on a part
29369 of the mode line without any text (e.g. past the right edge of
29370 the mode line text), use the default help text and pointer. */
29371 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29373 /* Arrange to display the help by setting the global variables
29374 help_echo_string, help_echo_object, and help_echo_pos. */
29377 if (STRINGP (string
))
29378 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29382 help_echo_string
= help
;
29383 XSETWINDOW (help_echo_window
, w
);
29384 help_echo_object
= string
;
29385 help_echo_pos
= charpos
;
29387 else if (area
== ON_MODE_LINE
)
29389 Lisp_Object default_help
29390 = buffer_local_value (Qmode_line_default_help_echo
,
29393 if (STRINGP (default_help
))
29395 help_echo_string
= default_help
;
29396 XSETWINDOW (help_echo_window
, w
);
29397 help_echo_object
= Qnil
;
29398 help_echo_pos
= -1;
29403 #ifdef HAVE_WINDOW_SYSTEM
29404 /* Change the mouse pointer according to what is under it. */
29405 if (FRAME_WINDOW_P (f
))
29407 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29409 || NILP (Vresize_mini_windows
));
29411 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29412 if (STRINGP (string
))
29414 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29416 if (NILP (pointer
))
29417 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29419 /* Change the mouse pointer according to what is under X/Y. */
29421 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29424 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29425 if (!KEYMAPP (map
))
29426 map
= Fget_text_property (pos
, Qkeymap
, string
);
29427 if (!KEYMAPP (map
) && draggable
)
29428 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29431 else if (draggable
)
29432 /* Default mode-line pointer. */
29433 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29438 /* Change the mouse face according to what is under X/Y. */
29439 if (STRINGP (string
))
29441 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29442 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29443 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29448 struct glyph
* tmp_glyph
;
29452 int total_pixel_width
;
29453 ptrdiff_t begpos
, endpos
, ignore
;
29457 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29458 Qmouse_face
, string
, Qnil
);
29464 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29466 endpos
= SCHARS (string
);
29470 /* Calculate the glyph position GPOS of GLYPH in the
29471 displayed string, relative to the beginning of the
29472 highlighted part of the string.
29474 Note: GPOS is different from CHARPOS. CHARPOS is the
29475 position of GLYPH in the internal string object. A mode
29476 line string format has structures which are converted to
29477 a flattened string by the Emacs Lisp interpreter. The
29478 internal string is an element of those structures. The
29479 displayed string is the flattened string. */
29480 tmp_glyph
= row_start_glyph
;
29481 while (tmp_glyph
< glyph
29482 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29483 && begpos
<= tmp_glyph
->charpos
29484 && tmp_glyph
->charpos
< endpos
)))
29486 gpos
= glyph
- tmp_glyph
;
29488 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29489 the highlighted part of the displayed string to which
29490 GLYPH belongs. Note: GSEQ_LENGTH is different from
29491 SCHARS (STRING), because the latter returns the length of
29492 the internal string. */
29493 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29495 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29496 && begpos
<= tmp_glyph
->charpos
29497 && tmp_glyph
->charpos
< endpos
));
29500 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29502 /* Calculate the total pixel width of all the glyphs between
29503 the beginning of the highlighted area and GLYPH. */
29504 total_pixel_width
= 0;
29505 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29506 total_pixel_width
+= tmp_glyph
->pixel_width
;
29508 /* Pre calculation of re-rendering position. Note: X is in
29509 column units here, after the call to mode_line_string or
29510 marginal_area_string. */
29512 vpos
= (area
== ON_MODE_LINE
29513 ? (w
->current_matrix
)->nrows
- 1
29516 /* If GLYPH's position is included in the region that is
29517 already drawn in mouse face, we have nothing to do. */
29518 if ( EQ (window
, hlinfo
->mouse_face_window
)
29519 && (!row
->reversed_p
29520 ? (hlinfo
->mouse_face_beg_col
<= hpos
29521 && hpos
< hlinfo
->mouse_face_end_col
)
29522 /* In R2L rows we swap BEG and END, see below. */
29523 : (hlinfo
->mouse_face_end_col
<= hpos
29524 && hpos
< hlinfo
->mouse_face_beg_col
))
29525 && hlinfo
->mouse_face_beg_row
== vpos
)
29528 if (clear_mouse_face (hlinfo
))
29529 cursor
= No_Cursor
;
29531 if (!row
->reversed_p
)
29533 hlinfo
->mouse_face_beg_col
= hpos
;
29534 hlinfo
->mouse_face_beg_x
= original_x_pixel
29535 - (total_pixel_width
+ dx
);
29536 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29537 hlinfo
->mouse_face_end_x
= 0;
29541 /* In R2L rows, show_mouse_face expects BEG and END
29542 coordinates to be swapped. */
29543 hlinfo
->mouse_face_end_col
= hpos
;
29544 hlinfo
->mouse_face_end_x
= original_x_pixel
29545 - (total_pixel_width
+ dx
);
29546 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29547 hlinfo
->mouse_face_beg_x
= 0;
29550 hlinfo
->mouse_face_beg_row
= vpos
;
29551 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29552 hlinfo
->mouse_face_past_end
= 0;
29553 hlinfo
->mouse_face_window
= window
;
29555 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29560 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29562 if (NILP (pointer
))
29565 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29566 clear_mouse_face (hlinfo
);
29568 #ifdef HAVE_WINDOW_SYSTEM
29569 if (FRAME_WINDOW_P (f
))
29570 define_frame_cursor1 (f
, cursor
, pointer
);
29576 Take proper action when the mouse has moved to position X, Y on
29577 frame F with regards to highlighting portions of display that have
29578 mouse-face properties. Also de-highlight portions of display where
29579 the mouse was before, set the mouse pointer shape as appropriate
29580 for the mouse coordinates, and activate help echo (tooltips).
29581 X and Y can be negative or out of range. */
29584 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29586 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29587 enum window_part part
= ON_NOTHING
;
29588 Lisp_Object window
;
29590 Cursor cursor
= No_Cursor
;
29591 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29594 /* When a menu is active, don't highlight because this looks odd. */
29595 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29596 if (popup_activated ())
29600 if (!f
->glyphs_initialized_p
29601 || f
->pointer_invisible
)
29604 hlinfo
->mouse_face_mouse_x
= x
;
29605 hlinfo
->mouse_face_mouse_y
= y
;
29606 hlinfo
->mouse_face_mouse_frame
= f
;
29608 if (hlinfo
->mouse_face_defer
)
29611 /* Which window is that in? */
29612 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29614 /* If displaying active text in another window, clear that. */
29615 if (! EQ (window
, hlinfo
->mouse_face_window
)
29616 /* Also clear if we move out of text area in same window. */
29617 || (!NILP (hlinfo
->mouse_face_window
)
29620 && part
!= ON_MODE_LINE
29621 && part
!= ON_HEADER_LINE
))
29622 clear_mouse_face (hlinfo
);
29624 /* Not on a window -> return. */
29625 if (!WINDOWP (window
))
29628 /* Reset help_echo_string. It will get recomputed below. */
29629 help_echo_string
= Qnil
;
29631 /* Convert to window-relative pixel coordinates. */
29632 w
= XWINDOW (window
);
29633 frame_to_window_pixel_xy (w
, &x
, &y
);
29635 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29636 /* Handle tool-bar window differently since it doesn't display a
29638 if (EQ (window
, f
->tool_bar_window
))
29640 note_tool_bar_highlight (f
, x
, y
);
29645 /* Mouse is on the mode, header line or margin? */
29646 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29647 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29649 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29651 #ifdef HAVE_WINDOW_SYSTEM
29652 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29654 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29655 /* Show non-text cursor (Bug#16647). */
29663 #ifdef HAVE_WINDOW_SYSTEM
29664 if (part
== ON_VERTICAL_BORDER
)
29666 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29667 help_echo_string
= build_string ("drag-mouse-1: resize");
29669 else if (part
== ON_RIGHT_DIVIDER
)
29671 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29672 help_echo_string
= build_string ("drag-mouse-1: resize");
29674 else if (part
== ON_BOTTOM_DIVIDER
)
29675 if (! WINDOW_BOTTOMMOST_P (w
)
29677 || NILP (Vresize_mini_windows
))
29679 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29680 help_echo_string
= build_string ("drag-mouse-1: resize");
29683 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29684 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29685 || part
== ON_VERTICAL_SCROLL_BAR
29686 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29687 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29689 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29692 /* Are we in a window whose display is up to date?
29693 And verify the buffer's text has not changed. */
29694 b
= XBUFFER (w
->contents
);
29695 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29697 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29699 struct glyph
*glyph
;
29700 Lisp_Object object
;
29701 Lisp_Object mouse_face
= Qnil
, position
;
29702 Lisp_Object
*overlay_vec
= NULL
;
29703 ptrdiff_t i
, noverlays
;
29704 struct buffer
*obuf
;
29705 ptrdiff_t obegv
, ozv
;
29708 /* Find the glyph under X/Y. */
29709 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29711 #ifdef HAVE_WINDOW_SYSTEM
29712 /* Look for :pointer property on image. */
29713 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29715 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29716 if (img
!= NULL
&& IMAGEP (img
->spec
))
29718 Lisp_Object image_map
, hotspot
;
29719 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29721 && (hotspot
= find_hot_spot (image_map
,
29722 glyph
->slice
.img
.x
+ dx
,
29723 glyph
->slice
.img
.y
+ dy
),
29725 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29729 /* Could check XCAR (hotspot) to see if we enter/leave
29731 If so, we could look for mouse-enter, mouse-leave
29732 properties in PLIST (and do something...). */
29733 hotspot
= XCDR (hotspot
);
29734 if (CONSP (hotspot
)
29735 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29737 pointer
= Fplist_get (plist
, Qpointer
);
29738 if (NILP (pointer
))
29740 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29741 if (!NILP (help_echo_string
))
29743 help_echo_window
= window
;
29744 help_echo_object
= glyph
->object
;
29745 help_echo_pos
= glyph
->charpos
;
29749 if (NILP (pointer
))
29750 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29753 #endif /* HAVE_WINDOW_SYSTEM */
29755 /* Clear mouse face if X/Y not over text. */
29757 || area
!= TEXT_AREA
29758 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29759 /* Glyph's OBJECT is nil for glyphs inserted by the
29760 display engine for its internal purposes, like truncation
29761 and continuation glyphs and blanks beyond the end of
29762 line's text on text terminals. If we are over such a
29763 glyph, we are not over any text. */
29764 || NILP (glyph
->object
)
29765 /* R2L rows have a stretch glyph at their front, which
29766 stands for no text, whereas L2R rows have no glyphs at
29767 all beyond the end of text. Treat such stretch glyphs
29768 like we do with NULL glyphs in L2R rows. */
29769 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29770 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29771 && glyph
->type
== STRETCH_GLYPH
29772 && glyph
->avoid_cursor_p
))
29774 if (clear_mouse_face (hlinfo
))
29775 cursor
= No_Cursor
;
29776 #ifdef HAVE_WINDOW_SYSTEM
29777 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29779 if (area
!= TEXT_AREA
)
29780 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29782 pointer
= Vvoid_text_area_pointer
;
29788 pos
= glyph
->charpos
;
29789 object
= glyph
->object
;
29790 if (!STRINGP (object
) && !BUFFERP (object
))
29793 /* If we get an out-of-range value, return now; avoid an error. */
29794 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29797 /* Make the window's buffer temporarily current for
29798 overlays_at and compute_char_face. */
29799 obuf
= current_buffer
;
29800 current_buffer
= b
;
29806 /* Is this char mouse-active or does it have help-echo? */
29807 position
= make_number (pos
);
29811 if (BUFFERP (object
))
29813 /* Put all the overlays we want in a vector in overlay_vec. */
29814 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29815 /* Sort overlays into increasing priority order. */
29816 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29821 if (NILP (Vmouse_highlight
))
29823 clear_mouse_face (hlinfo
);
29824 goto check_help_echo
;
29827 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29830 cursor
= No_Cursor
;
29832 /* Check mouse-face highlighting. */
29834 /* If there exists an overlay with mouse-face overlapping
29835 the one we are currently highlighting, we have to
29836 check if we enter the overlapping overlay, and then
29837 highlight only that. */
29838 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29839 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29841 /* Find the highest priority overlay with a mouse-face. */
29842 Lisp_Object overlay
= Qnil
;
29843 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29845 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29846 if (!NILP (mouse_face
))
29847 overlay
= overlay_vec
[i
];
29850 /* If we're highlighting the same overlay as before, there's
29851 no need to do that again. */
29852 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29853 goto check_help_echo
;
29854 hlinfo
->mouse_face_overlay
= overlay
;
29856 /* Clear the display of the old active region, if any. */
29857 if (clear_mouse_face (hlinfo
))
29858 cursor
= No_Cursor
;
29860 /* If no overlay applies, get a text property. */
29861 if (NILP (overlay
))
29862 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29864 /* Next, compute the bounds of the mouse highlighting and
29866 if (!NILP (mouse_face
) && STRINGP (object
))
29868 /* The mouse-highlighting comes from a display string
29869 with a mouse-face. */
29873 s
= Fprevious_single_property_change
29874 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29875 e
= Fnext_single_property_change
29876 (position
, Qmouse_face
, object
, Qnil
);
29878 s
= make_number (0);
29880 e
= make_number (SCHARS (object
));
29881 mouse_face_from_string_pos (w
, hlinfo
, object
,
29882 XINT (s
), XINT (e
));
29883 hlinfo
->mouse_face_past_end
= 0;
29884 hlinfo
->mouse_face_window
= window
;
29885 hlinfo
->mouse_face_face_id
29886 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29887 glyph
->face_id
, 1);
29888 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29889 cursor
= No_Cursor
;
29893 /* The mouse-highlighting, if any, comes from an overlay
29894 or text property in the buffer. */
29895 Lisp_Object buffer
IF_LINT (= Qnil
);
29896 Lisp_Object disp_string
IF_LINT (= Qnil
);
29898 if (STRINGP (object
))
29900 /* If we are on a display string with no mouse-face,
29901 check if the text under it has one. */
29902 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29903 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29904 pos
= string_buffer_position (object
, start
);
29907 mouse_face
= get_char_property_and_overlay
29908 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29909 buffer
= w
->contents
;
29910 disp_string
= object
;
29916 disp_string
= Qnil
;
29919 if (!NILP (mouse_face
))
29921 Lisp_Object before
, after
;
29922 Lisp_Object before_string
, after_string
;
29923 /* To correctly find the limits of mouse highlight
29924 in a bidi-reordered buffer, we must not use the
29925 optimization of limiting the search in
29926 previous-single-property-change and
29927 next-single-property-change, because
29928 rows_from_pos_range needs the real start and end
29929 positions to DTRT in this case. That's because
29930 the first row visible in a window does not
29931 necessarily display the character whose position
29932 is the smallest. */
29934 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29935 ? Fmarker_position (w
->start
)
29938 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29939 ? make_number (BUF_Z (XBUFFER (buffer
))
29940 - w
->window_end_pos
)
29943 if (NILP (overlay
))
29945 /* Handle the text property case. */
29946 before
= Fprevious_single_property_change
29947 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29948 after
= Fnext_single_property_change
29949 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29950 before_string
= after_string
= Qnil
;
29954 /* Handle the overlay case. */
29955 before
= Foverlay_start (overlay
);
29956 after
= Foverlay_end (overlay
);
29957 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29958 after_string
= Foverlay_get (overlay
, Qafter_string
);
29960 if (!STRINGP (before_string
)) before_string
= Qnil
;
29961 if (!STRINGP (after_string
)) after_string
= Qnil
;
29964 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29967 : XFASTINT (before
),
29969 ? BUF_Z (XBUFFER (buffer
))
29970 : XFASTINT (after
),
29971 before_string
, after_string
,
29973 cursor
= No_Cursor
;
29980 /* Look for a `help-echo' property. */
29981 if (NILP (help_echo_string
)) {
29982 Lisp_Object help
, overlay
;
29984 /* Check overlays first. */
29985 help
= overlay
= Qnil
;
29986 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29988 overlay
= overlay_vec
[i
];
29989 help
= Foverlay_get (overlay
, Qhelp_echo
);
29994 help_echo_string
= help
;
29995 help_echo_window
= window
;
29996 help_echo_object
= overlay
;
29997 help_echo_pos
= pos
;
30001 Lisp_Object obj
= glyph
->object
;
30002 ptrdiff_t charpos
= glyph
->charpos
;
30004 /* Try text properties. */
30007 && charpos
< SCHARS (obj
))
30009 help
= Fget_text_property (make_number (charpos
),
30013 /* If the string itself doesn't specify a help-echo,
30014 see if the buffer text ``under'' it does. */
30015 struct glyph_row
*r
30016 = MATRIX_ROW (w
->current_matrix
, vpos
);
30017 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30018 ptrdiff_t p
= string_buffer_position (obj
, start
);
30021 help
= Fget_char_property (make_number (p
),
30022 Qhelp_echo
, w
->contents
);
30031 else if (BUFFERP (obj
)
30034 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30039 help_echo_string
= help
;
30040 help_echo_window
= window
;
30041 help_echo_object
= obj
;
30042 help_echo_pos
= charpos
;
30047 #ifdef HAVE_WINDOW_SYSTEM
30048 /* Look for a `pointer' property. */
30049 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30051 /* Check overlays first. */
30052 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30053 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30055 if (NILP (pointer
))
30057 Lisp_Object obj
= glyph
->object
;
30058 ptrdiff_t charpos
= glyph
->charpos
;
30060 /* Try text properties. */
30063 && charpos
< SCHARS (obj
))
30065 pointer
= Fget_text_property (make_number (charpos
),
30067 if (NILP (pointer
))
30069 /* If the string itself doesn't specify a pointer,
30070 see if the buffer text ``under'' it does. */
30071 struct glyph_row
*r
30072 = MATRIX_ROW (w
->current_matrix
, vpos
);
30073 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30074 ptrdiff_t p
= string_buffer_position (obj
, start
);
30076 pointer
= Fget_char_property (make_number (p
),
30077 Qpointer
, w
->contents
);
30080 else if (BUFFERP (obj
)
30083 pointer
= Fget_text_property (make_number (charpos
),
30087 #endif /* HAVE_WINDOW_SYSTEM */
30091 current_buffer
= obuf
;
30097 #ifdef HAVE_WINDOW_SYSTEM
30098 if (FRAME_WINDOW_P (f
))
30099 define_frame_cursor1 (f
, cursor
, pointer
);
30101 /* This is here to prevent a compiler error, about "label at end of
30102 compound statement". */
30109 Clear any mouse-face on window W. This function is part of the
30110 redisplay interface, and is called from try_window_id and similar
30111 functions to ensure the mouse-highlight is off. */
30114 x_clear_window_mouse_face (struct window
*w
)
30116 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30117 Lisp_Object window
;
30120 XSETWINDOW (window
, w
);
30121 if (EQ (window
, hlinfo
->mouse_face_window
))
30122 clear_mouse_face (hlinfo
);
30128 Just discard the mouse face information for frame F, if any.
30129 This is used when the size of F is changed. */
30132 cancel_mouse_face (struct frame
*f
)
30134 Lisp_Object window
;
30135 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30137 window
= hlinfo
->mouse_face_window
;
30138 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30139 reset_mouse_highlight (hlinfo
);
30144 /***********************************************************************
30146 ***********************************************************************/
30148 #ifdef HAVE_WINDOW_SYSTEM
30150 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30151 which intersects rectangle R. R is in window-relative coordinates. */
30154 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30155 enum glyph_row_area area
)
30157 struct glyph
*first
= row
->glyphs
[area
];
30158 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30159 struct glyph
*last
;
30160 int first_x
, start_x
, x
;
30162 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30163 /* If row extends face to end of line write the whole line. */
30164 draw_glyphs (w
, 0, row
, area
,
30165 0, row
->used
[area
],
30166 DRAW_NORMAL_TEXT
, 0);
30169 /* Set START_X to the window-relative start position for drawing glyphs of
30170 AREA. The first glyph of the text area can be partially visible.
30171 The first glyphs of other areas cannot. */
30172 start_x
= window_box_left_offset (w
, area
);
30174 if (area
== TEXT_AREA
)
30177 /* Find the first glyph that must be redrawn. */
30179 && x
+ first
->pixel_width
< r
->x
)
30181 x
+= first
->pixel_width
;
30185 /* Find the last one. */
30189 && x
< r
->x
+ r
->width
)
30191 x
+= last
->pixel_width
;
30197 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30198 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30199 DRAW_NORMAL_TEXT
, 0);
30204 /* Redraw the parts of the glyph row ROW on window W intersecting
30205 rectangle R. R is in window-relative coordinates. Value is
30206 non-zero if mouse-face was overwritten. */
30209 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30211 eassert (row
->enabled_p
);
30213 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30214 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30215 0, row
->used
[TEXT_AREA
],
30216 DRAW_NORMAL_TEXT
, 0);
30219 if (row
->used
[LEFT_MARGIN_AREA
])
30220 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30221 if (row
->used
[TEXT_AREA
])
30222 expose_area (w
, row
, r
, TEXT_AREA
);
30223 if (row
->used
[RIGHT_MARGIN_AREA
])
30224 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30225 draw_row_fringe_bitmaps (w
, row
);
30228 return row
->mouse_face_p
;
30232 /* Redraw those parts of glyphs rows during expose event handling that
30233 overlap other rows. Redrawing of an exposed line writes over parts
30234 of lines overlapping that exposed line; this function fixes that.
30236 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30237 row in W's current matrix that is exposed and overlaps other rows.
30238 LAST_OVERLAPPING_ROW is the last such row. */
30241 expose_overlaps (struct window
*w
,
30242 struct glyph_row
*first_overlapping_row
,
30243 struct glyph_row
*last_overlapping_row
,
30246 struct glyph_row
*row
;
30248 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30249 if (row
->overlapping_p
)
30251 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30254 if (row
->used
[LEFT_MARGIN_AREA
])
30255 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30257 if (row
->used
[TEXT_AREA
])
30258 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30260 if (row
->used
[RIGHT_MARGIN_AREA
])
30261 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30267 /* Return non-zero if W's cursor intersects rectangle R. */
30270 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30272 XRectangle cr
, result
;
30273 struct glyph
*cursor_glyph
;
30274 struct glyph_row
*row
;
30276 if (w
->phys_cursor
.vpos
>= 0
30277 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30278 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30280 && row
->cursor_in_fringe_p
)
30282 /* Cursor is in the fringe. */
30283 cr
.x
= window_box_right_offset (w
,
30284 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30285 ? RIGHT_MARGIN_AREA
30288 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30289 cr
.height
= row
->height
;
30290 return x_intersect_rectangles (&cr
, r
, &result
);
30293 cursor_glyph
= get_phys_cursor_glyph (w
);
30296 /* r is relative to W's box, but w->phys_cursor.x is relative
30297 to left edge of W's TEXT area. Adjust it. */
30298 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30299 cr
.y
= w
->phys_cursor
.y
;
30300 cr
.width
= cursor_glyph
->pixel_width
;
30301 cr
.height
= w
->phys_cursor_height
;
30302 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30303 I assume the effect is the same -- and this is portable. */
30304 return x_intersect_rectangles (&cr
, r
, &result
);
30306 /* If we don't understand the format, pretend we're not in the hot-spot. */
30312 Draw a vertical window border to the right of window W if W doesn't
30313 have vertical scroll bars. */
30316 x_draw_vertical_border (struct window
*w
)
30318 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30320 /* We could do better, if we knew what type of scroll-bar the adjacent
30321 windows (on either side) have... But we don't :-(
30322 However, I think this works ok. ++KFS 2003-04-25 */
30324 /* Redraw borders between horizontally adjacent windows. Don't
30325 do it for frames with vertical scroll bars because either the
30326 right scroll bar of a window, or the left scroll bar of its
30327 neighbor will suffice as a border. */
30328 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30331 /* Note: It is necessary to redraw both the left and the right
30332 borders, for when only this single window W is being
30334 if (!WINDOW_RIGHTMOST_P (w
)
30335 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30337 int x0
, x1
, y0
, y1
;
30339 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30342 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30345 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30348 if (!WINDOW_LEFTMOST_P (w
)
30349 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30351 int x0
, x1
, y0
, y1
;
30353 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30356 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30359 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30364 /* Draw window dividers for window W. */
30367 x_draw_right_divider (struct window
*w
)
30369 struct frame
*f
= WINDOW_XFRAME (w
);
30371 if (w
->mini
|| w
->pseudo_window_p
)
30373 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30375 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30376 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30377 int y0
= WINDOW_TOP_EDGE_Y (w
);
30378 /* The bottom divider prevails. */
30379 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30381 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30386 x_draw_bottom_divider (struct window
*w
)
30388 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30390 if (w
->mini
|| w
->pseudo_window_p
)
30392 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30394 int x0
= WINDOW_LEFT_EDGE_X (w
);
30395 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30396 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30397 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30399 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30403 /* Redraw the part of window W intersection rectangle FR. Pixel
30404 coordinates in FR are frame-relative. Call this function with
30405 input blocked. Value is non-zero if the exposure overwrites
30409 expose_window (struct window
*w
, XRectangle
*fr
)
30411 struct frame
*f
= XFRAME (w
->frame
);
30413 int mouse_face_overwritten_p
= 0;
30415 /* If window is not yet fully initialized, do nothing. This can
30416 happen when toolkit scroll bars are used and a window is split.
30417 Reconfiguring the scroll bar will generate an expose for a newly
30419 if (w
->current_matrix
== NULL
)
30422 /* When we're currently updating the window, display and current
30423 matrix usually don't agree. Arrange for a thorough display
30425 if (w
->must_be_updated_p
)
30427 SET_FRAME_GARBAGED (f
);
30431 /* Frame-relative pixel rectangle of W. */
30432 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30433 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30434 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30435 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30437 if (x_intersect_rectangles (fr
, &wr
, &r
))
30439 int yb
= window_text_bottom_y (w
);
30440 struct glyph_row
*row
;
30441 int cursor_cleared_p
, phys_cursor_on_p
;
30442 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30444 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30445 r
.x
, r
.y
, r
.width
, r
.height
));
30447 /* Convert to window coordinates. */
30448 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30449 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30451 /* Turn off the cursor. */
30452 if (!w
->pseudo_window_p
30453 && phys_cursor_in_rect_p (w
, &r
))
30455 x_clear_cursor (w
);
30456 cursor_cleared_p
= 1;
30459 cursor_cleared_p
= 0;
30461 /* If the row containing the cursor extends face to end of line,
30462 then expose_area might overwrite the cursor outside the
30463 rectangle and thus notice_overwritten_cursor might clear
30464 w->phys_cursor_on_p. We remember the original value and
30465 check later if it is changed. */
30466 phys_cursor_on_p
= w
->phys_cursor_on_p
;
30468 /* Update lines intersecting rectangle R. */
30469 first_overlapping_row
= last_overlapping_row
= NULL
;
30470 for (row
= w
->current_matrix
->rows
;
30475 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30477 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
30478 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
30479 || (r
.y
>= y0
&& r
.y
< y1
)
30480 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
30482 /* A header line may be overlapping, but there is no need
30483 to fix overlapping areas for them. KFS 2005-02-12 */
30484 if (row
->overlapping_p
&& !row
->mode_line_p
)
30486 if (first_overlapping_row
== NULL
)
30487 first_overlapping_row
= row
;
30488 last_overlapping_row
= row
;
30492 if (expose_line (w
, row
, &r
))
30493 mouse_face_overwritten_p
= 1;
30496 else if (row
->overlapping_p
)
30498 /* We must redraw a row overlapping the exposed area. */
30500 ? y0
+ row
->phys_height
> r
.y
30501 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30503 if (first_overlapping_row
== NULL
)
30504 first_overlapping_row
= row
;
30505 last_overlapping_row
= row
;
30513 /* Display the mode line if there is one. */
30514 if (WINDOW_WANTS_MODELINE_P (w
)
30515 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30517 && row
->y
< r
.y
+ r
.height
)
30519 if (expose_line (w
, row
, &r
))
30520 mouse_face_overwritten_p
= 1;
30523 if (!w
->pseudo_window_p
)
30525 /* Fix the display of overlapping rows. */
30526 if (first_overlapping_row
)
30527 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30530 /* Draw border between windows. */
30531 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30532 x_draw_right_divider (w
);
30534 x_draw_vertical_border (w
);
30536 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30537 x_draw_bottom_divider (w
);
30539 /* Turn the cursor on again. */
30540 if (cursor_cleared_p
30541 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30542 update_window_cursor (w
, 1);
30546 return mouse_face_overwritten_p
;
30551 /* Redraw (parts) of all windows in the window tree rooted at W that
30552 intersect R. R contains frame pixel coordinates. Value is
30553 non-zero if the exposure overwrites mouse-face. */
30556 expose_window_tree (struct window
*w
, XRectangle
*r
)
30558 struct frame
*f
= XFRAME (w
->frame
);
30559 int mouse_face_overwritten_p
= 0;
30561 while (w
&& !FRAME_GARBAGED_P (f
))
30563 if (WINDOWP (w
->contents
))
30564 mouse_face_overwritten_p
30565 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30567 mouse_face_overwritten_p
|= expose_window (w
, r
);
30569 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30572 return mouse_face_overwritten_p
;
30577 Redisplay an exposed area of frame F. X and Y are the upper-left
30578 corner of the exposed rectangle. W and H are width and height of
30579 the exposed area. All are pixel values. W or H zero means redraw
30580 the entire frame. */
30583 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30586 int mouse_face_overwritten_p
= 0;
30588 TRACE ((stderr
, "expose_frame "));
30590 /* No need to redraw if frame will be redrawn soon. */
30591 if (FRAME_GARBAGED_P (f
))
30593 TRACE ((stderr
, " garbaged\n"));
30597 /* If basic faces haven't been realized yet, there is no point in
30598 trying to redraw anything. This can happen when we get an expose
30599 event while Emacs is starting, e.g. by moving another window. */
30600 if (FRAME_FACE_CACHE (f
) == NULL
30601 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30603 TRACE ((stderr
, " no faces\n"));
30607 if (w
== 0 || h
== 0)
30610 r
.width
= FRAME_TEXT_WIDTH (f
);
30611 r
.height
= FRAME_TEXT_HEIGHT (f
);
30621 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30622 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30624 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30625 if (WINDOWP (f
->tool_bar_window
))
30626 mouse_face_overwritten_p
30627 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30630 #ifdef HAVE_X_WINDOWS
30632 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30633 if (WINDOWP (f
->menu_bar_window
))
30634 mouse_face_overwritten_p
30635 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30636 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30640 /* Some window managers support a focus-follows-mouse style with
30641 delayed raising of frames. Imagine a partially obscured frame,
30642 and moving the mouse into partially obscured mouse-face on that
30643 frame. The visible part of the mouse-face will be highlighted,
30644 then the WM raises the obscured frame. With at least one WM, KDE
30645 2.1, Emacs is not getting any event for the raising of the frame
30646 (even tried with SubstructureRedirectMask), only Expose events.
30647 These expose events will draw text normally, i.e. not
30648 highlighted. Which means we must redo the highlight here.
30649 Subsume it under ``we love X''. --gerd 2001-08-15 */
30650 /* Included in Windows version because Windows most likely does not
30651 do the right thing if any third party tool offers
30652 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30653 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30655 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30656 if (f
== hlinfo
->mouse_face_mouse_frame
)
30658 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30659 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30660 clear_mouse_face (hlinfo
);
30661 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30668 Determine the intersection of two rectangles R1 and R2. Return
30669 the intersection in *RESULT. Value is non-zero if RESULT is not
30673 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30675 XRectangle
*left
, *right
;
30676 XRectangle
*upper
, *lower
;
30677 int intersection_p
= 0;
30679 /* Rearrange so that R1 is the left-most rectangle. */
30681 left
= r1
, right
= r2
;
30683 left
= r2
, right
= r1
;
30685 /* X0 of the intersection is right.x0, if this is inside R1,
30686 otherwise there is no intersection. */
30687 if (right
->x
<= left
->x
+ left
->width
)
30689 result
->x
= right
->x
;
30691 /* The right end of the intersection is the minimum of
30692 the right ends of left and right. */
30693 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30696 /* Same game for Y. */
30698 upper
= r1
, lower
= r2
;
30700 upper
= r2
, lower
= r1
;
30702 /* The upper end of the intersection is lower.y0, if this is inside
30703 of upper. Otherwise, there is no intersection. */
30704 if (lower
->y
<= upper
->y
+ upper
->height
)
30706 result
->y
= lower
->y
;
30708 /* The lower end of the intersection is the minimum of the lower
30709 ends of upper and lower. */
30710 result
->height
= (min (lower
->y
+ lower
->height
,
30711 upper
->y
+ upper
->height
)
30713 intersection_p
= 1;
30717 return intersection_p
;
30720 #endif /* HAVE_WINDOW_SYSTEM */
30723 /***********************************************************************
30725 ***********************************************************************/
30728 syms_of_xdisp (void)
30730 Vwith_echo_area_save_vector
= Qnil
;
30731 staticpro (&Vwith_echo_area_save_vector
);
30733 Vmessage_stack
= Qnil
;
30734 staticpro (&Vmessage_stack
);
30736 /* Non-nil means don't actually do any redisplay. */
30737 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30739 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30741 message_dolog_marker1
= Fmake_marker ();
30742 staticpro (&message_dolog_marker1
);
30743 message_dolog_marker2
= Fmake_marker ();
30744 staticpro (&message_dolog_marker2
);
30745 message_dolog_marker3
= Fmake_marker ();
30746 staticpro (&message_dolog_marker3
);
30749 defsubr (&Sdump_frame_glyph_matrix
);
30750 defsubr (&Sdump_glyph_matrix
);
30751 defsubr (&Sdump_glyph_row
);
30752 defsubr (&Sdump_tool_bar_row
);
30753 defsubr (&Strace_redisplay
);
30754 defsubr (&Strace_to_stderr
);
30756 #ifdef HAVE_WINDOW_SYSTEM
30757 defsubr (&Stool_bar_height
);
30758 defsubr (&Slookup_image_map
);
30760 defsubr (&Sline_pixel_height
);
30761 defsubr (&Sformat_mode_line
);
30762 defsubr (&Sinvisible_p
);
30763 defsubr (&Scurrent_bidi_paragraph_direction
);
30764 defsubr (&Swindow_text_pixel_size
);
30765 defsubr (&Smove_point_visually
);
30766 defsubr (&Sbidi_find_overridden_directionality
);
30768 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30769 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30770 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30771 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30772 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30773 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30774 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30775 DEFSYM (Qeval
, "eval");
30776 DEFSYM (QCdata
, ":data");
30778 /* Names of text properties relevant for redisplay. */
30779 DEFSYM (Qdisplay
, "display");
30780 DEFSYM (Qspace_width
, "space-width");
30781 DEFSYM (Qraise
, "raise");
30782 DEFSYM (Qslice
, "slice");
30783 DEFSYM (Qspace
, "space");
30784 DEFSYM (Qmargin
, "margin");
30785 DEFSYM (Qpointer
, "pointer");
30786 DEFSYM (Qleft_margin
, "left-margin");
30787 DEFSYM (Qright_margin
, "right-margin");
30788 DEFSYM (Qcenter
, "center");
30789 DEFSYM (Qline_height
, "line-height");
30790 DEFSYM (QCalign_to
, ":align-to");
30791 DEFSYM (QCrelative_width
, ":relative-width");
30792 DEFSYM (QCrelative_height
, ":relative-height");
30793 DEFSYM (QCeval
, ":eval");
30794 DEFSYM (QCpropertize
, ":propertize");
30795 DEFSYM (QCfile
, ":file");
30796 DEFSYM (Qfontified
, "fontified");
30797 DEFSYM (Qfontification_functions
, "fontification-functions");
30799 /* Name of the face used to highlight trailing whitespace. */
30800 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30802 /* Name and number of the face used to highlight escape glyphs. */
30803 DEFSYM (Qescape_glyph
, "escape-glyph");
30805 /* Name and number of the face used to highlight non-breaking spaces. */
30806 DEFSYM (Qnobreak_space
, "nobreak-space");
30808 /* The symbol 'image' which is the car of the lists used to represent
30809 images in Lisp. Also a tool bar style. */
30810 DEFSYM (Qimage
, "image");
30812 /* Tool bar styles. */
30813 DEFSYM (Qtext
, "text");
30814 DEFSYM (Qboth
, "both");
30815 DEFSYM (Qboth_horiz
, "both-horiz");
30816 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30818 /* The image map types. */
30819 DEFSYM (QCmap
, ":map");
30820 DEFSYM (QCpointer
, ":pointer");
30821 DEFSYM (Qrect
, "rect");
30822 DEFSYM (Qcircle
, "circle");
30823 DEFSYM (Qpoly
, "poly");
30825 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
30826 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30827 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30829 DEFSYM (Qgrow_only
, "grow-only");
30830 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30831 DEFSYM (Qposition
, "position");
30832 DEFSYM (Qbuffer_position
, "buffer-position");
30833 DEFSYM (Qobject
, "object");
30835 /* Cursor shapes. */
30836 DEFSYM (Qbar
, "bar");
30837 DEFSYM (Qhbar
, "hbar");
30838 DEFSYM (Qbox
, "box");
30839 DEFSYM (Qhollow
, "hollow");
30841 /* Pointer shapes. */
30842 DEFSYM (Qhand
, "hand");
30843 DEFSYM (Qarrow
, "arrow");
30846 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30848 list_of_error
= list1 (list2 (intern_c_string ("error"),
30849 intern_c_string ("void-variable")));
30850 staticpro (&list_of_error
);
30852 /* Values of those variables at last redisplay are stored as
30853 properties on 'overlay-arrow-position' symbol. However, if
30854 Voverlay_arrow_position is a marker, last-arrow-position is its
30855 numerical position. */
30856 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30857 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30859 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30860 properties on a symbol in overlay-arrow-variable-list. */
30861 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30862 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30864 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30865 staticpro (&echo_buffer
[0]);
30866 staticpro (&echo_buffer
[1]);
30868 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30869 staticpro (&echo_area_buffer
[0]);
30870 staticpro (&echo_area_buffer
[1]);
30872 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30873 staticpro (&Vmessages_buffer_name
);
30875 mode_line_proptrans_alist
= Qnil
;
30876 staticpro (&mode_line_proptrans_alist
);
30877 mode_line_string_list
= Qnil
;
30878 staticpro (&mode_line_string_list
);
30879 mode_line_string_face
= Qnil
;
30880 staticpro (&mode_line_string_face
);
30881 mode_line_string_face_prop
= Qnil
;
30882 staticpro (&mode_line_string_face_prop
);
30883 Vmode_line_unwind_vector
= Qnil
;
30884 staticpro (&Vmode_line_unwind_vector
);
30886 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30888 help_echo_string
= Qnil
;
30889 staticpro (&help_echo_string
);
30890 help_echo_object
= Qnil
;
30891 staticpro (&help_echo_object
);
30892 help_echo_window
= Qnil
;
30893 staticpro (&help_echo_window
);
30894 previous_help_echo_string
= Qnil
;
30895 staticpro (&previous_help_echo_string
);
30896 help_echo_pos
= -1;
30898 DEFSYM (Qright_to_left
, "right-to-left");
30899 DEFSYM (Qleft_to_right
, "left-to-right");
30900 defsubr (&Sbidi_resolved_levels
);
30902 #ifdef HAVE_WINDOW_SYSTEM
30903 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30904 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30905 For example, if a block cursor is over a tab, it will be drawn as
30906 wide as that tab on the display. */);
30907 x_stretch_cursor_p
= 0;
30910 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30911 doc
: /* Non-nil means highlight trailing whitespace.
30912 The face used for trailing whitespace is `trailing-whitespace'. */);
30913 Vshow_trailing_whitespace
= Qnil
;
30915 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30916 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30917 If the value is t, Emacs highlights non-ASCII chars which have the
30918 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30919 or `escape-glyph' face respectively.
30921 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30922 U+2011 (non-breaking hyphen) are affected.
30924 Any other non-nil value means to display these characters as a escape
30925 glyph followed by an ordinary space or hyphen.
30927 A value of nil means no special handling of these characters. */);
30928 Vnobreak_char_display
= Qt
;
30930 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30931 doc
: /* The pointer shape to show in void text areas.
30932 A value of nil means to show the text pointer. Other options are
30933 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30935 Vvoid_text_area_pointer
= Qarrow
;
30937 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30938 doc
: /* Non-nil means don't actually do any redisplay.
30939 This is used for internal purposes. */);
30940 Vinhibit_redisplay
= Qnil
;
30942 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30943 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30944 Vglobal_mode_string
= Qnil
;
30946 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30947 doc
: /* Marker for where to display an arrow on top of the buffer text.
30948 This must be the beginning of a line in order to work.
30949 See also `overlay-arrow-string'. */);
30950 Voverlay_arrow_position
= Qnil
;
30952 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30953 doc
: /* String to display as an arrow in non-window frames.
30954 See also `overlay-arrow-position'. */);
30955 Voverlay_arrow_string
= build_pure_c_string ("=>");
30957 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30958 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30959 The symbols on this list are examined during redisplay to determine
30960 where to display overlay arrows. */);
30961 Voverlay_arrow_variable_list
30962 = list1 (intern_c_string ("overlay-arrow-position"));
30964 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30965 doc
: /* The number of lines to try scrolling a window by when point moves out.
30966 If that fails to bring point back on frame, point is centered instead.
30967 If this is zero, point is always centered after it moves off frame.
30968 If you want scrolling to always be a line at a time, you should set
30969 `scroll-conservatively' to a large value rather than set this to 1. */);
30971 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30972 doc
: /* Scroll up to this many lines, to bring point back on screen.
30973 If point moves off-screen, redisplay will scroll by up to
30974 `scroll-conservatively' lines in order to bring point just barely
30975 onto the screen again. If that cannot be done, then redisplay
30976 recenters point as usual.
30978 If the value is greater than 100, redisplay will never recenter point,
30979 but will always scroll just enough text to bring point into view, even
30980 if you move far away.
30982 A value of zero means always recenter point if it moves off screen. */);
30983 scroll_conservatively
= 0;
30985 DEFVAR_INT ("scroll-margin", scroll_margin
,
30986 doc
: /* Number of lines of margin at the top and bottom of a window.
30987 Recenter the window whenever point gets within this many lines
30988 of the top or bottom of the window. */);
30991 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30992 doc
: /* Pixels per inch value for non-window system displays.
30993 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30994 Vdisplay_pixels_per_inch
= make_float (72.0);
30997 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31000 DEFVAR_LISP ("truncate-partial-width-windows",
31001 Vtruncate_partial_width_windows
,
31002 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31003 For an integer value, truncate lines in each window narrower than the
31004 full frame width, provided the window width is less than that integer;
31005 otherwise, respect the value of `truncate-lines'.
31007 For any other non-nil value, truncate lines in all windows that do
31008 not span the full frame width.
31010 A value of nil means to respect the value of `truncate-lines'.
31012 If `word-wrap' is enabled, you might want to reduce this. */);
31013 Vtruncate_partial_width_windows
= make_number (50);
31015 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31016 doc
: /* Maximum buffer size for which line number should be displayed.
31017 If the buffer is bigger than this, the line number does not appear
31018 in the mode line. A value of nil means no limit. */);
31019 Vline_number_display_limit
= Qnil
;
31021 DEFVAR_INT ("line-number-display-limit-width",
31022 line_number_display_limit_width
,
31023 doc
: /* Maximum line width (in characters) for line number display.
31024 If the average length of the lines near point is bigger than this, then the
31025 line number may be omitted from the mode line. */);
31026 line_number_display_limit_width
= 200;
31028 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31029 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31030 highlight_nonselected_windows
= 0;
31032 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31033 doc
: /* Non-nil if more than one frame is visible on this display.
31034 Minibuffer-only frames don't count, but iconified frames do.
31035 This variable is not guaranteed to be accurate except while processing
31036 `frame-title-format' and `icon-title-format'. */);
31038 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31039 doc
: /* Template for displaying the title bar of visible frames.
31040 \(Assuming the window manager supports this feature.)
31042 This variable has the same structure as `mode-line-format', except that
31043 the %c and %l constructs are ignored. It is used only on frames for
31044 which no explicit name has been set \(see `modify-frame-parameters'). */);
31046 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31047 doc
: /* Template for displaying the title bar of an iconified frame.
31048 \(Assuming the window manager supports this feature.)
31049 This variable has the same structure as `mode-line-format' (which see),
31050 and is used only on frames for which no explicit name has been set
31051 \(see `modify-frame-parameters'). */);
31053 = Vframe_title_format
31054 = listn (CONSTYPE_PURE
, 3,
31055 intern_c_string ("multiple-frames"),
31056 build_pure_c_string ("%b"),
31057 listn (CONSTYPE_PURE
, 4,
31058 empty_unibyte_string
,
31059 intern_c_string ("invocation-name"),
31060 build_pure_c_string ("@"),
31061 intern_c_string ("system-name")));
31063 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31064 doc
: /* Maximum number of lines to keep in the message log buffer.
31065 If nil, disable message logging. If t, log messages but don't truncate
31066 the buffer when it becomes large. */);
31067 Vmessage_log_max
= make_number (1000);
31069 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31070 doc
: /* Functions called before redisplay, if window sizes have changed.
31071 The value should be a list of functions that take one argument.
31072 Just before redisplay, for each frame, if any of its windows have changed
31073 size since the last redisplay, or have been split or deleted,
31074 all the functions in the list are called, with the frame as argument. */);
31075 Vwindow_size_change_functions
= Qnil
;
31077 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31078 doc
: /* List of functions to call before redisplaying a window with scrolling.
31079 Each function is called with two arguments, the window and its new
31080 display-start position.
31081 These functions are called whenever the `window-start' marker is modified,
31082 either to point into another buffer (e.g. via `set-window-buffer') or another
31083 place in the same buffer.
31084 Note that the value of `window-end' is not valid when these functions are
31087 Warning: Do not use this feature to alter the way the window
31088 is scrolled. It is not designed for that, and such use probably won't
31090 Vwindow_scroll_functions
= Qnil
;
31092 DEFVAR_LISP ("window-text-change-functions",
31093 Vwindow_text_change_functions
,
31094 doc
: /* Functions to call in redisplay when text in the window might change. */);
31095 Vwindow_text_change_functions
= Qnil
;
31097 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31098 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31099 Each function is called with two arguments, the window and the end trigger value.
31100 See `set-window-redisplay-end-trigger'. */);
31101 Vredisplay_end_trigger_functions
= Qnil
;
31103 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31104 doc
: /* Non-nil means autoselect window with mouse pointer.
31105 If nil, do not autoselect windows.
31106 A positive number means delay autoselection by that many seconds: a
31107 window is autoselected only after the mouse has remained in that
31108 window for the duration of the delay.
31109 A negative number has a similar effect, but causes windows to be
31110 autoselected only after the mouse has stopped moving. \(Because of
31111 the way Emacs compares mouse events, you will occasionally wait twice
31112 that time before the window gets selected.\)
31113 Any other value means to autoselect window instantaneously when the
31114 mouse pointer enters it.
31116 Autoselection selects the minibuffer only if it is active, and never
31117 unselects the minibuffer if it is active.
31119 When customizing this variable make sure that the actual value of
31120 `focus-follows-mouse' matches the behavior of your window manager. */);
31121 Vmouse_autoselect_window
= Qnil
;
31123 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31124 doc
: /* Non-nil means automatically resize tool-bars.
31125 This dynamically changes the tool-bar's height to the minimum height
31126 that is needed to make all tool-bar items visible.
31127 If value is `grow-only', the tool-bar's height is only increased
31128 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31129 Vauto_resize_tool_bars
= Qt
;
31131 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31132 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31133 auto_raise_tool_bar_buttons_p
= 1;
31135 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31136 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31137 make_cursor_line_fully_visible_p
= 1;
31139 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31140 doc
: /* Border below tool-bar in pixels.
31141 If an integer, use it as the height of the border.
31142 If it is one of `internal-border-width' or `border-width', use the
31143 value of the corresponding frame parameter.
31144 Otherwise, no border is added below the tool-bar. */);
31145 Vtool_bar_border
= Qinternal_border_width
;
31147 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31148 doc
: /* Margin around tool-bar buttons in pixels.
31149 If an integer, use that for both horizontal and vertical margins.
31150 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31151 HORZ specifying the horizontal margin, and VERT specifying the
31152 vertical margin. */);
31153 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31155 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31156 doc
: /* Relief thickness of tool-bar buttons. */);
31157 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31159 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31160 doc
: /* Tool bar style to use.
31162 image - show images only
31163 text - show text only
31164 both - show both, text below image
31165 both-horiz - show text to the right of the image
31166 text-image-horiz - show text to the left of the image
31167 any other - use system default or image if no system default.
31169 This variable only affects the GTK+ toolkit version of Emacs. */);
31170 Vtool_bar_style
= Qnil
;
31172 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31173 doc
: /* Maximum number of characters a label can have to be shown.
31174 The tool bar style must also show labels for this to have any effect, see
31175 `tool-bar-style'. */);
31176 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31178 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31179 doc
: /* List of functions to call to fontify regions of text.
31180 Each function is called with one argument POS. Functions must
31181 fontify a region starting at POS in the current buffer, and give
31182 fontified regions the property `fontified'. */);
31183 Vfontification_functions
= Qnil
;
31184 Fmake_variable_buffer_local (Qfontification_functions
);
31186 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31187 unibyte_display_via_language_environment
,
31188 doc
: /* Non-nil means display unibyte text according to language environment.
31189 Specifically, this means that raw bytes in the range 160-255 decimal
31190 are displayed by converting them to the equivalent multibyte characters
31191 according to the current language environment. As a result, they are
31192 displayed according to the current fontset.
31194 Note that this variable affects only how these bytes are displayed,
31195 but does not change the fact they are interpreted as raw bytes. */);
31196 unibyte_display_via_language_environment
= 0;
31198 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31199 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31200 If a float, it specifies a fraction of the mini-window frame's height.
31201 If an integer, it specifies a number of lines. */);
31202 Vmax_mini_window_height
= make_float (0.25);
31204 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31205 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31206 A value of nil means don't automatically resize mini-windows.
31207 A value of t means resize them to fit the text displayed in them.
31208 A value of `grow-only', the default, means let mini-windows grow only;
31209 they return to their normal size when the minibuffer is closed, or the
31210 echo area becomes empty. */);
31211 Vresize_mini_windows
= Qgrow_only
;
31213 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31214 doc
: /* Alist specifying how to blink the cursor off.
31215 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31216 `cursor-type' frame-parameter or variable equals ON-STATE,
31217 comparing using `equal', Emacs uses OFF-STATE to specify
31218 how to blink it off. ON-STATE and OFF-STATE are values for
31219 the `cursor-type' frame parameter.
31221 If a frame's ON-STATE has no entry in this list,
31222 the frame's other specifications determine how to blink the cursor off. */);
31223 Vblink_cursor_alist
= Qnil
;
31225 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31226 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31227 If non-nil, windows are automatically scrolled horizontally to make
31228 point visible. */);
31229 automatic_hscrolling_p
= 1;
31230 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31232 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31233 doc
: /* How many columns away from the window edge point is allowed to get
31234 before automatic hscrolling will horizontally scroll the window. */);
31235 hscroll_margin
= 5;
31237 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31238 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31239 When point is less than `hscroll-margin' columns from the window
31240 edge, automatic hscrolling will scroll the window by the amount of columns
31241 determined by this variable. If its value is a positive integer, scroll that
31242 many columns. If it's a positive floating-point number, it specifies the
31243 fraction of the window's width to scroll. If it's nil or zero, point will be
31244 centered horizontally after the scroll. Any other value, including negative
31245 numbers, are treated as if the value were zero.
31247 Automatic hscrolling always moves point outside the scroll margin, so if
31248 point was more than scroll step columns inside the margin, the window will
31249 scroll more than the value given by the scroll step.
31251 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31252 and `scroll-right' overrides this variable's effect. */);
31253 Vhscroll_step
= make_number (0);
31255 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31256 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31257 Bind this around calls to `message' to let it take effect. */);
31258 message_truncate_lines
= 0;
31260 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31261 doc
: /* Normal hook run to update the menu bar definitions.
31262 Redisplay runs this hook before it redisplays the menu bar.
31263 This is used to update menus such as Buffers, whose contents depend on
31265 Vmenu_bar_update_hook
= Qnil
;
31267 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31268 doc
: /* Frame for which we are updating a menu.
31269 The enable predicate for a menu binding should check this variable. */);
31270 Vmenu_updating_frame
= Qnil
;
31272 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31273 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31274 inhibit_menubar_update
= 0;
31276 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31277 doc
: /* Prefix prepended to all continuation lines at display time.
31278 The value may be a string, an image, or a stretch-glyph; it is
31279 interpreted in the same way as the value of a `display' text property.
31281 This variable is overridden by any `wrap-prefix' text or overlay
31284 To add a prefix to non-continuation lines, use `line-prefix'. */);
31285 Vwrap_prefix
= Qnil
;
31286 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31287 Fmake_variable_buffer_local (Qwrap_prefix
);
31289 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31290 doc
: /* Prefix prepended to all non-continuation lines at display time.
31291 The value may be a string, an image, or a stretch-glyph; it is
31292 interpreted in the same way as the value of a `display' text property.
31294 This variable is overridden by any `line-prefix' text or overlay
31297 To add a prefix to continuation lines, use `wrap-prefix'. */);
31298 Vline_prefix
= Qnil
;
31299 DEFSYM (Qline_prefix
, "line-prefix");
31300 Fmake_variable_buffer_local (Qline_prefix
);
31302 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31303 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31304 inhibit_eval_during_redisplay
= 0;
31306 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31307 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31308 inhibit_free_realized_faces
= 0;
31310 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31311 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31312 Intended for use during debugging and for testing bidi display;
31313 see biditest.el in the test suite. */);
31314 inhibit_bidi_mirroring
= 0;
31317 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31318 doc
: /* Inhibit try_window_id display optimization. */);
31319 inhibit_try_window_id
= 0;
31321 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31322 doc
: /* Inhibit try_window_reusing display optimization. */);
31323 inhibit_try_window_reusing
= 0;
31325 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31326 doc
: /* Inhibit try_cursor_movement display optimization. */);
31327 inhibit_try_cursor_movement
= 0;
31328 #endif /* GLYPH_DEBUG */
31330 DEFVAR_INT ("overline-margin", overline_margin
,
31331 doc
: /* Space between overline and text, in pixels.
31332 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31333 margin to the character height. */);
31334 overline_margin
= 2;
31336 DEFVAR_INT ("underline-minimum-offset",
31337 underline_minimum_offset
,
31338 doc
: /* Minimum distance between baseline and underline.
31339 This can improve legibility of underlined text at small font sizes,
31340 particularly when using variable `x-use-underline-position-properties'
31341 with fonts that specify an UNDERLINE_POSITION relatively close to the
31342 baseline. The default value is 1. */);
31343 underline_minimum_offset
= 1;
31345 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31346 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31347 This feature only works when on a window system that can change
31348 cursor shapes. */);
31349 display_hourglass_p
= 1;
31351 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31352 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31353 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31355 #ifdef HAVE_WINDOW_SYSTEM
31356 hourglass_atimer
= NULL
;
31357 hourglass_shown_p
= 0;
31358 #endif /* HAVE_WINDOW_SYSTEM */
31360 /* Name of the face used to display glyphless characters. */
31361 DEFSYM (Qglyphless_char
, "glyphless-char");
31363 /* Method symbols for Vglyphless_char_display. */
31364 DEFSYM (Qhex_code
, "hex-code");
31365 DEFSYM (Qempty_box
, "empty-box");
31366 DEFSYM (Qthin_space
, "thin-space");
31367 DEFSYM (Qzero_width
, "zero-width");
31369 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31370 doc
: /* Function run just before redisplay.
31371 It is called with one argument, which is the set of windows that are to
31372 be redisplayed. This set can be nil (meaning, only the selected window),
31373 or t (meaning all windows). */);
31374 Vpre_redisplay_function
= intern ("ignore");
31376 /* Symbol for the purpose of Vglyphless_char_display. */
31377 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31378 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31380 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31381 doc
: /* Char-table defining glyphless characters.
31382 Each element, if non-nil, should be one of the following:
31383 an ASCII acronym string: display this string in a box
31384 `hex-code': display the hexadecimal code of a character in a box
31385 `empty-box': display as an empty box
31386 `thin-space': display as 1-pixel width space
31387 `zero-width': don't display
31388 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31389 display method for graphical terminals and text terminals respectively.
31390 GRAPHICAL and TEXT should each have one of the values listed above.
31392 The char-table has one extra slot to control the display of a character for
31393 which no font is found. This slot only takes effect on graphical terminals.
31394 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31395 `thin-space'. The default is `empty-box'.
31397 If a character has a non-nil entry in an active display table, the
31398 display table takes effect; in this case, Emacs does not consult
31399 `glyphless-char-display' at all. */);
31400 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31401 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31404 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31405 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31406 Vdebug_on_message
= Qnil
;
31408 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31410 Vredisplay__all_windows_cause
31411 = Fmake_vector (make_number (100), make_number (0));
31413 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31415 Vredisplay__mode_lines_cause
31416 = Fmake_vector (make_number (100), make_number (0));
31420 /* Initialize this module when Emacs starts. */
31425 CHARPOS (this_line_start_pos
) = 0;
31427 if (!noninteractive
)
31429 struct window
*m
= XWINDOW (minibuf_window
);
31430 Lisp_Object frame
= m
->frame
;
31431 struct frame
*f
= XFRAME (frame
);
31432 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31433 struct window
*r
= XWINDOW (root
);
31436 echo_area_window
= minibuf_window
;
31438 r
->top_line
= FRAME_TOP_MARGIN (f
);
31439 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31440 r
->total_cols
= FRAME_COLS (f
);
31441 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31442 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31443 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31445 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31446 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31447 m
->total_cols
= FRAME_COLS (f
);
31448 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31449 m
->total_lines
= 1;
31450 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31452 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31453 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31454 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31456 /* The default ellipsis glyphs `...'. */
31457 for (i
= 0; i
< 3; ++i
)
31458 default_invis_vector
[i
] = make_number ('.');
31462 /* Allocate the buffer for frame titles.
31463 Also used for `format-mode-line'. */
31465 mode_line_noprop_buf
= xmalloc (size
);
31466 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31467 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31468 mode_line_target
= MODE_LINE_DISPLAY
;
31471 help_echo_showing_p
= 0;
31474 #ifdef HAVE_WINDOW_SYSTEM
31476 /* Platform-independent portion of hourglass implementation. */
31478 /* Timer function of hourglass_atimer. */
31481 show_hourglass (struct atimer
*timer
)
31483 /* The timer implementation will cancel this timer automatically
31484 after this function has run. Set hourglass_atimer to null
31485 so that we know the timer doesn't have to be canceled. */
31486 hourglass_atimer
= NULL
;
31488 if (!hourglass_shown_p
)
31490 Lisp_Object tail
, frame
;
31494 FOR_EACH_FRAME (tail
, frame
)
31496 struct frame
*f
= XFRAME (frame
);
31498 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31499 && FRAME_RIF (f
)->show_hourglass
)
31500 FRAME_RIF (f
)->show_hourglass (f
);
31503 hourglass_shown_p
= 1;
31508 /* Cancel a currently active hourglass timer, and start a new one. */
31511 start_hourglass (void)
31513 struct timespec delay
;
31515 cancel_hourglass ();
31517 if (INTEGERP (Vhourglass_delay
)
31518 && XINT (Vhourglass_delay
) > 0)
31519 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31520 TYPE_MAXIMUM (time_t)),
31522 else if (FLOATP (Vhourglass_delay
)
31523 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31524 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31526 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31528 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31529 show_hourglass
, NULL
);
31532 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31536 cancel_hourglass (void)
31538 if (hourglass_atimer
)
31540 cancel_atimer (hourglass_atimer
);
31541 hourglass_atimer
= NULL
;
31544 if (hourglass_shown_p
)
31546 Lisp_Object tail
, frame
;
31550 FOR_EACH_FRAME (tail
, frame
)
31552 struct frame
*f
= XFRAME (frame
);
31554 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31555 && FRAME_RIF (f
)->hide_hourglass
)
31556 FRAME_RIF (f
)->hide_hourglass (f
);
31558 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31559 else if (!FRAME_W32_P (f
))
31560 w32_arrow_cursor ();
31564 hourglass_shown_p
= 0;
31569 #endif /* HAVE_WINDOW_SYSTEM */