1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2014 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.
105 This function performs the full redisplay of a single window
106 assuming that its fonts were not changed and that the cursor
107 will not end up in the scroll margins. (Loading fonts requires
108 re-adjustment of dimensions of glyph matrices, which makes this
109 method impossible to use.)
111 These optimizations are tried in sequence (some can be skipped if
112 it is known that they are not applicable). If none of the
113 optimizations were successful, redisplay calls redisplay_windows,
114 which performs a full redisplay of all windows.
118 Desired matrices are always built per Emacs window. The function
119 `display_line' is the central function to look at if you are
120 interested. It constructs one row in a desired matrix given an
121 iterator structure containing both a buffer position and a
122 description of the environment in which the text is to be
123 displayed. But this is too early, read on.
125 Characters and pixmaps displayed for a range of buffer text depend
126 on various settings of buffers and windows, on overlays and text
127 properties, on display tables, on selective display. The good news
128 is that all this hairy stuff is hidden behind a small set of
129 interface functions taking an iterator structure (struct it)
132 Iteration over things to be displayed is then simple. It is
133 started by initializing an iterator with a call to init_iterator,
134 passing it the buffer position where to start iteration. For
135 iteration over strings, pass -1 as the position to init_iterator,
136 and call reseat_to_string when the string is ready, to initialize
137 the iterator for that string. Thereafter, calls to
138 get_next_display_element fill the iterator structure with relevant
139 information about the next thing to display. Calls to
140 set_iterator_to_next move the iterator to the next thing.
142 Besides this, an iterator also contains information about the
143 display environment in which glyphs for display elements are to be
144 produced. It has fields for the width and height of the display,
145 the information whether long lines are truncated or continued, a
146 current X and Y position, and lots of other stuff you can better
149 Glyphs in a desired matrix are normally constructed in a loop
150 calling get_next_display_element and then PRODUCE_GLYPHS. The call
151 to PRODUCE_GLYPHS will fill the iterator structure with pixel
152 information about the element being displayed and at the same time
153 produce glyphs for it. If the display element fits on the line
154 being displayed, set_iterator_to_next is called next, otherwise the
155 glyphs produced are discarded. The function display_line is the
156 workhorse of filling glyph rows in the desired matrix with glyphs.
157 In addition to producing glyphs, it also handles line truncation
158 and continuation, word wrap, and cursor positioning (for the
159 latter, see also set_cursor_from_row).
163 That just couldn't be all, could it? What about terminal types not
164 supporting operations on sub-windows of the screen? To update the
165 display on such a terminal, window-based glyph matrices are not
166 well suited. To be able to reuse part of the display (scrolling
167 lines up and down), we must instead have a view of the whole
168 screen. This is what `frame matrices' are for. They are a trick.
170 Frames on terminals like above have a glyph pool. Windows on such
171 a frame sub-allocate their glyph memory from their frame's glyph
172 pool. The frame itself is given its own glyph matrices. By
173 coincidence---or maybe something else---rows in window glyph
174 matrices are slices of corresponding rows in frame matrices. Thus
175 writing to window matrices implicitly updates a frame matrix which
176 provides us with the view of the whole screen that we originally
177 wanted to have without having to move many bytes around. To be
178 honest, there is a little bit more done, but not much more. If you
179 plan to extend that code, take a look at dispnew.c. The function
180 build_frame_matrix is a good starting point.
182 Bidirectional display.
184 Bidirectional display adds quite some hair to this already complex
185 design. The good news are that a large portion of that hairy stuff
186 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
187 reordering engine which is called by set_iterator_to_next and
188 returns the next character to display in the visual order. See
189 commentary on bidi.c for more details. As far as redisplay is
190 concerned, the effect of calling bidi_move_to_visually_next, the
191 main interface of the reordering engine, is that the iterator gets
192 magically placed on the buffer or string position that is to be
193 displayed next. In other words, a linear iteration through the
194 buffer/string is replaced with a non-linear one. All the rest of
195 the redisplay is oblivious to the bidi reordering.
197 Well, almost oblivious---there are still complications, most of
198 them due to the fact that buffer and string positions no longer
199 change monotonously with glyph indices in a glyph row. Moreover,
200 for continued lines, the buffer positions may not even be
201 monotonously changing with vertical positions. Also, accounting
202 for face changes, overlays, etc. becomes more complex because
203 non-linear iteration could potentially skip many positions with
204 changes, and then cross them again on the way back...
206 One other prominent effect of bidirectional display is that some
207 paragraphs of text need to be displayed starting at the right
208 margin of the window---the so-called right-to-left, or R2L
209 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
210 which have their reversed_p flag set. The bidi reordering engine
211 produces characters in such rows starting from the character which
212 should be the rightmost on display. PRODUCE_GLYPHS then reverses
213 the order, when it fills up the glyph row whose reversed_p flag is
214 set, by prepending each new glyph to what is already there, instead
215 of appending it. When the glyph row is complete, the function
216 extend_face_to_end_of_line fills the empty space to the left of the
217 leftmost character with special glyphs, which will display as,
218 well, empty. On text terminals, these special glyphs are simply
219 blank characters. On graphics terminals, there's a single stretch
220 glyph of a suitably computed width. Both the blanks and the
221 stretch glyph are given the face of the background of the line.
222 This way, the terminal-specific back-end can still draw the glyphs
223 left to right, even for R2L lines.
225 Bidirectional display and character compositions
227 Some scripts cannot be displayed by drawing each character
228 individually, because adjacent characters change each other's shape
229 on display. For example, Arabic and Indic scripts belong to this
232 Emacs display supports this by providing "character compositions",
233 most of which is implemented in composite.c. During the buffer
234 scan that delivers characters to PRODUCE_GLYPHS, if the next
235 character to be delivered is a composed character, the iteration
236 calls composition_reseat_it and next_element_from_composition. If
237 they succeed to compose the character with one or more of the
238 following characters, the whole sequence of characters that where
239 composed is recorded in the `struct composition_it' object that is
240 part of the buffer iterator. The composed sequence could produce
241 one or more font glyphs (called "grapheme clusters") on the screen.
242 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
243 in the direction corresponding to the current bidi scan direction
244 (recorded in the scan_dir member of the `struct bidi_it' object
245 that is part of the buffer iterator). In particular, if the bidi
246 iterator currently scans the buffer backwards, the grapheme
247 clusters are delivered back to front. This reorders the grapheme
248 clusters as appropriate for the current bidi context. Note that
249 this means that the grapheme clusters are always stored in the
250 LGSTRING object (see composite.c) in the logical order.
252 Moving an iterator in bidirectional text
253 without producing glyphs
255 Note one important detail mentioned above: that the bidi reordering
256 engine, driven by the iterator, produces characters in R2L rows
257 starting at the character that will be the rightmost on display.
258 As far as the iterator is concerned, the geometry of such rows is
259 still left to right, i.e. the iterator "thinks" the first character
260 is at the leftmost pixel position. The iterator does not know that
261 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
262 delivers. This is important when functions from the move_it_*
263 family are used to get to certain screen position or to match
264 screen coordinates with buffer coordinates: these functions use the
265 iterator geometry, which is left to right even in R2L paragraphs.
266 This works well with most callers of move_it_*, because they need
267 to get to a specific column, and columns are still numbered in the
268 reading order, i.e. the rightmost character in a R2L paragraph is
269 still column zero. But some callers do not get well with this; a
270 notable example is mouse clicks that need to find the character
271 that corresponds to certain pixel coordinates. See
272 buffer_posn_from_coords in dispnew.c for how this is handled. */
280 #include "keyboard.h"
283 #include "termchar.h"
284 #include "dispextern.h"
285 #include "character.h"
289 #include "commands.h"
293 #include "termhooks.h"
294 #include "termopts.h"
295 #include "intervals.h"
298 #include "region-cache.h"
301 #include "blockinput.h"
302 #ifdef HAVE_WINDOW_SYSTEM
304 #endif /* HAVE_WINDOW_SYSTEM */
306 #ifndef FRAME_X_OUTPUT
307 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
310 #define INFINITY 10000000
312 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
313 Lisp_Object Qwindow_scroll_functions
;
314 static Lisp_Object Qwindow_text_change_functions
;
315 static Lisp_Object Qredisplay_end_trigger_functions
;
316 Lisp_Object Qinhibit_point_motion_hooks
;
317 static Lisp_Object QCeval
, QCpropertize
;
318 Lisp_Object QCfile
, QCdata
;
319 static Lisp_Object Qfontified
;
320 static Lisp_Object Qgrow_only
;
321 static Lisp_Object Qinhibit_eval_during_redisplay
;
322 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
323 static Lisp_Object Qright_to_left
, Qleft_to_right
;
326 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
328 /* Pointer shapes. */
329 static Lisp_Object Qarrow
, Qhand
;
332 /* Holds the list (error). */
333 static Lisp_Object list_of_error
;
335 static Lisp_Object Qfontification_functions
;
337 static Lisp_Object Qwrap_prefix
;
338 static Lisp_Object Qline_prefix
;
339 static Lisp_Object Qredisplay_internal
;
341 /* Non-nil means don't actually do any redisplay. */
343 Lisp_Object Qinhibit_redisplay
;
345 /* Names of text properties relevant for redisplay. */
347 Lisp_Object Qdisplay
;
349 Lisp_Object Qspace
, QCalign_to
;
350 static Lisp_Object QCrelative_width
, QCrelative_height
;
351 Lisp_Object Qleft_margin
, Qright_margin
;
352 static Lisp_Object Qspace_width
, Qraise
;
353 static Lisp_Object Qslice
;
355 static Lisp_Object Qmargin
, Qpointer
;
356 static Lisp_Object Qline_height
;
358 #ifdef HAVE_WINDOW_SYSTEM
360 /* Test if overflow newline into fringe. Called with iterator IT
361 at or past right window margin, and with IT->current_x set. */
363 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
364 (!NILP (Voverflow_newline_into_fringe) \
365 && FRAME_WINDOW_P ((IT)->f) \
366 && ((IT)->bidi_it.paragraph_dir == R2L \
367 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
368 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
369 && (IT)->current_x == (IT)->last_visible_x)
371 #else /* !HAVE_WINDOW_SYSTEM */
372 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
373 #endif /* HAVE_WINDOW_SYSTEM */
375 /* Test if the display element loaded in IT, or the underlying buffer
376 or string character, is a space or a TAB character. This is used
377 to determine where word wrapping can occur. */
379 #define IT_DISPLAYING_WHITESPACE(it) \
380 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
381 || ((STRINGP (it->string) \
382 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
383 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
385 && (it->s[IT_BYTEPOS (*it)] == ' ' \
386 || it->s[IT_BYTEPOS (*it)] == '\t')) \
387 || (IT_BYTEPOS (*it) < ZV_BYTE \
388 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
389 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
391 /* Name of the face used to highlight trailing whitespace. */
393 static Lisp_Object Qtrailing_whitespace
;
395 /* Name and number of the face used to highlight escape glyphs. */
397 static Lisp_Object Qescape_glyph
;
399 /* Name and number of the face used to highlight non-breaking spaces. */
401 static Lisp_Object Qnobreak_space
;
403 /* The symbol `image' which is the car of the lists used to represent
404 images in Lisp. Also a tool bar style. */
408 /* The image map types. */
410 static Lisp_Object QCpointer
;
411 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
413 /* Tool bar styles */
414 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
416 /* Non-zero means print newline to stdout before next mini-buffer
419 bool noninteractive_need_newline
;
421 /* Non-zero means print newline to message log before next message. */
423 static bool message_log_need_newline
;
425 /* Three markers that message_dolog uses.
426 It could allocate them itself, but that causes trouble
427 in handling memory-full errors. */
428 static Lisp_Object message_dolog_marker1
;
429 static Lisp_Object message_dolog_marker2
;
430 static Lisp_Object message_dolog_marker3
;
432 /* The buffer position of the first character appearing entirely or
433 partially on the line of the selected window which contains the
434 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
435 redisplay optimization in redisplay_internal. */
437 static struct text_pos this_line_start_pos
;
439 /* Number of characters past the end of the line above, including the
440 terminating newline. */
442 static struct text_pos this_line_end_pos
;
444 /* The vertical positions and the height of this line. */
446 static int this_line_vpos
;
447 static int this_line_y
;
448 static int this_line_pixel_height
;
450 /* X position at which this display line starts. Usually zero;
451 negative if first character is partially visible. */
453 static int this_line_start_x
;
455 /* The smallest character position seen by move_it_* functions as they
456 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
457 hscrolled lines, see display_line. */
459 static struct text_pos this_line_min_pos
;
461 /* Buffer that this_line_.* variables are referring to. */
463 static struct buffer
*this_line_buffer
;
466 /* Values of those variables at last redisplay are stored as
467 properties on `overlay-arrow-position' symbol. However, if
468 Voverlay_arrow_position is a marker, last-arrow-position is its
469 numerical position. */
471 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
473 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
474 properties on a symbol in overlay-arrow-variable-list. */
476 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
478 Lisp_Object Qmenu_bar_update_hook
;
480 /* Nonzero if an overlay arrow has been displayed in this window. */
482 static bool overlay_arrow_seen
;
484 /* Vector containing glyphs for an ellipsis `...'. */
486 static Lisp_Object default_invis_vector
[3];
488 /* This is the window where the echo area message was displayed. It
489 is always a mini-buffer window, but it may not be the same window
490 currently active as a mini-buffer. */
492 Lisp_Object echo_area_window
;
494 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
495 pushes the current message and the value of
496 message_enable_multibyte on the stack, the function restore_message
497 pops the stack and displays MESSAGE again. */
499 static Lisp_Object Vmessage_stack
;
501 /* Nonzero means multibyte characters were enabled when the echo area
502 message was specified. */
504 static bool message_enable_multibyte
;
506 /* Nonzero if we should redraw the mode lines on the next redisplay.
507 If it has value REDISPLAY_SOME, then only redisplay the mode lines where
508 the `redisplay' bit has been set. Otherwise, redisplay all mode lines
509 (the number used is then only used to track down the cause for this
512 int update_mode_lines
;
514 /* Nonzero if window sizes or contents other than selected-window have changed
515 since last redisplay that finished.
516 If it has value REDISPLAY_SOME, then only redisplay the windows where
517 the `redisplay' bit has been set. Otherwise, redisplay all windows
518 (the number used is then only used to track down the cause for this
521 int windows_or_buffers_changed
;
523 /* Nonzero after display_mode_line if %l was used and it displayed a
526 static bool line_number_displayed
;
528 /* The name of the *Messages* buffer, a string. */
530 static Lisp_Object Vmessages_buffer_name
;
532 /* Current, index 0, and last displayed echo area message. Either
533 buffers from echo_buffers, or nil to indicate no message. */
535 Lisp_Object echo_area_buffer
[2];
537 /* The buffers referenced from echo_area_buffer. */
539 static Lisp_Object echo_buffer
[2];
541 /* A vector saved used in with_area_buffer to reduce consing. */
543 static Lisp_Object Vwith_echo_area_save_vector
;
545 /* Non-zero means display_echo_area should display the last echo area
546 message again. Set by redisplay_preserve_echo_area. */
548 static bool display_last_displayed_message_p
;
550 /* Nonzero if echo area is being used by print; zero if being used by
553 static bool message_buf_print
;
555 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
557 static Lisp_Object Qinhibit_menubar_update
;
558 static Lisp_Object Qmessage_truncate_lines
;
560 /* Set to 1 in clear_message to make redisplay_internal aware
561 of an emptied echo area. */
563 static bool message_cleared_p
;
565 /* A scratch glyph row with contents used for generating truncation
566 glyphs. Also used in direct_output_for_insert. */
568 #define MAX_SCRATCH_GLYPHS 100
569 static struct glyph_row scratch_glyph_row
;
570 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
572 /* Ascent and height of the last line processed by move_it_to. */
574 static int last_height
;
576 /* Non-zero if there's a help-echo in the echo area. */
578 bool help_echo_showing_p
;
580 /* The maximum distance to look ahead for text properties. Values
581 that are too small let us call compute_char_face and similar
582 functions too often which is expensive. Values that are too large
583 let us call compute_char_face and alike too often because we
584 might not be interested in text properties that far away. */
586 #define TEXT_PROP_DISTANCE_LIMIT 100
588 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
589 iterator state and later restore it. This is needed because the
590 bidi iterator on bidi.c keeps a stacked cache of its states, which
591 is really a singleton. When we use scratch iterator objects to
592 move around the buffer, we can cause the bidi cache to be pushed or
593 popped, and therefore we need to restore the cache state when we
594 return to the original iterator. */
595 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
598 bidi_unshelve_cache (CACHE, 1); \
600 CACHE = bidi_shelve_cache (); \
603 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
605 if (pITORIG != pITCOPY) \
606 *(pITORIG) = *(pITCOPY); \
607 bidi_unshelve_cache (CACHE, 0); \
611 /* Functions to mark elements as needing redisplay. */
612 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
615 redisplay_other_windows (void)
617 if (!windows_or_buffers_changed
)
618 windows_or_buffers_changed
= REDISPLAY_SOME
;
622 wset_redisplay (struct window
*w
)
624 /* Beware: selected_window can be nil during early stages. */
625 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
626 redisplay_other_windows ();
631 fset_redisplay (struct frame
*f
)
633 redisplay_other_windows ();
638 bset_redisplay (struct buffer
*b
)
640 int count
= buffer_window_count (b
);
643 /* ... it's visible in other window than selected, */
644 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
645 redisplay_other_windows ();
646 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
647 so that if we later set windows_or_buffers_changed, this buffer will
649 b
->text
->redisplay
= true;
654 bset_update_mode_line (struct buffer
*b
)
656 if (!update_mode_lines
)
657 update_mode_lines
= REDISPLAY_SOME
;
658 b
->text
->redisplay
= true;
663 /* Non-zero means print traces of redisplay if compiled with
664 GLYPH_DEBUG defined. */
666 bool trace_redisplay_p
;
668 #endif /* GLYPH_DEBUG */
670 #ifdef DEBUG_TRACE_MOVE
671 /* Non-zero means trace with TRACE_MOVE to stderr. */
674 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
676 #define TRACE_MOVE(x) (void) 0
679 static Lisp_Object Qauto_hscroll_mode
;
681 /* Buffer being redisplayed -- for redisplay_window_error. */
683 static struct buffer
*displayed_buffer
;
685 /* Value returned from text property handlers (see below). */
690 HANDLED_RECOMPUTE_PROPS
,
691 HANDLED_OVERLAY_STRING_CONSUMED
,
695 /* A description of text properties that redisplay is interested
700 /* The name of the property. */
703 /* A unique index for the property. */
706 /* A handler function called to set up iterator IT from the property
707 at IT's current position. Value is used to steer handle_stop. */
708 enum prop_handled (*handler
) (struct it
*it
);
711 static enum prop_handled
handle_face_prop (struct it
*);
712 static enum prop_handled
handle_invisible_prop (struct it
*);
713 static enum prop_handled
handle_display_prop (struct it
*);
714 static enum prop_handled
handle_composition_prop (struct it
*);
715 static enum prop_handled
handle_overlay_change (struct it
*);
716 static enum prop_handled
handle_fontified_prop (struct it
*);
718 /* Properties handled by iterators. */
720 static struct props it_props
[] =
722 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
723 /* Handle `face' before `display' because some sub-properties of
724 `display' need to know the face. */
725 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
726 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
727 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
728 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
732 /* Value is the position described by X. If X is a marker, value is
733 the marker_position of X. Otherwise, value is X. */
735 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
737 /* Enumeration returned by some move_it_.* functions internally. */
741 /* Not used. Undefined value. */
744 /* Move ended at the requested buffer position or ZV. */
745 MOVE_POS_MATCH_OR_ZV
,
747 /* Move ended at the requested X pixel position. */
750 /* Move within a line ended at the end of a line that must be
754 /* Move within a line ended at the end of a line that would
755 be displayed truncated. */
758 /* Move within a line ended at a line end. */
762 /* This counter is used to clear the face cache every once in a while
763 in redisplay_internal. It is incremented for each redisplay.
764 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
767 #define CLEAR_FACE_CACHE_COUNT 500
768 static int clear_face_cache_count
;
770 /* Similarly for the image cache. */
772 #ifdef HAVE_WINDOW_SYSTEM
773 #define CLEAR_IMAGE_CACHE_COUNT 101
774 static int clear_image_cache_count
;
776 /* Null glyph slice */
777 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
780 /* True while redisplay_internal is in progress. */
784 static Lisp_Object Qinhibit_free_realized_faces
;
785 static Lisp_Object Qmode_line_default_help_echo
;
787 /* If a string, XTread_socket generates an event to display that string.
788 (The display is done in read_char.) */
790 Lisp_Object help_echo_string
;
791 Lisp_Object help_echo_window
;
792 Lisp_Object help_echo_object
;
793 ptrdiff_t help_echo_pos
;
795 /* Temporary variable for XTread_socket. */
797 Lisp_Object previous_help_echo_string
;
799 /* Platform-independent portion of hourglass implementation. */
801 #ifdef HAVE_WINDOW_SYSTEM
803 /* Non-zero means an hourglass cursor is currently shown. */
804 bool hourglass_shown_p
;
806 /* If non-null, an asynchronous timer that, when it expires, displays
807 an hourglass cursor on all frames. */
808 struct atimer
*hourglass_atimer
;
810 #endif /* HAVE_WINDOW_SYSTEM */
812 /* Name of the face used to display glyphless characters. */
813 static Lisp_Object Qglyphless_char
;
815 /* Symbol for the purpose of Vglyphless_char_display. */
816 static Lisp_Object Qglyphless_char_display
;
818 /* Method symbols for Vglyphless_char_display. */
819 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
821 /* Default number of seconds to wait before displaying an hourglass
823 #define DEFAULT_HOURGLASS_DELAY 1
825 #ifdef HAVE_WINDOW_SYSTEM
827 /* Default pixel width of `thin-space' display method. */
828 #define THIN_SPACE_WIDTH 1
830 #endif /* HAVE_WINDOW_SYSTEM */
832 /* Function prototypes. */
834 static void setup_for_ellipsis (struct it
*, int);
835 static void set_iterator_to_next (struct it
*, int);
836 static void mark_window_display_accurate_1 (struct window
*, int);
837 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
838 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
839 static int row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
840 static int cursor_row_p (struct glyph_row
*);
841 static int redisplay_mode_lines (Lisp_Object
, bool);
842 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
844 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
846 static void handle_line_prefix (struct it
*);
848 static void pint2str (char *, int, ptrdiff_t);
849 static void pint2hrstr (char *, int, ptrdiff_t);
850 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
852 static int text_outside_line_unchanged_p (struct window
*,
853 ptrdiff_t, ptrdiff_t);
854 static void store_mode_line_noprop_char (char);
855 static int store_mode_line_noprop (const char *, int, int);
856 static void handle_stop (struct it
*);
857 static void handle_stop_backwards (struct it
*, ptrdiff_t);
858 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
859 static void ensure_echo_area_buffers (void);
860 static void unwind_with_echo_area_buffer (Lisp_Object
);
861 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
862 static int with_echo_area_buffer (struct window
*, int,
863 int (*) (ptrdiff_t, Lisp_Object
),
864 ptrdiff_t, Lisp_Object
);
865 static void clear_garbaged_frames (void);
866 static int current_message_1 (ptrdiff_t, Lisp_Object
);
867 static int truncate_message_1 (ptrdiff_t, Lisp_Object
);
868 static void set_message (Lisp_Object
);
869 static int set_message_1 (ptrdiff_t, Lisp_Object
);
870 static int display_echo_area (struct window
*);
871 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
);
872 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
873 static void unwind_redisplay (void);
874 static int string_char_and_length (const unsigned char *, int *);
875 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
877 static int compute_window_start_on_continuation_line (struct window
*);
878 static void insert_left_trunc_glyphs (struct it
*);
879 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
881 static void extend_face_to_end_of_line (struct it
*);
882 static int append_space_for_newline (struct it
*, int);
883 static int cursor_row_fully_visible_p (struct window
*, int, int);
884 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
885 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
886 static int trailing_whitespace_p (ptrdiff_t);
887 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
888 static void push_it (struct it
*, struct text_pos
*);
889 static void iterate_out_of_display_property (struct it
*);
890 static void pop_it (struct it
*);
891 static void sync_frame_with_window_matrix_rows (struct window
*);
892 static void redisplay_internal (void);
893 static int echo_area_display (int);
894 static void redisplay_windows (Lisp_Object
);
895 static void redisplay_window (Lisp_Object
, bool);
896 static Lisp_Object
redisplay_window_error (Lisp_Object
);
897 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
898 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
899 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
900 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
902 static int update_menu_bar (struct frame
*, int, int);
903 static int try_window_reusing_current_matrix (struct window
*);
904 static int try_window_id (struct window
*);
905 static int display_line (struct it
*);
906 static int display_mode_lines (struct window
*);
907 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
908 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
909 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
910 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
911 static void display_menu_bar (struct window
*);
912 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
914 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
915 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
916 static void compute_line_metrics (struct it
*);
917 static void run_redisplay_end_trigger_hook (struct it
*);
918 static int get_overlay_strings (struct it
*, ptrdiff_t);
919 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
920 static void next_overlay_string (struct it
*);
921 static void reseat (struct it
*, struct text_pos
, int);
922 static void reseat_1 (struct it
*, struct text_pos
, int);
923 static void back_to_previous_visible_line_start (struct it
*);
924 static void reseat_at_next_visible_line_start (struct it
*, int);
925 static int next_element_from_ellipsis (struct it
*);
926 static int next_element_from_display_vector (struct it
*);
927 static int next_element_from_string (struct it
*);
928 static int next_element_from_c_string (struct it
*);
929 static int next_element_from_buffer (struct it
*);
930 static int next_element_from_composition (struct it
*);
931 static int next_element_from_image (struct it
*);
932 static int next_element_from_stretch (struct it
*);
933 static void load_overlay_strings (struct it
*, ptrdiff_t);
934 static int init_from_display_pos (struct it
*, struct window
*,
935 struct display_pos
*);
936 static void reseat_to_string (struct it
*, const char *,
937 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
938 static int get_next_display_element (struct it
*);
939 static enum move_it_result
940 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
941 enum move_operation_enum
);
942 static void get_visually_first_element (struct it
*);
943 static void init_to_row_start (struct it
*, struct window
*,
945 static int init_to_row_end (struct it
*, struct window
*,
947 static void back_to_previous_line_start (struct it
*);
948 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
949 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
950 Lisp_Object
, ptrdiff_t);
951 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
952 static struct text_pos
c_string_pos (ptrdiff_t, const char *, bool);
953 static ptrdiff_t number_of_chars (const char *, bool);
954 static void compute_stop_pos (struct it
*);
955 static void compute_string_pos (struct text_pos
*, struct text_pos
,
957 static int face_before_or_after_it_pos (struct it
*, int);
958 static ptrdiff_t next_overlay_change (ptrdiff_t);
959 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
960 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
961 static int handle_single_display_spec (struct it
*, Lisp_Object
,
962 Lisp_Object
, Lisp_Object
,
963 struct text_pos
*, ptrdiff_t, int, int);
964 static int underlying_face_id (struct it
*);
965 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
968 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
969 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
971 #ifdef HAVE_WINDOW_SYSTEM
973 static void x_consider_frame_title (Lisp_Object
);
974 static void update_tool_bar (struct frame
*, int);
975 static int redisplay_tool_bar (struct frame
*);
976 static void x_draw_bottom_divider (struct window
*w
);
977 static void notice_overwritten_cursor (struct window
*,
980 static void append_stretch_glyph (struct it
*, Lisp_Object
,
984 #endif /* HAVE_WINDOW_SYSTEM */
986 static void produce_special_glyphs (struct it
*, enum display_element_type
);
987 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
988 static bool coords_in_mouse_face_p (struct window
*, int, int);
992 /***********************************************************************
993 Window display dimensions
994 ***********************************************************************/
996 /* Return the bottom boundary y-position for text lines in window W.
997 This is the first y position at which a line cannot start.
998 It is relative to the top of the window.
1000 This is the height of W minus the height of a mode line, if any. */
1003 window_text_bottom_y (struct window
*w
)
1005 int height
= WINDOW_PIXEL_HEIGHT (w
);
1007 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1009 if (WINDOW_WANTS_MODELINE_P (w
))
1010 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1015 /* Return the pixel width of display area AREA of window W.
1016 ANY_AREA means return the total width of W, not including
1017 fringes to the left and right of the window. */
1020 window_box_width (struct window
*w
, enum glyph_row_area area
)
1022 int width
= w
->pixel_width
;
1024 if (!w
->pseudo_window_p
)
1026 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
1027 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
1029 if (area
== TEXT_AREA
)
1030 width
-= (WINDOW_MARGINS_WIDTH (w
)
1031 + WINDOW_FRINGES_WIDTH (w
));
1032 else if (area
== LEFT_MARGIN_AREA
)
1033 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
1034 else if (area
== RIGHT_MARGIN_AREA
)
1035 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
1038 /* With wide margins, fringes, etc. we might end up with a negative
1039 width, correct that here. */
1040 return max (0, width
);
1044 /* Return the pixel height of the display area of window W, not
1045 including mode lines of W, if any. */
1048 window_box_height (struct window
*w
)
1050 struct frame
*f
= XFRAME (w
->frame
);
1051 int height
= WINDOW_PIXEL_HEIGHT (w
);
1053 eassert (height
>= 0);
1055 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1057 /* Note: the code below that determines the mode-line/header-line
1058 height is essentially the same as that contained in the macro
1059 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1060 the appropriate glyph row has its `mode_line_p' flag set,
1061 and if it doesn't, uses estimate_mode_line_height instead. */
1063 if (WINDOW_WANTS_MODELINE_P (w
))
1065 struct glyph_row
*ml_row
1066 = (w
->current_matrix
&& w
->current_matrix
->rows
1067 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1069 if (ml_row
&& ml_row
->mode_line_p
)
1070 height
-= ml_row
->height
;
1072 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1075 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1077 struct glyph_row
*hl_row
1078 = (w
->current_matrix
&& w
->current_matrix
->rows
1079 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1081 if (hl_row
&& hl_row
->mode_line_p
)
1082 height
-= hl_row
->height
;
1084 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1087 /* With a very small font and a mode-line that's taller than
1088 default, we might end up with a negative height. */
1089 return max (0, height
);
1092 /* Return the window-relative coordinate of the left edge of display
1093 area AREA of window W. ANY_AREA means return the left edge of the
1094 whole window, to the right of the left fringe of W. */
1097 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1101 if (w
->pseudo_window_p
)
1104 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1106 if (area
== TEXT_AREA
)
1107 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1108 + window_box_width (w
, LEFT_MARGIN_AREA
));
1109 else if (area
== RIGHT_MARGIN_AREA
)
1110 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1111 + window_box_width (w
, LEFT_MARGIN_AREA
)
1112 + window_box_width (w
, TEXT_AREA
)
1113 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1115 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1116 else if (area
== LEFT_MARGIN_AREA
1117 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1118 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1120 /* Don't return more than the window's pixel width. */
1121 return min (x
, w
->pixel_width
);
1125 /* Return the window-relative coordinate of the right edge of display
1126 area AREA of window W. ANY_AREA means return the right edge of the
1127 whole window, to the left of the right fringe of W. */
1130 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1132 /* Don't return more than the window's pixel width. */
1133 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1137 /* Return the frame-relative coordinate of the left edge of display
1138 area AREA of window W. ANY_AREA means return the left edge of the
1139 whole window, to the right of the left fringe of W. */
1142 window_box_left (struct window
*w
, enum glyph_row_area area
)
1144 struct frame
*f
= XFRAME (w
->frame
);
1147 if (w
->pseudo_window_p
)
1148 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1150 x
= (WINDOW_LEFT_EDGE_X (w
)
1151 + window_box_left_offset (w
, area
));
1157 /* Return the frame-relative coordinate of the right edge of display
1158 area AREA of window W. ANY_AREA means return the right edge of the
1159 whole window, to the left of the right fringe of W. */
1162 window_box_right (struct window
*w
, enum glyph_row_area area
)
1164 return window_box_left (w
, area
) + window_box_width (w
, area
);
1167 /* Get the bounding box of the display area AREA of window W, without
1168 mode lines, in frame-relative coordinates. ANY_AREA means the
1169 whole window, not including the left and right fringes of
1170 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1171 coordinates of the upper-left corner of the box. Return in
1172 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1175 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1176 int *box_y
, int *box_width
, int *box_height
)
1179 *box_width
= window_box_width (w
, area
);
1181 *box_height
= window_box_height (w
);
1183 *box_x
= window_box_left (w
, area
);
1186 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1187 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1188 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1192 #ifdef HAVE_WINDOW_SYSTEM
1194 /* Get the bounding box of the display area AREA of window W, without
1195 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1196 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1197 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1198 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1202 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1203 int *bottom_right_x
, int *bottom_right_y
)
1205 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1206 bottom_right_x
, bottom_right_y
);
1207 *bottom_right_x
+= *top_left_x
;
1208 *bottom_right_y
+= *top_left_y
;
1211 #endif /* HAVE_WINDOW_SYSTEM */
1213 /***********************************************************************
1215 ***********************************************************************/
1217 /* Return the bottom y-position of the line the iterator IT is in.
1218 This can modify IT's settings. */
1221 line_bottom_y (struct it
*it
)
1223 int line_height
= it
->max_ascent
+ it
->max_descent
;
1224 int line_top_y
= it
->current_y
;
1226 if (line_height
== 0)
1229 line_height
= last_height
;
1230 else if (IT_CHARPOS (*it
) < ZV
)
1232 move_it_by_lines (it
, 1);
1233 line_height
= (it
->max_ascent
|| it
->max_descent
1234 ? it
->max_ascent
+ it
->max_descent
1239 struct glyph_row
*row
= it
->glyph_row
;
1241 /* Use the default character height. */
1242 it
->glyph_row
= NULL
;
1243 it
->what
= IT_CHARACTER
;
1246 PRODUCE_GLYPHS (it
);
1247 line_height
= it
->ascent
+ it
->descent
;
1248 it
->glyph_row
= row
;
1252 return line_top_y
+ line_height
;
1255 DEFUN ("line-pixel-height", Fline_pixel_height
,
1256 Sline_pixel_height
, 0, 0, 0,
1257 doc
: /* Return height in pixels of text line in the selected window.
1259 Value is the height in pixels of the line at point. */)
1264 struct window
*w
= XWINDOW (selected_window
);
1265 struct buffer
*old_buffer
= NULL
;
1268 if (XBUFFER (w
->contents
) != current_buffer
)
1270 old_buffer
= current_buffer
;
1271 set_buffer_internal_1 (XBUFFER (w
->contents
));
1273 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1274 start_display (&it
, w
, pt
);
1275 it
.vpos
= it
.current_y
= 0;
1277 result
= make_number (line_bottom_y (&it
));
1279 set_buffer_internal_1 (old_buffer
);
1284 /* Return the default pixel height of text lines in window W. The
1285 value is the canonical height of the W frame's default font, plus
1286 any extra space required by the line-spacing variable or frame
1289 Implementation note: this ignores any line-spacing text properties
1290 put on the newline characters. This is because those properties
1291 only affect the _screen_ line ending in the newline (i.e., in a
1292 continued line, only the last screen line will be affected), which
1293 means only a small number of lines in a buffer can ever use this
1294 feature. Since this function is used to compute the default pixel
1295 equivalent of text lines in a window, we can safely ignore those
1296 few lines. For the same reasons, we ignore the line-height
1299 default_line_pixel_height (struct window
*w
)
1301 struct frame
*f
= WINDOW_XFRAME (w
);
1302 int height
= FRAME_LINE_HEIGHT (f
);
1304 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1306 struct buffer
*b
= XBUFFER (w
->contents
);
1307 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1310 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1313 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1314 height
+= XFASTINT (val
);
1315 else if (FLOATP (val
))
1317 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1324 height
+= f
->extra_line_spacing
;
1330 /* Subroutine of pos_visible_p below. Extracts a display string, if
1331 any, from the display spec given as its argument. */
1333 string_from_display_spec (Lisp_Object spec
)
1337 while (CONSP (spec
))
1339 if (STRINGP (XCAR (spec
)))
1344 else if (VECTORP (spec
))
1348 for (i
= 0; i
< ASIZE (spec
); i
++)
1350 if (STRINGP (AREF (spec
, i
)))
1351 return AREF (spec
, i
);
1360 /* Limit insanely large values of W->hscroll on frame F to the largest
1361 value that will still prevent first_visible_x and last_visible_x of
1362 'struct it' from overflowing an int. */
1364 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1366 ptrdiff_t window_hscroll
= w
->hscroll
;
1367 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1368 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1370 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1371 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1373 return window_hscroll
;
1376 /* Return 1 if position CHARPOS is visible in window W.
1377 CHARPOS < 0 means return info about WINDOW_END position.
1378 If visible, set *X and *Y to pixel coordinates of top left corner.
1379 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1380 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1383 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1384 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1387 void *itdata
= bidi_shelve_cache ();
1388 struct text_pos top
;
1390 struct buffer
*old_buffer
= NULL
;
1392 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1395 if (XBUFFER (w
->contents
) != current_buffer
)
1397 old_buffer
= current_buffer
;
1398 set_buffer_internal_1 (XBUFFER (w
->contents
));
1401 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1402 /* Scrolling a minibuffer window via scroll bar when the echo area
1403 shows long text sometimes resets the minibuffer contents behind
1405 if (CHARPOS (top
) > ZV
)
1406 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1408 /* Compute exact mode line heights. */
1409 if (WINDOW_WANTS_MODELINE_P (w
))
1411 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1412 BVAR (current_buffer
, mode_line_format
));
1414 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1415 w
->header_line_height
1416 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1417 BVAR (current_buffer
, header_line_format
));
1419 start_display (&it
, w
, top
);
1420 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1421 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1424 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1425 && IT_CHARPOS (it
) >= charpos
)
1426 /* When scanning backwards under bidi iteration, move_it_to
1427 stops at or _before_ CHARPOS, because it stops at or to
1428 the _right_ of the character at CHARPOS. */
1429 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1430 && IT_CHARPOS (it
) <= charpos
)))
1432 /* We have reached CHARPOS, or passed it. How the call to
1433 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1434 or covered by a display property, move_it_to stops at the end
1435 of the invisible text, to the right of CHARPOS. (ii) If
1436 CHARPOS is in a display vector, move_it_to stops on its last
1438 int top_x
= it
.current_x
;
1439 int top_y
= it
.current_y
;
1440 /* Calling line_bottom_y may change it.method, it.position, etc. */
1441 enum it_method it_method
= it
.method
;
1442 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1443 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1445 if (top_y
< window_top_y
)
1446 visible_p
= bottom_y
> window_top_y
;
1447 else if (top_y
< it
.last_visible_y
)
1449 if (bottom_y
>= it
.last_visible_y
1450 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1451 && IT_CHARPOS (it
) < charpos
)
1453 /* When the last line of the window is scanned backwards
1454 under bidi iteration, we could be duped into thinking
1455 that we have passed CHARPOS, when in fact move_it_to
1456 simply stopped short of CHARPOS because it reached
1457 last_visible_y. To see if that's what happened, we call
1458 move_it_to again with a slightly larger vertical limit,
1459 and see if it actually moved vertically; if it did, we
1460 didn't really reach CHARPOS, which is beyond window end. */
1461 struct it save_it
= it
;
1462 /* Why 10? because we don't know how many canonical lines
1463 will the height of the next line(s) be. So we guess. */
1464 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1466 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1467 MOVE_TO_POS
| MOVE_TO_Y
);
1468 if (it
.current_y
> top_y
)
1475 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1477 /* We stopped on the last glyph of a display vector.
1478 Try and recompute. Hack alert! */
1479 if (charpos
< 2 || top
.charpos
>= charpos
)
1480 top_x
= it
.glyph_row
->x
;
1483 struct it it2
, it2_prev
;
1484 /* The idea is to get to the previous buffer
1485 position, consume the character there, and use
1486 the pixel coordinates we get after that. But if
1487 the previous buffer position is also displayed
1488 from a display vector, we need to consume all of
1489 the glyphs from that display vector. */
1490 start_display (&it2
, w
, top
);
1491 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1492 /* If we didn't get to CHARPOS - 1, there's some
1493 replacing display property at that position, and
1494 we stopped after it. That is exactly the place
1495 whose coordinates we want. */
1496 if (IT_CHARPOS (it2
) != charpos
- 1)
1500 /* Iterate until we get out of the display
1501 vector that displays the character at
1504 get_next_display_element (&it2
);
1505 PRODUCE_GLYPHS (&it2
);
1507 set_iterator_to_next (&it2
, 1);
1508 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1509 && IT_CHARPOS (it2
) < charpos
);
1511 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1512 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1513 top_x
= it
.glyph_row
->x
;
1516 top_x
= it2_prev
.current_x
;
1517 top_y
= it2_prev
.current_y
;
1521 else if (IT_CHARPOS (it
) != charpos
)
1523 Lisp_Object cpos
= make_number (charpos
);
1524 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1525 Lisp_Object string
= string_from_display_spec (spec
);
1526 struct text_pos tpos
;
1527 int replacing_spec_p
;
1528 bool newline_in_string
1530 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1532 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1535 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1536 charpos
, FRAME_WINDOW_P (it
.f
)));
1537 /* The tricky code below is needed because there's a
1538 discrepancy between move_it_to and how we set cursor
1539 when PT is at the beginning of a portion of text
1540 covered by a display property or an overlay with a
1541 display property, or the display line ends in a
1542 newline from a display string. move_it_to will stop
1543 _after_ such display strings, whereas
1544 set_cursor_from_row conspires with cursor_row_p to
1545 place the cursor on the first glyph produced from the
1548 /* We have overshoot PT because it is covered by a
1549 display property that replaces the text it covers.
1550 If the string includes embedded newlines, we are also
1551 in the wrong display line. Backtrack to the correct
1552 line, where the display property begins. */
1553 if (replacing_spec_p
)
1555 Lisp_Object startpos
, endpos
;
1556 EMACS_INT start
, end
;
1560 /* Find the first and the last buffer positions
1561 covered by the display string. */
1563 Fnext_single_char_property_change (cpos
, Qdisplay
,
1566 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1568 start
= XFASTINT (startpos
);
1569 end
= XFASTINT (endpos
);
1570 /* Move to the last buffer position before the
1571 display property. */
1572 start_display (&it3
, w
, top
);
1573 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1574 /* Move forward one more line if the position before
1575 the display string is a newline or if it is the
1576 rightmost character on a line that is
1577 continued or word-wrapped. */
1578 if (it3
.method
== GET_FROM_BUFFER
1580 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1581 move_it_by_lines (&it3
, 1);
1582 else if (move_it_in_display_line_to (&it3
, -1,
1586 == MOVE_LINE_CONTINUED
)
1588 move_it_by_lines (&it3
, 1);
1589 /* When we are under word-wrap, the #$@%!
1590 move_it_by_lines moves 2 lines, so we need to
1592 if (it3
.line_wrap
== WORD_WRAP
)
1593 move_it_by_lines (&it3
, -1);
1596 /* Record the vertical coordinate of the display
1597 line where we wound up. */
1598 top_y
= it3
.current_y
;
1601 /* When characters are reordered for display,
1602 the character displayed to the left of the
1603 display string could be _after_ the display
1604 property in the logical order. Use the
1605 smallest vertical position of these two. */
1606 start_display (&it3
, w
, top
);
1607 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1608 if (it3
.current_y
< top_y
)
1609 top_y
= it3
.current_y
;
1611 /* Move from the top of the window to the beginning
1612 of the display line where the display string
1614 start_display (&it3
, w
, top
);
1615 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1616 /* If it3_moved stays zero after the 'while' loop
1617 below, that means we already were at a newline
1618 before the loop (e.g., the display string begins
1619 with a newline), so we don't need to (and cannot)
1620 inspect the glyphs of it3.glyph_row, because
1621 PRODUCE_GLYPHS will not produce anything for a
1622 newline, and thus it3.glyph_row stays at its
1623 stale content it got at top of the window. */
1625 /* Finally, advance the iterator until we hit the
1626 first display element whose character position is
1627 CHARPOS, or until the first newline from the
1628 display string, which signals the end of the
1630 while (get_next_display_element (&it3
))
1632 PRODUCE_GLYPHS (&it3
);
1633 if (IT_CHARPOS (it3
) == charpos
1634 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1637 set_iterator_to_next (&it3
, 0);
1639 top_x
= it3
.current_x
- it3
.pixel_width
;
1640 /* Normally, we would exit the above loop because we
1641 found the display element whose character
1642 position is CHARPOS. For the contingency that we
1643 didn't, and stopped at the first newline from the
1644 display string, move back over the glyphs
1645 produced from the string, until we find the
1646 rightmost glyph not from the string. */
1648 && newline_in_string
1649 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1651 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1652 + it3
.glyph_row
->used
[TEXT_AREA
];
1654 while (EQ ((g
- 1)->object
, string
))
1657 top_x
-= g
->pixel_width
;
1659 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1660 + it3
.glyph_row
->used
[TEXT_AREA
]);
1666 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1667 *rtop
= max (0, window_top_y
- top_y
);
1668 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1669 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1670 - max (top_y
, window_top_y
)));
1676 /* We were asked to provide info about WINDOW_END. */
1678 void *it2data
= NULL
;
1680 SAVE_IT (it2
, it
, it2data
);
1681 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1682 move_it_by_lines (&it
, 1);
1683 if (charpos
< IT_CHARPOS (it
)
1684 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1687 RESTORE_IT (&it2
, &it2
, it2data
);
1688 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1690 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1691 *rtop
= max (0, -it2
.current_y
);
1692 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1693 - it
.last_visible_y
));
1694 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1696 - max (it2
.current_y
,
1697 WINDOW_HEADER_LINE_HEIGHT (w
))));
1701 bidi_unshelve_cache (it2data
, 1);
1703 bidi_unshelve_cache (itdata
, 0);
1706 set_buffer_internal_1 (old_buffer
);
1708 if (visible_p
&& w
->hscroll
> 0)
1710 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1711 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1714 /* Debugging code. */
1716 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1717 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1719 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1726 /* Return the next character from STR. Return in *LEN the length of
1727 the character. This is like STRING_CHAR_AND_LENGTH but never
1728 returns an invalid character. If we find one, we return a `?', but
1729 with the length of the invalid character. */
1732 string_char_and_length (const unsigned char *str
, int *len
)
1736 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1737 if (!CHAR_VALID_P (c
))
1738 /* We may not change the length here because other places in Emacs
1739 don't use this function, i.e. they silently accept invalid
1748 /* Given a position POS containing a valid character and byte position
1749 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1751 static struct text_pos
1752 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1754 eassert (STRINGP (string
) && nchars
>= 0);
1756 if (STRING_MULTIBYTE (string
))
1758 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1763 string_char_and_length (p
, &len
);
1766 BYTEPOS (pos
) += len
;
1770 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1776 /* Value is the text position, i.e. character and byte position,
1777 for character position CHARPOS in STRING. */
1779 static struct text_pos
1780 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1782 struct text_pos pos
;
1783 eassert (STRINGP (string
));
1784 eassert (charpos
>= 0);
1785 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1790 /* Value is a text position, i.e. character and byte position, for
1791 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1792 means recognize multibyte characters. */
1794 static struct text_pos
1795 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1797 struct text_pos pos
;
1799 eassert (s
!= NULL
);
1800 eassert (charpos
>= 0);
1806 SET_TEXT_POS (pos
, 0, 0);
1809 string_char_and_length ((const unsigned char *) s
, &len
);
1812 BYTEPOS (pos
) += len
;
1816 SET_TEXT_POS (pos
, charpos
, charpos
);
1822 /* Value is the number of characters in C string S. MULTIBYTE_P
1823 non-zero means recognize multibyte characters. */
1826 number_of_chars (const char *s
, bool multibyte_p
)
1832 ptrdiff_t rest
= strlen (s
);
1834 const unsigned char *p
= (const unsigned char *) s
;
1836 for (nchars
= 0; rest
> 0; ++nchars
)
1838 string_char_and_length (p
, &len
);
1839 rest
-= len
, p
+= len
;
1843 nchars
= strlen (s
);
1849 /* Compute byte position NEWPOS->bytepos corresponding to
1850 NEWPOS->charpos. POS is a known position in string STRING.
1851 NEWPOS->charpos must be >= POS.charpos. */
1854 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1856 eassert (STRINGP (string
));
1857 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1859 if (STRING_MULTIBYTE (string
))
1860 *newpos
= string_pos_nchars_ahead (pos
, string
,
1861 CHARPOS (*newpos
) - CHARPOS (pos
));
1863 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1867 Return an estimation of the pixel height of mode or header lines on
1868 frame F. FACE_ID specifies what line's height to estimate. */
1871 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1873 #ifdef HAVE_WINDOW_SYSTEM
1874 if (FRAME_WINDOW_P (f
))
1876 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1878 /* This function is called so early when Emacs starts that the face
1879 cache and mode line face are not yet initialized. */
1880 if (FRAME_FACE_CACHE (f
))
1882 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1886 height
= FONT_HEIGHT (face
->font
);
1887 if (face
->box_line_width
> 0)
1888 height
+= 2 * face
->box_line_width
;
1899 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1900 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1901 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1902 not force the value into range. */
1905 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1906 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1909 #ifdef HAVE_WINDOW_SYSTEM
1910 if (FRAME_WINDOW_P (f
))
1912 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1913 even for negative values. */
1915 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1917 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1919 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1920 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1923 STORE_NATIVE_RECT (*bounds
,
1924 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1925 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1926 FRAME_COLUMN_WIDTH (f
) - 1,
1927 FRAME_LINE_HEIGHT (f
) - 1);
1929 /* PXW: Should we clip pixels before converting to columns/lines? */
1934 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1935 pix_x
= FRAME_TOTAL_COLS (f
);
1939 else if (pix_y
> FRAME_LINES (f
))
1940 pix_y
= FRAME_LINES (f
);
1950 /* Find the glyph under window-relative coordinates X/Y in window W.
1951 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1952 strings. Return in *HPOS and *VPOS the row and column number of
1953 the glyph found. Return in *AREA the glyph area containing X.
1954 Value is a pointer to the glyph found or null if X/Y is not on
1955 text, or we can't tell because W's current matrix is not up to
1958 static struct glyph
*
1959 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1960 int *dx
, int *dy
, int *area
)
1962 struct glyph
*glyph
, *end
;
1963 struct glyph_row
*row
= NULL
;
1966 /* Find row containing Y. Give up if some row is not enabled. */
1967 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1969 row
= MATRIX_ROW (w
->current_matrix
, i
);
1970 if (!row
->enabled_p
)
1972 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1979 /* Give up if Y is not in the window. */
1980 if (i
== w
->current_matrix
->nrows
)
1983 /* Get the glyph area containing X. */
1984 if (w
->pseudo_window_p
)
1991 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1993 *area
= LEFT_MARGIN_AREA
;
1994 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1996 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1999 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
2003 *area
= RIGHT_MARGIN_AREA
;
2004 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
2008 /* Find glyph containing X. */
2009 glyph
= row
->glyphs
[*area
];
2010 end
= glyph
+ row
->used
[*area
];
2012 while (glyph
< end
&& x
>= glyph
->pixel_width
)
2014 x
-= glyph
->pixel_width
;
2024 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
2027 *hpos
= glyph
- row
->glyphs
[*area
];
2031 /* Convert frame-relative x/y to coordinates relative to window W.
2032 Takes pseudo-windows into account. */
2035 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
2037 if (w
->pseudo_window_p
)
2039 /* A pseudo-window is always full-width, and starts at the
2040 left edge of the frame, plus a frame border. */
2041 struct frame
*f
= XFRAME (w
->frame
);
2042 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
2043 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2047 *x
-= WINDOW_LEFT_EDGE_X (w
);
2048 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2052 #ifdef HAVE_WINDOW_SYSTEM
2055 Return in RECTS[] at most N clipping rectangles for glyph string S.
2056 Return the number of stored rectangles. */
2059 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2066 if (s
->row
->full_width_p
)
2068 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2069 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2070 if (s
->row
->mode_line_p
)
2071 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2073 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2075 /* Unless displaying a mode or menu bar line, which are always
2076 fully visible, clip to the visible part of the row. */
2077 if (s
->w
->pseudo_window_p
)
2078 r
.height
= s
->row
->visible_height
;
2080 r
.height
= s
->height
;
2084 /* This is a text line that may be partially visible. */
2085 r
.x
= window_box_left (s
->w
, s
->area
);
2086 r
.width
= window_box_width (s
->w
, s
->area
);
2087 r
.height
= s
->row
->visible_height
;
2091 if (r
.x
< s
->clip_head
->x
)
2093 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2094 r
.width
-= s
->clip_head
->x
- r
.x
;
2097 r
.x
= s
->clip_head
->x
;
2100 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2102 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2103 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2108 /* If S draws overlapping rows, it's sufficient to use the top and
2109 bottom of the window for clipping because this glyph string
2110 intentionally draws over other lines. */
2111 if (s
->for_overlaps
)
2113 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2114 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2116 /* Alas, the above simple strategy does not work for the
2117 environments with anti-aliased text: if the same text is
2118 drawn onto the same place multiple times, it gets thicker.
2119 If the overlap we are processing is for the erased cursor, we
2120 take the intersection with the rectangle of the cursor. */
2121 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2123 XRectangle rc
, r_save
= r
;
2125 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2126 rc
.y
= s
->w
->phys_cursor
.y
;
2127 rc
.width
= s
->w
->phys_cursor_width
;
2128 rc
.height
= s
->w
->phys_cursor_height
;
2130 x_intersect_rectangles (&r_save
, &rc
, &r
);
2135 /* Don't use S->y for clipping because it doesn't take partially
2136 visible lines into account. For example, it can be negative for
2137 partially visible lines at the top of a window. */
2138 if (!s
->row
->full_width_p
2139 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2140 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2142 r
.y
= max (0, s
->row
->y
);
2145 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2147 /* If drawing the cursor, don't let glyph draw outside its
2148 advertised boundaries. Cleartype does this under some circumstances. */
2149 if (s
->hl
== DRAW_CURSOR
)
2151 struct glyph
*glyph
= s
->first_glyph
;
2156 r
.width
-= s
->x
- r
.x
;
2159 r
.width
= min (r
.width
, glyph
->pixel_width
);
2161 /* If r.y is below window bottom, ensure that we still see a cursor. */
2162 height
= min (glyph
->ascent
+ glyph
->descent
,
2163 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2164 max_y
= window_text_bottom_y (s
->w
) - height
;
2165 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2166 if (s
->ybase
- glyph
->ascent
> max_y
)
2173 /* Don't draw cursor glyph taller than our actual glyph. */
2174 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2175 if (height
< r
.height
)
2177 max_y
= r
.y
+ r
.height
;
2178 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2179 r
.height
= min (max_y
- r
.y
, height
);
2186 XRectangle r_save
= r
;
2188 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2192 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2193 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2195 #ifdef CONVERT_FROM_XRECT
2196 CONVERT_FROM_XRECT (r
, *rects
);
2204 /* If we are processing overlapping and allowed to return
2205 multiple clipping rectangles, we exclude the row of the glyph
2206 string from the clipping rectangle. This is to avoid drawing
2207 the same text on the environment with anti-aliasing. */
2208 #ifdef CONVERT_FROM_XRECT
2211 XRectangle
*rs
= rects
;
2213 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2215 if (s
->for_overlaps
& OVERLAPS_PRED
)
2218 if (r
.y
+ r
.height
> row_y
)
2221 rs
[i
].height
= row_y
- r
.y
;
2227 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2230 if (r
.y
< row_y
+ s
->row
->visible_height
)
2232 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2234 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2235 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2244 #ifdef CONVERT_FROM_XRECT
2245 for (i
= 0; i
< n
; i
++)
2246 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2253 Return in *NR the clipping rectangle for glyph string S. */
2256 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2258 get_glyph_string_clip_rects (s
, nr
, 1);
2263 Return the position and height of the phys cursor in window W.
2264 Set w->phys_cursor_width to width of phys cursor.
2268 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2269 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2271 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2272 int x
, y
, wd
, h
, h0
, y0
;
2274 /* Compute the width of the rectangle to draw. If on a stretch
2275 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2276 rectangle as wide as the glyph, but use a canonical character
2278 wd
= glyph
->pixel_width
- 1;
2279 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2283 x
= w
->phys_cursor
.x
;
2290 if (glyph
->type
== STRETCH_GLYPH
2291 && !x_stretch_cursor_p
)
2292 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2293 w
->phys_cursor_width
= wd
;
2295 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2297 /* If y is below window bottom, ensure that we still see a cursor. */
2298 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2300 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2301 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2303 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2306 h
= max (h
- (y0
- y
) + 1, h0
);
2311 y0
= window_text_bottom_y (w
) - h0
;
2319 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2320 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2325 * Remember which glyph the mouse is over.
2329 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2333 struct glyph_row
*r
, *gr
, *end_row
;
2334 enum window_part part
;
2335 enum glyph_row_area area
;
2336 int x
, y
, width
, height
;
2338 /* Try to determine frame pixel position and size of the glyph under
2339 frame pixel coordinates X/Y on frame F. */
2341 if (window_resize_pixelwise
)
2346 else if (!f
->glyphs_initialized_p
2347 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2350 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2351 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2355 w
= XWINDOW (window
);
2356 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2357 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2359 x
= window_relative_x_coord (w
, part
, gx
);
2360 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2362 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2363 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2365 if (w
->pseudo_window_p
)
2368 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2374 case ON_LEFT_MARGIN
:
2375 area
= LEFT_MARGIN_AREA
;
2378 case ON_RIGHT_MARGIN
:
2379 area
= RIGHT_MARGIN_AREA
;
2382 case ON_HEADER_LINE
:
2384 gr
= (part
== ON_HEADER_LINE
2385 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2386 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2389 goto text_glyph_row_found
;
2396 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2397 if (r
->y
+ r
->height
> y
)
2403 text_glyph_row_found
:
2406 struct glyph
*g
= gr
->glyphs
[area
];
2407 struct glyph
*end
= g
+ gr
->used
[area
];
2409 height
= gr
->height
;
2410 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2411 if (gx
+ g
->pixel_width
> x
)
2416 if (g
->type
== IMAGE_GLYPH
)
2418 /* Don't remember when mouse is over image, as
2419 image may have hot-spots. */
2420 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2423 width
= g
->pixel_width
;
2427 /* Use nominal char spacing at end of line. */
2429 gx
+= (x
/ width
) * width
;
2432 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2434 gx
+= window_box_left_offset (w
, area
);
2435 /* Don't expand over the modeline to make sure the vertical
2436 drag cursor is shown early enough. */
2437 height
= min (height
,
2438 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2443 /* Use nominal line height at end of window. */
2444 gx
= (x
/ width
) * width
;
2446 gy
+= (y
/ height
) * height
;
2447 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2448 /* See comment above. */
2449 height
= min (height
,
2450 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2454 case ON_LEFT_FRINGE
:
2455 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2456 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2457 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2458 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2461 case ON_RIGHT_FRINGE
:
2462 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2463 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2464 : window_box_right_offset (w
, TEXT_AREA
));
2465 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2466 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2467 && !WINDOW_RIGHTMOST_P (w
))
2468 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2469 /* Make sure the vertical border can get her own glyph to the
2470 right of the one we build here. */
2471 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2473 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2475 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2479 case ON_VERTICAL_BORDER
:
2480 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2484 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2486 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2487 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2488 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2490 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2494 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2495 if (r
->y
+ r
->height
> y
)
2502 height
= gr
->height
;
2505 /* Use nominal line height at end of window. */
2507 gy
+= (y
/ height
) * height
;
2511 case ON_RIGHT_DIVIDER
:
2512 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2513 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2515 /* The bottom divider prevails. */
2516 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2519 case ON_BOTTOM_DIVIDER
:
2521 width
= WINDOW_PIXEL_WIDTH (w
);
2522 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2523 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2529 /* If there is no glyph under the mouse, then we divide the screen
2530 into a grid of the smallest glyph in the frame, and use that
2533 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2534 round down even for negative values. */
2540 gx
= (gx
/ width
) * width
;
2541 gy
= (gy
/ height
) * height
;
2547 gx
+= WINDOW_LEFT_EDGE_X (w
);
2548 gy
+= WINDOW_TOP_EDGE_Y (w
);
2551 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2553 /* Visible feedback for debugging. */
2556 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2557 f
->output_data
.x
->normal_gc
,
2558 gx
, gy
, width
, height
);
2564 #endif /* HAVE_WINDOW_SYSTEM */
2567 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2570 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2571 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2573 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2576 /***********************************************************************
2577 Lisp form evaluation
2578 ***********************************************************************/
2580 /* Error handler for safe_eval and safe_call. */
2583 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2585 add_to_log ("Error during redisplay: %S signaled %S",
2586 Flist (nargs
, args
), arg
);
2590 /* Call function FUNC with the rest of NARGS - 1 arguments
2591 following. Return the result, or nil if something went
2592 wrong. Prevent redisplay during the evaluation. */
2595 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2599 if (inhibit_eval_during_redisplay
)
2604 ptrdiff_t count
= SPECPDL_INDEX ();
2605 struct gcpro gcpro1
;
2606 Lisp_Object
*args
= alloca (nargs
* word_size
);
2609 for (i
= 1; i
< nargs
; i
++)
2610 args
[i
] = va_arg (ap
, Lisp_Object
);
2613 gcpro1
.nvars
= nargs
;
2614 specbind (Qinhibit_redisplay
, Qt
);
2616 specbind (Qinhibit_quit
, Qt
);
2617 /* Use Qt to ensure debugger does not run,
2618 so there is no possibility of wanting to redisplay. */
2619 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2622 val
= unbind_to (count
, val
);
2629 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2634 va_start (ap
, func
);
2635 retval
= safe__call (false, nargs
, func
, ap
);
2640 /* Call function FN with one argument ARG.
2641 Return the result, or nil if something went wrong. */
2644 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2646 return safe_call (2, fn
, arg
);
2650 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2656 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2661 static Lisp_Object Qeval
;
2664 safe_eval (Lisp_Object sexpr
)
2666 return safe__call1 (false, Qeval
, sexpr
);
2670 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2672 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2675 /* Call function FN with two arguments ARG1 and ARG2.
2676 Return the result, or nil if something went wrong. */
2679 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2681 return safe_call (3, fn
, arg1
, arg2
);
2686 /***********************************************************************
2688 ***********************************************************************/
2692 /* Define CHECK_IT to perform sanity checks on iterators.
2693 This is for debugging. It is too slow to do unconditionally. */
2696 check_it (struct it
*it
)
2698 if (it
->method
== GET_FROM_STRING
)
2700 eassert (STRINGP (it
->string
));
2701 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2705 eassert (IT_STRING_CHARPOS (*it
) < 0);
2706 if (it
->method
== GET_FROM_BUFFER
)
2708 /* Check that character and byte positions agree. */
2709 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2714 eassert (it
->current
.dpvec_index
>= 0);
2716 eassert (it
->current
.dpvec_index
< 0);
2719 #define CHECK_IT(IT) check_it ((IT))
2723 #define CHECK_IT(IT) (void) 0
2728 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2730 /* Check that the window end of window W is what we expect it
2731 to be---the last row in the current matrix displaying text. */
2734 check_window_end (struct window
*w
)
2736 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2738 struct glyph_row
*row
;
2739 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2741 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2742 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2746 #define CHECK_WINDOW_END(W) check_window_end ((W))
2750 #define CHECK_WINDOW_END(W) (void) 0
2752 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2754 /***********************************************************************
2755 Iterator initialization
2756 ***********************************************************************/
2758 /* Initialize IT for displaying current_buffer in window W, starting
2759 at character position CHARPOS. CHARPOS < 0 means that no buffer
2760 position is specified which is useful when the iterator is assigned
2761 a position later. BYTEPOS is the byte position corresponding to
2764 If ROW is not null, calls to produce_glyphs with IT as parameter
2765 will produce glyphs in that row.
2767 BASE_FACE_ID is the id of a base face to use. It must be one of
2768 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2769 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2770 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2772 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2773 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2774 will be initialized to use the corresponding mode line glyph row of
2775 the desired matrix of W. */
2778 init_iterator (struct it
*it
, struct window
*w
,
2779 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2780 struct glyph_row
*row
, enum face_id base_face_id
)
2782 enum face_id remapped_base_face_id
= base_face_id
;
2784 /* Some precondition checks. */
2785 eassert (w
!= NULL
&& it
!= NULL
);
2786 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2789 /* If face attributes have been changed since the last redisplay,
2790 free realized faces now because they depend on face definitions
2791 that might have changed. Don't free faces while there might be
2792 desired matrices pending which reference these faces. */
2793 if (face_change_count
&& !inhibit_free_realized_faces
)
2795 face_change_count
= 0;
2796 free_all_realized_faces (Qnil
);
2799 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2800 if (! NILP (Vface_remapping_alist
))
2801 remapped_base_face_id
2802 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2804 /* Use one of the mode line rows of W's desired matrix if
2808 if (base_face_id
== MODE_LINE_FACE_ID
2809 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2810 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2811 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2812 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2816 memset (it
, 0, sizeof *it
);
2817 it
->current
.overlay_string_index
= -1;
2818 it
->current
.dpvec_index
= -1;
2819 it
->base_face_id
= remapped_base_face_id
;
2821 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2822 it
->paragraph_embedding
= L2R
;
2823 it
->bidi_it
.string
.lstring
= Qnil
;
2824 it
->bidi_it
.string
.s
= NULL
;
2825 it
->bidi_it
.string
.bufpos
= 0;
2828 /* The window in which we iterate over current_buffer: */
2829 XSETWINDOW (it
->window
, w
);
2831 it
->f
= XFRAME (w
->frame
);
2835 /* Extra space between lines (on window systems only). */
2836 if (base_face_id
== DEFAULT_FACE_ID
2837 && FRAME_WINDOW_P (it
->f
))
2839 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2840 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2841 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2842 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2843 * FRAME_LINE_HEIGHT (it
->f
));
2844 else if (it
->f
->extra_line_spacing
> 0)
2845 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2846 it
->max_extra_line_spacing
= 0;
2849 /* If realized faces have been removed, e.g. because of face
2850 attribute changes of named faces, recompute them. When running
2851 in batch mode, the face cache of the initial frame is null. If
2852 we happen to get called, make a dummy face cache. */
2853 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2854 init_frame_faces (it
->f
);
2855 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2856 recompute_basic_faces (it
->f
);
2858 /* Current value of the `slice', `space-width', and 'height' properties. */
2859 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2860 it
->space_width
= Qnil
;
2861 it
->font_height
= Qnil
;
2862 it
->override_ascent
= -1;
2864 /* Are control characters displayed as `^C'? */
2865 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2867 /* -1 means everything between a CR and the following line end
2868 is invisible. >0 means lines indented more than this value are
2870 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2872 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2874 : (!NILP (BVAR (current_buffer
, selective_display
))
2876 it
->selective_display_ellipsis_p
2877 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2879 /* Display table to use. */
2880 it
->dp
= window_display_table (w
);
2882 /* Are multibyte characters enabled in current_buffer? */
2883 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2885 /* Get the position at which the redisplay_end_trigger hook should
2886 be run, if it is to be run at all. */
2887 if (MARKERP (w
->redisplay_end_trigger
)
2888 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2889 it
->redisplay_end_trigger_charpos
2890 = marker_position (w
->redisplay_end_trigger
);
2891 else if (INTEGERP (w
->redisplay_end_trigger
))
2892 it
->redisplay_end_trigger_charpos
2893 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2896 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2898 /* Are lines in the display truncated? */
2899 if (base_face_id
!= DEFAULT_FACE_ID
2901 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2902 && ((!NILP (Vtruncate_partial_width_windows
)
2903 && !INTEGERP (Vtruncate_partial_width_windows
))
2904 || (INTEGERP (Vtruncate_partial_width_windows
)
2905 /* PXW: Shall we do something about this? */
2906 && (WINDOW_TOTAL_COLS (it
->w
)
2907 < XINT (Vtruncate_partial_width_windows
))))))
2908 it
->line_wrap
= TRUNCATE
;
2909 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2910 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2911 ? WINDOW_WRAP
: WORD_WRAP
;
2913 it
->line_wrap
= TRUNCATE
;
2915 /* Get dimensions of truncation and continuation glyphs. These are
2916 displayed as fringe bitmaps under X, but we need them for such
2917 frames when the fringes are turned off. But leave the dimensions
2918 zero for tooltip frames, as these glyphs look ugly there and also
2919 sabotage calculations of tooltip dimensions in x-show-tip. */
2920 #ifdef HAVE_WINDOW_SYSTEM
2921 if (!(FRAME_WINDOW_P (it
->f
)
2922 && FRAMEP (tip_frame
)
2923 && it
->f
== XFRAME (tip_frame
)))
2926 if (it
->line_wrap
== TRUNCATE
)
2928 /* We will need the truncation glyph. */
2929 eassert (it
->glyph_row
== NULL
);
2930 produce_special_glyphs (it
, IT_TRUNCATION
);
2931 it
->truncation_pixel_width
= it
->pixel_width
;
2935 /* We will need the continuation glyph. */
2936 eassert (it
->glyph_row
== NULL
);
2937 produce_special_glyphs (it
, IT_CONTINUATION
);
2938 it
->continuation_pixel_width
= it
->pixel_width
;
2942 /* Reset these values to zero because the produce_special_glyphs
2943 above has changed them. */
2944 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2945 it
->phys_ascent
= it
->phys_descent
= 0;
2947 /* Set this after getting the dimensions of truncation and
2948 continuation glyphs, so that we don't produce glyphs when calling
2949 produce_special_glyphs, above. */
2950 it
->glyph_row
= row
;
2951 it
->area
= TEXT_AREA
;
2953 /* Forget any previous info about this row being reversed. */
2955 it
->glyph_row
->reversed_p
= 0;
2957 /* Get the dimensions of the display area. The display area
2958 consists of the visible window area plus a horizontally scrolled
2959 part to the left of the window. All x-values are relative to the
2960 start of this total display area. */
2961 if (base_face_id
!= DEFAULT_FACE_ID
)
2963 /* Mode lines, menu bar in terminal frames. */
2964 it
->first_visible_x
= 0;
2965 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2970 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2971 it
->last_visible_x
= (it
->first_visible_x
2972 + window_box_width (w
, TEXT_AREA
));
2974 /* If we truncate lines, leave room for the truncation glyph(s) at
2975 the right margin. Otherwise, leave room for the continuation
2976 glyph(s). Done only if the window has no fringes. Since we
2977 don't know at this point whether there will be any R2L lines in
2978 the window, we reserve space for truncation/continuation glyphs
2979 even if only one of the fringes is absent. */
2980 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2981 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2983 if (it
->line_wrap
== TRUNCATE
)
2984 it
->last_visible_x
-= it
->truncation_pixel_width
;
2986 it
->last_visible_x
-= it
->continuation_pixel_width
;
2989 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2990 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2993 /* Leave room for a border glyph. */
2994 if (!FRAME_WINDOW_P (it
->f
)
2995 && !WINDOW_RIGHTMOST_P (it
->w
))
2996 it
->last_visible_x
-= 1;
2998 it
->last_visible_y
= window_text_bottom_y (w
);
3000 /* For mode lines and alike, arrange for the first glyph having a
3001 left box line if the face specifies a box. */
3002 if (base_face_id
!= DEFAULT_FACE_ID
)
3006 it
->face_id
= remapped_base_face_id
;
3008 /* If we have a boxed mode line, make the first character appear
3009 with a left box line. */
3010 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
3011 if (face
&& face
->box
!= FACE_NO_BOX
)
3012 it
->start_of_box_run_p
= true;
3015 /* If a buffer position was specified, set the iterator there,
3016 getting overlays and face properties from that position. */
3017 if (charpos
>= BUF_BEG (current_buffer
))
3019 it
->end_charpos
= ZV
;
3020 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3021 IT_CHARPOS (*it
) = charpos
;
3022 IT_BYTEPOS (*it
) = bytepos
;
3024 /* We will rely on `reseat' to set this up properly, via
3025 handle_face_prop. */
3026 it
->face_id
= it
->base_face_id
;
3028 it
->start
= it
->current
;
3029 /* Do we need to reorder bidirectional text? Not if this is a
3030 unibyte buffer: by definition, none of the single-byte
3031 characters are strong R2L, so no reordering is needed. And
3032 bidi.c doesn't support unibyte buffers anyway. Also, don't
3033 reorder while we are loading loadup.el, since the tables of
3034 character properties needed for reordering are not yet
3038 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3041 /* If we are to reorder bidirectional text, init the bidi
3045 /* Note the paragraph direction that this buffer wants to
3047 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3049 it
->paragraph_embedding
= L2R
;
3050 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3052 it
->paragraph_embedding
= R2L
;
3054 it
->paragraph_embedding
= NEUTRAL_DIR
;
3055 bidi_unshelve_cache (NULL
, 0);
3056 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3060 /* Compute faces etc. */
3061 reseat (it
, it
->current
.pos
, 1);
3068 /* Initialize IT for the display of window W with window start POS. */
3071 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3073 struct glyph_row
*row
;
3074 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3076 row
= w
->desired_matrix
->rows
+ first_vpos
;
3077 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3078 it
->first_vpos
= first_vpos
;
3080 /* Don't reseat to previous visible line start if current start
3081 position is in a string or image. */
3082 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3084 int start_at_line_beg_p
;
3085 int first_y
= it
->current_y
;
3087 /* If window start is not at a line start, skip forward to POS to
3088 get the correct continuation lines width. */
3089 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3090 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3091 if (!start_at_line_beg_p
)
3095 reseat_at_previous_visible_line_start (it
);
3096 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3098 new_x
= it
->current_x
+ it
->pixel_width
;
3100 /* If lines are continued, this line may end in the middle
3101 of a multi-glyph character (e.g. a control character
3102 displayed as \003, or in the middle of an overlay
3103 string). In this case move_it_to above will not have
3104 taken us to the start of the continuation line but to the
3105 end of the continued line. */
3106 if (it
->current_x
> 0
3107 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3108 && (/* And glyph doesn't fit on the line. */
3109 new_x
> it
->last_visible_x
3110 /* Or it fits exactly and we're on a window
3112 || (new_x
== it
->last_visible_x
3113 && FRAME_WINDOW_P (it
->f
)
3114 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3115 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3116 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3118 if ((it
->current
.dpvec_index
>= 0
3119 || it
->current
.overlay_string_index
>= 0)
3120 /* If we are on a newline from a display vector or
3121 overlay string, then we are already at the end of
3122 a screen line; no need to go to the next line in
3123 that case, as this line is not really continued.
3124 (If we do go to the next line, C-e will not DTRT.) */
3127 set_iterator_to_next (it
, 1);
3128 move_it_in_display_line_to (it
, -1, -1, 0);
3131 it
->continuation_lines_width
+= it
->current_x
;
3133 /* If the character at POS is displayed via a display
3134 vector, move_it_to above stops at the final glyph of
3135 IT->dpvec. To make the caller redisplay that character
3136 again (a.k.a. start at POS), we need to reset the
3137 dpvec_index to the beginning of IT->dpvec. */
3138 else if (it
->current
.dpvec_index
>= 0)
3139 it
->current
.dpvec_index
= 0;
3141 /* We're starting a new display line, not affected by the
3142 height of the continued line, so clear the appropriate
3143 fields in the iterator structure. */
3144 it
->max_ascent
= it
->max_descent
= 0;
3145 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3147 it
->current_y
= first_y
;
3149 it
->current_x
= it
->hpos
= 0;
3155 /* Return 1 if POS is a position in ellipses displayed for invisible
3156 text. W is the window we display, for text property lookup. */
3159 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3161 Lisp_Object prop
, window
;
3163 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3165 /* If POS specifies a position in a display vector, this might
3166 be for an ellipsis displayed for invisible text. We won't
3167 get the iterator set up for delivering that ellipsis unless
3168 we make sure that it gets aware of the invisible text. */
3169 if (pos
->dpvec_index
>= 0
3170 && pos
->overlay_string_index
< 0
3171 && CHARPOS (pos
->string_pos
) < 0
3173 && (XSETWINDOW (window
, w
),
3174 prop
= Fget_char_property (make_number (charpos
),
3175 Qinvisible
, window
),
3176 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3178 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3180 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3187 /* Initialize IT for stepping through current_buffer in window W,
3188 starting at position POS that includes overlay string and display
3189 vector/ control character translation position information. Value
3190 is zero if there are overlay strings with newlines at POS. */
3193 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3195 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3196 int i
, overlay_strings_with_newlines
= 0;
3198 /* If POS specifies a position in a display vector, this might
3199 be for an ellipsis displayed for invisible text. We won't
3200 get the iterator set up for delivering that ellipsis unless
3201 we make sure that it gets aware of the invisible text. */
3202 if (in_ellipses_for_invisible_text_p (pos
, w
))
3208 /* Keep in mind: the call to reseat in init_iterator skips invisible
3209 text, so we might end up at a position different from POS. This
3210 is only a problem when POS is a row start after a newline and an
3211 overlay starts there with an after-string, and the overlay has an
3212 invisible property. Since we don't skip invisible text in
3213 display_line and elsewhere immediately after consuming the
3214 newline before the row start, such a POS will not be in a string,
3215 but the call to init_iterator below will move us to the
3217 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3219 /* This only scans the current chunk -- it should scan all chunks.
3220 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3221 to 16 in 22.1 to make this a lesser problem. */
3222 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3224 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3225 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3227 while (s
< e
&& *s
!= '\n')
3232 overlay_strings_with_newlines
= 1;
3237 /* If position is within an overlay string, set up IT to the right
3239 if (pos
->overlay_string_index
>= 0)
3243 /* If the first overlay string happens to have a `display'
3244 property for an image, the iterator will be set up for that
3245 image, and we have to undo that setup first before we can
3246 correct the overlay string index. */
3247 if (it
->method
== GET_FROM_IMAGE
)
3250 /* We already have the first chunk of overlay strings in
3251 IT->overlay_strings. Load more until the one for
3252 pos->overlay_string_index is in IT->overlay_strings. */
3253 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3255 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3256 it
->current
.overlay_string_index
= 0;
3259 load_overlay_strings (it
, 0);
3260 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3264 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3265 relative_index
= (it
->current
.overlay_string_index
3266 % OVERLAY_STRING_CHUNK_SIZE
);
3267 it
->string
= it
->overlay_strings
[relative_index
];
3268 eassert (STRINGP (it
->string
));
3269 it
->current
.string_pos
= pos
->string_pos
;
3270 it
->method
= GET_FROM_STRING
;
3271 it
->end_charpos
= SCHARS (it
->string
);
3272 /* Set up the bidi iterator for this overlay string. */
3275 it
->bidi_it
.string
.lstring
= it
->string
;
3276 it
->bidi_it
.string
.s
= NULL
;
3277 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3278 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3279 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3280 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3281 it
->bidi_it
.w
= it
->w
;
3282 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3283 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3285 /* Synchronize the state of the bidi iterator with
3286 pos->string_pos. For any string position other than
3287 zero, this will be done automagically when we resume
3288 iteration over the string and get_visually_first_element
3289 is called. But if string_pos is zero, and the string is
3290 to be reordered for display, we need to resync manually,
3291 since it could be that the iteration state recorded in
3292 pos ended at string_pos of 0 moving backwards in string. */
3293 if (CHARPOS (pos
->string_pos
) == 0)
3295 get_visually_first_element (it
);
3296 if (IT_STRING_CHARPOS (*it
) != 0)
3299 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3300 bidi_move_to_visually_next (&it
->bidi_it
);
3301 } while (it
->bidi_it
.charpos
!= 0);
3303 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3304 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3308 if (CHARPOS (pos
->string_pos
) >= 0)
3310 /* Recorded position is not in an overlay string, but in another
3311 string. This can only be a string from a `display' property.
3312 IT should already be filled with that string. */
3313 it
->current
.string_pos
= pos
->string_pos
;
3314 eassert (STRINGP (it
->string
));
3316 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3317 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3320 /* Restore position in display vector translations, control
3321 character translations or ellipses. */
3322 if (pos
->dpvec_index
>= 0)
3324 if (it
->dpvec
== NULL
)
3325 get_next_display_element (it
);
3326 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3327 it
->current
.dpvec_index
= pos
->dpvec_index
;
3331 return !overlay_strings_with_newlines
;
3335 /* Initialize IT for stepping through current_buffer in window W
3336 starting at ROW->start. */
3339 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3341 init_from_display_pos (it
, w
, &row
->start
);
3342 it
->start
= row
->start
;
3343 it
->continuation_lines_width
= row
->continuation_lines_width
;
3348 /* Initialize IT for stepping through current_buffer in window W
3349 starting in the line following ROW, i.e. starting at ROW->end.
3350 Value is zero if there are overlay strings with newlines at ROW's
3354 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3358 if (init_from_display_pos (it
, w
, &row
->end
))
3360 if (row
->continued_p
)
3361 it
->continuation_lines_width
3362 = row
->continuation_lines_width
+ row
->pixel_width
;
3373 /***********************************************************************
3375 ***********************************************************************/
3377 /* Called when IT reaches IT->stop_charpos. Handle text property and
3378 overlay changes. Set IT->stop_charpos to the next position where
3382 handle_stop (struct it
*it
)
3384 enum prop_handled handled
;
3385 int handle_overlay_change_p
;
3389 it
->current
.dpvec_index
= -1;
3390 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3391 it
->ignore_overlay_strings_at_pos_p
= 0;
3394 /* Use face of preceding text for ellipsis (if invisible) */
3395 if (it
->selective_display_ellipsis_p
)
3396 it
->saved_face_id
= it
->face_id
;
3400 handled
= HANDLED_NORMALLY
;
3402 /* Call text property handlers. */
3403 for (p
= it_props
; p
->handler
; ++p
)
3405 handled
= p
->handler (it
);
3407 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3409 else if (handled
== HANDLED_RETURN
)
3411 /* We still want to show before and after strings from
3412 overlays even if the actual buffer text is replaced. */
3413 if (!handle_overlay_change_p
3415 /* Don't call get_overlay_strings_1 if we already
3416 have overlay strings loaded, because doing so
3417 will load them again and push the iterator state
3418 onto the stack one more time, which is not
3419 expected by the rest of the code that processes
3421 || (it
->current
.overlay_string_index
< 0
3422 ? !get_overlay_strings_1 (it
, 0, 0)
3426 setup_for_ellipsis (it
, 0);
3427 /* When handling a display spec, we might load an
3428 empty string. In that case, discard it here. We
3429 used to discard it in handle_single_display_spec,
3430 but that causes get_overlay_strings_1, above, to
3431 ignore overlay strings that we must check. */
3432 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3436 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3440 it
->ignore_overlay_strings_at_pos_p
= true;
3441 it
->string_from_display_prop_p
= 0;
3442 it
->from_disp_prop_p
= 0;
3443 handle_overlay_change_p
= 0;
3445 handled
= HANDLED_RECOMPUTE_PROPS
;
3448 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3449 handle_overlay_change_p
= 0;
3452 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3454 /* Don't check for overlay strings below when set to deliver
3455 characters from a display vector. */
3456 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3457 handle_overlay_change_p
= 0;
3459 /* Handle overlay changes.
3460 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3461 if it finds overlays. */
3462 if (handle_overlay_change_p
)
3463 handled
= handle_overlay_change (it
);
3468 setup_for_ellipsis (it
, 0);
3472 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3474 /* Determine where to stop next. */
3475 if (handled
== HANDLED_NORMALLY
)
3476 compute_stop_pos (it
);
3480 /* Compute IT->stop_charpos from text property and overlay change
3481 information for IT's current position. */
3484 compute_stop_pos (struct it
*it
)
3486 register INTERVAL iv
, next_iv
;
3487 Lisp_Object object
, limit
, position
;
3488 ptrdiff_t charpos
, bytepos
;
3490 if (STRINGP (it
->string
))
3492 /* Strings are usually short, so don't limit the search for
3494 it
->stop_charpos
= it
->end_charpos
;
3495 object
= it
->string
;
3497 charpos
= IT_STRING_CHARPOS (*it
);
3498 bytepos
= IT_STRING_BYTEPOS (*it
);
3504 /* If end_charpos is out of range for some reason, such as a
3505 misbehaving display function, rationalize it (Bug#5984). */
3506 if (it
->end_charpos
> ZV
)
3507 it
->end_charpos
= ZV
;
3508 it
->stop_charpos
= it
->end_charpos
;
3510 /* If next overlay change is in front of the current stop pos
3511 (which is IT->end_charpos), stop there. Note: value of
3512 next_overlay_change is point-max if no overlay change
3514 charpos
= IT_CHARPOS (*it
);
3515 bytepos
= IT_BYTEPOS (*it
);
3516 pos
= next_overlay_change (charpos
);
3517 if (pos
< it
->stop_charpos
)
3518 it
->stop_charpos
= pos
;
3520 /* Set up variables for computing the stop position from text
3521 property changes. */
3522 XSETBUFFER (object
, current_buffer
);
3523 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3526 /* Get the interval containing IT's position. Value is a null
3527 interval if there isn't such an interval. */
3528 position
= make_number (charpos
);
3529 iv
= validate_interval_range (object
, &position
, &position
, 0);
3532 Lisp_Object values_here
[LAST_PROP_IDX
];
3535 /* Get properties here. */
3536 for (p
= it_props
; p
->handler
; ++p
)
3537 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3539 /* Look for an interval following iv that has different
3541 for (next_iv
= next_interval (iv
);
3544 || XFASTINT (limit
) > next_iv
->position
));
3545 next_iv
= next_interval (next_iv
))
3547 for (p
= it_props
; p
->handler
; ++p
)
3549 Lisp_Object new_value
;
3551 new_value
= textget (next_iv
->plist
, *p
->name
);
3552 if (!EQ (values_here
[p
->idx
], new_value
))
3562 if (INTEGERP (limit
)
3563 && next_iv
->position
>= XFASTINT (limit
))
3564 /* No text property change up to limit. */
3565 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3567 /* Text properties change in next_iv. */
3568 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3572 if (it
->cmp_it
.id
< 0)
3574 ptrdiff_t stoppos
= it
->end_charpos
;
3576 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3578 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3579 stoppos
, it
->string
);
3582 eassert (STRINGP (it
->string
)
3583 || (it
->stop_charpos
>= BEGV
3584 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3588 /* Return the position of the next overlay change after POS in
3589 current_buffer. Value is point-max if no overlay change
3590 follows. This is like `next-overlay-change' but doesn't use
3594 next_overlay_change (ptrdiff_t pos
)
3596 ptrdiff_t i
, noverlays
;
3598 Lisp_Object
*overlays
;
3600 /* Get all overlays at the given position. */
3601 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3603 /* If any of these overlays ends before endpos,
3604 use its ending point instead. */
3605 for (i
= 0; i
< noverlays
; ++i
)
3610 oend
= OVERLAY_END (overlays
[i
]);
3611 oendpos
= OVERLAY_POSITION (oend
);
3612 endpos
= min (endpos
, oendpos
);
3618 /* How many characters forward to search for a display property or
3619 display string. Searching too far forward makes the bidi display
3620 sluggish, especially in small windows. */
3621 #define MAX_DISP_SCAN 250
3623 /* Return the character position of a display string at or after
3624 position specified by POSITION. If no display string exists at or
3625 after POSITION, return ZV. A display string is either an overlay
3626 with `display' property whose value is a string, or a `display'
3627 text property whose value is a string. STRING is data about the
3628 string to iterate; if STRING->lstring is nil, we are iterating a
3629 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3630 on a GUI frame. DISP_PROP is set to zero if we searched
3631 MAX_DISP_SCAN characters forward without finding any display
3632 strings, non-zero otherwise. It is set to 2 if the display string
3633 uses any kind of `(space ...)' spec that will produce a stretch of
3634 white space in the text area. */
3636 compute_display_string_pos (struct text_pos
*position
,
3637 struct bidi_string_data
*string
,
3639 int frame_window_p
, int *disp_prop
)
3641 /* OBJECT = nil means current buffer. */
3642 Lisp_Object object
, object1
;
3643 Lisp_Object pos
, spec
, limpos
;
3644 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3645 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3646 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3647 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3649 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3650 struct text_pos tpos
;
3653 if (string
&& STRINGP (string
->lstring
))
3654 object1
= object
= string
->lstring
;
3655 else if (w
&& !string_p
)
3657 XSETWINDOW (object
, w
);
3661 object1
= object
= Qnil
;
3666 /* We don't support display properties whose values are strings
3667 that have display string properties. */
3668 || string
->from_disp_str
3669 /* C strings cannot have display properties. */
3670 || (string
->s
&& !STRINGP (object
)))
3676 /* If the character at CHARPOS is where the display string begins,
3678 pos
= make_number (charpos
);
3679 if (STRINGP (object
))
3680 bufpos
= string
->bufpos
;
3684 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3686 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3689 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3697 /* Look forward for the first character with a `display' property
3698 that will replace the underlying text when displayed. */
3699 limpos
= make_number (lim
);
3701 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3702 CHARPOS (tpos
) = XFASTINT (pos
);
3703 if (CHARPOS (tpos
) >= lim
)
3708 if (STRINGP (object
))
3709 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3711 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3712 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3713 if (!STRINGP (object
))
3714 bufpos
= CHARPOS (tpos
);
3715 } while (NILP (spec
)
3716 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3717 bufpos
, frame_window_p
)));
3721 return CHARPOS (tpos
);
3724 /* Return the character position of the end of the display string that
3725 started at CHARPOS. If there's no display string at CHARPOS,
3726 return -1. A display string is either an overlay with `display'
3727 property whose value is a string or a `display' text property whose
3728 value is a string. */
3730 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3732 /* OBJECT = nil means current buffer. */
3733 Lisp_Object object
=
3734 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3735 Lisp_Object pos
= make_number (charpos
);
3737 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3739 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3742 /* It could happen that the display property or overlay was removed
3743 since we found it in compute_display_string_pos above. One way
3744 this can happen is if JIT font-lock was called (through
3745 handle_fontified_prop), and jit-lock-functions remove text
3746 properties or overlays from the portion of buffer that includes
3747 CHARPOS. Muse mode is known to do that, for example. In this
3748 case, we return -1 to the caller, to signal that no display
3749 string is actually present at CHARPOS. See bidi_fetch_char for
3750 how this is handled.
3752 An alternative would be to never look for display properties past
3753 it->stop_charpos. But neither compute_display_string_pos nor
3754 bidi_fetch_char that calls it know or care where the next
3756 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3759 /* Look forward for the first character where the `display' property
3761 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3763 return XFASTINT (pos
);
3768 /***********************************************************************
3770 ***********************************************************************/
3772 /* Handle changes in the `fontified' property of the current buffer by
3773 calling hook functions from Qfontification_functions to fontify
3776 static enum prop_handled
3777 handle_fontified_prop (struct it
*it
)
3779 Lisp_Object prop
, pos
;
3780 enum prop_handled handled
= HANDLED_NORMALLY
;
3782 if (!NILP (Vmemory_full
))
3785 /* Get the value of the `fontified' property at IT's current buffer
3786 position. (The `fontified' property doesn't have a special
3787 meaning in strings.) If the value is nil, call functions from
3788 Qfontification_functions. */
3789 if (!STRINGP (it
->string
)
3791 && !NILP (Vfontification_functions
)
3792 && !NILP (Vrun_hooks
)
3793 && (pos
= make_number (IT_CHARPOS (*it
)),
3794 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3795 /* Ignore the special cased nil value always present at EOB since
3796 no amount of fontifying will be able to change it. */
3797 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3799 ptrdiff_t count
= SPECPDL_INDEX ();
3801 struct buffer
*obuf
= current_buffer
;
3802 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3803 bool old_clip_changed
= current_buffer
->clip_changed
;
3805 val
= Vfontification_functions
;
3806 specbind (Qfontification_functions
, Qnil
);
3808 eassert (it
->end_charpos
== ZV
);
3810 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3811 safe_call1 (val
, pos
);
3814 Lisp_Object fns
, fn
;
3815 struct gcpro gcpro1
, gcpro2
;
3820 for (; CONSP (val
); val
= XCDR (val
))
3826 /* A value of t indicates this hook has a local
3827 binding; it means to run the global binding too.
3828 In a global value, t should not occur. If it
3829 does, we must ignore it to avoid an endless
3831 for (fns
= Fdefault_value (Qfontification_functions
);
3837 safe_call1 (fn
, pos
);
3841 safe_call1 (fn
, pos
);
3847 unbind_to (count
, Qnil
);
3849 /* Fontification functions routinely call `save-restriction'.
3850 Normally, this tags clip_changed, which can confuse redisplay
3851 (see discussion in Bug#6671). Since we don't perform any
3852 special handling of fontification changes in the case where
3853 `save-restriction' isn't called, there's no point doing so in
3854 this case either. So, if the buffer's restrictions are
3855 actually left unchanged, reset clip_changed. */
3856 if (obuf
== current_buffer
)
3858 if (begv
== BEGV
&& zv
== ZV
)
3859 current_buffer
->clip_changed
= old_clip_changed
;
3861 /* There isn't much we can reasonably do to protect against
3862 misbehaving fontification, but here's a fig leaf. */
3863 else if (BUFFER_LIVE_P (obuf
))
3864 set_buffer_internal_1 (obuf
);
3866 /* The fontification code may have added/removed text.
3867 It could do even a lot worse, but let's at least protect against
3868 the most obvious case where only the text past `pos' gets changed',
3869 as is/was done in grep.el where some escapes sequences are turned
3870 into face properties (bug#7876). */
3871 it
->end_charpos
= ZV
;
3873 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3874 something. This avoids an endless loop if they failed to
3875 fontify the text for which reason ever. */
3876 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3877 handled
= HANDLED_RECOMPUTE_PROPS
;
3885 /***********************************************************************
3887 ***********************************************************************/
3889 /* Set up iterator IT from face properties at its current position.
3890 Called from handle_stop. */
3892 static enum prop_handled
3893 handle_face_prop (struct it
*it
)
3896 ptrdiff_t next_stop
;
3898 if (!STRINGP (it
->string
))
3901 = face_at_buffer_position (it
->w
,
3905 + TEXT_PROP_DISTANCE_LIMIT
),
3906 0, it
->base_face_id
);
3908 /* Is this a start of a run of characters with box face?
3909 Caveat: this can be called for a freshly initialized
3910 iterator; face_id is -1 in this case. We know that the new
3911 face will not change until limit, i.e. if the new face has a
3912 box, all characters up to limit will have one. But, as
3913 usual, we don't know whether limit is really the end. */
3914 if (new_face_id
!= it
->face_id
)
3916 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3917 /* If it->face_id is -1, old_face below will be NULL, see
3918 the definition of FACE_FROM_ID. This will happen if this
3919 is the initial call that gets the face. */
3920 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3922 /* If the value of face_id of the iterator is -1, we have to
3923 look in front of IT's position and see whether there is a
3924 face there that's different from new_face_id. */
3925 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3927 int prev_face_id
= face_before_it_pos (it
);
3929 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3932 /* If the new face has a box, but the old face does not,
3933 this is the start of a run of characters with box face,
3934 i.e. this character has a shadow on the left side. */
3935 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3936 && (old_face
== NULL
|| !old_face
->box
));
3937 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3945 Lisp_Object from_overlay
3946 = (it
->current
.overlay_string_index
>= 0
3947 ? it
->string_overlays
[it
->current
.overlay_string_index
3948 % OVERLAY_STRING_CHUNK_SIZE
]
3951 /* See if we got to this string directly or indirectly from
3952 an overlay property. That includes the before-string or
3953 after-string of an overlay, strings in display properties
3954 provided by an overlay, their text properties, etc.
3956 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3957 if (! NILP (from_overlay
))
3958 for (i
= it
->sp
- 1; i
>= 0; i
--)
3960 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3962 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3963 % OVERLAY_STRING_CHUNK_SIZE
];
3964 else if (! NILP (it
->stack
[i
].from_overlay
))
3965 from_overlay
= it
->stack
[i
].from_overlay
;
3967 if (!NILP (from_overlay
))
3971 if (! NILP (from_overlay
))
3973 bufpos
= IT_CHARPOS (*it
);
3974 /* For a string from an overlay, the base face depends
3975 only on text properties and ignores overlays. */
3977 = face_for_overlay_string (it
->w
,
3981 + TEXT_PROP_DISTANCE_LIMIT
),
3989 /* For strings from a `display' property, use the face at
3990 IT's current buffer position as the base face to merge
3991 with, so that overlay strings appear in the same face as
3992 surrounding text, unless they specify their own faces.
3993 For strings from wrap-prefix and line-prefix properties,
3994 use the default face, possibly remapped via
3995 Vface_remapping_alist. */
3996 /* Note that the fact that we use the face at _buffer_
3997 position means that a 'display' property on an overlay
3998 string will not inherit the face of that overlay string,
3999 but will instead revert to the face of buffer text
4000 covered by the overlay. This is visible, e.g., when the
4001 overlay specifies a box face, but neither the buffer nor
4002 the display string do. This sounds like a design bug,
4003 but Emacs always did that since v21.1, so changing that
4004 might be a big deal. */
4005 base_face_id
= it
->string_from_prefix_prop_p
4006 ? (!NILP (Vface_remapping_alist
)
4007 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4009 : underlying_face_id (it
);
4012 new_face_id
= face_at_string_position (it
->w
,
4014 IT_STRING_CHARPOS (*it
),
4019 /* Is this a start of a run of characters with box? Caveat:
4020 this can be called for a freshly allocated iterator; face_id
4021 is -1 is this case. We know that the new face will not
4022 change until the next check pos, i.e. if the new face has a
4023 box, all characters up to that position will have a
4024 box. But, as usual, we don't know whether that position
4025 is really the end. */
4026 if (new_face_id
!= it
->face_id
)
4028 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4029 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4031 /* If new face has a box but old face hasn't, this is the
4032 start of a run of characters with box, i.e. it has a
4033 shadow on the left side. */
4034 it
->start_of_box_run_p
4035 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4036 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4040 it
->face_id
= new_face_id
;
4041 return HANDLED_NORMALLY
;
4045 /* Return the ID of the face ``underlying'' IT's current position,
4046 which is in a string. If the iterator is associated with a
4047 buffer, return the face at IT's current buffer position.
4048 Otherwise, use the iterator's base_face_id. */
4051 underlying_face_id (struct it
*it
)
4053 int face_id
= it
->base_face_id
, i
;
4055 eassert (STRINGP (it
->string
));
4057 for (i
= it
->sp
- 1; i
>= 0; --i
)
4058 if (NILP (it
->stack
[i
].string
))
4059 face_id
= it
->stack
[i
].face_id
;
4065 /* Compute the face one character before or after the current position
4066 of IT, in the visual order. BEFORE_P non-zero means get the face
4067 in front (to the left in L2R paragraphs, to the right in R2L
4068 paragraphs) of IT's screen position. Value is the ID of the face. */
4071 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4074 ptrdiff_t next_check_charpos
;
4076 void *it_copy_data
= NULL
;
4078 eassert (it
->s
== NULL
);
4080 if (STRINGP (it
->string
))
4082 ptrdiff_t bufpos
, charpos
;
4085 /* No face change past the end of the string (for the case
4086 we are padding with spaces). No face change before the
4088 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4089 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4094 /* Set charpos to the position before or after IT's current
4095 position, in the logical order, which in the non-bidi
4096 case is the same as the visual order. */
4098 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4099 else if (it
->what
== IT_COMPOSITION
)
4100 /* For composition, we must check the character after the
4102 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4104 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4110 /* With bidi iteration, the character before the current
4111 in the visual order cannot be found by simple
4112 iteration, because "reverse" reordering is not
4113 supported. Instead, we need to use the move_it_*
4114 family of functions. */
4115 /* Ignore face changes before the first visible
4116 character on this display line. */
4117 if (it
->current_x
<= it
->first_visible_x
)
4119 SAVE_IT (it_copy
, *it
, it_copy_data
);
4120 /* Implementation note: Since move_it_in_display_line
4121 works in the iterator geometry, and thinks the first
4122 character is always the leftmost, even in R2L lines,
4123 we don't need to distinguish between the R2L and L2R
4125 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4126 it_copy
.current_x
- 1, MOVE_TO_X
);
4127 charpos
= IT_STRING_CHARPOS (it_copy
);
4128 RESTORE_IT (it
, it
, it_copy_data
);
4132 /* Set charpos to the string position of the character
4133 that comes after IT's current position in the visual
4135 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4139 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4141 charpos
= it_copy
.bidi_it
.charpos
;
4144 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4146 if (it
->current
.overlay_string_index
>= 0)
4147 bufpos
= IT_CHARPOS (*it
);
4151 base_face_id
= underlying_face_id (it
);
4153 /* Get the face for ASCII, or unibyte. */
4154 face_id
= face_at_string_position (it
->w
,
4158 &next_check_charpos
,
4161 /* Correct the face for charsets different from ASCII. Do it
4162 for the multibyte case only. The face returned above is
4163 suitable for unibyte text if IT->string is unibyte. */
4164 if (STRING_MULTIBYTE (it
->string
))
4166 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4167 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4169 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4171 c
= string_char_and_length (p
, &len
);
4172 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4177 struct text_pos pos
;
4179 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4180 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4183 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4184 pos
= it
->current
.pos
;
4189 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4192 if (it
->what
== IT_COMPOSITION
)
4194 /* For composition, we must check the position after
4196 pos
.charpos
+= it
->cmp_it
.nchars
;
4197 pos
.bytepos
+= it
->len
;
4200 INC_TEXT_POS (pos
, it
->multibyte_p
);
4207 /* With bidi iteration, the character before the current
4208 in the visual order cannot be found by simple
4209 iteration, because "reverse" reordering is not
4210 supported. Instead, we need to use the move_it_*
4211 family of functions. */
4212 /* Ignore face changes before the first visible
4213 character on this display line. */
4214 if (it
->current_x
<= it
->first_visible_x
)
4216 SAVE_IT (it_copy
, *it
, it_copy_data
);
4217 /* Implementation note: Since move_it_in_display_line
4218 works in the iterator geometry, and thinks the first
4219 character is always the leftmost, even in R2L lines,
4220 we don't need to distinguish between the R2L and L2R
4222 move_it_in_display_line (&it_copy
, ZV
,
4223 it_copy
.current_x
- 1, MOVE_TO_X
);
4224 pos
= it_copy
.current
.pos
;
4225 RESTORE_IT (it
, it
, it_copy_data
);
4229 /* Set charpos to the buffer position of the character
4230 that comes after IT's current position in the visual
4232 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4236 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4239 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4242 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4244 /* Determine face for CHARSET_ASCII, or unibyte. */
4245 face_id
= face_at_buffer_position (it
->w
,
4247 &next_check_charpos
,
4250 /* Correct the face for charsets different from ASCII. Do it
4251 for the multibyte case only. The face returned above is
4252 suitable for unibyte text if current_buffer is unibyte. */
4253 if (it
->multibyte_p
)
4255 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4256 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4257 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4266 /***********************************************************************
4268 ***********************************************************************/
4270 /* Set up iterator IT from invisible properties at its current
4271 position. Called from handle_stop. */
4273 static enum prop_handled
4274 handle_invisible_prop (struct it
*it
)
4276 enum prop_handled handled
= HANDLED_NORMALLY
;
4280 if (STRINGP (it
->string
))
4282 Lisp_Object end_charpos
, limit
, charpos
;
4284 /* Get the value of the invisible text property at the
4285 current position. Value will be nil if there is no such
4287 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4288 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4289 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4291 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4293 /* Record whether we have to display an ellipsis for the
4295 int display_ellipsis_p
= (invis_p
== 2);
4296 ptrdiff_t len
, endpos
;
4298 handled
= HANDLED_RECOMPUTE_PROPS
;
4300 /* Get the position at which the next visible text can be
4301 found in IT->string, if any. */
4302 endpos
= len
= SCHARS (it
->string
);
4303 XSETINT (limit
, len
);
4306 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4308 if (INTEGERP (end_charpos
))
4310 endpos
= XFASTINT (end_charpos
);
4311 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4312 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4314 display_ellipsis_p
= true;
4317 while (invis_p
&& endpos
< len
);
4319 if (display_ellipsis_p
)
4320 it
->ellipsis_p
= true;
4324 /* Text at END_CHARPOS is visible. Move IT there. */
4325 struct text_pos old
;
4328 old
= it
->current
.string_pos
;
4329 oldpos
= CHARPOS (old
);
4332 if (it
->bidi_it
.first_elt
4333 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4334 bidi_paragraph_init (it
->paragraph_embedding
,
4336 /* Bidi-iterate out of the invisible text. */
4339 bidi_move_to_visually_next (&it
->bidi_it
);
4341 while (oldpos
<= it
->bidi_it
.charpos
4342 && it
->bidi_it
.charpos
< endpos
);
4344 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4345 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4346 if (IT_CHARPOS (*it
) >= endpos
)
4347 it
->prev_stop
= endpos
;
4351 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4352 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4357 /* The rest of the string is invisible. If this is an
4358 overlay string, proceed with the next overlay string
4359 or whatever comes and return a character from there. */
4360 if (it
->current
.overlay_string_index
>= 0
4361 && !display_ellipsis_p
)
4363 next_overlay_string (it
);
4364 /* Don't check for overlay strings when we just
4365 finished processing them. */
4366 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4370 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4371 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4378 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4379 Lisp_Object pos
, overlay
;
4381 /* First of all, is there invisible text at this position? */
4382 tem
= start_charpos
= IT_CHARPOS (*it
);
4383 pos
= make_number (tem
);
4384 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4386 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4388 /* If we are on invisible text, skip over it. */
4389 if (invis_p
&& start_charpos
< it
->end_charpos
)
4391 /* Record whether we have to display an ellipsis for the
4393 int display_ellipsis_p
= invis_p
== 2;
4395 handled
= HANDLED_RECOMPUTE_PROPS
;
4397 /* Loop skipping over invisible text. The loop is left at
4398 ZV or with IT on the first char being visible again. */
4401 /* Try to skip some invisible text. Return value is the
4402 position reached which can be equal to where we start
4403 if there is nothing invisible there. This skips both
4404 over invisible text properties and overlays with
4405 invisible property. */
4406 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4408 /* If we skipped nothing at all we weren't at invisible
4409 text in the first place. If everything to the end of
4410 the buffer was skipped, end the loop. */
4411 if (newpos
== tem
|| newpos
>= ZV
)
4415 /* We skipped some characters but not necessarily
4416 all there are. Check if we ended up on visible
4417 text. Fget_char_property returns the property of
4418 the char before the given position, i.e. if we
4419 get invis_p = 0, this means that the char at
4420 newpos is visible. */
4421 pos
= make_number (newpos
);
4422 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4423 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4426 /* If we ended up on invisible text, proceed to
4427 skip starting with next_stop. */
4431 /* If there are adjacent invisible texts, don't lose the
4432 second one's ellipsis. */
4434 display_ellipsis_p
= true;
4438 /* The position newpos is now either ZV or on visible text. */
4441 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4443 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4445 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4447 /* If the invisible text ends on a newline or on a
4448 character after a newline, we can avoid the costly,
4449 character by character, bidi iteration to NEWPOS, and
4450 instead simply reseat the iterator there. That's
4451 because all bidi reordering information is tossed at
4452 the newline. This is a big win for modes that hide
4453 complete lines, like Outline, Org, etc. */
4454 if (on_newline
|| after_newline
)
4456 struct text_pos tpos
;
4457 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4459 SET_TEXT_POS (tpos
, newpos
, bpos
);
4460 reseat_1 (it
, tpos
, 0);
4461 /* If we reseat on a newline/ZV, we need to prep the
4462 bidi iterator for advancing to the next character
4463 after the newline/EOB, keeping the current paragraph
4464 direction (so that PRODUCE_GLYPHS does TRT wrt
4465 prepending/appending glyphs to a glyph row). */
4468 it
->bidi_it
.first_elt
= 0;
4469 it
->bidi_it
.paragraph_dir
= pdir
;
4470 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4471 it
->bidi_it
.nchars
= 1;
4472 it
->bidi_it
.ch_len
= 1;
4475 else /* Must use the slow method. */
4477 /* With bidi iteration, the region of invisible text
4478 could start and/or end in the middle of a
4479 non-base embedding level. Therefore, we need to
4480 skip invisible text using the bidi iterator,
4481 starting at IT's current position, until we find
4482 ourselves outside of the invisible text.
4483 Skipping invisible text _after_ bidi iteration
4484 avoids affecting the visual order of the
4485 displayed text when invisible properties are
4486 added or removed. */
4487 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4489 /* If we were `reseat'ed to a new paragraph,
4490 determine the paragraph base direction. We
4491 need to do it now because
4492 next_element_from_buffer may not have a
4493 chance to do it, if we are going to skip any
4494 text at the beginning, which resets the
4496 bidi_paragraph_init (it
->paragraph_embedding
,
4501 bidi_move_to_visually_next (&it
->bidi_it
);
4503 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4504 && it
->bidi_it
.charpos
< newpos
);
4505 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4506 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4507 /* If we overstepped NEWPOS, record its position in
4508 the iterator, so that we skip invisible text if
4509 later the bidi iteration lands us in the
4510 invisible region again. */
4511 if (IT_CHARPOS (*it
) >= newpos
)
4512 it
->prev_stop
= newpos
;
4517 IT_CHARPOS (*it
) = newpos
;
4518 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4521 /* If there are before-strings at the start of invisible
4522 text, and the text is invisible because of a text
4523 property, arrange to show before-strings because 20.x did
4524 it that way. (If the text is invisible because of an
4525 overlay property instead of a text property, this is
4526 already handled in the overlay code.) */
4528 && get_overlay_strings (it
, it
->stop_charpos
))
4530 handled
= HANDLED_RECOMPUTE_PROPS
;
4531 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4533 else if (display_ellipsis_p
)
4535 /* Make sure that the glyphs of the ellipsis will get
4536 correct `charpos' values. If we would not update
4537 it->position here, the glyphs would belong to the
4538 last visible character _before_ the invisible
4539 text, which confuses `set_cursor_from_row'.
4541 We use the last invisible position instead of the
4542 first because this way the cursor is always drawn on
4543 the first "." of the ellipsis, whenever PT is inside
4544 the invisible text. Otherwise the cursor would be
4545 placed _after_ the ellipsis when the point is after the
4546 first invisible character. */
4547 if (!STRINGP (it
->object
))
4549 it
->position
.charpos
= newpos
- 1;
4550 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4552 it
->ellipsis_p
= true;
4553 /* Let the ellipsis display before
4554 considering any properties of the following char.
4555 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4556 handled
= HANDLED_RETURN
;
4565 /* Make iterator IT return `...' next.
4566 Replaces LEN characters from buffer. */
4569 setup_for_ellipsis (struct it
*it
, int len
)
4571 /* Use the display table definition for `...'. Invalid glyphs
4572 will be handled by the method returning elements from dpvec. */
4573 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4575 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4576 it
->dpvec
= v
->contents
;
4577 it
->dpend
= v
->contents
+ v
->header
.size
;
4581 /* Default `...'. */
4582 it
->dpvec
= default_invis_vector
;
4583 it
->dpend
= default_invis_vector
+ 3;
4586 it
->dpvec_char_len
= len
;
4587 it
->current
.dpvec_index
= 0;
4588 it
->dpvec_face_id
= -1;
4590 /* Remember the current face id in case glyphs specify faces.
4591 IT's face is restored in set_iterator_to_next.
4592 saved_face_id was set to preceding char's face in handle_stop. */
4593 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4594 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4596 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4597 it
->ellipsis_p
= true;
4602 /***********************************************************************
4604 ***********************************************************************/
4606 /* Set up iterator IT from `display' property at its current position.
4607 Called from handle_stop.
4608 We return HANDLED_RETURN if some part of the display property
4609 overrides the display of the buffer text itself.
4610 Otherwise we return HANDLED_NORMALLY. */
4612 static enum prop_handled
4613 handle_display_prop (struct it
*it
)
4615 Lisp_Object propval
, object
, overlay
;
4616 struct text_pos
*position
;
4618 /* Nonzero if some property replaces the display of the text itself. */
4619 int display_replaced_p
= 0;
4621 if (STRINGP (it
->string
))
4623 object
= it
->string
;
4624 position
= &it
->current
.string_pos
;
4625 bufpos
= CHARPOS (it
->current
.pos
);
4629 XSETWINDOW (object
, it
->w
);
4630 position
= &it
->current
.pos
;
4631 bufpos
= CHARPOS (*position
);
4634 /* Reset those iterator values set from display property values. */
4635 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4636 it
->space_width
= Qnil
;
4637 it
->font_height
= Qnil
;
4640 /* We don't support recursive `display' properties, i.e. string
4641 values that have a string `display' property, that have a string
4642 `display' property etc. */
4643 if (!it
->string_from_display_prop_p
)
4644 it
->area
= TEXT_AREA
;
4646 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4647 Qdisplay
, object
, &overlay
);
4649 return HANDLED_NORMALLY
;
4650 /* Now OVERLAY is the overlay that gave us this property, or nil
4651 if it was a text property. */
4653 if (!STRINGP (it
->string
))
4654 object
= it
->w
->contents
;
4656 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4658 FRAME_WINDOW_P (it
->f
));
4660 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4663 /* Subroutine of handle_display_prop. Returns non-zero if the display
4664 specification in SPEC is a replacing specification, i.e. it would
4665 replace the text covered by `display' property with something else,
4666 such as an image or a display string. If SPEC includes any kind or
4667 `(space ...) specification, the value is 2; this is used by
4668 compute_display_string_pos, which see.
4670 See handle_single_display_spec for documentation of arguments.
4671 frame_window_p is non-zero if the window being redisplayed is on a
4672 GUI frame; this argument is used only if IT is NULL, see below.
4674 IT can be NULL, if this is called by the bidi reordering code
4675 through compute_display_string_pos, which see. In that case, this
4676 function only examines SPEC, but does not otherwise "handle" it, in
4677 the sense that it doesn't set up members of IT from the display
4680 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4681 Lisp_Object overlay
, struct text_pos
*position
,
4682 ptrdiff_t bufpos
, int frame_window_p
)
4684 int replacing_p
= 0;
4688 /* Simple specifications. */
4689 && !EQ (XCAR (spec
), Qimage
)
4690 && !EQ (XCAR (spec
), Qspace
)
4691 && !EQ (XCAR (spec
), Qwhen
)
4692 && !EQ (XCAR (spec
), Qslice
)
4693 && !EQ (XCAR (spec
), Qspace_width
)
4694 && !EQ (XCAR (spec
), Qheight
)
4695 && !EQ (XCAR (spec
), Qraise
)
4696 /* Marginal area specifications. */
4697 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4698 && !EQ (XCAR (spec
), Qleft_fringe
)
4699 && !EQ (XCAR (spec
), Qright_fringe
)
4700 && !NILP (XCAR (spec
)))
4702 for (; CONSP (spec
); spec
= XCDR (spec
))
4704 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4705 overlay
, position
, bufpos
,
4706 replacing_p
, frame_window_p
)))
4709 /* If some text in a string is replaced, `position' no
4710 longer points to the position of `object'. */
4711 if (!it
|| STRINGP (object
))
4716 else if (VECTORP (spec
))
4719 for (i
= 0; i
< ASIZE (spec
); ++i
)
4720 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4721 overlay
, position
, bufpos
,
4722 replacing_p
, frame_window_p
)))
4725 /* If some text in a string is replaced, `position' no
4726 longer points to the position of `object'. */
4727 if (!it
|| STRINGP (object
))
4733 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4734 position
, bufpos
, 0,
4742 /* Value is the position of the end of the `display' property starting
4743 at START_POS in OBJECT. */
4745 static struct text_pos
4746 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4749 struct text_pos end_pos
;
4751 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4752 Qdisplay
, object
, Qnil
);
4753 CHARPOS (end_pos
) = XFASTINT (end
);
4754 if (STRINGP (object
))
4755 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4757 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4763 /* Set up IT from a single `display' property specification SPEC. OBJECT
4764 is the object in which the `display' property was found. *POSITION
4765 is the position in OBJECT at which the `display' property was found.
4766 BUFPOS is the buffer position of OBJECT (different from POSITION if
4767 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4768 previously saw a display specification which already replaced text
4769 display with something else, for example an image; we ignore such
4770 properties after the first one has been processed.
4772 OVERLAY is the overlay this `display' property came from,
4773 or nil if it was a text property.
4775 If SPEC is a `space' or `image' specification, and in some other
4776 cases too, set *POSITION to the position where the `display'
4779 If IT is NULL, only examine the property specification in SPEC, but
4780 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4781 is intended to be displayed in a window on a GUI frame.
4783 Value is non-zero if something was found which replaces the display
4784 of buffer or string text. */
4787 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4788 Lisp_Object overlay
, struct text_pos
*position
,
4789 ptrdiff_t bufpos
, int display_replaced_p
,
4793 Lisp_Object location
, value
;
4794 struct text_pos start_pos
= *position
;
4797 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4798 If the result is non-nil, use VALUE instead of SPEC. */
4800 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4809 if (!NILP (form
) && !EQ (form
, Qt
))
4811 ptrdiff_t count
= SPECPDL_INDEX ();
4812 struct gcpro gcpro1
;
4814 /* Bind `object' to the object having the `display' property, a
4815 buffer or string. Bind `position' to the position in the
4816 object where the property was found, and `buffer-position'
4817 to the current position in the buffer. */
4820 XSETBUFFER (object
, current_buffer
);
4821 specbind (Qobject
, object
);
4822 specbind (Qposition
, make_number (CHARPOS (*position
)));
4823 specbind (Qbuffer_position
, make_number (bufpos
));
4825 form
= safe_eval (form
);
4827 unbind_to (count
, Qnil
);
4833 /* Handle `(height HEIGHT)' specifications. */
4835 && EQ (XCAR (spec
), Qheight
)
4836 && CONSP (XCDR (spec
)))
4840 if (!FRAME_WINDOW_P (it
->f
))
4843 it
->font_height
= XCAR (XCDR (spec
));
4844 if (!NILP (it
->font_height
))
4846 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4847 int new_height
= -1;
4849 if (CONSP (it
->font_height
)
4850 && (EQ (XCAR (it
->font_height
), Qplus
)
4851 || EQ (XCAR (it
->font_height
), Qminus
))
4852 && CONSP (XCDR (it
->font_height
))
4853 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4855 /* `(+ N)' or `(- N)' where N is an integer. */
4856 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4857 if (EQ (XCAR (it
->font_height
), Qplus
))
4859 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4861 else if (FUNCTIONP (it
->font_height
))
4863 /* Call function with current height as argument.
4864 Value is the new height. */
4866 height
= safe_call1 (it
->font_height
,
4867 face
->lface
[LFACE_HEIGHT_INDEX
]);
4868 if (NUMBERP (height
))
4869 new_height
= XFLOATINT (height
);
4871 else if (NUMBERP (it
->font_height
))
4873 /* Value is a multiple of the canonical char height. */
4876 f
= FACE_FROM_ID (it
->f
,
4877 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4878 new_height
= (XFLOATINT (it
->font_height
)
4879 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4883 /* Evaluate IT->font_height with `height' bound to the
4884 current specified height to get the new height. */
4885 ptrdiff_t count
= SPECPDL_INDEX ();
4887 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4888 value
= safe_eval (it
->font_height
);
4889 unbind_to (count
, Qnil
);
4891 if (NUMBERP (value
))
4892 new_height
= XFLOATINT (value
);
4896 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4903 /* Handle `(space-width WIDTH)'. */
4905 && EQ (XCAR (spec
), Qspace_width
)
4906 && CONSP (XCDR (spec
)))
4910 if (!FRAME_WINDOW_P (it
->f
))
4913 value
= XCAR (XCDR (spec
));
4914 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4915 it
->space_width
= value
;
4921 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4923 && EQ (XCAR (spec
), Qslice
))
4929 if (!FRAME_WINDOW_P (it
->f
))
4932 if (tem
= XCDR (spec
), CONSP (tem
))
4934 it
->slice
.x
= XCAR (tem
);
4935 if (tem
= XCDR (tem
), CONSP (tem
))
4937 it
->slice
.y
= XCAR (tem
);
4938 if (tem
= XCDR (tem
), CONSP (tem
))
4940 it
->slice
.width
= XCAR (tem
);
4941 if (tem
= XCDR (tem
), CONSP (tem
))
4942 it
->slice
.height
= XCAR (tem
);
4951 /* Handle `(raise FACTOR)'. */
4953 && EQ (XCAR (spec
), Qraise
)
4954 && CONSP (XCDR (spec
)))
4958 if (!FRAME_WINDOW_P (it
->f
))
4961 #ifdef HAVE_WINDOW_SYSTEM
4962 value
= XCAR (XCDR (spec
));
4963 if (NUMBERP (value
))
4965 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4966 it
->voffset
= - (XFLOATINT (value
)
4967 * (FONT_HEIGHT (face
->font
)));
4969 #endif /* HAVE_WINDOW_SYSTEM */
4975 /* Don't handle the other kinds of display specifications
4976 inside a string that we got from a `display' property. */
4977 if (it
&& it
->string_from_display_prop_p
)
4980 /* Characters having this form of property are not displayed, so
4981 we have to find the end of the property. */
4984 start_pos
= *position
;
4985 *position
= display_prop_end (it
, object
, start_pos
);
4989 /* Stop the scan at that end position--we assume that all
4990 text properties change there. */
4992 it
->stop_charpos
= position
->charpos
;
4994 /* Handle `(left-fringe BITMAP [FACE])'
4995 and `(right-fringe BITMAP [FACE])'. */
4997 && (EQ (XCAR (spec
), Qleft_fringe
)
4998 || EQ (XCAR (spec
), Qright_fringe
))
4999 && CONSP (XCDR (spec
)))
5005 if (!FRAME_WINDOW_P (it
->f
))
5006 /* If we return here, POSITION has been advanced
5007 across the text with this property. */
5009 /* Synchronize the bidi iterator with POSITION. This is
5010 needed because we are not going to push the iterator
5011 on behalf of this display property, so there will be
5012 no pop_it call to do this synchronization for us. */
5015 it
->position
= *position
;
5016 iterate_out_of_display_property (it
);
5017 *position
= it
->position
;
5022 else if (!frame_window_p
)
5025 #ifdef HAVE_WINDOW_SYSTEM
5026 value
= XCAR (XCDR (spec
));
5027 if (!SYMBOLP (value
)
5028 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5029 /* If we return here, POSITION has been advanced
5030 across the text with this property. */
5032 if (it
&& it
->bidi_p
)
5034 it
->position
= *position
;
5035 iterate_out_of_display_property (it
);
5036 *position
= it
->position
;
5043 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5045 if (CONSP (XCDR (XCDR (spec
))))
5047 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5048 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5054 /* Save current settings of IT so that we can restore them
5055 when we are finished with the glyph property value. */
5056 push_it (it
, position
);
5058 it
->area
= TEXT_AREA
;
5059 it
->what
= IT_IMAGE
;
5060 it
->image_id
= -1; /* no image */
5061 it
->position
= start_pos
;
5062 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5063 it
->method
= GET_FROM_IMAGE
;
5064 it
->from_overlay
= Qnil
;
5065 it
->face_id
= face_id
;
5066 it
->from_disp_prop_p
= true;
5068 /* Say that we haven't consumed the characters with
5069 `display' property yet. The call to pop_it in
5070 set_iterator_to_next will clean this up. */
5071 *position
= start_pos
;
5073 if (EQ (XCAR (spec
), Qleft_fringe
))
5075 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5076 it
->left_user_fringe_face_id
= face_id
;
5080 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5081 it
->right_user_fringe_face_id
= face_id
;
5084 #endif /* HAVE_WINDOW_SYSTEM */
5088 /* Prepare to handle `((margin left-margin) ...)',
5089 `((margin right-margin) ...)' and `((margin nil) ...)'
5090 prefixes for display specifications. */
5091 location
= Qunbound
;
5092 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5096 value
= XCDR (spec
);
5098 value
= XCAR (value
);
5101 if (EQ (XCAR (tem
), Qmargin
)
5102 && (tem
= XCDR (tem
),
5103 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5105 || EQ (tem
, Qleft_margin
)
5106 || EQ (tem
, Qright_margin
))))
5110 if (EQ (location
, Qunbound
))
5116 /* After this point, VALUE is the property after any
5117 margin prefix has been stripped. It must be a string,
5118 an image specification, or `(space ...)'.
5120 LOCATION specifies where to display: `left-margin',
5121 `right-margin' or nil. */
5123 valid_p
= (STRINGP (value
)
5124 #ifdef HAVE_WINDOW_SYSTEM
5125 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5126 && valid_image_p (value
))
5127 #endif /* not HAVE_WINDOW_SYSTEM */
5128 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5130 if (valid_p
&& !display_replaced_p
)
5136 /* Callers need to know whether the display spec is any kind
5137 of `(space ...)' spec that is about to affect text-area
5139 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5144 /* Save current settings of IT so that we can restore them
5145 when we are finished with the glyph property value. */
5146 push_it (it
, position
);
5147 it
->from_overlay
= overlay
;
5148 it
->from_disp_prop_p
= true;
5150 if (NILP (location
))
5151 it
->area
= TEXT_AREA
;
5152 else if (EQ (location
, Qleft_margin
))
5153 it
->area
= LEFT_MARGIN_AREA
;
5155 it
->area
= RIGHT_MARGIN_AREA
;
5157 if (STRINGP (value
))
5160 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5161 it
->current
.overlay_string_index
= -1;
5162 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5163 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5164 it
->method
= GET_FROM_STRING
;
5165 it
->stop_charpos
= 0;
5167 it
->base_level_stop
= 0;
5168 it
->string_from_display_prop_p
= true;
5169 /* Say that we haven't consumed the characters with
5170 `display' property yet. The call to pop_it in
5171 set_iterator_to_next will clean this up. */
5172 if (BUFFERP (object
))
5173 *position
= start_pos
;
5175 /* Force paragraph direction to be that of the parent
5176 object. If the parent object's paragraph direction is
5177 not yet determined, default to L2R. */
5178 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5179 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5181 it
->paragraph_embedding
= L2R
;
5183 /* Set up the bidi iterator for this display string. */
5186 it
->bidi_it
.string
.lstring
= it
->string
;
5187 it
->bidi_it
.string
.s
= NULL
;
5188 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5189 it
->bidi_it
.string
.bufpos
= bufpos
;
5190 it
->bidi_it
.string
.from_disp_str
= 1;
5191 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5192 it
->bidi_it
.w
= it
->w
;
5193 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5196 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5198 it
->method
= GET_FROM_STRETCH
;
5200 *position
= it
->position
= start_pos
;
5201 retval
= 1 + (it
->area
== TEXT_AREA
);
5203 #ifdef HAVE_WINDOW_SYSTEM
5206 it
->what
= IT_IMAGE
;
5207 it
->image_id
= lookup_image (it
->f
, value
);
5208 it
->position
= start_pos
;
5209 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5210 it
->method
= GET_FROM_IMAGE
;
5212 /* Say that we haven't consumed the characters with
5213 `display' property yet. The call to pop_it in
5214 set_iterator_to_next will clean this up. */
5215 *position
= start_pos
;
5217 #endif /* HAVE_WINDOW_SYSTEM */
5222 /* Invalid property or property not supported. Restore
5223 POSITION to what it was before. */
5224 *position
= start_pos
;
5228 /* Check if PROP is a display property value whose text should be
5229 treated as intangible. OVERLAY is the overlay from which PROP
5230 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5231 specify the buffer position covered by PROP. */
5234 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5235 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5237 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5238 struct text_pos position
;
5240 SET_TEXT_POS (position
, charpos
, bytepos
);
5241 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5242 &position
, charpos
, frame_window_p
);
5246 /* Return 1 if PROP is a display sub-property value containing STRING.
5248 Implementation note: this and the following function are really
5249 special cases of handle_display_spec and
5250 handle_single_display_spec, and should ideally use the same code.
5251 Until they do, these two pairs must be consistent and must be
5252 modified in sync. */
5255 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5257 if (EQ (string
, prop
))
5260 /* Skip over `when FORM'. */
5261 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5266 /* Actually, the condition following `when' should be eval'ed,
5267 like handle_single_display_spec does, and we should return
5268 zero if it evaluates to nil. However, this function is
5269 called only when the buffer was already displayed and some
5270 glyph in the glyph matrix was found to come from a display
5271 string. Therefore, the condition was already evaluated, and
5272 the result was non-nil, otherwise the display string wouldn't
5273 have been displayed and we would have never been called for
5274 this property. Thus, we can skip the evaluation and assume
5275 its result is non-nil. */
5280 /* Skip over `margin LOCATION'. */
5281 if (EQ (XCAR (prop
), Qmargin
))
5292 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5296 /* Return 1 if STRING appears in the `display' property PROP. */
5299 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5302 && !EQ (XCAR (prop
), Qwhen
)
5303 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5305 /* A list of sub-properties. */
5306 while (CONSP (prop
))
5308 if (single_display_spec_string_p (XCAR (prop
), string
))
5313 else if (VECTORP (prop
))
5315 /* A vector of sub-properties. */
5317 for (i
= 0; i
< ASIZE (prop
); ++i
)
5318 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5322 return single_display_spec_string_p (prop
, string
);
5327 /* Look for STRING in overlays and text properties in the current
5328 buffer, between character positions FROM and TO (excluding TO).
5329 BACK_P non-zero means look back (in this case, TO is supposed to be
5331 Value is the first character position where STRING was found, or
5332 zero if it wasn't found before hitting TO.
5334 This function may only use code that doesn't eval because it is
5335 called asynchronously from note_mouse_highlight. */
5338 string_buffer_position_lim (Lisp_Object string
,
5339 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5341 Lisp_Object limit
, prop
, pos
;
5344 pos
= make_number (max (from
, BEGV
));
5346 if (!back_p
) /* looking forward */
5348 limit
= make_number (min (to
, ZV
));
5349 while (!found
&& !EQ (pos
, limit
))
5351 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5352 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5355 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5359 else /* looking back */
5361 limit
= make_number (max (to
, BEGV
));
5362 while (!found
&& !EQ (pos
, limit
))
5364 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5365 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5368 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5373 return found
? XINT (pos
) : 0;
5376 /* Determine which buffer position in current buffer STRING comes from.
5377 AROUND_CHARPOS is an approximate position where it could come from.
5378 Value is the buffer position or 0 if it couldn't be determined.
5380 This function is necessary because we don't record buffer positions
5381 in glyphs generated from strings (to keep struct glyph small).
5382 This function may only use code that doesn't eval because it is
5383 called asynchronously from note_mouse_highlight. */
5386 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5388 const int MAX_DISTANCE
= 1000;
5389 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5390 around_charpos
+ MAX_DISTANCE
,
5394 found
= string_buffer_position_lim (string
, around_charpos
,
5395 around_charpos
- MAX_DISTANCE
, 1);
5401 /***********************************************************************
5402 `composition' property
5403 ***********************************************************************/
5405 /* Set up iterator IT from `composition' property at its current
5406 position. Called from handle_stop. */
5408 static enum prop_handled
5409 handle_composition_prop (struct it
*it
)
5411 Lisp_Object prop
, string
;
5412 ptrdiff_t pos
, pos_byte
, start
, end
;
5414 if (STRINGP (it
->string
))
5418 pos
= IT_STRING_CHARPOS (*it
);
5419 pos_byte
= IT_STRING_BYTEPOS (*it
);
5420 string
= it
->string
;
5421 s
= SDATA (string
) + pos_byte
;
5422 it
->c
= STRING_CHAR (s
);
5426 pos
= IT_CHARPOS (*it
);
5427 pos_byte
= IT_BYTEPOS (*it
);
5429 it
->c
= FETCH_CHAR (pos_byte
);
5432 /* If there's a valid composition and point is not inside of the
5433 composition (in the case that the composition is from the current
5434 buffer), draw a glyph composed from the composition components. */
5435 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5436 && composition_valid_p (start
, end
, prop
)
5437 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5440 /* As we can't handle this situation (perhaps font-lock added
5441 a new composition), we just return here hoping that next
5442 redisplay will detect this composition much earlier. */
5443 return HANDLED_NORMALLY
;
5446 if (STRINGP (it
->string
))
5447 pos_byte
= string_char_to_byte (it
->string
, start
);
5449 pos_byte
= CHAR_TO_BYTE (start
);
5451 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5454 if (it
->cmp_it
.id
>= 0)
5457 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5458 it
->cmp_it
.nglyphs
= -1;
5462 return HANDLED_NORMALLY
;
5467 /***********************************************************************
5469 ***********************************************************************/
5471 /* The following structure is used to record overlay strings for
5472 later sorting in load_overlay_strings. */
5474 struct overlay_entry
5476 Lisp_Object overlay
;
5483 /* Set up iterator IT from overlay strings at its current position.
5484 Called from handle_stop. */
5486 static enum prop_handled
5487 handle_overlay_change (struct it
*it
)
5489 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5490 return HANDLED_RECOMPUTE_PROPS
;
5492 return HANDLED_NORMALLY
;
5496 /* Set up the next overlay string for delivery by IT, if there is an
5497 overlay string to deliver. Called by set_iterator_to_next when the
5498 end of the current overlay string is reached. If there are more
5499 overlay strings to display, IT->string and
5500 IT->current.overlay_string_index are set appropriately here.
5501 Otherwise IT->string is set to nil. */
5504 next_overlay_string (struct it
*it
)
5506 ++it
->current
.overlay_string_index
;
5507 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5509 /* No more overlay strings. Restore IT's settings to what
5510 they were before overlay strings were processed, and
5511 continue to deliver from current_buffer. */
5513 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5516 || (NILP (it
->string
)
5517 && it
->method
== GET_FROM_BUFFER
5518 && it
->stop_charpos
>= BEGV
5519 && it
->stop_charpos
<= it
->end_charpos
));
5520 it
->current
.overlay_string_index
= -1;
5521 it
->n_overlay_strings
= 0;
5522 it
->overlay_strings_charpos
= -1;
5523 /* If there's an empty display string on the stack, pop the
5524 stack, to resync the bidi iterator with IT's position. Such
5525 empty strings are pushed onto the stack in
5526 get_overlay_strings_1. */
5527 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5530 /* If we're at the end of the buffer, record that we have
5531 processed the overlay strings there already, so that
5532 next_element_from_buffer doesn't try it again. */
5533 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5534 it
->overlay_strings_at_end_processed_p
= true;
5538 /* There are more overlay strings to process. If
5539 IT->current.overlay_string_index has advanced to a position
5540 where we must load IT->overlay_strings with more strings, do
5541 it. We must load at the IT->overlay_strings_charpos where
5542 IT->n_overlay_strings was originally computed; when invisible
5543 text is present, this might not be IT_CHARPOS (Bug#7016). */
5544 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5546 if (it
->current
.overlay_string_index
&& i
== 0)
5547 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5549 /* Initialize IT to deliver display elements from the overlay
5551 it
->string
= it
->overlay_strings
[i
];
5552 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5553 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5554 it
->method
= GET_FROM_STRING
;
5555 it
->stop_charpos
= 0;
5556 it
->end_charpos
= SCHARS (it
->string
);
5557 if (it
->cmp_it
.stop_pos
>= 0)
5558 it
->cmp_it
.stop_pos
= 0;
5560 it
->base_level_stop
= 0;
5562 /* Set up the bidi iterator for this overlay string. */
5565 it
->bidi_it
.string
.lstring
= it
->string
;
5566 it
->bidi_it
.string
.s
= NULL
;
5567 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5568 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5569 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5570 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5571 it
->bidi_it
.w
= it
->w
;
5572 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5580 /* Compare two overlay_entry structures E1 and E2. Used as a
5581 comparison function for qsort in load_overlay_strings. Overlay
5582 strings for the same position are sorted so that
5584 1. All after-strings come in front of before-strings, except
5585 when they come from the same overlay.
5587 2. Within after-strings, strings are sorted so that overlay strings
5588 from overlays with higher priorities come first.
5590 2. Within before-strings, strings are sorted so that overlay
5591 strings from overlays with higher priorities come last.
5593 Value is analogous to strcmp. */
5597 compare_overlay_entries (const void *e1
, const void *e2
)
5599 struct overlay_entry
const *entry1
= e1
;
5600 struct overlay_entry
const *entry2
= e2
;
5603 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5605 /* Let after-strings appear in front of before-strings if
5606 they come from different overlays. */
5607 if (EQ (entry1
->overlay
, entry2
->overlay
))
5608 result
= entry1
->after_string_p
? 1 : -1;
5610 result
= entry1
->after_string_p
? -1 : 1;
5612 else if (entry1
->priority
!= entry2
->priority
)
5614 if (entry1
->after_string_p
)
5615 /* After-strings sorted in order of decreasing priority. */
5616 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5618 /* Before-strings sorted in order of increasing priority. */
5619 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5628 /* Load the vector IT->overlay_strings with overlay strings from IT's
5629 current buffer position, or from CHARPOS if that is > 0. Set
5630 IT->n_overlays to the total number of overlay strings found.
5632 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5633 a time. On entry into load_overlay_strings,
5634 IT->current.overlay_string_index gives the number of overlay
5635 strings that have already been loaded by previous calls to this
5638 IT->add_overlay_start contains an additional overlay start
5639 position to consider for taking overlay strings from, if non-zero.
5640 This position comes into play when the overlay has an `invisible'
5641 property, and both before and after-strings. When we've skipped to
5642 the end of the overlay, because of its `invisible' property, we
5643 nevertheless want its before-string to appear.
5644 IT->add_overlay_start will contain the overlay start position
5647 Overlay strings are sorted so that after-string strings come in
5648 front of before-string strings. Within before and after-strings,
5649 strings are sorted by overlay priority. See also function
5650 compare_overlay_entries. */
5653 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5655 Lisp_Object overlay
, window
, str
, invisible
;
5656 struct Lisp_Overlay
*ov
;
5657 ptrdiff_t start
, end
;
5658 ptrdiff_t size
= 20;
5659 ptrdiff_t n
= 0, i
, j
;
5661 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5665 charpos
= IT_CHARPOS (*it
);
5667 /* Append the overlay string STRING of overlay OVERLAY to vector
5668 `entries' which has size `size' and currently contains `n'
5669 elements. AFTER_P non-zero means STRING is an after-string of
5671 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5674 Lisp_Object priority; \
5678 struct overlay_entry *old = entries; \
5679 SAFE_NALLOCA (entries, 2, size); \
5680 memcpy (entries, old, size * sizeof *entries); \
5684 entries[n].string = (STRING); \
5685 entries[n].overlay = (OVERLAY); \
5686 priority = Foverlay_get ((OVERLAY), Qpriority); \
5687 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5688 entries[n].after_string_p = (AFTER_P); \
5693 /* Process overlay before the overlay center. */
5694 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5696 XSETMISC (overlay
, ov
);
5697 eassert (OVERLAYP (overlay
));
5698 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5699 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5704 /* Skip this overlay if it doesn't start or end at IT's current
5706 if (end
!= charpos
&& start
!= charpos
)
5709 /* Skip this overlay if it doesn't apply to IT->w. */
5710 window
= Foverlay_get (overlay
, Qwindow
);
5711 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5714 /* If the text ``under'' the overlay is invisible, both before-
5715 and after-strings from this overlay are visible; start and
5716 end position are indistinguishable. */
5717 invisible
= Foverlay_get (overlay
, Qinvisible
);
5718 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5720 /* If overlay has a non-empty before-string, record it. */
5721 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5722 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5724 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5726 /* If overlay has a non-empty after-string, record it. */
5727 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5728 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5730 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5733 /* Process overlays after the overlay center. */
5734 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5736 XSETMISC (overlay
, ov
);
5737 eassert (OVERLAYP (overlay
));
5738 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5739 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5741 if (start
> charpos
)
5744 /* Skip this overlay if it doesn't start or end at IT's current
5746 if (end
!= charpos
&& start
!= charpos
)
5749 /* Skip this overlay if it doesn't apply to IT->w. */
5750 window
= Foverlay_get (overlay
, Qwindow
);
5751 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5754 /* If the text ``under'' the overlay is invisible, it has a zero
5755 dimension, and both before- and after-strings apply. */
5756 invisible
= Foverlay_get (overlay
, Qinvisible
);
5757 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5759 /* If overlay has a non-empty before-string, record it. */
5760 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5761 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5763 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5765 /* If overlay has a non-empty after-string, record it. */
5766 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5767 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5769 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5772 #undef RECORD_OVERLAY_STRING
5776 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5778 /* Record number of overlay strings, and where we computed it. */
5779 it
->n_overlay_strings
= n
;
5780 it
->overlay_strings_charpos
= charpos
;
5782 /* IT->current.overlay_string_index is the number of overlay strings
5783 that have already been consumed by IT. Copy some of the
5784 remaining overlay strings to IT->overlay_strings. */
5786 j
= it
->current
.overlay_string_index
;
5787 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5789 it
->overlay_strings
[i
] = entries
[j
].string
;
5790 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5798 /* Get the first chunk of overlay strings at IT's current buffer
5799 position, or at CHARPOS if that is > 0. Value is non-zero if at
5800 least one overlay string was found. */
5803 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5805 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5806 process. This fills IT->overlay_strings with strings, and sets
5807 IT->n_overlay_strings to the total number of strings to process.
5808 IT->pos.overlay_string_index has to be set temporarily to zero
5809 because load_overlay_strings needs this; it must be set to -1
5810 when no overlay strings are found because a zero value would
5811 indicate a position in the first overlay string. */
5812 it
->current
.overlay_string_index
= 0;
5813 load_overlay_strings (it
, charpos
);
5815 /* If we found overlay strings, set up IT to deliver display
5816 elements from the first one. Otherwise set up IT to deliver
5817 from current_buffer. */
5818 if (it
->n_overlay_strings
)
5820 /* Make sure we know settings in current_buffer, so that we can
5821 restore meaningful values when we're done with the overlay
5824 compute_stop_pos (it
);
5825 eassert (it
->face_id
>= 0);
5827 /* Save IT's settings. They are restored after all overlay
5828 strings have been processed. */
5829 eassert (!compute_stop_p
|| it
->sp
== 0);
5831 /* When called from handle_stop, there might be an empty display
5832 string loaded. In that case, don't bother saving it. But
5833 don't use this optimization with the bidi iterator, since we
5834 need the corresponding pop_it call to resync the bidi
5835 iterator's position with IT's position, after we are done
5836 with the overlay strings. (The corresponding call to pop_it
5837 in case of an empty display string is in
5838 next_overlay_string.) */
5840 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5843 /* Set up IT to deliver display elements from the first overlay
5845 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5846 it
->string
= it
->overlay_strings
[0];
5847 it
->from_overlay
= Qnil
;
5848 it
->stop_charpos
= 0;
5849 eassert (STRINGP (it
->string
));
5850 it
->end_charpos
= SCHARS (it
->string
);
5852 it
->base_level_stop
= 0;
5853 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5854 it
->method
= GET_FROM_STRING
;
5855 it
->from_disp_prop_p
= 0;
5857 /* Force paragraph direction to be that of the parent
5859 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5860 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5862 it
->paragraph_embedding
= L2R
;
5864 /* Set up the bidi iterator for this overlay string. */
5867 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5869 it
->bidi_it
.string
.lstring
= it
->string
;
5870 it
->bidi_it
.string
.s
= NULL
;
5871 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5872 it
->bidi_it
.string
.bufpos
= pos
;
5873 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5874 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5875 it
->bidi_it
.w
= it
->w
;
5876 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5881 it
->current
.overlay_string_index
= -1;
5886 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5889 it
->method
= GET_FROM_BUFFER
;
5891 (void) get_overlay_strings_1 (it
, charpos
, 1);
5895 /* Value is non-zero if we found at least one overlay string. */
5896 return STRINGP (it
->string
);
5901 /***********************************************************************
5902 Saving and restoring state
5903 ***********************************************************************/
5905 /* Save current settings of IT on IT->stack. Called, for example,
5906 before setting up IT for an overlay string, to be able to restore
5907 IT's settings to what they were after the overlay string has been
5908 processed. If POSITION is non-NULL, it is the position to save on
5909 the stack instead of IT->position. */
5912 push_it (struct it
*it
, struct text_pos
*position
)
5914 struct iterator_stack_entry
*p
;
5916 eassert (it
->sp
< IT_STACK_SIZE
);
5917 p
= it
->stack
+ it
->sp
;
5919 p
->stop_charpos
= it
->stop_charpos
;
5920 p
->prev_stop
= it
->prev_stop
;
5921 p
->base_level_stop
= it
->base_level_stop
;
5922 p
->cmp_it
= it
->cmp_it
;
5923 eassert (it
->face_id
>= 0);
5924 p
->face_id
= it
->face_id
;
5925 p
->string
= it
->string
;
5926 p
->method
= it
->method
;
5927 p
->from_overlay
= it
->from_overlay
;
5930 case GET_FROM_IMAGE
:
5931 p
->u
.image
.object
= it
->object
;
5932 p
->u
.image
.image_id
= it
->image_id
;
5933 p
->u
.image
.slice
= it
->slice
;
5935 case GET_FROM_STRETCH
:
5936 p
->u
.stretch
.object
= it
->object
;
5939 p
->position
= position
? *position
: it
->position
;
5940 p
->current
= it
->current
;
5941 p
->end_charpos
= it
->end_charpos
;
5942 p
->string_nchars
= it
->string_nchars
;
5944 p
->multibyte_p
= it
->multibyte_p
;
5945 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5946 p
->space_width
= it
->space_width
;
5947 p
->font_height
= it
->font_height
;
5948 p
->voffset
= it
->voffset
;
5949 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5950 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5951 p
->display_ellipsis_p
= 0;
5952 p
->line_wrap
= it
->line_wrap
;
5953 p
->bidi_p
= it
->bidi_p
;
5954 p
->paragraph_embedding
= it
->paragraph_embedding
;
5955 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5958 /* Save the state of the bidi iterator as well. */
5960 bidi_push_it (&it
->bidi_it
);
5964 iterate_out_of_display_property (struct it
*it
)
5966 int buffer_p
= !STRINGP (it
->string
);
5967 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5968 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5970 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5972 /* Maybe initialize paragraph direction. If we are at the beginning
5973 of a new paragraph, next_element_from_buffer may not have a
5974 chance to do that. */
5975 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5976 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5977 /* prev_stop can be zero, so check against BEGV as well. */
5978 while (it
->bidi_it
.charpos
>= bob
5979 && it
->prev_stop
<= it
->bidi_it
.charpos
5980 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5981 && it
->bidi_it
.charpos
< eob
)
5982 bidi_move_to_visually_next (&it
->bidi_it
);
5983 /* Record the stop_pos we just crossed, for when we cross it
5985 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5986 it
->prev_stop
= CHARPOS (it
->position
);
5987 /* If we ended up not where pop_it put us, resync IT's
5988 positional members with the bidi iterator. */
5989 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5990 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5992 it
->current
.pos
= it
->position
;
5994 it
->current
.string_pos
= it
->position
;
5997 /* Restore IT's settings from IT->stack. Called, for example, when no
5998 more overlay strings must be processed, and we return to delivering
5999 display elements from a buffer, or when the end of a string from a
6000 `display' property is reached and we return to delivering display
6001 elements from an overlay string, or from a buffer. */
6004 pop_it (struct it
*it
)
6006 struct iterator_stack_entry
*p
;
6007 int from_display_prop
= it
->from_disp_prop_p
;
6009 eassert (it
->sp
> 0);
6011 p
= it
->stack
+ it
->sp
;
6012 it
->stop_charpos
= p
->stop_charpos
;
6013 it
->prev_stop
= p
->prev_stop
;
6014 it
->base_level_stop
= p
->base_level_stop
;
6015 it
->cmp_it
= p
->cmp_it
;
6016 it
->face_id
= p
->face_id
;
6017 it
->current
= p
->current
;
6018 it
->position
= p
->position
;
6019 it
->string
= p
->string
;
6020 it
->from_overlay
= p
->from_overlay
;
6021 if (NILP (it
->string
))
6022 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6023 it
->method
= p
->method
;
6026 case GET_FROM_IMAGE
:
6027 it
->image_id
= p
->u
.image
.image_id
;
6028 it
->object
= p
->u
.image
.object
;
6029 it
->slice
= p
->u
.image
.slice
;
6031 case GET_FROM_STRETCH
:
6032 it
->object
= p
->u
.stretch
.object
;
6034 case GET_FROM_BUFFER
:
6035 it
->object
= it
->w
->contents
;
6037 case GET_FROM_STRING
:
6039 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6041 /* Restore the face_box_p flag, since it could have been
6042 overwritten by the face of the object that we just finished
6045 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6046 it
->object
= it
->string
;
6049 case GET_FROM_DISPLAY_VECTOR
:
6051 it
->method
= GET_FROM_C_STRING
;
6052 else if (STRINGP (it
->string
))
6053 it
->method
= GET_FROM_STRING
;
6056 it
->method
= GET_FROM_BUFFER
;
6057 it
->object
= it
->w
->contents
;
6060 it
->end_charpos
= p
->end_charpos
;
6061 it
->string_nchars
= p
->string_nchars
;
6063 it
->multibyte_p
= p
->multibyte_p
;
6064 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6065 it
->space_width
= p
->space_width
;
6066 it
->font_height
= p
->font_height
;
6067 it
->voffset
= p
->voffset
;
6068 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6069 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6070 it
->line_wrap
= p
->line_wrap
;
6071 it
->bidi_p
= p
->bidi_p
;
6072 it
->paragraph_embedding
= p
->paragraph_embedding
;
6073 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6076 bidi_pop_it (&it
->bidi_it
);
6077 /* Bidi-iterate until we get out of the portion of text, if any,
6078 covered by a `display' text property or by an overlay with
6079 `display' property. (We cannot just jump there, because the
6080 internal coherency of the bidi iterator state can not be
6081 preserved across such jumps.) We also must determine the
6082 paragraph base direction if the overlay we just processed is
6083 at the beginning of a new paragraph. */
6084 if (from_display_prop
6085 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6086 iterate_out_of_display_property (it
);
6088 eassert ((BUFFERP (it
->object
)
6089 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6090 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6091 || (STRINGP (it
->object
)
6092 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6093 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6094 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6100 /***********************************************************************
6102 ***********************************************************************/
6104 /* Set IT's current position to the previous line start. */
6107 back_to_previous_line_start (struct it
*it
)
6109 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6112 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6116 /* Move IT to the next line start.
6118 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6119 we skipped over part of the text (as opposed to moving the iterator
6120 continuously over the text). Otherwise, don't change the value
6123 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6124 iterator on the newline, if it was found.
6126 Newlines may come from buffer text, overlay strings, or strings
6127 displayed via the `display' property. That's the reason we can't
6128 simply use find_newline_no_quit.
6130 Note that this function may not skip over invisible text that is so
6131 because of text properties and immediately follows a newline. If
6132 it would, function reseat_at_next_visible_line_start, when called
6133 from set_iterator_to_next, would effectively make invisible
6134 characters following a newline part of the wrong glyph row, which
6135 leads to wrong cursor motion. */
6138 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6139 struct bidi_it
*bidi_it_prev
)
6141 ptrdiff_t old_selective
;
6142 int newline_found_p
, n
;
6143 const int MAX_NEWLINE_DISTANCE
= 500;
6145 /* If already on a newline, just consume it to avoid unintended
6146 skipping over invisible text below. */
6147 if (it
->what
== IT_CHARACTER
6149 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6151 if (it
->bidi_p
&& bidi_it_prev
)
6152 *bidi_it_prev
= it
->bidi_it
;
6153 set_iterator_to_next (it
, 0);
6158 /* Don't handle selective display in the following. It's (a)
6159 unnecessary because it's done by the caller, and (b) leads to an
6160 infinite recursion because next_element_from_ellipsis indirectly
6161 calls this function. */
6162 old_selective
= it
->selective
;
6165 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6166 from buffer text. */
6167 for (n
= newline_found_p
= 0;
6168 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6169 n
+= STRINGP (it
->string
) ? 0 : 1)
6171 if (!get_next_display_element (it
))
6173 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6174 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6175 *bidi_it_prev
= it
->bidi_it
;
6176 set_iterator_to_next (it
, 0);
6179 /* If we didn't find a newline near enough, see if we can use a
6181 if (!newline_found_p
)
6183 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6184 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6188 eassert (!STRINGP (it
->string
));
6190 /* If there isn't any `display' property in sight, and no
6191 overlays, we can just use the position of the newline in
6193 if (it
->stop_charpos
>= limit
6194 || ((pos
= Fnext_single_property_change (make_number (start
),
6196 make_number (limit
)),
6198 && next_overlay_change (start
) == ZV
))
6202 IT_CHARPOS (*it
) = limit
;
6203 IT_BYTEPOS (*it
) = bytepos
;
6207 struct bidi_it bprev
;
6209 /* Help bidi.c avoid expensive searches for display
6210 properties and overlays, by telling it that there are
6211 none up to `limit'. */
6212 if (it
->bidi_it
.disp_pos
< limit
)
6214 it
->bidi_it
.disp_pos
= limit
;
6215 it
->bidi_it
.disp_prop
= 0;
6218 bprev
= it
->bidi_it
;
6219 bidi_move_to_visually_next (&it
->bidi_it
);
6220 } while (it
->bidi_it
.charpos
!= limit
);
6221 IT_CHARPOS (*it
) = limit
;
6222 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6224 *bidi_it_prev
= bprev
;
6226 *skipped_p
= newline_found_p
= true;
6230 while (get_next_display_element (it
)
6231 && !newline_found_p
)
6233 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6234 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6235 *bidi_it_prev
= it
->bidi_it
;
6236 set_iterator_to_next (it
, 0);
6241 it
->selective
= old_selective
;
6242 return newline_found_p
;
6246 /* Set IT's current position to the previous visible line start. Skip
6247 invisible text that is so either due to text properties or due to
6248 selective display. Caution: this does not change IT->current_x and
6252 back_to_previous_visible_line_start (struct it
*it
)
6254 while (IT_CHARPOS (*it
) > BEGV
)
6256 back_to_previous_line_start (it
);
6258 if (IT_CHARPOS (*it
) <= BEGV
)
6261 /* If selective > 0, then lines indented more than its value are
6263 if (it
->selective
> 0
6264 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6268 /* Check the newline before point for invisibility. */
6271 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6272 Qinvisible
, it
->window
);
6273 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6277 if (IT_CHARPOS (*it
) <= BEGV
)
6282 void *it2data
= NULL
;
6285 Lisp_Object val
, overlay
;
6287 SAVE_IT (it2
, *it
, it2data
);
6289 /* If newline is part of a composition, continue from start of composition */
6290 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6291 && beg
< IT_CHARPOS (*it
))
6294 /* If newline is replaced by a display property, find start of overlay
6295 or interval and continue search from that point. */
6296 pos
= --IT_CHARPOS (it2
);
6299 bidi_unshelve_cache (NULL
, 0);
6300 it2
.string_from_display_prop_p
= 0;
6301 it2
.from_disp_prop_p
= 0;
6302 if (handle_display_prop (&it2
) == HANDLED_RETURN
6303 && !NILP (val
= get_char_property_and_overlay
6304 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6305 && (OVERLAYP (overlay
)
6306 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6307 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6309 RESTORE_IT (it
, it
, it2data
);
6313 /* Newline is not replaced by anything -- so we are done. */
6314 RESTORE_IT (it
, it
, it2data
);
6320 IT_CHARPOS (*it
) = beg
;
6321 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6325 it
->continuation_lines_width
= 0;
6327 eassert (IT_CHARPOS (*it
) >= BEGV
);
6328 eassert (IT_CHARPOS (*it
) == BEGV
6329 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6334 /* Reseat iterator IT at the previous visible line start. Skip
6335 invisible text that is so either due to text properties or due to
6336 selective display. At the end, update IT's overlay information,
6337 face information etc. */
6340 reseat_at_previous_visible_line_start (struct it
*it
)
6342 back_to_previous_visible_line_start (it
);
6343 reseat (it
, it
->current
.pos
, 1);
6348 /* Reseat iterator IT on the next visible line start in the current
6349 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6350 preceding the line start. Skip over invisible text that is so
6351 because of selective display. Compute faces, overlays etc at the
6352 new position. Note that this function does not skip over text that
6353 is invisible because of text properties. */
6356 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6358 int newline_found_p
, skipped_p
= 0;
6359 struct bidi_it bidi_it_prev
;
6361 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6363 /* Skip over lines that are invisible because they are indented
6364 more than the value of IT->selective. */
6365 if (it
->selective
> 0)
6366 while (IT_CHARPOS (*it
) < ZV
6367 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6370 eassert (IT_BYTEPOS (*it
) == BEGV
6371 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6373 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6376 /* Position on the newline if that's what's requested. */
6377 if (on_newline_p
&& newline_found_p
)
6379 if (STRINGP (it
->string
))
6381 if (IT_STRING_CHARPOS (*it
) > 0)
6385 --IT_STRING_CHARPOS (*it
);
6386 --IT_STRING_BYTEPOS (*it
);
6390 /* We need to restore the bidi iterator to the state
6391 it had on the newline, and resync the IT's
6392 position with that. */
6393 it
->bidi_it
= bidi_it_prev
;
6394 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6395 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6399 else if (IT_CHARPOS (*it
) > BEGV
)
6408 /* We need to restore the bidi iterator to the state it
6409 had on the newline and resync IT with that. */
6410 it
->bidi_it
= bidi_it_prev
;
6411 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6412 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6414 reseat (it
, it
->current
.pos
, 0);
6418 reseat (it
, it
->current
.pos
, 0);
6425 /***********************************************************************
6426 Changing an iterator's position
6427 ***********************************************************************/
6429 /* Change IT's current position to POS in current_buffer. If FORCE_P
6430 is non-zero, always check for text properties at the new position.
6431 Otherwise, text properties are only looked up if POS >=
6432 IT->check_charpos of a property. */
6435 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6437 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6439 reseat_1 (it
, pos
, 0);
6441 /* Determine where to check text properties. Avoid doing it
6442 where possible because text property lookup is very expensive. */
6444 || CHARPOS (pos
) > it
->stop_charpos
6445 || CHARPOS (pos
) < original_pos
)
6449 /* For bidi iteration, we need to prime prev_stop and
6450 base_level_stop with our best estimations. */
6451 /* Implementation note: Of course, POS is not necessarily a
6452 stop position, so assigning prev_pos to it is a lie; we
6453 should have called compute_stop_backwards. However, if
6454 the current buffer does not include any R2L characters,
6455 that call would be a waste of cycles, because the
6456 iterator will never move back, and thus never cross this
6457 "fake" stop position. So we delay that backward search
6458 until the time we really need it, in next_element_from_buffer. */
6459 if (CHARPOS (pos
) != it
->prev_stop
)
6460 it
->prev_stop
= CHARPOS (pos
);
6461 if (CHARPOS (pos
) < it
->base_level_stop
)
6462 it
->base_level_stop
= 0; /* meaning it's unknown */
6468 it
->prev_stop
= it
->base_level_stop
= 0;
6477 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6478 IT->stop_pos to POS, also. */
6481 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6483 /* Don't call this function when scanning a C string. */
6484 eassert (it
->s
== NULL
);
6486 /* POS must be a reasonable value. */
6487 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6489 it
->current
.pos
= it
->position
= pos
;
6490 it
->end_charpos
= ZV
;
6492 it
->current
.dpvec_index
= -1;
6493 it
->current
.overlay_string_index
= -1;
6494 IT_STRING_CHARPOS (*it
) = -1;
6495 IT_STRING_BYTEPOS (*it
) = -1;
6497 it
->method
= GET_FROM_BUFFER
;
6498 it
->object
= it
->w
->contents
;
6499 it
->area
= TEXT_AREA
;
6500 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6502 it
->string_from_display_prop_p
= 0;
6503 it
->string_from_prefix_prop_p
= 0;
6505 it
->from_disp_prop_p
= 0;
6506 it
->face_before_selective_p
= 0;
6509 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6511 bidi_unshelve_cache (NULL
, 0);
6512 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6513 it
->bidi_it
.string
.s
= NULL
;
6514 it
->bidi_it
.string
.lstring
= Qnil
;
6515 it
->bidi_it
.string
.bufpos
= 0;
6516 it
->bidi_it
.string
.from_disp_str
= 0;
6517 it
->bidi_it
.string
.unibyte
= 0;
6518 it
->bidi_it
.w
= it
->w
;
6523 it
->stop_charpos
= CHARPOS (pos
);
6524 it
->base_level_stop
= CHARPOS (pos
);
6526 /* This make the information stored in it->cmp_it invalidate. */
6531 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6532 If S is non-null, it is a C string to iterate over. Otherwise,
6533 STRING gives a Lisp string to iterate over.
6535 If PRECISION > 0, don't return more then PRECISION number of
6536 characters from the string.
6538 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6539 characters have been returned. FIELD_WIDTH < 0 means an infinite
6542 MULTIBYTE = 0 means disable processing of multibyte characters,
6543 MULTIBYTE > 0 means enable it,
6544 MULTIBYTE < 0 means use IT->multibyte_p.
6546 IT must be initialized via a prior call to init_iterator before
6547 calling this function. */
6550 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6551 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6554 /* No text property checks performed by default, but see below. */
6555 it
->stop_charpos
= -1;
6557 /* Set iterator position and end position. */
6558 memset (&it
->current
, 0, sizeof it
->current
);
6559 it
->current
.overlay_string_index
= -1;
6560 it
->current
.dpvec_index
= -1;
6561 eassert (charpos
>= 0);
6563 /* If STRING is specified, use its multibyteness, otherwise use the
6564 setting of MULTIBYTE, if specified. */
6566 it
->multibyte_p
= multibyte
> 0;
6568 /* Bidirectional reordering of strings is controlled by the default
6569 value of bidi-display-reordering. Don't try to reorder while
6570 loading loadup.el, as the necessary character property tables are
6571 not yet available. */
6574 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6578 eassert (STRINGP (string
));
6579 it
->string
= string
;
6581 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6582 it
->method
= GET_FROM_STRING
;
6583 it
->current
.string_pos
= string_pos (charpos
, string
);
6587 it
->bidi_it
.string
.lstring
= string
;
6588 it
->bidi_it
.string
.s
= NULL
;
6589 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6590 it
->bidi_it
.string
.bufpos
= 0;
6591 it
->bidi_it
.string
.from_disp_str
= 0;
6592 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6593 it
->bidi_it
.w
= it
->w
;
6594 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6595 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6600 it
->s
= (const unsigned char *) s
;
6603 /* Note that we use IT->current.pos, not it->current.string_pos,
6604 for displaying C strings. */
6605 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6606 if (it
->multibyte_p
)
6608 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6609 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6613 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6614 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6619 it
->bidi_it
.string
.lstring
= Qnil
;
6620 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6621 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6622 it
->bidi_it
.string
.bufpos
= 0;
6623 it
->bidi_it
.string
.from_disp_str
= 0;
6624 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6625 it
->bidi_it
.w
= it
->w
;
6626 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6629 it
->method
= GET_FROM_C_STRING
;
6632 /* PRECISION > 0 means don't return more than PRECISION characters
6634 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6636 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6638 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6641 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6642 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6643 FIELD_WIDTH < 0 means infinite field width. This is useful for
6644 padding with `-' at the end of a mode line. */
6645 if (field_width
< 0)
6646 field_width
= INFINITY
;
6647 /* Implementation note: We deliberately don't enlarge
6648 it->bidi_it.string.schars here to fit it->end_charpos, because
6649 the bidi iterator cannot produce characters out of thin air. */
6650 if (field_width
> it
->end_charpos
- charpos
)
6651 it
->end_charpos
= charpos
+ field_width
;
6653 /* Use the standard display table for displaying strings. */
6654 if (DISP_TABLE_P (Vstandard_display_table
))
6655 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6657 it
->stop_charpos
= charpos
;
6658 it
->prev_stop
= charpos
;
6659 it
->base_level_stop
= 0;
6662 it
->bidi_it
.first_elt
= 1;
6663 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6664 it
->bidi_it
.disp_pos
= -1;
6666 if (s
== NULL
&& it
->multibyte_p
)
6668 ptrdiff_t endpos
= SCHARS (it
->string
);
6669 if (endpos
> it
->end_charpos
)
6670 endpos
= it
->end_charpos
;
6671 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6679 /***********************************************************************
6681 ***********************************************************************/
6683 /* Map enum it_method value to corresponding next_element_from_* function. */
6685 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6687 next_element_from_buffer
,
6688 next_element_from_display_vector
,
6689 next_element_from_string
,
6690 next_element_from_c_string
,
6691 next_element_from_image
,
6692 next_element_from_stretch
6695 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6698 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6699 (possibly with the following characters). */
6701 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6702 ((IT)->cmp_it.id >= 0 \
6703 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6704 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6705 END_CHARPOS, (IT)->w, \
6706 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6710 /* Lookup the char-table Vglyphless_char_display for character C (-1
6711 if we want information for no-font case), and return the display
6712 method symbol. By side-effect, update it->what and
6713 it->glyphless_method. This function is called from
6714 get_next_display_element for each character element, and from
6715 x_produce_glyphs when no suitable font was found. */
6718 lookup_glyphless_char_display (int c
, struct it
*it
)
6720 Lisp_Object glyphless_method
= Qnil
;
6722 if (CHAR_TABLE_P (Vglyphless_char_display
)
6723 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6727 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6728 if (CONSP (glyphless_method
))
6729 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6730 ? XCAR (glyphless_method
)
6731 : XCDR (glyphless_method
);
6734 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6738 if (NILP (glyphless_method
))
6741 /* The default is to display the character by a proper font. */
6743 /* The default for the no-font case is to display an empty box. */
6744 glyphless_method
= Qempty_box
;
6746 if (EQ (glyphless_method
, Qzero_width
))
6749 return glyphless_method
;
6750 /* This method can't be used for the no-font case. */
6751 glyphless_method
= Qempty_box
;
6753 if (EQ (glyphless_method
, Qthin_space
))
6754 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6755 else if (EQ (glyphless_method
, Qempty_box
))
6756 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6757 else if (EQ (glyphless_method
, Qhex_code
))
6758 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6759 else if (STRINGP (glyphless_method
))
6760 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6763 /* Invalid value. We use the default method. */
6764 glyphless_method
= Qnil
;
6767 it
->what
= IT_GLYPHLESS
;
6768 return glyphless_method
;
6771 /* Merge escape glyph face and cache the result. */
6773 static struct frame
*last_escape_glyph_frame
= NULL
;
6774 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6775 static int last_escape_glyph_merged_face_id
= 0;
6778 merge_escape_glyph_face (struct it
*it
)
6782 if (it
->f
== last_escape_glyph_frame
6783 && it
->face_id
== last_escape_glyph_face_id
)
6784 face_id
= last_escape_glyph_merged_face_id
;
6787 /* Merge the `escape-glyph' face into the current face. */
6788 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6789 last_escape_glyph_frame
= it
->f
;
6790 last_escape_glyph_face_id
= it
->face_id
;
6791 last_escape_glyph_merged_face_id
= face_id
;
6796 /* Likewise for glyphless glyph face. */
6798 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6799 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6800 static int last_glyphless_glyph_merged_face_id
= 0;
6803 merge_glyphless_glyph_face (struct it
*it
)
6807 if (it
->f
== last_glyphless_glyph_frame
6808 && it
->face_id
== last_glyphless_glyph_face_id
)
6809 face_id
= last_glyphless_glyph_merged_face_id
;
6812 /* Merge the `glyphless-char' face into the current face. */
6813 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6814 last_glyphless_glyph_frame
= it
->f
;
6815 last_glyphless_glyph_face_id
= it
->face_id
;
6816 last_glyphless_glyph_merged_face_id
= face_id
;
6821 /* Load IT's display element fields with information about the next
6822 display element from the current position of IT. Value is zero if
6823 end of buffer (or C string) is reached. */
6826 get_next_display_element (struct it
*it
)
6828 /* Non-zero means that we found a display element. Zero means that
6829 we hit the end of what we iterate over. Performance note: the
6830 function pointer `method' used here turns out to be faster than
6831 using a sequence of if-statements. */
6835 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6837 if (it
->what
== IT_CHARACTER
)
6839 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6840 and only if (a) the resolved directionality of that character
6842 /* FIXME: Do we need an exception for characters from display
6844 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6845 it
->c
= bidi_mirror_char (it
->c
);
6846 /* Map via display table or translate control characters.
6847 IT->c, IT->len etc. have been set to the next character by
6848 the function call above. If we have a display table, and it
6849 contains an entry for IT->c, translate it. Don't do this if
6850 IT->c itself comes from a display table, otherwise we could
6851 end up in an infinite recursion. (An alternative could be to
6852 count the recursion depth of this function and signal an
6853 error when a certain maximum depth is reached.) Is it worth
6855 if (success_p
&& it
->dpvec
== NULL
)
6858 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6859 int nonascii_space_p
= 0;
6860 int nonascii_hyphen_p
= 0;
6861 int c
= it
->c
; /* This is the character to display. */
6863 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6865 eassert (SINGLE_BYTE_CHAR_P (c
));
6866 if (unibyte_display_via_language_environment
)
6868 c
= DECODE_CHAR (unibyte
, c
);
6870 c
= BYTE8_TO_CHAR (it
->c
);
6873 c
= BYTE8_TO_CHAR (it
->c
);
6877 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6880 struct Lisp_Vector
*v
= XVECTOR (dv
);
6882 /* Return the first character from the display table
6883 entry, if not empty. If empty, don't display the
6884 current character. */
6887 it
->dpvec_char_len
= it
->len
;
6888 it
->dpvec
= v
->contents
;
6889 it
->dpend
= v
->contents
+ v
->header
.size
;
6890 it
->current
.dpvec_index
= 0;
6891 it
->dpvec_face_id
= -1;
6892 it
->saved_face_id
= it
->face_id
;
6893 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6898 set_iterator_to_next (it
, 0);
6903 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6905 if (it
->what
== IT_GLYPHLESS
)
6907 /* Don't display this character. */
6908 set_iterator_to_next (it
, 0);
6912 /* If `nobreak-char-display' is non-nil, we display
6913 non-ASCII spaces and hyphens specially. */
6914 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6917 nonascii_space_p
= true;
6918 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6919 nonascii_hyphen_p
= true;
6922 /* Translate control characters into `\003' or `^C' form.
6923 Control characters coming from a display table entry are
6924 currently not translated because we use IT->dpvec to hold
6925 the translation. This could easily be changed but I
6926 don't believe that it is worth doing.
6928 The characters handled by `nobreak-char-display' must be
6931 Non-printable characters and raw-byte characters are also
6932 translated to octal form. */
6933 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6934 ? (it
->area
!= TEXT_AREA
6935 /* In mode line, treat \n, \t like other crl chars. */
6938 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6939 || (c
!= '\n' && c
!= '\t'))
6941 || nonascii_hyphen_p
6943 || ! CHAR_PRINTABLE_P (c
))))
6945 /* C is a control character, non-ASCII space/hyphen,
6946 raw-byte, or a non-printable character which must be
6947 displayed either as '\003' or as `^C' where the '\\'
6948 and '^' can be defined in the display table. Fill
6949 IT->ctl_chars with glyphs for what we have to
6950 display. Then, set IT->dpvec to these glyphs. */
6957 /* Handle control characters with ^. */
6959 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6963 g
= '^'; /* default glyph for Control */
6964 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6966 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6968 g
= GLYPH_CODE_CHAR (gc
);
6969 lface_id
= GLYPH_CODE_FACE (gc
);
6973 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6974 : merge_escape_glyph_face (it
));
6976 XSETINT (it
->ctl_chars
[0], g
);
6977 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6979 goto display_control
;
6982 /* Handle non-ascii space in the mode where it only gets
6985 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6987 /* Merge `nobreak-space' into the current face. */
6988 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6990 XSETINT (it
->ctl_chars
[0], ' ');
6992 goto display_control
;
6995 /* Handle sequences that start with the "escape glyph". */
6997 /* the default escape glyph is \. */
6998 escape_glyph
= '\\';
7001 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7003 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7004 lface_id
= GLYPH_CODE_FACE (gc
);
7008 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7009 : merge_escape_glyph_face (it
));
7011 /* Draw non-ASCII hyphen with just highlighting: */
7013 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7015 XSETINT (it
->ctl_chars
[0], '-');
7017 goto display_control
;
7020 /* Draw non-ASCII space/hyphen with escape glyph: */
7022 if (nonascii_space_p
|| nonascii_hyphen_p
)
7024 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7025 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7027 goto display_control
;
7034 if (CHAR_BYTE8_P (c
))
7035 /* Display \200 instead of \17777600. */
7036 c
= CHAR_TO_BYTE8 (c
);
7037 len
= sprintf (str
, "%03o", c
);
7039 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7040 for (i
= 0; i
< len
; i
++)
7041 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7046 /* Set up IT->dpvec and return first character from it. */
7047 it
->dpvec_char_len
= it
->len
;
7048 it
->dpvec
= it
->ctl_chars
;
7049 it
->dpend
= it
->dpvec
+ ctl_len
;
7050 it
->current
.dpvec_index
= 0;
7051 it
->dpvec_face_id
= face_id
;
7052 it
->saved_face_id
= it
->face_id
;
7053 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7057 it
->char_to_display
= c
;
7061 it
->char_to_display
= it
->c
;
7065 #ifdef HAVE_WINDOW_SYSTEM
7066 /* Adjust face id for a multibyte character. There are no multibyte
7067 character in unibyte text. */
7068 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7071 && FRAME_WINDOW_P (it
->f
))
7073 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7075 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7077 /* Automatic composition with glyph-string. */
7078 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7080 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7084 ptrdiff_t pos
= (it
->s
? -1
7085 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7086 : IT_CHARPOS (*it
));
7089 if (it
->what
== IT_CHARACTER
)
7090 c
= it
->char_to_display
;
7093 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7097 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7098 /* TAB in a composition means display glyphs with
7099 padding space on the left or right. */
7100 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7103 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7106 #endif /* HAVE_WINDOW_SYSTEM */
7109 /* Is this character the last one of a run of characters with
7110 box? If yes, set IT->end_of_box_run_p to 1. */
7114 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7116 int face_id
= underlying_face_id (it
);
7117 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7121 if (face
->box
== FACE_NO_BOX
)
7123 /* If the box comes from face properties in a
7124 display string, check faces in that string. */
7125 int string_face_id
= face_after_it_pos (it
);
7126 it
->end_of_box_run_p
7127 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7130 /* Otherwise, the box comes from the underlying face.
7131 If this is the last string character displayed, check
7132 the next buffer location. */
7133 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7134 /* n_overlay_strings is unreliable unless
7135 overlay_string_index is non-negative. */
7136 && ((it
->current
.overlay_string_index
>= 0
7137 && (it
->current
.overlay_string_index
7138 == it
->n_overlay_strings
- 1))
7139 /* A string from display property. */
7140 || it
->from_disp_prop_p
))
7144 struct text_pos pos
= it
->current
.pos
;
7146 /* For a string from a display property, the next
7147 buffer position is stored in the 'position'
7148 member of the iteration stack slot below the
7149 current one, see handle_single_display_spec. By
7150 contrast, it->current.pos was is not yet updated
7151 to point to that buffer position; that will
7152 happen in pop_it, after we finish displaying the
7153 current string. Note that we already checked
7154 above that it->sp is positive, so subtracting one
7156 if (it
->from_disp_prop_p
)
7157 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7159 INC_TEXT_POS (pos
, it
->multibyte_p
);
7161 if (CHARPOS (pos
) >= ZV
)
7162 it
->end_of_box_run_p
= true;
7165 next_face_id
= face_at_buffer_position
7166 (it
->w
, CHARPOS (pos
), &ignore
,
7167 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7168 it
->end_of_box_run_p
7169 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7175 /* next_element_from_display_vector sets this flag according to
7176 faces of the display vector glyphs, see there. */
7177 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7179 int face_id
= face_after_it_pos (it
);
7180 it
->end_of_box_run_p
7181 = (face_id
!= it
->face_id
7182 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7185 /* If we reached the end of the object we've been iterating (e.g., a
7186 display string or an overlay string), and there's something on
7187 IT->stack, proceed with what's on the stack. It doesn't make
7188 sense to return zero if there's unprocessed stuff on the stack,
7189 because otherwise that stuff will never be displayed. */
7190 if (!success_p
&& it
->sp
> 0)
7192 set_iterator_to_next (it
, 0);
7193 success_p
= get_next_display_element (it
);
7196 /* Value is 0 if end of buffer or string reached. */
7201 /* Move IT to the next display element.
7203 RESEAT_P non-zero means if called on a newline in buffer text,
7204 skip to the next visible line start.
7206 Functions get_next_display_element and set_iterator_to_next are
7207 separate because I find this arrangement easier to handle than a
7208 get_next_display_element function that also increments IT's
7209 position. The way it is we can first look at an iterator's current
7210 display element, decide whether it fits on a line, and if it does,
7211 increment the iterator position. The other way around we probably
7212 would either need a flag indicating whether the iterator has to be
7213 incremented the next time, or we would have to implement a
7214 decrement position function which would not be easy to write. */
7217 set_iterator_to_next (struct it
*it
, int reseat_p
)
7219 /* Reset flags indicating start and end of a sequence of characters
7220 with box. Reset them at the start of this function because
7221 moving the iterator to a new position might set them. */
7222 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7226 case GET_FROM_BUFFER
:
7227 /* The current display element of IT is a character from
7228 current_buffer. Advance in the buffer, and maybe skip over
7229 invisible lines that are so because of selective display. */
7230 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7231 reseat_at_next_visible_line_start (it
, 0);
7232 else if (it
->cmp_it
.id
>= 0)
7234 /* We are currently getting glyphs from a composition. */
7239 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7240 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7241 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7243 it
->cmp_it
.from
= it
->cmp_it
.to
;
7248 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7250 it
->end_charpos
, Qnil
);
7253 else if (! it
->cmp_it
.reversed_p
)
7255 /* Composition created while scanning forward. */
7256 /* Update IT's char/byte positions to point to the first
7257 character of the next grapheme cluster, or to the
7258 character visually after the current composition. */
7259 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7260 bidi_move_to_visually_next (&it
->bidi_it
);
7261 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7262 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7264 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7266 /* Proceed to the next grapheme cluster. */
7267 it
->cmp_it
.from
= it
->cmp_it
.to
;
7271 /* No more grapheme clusters in this composition.
7272 Find the next stop position. */
7273 ptrdiff_t stop
= it
->end_charpos
;
7274 if (it
->bidi_it
.scan_dir
< 0)
7275 /* Now we are scanning backward and don't know
7278 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7279 IT_BYTEPOS (*it
), stop
, Qnil
);
7284 /* Composition created while scanning backward. */
7285 /* Update IT's char/byte positions to point to the last
7286 character of the previous grapheme cluster, or the
7287 character visually after the current composition. */
7288 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7289 bidi_move_to_visually_next (&it
->bidi_it
);
7290 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7291 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7292 if (it
->cmp_it
.from
> 0)
7294 /* Proceed to the previous grapheme cluster. */
7295 it
->cmp_it
.to
= it
->cmp_it
.from
;
7299 /* No more grapheme clusters in this composition.
7300 Find the next stop position. */
7301 ptrdiff_t stop
= it
->end_charpos
;
7302 if (it
->bidi_it
.scan_dir
< 0)
7303 /* Now we are scanning backward and don't know
7306 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7307 IT_BYTEPOS (*it
), stop
, Qnil
);
7313 eassert (it
->len
!= 0);
7317 IT_BYTEPOS (*it
) += it
->len
;
7318 IT_CHARPOS (*it
) += 1;
7322 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7323 /* If this is a new paragraph, determine its base
7324 direction (a.k.a. its base embedding level). */
7325 if (it
->bidi_it
.new_paragraph
)
7326 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7327 bidi_move_to_visually_next (&it
->bidi_it
);
7328 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7329 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7330 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7332 /* As the scan direction was changed, we must
7333 re-compute the stop position for composition. */
7334 ptrdiff_t stop
= it
->end_charpos
;
7335 if (it
->bidi_it
.scan_dir
< 0)
7337 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7338 IT_BYTEPOS (*it
), stop
, Qnil
);
7341 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7345 case GET_FROM_C_STRING
:
7346 /* Current display element of IT is from a C string. */
7348 /* If the string position is beyond string's end, it means
7349 next_element_from_c_string is padding the string with
7350 blanks, in which case we bypass the bidi iterator,
7351 because it cannot deal with such virtual characters. */
7352 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7354 IT_BYTEPOS (*it
) += it
->len
;
7355 IT_CHARPOS (*it
) += 1;
7359 bidi_move_to_visually_next (&it
->bidi_it
);
7360 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7361 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7365 case GET_FROM_DISPLAY_VECTOR
:
7366 /* Current display element of IT is from a display table entry.
7367 Advance in the display table definition. Reset it to null if
7368 end reached, and continue with characters from buffers/
7370 ++it
->current
.dpvec_index
;
7372 /* Restore face of the iterator to what they were before the
7373 display vector entry (these entries may contain faces). */
7374 it
->face_id
= it
->saved_face_id
;
7376 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7378 int recheck_faces
= it
->ellipsis_p
;
7381 it
->method
= GET_FROM_C_STRING
;
7382 else if (STRINGP (it
->string
))
7383 it
->method
= GET_FROM_STRING
;
7386 it
->method
= GET_FROM_BUFFER
;
7387 it
->object
= it
->w
->contents
;
7391 it
->current
.dpvec_index
= -1;
7393 /* Skip over characters which were displayed via IT->dpvec. */
7394 if (it
->dpvec_char_len
< 0)
7395 reseat_at_next_visible_line_start (it
, 1);
7396 else if (it
->dpvec_char_len
> 0)
7398 if (it
->method
== GET_FROM_STRING
7399 && it
->current
.overlay_string_index
>= 0
7400 && it
->n_overlay_strings
> 0)
7401 it
->ignore_overlay_strings_at_pos_p
= true;
7402 it
->len
= it
->dpvec_char_len
;
7403 set_iterator_to_next (it
, reseat_p
);
7406 /* Maybe recheck faces after display vector. */
7408 it
->stop_charpos
= IT_CHARPOS (*it
);
7412 case GET_FROM_STRING
:
7413 /* Current display element is a character from a Lisp string. */
7414 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7415 /* Don't advance past string end. These conditions are true
7416 when set_iterator_to_next is called at the end of
7417 get_next_display_element, in which case the Lisp string is
7418 already exhausted, and all we want is pop the iterator
7420 if (it
->current
.overlay_string_index
>= 0)
7422 /* This is an overlay string, so there's no padding with
7423 spaces, and the number of characters in the string is
7424 where the string ends. */
7425 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7426 goto consider_string_end
;
7430 /* Not an overlay string. There could be padding, so test
7431 against it->end_charpos. */
7432 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7433 goto consider_string_end
;
7435 if (it
->cmp_it
.id
>= 0)
7441 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7442 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7443 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7444 it
->cmp_it
.from
= it
->cmp_it
.to
;
7448 composition_compute_stop_pos (&it
->cmp_it
,
7449 IT_STRING_CHARPOS (*it
),
7450 IT_STRING_BYTEPOS (*it
),
7451 it
->end_charpos
, it
->string
);
7454 else if (! it
->cmp_it
.reversed_p
)
7456 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7457 bidi_move_to_visually_next (&it
->bidi_it
);
7458 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7459 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7461 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7462 it
->cmp_it
.from
= it
->cmp_it
.to
;
7465 ptrdiff_t stop
= it
->end_charpos
;
7466 if (it
->bidi_it
.scan_dir
< 0)
7468 composition_compute_stop_pos (&it
->cmp_it
,
7469 IT_STRING_CHARPOS (*it
),
7470 IT_STRING_BYTEPOS (*it
), stop
,
7476 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7477 bidi_move_to_visually_next (&it
->bidi_it
);
7478 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7479 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7480 if (it
->cmp_it
.from
> 0)
7481 it
->cmp_it
.to
= it
->cmp_it
.from
;
7484 ptrdiff_t stop
= it
->end_charpos
;
7485 if (it
->bidi_it
.scan_dir
< 0)
7487 composition_compute_stop_pos (&it
->cmp_it
,
7488 IT_STRING_CHARPOS (*it
),
7489 IT_STRING_BYTEPOS (*it
), stop
,
7497 /* If the string position is beyond string's end, it
7498 means next_element_from_string is padding the string
7499 with blanks, in which case we bypass the bidi
7500 iterator, because it cannot deal with such virtual
7502 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7504 IT_STRING_BYTEPOS (*it
) += it
->len
;
7505 IT_STRING_CHARPOS (*it
) += 1;
7509 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7511 bidi_move_to_visually_next (&it
->bidi_it
);
7512 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7513 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7514 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7516 ptrdiff_t stop
= it
->end_charpos
;
7518 if (it
->bidi_it
.scan_dir
< 0)
7520 composition_compute_stop_pos (&it
->cmp_it
,
7521 IT_STRING_CHARPOS (*it
),
7522 IT_STRING_BYTEPOS (*it
), stop
,
7528 consider_string_end
:
7530 if (it
->current
.overlay_string_index
>= 0)
7532 /* IT->string is an overlay string. Advance to the
7533 next, if there is one. */
7534 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7537 next_overlay_string (it
);
7539 setup_for_ellipsis (it
, 0);
7544 /* IT->string is not an overlay string. If we reached
7545 its end, and there is something on IT->stack, proceed
7546 with what is on the stack. This can be either another
7547 string, this time an overlay string, or a buffer. */
7548 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7552 if (it
->method
== GET_FROM_STRING
)
7553 goto consider_string_end
;
7558 case GET_FROM_IMAGE
:
7559 case GET_FROM_STRETCH
:
7560 /* The position etc with which we have to proceed are on
7561 the stack. The position may be at the end of a string,
7562 if the `display' property takes up the whole string. */
7563 eassert (it
->sp
> 0);
7565 if (it
->method
== GET_FROM_STRING
)
7566 goto consider_string_end
;
7570 /* There are no other methods defined, so this should be a bug. */
7574 eassert (it
->method
!= GET_FROM_STRING
7575 || (STRINGP (it
->string
)
7576 && IT_STRING_CHARPOS (*it
) >= 0));
7579 /* Load IT's display element fields with information about the next
7580 display element which comes from a display table entry or from the
7581 result of translating a control character to one of the forms `^C'
7584 IT->dpvec holds the glyphs to return as characters.
7585 IT->saved_face_id holds the face id before the display vector--it
7586 is restored into IT->face_id in set_iterator_to_next. */
7589 next_element_from_display_vector (struct it
*it
)
7592 int prev_face_id
= it
->face_id
;
7596 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7598 it
->face_id
= it
->saved_face_id
;
7600 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7601 That seemed totally bogus - so I changed it... */
7602 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7604 if (GLYPH_CODE_P (gc
))
7606 struct face
*this_face
, *prev_face
, *next_face
;
7608 it
->c
= GLYPH_CODE_CHAR (gc
);
7609 it
->len
= CHAR_BYTES (it
->c
);
7611 /* The entry may contain a face id to use. Such a face id is
7612 the id of a Lisp face, not a realized face. A face id of
7613 zero means no face is specified. */
7614 if (it
->dpvec_face_id
>= 0)
7615 it
->face_id
= it
->dpvec_face_id
;
7618 int lface_id
= GLYPH_CODE_FACE (gc
);
7620 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7624 /* Glyphs in the display vector could have the box face, so we
7625 need to set the related flags in the iterator, as
7627 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7628 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7630 /* Is this character the first character of a box-face run? */
7631 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7633 || prev_face
->box
== FACE_NO_BOX
));
7635 /* For the last character of the box-face run, we need to look
7636 either at the next glyph from the display vector, or at the
7637 face we saw before the display vector. */
7638 next_face_id
= it
->saved_face_id
;
7639 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7641 if (it
->dpvec_face_id
>= 0)
7642 next_face_id
= it
->dpvec_face_id
;
7646 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7649 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7653 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7654 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7656 || next_face
->box
== FACE_NO_BOX
));
7657 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7660 /* Display table entry is invalid. Return a space. */
7661 it
->c
= ' ', it
->len
= 1;
7663 /* Don't change position and object of the iterator here. They are
7664 still the values of the character that had this display table
7665 entry or was translated, and that's what we want. */
7666 it
->what
= IT_CHARACTER
;
7670 /* Get the first element of string/buffer in the visual order, after
7671 being reseated to a new position in a string or a buffer. */
7673 get_visually_first_element (struct it
*it
)
7675 int string_p
= STRINGP (it
->string
) || it
->s
;
7676 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7677 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7679 if (STRINGP (it
->string
))
7681 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7682 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7686 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7687 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7690 if (it
->bidi_it
.charpos
== eob
)
7692 /* Nothing to do, but reset the FIRST_ELT flag, like
7693 bidi_paragraph_init does, because we are not going to
7695 it
->bidi_it
.first_elt
= 0;
7697 else if (it
->bidi_it
.charpos
== bob
7699 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7700 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7702 /* If we are at the beginning of a line/string, we can produce
7703 the next element right away. */
7704 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7705 bidi_move_to_visually_next (&it
->bidi_it
);
7709 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7711 /* We need to prime the bidi iterator starting at the line's or
7712 string's beginning, before we will be able to produce the
7715 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7717 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7718 IT_BYTEPOS (*it
), -1,
7719 &it
->bidi_it
.bytepos
);
7720 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7723 /* Now return to buffer/string position where we were asked
7724 to get the next display element, and produce that. */
7725 bidi_move_to_visually_next (&it
->bidi_it
);
7727 while (it
->bidi_it
.bytepos
!= orig_bytepos
7728 && it
->bidi_it
.charpos
< eob
);
7731 /* Adjust IT's position information to where we ended up. */
7732 if (STRINGP (it
->string
))
7734 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7735 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7739 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7740 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7743 if (STRINGP (it
->string
) || !it
->s
)
7745 ptrdiff_t stop
, charpos
, bytepos
;
7747 if (STRINGP (it
->string
))
7750 stop
= SCHARS (it
->string
);
7751 if (stop
> it
->end_charpos
)
7752 stop
= it
->end_charpos
;
7753 charpos
= IT_STRING_CHARPOS (*it
);
7754 bytepos
= IT_STRING_BYTEPOS (*it
);
7758 stop
= it
->end_charpos
;
7759 charpos
= IT_CHARPOS (*it
);
7760 bytepos
= IT_BYTEPOS (*it
);
7762 if (it
->bidi_it
.scan_dir
< 0)
7764 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7769 /* Load IT with the next display element from Lisp string IT->string.
7770 IT->current.string_pos is the current position within the string.
7771 If IT->current.overlay_string_index >= 0, the Lisp string is an
7775 next_element_from_string (struct it
*it
)
7777 struct text_pos position
;
7779 eassert (STRINGP (it
->string
));
7780 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7781 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7782 position
= it
->current
.string_pos
;
7784 /* With bidi reordering, the character to display might not be the
7785 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7786 that we were reseat()ed to a new string, whose paragraph
7787 direction is not known. */
7788 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7790 get_visually_first_element (it
);
7791 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7794 /* Time to check for invisible text? */
7795 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7797 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7800 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7801 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7803 /* With bidi non-linear iteration, we could find
7804 ourselves far beyond the last computed stop_charpos,
7805 with several other stop positions in between that we
7806 missed. Scan them all now, in buffer's logical
7807 order, until we find and handle the last stop_charpos
7808 that precedes our current position. */
7809 handle_stop_backwards (it
, it
->stop_charpos
);
7810 return GET_NEXT_DISPLAY_ELEMENT (it
);
7816 /* Take note of the stop position we just moved
7817 across, for when we will move back across it. */
7818 it
->prev_stop
= it
->stop_charpos
;
7819 /* If we are at base paragraph embedding level, take
7820 note of the last stop position seen at this
7822 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7823 it
->base_level_stop
= it
->stop_charpos
;
7827 /* Since a handler may have changed IT->method, we must
7829 return GET_NEXT_DISPLAY_ELEMENT (it
);
7833 /* If we are before prev_stop, we may have overstepped
7834 on our way backwards a stop_pos, and if so, we need
7835 to handle that stop_pos. */
7836 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7837 /* We can sometimes back up for reasons that have nothing
7838 to do with bidi reordering. E.g., compositions. The
7839 code below is only needed when we are above the base
7840 embedding level, so test for that explicitly. */
7841 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7843 /* If we lost track of base_level_stop, we have no better
7844 place for handle_stop_backwards to start from than string
7845 beginning. This happens, e.g., when we were reseated to
7846 the previous screenful of text by vertical-motion. */
7847 if (it
->base_level_stop
<= 0
7848 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7849 it
->base_level_stop
= 0;
7850 handle_stop_backwards (it
, it
->base_level_stop
);
7851 return GET_NEXT_DISPLAY_ELEMENT (it
);
7855 if (it
->current
.overlay_string_index
>= 0)
7857 /* Get the next character from an overlay string. In overlay
7858 strings, there is no field width or padding with spaces to
7860 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7865 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7866 IT_STRING_BYTEPOS (*it
),
7867 it
->bidi_it
.scan_dir
< 0
7869 : SCHARS (it
->string
))
7870 && next_element_from_composition (it
))
7874 else if (STRING_MULTIBYTE (it
->string
))
7876 const unsigned char *s
= (SDATA (it
->string
)
7877 + IT_STRING_BYTEPOS (*it
));
7878 it
->c
= string_char_and_length (s
, &it
->len
);
7882 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7888 /* Get the next character from a Lisp string that is not an
7889 overlay string. Such strings come from the mode line, for
7890 example. We may have to pad with spaces, or truncate the
7891 string. See also next_element_from_c_string. */
7892 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7897 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7899 /* Pad with spaces. */
7900 it
->c
= ' ', it
->len
= 1;
7901 CHARPOS (position
) = BYTEPOS (position
) = -1;
7903 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7904 IT_STRING_BYTEPOS (*it
),
7905 it
->bidi_it
.scan_dir
< 0
7907 : it
->string_nchars
)
7908 && next_element_from_composition (it
))
7912 else if (STRING_MULTIBYTE (it
->string
))
7914 const unsigned char *s
= (SDATA (it
->string
)
7915 + IT_STRING_BYTEPOS (*it
));
7916 it
->c
= string_char_and_length (s
, &it
->len
);
7920 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7925 /* Record what we have and where it came from. */
7926 it
->what
= IT_CHARACTER
;
7927 it
->object
= it
->string
;
7928 it
->position
= position
;
7933 /* Load IT with next display element from C string IT->s.
7934 IT->string_nchars is the maximum number of characters to return
7935 from the string. IT->end_charpos may be greater than
7936 IT->string_nchars when this function is called, in which case we
7937 may have to return padding spaces. Value is zero if end of string
7938 reached, including padding spaces. */
7941 next_element_from_c_string (struct it
*it
)
7943 bool success_p
= true;
7946 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7947 it
->what
= IT_CHARACTER
;
7948 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7951 /* With bidi reordering, the character to display might not be the
7952 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7953 we were reseated to a new string, whose paragraph direction is
7955 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7956 get_visually_first_element (it
);
7958 /* IT's position can be greater than IT->string_nchars in case a
7959 field width or precision has been specified when the iterator was
7961 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7963 /* End of the game. */
7967 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7969 /* Pad with spaces. */
7970 it
->c
= ' ', it
->len
= 1;
7971 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7973 else if (it
->multibyte_p
)
7974 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7976 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7982 /* Set up IT to return characters from an ellipsis, if appropriate.
7983 The definition of the ellipsis glyphs may come from a display table
7984 entry. This function fills IT with the first glyph from the
7985 ellipsis if an ellipsis is to be displayed. */
7988 next_element_from_ellipsis (struct it
*it
)
7990 if (it
->selective_display_ellipsis_p
)
7991 setup_for_ellipsis (it
, it
->len
);
7994 /* The face at the current position may be different from the
7995 face we find after the invisible text. Remember what it
7996 was in IT->saved_face_id, and signal that it's there by
7997 setting face_before_selective_p. */
7998 it
->saved_face_id
= it
->face_id
;
7999 it
->method
= GET_FROM_BUFFER
;
8000 it
->object
= it
->w
->contents
;
8001 reseat_at_next_visible_line_start (it
, 1);
8002 it
->face_before_selective_p
= true;
8005 return GET_NEXT_DISPLAY_ELEMENT (it
);
8009 /* Deliver an image display element. The iterator IT is already
8010 filled with image information (done in handle_display_prop). Value
8015 next_element_from_image (struct it
*it
)
8017 it
->what
= IT_IMAGE
;
8018 it
->ignore_overlay_strings_at_pos_p
= 0;
8023 /* Fill iterator IT with next display element from a stretch glyph
8024 property. IT->object is the value of the text property. Value is
8028 next_element_from_stretch (struct it
*it
)
8030 it
->what
= IT_STRETCH
;
8034 /* Scan backwards from IT's current position until we find a stop
8035 position, or until BEGV. This is called when we find ourself
8036 before both the last known prev_stop and base_level_stop while
8037 reordering bidirectional text. */
8040 compute_stop_pos_backwards (struct it
*it
)
8042 const int SCAN_BACK_LIMIT
= 1000;
8043 struct text_pos pos
;
8044 struct display_pos save_current
= it
->current
;
8045 struct text_pos save_position
= it
->position
;
8046 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8047 ptrdiff_t where_we_are
= charpos
;
8048 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8049 ptrdiff_t save_end_pos
= it
->end_charpos
;
8051 eassert (NILP (it
->string
) && !it
->s
);
8052 eassert (it
->bidi_p
);
8056 it
->end_charpos
= min (charpos
+ 1, ZV
);
8057 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8058 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8059 reseat_1 (it
, pos
, 0);
8060 compute_stop_pos (it
);
8061 /* We must advance forward, right? */
8062 if (it
->stop_charpos
<= charpos
)
8065 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8067 if (it
->stop_charpos
<= where_we_are
)
8068 it
->prev_stop
= it
->stop_charpos
;
8070 it
->prev_stop
= BEGV
;
8072 it
->current
= save_current
;
8073 it
->position
= save_position
;
8074 it
->stop_charpos
= save_stop_pos
;
8075 it
->end_charpos
= save_end_pos
;
8078 /* Scan forward from CHARPOS in the current buffer/string, until we
8079 find a stop position > current IT's position. Then handle the stop
8080 position before that. This is called when we bump into a stop
8081 position while reordering bidirectional text. CHARPOS should be
8082 the last previously processed stop_pos (or BEGV/0, if none were
8083 processed yet) whose position is less that IT's current
8087 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8089 int bufp
= !STRINGP (it
->string
);
8090 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8091 struct display_pos save_current
= it
->current
;
8092 struct text_pos save_position
= it
->position
;
8093 struct text_pos pos1
;
8094 ptrdiff_t next_stop
;
8096 /* Scan in strict logical order. */
8097 eassert (it
->bidi_p
);
8101 it
->prev_stop
= charpos
;
8104 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8105 reseat_1 (it
, pos1
, 0);
8108 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8109 compute_stop_pos (it
);
8110 /* We must advance forward, right? */
8111 if (it
->stop_charpos
<= it
->prev_stop
)
8113 charpos
= it
->stop_charpos
;
8115 while (charpos
<= where_we_are
);
8118 it
->current
= save_current
;
8119 it
->position
= save_position
;
8120 next_stop
= it
->stop_charpos
;
8121 it
->stop_charpos
= it
->prev_stop
;
8123 it
->stop_charpos
= next_stop
;
8126 /* Load IT with the next display element from current_buffer. Value
8127 is zero if end of buffer reached. IT->stop_charpos is the next
8128 position at which to stop and check for text properties or buffer
8132 next_element_from_buffer (struct it
*it
)
8134 bool success_p
= true;
8136 eassert (IT_CHARPOS (*it
) >= BEGV
);
8137 eassert (NILP (it
->string
) && !it
->s
);
8138 eassert (!it
->bidi_p
8139 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8140 && it
->bidi_it
.string
.s
== NULL
));
8142 /* With bidi reordering, the character to display might not be the
8143 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8144 we were reseat()ed to a new buffer position, which is potentially
8145 a different paragraph. */
8146 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8148 get_visually_first_element (it
);
8149 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8152 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8154 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8156 int overlay_strings_follow_p
;
8158 /* End of the game, except when overlay strings follow that
8159 haven't been returned yet. */
8160 if (it
->overlay_strings_at_end_processed_p
)
8161 overlay_strings_follow_p
= 0;
8164 it
->overlay_strings_at_end_processed_p
= true;
8165 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8168 if (overlay_strings_follow_p
)
8169 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8173 it
->position
= it
->current
.pos
;
8177 else if (!(!it
->bidi_p
8178 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8179 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8181 /* With bidi non-linear iteration, we could find ourselves
8182 far beyond the last computed stop_charpos, with several
8183 other stop positions in between that we missed. Scan
8184 them all now, in buffer's logical order, until we find
8185 and handle the last stop_charpos that precedes our
8186 current position. */
8187 handle_stop_backwards (it
, it
->stop_charpos
);
8188 return GET_NEXT_DISPLAY_ELEMENT (it
);
8194 /* Take note of the stop position we just moved across,
8195 for when we will move back across it. */
8196 it
->prev_stop
= it
->stop_charpos
;
8197 /* If we are at base paragraph embedding level, take
8198 note of the last stop position seen at this
8200 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8201 it
->base_level_stop
= it
->stop_charpos
;
8204 return GET_NEXT_DISPLAY_ELEMENT (it
);
8208 /* If we are before prev_stop, we may have overstepped on
8209 our way backwards a stop_pos, and if so, we need to
8210 handle that stop_pos. */
8211 && IT_CHARPOS (*it
) < it
->prev_stop
8212 /* We can sometimes back up for reasons that have nothing
8213 to do with bidi reordering. E.g., compositions. The
8214 code below is only needed when we are above the base
8215 embedding level, so test for that explicitly. */
8216 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8218 if (it
->base_level_stop
<= 0
8219 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8221 /* If we lost track of base_level_stop, we need to find
8222 prev_stop by looking backwards. This happens, e.g., when
8223 we were reseated to the previous screenful of text by
8225 it
->base_level_stop
= BEGV
;
8226 compute_stop_pos_backwards (it
);
8227 handle_stop_backwards (it
, it
->prev_stop
);
8230 handle_stop_backwards (it
, it
->base_level_stop
);
8231 return GET_NEXT_DISPLAY_ELEMENT (it
);
8235 /* No face changes, overlays etc. in sight, so just return a
8236 character from current_buffer. */
8240 /* Maybe run the redisplay end trigger hook. Performance note:
8241 This doesn't seem to cost measurable time. */
8242 if (it
->redisplay_end_trigger_charpos
8244 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8245 run_redisplay_end_trigger_hook (it
);
8247 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8248 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8250 && next_element_from_composition (it
))
8255 /* Get the next character, maybe multibyte. */
8256 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8257 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8258 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8260 it
->c
= *p
, it
->len
= 1;
8262 /* Record what we have and where it came from. */
8263 it
->what
= IT_CHARACTER
;
8264 it
->object
= it
->w
->contents
;
8265 it
->position
= it
->current
.pos
;
8267 /* Normally we return the character found above, except when we
8268 really want to return an ellipsis for selective display. */
8273 /* A value of selective > 0 means hide lines indented more
8274 than that number of columns. */
8275 if (it
->selective
> 0
8276 && IT_CHARPOS (*it
) + 1 < ZV
8277 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8278 IT_BYTEPOS (*it
) + 1,
8281 success_p
= next_element_from_ellipsis (it
);
8282 it
->dpvec_char_len
= -1;
8285 else if (it
->c
== '\r' && it
->selective
== -1)
8287 /* A value of selective == -1 means that everything from the
8288 CR to the end of the line is invisible, with maybe an
8289 ellipsis displayed for it. */
8290 success_p
= next_element_from_ellipsis (it
);
8291 it
->dpvec_char_len
= -1;
8296 /* Value is zero if end of buffer reached. */
8297 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8302 /* Run the redisplay end trigger hook for IT. */
8305 run_redisplay_end_trigger_hook (struct it
*it
)
8307 Lisp_Object args
[3];
8309 /* IT->glyph_row should be non-null, i.e. we should be actually
8310 displaying something, or otherwise we should not run the hook. */
8311 eassert (it
->glyph_row
);
8313 /* Set up hook arguments. */
8314 args
[0] = Qredisplay_end_trigger_functions
;
8315 args
[1] = it
->window
;
8316 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8317 it
->redisplay_end_trigger_charpos
= 0;
8319 /* Since we are *trying* to run these functions, don't try to run
8320 them again, even if they get an error. */
8321 wset_redisplay_end_trigger (it
->w
, Qnil
);
8322 Frun_hook_with_args (3, args
);
8324 /* Notice if it changed the face of the character we are on. */
8325 handle_face_prop (it
);
8329 /* Deliver a composition display element. Unlike the other
8330 next_element_from_XXX, this function is not registered in the array
8331 get_next_element[]. It is called from next_element_from_buffer and
8332 next_element_from_string when necessary. */
8335 next_element_from_composition (struct it
*it
)
8337 it
->what
= IT_COMPOSITION
;
8338 it
->len
= it
->cmp_it
.nbytes
;
8339 if (STRINGP (it
->string
))
8343 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8344 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8347 it
->position
= it
->current
.string_pos
;
8348 it
->object
= it
->string
;
8349 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8350 IT_STRING_BYTEPOS (*it
), it
->string
);
8356 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8357 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8360 if (it
->bidi_it
.new_paragraph
)
8361 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8362 /* Resync the bidi iterator with IT's new position.
8363 FIXME: this doesn't support bidirectional text. */
8364 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8365 bidi_move_to_visually_next (&it
->bidi_it
);
8369 it
->position
= it
->current
.pos
;
8370 it
->object
= it
->w
->contents
;
8371 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8372 IT_BYTEPOS (*it
), Qnil
);
8379 /***********************************************************************
8380 Moving an iterator without producing glyphs
8381 ***********************************************************************/
8383 /* Check if iterator is at a position corresponding to a valid buffer
8384 position after some move_it_ call. */
8386 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8387 ((it)->method == GET_FROM_STRING \
8388 ? IT_STRING_CHARPOS (*it) == 0 \
8392 /* Move iterator IT to a specified buffer or X position within one
8393 line on the display without producing glyphs.
8395 OP should be a bit mask including some or all of these bits:
8396 MOVE_TO_X: Stop upon reaching x-position TO_X.
8397 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8398 Regardless of OP's value, stop upon reaching the end of the display line.
8400 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8401 This means, in particular, that TO_X includes window's horizontal
8404 The return value has several possible values that
8405 say what condition caused the scan to stop:
8407 MOVE_POS_MATCH_OR_ZV
8408 - when TO_POS or ZV was reached.
8411 -when TO_X was reached before TO_POS or ZV were reached.
8414 - when we reached the end of the display area and the line must
8418 - when we reached the end of the display area and the line is
8422 - when we stopped at a line end, i.e. a newline or a CR and selective
8425 static enum move_it_result
8426 move_it_in_display_line_to (struct it
*it
,
8427 ptrdiff_t to_charpos
, int to_x
,
8428 enum move_operation_enum op
)
8430 enum move_it_result result
= MOVE_UNDEFINED
;
8431 struct glyph_row
*saved_glyph_row
;
8432 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8433 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8434 void *ppos_data
= NULL
;
8436 enum it_method prev_method
= it
->method
;
8437 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8438 int saw_smaller_pos
= prev_pos
< to_charpos
;
8440 /* Don't produce glyphs in produce_glyphs. */
8441 saved_glyph_row
= it
->glyph_row
;
8442 it
->glyph_row
= NULL
;
8444 /* Use wrap_it to save a copy of IT wherever a word wrap could
8445 occur. Use atpos_it to save a copy of IT at the desired buffer
8446 position, if found, so that we can scan ahead and check if the
8447 word later overshoots the window edge. Use atx_it similarly, for
8453 /* Use ppos_it under bidi reordering to save a copy of IT for the
8454 initial position. We restore that position in IT when we have
8455 scanned the entire display line without finding a match for
8456 TO_CHARPOS and all the character positions are greater than
8457 TO_CHARPOS. We then restart the scan from the initial position,
8458 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8459 the closest to TO_CHARPOS. */
8462 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8464 SAVE_IT (ppos_it
, *it
, ppos_data
);
8465 closest_pos
= IT_CHARPOS (*it
);
8471 #define BUFFER_POS_REACHED_P() \
8472 ((op & MOVE_TO_POS) != 0 \
8473 && BUFFERP (it->object) \
8474 && (IT_CHARPOS (*it) == to_charpos \
8476 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8477 && IT_CHARPOS (*it) > to_charpos) \
8478 || (it->what == IT_COMPOSITION \
8479 && ((IT_CHARPOS (*it) > to_charpos \
8480 && to_charpos >= it->cmp_it.charpos) \
8481 || (IT_CHARPOS (*it) < to_charpos \
8482 && to_charpos <= it->cmp_it.charpos)))) \
8483 && (it->method == GET_FROM_BUFFER \
8484 || (it->method == GET_FROM_DISPLAY_VECTOR \
8485 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8487 /* If there's a line-/wrap-prefix, handle it. */
8488 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8489 && it
->current_y
< it
->last_visible_y
)
8490 handle_line_prefix (it
);
8492 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8493 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8497 int x
, i
, ascent
= 0, descent
= 0;
8499 /* Utility macro to reset an iterator with x, ascent, and descent. */
8500 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8501 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8502 (IT)->max_descent = descent)
8504 /* Stop if we move beyond TO_CHARPOS (after an image or a
8505 display string or stretch glyph). */
8506 if ((op
& MOVE_TO_POS
) != 0
8507 && BUFFERP (it
->object
)
8508 && it
->method
== GET_FROM_BUFFER
8510 /* When the iterator is at base embedding level, we
8511 are guaranteed that characters are delivered for
8512 display in strictly increasing order of their
8513 buffer positions. */
8514 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8515 && IT_CHARPOS (*it
) > to_charpos
)
8517 && (prev_method
== GET_FROM_IMAGE
8518 || prev_method
== GET_FROM_STRETCH
8519 || prev_method
== GET_FROM_STRING
)
8520 /* Passed TO_CHARPOS from left to right. */
8521 && ((prev_pos
< to_charpos
8522 && IT_CHARPOS (*it
) > to_charpos
)
8523 /* Passed TO_CHARPOS from right to left. */
8524 || (prev_pos
> to_charpos
8525 && IT_CHARPOS (*it
) < to_charpos
)))))
8527 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8529 result
= MOVE_POS_MATCH_OR_ZV
;
8532 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8533 /* If wrap_it is valid, the current position might be in a
8534 word that is wrapped. So, save the iterator in
8535 atpos_it and continue to see if wrapping happens. */
8536 SAVE_IT (atpos_it
, *it
, atpos_data
);
8539 /* Stop when ZV reached.
8540 We used to stop here when TO_CHARPOS reached as well, but that is
8541 too soon if this glyph does not fit on this line. So we handle it
8542 explicitly below. */
8543 if (!get_next_display_element (it
))
8545 result
= MOVE_POS_MATCH_OR_ZV
;
8549 if (it
->line_wrap
== TRUNCATE
)
8551 if (BUFFER_POS_REACHED_P ())
8553 result
= MOVE_POS_MATCH_OR_ZV
;
8559 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8561 if (IT_DISPLAYING_WHITESPACE (it
))
8565 /* We have reached a glyph that follows one or more
8566 whitespace characters. If the position is
8567 already found, we are done. */
8568 if (atpos_it
.sp
>= 0)
8570 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8571 result
= MOVE_POS_MATCH_OR_ZV
;
8576 RESTORE_IT (it
, &atx_it
, atx_data
);
8577 result
= MOVE_X_REACHED
;
8580 /* Otherwise, we can wrap here. */
8581 SAVE_IT (wrap_it
, *it
, wrap_data
);
8587 /* Remember the line height for the current line, in case
8588 the next element doesn't fit on the line. */
8589 ascent
= it
->max_ascent
;
8590 descent
= it
->max_descent
;
8592 /* The call to produce_glyphs will get the metrics of the
8593 display element IT is loaded with. Record the x-position
8594 before this display element, in case it doesn't fit on the
8598 PRODUCE_GLYPHS (it
);
8600 if (it
->area
!= TEXT_AREA
)
8602 prev_method
= it
->method
;
8603 if (it
->method
== GET_FROM_BUFFER
)
8604 prev_pos
= IT_CHARPOS (*it
);
8605 set_iterator_to_next (it
, 1);
8606 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8607 SET_TEXT_POS (this_line_min_pos
,
8608 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8610 && (op
& MOVE_TO_POS
)
8611 && IT_CHARPOS (*it
) > to_charpos
8612 && IT_CHARPOS (*it
) < closest_pos
)
8613 closest_pos
= IT_CHARPOS (*it
);
8617 /* The number of glyphs we get back in IT->nglyphs will normally
8618 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8619 character on a terminal frame, or (iii) a line end. For the
8620 second case, IT->nglyphs - 1 padding glyphs will be present.
8621 (On X frames, there is only one glyph produced for a
8622 composite character.)
8624 The behavior implemented below means, for continuation lines,
8625 that as many spaces of a TAB as fit on the current line are
8626 displayed there. For terminal frames, as many glyphs of a
8627 multi-glyph character are displayed in the current line, too.
8628 This is what the old redisplay code did, and we keep it that
8629 way. Under X, the whole shape of a complex character must
8630 fit on the line or it will be completely displayed in the
8633 Note that both for tabs and padding glyphs, all glyphs have
8637 /* More than one glyph or glyph doesn't fit on line. All
8638 glyphs have the same width. */
8639 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8641 int x_before_this_char
= x
;
8642 int hpos_before_this_char
= it
->hpos
;
8644 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8646 new_x
= x
+ single_glyph_width
;
8648 /* We want to leave anything reaching TO_X to the caller. */
8649 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8651 if (BUFFER_POS_REACHED_P ())
8653 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8654 goto buffer_pos_reached
;
8655 if (atpos_it
.sp
< 0)
8657 SAVE_IT (atpos_it
, *it
, atpos_data
);
8658 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8663 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8666 result
= MOVE_X_REACHED
;
8671 SAVE_IT (atx_it
, *it
, atx_data
);
8672 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8677 if (/* Lines are continued. */
8678 it
->line_wrap
!= TRUNCATE
8679 && (/* And glyph doesn't fit on the line. */
8680 new_x
> it
->last_visible_x
8681 /* Or it fits exactly and we're on a window
8683 || (new_x
== it
->last_visible_x
8684 && FRAME_WINDOW_P (it
->f
)
8685 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8686 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8687 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8689 if (/* IT->hpos == 0 means the very first glyph
8690 doesn't fit on the line, e.g. a wide image. */
8692 || (new_x
== it
->last_visible_x
8693 && FRAME_WINDOW_P (it
->f
)
8694 /* When word-wrap is ON and we have a valid
8695 wrap point, we don't allow the last glyph
8696 to "just barely fit" on the line. */
8697 && (it
->line_wrap
!= WORD_WRAP
8698 || wrap_it
.sp
< 0)))
8701 it
->current_x
= new_x
;
8703 /* The character's last glyph just barely fits
8705 if (i
== it
->nglyphs
- 1)
8707 /* If this is the destination position,
8708 return a position *before* it in this row,
8709 now that we know it fits in this row. */
8710 if (BUFFER_POS_REACHED_P ())
8712 if (it
->line_wrap
!= WORD_WRAP
8715 it
->hpos
= hpos_before_this_char
;
8716 it
->current_x
= x_before_this_char
;
8717 result
= MOVE_POS_MATCH_OR_ZV
;
8720 if (it
->line_wrap
== WORD_WRAP
8723 SAVE_IT (atpos_it
, *it
, atpos_data
);
8724 atpos_it
.current_x
= x_before_this_char
;
8725 atpos_it
.hpos
= hpos_before_this_char
;
8729 prev_method
= it
->method
;
8730 if (it
->method
== GET_FROM_BUFFER
)
8731 prev_pos
= IT_CHARPOS (*it
);
8732 set_iterator_to_next (it
, 1);
8733 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8734 SET_TEXT_POS (this_line_min_pos
,
8735 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8736 /* On graphical terminals, newlines may
8737 "overflow" into the fringe if
8738 overflow-newline-into-fringe is non-nil.
8739 On text terminals, and on graphical
8740 terminals with no right margin, newlines
8741 may overflow into the last glyph on the
8743 if (!FRAME_WINDOW_P (it
->f
)
8745 && it
->bidi_it
.paragraph_dir
== R2L
)
8746 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8747 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8748 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8750 if (!get_next_display_element (it
))
8752 result
= MOVE_POS_MATCH_OR_ZV
;
8755 if (BUFFER_POS_REACHED_P ())
8757 if (ITERATOR_AT_END_OF_LINE_P (it
))
8758 result
= MOVE_POS_MATCH_OR_ZV
;
8760 result
= MOVE_LINE_CONTINUED
;
8763 if (ITERATOR_AT_END_OF_LINE_P (it
)
8764 && (it
->line_wrap
!= WORD_WRAP
8767 result
= MOVE_NEWLINE_OR_CR
;
8774 IT_RESET_X_ASCENT_DESCENT (it
);
8776 if (wrap_it
.sp
>= 0)
8778 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8783 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8785 result
= MOVE_LINE_CONTINUED
;
8789 if (BUFFER_POS_REACHED_P ())
8791 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8792 goto buffer_pos_reached
;
8793 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8795 SAVE_IT (atpos_it
, *it
, atpos_data
);
8796 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8800 if (new_x
> it
->first_visible_x
)
8802 /* Glyph is visible. Increment number of glyphs that
8803 would be displayed. */
8808 if (result
!= MOVE_UNDEFINED
)
8811 else if (BUFFER_POS_REACHED_P ())
8814 IT_RESET_X_ASCENT_DESCENT (it
);
8815 result
= MOVE_POS_MATCH_OR_ZV
;
8818 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8820 /* Stop when TO_X specified and reached. This check is
8821 necessary here because of lines consisting of a line end,
8822 only. The line end will not produce any glyphs and we
8823 would never get MOVE_X_REACHED. */
8824 eassert (it
->nglyphs
== 0);
8825 result
= MOVE_X_REACHED
;
8829 /* Is this a line end? If yes, we're done. */
8830 if (ITERATOR_AT_END_OF_LINE_P (it
))
8832 /* If we are past TO_CHARPOS, but never saw any character
8833 positions smaller than TO_CHARPOS, return
8834 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8836 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8838 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8840 if (closest_pos
< ZV
)
8842 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8843 /* Don't recurse if closest_pos is equal to
8844 to_charpos, since we have just tried that. */
8845 if (closest_pos
!= to_charpos
)
8846 move_it_in_display_line_to (it
, closest_pos
, -1,
8848 result
= MOVE_POS_MATCH_OR_ZV
;
8851 goto buffer_pos_reached
;
8853 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8854 && IT_CHARPOS (*it
) > to_charpos
)
8855 goto buffer_pos_reached
;
8857 result
= MOVE_NEWLINE_OR_CR
;
8860 result
= MOVE_NEWLINE_OR_CR
;
8864 prev_method
= it
->method
;
8865 if (it
->method
== GET_FROM_BUFFER
)
8866 prev_pos
= IT_CHARPOS (*it
);
8867 /* The current display element has been consumed. Advance
8869 set_iterator_to_next (it
, 1);
8870 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8871 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8872 if (IT_CHARPOS (*it
) < to_charpos
)
8873 saw_smaller_pos
= 1;
8875 && (op
& MOVE_TO_POS
)
8876 && IT_CHARPOS (*it
) >= to_charpos
8877 && IT_CHARPOS (*it
) < closest_pos
)
8878 closest_pos
= IT_CHARPOS (*it
);
8880 /* Stop if lines are truncated and IT's current x-position is
8881 past the right edge of the window now. */
8882 if (it
->line_wrap
== TRUNCATE
8883 && it
->current_x
>= it
->last_visible_x
)
8885 if (!FRAME_WINDOW_P (it
->f
)
8886 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8887 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8888 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8889 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8893 if ((at_eob_p
= !get_next_display_element (it
))
8894 || BUFFER_POS_REACHED_P ()
8895 /* If we are past TO_CHARPOS, but never saw any
8896 character positions smaller than TO_CHARPOS,
8897 return MOVE_POS_MATCH_OR_ZV, like the
8898 unidirectional display did. */
8899 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8901 && IT_CHARPOS (*it
) > to_charpos
))
8904 && !BUFFER_POS_REACHED_P ()
8905 && !at_eob_p
&& closest_pos
< ZV
)
8907 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8908 if (closest_pos
!= to_charpos
)
8909 move_it_in_display_line_to (it
, closest_pos
, -1,
8912 result
= MOVE_POS_MATCH_OR_ZV
;
8915 if (ITERATOR_AT_END_OF_LINE_P (it
))
8917 result
= MOVE_NEWLINE_OR_CR
;
8921 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8923 && IT_CHARPOS (*it
) > to_charpos
)
8925 if (closest_pos
< ZV
)
8927 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8928 if (closest_pos
!= to_charpos
)
8929 move_it_in_display_line_to (it
, closest_pos
, -1,
8932 result
= MOVE_POS_MATCH_OR_ZV
;
8935 result
= MOVE_LINE_TRUNCATED
;
8938 #undef IT_RESET_X_ASCENT_DESCENT
8941 #undef BUFFER_POS_REACHED_P
8943 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8944 restore the saved iterator. */
8945 if (atpos_it
.sp
>= 0)
8946 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8947 else if (atx_it
.sp
>= 0)
8948 RESTORE_IT (it
, &atx_it
, atx_data
);
8953 bidi_unshelve_cache (atpos_data
, 1);
8955 bidi_unshelve_cache (atx_data
, 1);
8957 bidi_unshelve_cache (wrap_data
, 1);
8959 bidi_unshelve_cache (ppos_data
, 1);
8961 /* Restore the iterator settings altered at the beginning of this
8963 it
->glyph_row
= saved_glyph_row
;
8967 /* For external use. */
8969 move_it_in_display_line (struct it
*it
,
8970 ptrdiff_t to_charpos
, int to_x
,
8971 enum move_operation_enum op
)
8973 if (it
->line_wrap
== WORD_WRAP
8974 && (op
& MOVE_TO_X
))
8977 void *save_data
= NULL
;
8980 SAVE_IT (save_it
, *it
, save_data
);
8981 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8982 /* When word-wrap is on, TO_X may lie past the end
8983 of a wrapped line. Then it->current is the
8984 character on the next line, so backtrack to the
8985 space before the wrap point. */
8986 if (skip
== MOVE_LINE_CONTINUED
)
8988 int prev_x
= max (it
->current_x
- 1, 0);
8989 RESTORE_IT (it
, &save_it
, save_data
);
8990 move_it_in_display_line_to
8991 (it
, -1, prev_x
, MOVE_TO_X
);
8994 bidi_unshelve_cache (save_data
, 1);
8997 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9001 /* Move IT forward until it satisfies one or more of the criteria in
9002 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9004 OP is a bit-mask that specifies where to stop, and in particular,
9005 which of those four position arguments makes a difference. See the
9006 description of enum move_operation_enum.
9008 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9009 screen line, this function will set IT to the next position that is
9010 displayed to the right of TO_CHARPOS on the screen.
9012 Return the maximum pixel length of any line scanned but never more
9013 than it.last_visible_x. */
9016 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9018 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9019 int line_height
, line_start_x
= 0, reached
= 0;
9020 int max_current_x
= 0;
9021 void *backup_data
= NULL
;
9025 if (op
& MOVE_TO_VPOS
)
9027 /* If no TO_CHARPOS and no TO_X specified, stop at the
9028 start of the line TO_VPOS. */
9029 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9031 if (it
->vpos
== to_vpos
)
9037 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9041 /* TO_VPOS >= 0 means stop at TO_X in the line at
9042 TO_VPOS, or at TO_POS, whichever comes first. */
9043 if (it
->vpos
== to_vpos
)
9049 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9051 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9056 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9058 /* We have reached TO_X but not in the line we want. */
9059 skip
= move_it_in_display_line_to (it
, to_charpos
,
9061 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9069 else if (op
& MOVE_TO_Y
)
9071 struct it it_backup
;
9073 if (it
->line_wrap
== WORD_WRAP
)
9074 SAVE_IT (it_backup
, *it
, backup_data
);
9076 /* TO_Y specified means stop at TO_X in the line containing
9077 TO_Y---or at TO_CHARPOS if this is reached first. The
9078 problem is that we can't really tell whether the line
9079 contains TO_Y before we have completely scanned it, and
9080 this may skip past TO_X. What we do is to first scan to
9083 If TO_X is not specified, use a TO_X of zero. The reason
9084 is to make the outcome of this function more predictable.
9085 If we didn't use TO_X == 0, we would stop at the end of
9086 the line which is probably not what a caller would expect
9088 skip
= move_it_in_display_line_to
9089 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9090 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9092 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9093 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9095 else if (skip
== MOVE_X_REACHED
)
9097 /* If TO_X was reached, we want to know whether TO_Y is
9098 in the line. We know this is the case if the already
9099 scanned glyphs make the line tall enough. Otherwise,
9100 we must check by scanning the rest of the line. */
9101 line_height
= it
->max_ascent
+ it
->max_descent
;
9102 if (to_y
>= it
->current_y
9103 && to_y
< it
->current_y
+ line_height
)
9108 SAVE_IT (it_backup
, *it
, backup_data
);
9109 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9110 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9112 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9113 line_height
= it
->max_ascent
+ it
->max_descent
;
9114 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9116 if (to_y
>= it
->current_y
9117 && to_y
< it
->current_y
+ line_height
)
9119 /* If TO_Y is in this line and TO_X was reached
9120 above, we scanned too far. We have to restore
9121 IT's settings to the ones before skipping. But
9122 keep the more accurate values of max_ascent and
9123 max_descent we've found while skipping the rest
9124 of the line, for the sake of callers, such as
9125 pos_visible_p, that need to know the line
9127 int max_ascent
= it
->max_ascent
;
9128 int max_descent
= it
->max_descent
;
9130 RESTORE_IT (it
, &it_backup
, backup_data
);
9131 it
->max_ascent
= max_ascent
;
9132 it
->max_descent
= max_descent
;
9138 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9144 /* Check whether TO_Y is in this line. */
9145 line_height
= it
->max_ascent
+ it
->max_descent
;
9146 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9148 if (to_y
>= it
->current_y
9149 && to_y
< it
->current_y
+ line_height
)
9151 if (to_y
> it
->current_y
)
9152 max_current_x
= max (it
->current_x
, max_current_x
);
9154 /* When word-wrap is on, TO_X may lie past the end
9155 of a wrapped line. Then it->current is the
9156 character on the next line, so backtrack to the
9157 space before the wrap point. */
9158 if (skip
== MOVE_LINE_CONTINUED
9159 && it
->line_wrap
== WORD_WRAP
)
9161 int prev_x
= max (it
->current_x
- 1, 0);
9162 RESTORE_IT (it
, &it_backup
, backup_data
);
9163 skip
= move_it_in_display_line_to
9164 (it
, -1, prev_x
, MOVE_TO_X
);
9173 max_current_x
= max (it
->current_x
, max_current_x
);
9177 else if (BUFFERP (it
->object
)
9178 && (it
->method
== GET_FROM_BUFFER
9179 || it
->method
== GET_FROM_STRETCH
)
9180 && IT_CHARPOS (*it
) >= to_charpos
9181 /* Under bidi iteration, a call to set_iterator_to_next
9182 can scan far beyond to_charpos if the initial
9183 portion of the next line needs to be reordered. In
9184 that case, give move_it_in_display_line_to another
9187 && it
->bidi_it
.scan_dir
== -1))
9188 skip
= MOVE_POS_MATCH_OR_ZV
;
9190 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9194 case MOVE_POS_MATCH_OR_ZV
:
9195 max_current_x
= max (it
->current_x
, max_current_x
);
9199 case MOVE_NEWLINE_OR_CR
:
9200 max_current_x
= max (it
->current_x
, max_current_x
);
9201 set_iterator_to_next (it
, 1);
9202 it
->continuation_lines_width
= 0;
9205 case MOVE_LINE_TRUNCATED
:
9206 max_current_x
= it
->last_visible_x
;
9207 it
->continuation_lines_width
= 0;
9208 reseat_at_next_visible_line_start (it
, 0);
9209 if ((op
& MOVE_TO_POS
) != 0
9210 && IT_CHARPOS (*it
) > to_charpos
)
9217 case MOVE_LINE_CONTINUED
:
9218 max_current_x
= it
->last_visible_x
;
9219 /* For continued lines ending in a tab, some of the glyphs
9220 associated with the tab are displayed on the current
9221 line. Since it->current_x does not include these glyphs,
9222 we use it->last_visible_x instead. */
9225 it
->continuation_lines_width
+= it
->last_visible_x
;
9226 /* When moving by vpos, ensure that the iterator really
9227 advances to the next line (bug#847, bug#969). Fixme:
9228 do we need to do this in other circumstances? */
9229 if (it
->current_x
!= it
->last_visible_x
9230 && (op
& MOVE_TO_VPOS
)
9231 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9233 line_start_x
= it
->current_x
+ it
->pixel_width
9234 - it
->last_visible_x
;
9235 set_iterator_to_next (it
, 0);
9239 it
->continuation_lines_width
+= it
->current_x
;
9246 /* Reset/increment for the next run. */
9247 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9248 it
->current_x
= line_start_x
;
9251 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9253 last_height
= it
->max_ascent
+ it
->max_descent
;
9254 it
->max_ascent
= it
->max_descent
= 0;
9259 /* On text terminals, we may stop at the end of a line in the middle
9260 of a multi-character glyph. If the glyph itself is continued,
9261 i.e. it is actually displayed on the next line, don't treat this
9262 stopping point as valid; move to the next line instead (unless
9263 that brings us offscreen). */
9264 if (!FRAME_WINDOW_P (it
->f
)
9266 && IT_CHARPOS (*it
) == to_charpos
9267 && it
->what
== IT_CHARACTER
9269 && it
->line_wrap
== WINDOW_WRAP
9270 && it
->current_x
== it
->last_visible_x
- 1
9273 && it
->vpos
< it
->w
->window_end_vpos
)
9275 it
->continuation_lines_width
+= it
->current_x
;
9276 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9277 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9279 last_height
= it
->max_ascent
+ it
->max_descent
;
9283 bidi_unshelve_cache (backup_data
, 1);
9285 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9287 return max_current_x
;
9291 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9293 If DY > 0, move IT backward at least that many pixels. DY = 0
9294 means move IT backward to the preceding line start or BEGV. This
9295 function may move over more than DY pixels if IT->current_y - DY
9296 ends up in the middle of a line; in this case IT->current_y will be
9297 set to the top of the line moved to. */
9300 move_it_vertically_backward (struct it
*it
, int dy
)
9304 void *it2data
= NULL
, *it3data
= NULL
;
9305 ptrdiff_t start_pos
;
9307 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9308 ptrdiff_t pos_limit
;
9313 start_pos
= IT_CHARPOS (*it
);
9315 /* Estimate how many newlines we must move back. */
9316 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9317 if (it
->line_wrap
== TRUNCATE
)
9320 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9322 /* Set the iterator's position that many lines back. But don't go
9323 back more than NLINES full screen lines -- this wins a day with
9324 buffers which have very long lines. */
9325 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9326 back_to_previous_visible_line_start (it
);
9328 /* Reseat the iterator here. When moving backward, we don't want
9329 reseat to skip forward over invisible text, set up the iterator
9330 to deliver from overlay strings at the new position etc. So,
9331 use reseat_1 here. */
9332 reseat_1 (it
, it
->current
.pos
, 1);
9334 /* We are now surely at a line start. */
9335 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9336 reordering is in effect. */
9337 it
->continuation_lines_width
= 0;
9339 /* Move forward and see what y-distance we moved. First move to the
9340 start of the next line so that we get its height. We need this
9341 height to be able to tell whether we reached the specified
9343 SAVE_IT (it2
, *it
, it2data
);
9344 it2
.max_ascent
= it2
.max_descent
= 0;
9347 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9348 MOVE_TO_POS
| MOVE_TO_VPOS
);
9350 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9351 /* If we are in a display string which starts at START_POS,
9352 and that display string includes a newline, and we are
9353 right after that newline (i.e. at the beginning of a
9354 display line), exit the loop, because otherwise we will
9355 infloop, since move_it_to will see that it is already at
9356 START_POS and will not move. */
9357 || (it2
.method
== GET_FROM_STRING
9358 && IT_CHARPOS (it2
) == start_pos
9359 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9360 eassert (IT_CHARPOS (*it
) >= BEGV
);
9361 SAVE_IT (it3
, it2
, it3data
);
9363 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9364 eassert (IT_CHARPOS (*it
) >= BEGV
);
9365 /* H is the actual vertical distance from the position in *IT
9366 and the starting position. */
9367 h
= it2
.current_y
- it
->current_y
;
9368 /* NLINES is the distance in number of lines. */
9369 nlines
= it2
.vpos
- it
->vpos
;
9371 /* Correct IT's y and vpos position
9372 so that they are relative to the starting point. */
9378 /* DY == 0 means move to the start of the screen line. The
9379 value of nlines is > 0 if continuation lines were involved,
9380 or if the original IT position was at start of a line. */
9381 RESTORE_IT (it
, it
, it2data
);
9383 move_it_by_lines (it
, nlines
);
9384 /* The above code moves us to some position NLINES down,
9385 usually to its first glyph (leftmost in an L2R line), but
9386 that's not necessarily the start of the line, under bidi
9387 reordering. We want to get to the character position
9388 that is immediately after the newline of the previous
9391 && !it
->continuation_lines_width
9392 && !STRINGP (it
->string
)
9393 && IT_CHARPOS (*it
) > BEGV
9394 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9396 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9399 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9400 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9402 bidi_unshelve_cache (it3data
, 1);
9406 /* The y-position we try to reach, relative to *IT.
9407 Note that H has been subtracted in front of the if-statement. */
9408 int target_y
= it
->current_y
+ h
- dy
;
9409 int y0
= it3
.current_y
;
9413 RESTORE_IT (&it3
, &it3
, it3data
);
9414 y1
= line_bottom_y (&it3
);
9415 line_height
= y1
- y0
;
9416 RESTORE_IT (it
, it
, it2data
);
9417 /* If we did not reach target_y, try to move further backward if
9418 we can. If we moved too far backward, try to move forward. */
9419 if (target_y
< it
->current_y
9420 /* This is heuristic. In a window that's 3 lines high, with
9421 a line height of 13 pixels each, recentering with point
9422 on the bottom line will try to move -39/2 = 19 pixels
9423 backward. Try to avoid moving into the first line. */
9424 && (it
->current_y
- target_y
9425 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9426 && IT_CHARPOS (*it
) > BEGV
)
9428 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9429 target_y
- it
->current_y
));
9430 dy
= it
->current_y
- target_y
;
9431 goto move_further_back
;
9433 else if (target_y
>= it
->current_y
+ line_height
9434 && IT_CHARPOS (*it
) < ZV
)
9436 /* Should move forward by at least one line, maybe more.
9438 Note: Calling move_it_by_lines can be expensive on
9439 terminal frames, where compute_motion is used (via
9440 vmotion) to do the job, when there are very long lines
9441 and truncate-lines is nil. That's the reason for
9442 treating terminal frames specially here. */
9444 if (!FRAME_WINDOW_P (it
->f
))
9445 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9450 move_it_by_lines (it
, 1);
9452 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9459 /* Move IT by a specified amount of pixel lines DY. DY negative means
9460 move backwards. DY = 0 means move to start of screen line. At the
9461 end, IT will be on the start of a screen line. */
9464 move_it_vertically (struct it
*it
, int dy
)
9467 move_it_vertically_backward (it
, -dy
);
9470 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9471 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9472 MOVE_TO_POS
| MOVE_TO_Y
);
9473 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9475 /* If buffer ends in ZV without a newline, move to the start of
9476 the line to satisfy the post-condition. */
9477 if (IT_CHARPOS (*it
) == ZV
9479 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9480 move_it_by_lines (it
, 0);
9485 /* Move iterator IT past the end of the text line it is in. */
9488 move_it_past_eol (struct it
*it
)
9490 enum move_it_result rc
;
9492 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9493 if (rc
== MOVE_NEWLINE_OR_CR
)
9494 set_iterator_to_next (it
, 0);
9498 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9499 negative means move up. DVPOS == 0 means move to the start of the
9502 Optimization idea: If we would know that IT->f doesn't use
9503 a face with proportional font, we could be faster for
9504 truncate-lines nil. */
9507 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9510 /* The commented-out optimization uses vmotion on terminals. This
9511 gives bad results, because elements like it->what, on which
9512 callers such as pos_visible_p rely, aren't updated. */
9513 /* struct position pos;
9514 if (!FRAME_WINDOW_P (it->f))
9516 struct text_pos textpos;
9518 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9519 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9520 reseat (it, textpos, 1);
9521 it->vpos += pos.vpos;
9522 it->current_y += pos.vpos;
9528 /* DVPOS == 0 means move to the start of the screen line. */
9529 move_it_vertically_backward (it
, 0);
9530 /* Let next call to line_bottom_y calculate real line height. */
9535 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9536 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9538 /* Only move to the next buffer position if we ended up in a
9539 string from display property, not in an overlay string
9540 (before-string or after-string). That is because the
9541 latter don't conceal the underlying buffer position, so
9542 we can ask to move the iterator to the exact position we
9543 are interested in. Note that, even if we are already at
9544 IT_CHARPOS (*it), the call below is not a no-op, as it
9545 will detect that we are at the end of the string, pop the
9546 iterator, and compute it->current_x and it->hpos
9548 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9549 -1, -1, -1, MOVE_TO_POS
);
9555 void *it2data
= NULL
;
9556 ptrdiff_t start_charpos
, i
;
9558 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9559 bool hit_pos_limit
= false;
9560 ptrdiff_t pos_limit
;
9562 /* Start at the beginning of the screen line containing IT's
9563 position. This may actually move vertically backwards,
9564 in case of overlays, so adjust dvpos accordingly. */
9566 move_it_vertically_backward (it
, 0);
9569 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9570 screen lines, and reseat the iterator there. */
9571 start_charpos
= IT_CHARPOS (*it
);
9572 if (it
->line_wrap
== TRUNCATE
)
9575 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9577 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9578 back_to_previous_visible_line_start (it
);
9579 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9580 hit_pos_limit
= true;
9581 reseat (it
, it
->current
.pos
, 1);
9583 /* Move further back if we end up in a string or an image. */
9584 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9586 /* First try to move to start of display line. */
9588 move_it_vertically_backward (it
, 0);
9590 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9592 /* If start of line is still in string or image,
9593 move further back. */
9594 back_to_previous_visible_line_start (it
);
9595 reseat (it
, it
->current
.pos
, 1);
9599 it
->current_x
= it
->hpos
= 0;
9601 /* Above call may have moved too far if continuation lines
9602 are involved. Scan forward and see if it did. */
9603 SAVE_IT (it2
, *it
, it2data
);
9604 it2
.vpos
= it2
.current_y
= 0;
9605 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9606 it
->vpos
-= it2
.vpos
;
9607 it
->current_y
-= it2
.current_y
;
9608 it
->current_x
= it
->hpos
= 0;
9610 /* If we moved too far back, move IT some lines forward. */
9611 if (it2
.vpos
> -dvpos
)
9613 int delta
= it2
.vpos
+ dvpos
;
9615 RESTORE_IT (&it2
, &it2
, it2data
);
9616 SAVE_IT (it2
, *it
, it2data
);
9617 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9618 /* Move back again if we got too far ahead. */
9619 if (IT_CHARPOS (*it
) >= start_charpos
)
9620 RESTORE_IT (it
, &it2
, it2data
);
9622 bidi_unshelve_cache (it2data
, 1);
9624 else if (hit_pos_limit
&& pos_limit
> BEGV
9625 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9627 /* If we hit the limit, but still didn't make it far enough
9628 back, that means there's a display string with a newline
9629 covering a large chunk of text, and that caused
9630 back_to_previous_visible_line_start try to go too far.
9631 Punish those who commit such atrocities by going back
9632 until we've reached DVPOS, after lifting the limit, which
9633 could make it slow for very long lines. "If it hurts,
9636 RESTORE_IT (it
, it
, it2data
);
9637 for (i
= -dvpos
; i
> 0; --i
)
9639 back_to_previous_visible_line_start (it
);
9644 RESTORE_IT (it
, it
, it2data
);
9648 /* Return true if IT points into the middle of a display vector. */
9651 in_display_vector_p (struct it
*it
)
9653 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9654 && it
->current
.dpvec_index
> 0
9655 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9658 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9659 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9660 WINDOW must be a live window and defaults to the selected one. The
9661 return value is a cons of the maximum pixel-width of any text line and
9662 the maximum pixel-height of all text lines.
9664 The optional argument FROM, if non-nil, specifies the first text
9665 position and defaults to the minimum accessible position of the buffer.
9666 If FROM is t, use the minimum accessible position that is not a newline
9667 character. TO, if non-nil, specifies the last text position and
9668 defaults to the maximum accessible position of the buffer. If TO is t,
9669 use the maximum accessible position that is not a newline character.
9671 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9672 width that can be returned. X-LIMIT nil or omitted, means to use the
9673 pixel-width of WINDOW's body; use this if you do not intend to change
9674 the width of WINDOW. Use the maximum width WINDOW may assume if you
9675 intend to change WINDOW's width. In any case, text whose x-coordinate
9676 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9677 can take some time, it's always a good idea to make this argument as
9678 small as possible; in particular, if the buffer contains long lines that
9679 shall be truncated anyway.
9681 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9682 height that can be returned. Text lines whose y-coordinate is beyond
9683 Y-LIMIT are ignored. Since calculating the text height of a large
9684 buffer can take some time, it makes sense to specify this argument if
9685 the size of the buffer is unknown.
9687 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9688 include the height of the mode- or header-line of WINDOW in the return
9689 value. If it is either the symbol `mode-line' or `header-line', include
9690 only the height of that line, if present, in the return value. If t,
9691 include the height of both, if present, in the return value. */)
9692 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9693 Lisp_Object mode_and_header_line
)
9695 struct window
*w
= decode_live_window (window
);
9699 struct buffer
*old_buffer
= NULL
;
9700 ptrdiff_t start
, end
, pos
;
9701 struct text_pos startp
;
9702 void *itdata
= NULL
;
9703 int c
, max_y
= -1, x
= 0, y
= 0;
9709 if (b
!= current_buffer
)
9711 old_buffer
= current_buffer
;
9712 set_buffer_internal (b
);
9717 else if (EQ (from
, Qt
))
9720 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9721 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9723 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9728 CHECK_NUMBER_COERCE_MARKER (from
);
9729 start
= min (max (XINT (from
), BEGV
), ZV
);
9734 else if (EQ (to
, Qt
))
9737 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9738 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9740 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9745 CHECK_NUMBER_COERCE_MARKER (to
);
9746 end
= max (start
, min (XINT (to
), ZV
));
9749 if (!NILP (y_limit
))
9751 CHECK_NUMBER (y_limit
);
9752 max_y
= min (XINT (y_limit
), INT_MAX
);
9755 itdata
= bidi_shelve_cache ();
9756 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9757 start_display (&it
, w
, startp
);
9760 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9763 CHECK_NUMBER (x_limit
);
9764 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9765 /* Actually, we never want move_it_to stop at to_x. But to make
9766 sure that move_it_in_display_line_to always moves far enough,
9767 we set it to INT_MAX and specify MOVE_TO_X. */
9768 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9769 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9772 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9774 if (!EQ (mode_and_header_line
, Qheader_line
)
9775 && !EQ (mode_and_header_line
, Qt
))
9776 /* Do not count the header-line which was counted automatically by
9778 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9780 if (EQ (mode_and_header_line
, Qmode_line
)
9781 || EQ (mode_and_header_line
, Qt
))
9782 /* Do count the mode-line which is not included automatically by
9784 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9786 bidi_unshelve_cache (itdata
, 0);
9789 set_buffer_internal (old_buffer
);
9791 return Fcons (make_number (x
), make_number (y
));
9794 /***********************************************************************
9796 ***********************************************************************/
9799 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9803 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9805 Lisp_Object args
[3];
9806 Lisp_Object msg
, fmt
;
9809 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9813 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9815 args
[0] = fmt
= build_string (format
);
9818 msg
= Fformat (3, args
);
9820 len
= SBYTES (msg
) + 1;
9821 buffer
= SAFE_ALLOCA (len
);
9822 memcpy (buffer
, SDATA (msg
), len
);
9824 message_dolog (buffer
, len
- 1, 1, 0);
9831 /* Output a newline in the *Messages* buffer if "needs" one. */
9834 message_log_maybe_newline (void)
9836 if (message_log_need_newline
)
9837 message_dolog ("", 0, 1, 0);
9841 /* Add a string M of length NBYTES to the message log, optionally
9842 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9843 true, means interpret the contents of M as multibyte. This
9844 function calls low-level routines in order to bypass text property
9845 hooks, etc. which might not be safe to run.
9847 This may GC (insert may run before/after change hooks),
9848 so the buffer M must NOT point to a Lisp string. */
9851 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9853 const unsigned char *msg
= (const unsigned char *) m
;
9855 if (!NILP (Vmemory_full
))
9858 if (!NILP (Vmessage_log_max
))
9860 struct buffer
*oldbuf
;
9861 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9862 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9863 ptrdiff_t point_at_end
= 0;
9864 ptrdiff_t zv_at_end
= 0;
9865 Lisp_Object old_deactivate_mark
;
9866 struct gcpro gcpro1
;
9868 old_deactivate_mark
= Vdeactivate_mark
;
9869 oldbuf
= current_buffer
;
9871 /* Ensure the Messages buffer exists, and switch to it.
9872 If we created it, set the major-mode. */
9875 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9877 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9880 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9881 call0 (intern ("messages-buffer-mode"));
9884 bset_undo_list (current_buffer
, Qt
);
9885 bset_cache_long_scans (current_buffer
, Qnil
);
9887 oldpoint
= message_dolog_marker1
;
9888 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9889 oldbegv
= message_dolog_marker2
;
9890 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9891 oldzv
= message_dolog_marker3
;
9892 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9893 GCPRO1 (old_deactivate_mark
);
9901 BEGV_BYTE
= BEG_BYTE
;
9904 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9906 /* Insert the string--maybe converting multibyte to single byte
9907 or vice versa, so that all the text fits the buffer. */
9909 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9915 /* Convert a multibyte string to single-byte
9916 for the *Message* buffer. */
9917 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9919 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9920 work
[0] = (ASCII_CHAR_P (c
)
9922 : multibyte_char_to_unibyte (c
));
9923 insert_1_both (work
, 1, 1, 1, 0, 0);
9926 else if (! multibyte
9927 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9931 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9932 /* Convert a single-byte string to multibyte
9933 for the *Message* buffer. */
9934 for (i
= 0; i
< nbytes
; i
++)
9937 MAKE_CHAR_MULTIBYTE (c
);
9938 char_bytes
= CHAR_STRING (c
, str
);
9939 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9943 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9947 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9950 insert_1_both ("\n", 1, 1, 1, 0, 0);
9952 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9954 this_bol_byte
= PT_BYTE
;
9956 /* See if this line duplicates the previous one.
9957 If so, combine duplicates. */
9960 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9962 prev_bol_byte
= PT_BYTE
;
9964 dups
= message_log_check_duplicate (prev_bol_byte
,
9968 del_range_both (prev_bol
, prev_bol_byte
,
9969 this_bol
, this_bol_byte
, 0);
9972 char dupstr
[sizeof " [ times]"
9973 + INT_STRLEN_BOUND (printmax_t
)];
9975 /* If you change this format, don't forget to also
9976 change message_log_check_duplicate. */
9977 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9978 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9979 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
9984 /* If we have more than the desired maximum number of lines
9985 in the *Messages* buffer now, delete the oldest ones.
9986 This is safe because we don't have undo in this buffer. */
9988 if (NATNUMP (Vmessage_log_max
))
9990 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9991 -XFASTINT (Vmessage_log_max
) - 1, 0);
9992 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9995 BEGV
= marker_position (oldbegv
);
9996 BEGV_BYTE
= marker_byte_position (oldbegv
);
10005 ZV
= marker_position (oldzv
);
10006 ZV_BYTE
= marker_byte_position (oldzv
);
10010 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10012 /* We can't do Fgoto_char (oldpoint) because it will run some
10014 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10015 marker_byte_position (oldpoint
));
10018 unchain_marker (XMARKER (oldpoint
));
10019 unchain_marker (XMARKER (oldbegv
));
10020 unchain_marker (XMARKER (oldzv
));
10022 /* We called insert_1_both above with its 5th argument (PREPARE)
10023 zero, which prevents insert_1_both from calling
10024 prepare_to_modify_buffer, which in turns prevents us from
10025 incrementing windows_or_buffers_changed even if *Messages* is
10026 shown in some window. So we must manually set
10027 windows_or_buffers_changed here to make up for that. */
10028 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10029 bset_redisplay (current_buffer
);
10031 set_buffer_internal (oldbuf
);
10033 message_log_need_newline
= !nlflag
;
10034 Vdeactivate_mark
= old_deactivate_mark
;
10039 /* We are at the end of the buffer after just having inserted a newline.
10040 (Note: We depend on the fact we won't be crossing the gap.)
10041 Check to see if the most recent message looks a lot like the previous one.
10042 Return 0 if different, 1 if the new one should just replace it, or a
10043 value N > 1 if we should also append " [N times]". */
10046 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10049 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10051 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10052 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10054 for (i
= 0; i
< len
; i
++)
10056 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10058 if (p1
[i
] != p2
[i
])
10064 if (*p1
++ == ' ' && *p1
++ == '[')
10067 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10068 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10075 /* Display an echo area message M with a specified length of NBYTES
10076 bytes. The string may include null characters. If M is not a
10077 string, clear out any existing message, and let the mini-buffer
10080 This function cancels echoing. */
10083 message3 (Lisp_Object m
)
10085 struct gcpro gcpro1
;
10088 clear_message (true, true);
10091 /* First flush out any partial line written with print. */
10092 message_log_maybe_newline ();
10095 ptrdiff_t nbytes
= SBYTES (m
);
10096 bool multibyte
= STRING_MULTIBYTE (m
);
10098 char *buffer
= SAFE_ALLOCA (nbytes
);
10099 memcpy (buffer
, SDATA (m
), nbytes
);
10100 message_dolog (buffer
, nbytes
, 1, multibyte
);
10103 message3_nolog (m
);
10109 /* The non-logging version of message3.
10110 This does not cancel echoing, because it is used for echoing.
10111 Perhaps we need to make a separate function for echoing
10112 and make this cancel echoing. */
10115 message3_nolog (Lisp_Object m
)
10117 struct frame
*sf
= SELECTED_FRAME ();
10119 if (FRAME_INITIAL_P (sf
))
10121 if (noninteractive_need_newline
)
10122 putc ('\n', stderr
);
10123 noninteractive_need_newline
= 0;
10126 Lisp_Object s
= ENCODE_SYSTEM (m
);
10128 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10130 if (cursor_in_echo_area
== 0)
10131 fprintf (stderr
, "\n");
10134 /* Error messages get reported properly by cmd_error, so this must be just an
10135 informative message; if the frame hasn't really been initialized yet, just
10137 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10139 /* Get the frame containing the mini-buffer
10140 that the selected frame is using. */
10141 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10142 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10143 struct frame
*f
= XFRAME (frame
);
10145 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10146 Fmake_frame_visible (frame
);
10148 if (STRINGP (m
) && SCHARS (m
) > 0)
10151 if (minibuffer_auto_raise
)
10152 Fraise_frame (frame
);
10153 /* Assume we are not echoing.
10154 (If we are, echo_now will override this.) */
10155 echo_message_buffer
= Qnil
;
10158 clear_message (true, true);
10160 do_pending_window_change (0);
10161 echo_area_display (1);
10162 do_pending_window_change (0);
10163 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10164 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10169 /* Display a null-terminated echo area message M. If M is 0, clear
10170 out any existing message, and let the mini-buffer text show through.
10172 The buffer M must continue to exist until after the echo area gets
10173 cleared or some other message gets displayed there. Do not pass
10174 text that is stored in a Lisp string. Do not pass text in a buffer
10175 that was alloca'd. */
10178 message1 (const char *m
)
10180 message3 (m
? build_unibyte_string (m
) : Qnil
);
10184 /* The non-logging counterpart of message1. */
10187 message1_nolog (const char *m
)
10189 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10192 /* Display a message M which contains a single %s
10193 which gets replaced with STRING. */
10196 message_with_string (const char *m
, Lisp_Object string
, int log
)
10198 CHECK_STRING (string
);
10200 if (noninteractive
)
10204 /* ENCODE_SYSTEM below can GC and/or relocate the Lisp
10205 String whose data pointer might be passed to us in M. So
10206 we use a local copy. */
10207 char *fmt
= xstrdup (m
);
10209 if (noninteractive_need_newline
)
10210 putc ('\n', stderr
);
10211 noninteractive_need_newline
= 0;
10212 fprintf (stderr
, fmt
, SDATA (ENCODE_SYSTEM (string
)));
10213 if (!cursor_in_echo_area
)
10214 fprintf (stderr
, "\n");
10219 else if (INTERACTIVE
)
10221 /* The frame whose minibuffer we're going to display the message on.
10222 It may be larger than the selected frame, so we need
10223 to use its buffer, not the selected frame's buffer. */
10224 Lisp_Object mini_window
;
10225 struct frame
*f
, *sf
= SELECTED_FRAME ();
10227 /* Get the frame containing the minibuffer
10228 that the selected frame is using. */
10229 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10230 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10232 /* Error messages get reported properly by cmd_error, so this must be
10233 just an informative message; if the frame hasn't really been
10234 initialized yet, just toss it. */
10235 if (f
->glyphs_initialized_p
)
10237 Lisp_Object args
[2], msg
;
10238 struct gcpro gcpro1
, gcpro2
;
10240 args
[0] = build_string (m
);
10241 args
[1] = msg
= string
;
10242 GCPRO2 (args
[0], msg
);
10245 msg
= Fformat (2, args
);
10250 message3_nolog (msg
);
10254 /* Print should start at the beginning of the message
10255 buffer next time. */
10256 message_buf_print
= 0;
10262 /* Dump an informative message to the minibuf. If M is 0, clear out
10263 any existing message, and let the mini-buffer text show through. */
10266 vmessage (const char *m
, va_list ap
)
10268 if (noninteractive
)
10272 if (noninteractive_need_newline
)
10273 putc ('\n', stderr
);
10274 noninteractive_need_newline
= 0;
10275 vfprintf (stderr
, m
, ap
);
10276 if (cursor_in_echo_area
== 0)
10277 fprintf (stderr
, "\n");
10281 else if (INTERACTIVE
)
10283 /* The frame whose mini-buffer we're going to display the message
10284 on. It may be larger than the selected frame, so we need to
10285 use its buffer, not the selected frame's buffer. */
10286 Lisp_Object mini_window
;
10287 struct frame
*f
, *sf
= SELECTED_FRAME ();
10289 /* Get the frame containing the mini-buffer
10290 that the selected frame is using. */
10291 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10292 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10294 /* Error messages get reported properly by cmd_error, so this must be
10295 just an informative message; if the frame hasn't really been
10296 initialized yet, just toss it. */
10297 if (f
->glyphs_initialized_p
)
10302 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10303 char *message_buf
= alloca (maxsize
+ 1);
10305 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10307 message3 (make_string (message_buf
, len
));
10312 /* Print should start at the beginning of the message
10313 buffer next time. */
10314 message_buf_print
= 0;
10320 message (const char *m
, ...)
10330 /* The non-logging version of message. */
10333 message_nolog (const char *m
, ...)
10335 Lisp_Object old_log_max
;
10338 old_log_max
= Vmessage_log_max
;
10339 Vmessage_log_max
= Qnil
;
10341 Vmessage_log_max
= old_log_max
;
10347 /* Display the current message in the current mini-buffer. This is
10348 only called from error handlers in process.c, and is not time
10352 update_echo_area (void)
10354 if (!NILP (echo_area_buffer
[0]))
10356 Lisp_Object string
;
10357 string
= Fcurrent_message ();
10363 /* Make sure echo area buffers in `echo_buffers' are live.
10364 If they aren't, make new ones. */
10367 ensure_echo_area_buffers (void)
10371 for (i
= 0; i
< 2; ++i
)
10372 if (!BUFFERP (echo_buffer
[i
])
10373 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10376 Lisp_Object old_buffer
;
10379 old_buffer
= echo_buffer
[i
];
10380 echo_buffer
[i
] = Fget_buffer_create
10381 (make_formatted_string (name
, " *Echo Area %d*", i
));
10382 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10383 /* to force word wrap in echo area -
10384 it was decided to postpone this*/
10385 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10387 for (j
= 0; j
< 2; ++j
)
10388 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10389 echo_area_buffer
[j
] = echo_buffer
[i
];
10394 /* Call FN with args A1..A2 with either the current or last displayed
10395 echo_area_buffer as current buffer.
10397 WHICH zero means use the current message buffer
10398 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10399 from echo_buffer[] and clear it.
10401 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10402 suitable buffer from echo_buffer[] and clear it.
10404 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10405 that the current message becomes the last displayed one, make
10406 choose a suitable buffer for echo_area_buffer[0], and clear it.
10408 Value is what FN returns. */
10411 with_echo_area_buffer (struct window
*w
, int which
,
10412 int (*fn
) (ptrdiff_t, Lisp_Object
),
10413 ptrdiff_t a1
, Lisp_Object a2
)
10415 Lisp_Object buffer
;
10416 int this_one
, the_other
, clear_buffer_p
, rc
;
10417 ptrdiff_t count
= SPECPDL_INDEX ();
10419 /* If buffers aren't live, make new ones. */
10420 ensure_echo_area_buffers ();
10422 clear_buffer_p
= 0;
10425 this_one
= 0, the_other
= 1;
10426 else if (which
> 0)
10427 this_one
= 1, the_other
= 0;
10430 this_one
= 0, the_other
= 1;
10431 clear_buffer_p
= true;
10433 /* We need a fresh one in case the current echo buffer equals
10434 the one containing the last displayed echo area message. */
10435 if (!NILP (echo_area_buffer
[this_one
])
10436 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10437 echo_area_buffer
[this_one
] = Qnil
;
10440 /* Choose a suitable buffer from echo_buffer[] is we don't
10442 if (NILP (echo_area_buffer
[this_one
]))
10444 echo_area_buffer
[this_one
]
10445 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10446 ? echo_buffer
[the_other
]
10447 : echo_buffer
[this_one
]);
10448 clear_buffer_p
= true;
10451 buffer
= echo_area_buffer
[this_one
];
10453 /* Don't get confused by reusing the buffer used for echoing
10454 for a different purpose. */
10455 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10458 record_unwind_protect (unwind_with_echo_area_buffer
,
10459 with_echo_area_buffer_unwind_data (w
));
10461 /* Make the echo area buffer current. Note that for display
10462 purposes, it is not necessary that the displayed window's buffer
10463 == current_buffer, except for text property lookup. So, let's
10464 only set that buffer temporarily here without doing a full
10465 Fset_window_buffer. We must also change w->pointm, though,
10466 because otherwise an assertions in unshow_buffer fails, and Emacs
10468 set_buffer_internal_1 (XBUFFER (buffer
));
10471 wset_buffer (w
, buffer
);
10472 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10475 bset_undo_list (current_buffer
, Qt
);
10476 bset_read_only (current_buffer
, Qnil
);
10477 specbind (Qinhibit_read_only
, Qt
);
10478 specbind (Qinhibit_modification_hooks
, Qt
);
10480 if (clear_buffer_p
&& Z
> BEG
)
10481 del_range (BEG
, Z
);
10483 eassert (BEGV
>= BEG
);
10484 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10488 eassert (BEGV
>= BEG
);
10489 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10491 unbind_to (count
, Qnil
);
10496 /* Save state that should be preserved around the call to the function
10497 FN called in with_echo_area_buffer. */
10500 with_echo_area_buffer_unwind_data (struct window
*w
)
10503 Lisp_Object vector
, tmp
;
10505 /* Reduce consing by keeping one vector in
10506 Vwith_echo_area_save_vector. */
10507 vector
= Vwith_echo_area_save_vector
;
10508 Vwith_echo_area_save_vector
= Qnil
;
10511 vector
= Fmake_vector (make_number (9), Qnil
);
10513 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10514 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10515 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10519 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10520 ASET (vector
, i
, w
->contents
); ++i
;
10521 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10522 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10523 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10524 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10529 for (; i
< end
; ++i
)
10530 ASET (vector
, i
, Qnil
);
10533 eassert (i
== ASIZE (vector
));
10538 /* Restore global state from VECTOR which was created by
10539 with_echo_area_buffer_unwind_data. */
10542 unwind_with_echo_area_buffer (Lisp_Object vector
)
10544 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10545 Vdeactivate_mark
= AREF (vector
, 1);
10546 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10548 if (WINDOWP (AREF (vector
, 3)))
10551 Lisp_Object buffer
;
10553 w
= XWINDOW (AREF (vector
, 3));
10554 buffer
= AREF (vector
, 4);
10556 wset_buffer (w
, buffer
);
10557 set_marker_both (w
->pointm
, buffer
,
10558 XFASTINT (AREF (vector
, 5)),
10559 XFASTINT (AREF (vector
, 6)));
10560 set_marker_both (w
->start
, buffer
,
10561 XFASTINT (AREF (vector
, 7)),
10562 XFASTINT (AREF (vector
, 8)));
10565 Vwith_echo_area_save_vector
= vector
;
10569 /* Set up the echo area for use by print functions. MULTIBYTE_P
10570 non-zero means we will print multibyte. */
10573 setup_echo_area_for_printing (int multibyte_p
)
10575 /* If we can't find an echo area any more, exit. */
10576 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10577 Fkill_emacs (Qnil
);
10579 ensure_echo_area_buffers ();
10581 if (!message_buf_print
)
10583 /* A message has been output since the last time we printed.
10584 Choose a fresh echo area buffer. */
10585 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10586 echo_area_buffer
[0] = echo_buffer
[1];
10588 echo_area_buffer
[0] = echo_buffer
[0];
10590 /* Switch to that buffer and clear it. */
10591 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10592 bset_truncate_lines (current_buffer
, Qnil
);
10596 ptrdiff_t count
= SPECPDL_INDEX ();
10597 specbind (Qinhibit_read_only
, Qt
);
10598 /* Note that undo recording is always disabled. */
10599 del_range (BEG
, Z
);
10600 unbind_to (count
, Qnil
);
10602 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10604 /* Set up the buffer for the multibyteness we need. */
10606 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10607 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10609 /* Raise the frame containing the echo area. */
10610 if (minibuffer_auto_raise
)
10612 struct frame
*sf
= SELECTED_FRAME ();
10613 Lisp_Object mini_window
;
10614 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10615 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10618 message_log_maybe_newline ();
10619 message_buf_print
= 1;
10623 if (NILP (echo_area_buffer
[0]))
10625 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10626 echo_area_buffer
[0] = echo_buffer
[1];
10628 echo_area_buffer
[0] = echo_buffer
[0];
10631 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10633 /* Someone switched buffers between print requests. */
10634 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10635 bset_truncate_lines (current_buffer
, Qnil
);
10641 /* Display an echo area message in window W. Value is non-zero if W's
10642 height is changed. If display_last_displayed_message_p is
10643 non-zero, display the message that was last displayed, otherwise
10644 display the current message. */
10647 display_echo_area (struct window
*w
)
10649 int i
, no_message_p
, window_height_changed_p
;
10651 /* Temporarily disable garbage collections while displaying the echo
10652 area. This is done because a GC can print a message itself.
10653 That message would modify the echo area buffer's contents while a
10654 redisplay of the buffer is going on, and seriously confuse
10656 ptrdiff_t count
= inhibit_garbage_collection ();
10658 /* If there is no message, we must call display_echo_area_1
10659 nevertheless because it resizes the window. But we will have to
10660 reset the echo_area_buffer in question to nil at the end because
10661 with_echo_area_buffer will sets it to an empty buffer. */
10662 i
= display_last_displayed_message_p
? 1 : 0;
10663 no_message_p
= NILP (echo_area_buffer
[i
]);
10665 window_height_changed_p
10666 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10667 display_echo_area_1
,
10668 (intptr_t) w
, Qnil
);
10671 echo_area_buffer
[i
] = Qnil
;
10673 unbind_to (count
, Qnil
);
10674 return window_height_changed_p
;
10678 /* Helper for display_echo_area. Display the current buffer which
10679 contains the current echo area message in window W, a mini-window,
10680 a pointer to which is passed in A1. A2..A4 are currently not used.
10681 Change the height of W so that all of the message is displayed.
10682 Value is non-zero if height of W was changed. */
10685 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10688 struct window
*w
= (struct window
*) i1
;
10689 Lisp_Object window
;
10690 struct text_pos start
;
10691 int window_height_changed_p
= 0;
10693 /* Do this before displaying, so that we have a large enough glyph
10694 matrix for the display. If we can't get enough space for the
10695 whole text, display the last N lines. That works by setting w->start. */
10696 window_height_changed_p
= resize_mini_window (w
, 0);
10698 /* Use the starting position chosen by resize_mini_window. */
10699 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10702 clear_glyph_matrix (w
->desired_matrix
);
10703 XSETWINDOW (window
, w
);
10704 try_window (window
, start
, 0);
10706 return window_height_changed_p
;
10710 /* Resize the echo area window to exactly the size needed for the
10711 currently displayed message, if there is one. If a mini-buffer
10712 is active, don't shrink it. */
10715 resize_echo_area_exactly (void)
10717 if (BUFFERP (echo_area_buffer
[0])
10718 && WINDOWP (echo_area_window
))
10720 struct window
*w
= XWINDOW (echo_area_window
);
10721 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10722 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10723 (intptr_t) w
, resize_exactly
);
10726 windows_or_buffers_changed
= 42;
10727 update_mode_lines
= 30;
10728 redisplay_internal ();
10734 /* Callback function for with_echo_area_buffer, when used from
10735 resize_echo_area_exactly. A1 contains a pointer to the window to
10736 resize, EXACTLY non-nil means resize the mini-window exactly to the
10737 size of the text displayed. A3 and A4 are not used. Value is what
10738 resize_mini_window returns. */
10741 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10744 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10748 /* Resize mini-window W to fit the size of its contents. EXACT_P
10749 means size the window exactly to the size needed. Otherwise, it's
10750 only enlarged until W's buffer is empty.
10752 Set W->start to the right place to begin display. If the whole
10753 contents fit, start at the beginning. Otherwise, start so as
10754 to make the end of the contents appear. This is particularly
10755 important for y-or-n-p, but seems desirable generally.
10757 Value is non-zero if the window height has been changed. */
10760 resize_mini_window (struct window
*w
, int exact_p
)
10762 struct frame
*f
= XFRAME (w
->frame
);
10763 int window_height_changed_p
= 0;
10765 eassert (MINI_WINDOW_P (w
));
10767 /* By default, start display at the beginning. */
10768 set_marker_both (w
->start
, w
->contents
,
10769 BUF_BEGV (XBUFFER (w
->contents
)),
10770 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10772 /* Don't resize windows while redisplaying a window; it would
10773 confuse redisplay functions when the size of the window they are
10774 displaying changes from under them. Such a resizing can happen,
10775 for instance, when which-func prints a long message while
10776 we are running fontification-functions. We're running these
10777 functions with safe_call which binds inhibit-redisplay to t. */
10778 if (!NILP (Vinhibit_redisplay
))
10781 /* Nil means don't try to resize. */
10782 if (NILP (Vresize_mini_windows
)
10783 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10786 if (!FRAME_MINIBUF_ONLY_P (f
))
10789 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10790 + WINDOW_PIXEL_HEIGHT (w
));
10791 int unit
= FRAME_LINE_HEIGHT (f
);
10792 int height
, max_height
;
10793 struct text_pos start
;
10794 struct buffer
*old_current_buffer
= NULL
;
10796 if (current_buffer
!= XBUFFER (w
->contents
))
10798 old_current_buffer
= current_buffer
;
10799 set_buffer_internal (XBUFFER (w
->contents
));
10802 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10804 /* Compute the max. number of lines specified by the user. */
10805 if (FLOATP (Vmax_mini_window_height
))
10806 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10807 else if (INTEGERP (Vmax_mini_window_height
))
10808 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10810 max_height
= total_height
/ 4;
10812 /* Correct that max. height if it's bogus. */
10813 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10815 /* Find out the height of the text in the window. */
10816 if (it
.line_wrap
== TRUNCATE
)
10821 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10822 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10823 height
= it
.current_y
+ last_height
;
10825 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10826 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10829 /* Compute a suitable window start. */
10830 if (height
> max_height
)
10832 height
= (max_height
/ unit
) * unit
;
10833 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10834 move_it_vertically_backward (&it
, height
- unit
);
10835 start
= it
.current
.pos
;
10838 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10839 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10841 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10843 /* Let it grow only, until we display an empty message, in which
10844 case the window shrinks again. */
10845 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10847 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10849 FRAME_WINDOWS_FROZEN (f
) = 1;
10850 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10851 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10853 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10854 && (exact_p
|| BEGV
== ZV
))
10856 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10858 FRAME_WINDOWS_FROZEN (f
) = 0;
10859 shrink_mini_window (w
, 1);
10860 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10865 /* Always resize to exact size needed. */
10866 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10868 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10870 FRAME_WINDOWS_FROZEN (f
) = 1;
10871 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10872 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10874 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10876 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10878 FRAME_WINDOWS_FROZEN (f
) = 0;
10879 shrink_mini_window (w
, 1);
10883 FRAME_WINDOWS_FROZEN (f
) = 1;
10884 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10887 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10891 if (old_current_buffer
)
10892 set_buffer_internal (old_current_buffer
);
10895 return window_height_changed_p
;
10899 /* Value is the current message, a string, or nil if there is no
10900 current message. */
10903 current_message (void)
10907 if (!BUFFERP (echo_area_buffer
[0]))
10911 with_echo_area_buffer (0, 0, current_message_1
,
10912 (intptr_t) &msg
, Qnil
);
10914 echo_area_buffer
[0] = Qnil
;
10922 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10925 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10928 *msg
= make_buffer_string (BEG
, Z
, 1);
10935 /* Push the current message on Vmessage_stack for later restoration
10936 by restore_message. Value is non-zero if the current message isn't
10937 empty. This is a relatively infrequent operation, so it's not
10938 worth optimizing. */
10941 push_message (void)
10943 Lisp_Object msg
= current_message ();
10944 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10945 return STRINGP (msg
);
10949 /* Restore message display from the top of Vmessage_stack. */
10952 restore_message (void)
10954 eassert (CONSP (Vmessage_stack
));
10955 message3_nolog (XCAR (Vmessage_stack
));
10959 /* Handler for unwind-protect calling pop_message. */
10962 pop_message_unwind (void)
10964 /* Pop the top-most entry off Vmessage_stack. */
10965 eassert (CONSP (Vmessage_stack
));
10966 Vmessage_stack
= XCDR (Vmessage_stack
);
10970 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10971 exits. If the stack is not empty, we have a missing pop_message
10975 check_message_stack (void)
10977 if (!NILP (Vmessage_stack
))
10982 /* Truncate to NCHARS what will be displayed in the echo area the next
10983 time we display it---but don't redisplay it now. */
10986 truncate_echo_area (ptrdiff_t nchars
)
10989 echo_area_buffer
[0] = Qnil
;
10990 else if (!noninteractive
10992 && !NILP (echo_area_buffer
[0]))
10994 struct frame
*sf
= SELECTED_FRAME ();
10995 /* Error messages get reported properly by cmd_error, so this must be
10996 just an informative message; if the frame hasn't really been
10997 initialized yet, just toss it. */
10998 if (sf
->glyphs_initialized_p
)
10999 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11004 /* Helper function for truncate_echo_area. Truncate the current
11005 message to at most NCHARS characters. */
11008 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11010 if (BEG
+ nchars
< Z
)
11011 del_range (BEG
+ nchars
, Z
);
11013 echo_area_buffer
[0] = Qnil
;
11017 /* Set the current message to STRING. */
11020 set_message (Lisp_Object string
)
11022 eassert (STRINGP (string
));
11024 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11026 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11027 message_buf_print
= 0;
11028 help_echo_showing_p
= 0;
11030 if (STRINGP (Vdebug_on_message
)
11031 && STRINGP (string
)
11032 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11033 call_debugger (list2 (Qerror
, string
));
11037 /* Helper function for set_message. First argument is ignored and second
11038 argument has the same meaning as for set_message.
11039 This function is called with the echo area buffer being current. */
11042 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11044 eassert (STRINGP (string
));
11046 /* Change multibyteness of the echo buffer appropriately. */
11047 if (message_enable_multibyte
11048 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11049 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11051 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11052 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11053 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11055 /* Insert new message at BEG. */
11056 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11058 /* This function takes care of single/multibyte conversion.
11059 We just have to ensure that the echo area buffer has the right
11060 setting of enable_multibyte_characters. */
11061 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11067 /* Clear messages. CURRENT_P non-zero means clear the current
11068 message. LAST_DISPLAYED_P non-zero means clear the message
11072 clear_message (bool current_p
, bool last_displayed_p
)
11076 echo_area_buffer
[0] = Qnil
;
11077 message_cleared_p
= true;
11080 if (last_displayed_p
)
11081 echo_area_buffer
[1] = Qnil
;
11083 message_buf_print
= 0;
11086 /* Clear garbaged frames.
11088 This function is used where the old redisplay called
11089 redraw_garbaged_frames which in turn called redraw_frame which in
11090 turn called clear_frame. The call to clear_frame was a source of
11091 flickering. I believe a clear_frame is not necessary. It should
11092 suffice in the new redisplay to invalidate all current matrices,
11093 and ensure a complete redisplay of all windows. */
11096 clear_garbaged_frames (void)
11098 if (frame_garbaged
)
11100 Lisp_Object tail
, frame
;
11102 FOR_EACH_FRAME (tail
, frame
)
11104 struct frame
*f
= XFRAME (frame
);
11106 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11111 clear_current_matrices (f
);
11112 fset_redisplay (f
);
11113 f
->garbaged
= false;
11114 f
->resized_p
= false;
11118 frame_garbaged
= false;
11123 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11124 is non-zero update selected_frame. Value is non-zero if the
11125 mini-windows height has been changed. */
11128 echo_area_display (int update_frame_p
)
11130 Lisp_Object mini_window
;
11133 int window_height_changed_p
= 0;
11134 struct frame
*sf
= SELECTED_FRAME ();
11136 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11137 w
= XWINDOW (mini_window
);
11138 f
= XFRAME (WINDOW_FRAME (w
));
11140 /* Don't display if frame is invisible or not yet initialized. */
11141 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11144 #ifdef HAVE_WINDOW_SYSTEM
11145 /* When Emacs starts, selected_frame may be the initial terminal
11146 frame. If we let this through, a message would be displayed on
11148 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11150 #endif /* HAVE_WINDOW_SYSTEM */
11152 /* Redraw garbaged frames. */
11153 clear_garbaged_frames ();
11155 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11157 echo_area_window
= mini_window
;
11158 window_height_changed_p
= display_echo_area (w
);
11159 w
->must_be_updated_p
= true;
11161 /* Update the display, unless called from redisplay_internal.
11162 Also don't update the screen during redisplay itself. The
11163 update will happen at the end of redisplay, and an update
11164 here could cause confusion. */
11165 if (update_frame_p
&& !redisplaying_p
)
11169 /* If the display update has been interrupted by pending
11170 input, update mode lines in the frame. Due to the
11171 pending input, it might have been that redisplay hasn't
11172 been called, so that mode lines above the echo area are
11173 garbaged. This looks odd, so we prevent it here. */
11174 if (!display_completed
)
11175 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11177 if (window_height_changed_p
11178 /* Don't do this if Emacs is shutting down. Redisplay
11179 needs to run hooks. */
11180 && !NILP (Vrun_hooks
))
11182 /* Must update other windows. Likewise as in other
11183 cases, don't let this update be interrupted by
11185 ptrdiff_t count
= SPECPDL_INDEX ();
11186 specbind (Qredisplay_dont_pause
, Qt
);
11187 windows_or_buffers_changed
= 44;
11188 redisplay_internal ();
11189 unbind_to (count
, Qnil
);
11191 else if (FRAME_WINDOW_P (f
) && n
== 0)
11193 /* Window configuration is the same as before.
11194 Can do with a display update of the echo area,
11195 unless we displayed some mode lines. */
11196 update_single_window (w
, 1);
11200 update_frame (f
, 1, 1);
11202 /* If cursor is in the echo area, make sure that the next
11203 redisplay displays the minibuffer, so that the cursor will
11204 be replaced with what the minibuffer wants. */
11205 if (cursor_in_echo_area
)
11206 wset_redisplay (XWINDOW (mini_window
));
11209 else if (!EQ (mini_window
, selected_window
))
11210 wset_redisplay (XWINDOW (mini_window
));
11212 /* Last displayed message is now the current message. */
11213 echo_area_buffer
[1] = echo_area_buffer
[0];
11214 /* Inform read_char that we're not echoing. */
11215 echo_message_buffer
= Qnil
;
11217 /* Prevent redisplay optimization in redisplay_internal by resetting
11218 this_line_start_pos. This is done because the mini-buffer now
11219 displays the message instead of its buffer text. */
11220 if (EQ (mini_window
, selected_window
))
11221 CHARPOS (this_line_start_pos
) = 0;
11223 return window_height_changed_p
;
11226 /* Nonzero if W's buffer was changed but not saved. */
11229 window_buffer_changed (struct window
*w
)
11231 struct buffer
*b
= XBUFFER (w
->contents
);
11233 eassert (BUFFER_LIVE_P (b
));
11235 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11238 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11241 mode_line_update_needed (struct window
*w
)
11243 return (w
->column_number_displayed
!= -1
11244 && !(PT
== w
->last_point
&& !window_outdated (w
))
11245 && (w
->column_number_displayed
!= current_column ()));
11248 /* Nonzero if window start of W is frozen and may not be changed during
11252 window_frozen_p (struct window
*w
)
11254 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11256 Lisp_Object window
;
11258 XSETWINDOW (window
, w
);
11259 if (MINI_WINDOW_P (w
))
11261 else if (EQ (window
, selected_window
))
11263 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11264 && EQ (window
, Vminibuf_scroll_window
))
11265 /* This special window can't be frozen too. */
11273 /***********************************************************************
11274 Mode Lines and Frame Titles
11275 ***********************************************************************/
11277 /* A buffer for constructing non-propertized mode-line strings and
11278 frame titles in it; allocated from the heap in init_xdisp and
11279 resized as needed in store_mode_line_noprop_char. */
11281 static char *mode_line_noprop_buf
;
11283 /* The buffer's end, and a current output position in it. */
11285 static char *mode_line_noprop_buf_end
;
11286 static char *mode_line_noprop_ptr
;
11288 #define MODE_LINE_NOPROP_LEN(start) \
11289 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11292 MODE_LINE_DISPLAY
= 0,
11296 } mode_line_target
;
11298 /* Alist that caches the results of :propertize.
11299 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11300 static Lisp_Object mode_line_proptrans_alist
;
11302 /* List of strings making up the mode-line. */
11303 static Lisp_Object mode_line_string_list
;
11305 /* Base face property when building propertized mode line string. */
11306 static Lisp_Object mode_line_string_face
;
11307 static Lisp_Object mode_line_string_face_prop
;
11310 /* Unwind data for mode line strings */
11312 static Lisp_Object Vmode_line_unwind_vector
;
11315 format_mode_line_unwind_data (struct frame
*target_frame
,
11316 struct buffer
*obuf
,
11318 int save_proptrans
)
11320 Lisp_Object vector
, tmp
;
11322 /* Reduce consing by keeping one vector in
11323 Vwith_echo_area_save_vector. */
11324 vector
= Vmode_line_unwind_vector
;
11325 Vmode_line_unwind_vector
= Qnil
;
11328 vector
= Fmake_vector (make_number (10), Qnil
);
11330 ASET (vector
, 0, make_number (mode_line_target
));
11331 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11332 ASET (vector
, 2, mode_line_string_list
);
11333 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11334 ASET (vector
, 4, mode_line_string_face
);
11335 ASET (vector
, 5, mode_line_string_face_prop
);
11338 XSETBUFFER (tmp
, obuf
);
11341 ASET (vector
, 6, tmp
);
11342 ASET (vector
, 7, owin
);
11345 /* Similarly to `with-selected-window', if the operation selects
11346 a window on another frame, we must restore that frame's
11347 selected window, and (for a tty) the top-frame. */
11348 ASET (vector
, 8, target_frame
->selected_window
);
11349 if (FRAME_TERMCAP_P (target_frame
))
11350 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11357 unwind_format_mode_line (Lisp_Object vector
)
11359 Lisp_Object old_window
= AREF (vector
, 7);
11360 Lisp_Object target_frame_window
= AREF (vector
, 8);
11361 Lisp_Object old_top_frame
= AREF (vector
, 9);
11363 mode_line_target
= XINT (AREF (vector
, 0));
11364 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11365 mode_line_string_list
= AREF (vector
, 2);
11366 if (! EQ (AREF (vector
, 3), Qt
))
11367 mode_line_proptrans_alist
= AREF (vector
, 3);
11368 mode_line_string_face
= AREF (vector
, 4);
11369 mode_line_string_face_prop
= AREF (vector
, 5);
11371 /* Select window before buffer, since it may change the buffer. */
11372 if (!NILP (old_window
))
11374 /* If the operation that we are unwinding had selected a window
11375 on a different frame, reset its frame-selected-window. For a
11376 text terminal, reset its top-frame if necessary. */
11377 if (!NILP (target_frame_window
))
11380 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11382 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11383 Fselect_window (target_frame_window
, Qt
);
11385 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11386 Fselect_frame (old_top_frame
, Qt
);
11389 Fselect_window (old_window
, Qt
);
11392 if (!NILP (AREF (vector
, 6)))
11394 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11395 ASET (vector
, 6, Qnil
);
11398 Vmode_line_unwind_vector
= vector
;
11402 /* Store a single character C for the frame title in mode_line_noprop_buf.
11403 Re-allocate mode_line_noprop_buf if necessary. */
11406 store_mode_line_noprop_char (char c
)
11408 /* If output position has reached the end of the allocated buffer,
11409 increase the buffer's size. */
11410 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11412 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11413 ptrdiff_t size
= len
;
11414 mode_line_noprop_buf
=
11415 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11416 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11417 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11420 *mode_line_noprop_ptr
++ = c
;
11424 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11425 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11426 characters that yield more columns than PRECISION; PRECISION <= 0
11427 means copy the whole string. Pad with spaces until FIELD_WIDTH
11428 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11429 pad. Called from display_mode_element when it is used to build a
11433 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11435 const unsigned char *str
= (const unsigned char *) string
;
11437 ptrdiff_t dummy
, nbytes
;
11439 /* Copy at most PRECISION chars from STR. */
11440 nbytes
= strlen (string
);
11441 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11443 store_mode_line_noprop_char (*str
++);
11445 /* Fill up with spaces until FIELD_WIDTH reached. */
11446 while (field_width
> 0
11447 && n
< field_width
)
11449 store_mode_line_noprop_char (' ');
11456 /***********************************************************************
11458 ***********************************************************************/
11460 #ifdef HAVE_WINDOW_SYSTEM
11462 /* Set the title of FRAME, if it has changed. The title format is
11463 Vicon_title_format if FRAME is iconified, otherwise it is
11464 frame_title_format. */
11467 x_consider_frame_title (Lisp_Object frame
)
11469 struct frame
*f
= XFRAME (frame
);
11471 if (FRAME_WINDOW_P (f
)
11472 || FRAME_MINIBUF_ONLY_P (f
)
11473 || f
->explicit_name
)
11475 /* Do we have more than one visible frame on this X display? */
11476 Lisp_Object tail
, other_frame
, fmt
;
11477 ptrdiff_t title_start
;
11481 ptrdiff_t count
= SPECPDL_INDEX ();
11483 FOR_EACH_FRAME (tail
, other_frame
)
11485 struct frame
*tf
= XFRAME (other_frame
);
11488 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11489 && !FRAME_MINIBUF_ONLY_P (tf
)
11490 && !EQ (other_frame
, tip_frame
)
11491 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11495 /* Set global variable indicating that multiple frames exist. */
11496 multiple_frames
= CONSP (tail
);
11498 /* Switch to the buffer of selected window of the frame. Set up
11499 mode_line_target so that display_mode_element will output into
11500 mode_line_noprop_buf; then display the title. */
11501 record_unwind_protect (unwind_format_mode_line
,
11502 format_mode_line_unwind_data
11503 (f
, current_buffer
, selected_window
, 0));
11505 Fselect_window (f
->selected_window
, Qt
);
11506 set_buffer_internal_1
11507 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11508 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11510 mode_line_target
= MODE_LINE_TITLE
;
11511 title_start
= MODE_LINE_NOPROP_LEN (0);
11512 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11513 NULL
, DEFAULT_FACE_ID
);
11514 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11515 len
= MODE_LINE_NOPROP_LEN (title_start
);
11516 title
= mode_line_noprop_buf
+ title_start
;
11517 unbind_to (count
, Qnil
);
11519 /* Set the title only if it's changed. This avoids consing in
11520 the common case where it hasn't. (If it turns out that we've
11521 already wasted too much time by walking through the list with
11522 display_mode_element, then we might need to optimize at a
11523 higher level than this.) */
11524 if (! STRINGP (f
->name
)
11525 || SBYTES (f
->name
) != len
11526 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11527 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11531 #endif /* not HAVE_WINDOW_SYSTEM */
11534 /***********************************************************************
11536 ***********************************************************************/
11538 /* Non-zero if we will not redisplay all visible windows. */
11539 #define REDISPLAY_SOME_P() \
11540 ((windows_or_buffers_changed == 0 \
11541 || windows_or_buffers_changed == REDISPLAY_SOME) \
11542 && (update_mode_lines == 0 \
11543 || update_mode_lines == REDISPLAY_SOME))
11545 /* Prepare for redisplay by updating menu-bar item lists when
11546 appropriate. This can call eval. */
11549 prepare_menu_bars (void)
11551 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11552 bool some_windows
= REDISPLAY_SOME_P ();
11553 struct gcpro gcpro1
, gcpro2
;
11554 Lisp_Object tooltip_frame
;
11556 #ifdef HAVE_WINDOW_SYSTEM
11557 tooltip_frame
= tip_frame
;
11559 tooltip_frame
= Qnil
;
11562 if (FUNCTIONP (Vpre_redisplay_function
))
11564 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11565 if (all_windows
&& some_windows
)
11567 Lisp_Object ws
= window_list ();
11568 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11570 Lisp_Object
this = XCAR (ws
);
11571 struct window
*w
= XWINDOW (this);
11573 || XFRAME (w
->frame
)->redisplay
11574 || XBUFFER (w
->contents
)->text
->redisplay
)
11576 windows
= Fcons (this, windows
);
11580 safe__call1 (true, Vpre_redisplay_function
, windows
);
11583 /* Update all frame titles based on their buffer names, etc. We do
11584 this before the menu bars so that the buffer-menu will show the
11585 up-to-date frame titles. */
11586 #ifdef HAVE_WINDOW_SYSTEM
11589 Lisp_Object tail
, frame
;
11591 FOR_EACH_FRAME (tail
, frame
)
11593 struct frame
*f
= XFRAME (frame
);
11594 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11598 && !XBUFFER (w
->contents
)->text
->redisplay
)
11601 if (!EQ (frame
, tooltip_frame
)
11602 && (FRAME_ICONIFIED_P (f
)
11603 || FRAME_VISIBLE_P (f
) == 1
11604 /* Exclude TTY frames that are obscured because they
11605 are not the top frame on their console. This is
11606 because x_consider_frame_title actually switches
11607 to the frame, which for TTY frames means it is
11608 marked as garbaged, and will be completely
11609 redrawn on the next redisplay cycle. This causes
11610 TTY frames to be completely redrawn, when there
11611 are more than one of them, even though nothing
11612 should be changed on display. */
11613 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11614 x_consider_frame_title (frame
);
11617 #endif /* HAVE_WINDOW_SYSTEM */
11619 /* Update the menu bar item lists, if appropriate. This has to be
11620 done before any actual redisplay or generation of display lines. */
11624 Lisp_Object tail
, frame
;
11625 ptrdiff_t count
= SPECPDL_INDEX ();
11626 /* 1 means that update_menu_bar has run its hooks
11627 so any further calls to update_menu_bar shouldn't do so again. */
11628 int menu_bar_hooks_run
= 0;
11630 record_unwind_save_match_data ();
11632 FOR_EACH_FRAME (tail
, frame
)
11634 struct frame
*f
= XFRAME (frame
);
11635 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11637 /* Ignore tooltip frame. */
11638 if (EQ (frame
, tooltip_frame
))
11644 && !XBUFFER (w
->contents
)->text
->redisplay
)
11647 /* If a window on this frame changed size, report that to
11648 the user and clear the size-change flag. */
11649 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11651 Lisp_Object functions
;
11653 /* Clear flag first in case we get an error below. */
11654 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11655 functions
= Vwindow_size_change_functions
;
11656 GCPRO2 (tail
, functions
);
11658 while (CONSP (functions
))
11660 if (!EQ (XCAR (functions
), Qt
))
11661 call1 (XCAR (functions
), frame
);
11662 functions
= XCDR (functions
);
11668 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11669 #ifdef HAVE_WINDOW_SYSTEM
11670 update_tool_bar (f
, 0);
11673 if (windows_or_buffers_changed
11676 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11681 unbind_to (count
, Qnil
);
11685 struct frame
*sf
= SELECTED_FRAME ();
11686 update_menu_bar (sf
, 1, 0);
11687 #ifdef HAVE_WINDOW_SYSTEM
11688 update_tool_bar (sf
, 1);
11694 /* Update the menu bar item list for frame F. This has to be done
11695 before we start to fill in any display lines, because it can call
11698 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11700 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11701 already ran the menu bar hooks for this redisplay, so there
11702 is no need to run them again. The return value is the
11703 updated value of this flag, to pass to the next call. */
11706 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11708 Lisp_Object window
;
11709 register struct window
*w
;
11711 /* If called recursively during a menu update, do nothing. This can
11712 happen when, for instance, an activate-menubar-hook causes a
11714 if (inhibit_menubar_update
)
11717 window
= FRAME_SELECTED_WINDOW (f
);
11718 w
= XWINDOW (window
);
11720 if (FRAME_WINDOW_P (f
)
11722 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11723 || defined (HAVE_NS) || defined (USE_GTK)
11724 FRAME_EXTERNAL_MENU_BAR (f
)
11726 FRAME_MENU_BAR_LINES (f
) > 0
11728 : FRAME_MENU_BAR_LINES (f
) > 0)
11730 /* If the user has switched buffers or windows, we need to
11731 recompute to reflect the new bindings. But we'll
11732 recompute when update_mode_lines is set too; that means
11733 that people can use force-mode-line-update to request
11734 that the menu bar be recomputed. The adverse effect on
11735 the rest of the redisplay algorithm is about the same as
11736 windows_or_buffers_changed anyway. */
11737 if (windows_or_buffers_changed
11738 /* This used to test w->update_mode_line, but we believe
11739 there is no need to recompute the menu in that case. */
11740 || update_mode_lines
11741 || window_buffer_changed (w
))
11743 struct buffer
*prev
= current_buffer
;
11744 ptrdiff_t count
= SPECPDL_INDEX ();
11746 specbind (Qinhibit_menubar_update
, Qt
);
11748 set_buffer_internal_1 (XBUFFER (w
->contents
));
11749 if (save_match_data
)
11750 record_unwind_save_match_data ();
11751 if (NILP (Voverriding_local_map_menu_flag
))
11753 specbind (Qoverriding_terminal_local_map
, Qnil
);
11754 specbind (Qoverriding_local_map
, Qnil
);
11759 /* Run the Lucid hook. */
11760 safe_run_hooks (Qactivate_menubar_hook
);
11762 /* If it has changed current-menubar from previous value,
11763 really recompute the menu-bar from the value. */
11764 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11765 call0 (Qrecompute_lucid_menubar
);
11767 safe_run_hooks (Qmenu_bar_update_hook
);
11772 XSETFRAME (Vmenu_updating_frame
, f
);
11773 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11775 /* Redisplay the menu bar in case we changed it. */
11776 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11777 || defined (HAVE_NS) || defined (USE_GTK)
11778 if (FRAME_WINDOW_P (f
))
11780 #if defined (HAVE_NS)
11781 /* All frames on Mac OS share the same menubar. So only
11782 the selected frame should be allowed to set it. */
11783 if (f
== SELECTED_FRAME ())
11785 set_frame_menubar (f
, 0, 0);
11788 /* On a terminal screen, the menu bar is an ordinary screen
11789 line, and this makes it get updated. */
11790 w
->update_mode_line
= 1;
11791 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11792 /* In the non-toolkit version, the menu bar is an ordinary screen
11793 line, and this makes it get updated. */
11794 w
->update_mode_line
= 1;
11795 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11797 unbind_to (count
, Qnil
);
11798 set_buffer_internal_1 (prev
);
11805 /***********************************************************************
11807 ***********************************************************************/
11809 #ifdef HAVE_WINDOW_SYSTEM
11811 /* Tool-bar item index of the item on which a mouse button was pressed
11814 int last_tool_bar_item
;
11816 /* Select `frame' temporarily without running all the code in
11818 FIXME: Maybe do_switch_frame should be trimmed down similarly
11819 when `norecord' is set. */
11821 fast_set_selected_frame (Lisp_Object frame
)
11823 if (!EQ (selected_frame
, frame
))
11825 selected_frame
= frame
;
11826 selected_window
= XFRAME (frame
)->selected_window
;
11830 /* Update the tool-bar item list for frame F. This has to be done
11831 before we start to fill in any display lines. Called from
11832 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11833 and restore it here. */
11836 update_tool_bar (struct frame
*f
, int save_match_data
)
11838 #if defined (USE_GTK) || defined (HAVE_NS)
11839 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11841 int do_update
= (WINDOWP (f
->tool_bar_window
)
11842 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11847 Lisp_Object window
;
11850 window
= FRAME_SELECTED_WINDOW (f
);
11851 w
= XWINDOW (window
);
11853 /* If the user has switched buffers or windows, we need to
11854 recompute to reflect the new bindings. But we'll
11855 recompute when update_mode_lines is set too; that means
11856 that people can use force-mode-line-update to request
11857 that the menu bar be recomputed. The adverse effect on
11858 the rest of the redisplay algorithm is about the same as
11859 windows_or_buffers_changed anyway. */
11860 if (windows_or_buffers_changed
11861 || w
->update_mode_line
11862 || update_mode_lines
11863 || window_buffer_changed (w
))
11865 struct buffer
*prev
= current_buffer
;
11866 ptrdiff_t count
= SPECPDL_INDEX ();
11867 Lisp_Object frame
, new_tool_bar
;
11868 int new_n_tool_bar
;
11869 struct gcpro gcpro1
;
11871 /* Set current_buffer to the buffer of the selected
11872 window of the frame, so that we get the right local
11874 set_buffer_internal_1 (XBUFFER (w
->contents
));
11876 /* Save match data, if we must. */
11877 if (save_match_data
)
11878 record_unwind_save_match_data ();
11880 /* Make sure that we don't accidentally use bogus keymaps. */
11881 if (NILP (Voverriding_local_map_menu_flag
))
11883 specbind (Qoverriding_terminal_local_map
, Qnil
);
11884 specbind (Qoverriding_local_map
, Qnil
);
11887 GCPRO1 (new_tool_bar
);
11889 /* We must temporarily set the selected frame to this frame
11890 before calling tool_bar_items, because the calculation of
11891 the tool-bar keymap uses the selected frame (see
11892 `tool-bar-make-keymap' in tool-bar.el). */
11893 eassert (EQ (selected_window
,
11894 /* Since we only explicitly preserve selected_frame,
11895 check that selected_window would be redundant. */
11896 XFRAME (selected_frame
)->selected_window
));
11897 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11898 XSETFRAME (frame
, f
);
11899 fast_set_selected_frame (frame
);
11901 /* Build desired tool-bar items from keymaps. */
11903 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11906 /* Redisplay the tool-bar if we changed it. */
11907 if (new_n_tool_bar
!= f
->n_tool_bar_items
11908 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11910 /* Redisplay that happens asynchronously due to an expose event
11911 may access f->tool_bar_items. Make sure we update both
11912 variables within BLOCK_INPUT so no such event interrupts. */
11914 fset_tool_bar_items (f
, new_tool_bar
);
11915 f
->n_tool_bar_items
= new_n_tool_bar
;
11916 w
->update_mode_line
= 1;
11922 unbind_to (count
, Qnil
);
11923 set_buffer_internal_1 (prev
);
11928 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11930 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11931 F's desired tool-bar contents. F->tool_bar_items must have
11932 been set up previously by calling prepare_menu_bars. */
11935 build_desired_tool_bar_string (struct frame
*f
)
11937 int i
, size
, size_needed
;
11938 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11939 Lisp_Object image
, plist
, props
;
11941 image
= plist
= props
= Qnil
;
11942 GCPRO3 (image
, plist
, props
);
11944 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11945 Otherwise, make a new string. */
11947 /* The size of the string we might be able to reuse. */
11948 size
= (STRINGP (f
->desired_tool_bar_string
)
11949 ? SCHARS (f
->desired_tool_bar_string
)
11952 /* We need one space in the string for each image. */
11953 size_needed
= f
->n_tool_bar_items
;
11955 /* Reuse f->desired_tool_bar_string, if possible. */
11956 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11957 fset_desired_tool_bar_string
11958 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11961 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11962 Fremove_text_properties (make_number (0), make_number (size
),
11963 props
, f
->desired_tool_bar_string
);
11966 /* Put a `display' property on the string for the images to display,
11967 put a `menu_item' property on tool-bar items with a value that
11968 is the index of the item in F's tool-bar item vector. */
11969 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11971 #define PROP(IDX) \
11972 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11974 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11975 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11976 int hmargin
, vmargin
, relief
, idx
, end
;
11978 /* If image is a vector, choose the image according to the
11980 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11981 if (VECTORP (image
))
11985 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11986 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11989 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11990 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11992 eassert (ASIZE (image
) >= idx
);
11993 image
= AREF (image
, idx
);
11998 /* Ignore invalid image specifications. */
11999 if (!valid_image_p (image
))
12002 /* Display the tool-bar button pressed, or depressed. */
12003 plist
= Fcopy_sequence (XCDR (image
));
12005 /* Compute margin and relief to draw. */
12006 relief
= (tool_bar_button_relief
>= 0
12007 ? tool_bar_button_relief
12008 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12009 hmargin
= vmargin
= relief
;
12011 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12012 INT_MAX
- max (hmargin
, vmargin
)))
12014 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12015 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12017 else if (CONSP (Vtool_bar_button_margin
))
12019 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12020 INT_MAX
- hmargin
))
12021 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12023 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12024 INT_MAX
- vmargin
))
12025 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12028 if (auto_raise_tool_bar_buttons_p
)
12030 /* Add a `:relief' property to the image spec if the item is
12034 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12041 /* If image is selected, display it pressed, i.e. with a
12042 negative relief. If it's not selected, display it with a
12044 plist
= Fplist_put (plist
, QCrelief
,
12046 ? make_number (-relief
)
12047 : make_number (relief
)));
12052 /* Put a margin around the image. */
12053 if (hmargin
|| vmargin
)
12055 if (hmargin
== vmargin
)
12056 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12058 plist
= Fplist_put (plist
, QCmargin
,
12059 Fcons (make_number (hmargin
),
12060 make_number (vmargin
)));
12063 /* If button is not enabled, and we don't have special images
12064 for the disabled state, make the image appear disabled by
12065 applying an appropriate algorithm to it. */
12066 if (!enabled_p
&& idx
< 0)
12067 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12069 /* Put a `display' text property on the string for the image to
12070 display. Put a `menu-item' property on the string that gives
12071 the start of this item's properties in the tool-bar items
12073 image
= Fcons (Qimage
, plist
);
12074 props
= list4 (Qdisplay
, image
,
12075 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12077 /* Let the last image hide all remaining spaces in the tool bar
12078 string. The string can be longer than needed when we reuse a
12079 previous string. */
12080 if (i
+ 1 == f
->n_tool_bar_items
)
12081 end
= SCHARS (f
->desired_tool_bar_string
);
12084 Fadd_text_properties (make_number (i
), make_number (end
),
12085 props
, f
->desired_tool_bar_string
);
12093 /* Display one line of the tool-bar of frame IT->f.
12095 HEIGHT specifies the desired height of the tool-bar line.
12096 If the actual height of the glyph row is less than HEIGHT, the
12097 row's height is increased to HEIGHT, and the icons are centered
12098 vertically in the new height.
12100 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12101 count a final empty row in case the tool-bar width exactly matches
12106 display_tool_bar_line (struct it
*it
, int height
)
12108 struct glyph_row
*row
= it
->glyph_row
;
12109 int max_x
= it
->last_visible_x
;
12110 struct glyph
*last
;
12112 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12113 clear_glyph_row (row
);
12114 row
->enabled_p
= true;
12115 row
->y
= it
->current_y
;
12117 /* Note that this isn't made use of if the face hasn't a box,
12118 so there's no need to check the face here. */
12119 it
->start_of_box_run_p
= 1;
12121 while (it
->current_x
< max_x
)
12123 int x
, n_glyphs_before
, i
, nglyphs
;
12124 struct it it_before
;
12126 /* Get the next display element. */
12127 if (!get_next_display_element (it
))
12129 /* Don't count empty row if we are counting needed tool-bar lines. */
12130 if (height
< 0 && !it
->hpos
)
12135 /* Produce glyphs. */
12136 n_glyphs_before
= row
->used
[TEXT_AREA
];
12139 PRODUCE_GLYPHS (it
);
12141 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12143 x
= it_before
.current_x
;
12144 while (i
< nglyphs
)
12146 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12148 if (x
+ glyph
->pixel_width
> max_x
)
12150 /* Glyph doesn't fit on line. Backtrack. */
12151 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12153 /* If this is the only glyph on this line, it will never fit on the
12154 tool-bar, so skip it. But ensure there is at least one glyph,
12155 so we don't accidentally disable the tool-bar. */
12156 if (n_glyphs_before
== 0
12157 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12163 x
+= glyph
->pixel_width
;
12167 /* Stop at line end. */
12168 if (ITERATOR_AT_END_OF_LINE_P (it
))
12171 set_iterator_to_next (it
, 1);
12176 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12178 /* Use default face for the border below the tool bar.
12180 FIXME: When auto-resize-tool-bars is grow-only, there is
12181 no additional border below the possibly empty tool-bar lines.
12182 So to make the extra empty lines look "normal", we have to
12183 use the tool-bar face for the border too. */
12184 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12185 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12186 it
->face_id
= DEFAULT_FACE_ID
;
12188 extend_face_to_end_of_line (it
);
12189 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12190 last
->right_box_line_p
= 1;
12191 if (last
== row
->glyphs
[TEXT_AREA
])
12192 last
->left_box_line_p
= 1;
12194 /* Make line the desired height and center it vertically. */
12195 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12197 /* Don't add more than one line height. */
12198 height
%= FRAME_LINE_HEIGHT (it
->f
);
12199 it
->max_ascent
+= height
/ 2;
12200 it
->max_descent
+= (height
+ 1) / 2;
12203 compute_line_metrics (it
);
12205 /* If line is empty, make it occupy the rest of the tool-bar. */
12206 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12208 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12209 row
->visible_height
= row
->height
;
12210 row
->ascent
= row
->phys_ascent
= 0;
12211 row
->extra_line_spacing
= 0;
12214 row
->full_width_p
= 1;
12215 row
->continued_p
= 0;
12216 row
->truncated_on_left_p
= 0;
12217 row
->truncated_on_right_p
= 0;
12219 it
->current_x
= it
->hpos
= 0;
12220 it
->current_y
+= row
->height
;
12226 /* Max tool-bar height. Basically, this is what makes all other windows
12227 disappear when the frame gets too small. Rethink this! */
12229 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12230 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12232 /* Value is the number of pixels needed to make all tool-bar items of
12233 frame F visible. The actual number of glyph rows needed is
12234 returned in *N_ROWS if non-NULL. */
12237 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12239 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12241 /* tool_bar_height is called from redisplay_tool_bar after building
12242 the desired matrix, so use (unused) mode-line row as temporary row to
12243 avoid destroying the first tool-bar row. */
12244 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12246 /* Initialize an iterator for iteration over
12247 F->desired_tool_bar_string in the tool-bar window of frame F. */
12248 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12249 it
.first_visible_x
= 0;
12250 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12251 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12252 it
.paragraph_embedding
= L2R
;
12254 while (!ITERATOR_AT_END_P (&it
))
12256 clear_glyph_row (temp_row
);
12257 it
.glyph_row
= temp_row
;
12258 display_tool_bar_line (&it
, -1);
12260 clear_glyph_row (temp_row
);
12262 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12264 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12267 return it
.current_y
;
12269 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12272 #endif /* !USE_GTK && !HAVE_NS */
12274 #if defined USE_GTK || defined HAVE_NS
12275 EXFUN (Ftool_bar_height
, 2) ATTRIBUTE_CONST
;
12276 EXFUN (Ftool_bar_lines_needed
, 1) ATTRIBUTE_CONST
;
12279 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12281 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12282 If FRAME is nil or omitted, use the selected frame. Optional argument
12283 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12284 (Lisp_Object frame
, Lisp_Object pixelwise
)
12288 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12289 struct frame
*f
= decode_any_frame (frame
);
12291 if (WINDOWP (f
->tool_bar_window
)
12292 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12294 update_tool_bar (f
, 1);
12295 if (f
->n_tool_bar_items
)
12297 build_desired_tool_bar_string (f
);
12298 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12303 return make_number (height
);
12307 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12308 height should be changed. */
12311 redisplay_tool_bar (struct frame
*f
)
12313 #if defined (USE_GTK) || defined (HAVE_NS)
12315 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12316 update_frame_tool_bar (f
);
12319 #else /* !USE_GTK && !HAVE_NS */
12323 struct glyph_row
*row
;
12325 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12326 do anything. This means you must start with tool-bar-lines
12327 non-zero to get the auto-sizing effect. Or in other words, you
12328 can turn off tool-bars by specifying tool-bar-lines zero. */
12329 if (!WINDOWP (f
->tool_bar_window
)
12330 || (w
= XWINDOW (f
->tool_bar_window
),
12331 WINDOW_PIXEL_HEIGHT (w
) == 0))
12334 /* Set up an iterator for the tool-bar window. */
12335 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12336 it
.first_visible_x
= 0;
12337 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12338 row
= it
.glyph_row
;
12340 /* Build a string that represents the contents of the tool-bar. */
12341 build_desired_tool_bar_string (f
);
12342 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12343 /* FIXME: This should be controlled by a user option. But it
12344 doesn't make sense to have an R2L tool bar if the menu bar cannot
12345 be drawn also R2L, and making the menu bar R2L is tricky due
12346 toolkit-specific code that implements it. If an R2L tool bar is
12347 ever supported, display_tool_bar_line should also be augmented to
12348 call unproduce_glyphs like display_line and display_string
12350 it
.paragraph_embedding
= L2R
;
12352 if (f
->n_tool_bar_rows
== 0)
12354 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12356 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12359 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12360 / FRAME_LINE_HEIGHT (f
));
12362 XSETFRAME (frame
, f
);
12363 Fmodify_frame_parameters (frame
,
12364 list1 (Fcons (Qtool_bar_lines
,
12365 make_number (new_lines
))));
12366 /* Always do that now. */
12367 clear_glyph_matrix (w
->desired_matrix
);
12368 f
->fonts_changed
= 1;
12373 /* Display as many lines as needed to display all tool-bar items. */
12375 if (f
->n_tool_bar_rows
> 0)
12377 int border
, rows
, height
, extra
;
12379 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12380 border
= XINT (Vtool_bar_border
);
12381 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12382 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12383 else if (EQ (Vtool_bar_border
, Qborder_width
))
12384 border
= f
->border_width
;
12390 rows
= f
->n_tool_bar_rows
;
12391 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12392 extra
= it
.last_visible_y
- border
- height
* rows
;
12394 while (it
.current_y
< it
.last_visible_y
)
12397 if (extra
> 0 && rows
-- > 0)
12399 h
= (extra
+ rows
- 1) / rows
;
12402 display_tool_bar_line (&it
, height
+ h
);
12407 while (it
.current_y
< it
.last_visible_y
)
12408 display_tool_bar_line (&it
, 0);
12411 /* It doesn't make much sense to try scrolling in the tool-bar
12412 window, so don't do it. */
12413 w
->desired_matrix
->no_scrolling_p
= 1;
12414 w
->must_be_updated_p
= 1;
12416 if (!NILP (Vauto_resize_tool_bars
))
12418 /* Do we really allow the toolbar to occupy the whole frame? */
12419 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12420 int change_height_p
= 0;
12422 /* If we couldn't display everything, change the tool-bar's
12423 height if there is room for more. */
12424 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12425 && it
.current_y
< max_tool_bar_height
)
12426 change_height_p
= 1;
12428 /* We subtract 1 because display_tool_bar_line advances the
12429 glyph_row pointer before returning to its caller. We want to
12430 examine the last glyph row produced by
12431 display_tool_bar_line. */
12432 row
= it
.glyph_row
- 1;
12434 /* If there are blank lines at the end, except for a partially
12435 visible blank line at the end that is smaller than
12436 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12437 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12438 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12439 change_height_p
= 1;
12441 /* If row displays tool-bar items, but is partially visible,
12442 change the tool-bar's height. */
12443 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12444 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12445 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12446 change_height_p
= 1;
12448 /* Resize windows as needed by changing the `tool-bar-lines'
12449 frame parameter. */
12450 if (change_height_p
)
12454 int new_height
= tool_bar_height (f
, &nrows
, 1);
12456 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12457 && !f
->minimize_tool_bar_window_p
)
12458 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12459 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12460 f
->minimize_tool_bar_window_p
= 0;
12462 if (change_height_p
)
12464 /* Current size of the tool-bar window in canonical line
12466 int old_lines
= WINDOW_TOTAL_LINES (w
);
12467 /* Required size of the tool-bar window in canonical
12469 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12470 / FRAME_LINE_HEIGHT (f
));
12471 /* Maximum size of the tool-bar window in canonical line
12472 units that this frame can allow. */
12474 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12476 /* Don't try to change the tool-bar window size and set
12477 the fonts_changed flag unless really necessary. That
12478 flag causes redisplay to give up and retry
12479 redisplaying the frame from scratch, so setting it
12480 unnecessarily can lead to nasty redisplay loops. */
12481 if (new_lines
<= max_lines
12482 && eabs (new_lines
- old_lines
) >= 1)
12484 XSETFRAME (frame
, f
);
12485 Fmodify_frame_parameters (frame
,
12486 list1 (Fcons (Qtool_bar_lines
,
12487 make_number (new_lines
))));
12488 clear_glyph_matrix (w
->desired_matrix
);
12489 f
->n_tool_bar_rows
= nrows
;
12490 f
->fonts_changed
= 1;
12497 f
->minimize_tool_bar_window_p
= 0;
12500 #endif /* USE_GTK || HAVE_NS */
12503 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12505 /* Get information about the tool-bar item which is displayed in GLYPH
12506 on frame F. Return in *PROP_IDX the index where tool-bar item
12507 properties start in F->tool_bar_items. Value is zero if
12508 GLYPH doesn't display a tool-bar item. */
12511 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12517 /* This function can be called asynchronously, which means we must
12518 exclude any possibility that Fget_text_property signals an
12520 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12521 charpos
= max (0, charpos
);
12523 /* Get the text property `menu-item' at pos. The value of that
12524 property is the start index of this item's properties in
12525 F->tool_bar_items. */
12526 prop
= Fget_text_property (make_number (charpos
),
12527 Qmenu_item
, f
->current_tool_bar_string
);
12528 if (INTEGERP (prop
))
12530 *prop_idx
= XINT (prop
);
12540 /* Get information about the tool-bar item at position X/Y on frame F.
12541 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12542 the current matrix of the tool-bar window of F, or NULL if not
12543 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12544 item in F->tool_bar_items. Value is
12546 -1 if X/Y is not on a tool-bar item
12547 0 if X/Y is on the same item that was highlighted before.
12551 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12552 int *hpos
, int *vpos
, int *prop_idx
)
12554 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12555 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12558 /* Find the glyph under X/Y. */
12559 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12560 if (*glyph
== NULL
)
12563 /* Get the start of this tool-bar item's properties in
12564 f->tool_bar_items. */
12565 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12568 /* Is mouse on the highlighted item? */
12569 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12570 && *vpos
>= hlinfo
->mouse_face_beg_row
12571 && *vpos
<= hlinfo
->mouse_face_end_row
12572 && (*vpos
> hlinfo
->mouse_face_beg_row
12573 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12574 && (*vpos
< hlinfo
->mouse_face_end_row
12575 || *hpos
< hlinfo
->mouse_face_end_col
12576 || hlinfo
->mouse_face_past_end
))
12584 Handle mouse button event on the tool-bar of frame F, at
12585 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12586 0 for button release. MODIFIERS is event modifiers for button
12590 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12593 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12594 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12595 int hpos
, vpos
, prop_idx
;
12596 struct glyph
*glyph
;
12597 Lisp_Object enabled_p
;
12600 /* If not on the highlighted tool-bar item, and mouse-highlight is
12601 non-nil, return. This is so we generate the tool-bar button
12602 click only when the mouse button is released on the same item as
12603 where it was pressed. However, when mouse-highlight is disabled,
12604 generate the click when the button is released regardless of the
12605 highlight, since tool-bar items are not highlighted in that
12607 frame_to_window_pixel_xy (w
, &x
, &y
);
12608 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12610 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12613 /* When mouse-highlight is off, generate the click for the item
12614 where the button was pressed, disregarding where it was
12616 if (NILP (Vmouse_highlight
) && !down_p
)
12617 prop_idx
= last_tool_bar_item
;
12619 /* If item is disabled, do nothing. */
12620 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12621 if (NILP (enabled_p
))
12626 /* Show item in pressed state. */
12627 if (!NILP (Vmouse_highlight
))
12628 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12629 last_tool_bar_item
= prop_idx
;
12633 Lisp_Object key
, frame
;
12634 struct input_event event
;
12635 EVENT_INIT (event
);
12637 /* Show item in released state. */
12638 if (!NILP (Vmouse_highlight
))
12639 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12641 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12643 XSETFRAME (frame
, f
);
12644 event
.kind
= TOOL_BAR_EVENT
;
12645 event
.frame_or_window
= frame
;
12647 kbd_buffer_store_event (&event
);
12649 event
.kind
= TOOL_BAR_EVENT
;
12650 event
.frame_or_window
= frame
;
12652 event
.modifiers
= modifiers
;
12653 kbd_buffer_store_event (&event
);
12654 last_tool_bar_item
= -1;
12659 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12660 tool-bar window-relative coordinates X/Y. Called from
12661 note_mouse_highlight. */
12664 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12666 Lisp_Object window
= f
->tool_bar_window
;
12667 struct window
*w
= XWINDOW (window
);
12668 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12669 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12671 struct glyph
*glyph
;
12672 struct glyph_row
*row
;
12674 Lisp_Object enabled_p
;
12676 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12677 int mouse_down_p
, rc
;
12679 /* Function note_mouse_highlight is called with negative X/Y
12680 values when mouse moves outside of the frame. */
12681 if (x
<= 0 || y
<= 0)
12683 clear_mouse_face (hlinfo
);
12687 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12690 /* Not on tool-bar item. */
12691 clear_mouse_face (hlinfo
);
12695 /* On same tool-bar item as before. */
12696 goto set_help_echo
;
12698 clear_mouse_face (hlinfo
);
12700 /* Mouse is down, but on different tool-bar item? */
12701 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12702 && f
== dpyinfo
->last_mouse_frame
);
12705 && last_tool_bar_item
!= prop_idx
)
12708 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12710 /* If tool-bar item is not enabled, don't highlight it. */
12711 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12712 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12714 /* Compute the x-position of the glyph. In front and past the
12715 image is a space. We include this in the highlighted area. */
12716 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12717 for (i
= x
= 0; i
< hpos
; ++i
)
12718 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12720 /* Record this as the current active region. */
12721 hlinfo
->mouse_face_beg_col
= hpos
;
12722 hlinfo
->mouse_face_beg_row
= vpos
;
12723 hlinfo
->mouse_face_beg_x
= x
;
12724 hlinfo
->mouse_face_past_end
= 0;
12726 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12727 hlinfo
->mouse_face_end_row
= vpos
;
12728 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12729 hlinfo
->mouse_face_window
= window
;
12730 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12732 /* Display it as active. */
12733 show_mouse_face (hlinfo
, draw
);
12738 /* Set help_echo_string to a help string to display for this tool-bar item.
12739 XTread_socket does the rest. */
12740 help_echo_object
= help_echo_window
= Qnil
;
12741 help_echo_pos
= -1;
12742 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12743 if (NILP (help_echo_string
))
12744 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12747 #endif /* !USE_GTK && !HAVE_NS */
12749 #endif /* HAVE_WINDOW_SYSTEM */
12753 /************************************************************************
12754 Horizontal scrolling
12755 ************************************************************************/
12757 static int hscroll_window_tree (Lisp_Object
);
12758 static int hscroll_windows (Lisp_Object
);
12760 /* For all leaf windows in the window tree rooted at WINDOW, set their
12761 hscroll value so that PT is (i) visible in the window, and (ii) so
12762 that it is not within a certain margin at the window's left and
12763 right border. Value is non-zero if any window's hscroll has been
12767 hscroll_window_tree (Lisp_Object window
)
12769 int hscrolled_p
= 0;
12770 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12771 int hscroll_step_abs
= 0;
12772 double hscroll_step_rel
= 0;
12774 if (hscroll_relative_p
)
12776 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12777 if (hscroll_step_rel
< 0)
12779 hscroll_relative_p
= 0;
12780 hscroll_step_abs
= 0;
12783 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12785 hscroll_step_abs
= XINT (Vhscroll_step
);
12786 if (hscroll_step_abs
< 0)
12787 hscroll_step_abs
= 0;
12790 hscroll_step_abs
= 0;
12792 while (WINDOWP (window
))
12794 struct window
*w
= XWINDOW (window
);
12796 if (WINDOWP (w
->contents
))
12797 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12798 else if (w
->cursor
.vpos
>= 0)
12801 int text_area_width
;
12802 struct glyph_row
*cursor_row
;
12803 struct glyph_row
*bottom_row
;
12806 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12807 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12808 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12810 cursor_row
= bottom_row
- 1;
12812 if (!cursor_row
->enabled_p
)
12814 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12815 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12816 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12818 cursor_row
= bottom_row
- 1;
12820 row_r2l_p
= cursor_row
->reversed_p
;
12822 text_area_width
= window_box_width (w
, TEXT_AREA
);
12824 /* Scroll when cursor is inside this scroll margin. */
12825 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12827 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12828 /* For left-to-right rows, hscroll when cursor is either
12829 (i) inside the right hscroll margin, or (ii) if it is
12830 inside the left margin and the window is already
12834 && w
->cursor
.x
<= h_margin
)
12835 || (cursor_row
->enabled_p
12836 && cursor_row
->truncated_on_right_p
12837 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12838 /* For right-to-left rows, the logic is similar,
12839 except that rules for scrolling to left and right
12840 are reversed. E.g., if cursor.x <= h_margin, we
12841 need to hscroll "to the right" unconditionally,
12842 and that will scroll the screen to the left so as
12843 to reveal the next portion of the row. */
12845 && ((cursor_row
->enabled_p
12846 /* FIXME: It is confusing to set the
12847 truncated_on_right_p flag when R2L rows
12848 are actually truncated on the left. */
12849 && cursor_row
->truncated_on_right_p
12850 && w
->cursor
.x
<= h_margin
)
12852 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12856 struct buffer
*saved_current_buffer
;
12860 /* Find point in a display of infinite width. */
12861 saved_current_buffer
= current_buffer
;
12862 current_buffer
= XBUFFER (w
->contents
);
12864 if (w
== XWINDOW (selected_window
))
12867 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12869 /* Move iterator to pt starting at cursor_row->start in
12870 a line with infinite width. */
12871 init_to_row_start (&it
, w
, cursor_row
);
12872 it
.last_visible_x
= INFINITY
;
12873 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12874 current_buffer
= saved_current_buffer
;
12876 /* Position cursor in window. */
12877 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12878 hscroll
= max (0, (it
.current_x
12879 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12880 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12881 : (text_area_width
/ 2))))
12882 / FRAME_COLUMN_WIDTH (it
.f
);
12883 else if ((!row_r2l_p
12884 && w
->cursor
.x
>= text_area_width
- h_margin
)
12885 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12887 if (hscroll_relative_p
)
12888 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12891 wanted_x
= text_area_width
12892 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12895 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12899 if (hscroll_relative_p
)
12900 wanted_x
= text_area_width
* hscroll_step_rel
12903 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12906 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12908 hscroll
= max (hscroll
, w
->min_hscroll
);
12910 /* Don't prevent redisplay optimizations if hscroll
12911 hasn't changed, as it will unnecessarily slow down
12913 if (w
->hscroll
!= hscroll
)
12915 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12916 w
->hscroll
= hscroll
;
12925 /* Value is non-zero if hscroll of any leaf window has been changed. */
12926 return hscrolled_p
;
12930 /* Set hscroll so that cursor is visible and not inside horizontal
12931 scroll margins for all windows in the tree rooted at WINDOW. See
12932 also hscroll_window_tree above. Value is non-zero if any window's
12933 hscroll has been changed. If it has, desired matrices on the frame
12934 of WINDOW are cleared. */
12937 hscroll_windows (Lisp_Object window
)
12939 int hscrolled_p
= hscroll_window_tree (window
);
12941 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12942 return hscrolled_p
;
12947 /************************************************************************
12949 ************************************************************************/
12951 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12952 to a non-zero value. This is sometimes handy to have in a debugger
12957 /* First and last unchanged row for try_window_id. */
12959 static int debug_first_unchanged_at_end_vpos
;
12960 static int debug_last_unchanged_at_beg_vpos
;
12962 /* Delta vpos and y. */
12964 static int debug_dvpos
, debug_dy
;
12966 /* Delta in characters and bytes for try_window_id. */
12968 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12970 /* Values of window_end_pos and window_end_vpos at the end of
12973 static ptrdiff_t debug_end_vpos
;
12975 /* Append a string to W->desired_matrix->method. FMT is a printf
12976 format string. If trace_redisplay_p is true also printf the
12977 resulting string to stderr. */
12979 static void debug_method_add (struct window
*, char const *, ...)
12980 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12983 debug_method_add (struct window
*w
, char const *fmt
, ...)
12986 char *method
= w
->desired_matrix
->method
;
12987 int len
= strlen (method
);
12988 int size
= sizeof w
->desired_matrix
->method
;
12989 int remaining
= size
- len
- 1;
12992 if (len
&& remaining
)
12995 --remaining
, ++len
;
12998 va_start (ap
, fmt
);
12999 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13002 if (trace_redisplay_p
)
13003 fprintf (stderr
, "%p (%s): %s\n",
13005 ((BUFFERP (w
->contents
)
13006 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13007 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13012 #endif /* GLYPH_DEBUG */
13015 /* Value is non-zero if all changes in window W, which displays
13016 current_buffer, are in the text between START and END. START is a
13017 buffer position, END is given as a distance from Z. Used in
13018 redisplay_internal for display optimization. */
13021 text_outside_line_unchanged_p (struct window
*w
,
13022 ptrdiff_t start
, ptrdiff_t end
)
13024 int unchanged_p
= 1;
13026 /* If text or overlays have changed, see where. */
13027 if (window_outdated (w
))
13029 /* Gap in the line? */
13030 if (GPT
< start
|| Z
- GPT
< end
)
13033 /* Changes start in front of the line, or end after it? */
13035 && (BEG_UNCHANGED
< start
- 1
13036 || END_UNCHANGED
< end
))
13039 /* If selective display, can't optimize if changes start at the
13040 beginning of the line. */
13042 && INTEGERP (BVAR (current_buffer
, selective_display
))
13043 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13044 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13047 /* If there are overlays at the start or end of the line, these
13048 may have overlay strings with newlines in them. A change at
13049 START, for instance, may actually concern the display of such
13050 overlay strings as well, and they are displayed on different
13051 lines. So, quickly rule out this case. (For the future, it
13052 might be desirable to implement something more telling than
13053 just BEG/END_UNCHANGED.) */
13056 if (BEG
+ BEG_UNCHANGED
== start
13057 && overlay_touches_p (start
))
13059 if (END_UNCHANGED
== end
13060 && overlay_touches_p (Z
- end
))
13064 /* Under bidi reordering, adding or deleting a character in the
13065 beginning of a paragraph, before the first strong directional
13066 character, can change the base direction of the paragraph (unless
13067 the buffer specifies a fixed paragraph direction), which will
13068 require to redisplay the whole paragraph. It might be worthwhile
13069 to find the paragraph limits and widen the range of redisplayed
13070 lines to that, but for now just give up this optimization. */
13071 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13072 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13076 return unchanged_p
;
13080 /* Do a frame update, taking possible shortcuts into account. This is
13081 the main external entry point for redisplay.
13083 If the last redisplay displayed an echo area message and that message
13084 is no longer requested, we clear the echo area or bring back the
13085 mini-buffer if that is in use. */
13090 redisplay_internal ();
13095 overlay_arrow_string_or_property (Lisp_Object var
)
13099 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13102 return Voverlay_arrow_string
;
13105 /* Return 1 if there are any overlay-arrows in current_buffer. */
13107 overlay_arrow_in_current_buffer_p (void)
13111 for (vlist
= Voverlay_arrow_variable_list
;
13113 vlist
= XCDR (vlist
))
13115 Lisp_Object var
= XCAR (vlist
);
13118 if (!SYMBOLP (var
))
13120 val
= find_symbol_value (var
);
13122 && current_buffer
== XMARKER (val
)->buffer
)
13129 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13133 overlay_arrows_changed_p (void)
13137 for (vlist
= Voverlay_arrow_variable_list
;
13139 vlist
= XCDR (vlist
))
13141 Lisp_Object var
= XCAR (vlist
);
13142 Lisp_Object val
, pstr
;
13144 if (!SYMBOLP (var
))
13146 val
= find_symbol_value (var
);
13147 if (!MARKERP (val
))
13149 if (! EQ (COERCE_MARKER (val
),
13150 Fget (var
, Qlast_arrow_position
))
13151 || ! (pstr
= overlay_arrow_string_or_property (var
),
13152 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13158 /* Mark overlay arrows to be updated on next redisplay. */
13161 update_overlay_arrows (int up_to_date
)
13165 for (vlist
= Voverlay_arrow_variable_list
;
13167 vlist
= XCDR (vlist
))
13169 Lisp_Object var
= XCAR (vlist
);
13171 if (!SYMBOLP (var
))
13174 if (up_to_date
> 0)
13176 Lisp_Object val
= find_symbol_value (var
);
13177 Fput (var
, Qlast_arrow_position
,
13178 COERCE_MARKER (val
));
13179 Fput (var
, Qlast_arrow_string
,
13180 overlay_arrow_string_or_property (var
));
13182 else if (up_to_date
< 0
13183 || !NILP (Fget (var
, Qlast_arrow_position
)))
13185 Fput (var
, Qlast_arrow_position
, Qt
);
13186 Fput (var
, Qlast_arrow_string
, Qt
);
13192 /* Return overlay arrow string to display at row.
13193 Return integer (bitmap number) for arrow bitmap in left fringe.
13194 Return nil if no overlay arrow. */
13197 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13201 for (vlist
= Voverlay_arrow_variable_list
;
13203 vlist
= XCDR (vlist
))
13205 Lisp_Object var
= XCAR (vlist
);
13208 if (!SYMBOLP (var
))
13211 val
= find_symbol_value (var
);
13214 && current_buffer
== XMARKER (val
)->buffer
13215 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13217 if (FRAME_WINDOW_P (it
->f
)
13218 /* FIXME: if ROW->reversed_p is set, this should test
13219 the right fringe, not the left one. */
13220 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13222 #ifdef HAVE_WINDOW_SYSTEM
13223 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13226 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13227 return make_number (fringe_bitmap
);
13230 return make_number (-1); /* Use default arrow bitmap. */
13232 return overlay_arrow_string_or_property (var
);
13239 /* Return 1 if point moved out of or into a composition. Otherwise
13240 return 0. PREV_BUF and PREV_PT are the last point buffer and
13241 position. BUF and PT are the current point buffer and position. */
13244 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13245 struct buffer
*buf
, ptrdiff_t pt
)
13247 ptrdiff_t start
, end
;
13249 Lisp_Object buffer
;
13251 XSETBUFFER (buffer
, buf
);
13252 /* Check a composition at the last point if point moved within the
13254 if (prev_buf
== buf
)
13257 /* Point didn't move. */
13260 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13261 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13262 && composition_valid_p (start
, end
, prop
)
13263 && start
< prev_pt
&& end
> prev_pt
)
13264 /* The last point was within the composition. Return 1 iff
13265 point moved out of the composition. */
13266 return (pt
<= start
|| pt
>= end
);
13269 /* Check a composition at the current point. */
13270 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13271 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13272 && composition_valid_p (start
, end
, prop
)
13273 && start
< pt
&& end
> pt
);
13276 /* Reconsider the clip changes of buffer which is displayed in W. */
13279 reconsider_clip_changes (struct window
*w
)
13281 struct buffer
*b
= XBUFFER (w
->contents
);
13283 if (b
->clip_changed
13284 && w
->window_end_valid
13285 && w
->current_matrix
->buffer
== b
13286 && w
->current_matrix
->zv
== BUF_ZV (b
)
13287 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13288 b
->clip_changed
= 0;
13290 /* If display wasn't paused, and W is not a tool bar window, see if
13291 point has been moved into or out of a composition. In that case,
13292 we set b->clip_changed to 1 to force updating the screen. If
13293 b->clip_changed has already been set to 1, we can skip this
13295 if (!b
->clip_changed
&& w
->window_end_valid
)
13297 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13298 ? PT
: marker_position (w
->pointm
));
13300 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13301 && check_point_in_composition (w
->current_matrix
->buffer
,
13302 w
->last_point
, b
, pt
))
13303 b
->clip_changed
= 1;
13308 propagate_buffer_redisplay (void)
13309 { /* Resetting b->text->redisplay is problematic!
13310 We can't just reset it in the case that some window that displays
13311 it has not been redisplayed; and such a window can stay
13312 unredisplayed for a long time if it's currently invisible.
13313 But we do want to reset it at the end of redisplay otherwise
13314 its displayed windows will keep being redisplayed over and over
13316 So we copy all b->text->redisplay flags up to their windows here,
13317 such that mark_window_display_accurate can safely reset
13318 b->text->redisplay. */
13319 Lisp_Object ws
= window_list ();
13320 for (; CONSP (ws
); ws
= XCDR (ws
))
13322 struct window
*thisw
= XWINDOW (XCAR (ws
));
13323 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13324 if (thisb
->text
->redisplay
)
13325 thisw
->redisplay
= true;
13329 #define STOP_POLLING \
13330 do { if (! polling_stopped_here) stop_polling (); \
13331 polling_stopped_here = 1; } while (0)
13333 #define RESUME_POLLING \
13334 do { if (polling_stopped_here) start_polling (); \
13335 polling_stopped_here = 0; } while (0)
13338 /* Perhaps in the future avoid recentering windows if it
13339 is not necessary; currently that causes some problems. */
13342 redisplay_internal (void)
13344 struct window
*w
= XWINDOW (selected_window
);
13348 bool must_finish
= 0, match_p
;
13349 struct text_pos tlbufpos
, tlendpos
;
13350 int number_of_visible_frames
;
13353 int polling_stopped_here
= 0;
13354 Lisp_Object tail
, frame
;
13356 /* True means redisplay has to consider all windows on all
13357 frames. False, only selected_window is considered. */
13358 bool consider_all_windows_p
;
13360 /* True means redisplay has to redisplay the miniwindow. */
13361 bool update_miniwindow_p
= false;
13363 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13365 /* No redisplay if running in batch mode or frame is not yet fully
13366 initialized, or redisplay is explicitly turned off by setting
13367 Vinhibit_redisplay. */
13368 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13369 || !NILP (Vinhibit_redisplay
))
13372 /* Don't examine these until after testing Vinhibit_redisplay.
13373 When Emacs is shutting down, perhaps because its connection to
13374 X has dropped, we should not look at them at all. */
13375 fr
= XFRAME (w
->frame
);
13376 sf
= SELECTED_FRAME ();
13378 if (!fr
->glyphs_initialized_p
)
13381 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13382 if (popup_activated ())
13386 /* I don't think this happens but let's be paranoid. */
13387 if (redisplaying_p
)
13390 /* Record a function that clears redisplaying_p
13391 when we leave this function. */
13392 count
= SPECPDL_INDEX ();
13393 record_unwind_protect_void (unwind_redisplay
);
13394 redisplaying_p
= 1;
13395 specbind (Qinhibit_free_realized_faces
, Qnil
);
13397 /* Record this function, so it appears on the profiler's backtraces. */
13398 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13400 FOR_EACH_FRAME (tail
, frame
)
13401 XFRAME (frame
)->already_hscrolled_p
= 0;
13404 /* Remember the currently selected window. */
13408 last_escape_glyph_frame
= NULL
;
13409 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13410 last_glyphless_glyph_frame
= NULL
;
13411 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13413 /* If face_change_count is non-zero, init_iterator will free all
13414 realized faces, which includes the faces referenced from current
13415 matrices. So, we can't reuse current matrices in this case. */
13416 if (face_change_count
)
13417 windows_or_buffers_changed
= 47;
13419 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13420 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13422 /* Since frames on a single ASCII terminal share the same
13423 display area, displaying a different frame means redisplay
13424 the whole thing. */
13425 SET_FRAME_GARBAGED (sf
);
13427 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13429 FRAME_TTY (sf
)->previous_frame
= sf
;
13432 /* Set the visible flags for all frames. Do this before checking for
13433 resized or garbaged frames; they want to know if their frames are
13434 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13435 number_of_visible_frames
= 0;
13437 FOR_EACH_FRAME (tail
, frame
)
13439 struct frame
*f
= XFRAME (frame
);
13441 if (FRAME_VISIBLE_P (f
))
13443 ++number_of_visible_frames
;
13444 /* Adjust matrices for visible frames only. */
13445 if (f
->fonts_changed
)
13447 adjust_frame_glyphs (f
);
13448 f
->fonts_changed
= 0;
13450 /* If cursor type has been changed on the frame
13451 other than selected, consider all frames. */
13452 if (f
!= sf
&& f
->cursor_type_changed
)
13453 update_mode_lines
= 31;
13455 clear_desired_matrices (f
);
13458 /* Notice any pending interrupt request to change frame size. */
13459 do_pending_window_change (1);
13461 /* do_pending_window_change could change the selected_window due to
13462 frame resizing which makes the selected window too small. */
13463 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13466 /* Clear frames marked as garbaged. */
13467 clear_garbaged_frames ();
13469 /* Build menubar and tool-bar items. */
13470 if (NILP (Vmemory_full
))
13471 prepare_menu_bars ();
13473 reconsider_clip_changes (w
);
13475 /* In most cases selected window displays current buffer. */
13476 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13479 /* Detect case that we need to write or remove a star in the mode line. */
13480 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13481 w
->update_mode_line
= 1;
13483 if (mode_line_update_needed (w
))
13484 w
->update_mode_line
= 1;
13487 /* Normally the message* functions will have already displayed and
13488 updated the echo area, but the frame may have been trashed, or
13489 the update may have been preempted, so display the echo area
13490 again here. Checking message_cleared_p captures the case that
13491 the echo area should be cleared. */
13492 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13493 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13494 || (message_cleared_p
13495 && minibuf_level
== 0
13496 /* If the mini-window is currently selected, this means the
13497 echo-area doesn't show through. */
13498 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13500 int window_height_changed_p
= echo_area_display (0);
13502 if (message_cleared_p
)
13503 update_miniwindow_p
= true;
13507 /* If we don't display the current message, don't clear the
13508 message_cleared_p flag, because, if we did, we wouldn't clear
13509 the echo area in the next redisplay which doesn't preserve
13511 if (!display_last_displayed_message_p
)
13512 message_cleared_p
= 0;
13514 if (window_height_changed_p
)
13516 windows_or_buffers_changed
= 50;
13518 /* If window configuration was changed, frames may have been
13519 marked garbaged. Clear them or we will experience
13520 surprises wrt scrolling. */
13521 clear_garbaged_frames ();
13524 else if (EQ (selected_window
, minibuf_window
)
13525 && (current_buffer
->clip_changed
|| window_outdated (w
))
13526 && resize_mini_window (w
, 0))
13528 /* Resized active mini-window to fit the size of what it is
13529 showing if its contents might have changed. */
13532 /* If window configuration was changed, frames may have been
13533 marked garbaged. Clear them or we will experience
13534 surprises wrt scrolling. */
13535 clear_garbaged_frames ();
13538 if (windows_or_buffers_changed
&& !update_mode_lines
)
13539 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13540 only the windows's contents needs to be refreshed, or whether the
13541 mode-lines also need a refresh. */
13542 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13543 ? REDISPLAY_SOME
: 32);
13545 /* If specs for an arrow have changed, do thorough redisplay
13546 to ensure we remove any arrow that should no longer exist. */
13547 if (overlay_arrows_changed_p ())
13548 /* Apparently, this is the only case where we update other windows,
13549 without updating other mode-lines. */
13550 windows_or_buffers_changed
= 49;
13552 consider_all_windows_p
= (update_mode_lines
13553 || windows_or_buffers_changed
);
13555 #define AINC(a,i) \
13556 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13557 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13559 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13560 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13562 /* Optimize the case that only the line containing the cursor in the
13563 selected window has changed. Variables starting with this_ are
13564 set in display_line and record information about the line
13565 containing the cursor. */
13566 tlbufpos
= this_line_start_pos
;
13567 tlendpos
= this_line_end_pos
;
13568 if (!consider_all_windows_p
13569 && CHARPOS (tlbufpos
) > 0
13570 && !w
->update_mode_line
13571 && !current_buffer
->clip_changed
13572 && !current_buffer
->prevent_redisplay_optimizations_p
13573 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13574 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13575 && !XFRAME (w
->frame
)->cursor_type_changed
13576 /* Make sure recorded data applies to current buffer, etc. */
13577 && this_line_buffer
== current_buffer
13580 && !w
->optional_new_start
13581 /* Point must be on the line that we have info recorded about. */
13582 && PT
>= CHARPOS (tlbufpos
)
13583 && PT
<= Z
- CHARPOS (tlendpos
)
13584 /* All text outside that line, including its final newline,
13585 must be unchanged. */
13586 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13587 CHARPOS (tlendpos
)))
13589 if (CHARPOS (tlbufpos
) > BEGV
13590 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13591 && (CHARPOS (tlbufpos
) == ZV
13592 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13593 /* Former continuation line has disappeared by becoming empty. */
13595 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13597 /* We have to handle the case of continuation around a
13598 wide-column character (see the comment in indent.c around
13601 For instance, in the following case:
13603 -------- Insert --------
13604 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13605 J_I_ ==> J_I_ `^^' are cursors.
13609 As we have to redraw the line above, we cannot use this
13613 int line_height_before
= this_line_pixel_height
;
13615 /* Note that start_display will handle the case that the
13616 line starting at tlbufpos is a continuation line. */
13617 start_display (&it
, w
, tlbufpos
);
13619 /* Implementation note: It this still necessary? */
13620 if (it
.current_x
!= this_line_start_x
)
13623 TRACE ((stderr
, "trying display optimization 1\n"));
13624 w
->cursor
.vpos
= -1;
13625 overlay_arrow_seen
= 0;
13626 it
.vpos
= this_line_vpos
;
13627 it
.current_y
= this_line_y
;
13628 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13629 display_line (&it
);
13631 /* If line contains point, is not continued,
13632 and ends at same distance from eob as before, we win. */
13633 if (w
->cursor
.vpos
>= 0
13634 /* Line is not continued, otherwise this_line_start_pos
13635 would have been set to 0 in display_line. */
13636 && CHARPOS (this_line_start_pos
)
13637 /* Line ends as before. */
13638 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13639 /* Line has same height as before. Otherwise other lines
13640 would have to be shifted up or down. */
13641 && this_line_pixel_height
== line_height_before
)
13643 /* If this is not the window's last line, we must adjust
13644 the charstarts of the lines below. */
13645 if (it
.current_y
< it
.last_visible_y
)
13647 struct glyph_row
*row
13648 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13649 ptrdiff_t delta
, delta_bytes
;
13651 /* We used to distinguish between two cases here,
13652 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13653 when the line ends in a newline or the end of the
13654 buffer's accessible portion. But both cases did
13655 the same, so they were collapsed. */
13657 - CHARPOS (tlendpos
)
13658 - MATRIX_ROW_START_CHARPOS (row
));
13659 delta_bytes
= (Z_BYTE
13660 - BYTEPOS (tlendpos
)
13661 - MATRIX_ROW_START_BYTEPOS (row
));
13663 increment_matrix_positions (w
->current_matrix
,
13664 this_line_vpos
+ 1,
13665 w
->current_matrix
->nrows
,
13666 delta
, delta_bytes
);
13669 /* If this row displays text now but previously didn't,
13670 or vice versa, w->window_end_vpos may have to be
13672 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13674 if (w
->window_end_vpos
< this_line_vpos
)
13675 w
->window_end_vpos
= this_line_vpos
;
13677 else if (w
->window_end_vpos
== this_line_vpos
13678 && this_line_vpos
> 0)
13679 w
->window_end_vpos
= this_line_vpos
- 1;
13680 w
->window_end_valid
= 0;
13682 /* Update hint: No need to try to scroll in update_window. */
13683 w
->desired_matrix
->no_scrolling_p
= 1;
13686 *w
->desired_matrix
->method
= 0;
13687 debug_method_add (w
, "optimization 1");
13689 #ifdef HAVE_WINDOW_SYSTEM
13690 update_window_fringes (w
, 0);
13697 else if (/* Cursor position hasn't changed. */
13698 PT
== w
->last_point
13699 /* Make sure the cursor was last displayed
13700 in this window. Otherwise we have to reposition it. */
13702 /* PXW: Must be converted to pixels, probably. */
13703 && 0 <= w
->cursor
.vpos
13704 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13708 do_pending_window_change (1);
13709 /* If selected_window changed, redisplay again. */
13710 if (WINDOWP (selected_window
)
13711 && (w
= XWINDOW (selected_window
)) != sw
)
13714 /* We used to always goto end_of_redisplay here, but this
13715 isn't enough if we have a blinking cursor. */
13716 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13717 goto end_of_redisplay
;
13721 /* If highlighting the region, or if the cursor is in the echo area,
13722 then we can't just move the cursor. */
13723 else if (NILP (Vshow_trailing_whitespace
)
13724 && !cursor_in_echo_area
)
13727 struct glyph_row
*row
;
13729 /* Skip from tlbufpos to PT and see where it is. Note that
13730 PT may be in invisible text. If so, we will end at the
13731 next visible position. */
13732 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13733 NULL
, DEFAULT_FACE_ID
);
13734 it
.current_x
= this_line_start_x
;
13735 it
.current_y
= this_line_y
;
13736 it
.vpos
= this_line_vpos
;
13738 /* The call to move_it_to stops in front of PT, but
13739 moves over before-strings. */
13740 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13742 if (it
.vpos
== this_line_vpos
13743 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13746 eassert (this_line_vpos
== it
.vpos
);
13747 eassert (this_line_y
== it
.current_y
);
13748 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13750 *w
->desired_matrix
->method
= 0;
13751 debug_method_add (w
, "optimization 3");
13760 /* Text changed drastically or point moved off of line. */
13761 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13764 CHARPOS (this_line_start_pos
) = 0;
13765 ++clear_face_cache_count
;
13766 #ifdef HAVE_WINDOW_SYSTEM
13767 ++clear_image_cache_count
;
13770 /* Build desired matrices, and update the display. If
13771 consider_all_windows_p is non-zero, do it for all windows on all
13772 frames. Otherwise do it for selected_window, only. */
13774 if (consider_all_windows_p
)
13776 FOR_EACH_FRAME (tail
, frame
)
13777 XFRAME (frame
)->updated_p
= 0;
13779 propagate_buffer_redisplay ();
13781 FOR_EACH_FRAME (tail
, frame
)
13783 struct frame
*f
= XFRAME (frame
);
13785 /* We don't have to do anything for unselected terminal
13787 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13788 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13793 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13796 /* Only GC scrollbars when we redisplay the whole frame. */
13797 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13798 /* Mark all the scroll bars to be removed; we'll redeem
13799 the ones we want when we redisplay their windows. */
13800 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13801 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13803 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13804 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13805 /* Remember that the invisible frames need to be redisplayed next
13806 time they're visible. */
13807 else if (!REDISPLAY_SOME_P ())
13808 f
->redisplay
= true;
13810 /* The X error handler may have deleted that frame. */
13811 if (!FRAME_LIVE_P (f
))
13814 /* Any scroll bars which redisplay_windows should have
13815 nuked should now go away. */
13816 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13817 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13819 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13821 /* If fonts changed on visible frame, display again. */
13822 if (f
->fonts_changed
)
13824 adjust_frame_glyphs (f
);
13825 f
->fonts_changed
= 0;
13829 /* See if we have to hscroll. */
13830 if (!f
->already_hscrolled_p
)
13832 f
->already_hscrolled_p
= 1;
13833 if (hscroll_windows (f
->root_window
))
13837 /* Prevent various kinds of signals during display
13838 update. stdio is not robust about handling
13839 signals, which can cause an apparent I/O error. */
13840 if (interrupt_input
)
13841 unrequest_sigio ();
13844 pending
|= update_frame (f
, 0, 0);
13845 f
->cursor_type_changed
= 0;
13851 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13855 /* Do the mark_window_display_accurate after all windows have
13856 been redisplayed because this call resets flags in buffers
13857 which are needed for proper redisplay. */
13858 FOR_EACH_FRAME (tail
, frame
)
13860 struct frame
*f
= XFRAME (frame
);
13863 f
->redisplay
= false;
13864 mark_window_display_accurate (f
->root_window
, 1);
13865 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13866 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13871 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13873 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13874 struct frame
*mini_frame
;
13876 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13877 /* Use list_of_error, not Qerror, so that
13878 we catch only errors and don't run the debugger. */
13879 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13881 redisplay_window_error
);
13882 if (update_miniwindow_p
)
13883 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13885 redisplay_window_error
);
13887 /* Compare desired and current matrices, perform output. */
13890 /* If fonts changed, display again. */
13891 if (sf
->fonts_changed
)
13894 /* Prevent various kinds of signals during display update.
13895 stdio is not robust about handling signals,
13896 which can cause an apparent I/O error. */
13897 if (interrupt_input
)
13898 unrequest_sigio ();
13901 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13903 if (hscroll_windows (selected_window
))
13906 XWINDOW (selected_window
)->must_be_updated_p
= true;
13907 pending
= update_frame (sf
, 0, 0);
13908 sf
->cursor_type_changed
= 0;
13911 /* We may have called echo_area_display at the top of this
13912 function. If the echo area is on another frame, that may
13913 have put text on a frame other than the selected one, so the
13914 above call to update_frame would not have caught it. Catch
13916 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13917 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13919 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13921 XWINDOW (mini_window
)->must_be_updated_p
= true;
13922 pending
|= update_frame (mini_frame
, 0, 0);
13923 mini_frame
->cursor_type_changed
= 0;
13924 if (!pending
&& hscroll_windows (mini_window
))
13929 /* If display was paused because of pending input, make sure we do a
13930 thorough update the next time. */
13933 /* Prevent the optimization at the beginning of
13934 redisplay_internal that tries a single-line update of the
13935 line containing the cursor in the selected window. */
13936 CHARPOS (this_line_start_pos
) = 0;
13938 /* Let the overlay arrow be updated the next time. */
13939 update_overlay_arrows (0);
13941 /* If we pause after scrolling, some rows in the current
13942 matrices of some windows are not valid. */
13943 if (!WINDOW_FULL_WIDTH_P (w
)
13944 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13945 update_mode_lines
= 36;
13949 if (!consider_all_windows_p
)
13951 /* This has already been done above if
13952 consider_all_windows_p is set. */
13953 if (XBUFFER (w
->contents
)->text
->redisplay
13954 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13955 /* This can happen if b->text->redisplay was set during
13957 propagate_buffer_redisplay ();
13958 mark_window_display_accurate_1 (w
, 1);
13960 /* Say overlay arrows are up to date. */
13961 update_overlay_arrows (1);
13963 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13964 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13967 update_mode_lines
= 0;
13968 windows_or_buffers_changed
= 0;
13971 /* Start SIGIO interrupts coming again. Having them off during the
13972 code above makes it less likely one will discard output, but not
13973 impossible, since there might be stuff in the system buffer here.
13974 But it is much hairier to try to do anything about that. */
13975 if (interrupt_input
)
13979 /* If a frame has become visible which was not before, redisplay
13980 again, so that we display it. Expose events for such a frame
13981 (which it gets when becoming visible) don't call the parts of
13982 redisplay constructing glyphs, so simply exposing a frame won't
13983 display anything in this case. So, we have to display these
13984 frames here explicitly. */
13989 FOR_EACH_FRAME (tail
, frame
)
13991 if (XFRAME (frame
)->visible
)
13995 if (new_count
!= number_of_visible_frames
)
13996 windows_or_buffers_changed
= 52;
13999 /* Change frame size now if a change is pending. */
14000 do_pending_window_change (1);
14002 /* If we just did a pending size change, or have additional
14003 visible frames, or selected_window changed, redisplay again. */
14004 if ((windows_or_buffers_changed
&& !pending
)
14005 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14008 /* Clear the face and image caches.
14010 We used to do this only if consider_all_windows_p. But the cache
14011 needs to be cleared if a timer creates images in the current
14012 buffer (e.g. the test case in Bug#6230). */
14014 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14016 clear_face_cache (0);
14017 clear_face_cache_count
= 0;
14020 #ifdef HAVE_WINDOW_SYSTEM
14021 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14023 clear_image_caches (Qnil
);
14024 clear_image_cache_count
= 0;
14026 #endif /* HAVE_WINDOW_SYSTEM */
14029 if (interrupt_input
&& interrupts_deferred
)
14032 unbind_to (count
, Qnil
);
14037 /* Redisplay, but leave alone any recent echo area message unless
14038 another message has been requested in its place.
14040 This is useful in situations where you need to redisplay but no
14041 user action has occurred, making it inappropriate for the message
14042 area to be cleared. See tracking_off and
14043 wait_reading_process_output for examples of these situations.
14045 FROM_WHERE is an integer saying from where this function was
14046 called. This is useful for debugging. */
14049 redisplay_preserve_echo_area (int from_where
)
14051 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14053 if (!NILP (echo_area_buffer
[1]))
14055 /* We have a previously displayed message, but no current
14056 message. Redisplay the previous message. */
14057 display_last_displayed_message_p
= 1;
14058 redisplay_internal ();
14059 display_last_displayed_message_p
= 0;
14062 redisplay_internal ();
14064 flush_frame (SELECTED_FRAME ());
14068 /* Function registered with record_unwind_protect in redisplay_internal. */
14071 unwind_redisplay (void)
14073 redisplaying_p
= 0;
14077 /* Mark the display of leaf window W as accurate or inaccurate.
14078 If ACCURATE_P is non-zero mark display of W as accurate. If
14079 ACCURATE_P is zero, arrange for W to be redisplayed the next
14080 time redisplay_internal is called. */
14083 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14085 struct buffer
*b
= XBUFFER (w
->contents
);
14087 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14088 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14089 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14093 b
->clip_changed
= false;
14094 b
->prevent_redisplay_optimizations_p
= false;
14095 eassert (buffer_window_count (b
) > 0);
14096 /* Resetting b->text->redisplay is problematic!
14097 In order to make it safer to do it here, redisplay_internal must
14098 have copied all b->text->redisplay to their respective windows. */
14099 b
->text
->redisplay
= false;
14101 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14102 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14103 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14104 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14106 w
->current_matrix
->buffer
= b
;
14107 w
->current_matrix
->begv
= BUF_BEGV (b
);
14108 w
->current_matrix
->zv
= BUF_ZV (b
);
14110 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14111 w
->last_cursor_off_p
= w
->cursor_off_p
;
14113 if (w
== XWINDOW (selected_window
))
14114 w
->last_point
= BUF_PT (b
);
14116 w
->last_point
= marker_position (w
->pointm
);
14118 w
->window_end_valid
= true;
14119 w
->update_mode_line
= false;
14122 w
->redisplay
= !accurate_p
;
14126 /* Mark the display of windows in the window tree rooted at WINDOW as
14127 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14128 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14129 be redisplayed the next time redisplay_internal is called. */
14132 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14136 for (; !NILP (window
); window
= w
->next
)
14138 w
= XWINDOW (window
);
14139 if (WINDOWP (w
->contents
))
14140 mark_window_display_accurate (w
->contents
, accurate_p
);
14142 mark_window_display_accurate_1 (w
, accurate_p
);
14146 update_overlay_arrows (1);
14148 /* Force a thorough redisplay the next time by setting
14149 last_arrow_position and last_arrow_string to t, which is
14150 unequal to any useful value of Voverlay_arrow_... */
14151 update_overlay_arrows (-1);
14155 /* Return value in display table DP (Lisp_Char_Table *) for character
14156 C. Since a display table doesn't have any parent, we don't have to
14157 follow parent. Do not call this function directly but use the
14158 macro DISP_CHAR_VECTOR. */
14161 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14165 if (ASCII_CHAR_P (c
))
14168 if (SUB_CHAR_TABLE_P (val
))
14169 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14175 XSETCHAR_TABLE (table
, dp
);
14176 val
= char_table_ref (table
, c
);
14185 /***********************************************************************
14187 ***********************************************************************/
14189 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14192 redisplay_windows (Lisp_Object window
)
14194 while (!NILP (window
))
14196 struct window
*w
= XWINDOW (window
);
14198 if (WINDOWP (w
->contents
))
14199 redisplay_windows (w
->contents
);
14200 else if (BUFFERP (w
->contents
))
14202 displayed_buffer
= XBUFFER (w
->contents
);
14203 /* Use list_of_error, not Qerror, so that
14204 we catch only errors and don't run the debugger. */
14205 internal_condition_case_1 (redisplay_window_0
, window
,
14207 redisplay_window_error
);
14215 redisplay_window_error (Lisp_Object ignore
)
14217 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14222 redisplay_window_0 (Lisp_Object window
)
14224 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14225 redisplay_window (window
, false);
14230 redisplay_window_1 (Lisp_Object window
)
14232 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14233 redisplay_window (window
, true);
14238 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14239 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14240 which positions recorded in ROW differ from current buffer
14243 Return 0 if cursor is not on this row, 1 otherwise. */
14246 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14247 struct glyph_matrix
*matrix
,
14248 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14251 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14252 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14253 struct glyph
*cursor
= NULL
;
14254 /* The last known character position in row. */
14255 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14257 ptrdiff_t pt_old
= PT
- delta
;
14258 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14259 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14260 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14261 /* A glyph beyond the edge of TEXT_AREA which we should never
14263 struct glyph
*glyphs_end
= end
;
14264 /* Non-zero means we've found a match for cursor position, but that
14265 glyph has the avoid_cursor_p flag set. */
14266 int match_with_avoid_cursor
= 0;
14267 /* Non-zero means we've seen at least one glyph that came from a
14269 int string_seen
= 0;
14270 /* Largest and smallest buffer positions seen so far during scan of
14272 ptrdiff_t bpos_max
= pos_before
;
14273 ptrdiff_t bpos_min
= pos_after
;
14274 /* Last buffer position covered by an overlay string with an integer
14275 `cursor' property. */
14276 ptrdiff_t bpos_covered
= 0;
14277 /* Non-zero means the display string on which to display the cursor
14278 comes from a text property, not from an overlay. */
14279 int string_from_text_prop
= 0;
14281 /* Don't even try doing anything if called for a mode-line or
14282 header-line row, since the rest of the code isn't prepared to
14283 deal with such calamities. */
14284 eassert (!row
->mode_line_p
);
14285 if (row
->mode_line_p
)
14288 /* Skip over glyphs not having an object at the start and the end of
14289 the row. These are special glyphs like truncation marks on
14290 terminal frames. */
14291 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14293 if (!row
->reversed_p
)
14296 && INTEGERP (glyph
->object
)
14297 && glyph
->charpos
< 0)
14299 x
+= glyph
->pixel_width
;
14303 && INTEGERP ((end
- 1)->object
)
14304 /* CHARPOS is zero for blanks and stretch glyphs
14305 inserted by extend_face_to_end_of_line. */
14306 && (end
- 1)->charpos
<= 0)
14308 glyph_before
= glyph
- 1;
14315 /* If the glyph row is reversed, we need to process it from back
14316 to front, so swap the edge pointers. */
14317 glyphs_end
= end
= glyph
- 1;
14318 glyph
+= row
->used
[TEXT_AREA
] - 1;
14320 while (glyph
> end
+ 1
14321 && INTEGERP (glyph
->object
)
14322 && glyph
->charpos
< 0)
14325 x
-= glyph
->pixel_width
;
14327 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14329 /* By default, in reversed rows we put the cursor on the
14330 rightmost (first in the reading order) glyph. */
14331 for (g
= end
+ 1; g
< glyph
; g
++)
14332 x
+= g
->pixel_width
;
14334 && INTEGERP ((end
+ 1)->object
)
14335 && (end
+ 1)->charpos
<= 0)
14337 glyph_before
= glyph
+ 1;
14341 else if (row
->reversed_p
)
14343 /* In R2L rows that don't display text, put the cursor on the
14344 rightmost glyph. Case in point: an empty last line that is
14345 part of an R2L paragraph. */
14347 /* Avoid placing the cursor on the last glyph of the row, where
14348 on terminal frames we hold the vertical border between
14349 adjacent windows. */
14350 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14351 && !WINDOW_RIGHTMOST_P (w
)
14352 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14354 x
= -1; /* will be computed below, at label compute_x */
14357 /* Step 1: Try to find the glyph whose character position
14358 corresponds to point. If that's not possible, find 2 glyphs
14359 whose character positions are the closest to point, one before
14360 point, the other after it. */
14361 if (!row
->reversed_p
)
14362 while (/* not marched to end of glyph row */
14364 /* glyph was not inserted by redisplay for internal purposes */
14365 && !INTEGERP (glyph
->object
))
14367 if (BUFFERP (glyph
->object
))
14369 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14371 if (glyph
->charpos
> bpos_max
)
14372 bpos_max
= glyph
->charpos
;
14373 if (glyph
->charpos
< bpos_min
)
14374 bpos_min
= glyph
->charpos
;
14375 if (!glyph
->avoid_cursor_p
)
14377 /* If we hit point, we've found the glyph on which to
14378 display the cursor. */
14381 match_with_avoid_cursor
= 0;
14384 /* See if we've found a better approximation to
14385 POS_BEFORE or to POS_AFTER. */
14386 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14388 pos_before
= glyph
->charpos
;
14389 glyph_before
= glyph
;
14391 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14393 pos_after
= glyph
->charpos
;
14394 glyph_after
= glyph
;
14397 else if (dpos
== 0)
14398 match_with_avoid_cursor
= 1;
14400 else if (STRINGP (glyph
->object
))
14402 Lisp_Object chprop
;
14403 ptrdiff_t glyph_pos
= glyph
->charpos
;
14405 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14407 if (!NILP (chprop
))
14409 /* If the string came from a `display' text property,
14410 look up the buffer position of that property and
14411 use that position to update bpos_max, as if we
14412 actually saw such a position in one of the row's
14413 glyphs. This helps with supporting integer values
14414 of `cursor' property on the display string in
14415 situations where most or all of the row's buffer
14416 text is completely covered by display properties,
14417 so that no glyph with valid buffer positions is
14418 ever seen in the row. */
14419 ptrdiff_t prop_pos
=
14420 string_buffer_position_lim (glyph
->object
, pos_before
,
14423 if (prop_pos
>= pos_before
)
14424 bpos_max
= prop_pos
- 1;
14426 if (INTEGERP (chprop
))
14428 bpos_covered
= bpos_max
+ XINT (chprop
);
14429 /* If the `cursor' property covers buffer positions up
14430 to and including point, we should display cursor on
14431 this glyph. Note that, if a `cursor' property on one
14432 of the string's characters has an integer value, we
14433 will break out of the loop below _before_ we get to
14434 the position match above. IOW, integer values of
14435 the `cursor' property override the "exact match for
14436 point" strategy of positioning the cursor. */
14437 /* Implementation note: bpos_max == pt_old when, e.g.,
14438 we are in an empty line, where bpos_max is set to
14439 MATRIX_ROW_START_CHARPOS, see above. */
14440 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14449 x
+= glyph
->pixel_width
;
14452 else if (glyph
> end
) /* row is reversed */
14453 while (!INTEGERP (glyph
->object
))
14455 if (BUFFERP (glyph
->object
))
14457 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14459 if (glyph
->charpos
> bpos_max
)
14460 bpos_max
= glyph
->charpos
;
14461 if (glyph
->charpos
< bpos_min
)
14462 bpos_min
= glyph
->charpos
;
14463 if (!glyph
->avoid_cursor_p
)
14467 match_with_avoid_cursor
= 0;
14470 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14472 pos_before
= glyph
->charpos
;
14473 glyph_before
= glyph
;
14475 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14477 pos_after
= glyph
->charpos
;
14478 glyph_after
= glyph
;
14481 else if (dpos
== 0)
14482 match_with_avoid_cursor
= 1;
14484 else if (STRINGP (glyph
->object
))
14486 Lisp_Object chprop
;
14487 ptrdiff_t glyph_pos
= glyph
->charpos
;
14489 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14491 if (!NILP (chprop
))
14493 ptrdiff_t prop_pos
=
14494 string_buffer_position_lim (glyph
->object
, pos_before
,
14497 if (prop_pos
>= pos_before
)
14498 bpos_max
= prop_pos
- 1;
14500 if (INTEGERP (chprop
))
14502 bpos_covered
= bpos_max
+ XINT (chprop
);
14503 /* If the `cursor' property covers buffer positions up
14504 to and including point, we should display cursor on
14506 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14515 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14517 x
--; /* can't use any pixel_width */
14520 x
-= glyph
->pixel_width
;
14523 /* Step 2: If we didn't find an exact match for point, we need to
14524 look for a proper place to put the cursor among glyphs between
14525 GLYPH_BEFORE and GLYPH_AFTER. */
14526 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14527 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14528 && !(bpos_max
< pt_old
&& pt_old
<= bpos_covered
))
14530 /* An empty line has a single glyph whose OBJECT is zero and
14531 whose CHARPOS is the position of a newline on that line.
14532 Note that on a TTY, there are more glyphs after that, which
14533 were produced by extend_face_to_end_of_line, but their
14534 CHARPOS is zero or negative. */
14536 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14537 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14538 /* On a TTY, continued and truncated rows also have a glyph at
14539 their end whose OBJECT is zero and whose CHARPOS is
14540 positive (the continuation and truncation glyphs), but such
14541 rows are obviously not "empty". */
14542 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14544 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14546 ptrdiff_t ellipsis_pos
;
14548 /* Scan back over the ellipsis glyphs. */
14549 if (!row
->reversed_p
)
14551 ellipsis_pos
= (glyph
- 1)->charpos
;
14552 while (glyph
> row
->glyphs
[TEXT_AREA
]
14553 && (glyph
- 1)->charpos
== ellipsis_pos
)
14554 glyph
--, x
-= glyph
->pixel_width
;
14555 /* That loop always goes one position too far, including
14556 the glyph before the ellipsis. So scan forward over
14558 x
+= glyph
->pixel_width
;
14561 else /* row is reversed */
14563 ellipsis_pos
= (glyph
+ 1)->charpos
;
14564 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14565 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14566 glyph
++, x
+= glyph
->pixel_width
;
14567 x
-= glyph
->pixel_width
;
14571 else if (match_with_avoid_cursor
)
14573 cursor
= glyph_after
;
14576 else if (string_seen
)
14578 int incr
= row
->reversed_p
? -1 : +1;
14580 /* Need to find the glyph that came out of a string which is
14581 present at point. That glyph is somewhere between
14582 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14583 positioned between POS_BEFORE and POS_AFTER in the
14585 struct glyph
*start
, *stop
;
14586 ptrdiff_t pos
= pos_before
;
14590 /* If the row ends in a newline from a display string,
14591 reordering could have moved the glyphs belonging to the
14592 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14593 in this case we extend the search to the last glyph in
14594 the row that was not inserted by redisplay. */
14595 if (row
->ends_in_newline_from_string_p
)
14598 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14601 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14602 correspond to POS_BEFORE and POS_AFTER, respectively. We
14603 need START and STOP in the order that corresponds to the
14604 row's direction as given by its reversed_p flag. If the
14605 directionality of characters between POS_BEFORE and
14606 POS_AFTER is the opposite of the row's base direction,
14607 these characters will have been reordered for display,
14608 and we need to reverse START and STOP. */
14609 if (!row
->reversed_p
)
14611 start
= min (glyph_before
, glyph_after
);
14612 stop
= max (glyph_before
, glyph_after
);
14616 start
= max (glyph_before
, glyph_after
);
14617 stop
= min (glyph_before
, glyph_after
);
14619 for (glyph
= start
+ incr
;
14620 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14623 /* Any glyphs that come from the buffer are here because
14624 of bidi reordering. Skip them, and only pay
14625 attention to glyphs that came from some string. */
14626 if (STRINGP (glyph
->object
))
14630 /* If the display property covers the newline, we
14631 need to search for it one position farther. */
14632 ptrdiff_t lim
= pos_after
14633 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14635 string_from_text_prop
= 0;
14636 str
= glyph
->object
;
14637 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14638 if (tem
== 0 /* from overlay */
14641 /* If the string from which this glyph came is
14642 found in the buffer at point, or at position
14643 that is closer to point than pos_after, then
14644 we've found the glyph we've been looking for.
14645 If it comes from an overlay (tem == 0), and
14646 it has the `cursor' property on one of its
14647 glyphs, record that glyph as a candidate for
14648 displaying the cursor. (As in the
14649 unidirectional version, we will display the
14650 cursor on the last candidate we find.) */
14653 || (tem
- pt_old
> 0 && tem
< pos_after
))
14655 /* The glyphs from this string could have
14656 been reordered. Find the one with the
14657 smallest string position. Or there could
14658 be a character in the string with the
14659 `cursor' property, which means display
14660 cursor on that character's glyph. */
14661 ptrdiff_t strpos
= glyph
->charpos
;
14666 string_from_text_prop
= 1;
14669 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14670 && EQ (glyph
->object
, str
);
14674 ptrdiff_t gpos
= glyph
->charpos
;
14676 cprop
= Fget_char_property (make_number (gpos
),
14684 if (tem
&& glyph
->charpos
< strpos
)
14686 strpos
= glyph
->charpos
;
14692 || (tem
- pt_old
> 0 && tem
< pos_after
))
14696 pos
= tem
+ 1; /* don't find previous instances */
14698 /* This string is not what we want; skip all of the
14699 glyphs that came from it. */
14700 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14701 && EQ (glyph
->object
, str
))
14708 /* If we reached the end of the line, and END was from a string,
14709 the cursor is not on this line. */
14711 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14712 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14713 && STRINGP (end
->object
)
14714 && row
->continued_p
)
14717 /* A truncated row may not include PT among its character positions.
14718 Setting the cursor inside the scroll margin will trigger
14719 recalculation of hscroll in hscroll_window_tree. But if a
14720 display string covers point, defer to the string-handling
14721 code below to figure this out. */
14722 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14724 cursor
= glyph_before
;
14727 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14728 /* Zero-width characters produce no glyphs. */
14730 && (row
->reversed_p
14731 ? glyph_after
> glyphs_end
14732 : glyph_after
< glyphs_end
)))
14734 cursor
= glyph_after
;
14740 if (cursor
!= NULL
)
14742 else if (glyph
== glyphs_end
14743 && pos_before
== pos_after
14744 && STRINGP ((row
->reversed_p
14745 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14746 : row
->glyphs
[TEXT_AREA
])->object
))
14748 /* If all the glyphs of this row came from strings, put the
14749 cursor on the first glyph of the row. This avoids having the
14750 cursor outside of the text area in this very rare and hard
14754 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14755 : row
->glyphs
[TEXT_AREA
];
14761 /* Need to compute x that corresponds to GLYPH. */
14762 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14764 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14766 x
+= g
->pixel_width
;
14770 /* ROW could be part of a continued line, which, under bidi
14771 reordering, might have other rows whose start and end charpos
14772 occlude point. Only set w->cursor if we found a better
14773 approximation to the cursor position than we have from previously
14774 examined candidate rows belonging to the same continued line. */
14775 if (/* We already have a candidate row. */
14776 w
->cursor
.vpos
>= 0
14777 /* That candidate is not the row we are processing. */
14778 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14779 /* Make sure cursor.vpos specifies a row whose start and end
14780 charpos occlude point, and it is valid candidate for being a
14781 cursor-row. This is because some callers of this function
14782 leave cursor.vpos at the row where the cursor was displayed
14783 during the last redisplay cycle. */
14784 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14785 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14786 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14789 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14791 /* Don't consider glyphs that are outside TEXT_AREA. */
14792 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14794 /* Keep the candidate whose buffer position is the closest to
14795 point or has the `cursor' property. */
14796 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14797 w
->cursor
.hpos
>= 0
14798 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14799 && ((BUFFERP (g1
->object
)
14800 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14801 || (BUFFERP (glyph
->object
)
14802 && eabs (g1
->charpos
- pt_old
)
14803 < eabs (glyph
->charpos
- pt_old
))))
14804 /* Previous candidate is a glyph from a string that has
14805 a non-nil `cursor' property. */
14806 || (STRINGP (g1
->object
)
14807 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14808 Qcursor
, g1
->object
))
14809 /* Previous candidate is from the same display
14810 string as this one, and the display string
14811 came from a text property. */
14812 || (EQ (g1
->object
, glyph
->object
)
14813 && string_from_text_prop
)
14814 /* this candidate is from newline and its
14815 position is not an exact match */
14816 || (INTEGERP (glyph
->object
)
14817 && glyph
->charpos
!= pt_old
)))))
14819 /* If this candidate gives an exact match, use that. */
14820 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14821 /* If this candidate is a glyph created for the
14822 terminating newline of a line, and point is on that
14823 newline, it wins because it's an exact match. */
14824 || (!row
->continued_p
14825 && INTEGERP (glyph
->object
)
14826 && glyph
->charpos
== 0
14827 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14828 /* Otherwise, keep the candidate that comes from a row
14829 spanning less buffer positions. This may win when one or
14830 both candidate positions are on glyphs that came from
14831 display strings, for which we cannot compare buffer
14833 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14834 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14835 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14838 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14840 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14841 w
->cursor
.y
= row
->y
+ dy
;
14843 if (w
== XWINDOW (selected_window
))
14845 if (!row
->continued_p
14846 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14849 this_line_buffer
= XBUFFER (w
->contents
);
14851 CHARPOS (this_line_start_pos
)
14852 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14853 BYTEPOS (this_line_start_pos
)
14854 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14856 CHARPOS (this_line_end_pos
)
14857 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14858 BYTEPOS (this_line_end_pos
)
14859 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14861 this_line_y
= w
->cursor
.y
;
14862 this_line_pixel_height
= row
->height
;
14863 this_line_vpos
= w
->cursor
.vpos
;
14864 this_line_start_x
= row
->x
;
14867 CHARPOS (this_line_start_pos
) = 0;
14874 /* Run window scroll functions, if any, for WINDOW with new window
14875 start STARTP. Sets the window start of WINDOW to that position.
14877 We assume that the window's buffer is really current. */
14879 static struct text_pos
14880 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14882 struct window
*w
= XWINDOW (window
);
14883 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14885 eassert (current_buffer
== XBUFFER (w
->contents
));
14887 if (!NILP (Vwindow_scroll_functions
))
14889 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14890 make_number (CHARPOS (startp
)));
14891 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14892 /* In case the hook functions switch buffers. */
14893 set_buffer_internal (XBUFFER (w
->contents
));
14900 /* Make sure the line containing the cursor is fully visible.
14901 A value of 1 means there is nothing to be done.
14902 (Either the line is fully visible, or it cannot be made so,
14903 or we cannot tell.)
14905 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14906 is higher than window.
14908 A value of 0 means the caller should do scrolling
14909 as if point had gone off the screen. */
14912 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14914 struct glyph_matrix
*matrix
;
14915 struct glyph_row
*row
;
14918 if (!make_cursor_line_fully_visible_p
)
14921 /* It's not always possible to find the cursor, e.g, when a window
14922 is full of overlay strings. Don't do anything in that case. */
14923 if (w
->cursor
.vpos
< 0)
14926 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14927 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14929 /* If the cursor row is not partially visible, there's nothing to do. */
14930 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14933 /* If the row the cursor is in is taller than the window's height,
14934 it's not clear what to do, so do nothing. */
14935 window_height
= window_box_height (w
);
14936 if (row
->height
>= window_height
)
14938 if (!force_p
|| MINI_WINDOW_P (w
)
14939 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14946 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14947 non-zero means only WINDOW is redisplayed in redisplay_internal.
14948 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14949 in redisplay_window to bring a partially visible line into view in
14950 the case that only the cursor has moved.
14952 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14953 last screen line's vertical height extends past the end of the screen.
14957 1 if scrolling succeeded
14959 0 if scrolling didn't find point.
14961 -1 if new fonts have been loaded so that we must interrupt
14962 redisplay, adjust glyph matrices, and try again. */
14968 SCROLLING_NEED_LARGER_MATRICES
14971 /* If scroll-conservatively is more than this, never recenter.
14973 If you change this, don't forget to update the doc string of
14974 `scroll-conservatively' and the Emacs manual. */
14975 #define SCROLL_LIMIT 100
14978 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14979 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14980 int temp_scroll_step
, int last_line_misfit
)
14982 struct window
*w
= XWINDOW (window
);
14983 struct frame
*f
= XFRAME (w
->frame
);
14984 struct text_pos pos
, startp
;
14986 int this_scroll_margin
, scroll_max
, rc
, height
;
14987 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14988 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14989 Lisp_Object aggressive
;
14990 /* We will never try scrolling more than this number of lines. */
14991 int scroll_limit
= SCROLL_LIMIT
;
14992 int frame_line_height
= default_line_pixel_height (w
);
14993 int window_total_lines
14994 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
14997 debug_method_add (w
, "try_scrolling");
15000 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15002 /* Compute scroll margin height in pixels. We scroll when point is
15003 within this distance from the top or bottom of the window. */
15004 if (scroll_margin
> 0)
15005 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15006 * frame_line_height
;
15008 this_scroll_margin
= 0;
15010 /* Force arg_scroll_conservatively to have a reasonable value, to
15011 avoid scrolling too far away with slow move_it_* functions. Note
15012 that the user can supply scroll-conservatively equal to
15013 `most-positive-fixnum', which can be larger than INT_MAX. */
15014 if (arg_scroll_conservatively
> scroll_limit
)
15016 arg_scroll_conservatively
= scroll_limit
+ 1;
15017 scroll_max
= scroll_limit
* frame_line_height
;
15019 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15020 /* Compute how much we should try to scroll maximally to bring
15021 point into view. */
15022 scroll_max
= (max (scroll_step
,
15023 max (arg_scroll_conservatively
, temp_scroll_step
))
15024 * frame_line_height
);
15025 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15026 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15027 /* We're trying to scroll because of aggressive scrolling but no
15028 scroll_step is set. Choose an arbitrary one. */
15029 scroll_max
= 10 * frame_line_height
;
15035 /* Decide whether to scroll down. */
15036 if (PT
> CHARPOS (startp
))
15038 int scroll_margin_y
;
15040 /* Compute the pixel ypos of the scroll margin, then move IT to
15041 either that ypos or PT, whichever comes first. */
15042 start_display (&it
, w
, startp
);
15043 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15044 - frame_line_height
* extra_scroll_margin_lines
;
15045 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15046 (MOVE_TO_POS
| MOVE_TO_Y
));
15048 if (PT
> CHARPOS (it
.current
.pos
))
15050 int y0
= line_bottom_y (&it
);
15051 /* Compute how many pixels below window bottom to stop searching
15052 for PT. This avoids costly search for PT that is far away if
15053 the user limited scrolling by a small number of lines, but
15054 always finds PT if scroll_conservatively is set to a large
15055 number, such as most-positive-fixnum. */
15056 int slack
= max (scroll_max
, 10 * frame_line_height
);
15057 int y_to_move
= it
.last_visible_y
+ slack
;
15059 /* Compute the distance from the scroll margin to PT or to
15060 the scroll limit, whichever comes first. This should
15061 include the height of the cursor line, to make that line
15063 move_it_to (&it
, PT
, -1, y_to_move
,
15064 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15065 dy
= line_bottom_y (&it
) - y0
;
15067 if (dy
> scroll_max
)
15068 return SCROLLING_FAILED
;
15077 /* Point is in or below the bottom scroll margin, so move the
15078 window start down. If scrolling conservatively, move it just
15079 enough down to make point visible. If scroll_step is set,
15080 move it down by scroll_step. */
15081 if (arg_scroll_conservatively
)
15083 = min (max (dy
, frame_line_height
),
15084 frame_line_height
* arg_scroll_conservatively
);
15085 else if (scroll_step
|| temp_scroll_step
)
15086 amount_to_scroll
= scroll_max
;
15089 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15090 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15091 if (NUMBERP (aggressive
))
15093 double float_amount
= XFLOATINT (aggressive
) * height
;
15094 int aggressive_scroll
= float_amount
;
15095 if (aggressive_scroll
== 0 && float_amount
> 0)
15096 aggressive_scroll
= 1;
15097 /* Don't let point enter the scroll margin near top of
15098 the window. This could happen if the value of
15099 scroll_up_aggressively is too large and there are
15100 non-zero margins, because scroll_up_aggressively
15101 means put point that fraction of window height
15102 _from_the_bottom_margin_. */
15103 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15104 aggressive_scroll
= height
- 2*this_scroll_margin
;
15105 amount_to_scroll
= dy
+ aggressive_scroll
;
15109 if (amount_to_scroll
<= 0)
15110 return SCROLLING_FAILED
;
15112 start_display (&it
, w
, startp
);
15113 if (arg_scroll_conservatively
<= scroll_limit
)
15114 move_it_vertically (&it
, amount_to_scroll
);
15117 /* Extra precision for users who set scroll-conservatively
15118 to a large number: make sure the amount we scroll
15119 the window start is never less than amount_to_scroll,
15120 which was computed as distance from window bottom to
15121 point. This matters when lines at window top and lines
15122 below window bottom have different height. */
15124 void *it1data
= NULL
;
15125 /* We use a temporary it1 because line_bottom_y can modify
15126 its argument, if it moves one line down; see there. */
15129 SAVE_IT (it1
, it
, it1data
);
15130 start_y
= line_bottom_y (&it1
);
15132 RESTORE_IT (&it
, &it
, it1data
);
15133 move_it_by_lines (&it
, 1);
15134 SAVE_IT (it1
, it
, it1data
);
15135 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15138 /* If STARTP is unchanged, move it down another screen line. */
15139 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15140 move_it_by_lines (&it
, 1);
15141 startp
= it
.current
.pos
;
15145 struct text_pos scroll_margin_pos
= startp
;
15148 /* See if point is inside the scroll margin at the top of the
15150 if (this_scroll_margin
)
15154 start_display (&it
, w
, startp
);
15155 y_start
= it
.current_y
;
15156 move_it_vertically (&it
, this_scroll_margin
);
15157 scroll_margin_pos
= it
.current
.pos
;
15158 /* If we didn't move enough before hitting ZV, request
15159 additional amount of scroll, to move point out of the
15161 if (IT_CHARPOS (it
) == ZV
15162 && it
.current_y
- y_start
< this_scroll_margin
)
15163 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15166 if (PT
< CHARPOS (scroll_margin_pos
))
15168 /* Point is in the scroll margin at the top of the window or
15169 above what is displayed in the window. */
15172 /* Compute the vertical distance from PT to the scroll
15173 margin position. Move as far as scroll_max allows, or
15174 one screenful, or 10 screen lines, whichever is largest.
15175 Give up if distance is greater than scroll_max or if we
15176 didn't reach the scroll margin position. */
15177 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15178 start_display (&it
, w
, pos
);
15180 y_to_move
= max (it
.last_visible_y
,
15181 max (scroll_max
, 10 * frame_line_height
));
15182 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15184 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15185 dy
= it
.current_y
- y0
;
15186 if (dy
> scroll_max
15187 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15188 return SCROLLING_FAILED
;
15190 /* Additional scroll for when ZV was too close to point. */
15193 /* Compute new window start. */
15194 start_display (&it
, w
, startp
);
15196 if (arg_scroll_conservatively
)
15197 amount_to_scroll
= max (dy
, frame_line_height
*
15198 max (scroll_step
, temp_scroll_step
));
15199 else if (scroll_step
|| temp_scroll_step
)
15200 amount_to_scroll
= scroll_max
;
15203 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15204 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15205 if (NUMBERP (aggressive
))
15207 double float_amount
= XFLOATINT (aggressive
) * height
;
15208 int aggressive_scroll
= float_amount
;
15209 if (aggressive_scroll
== 0 && float_amount
> 0)
15210 aggressive_scroll
= 1;
15211 /* Don't let point enter the scroll margin near
15212 bottom of the window, if the value of
15213 scroll_down_aggressively happens to be too
15215 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15216 aggressive_scroll
= height
- 2*this_scroll_margin
;
15217 amount_to_scroll
= dy
+ aggressive_scroll
;
15221 if (amount_to_scroll
<= 0)
15222 return SCROLLING_FAILED
;
15224 move_it_vertically_backward (&it
, amount_to_scroll
);
15225 startp
= it
.current
.pos
;
15229 /* Run window scroll functions. */
15230 startp
= run_window_scroll_functions (window
, startp
);
15232 /* Display the window. Give up if new fonts are loaded, or if point
15234 if (!try_window (window
, startp
, 0))
15235 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15236 else if (w
->cursor
.vpos
< 0)
15238 clear_glyph_matrix (w
->desired_matrix
);
15239 rc
= SCROLLING_FAILED
;
15243 /* Maybe forget recorded base line for line number display. */
15244 if (!just_this_one_p
15245 || current_buffer
->clip_changed
15246 || BEG_UNCHANGED
< CHARPOS (startp
))
15247 w
->base_line_number
= 0;
15249 /* If cursor ends up on a partially visible line,
15250 treat that as being off the bottom of the screen. */
15251 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15252 /* It's possible that the cursor is on the first line of the
15253 buffer, which is partially obscured due to a vscroll
15254 (Bug#7537). In that case, avoid looping forever. */
15255 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15257 clear_glyph_matrix (w
->desired_matrix
);
15258 ++extra_scroll_margin_lines
;
15261 rc
= SCROLLING_SUCCESS
;
15268 /* Compute a suitable window start for window W if display of W starts
15269 on a continuation line. Value is non-zero if a new window start
15272 The new window start will be computed, based on W's width, starting
15273 from the start of the continued line. It is the start of the
15274 screen line with the minimum distance from the old start W->start. */
15277 compute_window_start_on_continuation_line (struct window
*w
)
15279 struct text_pos pos
, start_pos
;
15280 int window_start_changed_p
= 0;
15282 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15284 /* If window start is on a continuation line... Window start may be
15285 < BEGV in case there's invisible text at the start of the
15286 buffer (M-x rmail, for example). */
15287 if (CHARPOS (start_pos
) > BEGV
15288 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15291 struct glyph_row
*row
;
15293 /* Handle the case that the window start is out of range. */
15294 if (CHARPOS (start_pos
) < BEGV
)
15295 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15296 else if (CHARPOS (start_pos
) > ZV
)
15297 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15299 /* Find the start of the continued line. This should be fast
15300 because find_newline is fast (newline cache). */
15301 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15302 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15303 row
, DEFAULT_FACE_ID
);
15304 reseat_at_previous_visible_line_start (&it
);
15306 /* If the line start is "too far" away from the window start,
15307 say it takes too much time to compute a new window start. */
15308 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15309 /* PXW: Do we need upper bounds here? */
15310 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15312 int min_distance
, distance
;
15314 /* Move forward by display lines to find the new window
15315 start. If window width was enlarged, the new start can
15316 be expected to be > the old start. If window width was
15317 decreased, the new window start will be < the old start.
15318 So, we're looking for the display line start with the
15319 minimum distance from the old window start. */
15320 pos
= it
.current
.pos
;
15321 min_distance
= INFINITY
;
15322 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15323 distance
< min_distance
)
15325 min_distance
= distance
;
15326 pos
= it
.current
.pos
;
15327 if (it
.line_wrap
== WORD_WRAP
)
15329 /* Under WORD_WRAP, move_it_by_lines is likely to
15330 overshoot and stop not at the first, but the
15331 second character from the left margin. So in
15332 that case, we need a more tight control on the X
15333 coordinate of the iterator than move_it_by_lines
15334 promises in its contract. The method is to first
15335 go to the last (rightmost) visible character of a
15336 line, then move to the leftmost character on the
15337 next line in a separate call. */
15338 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15339 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15340 move_it_to (&it
, ZV
, 0,
15341 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15342 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15345 move_it_by_lines (&it
, 1);
15348 /* Set the window start there. */
15349 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15350 window_start_changed_p
= 1;
15354 return window_start_changed_p
;
15358 /* Try cursor movement in case text has not changed in window WINDOW,
15359 with window start STARTP. Value is
15361 CURSOR_MOVEMENT_SUCCESS if successful
15363 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15365 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15366 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15367 we want to scroll as if scroll-step were set to 1. See the code.
15369 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15370 which case we have to abort this redisplay, and adjust matrices
15375 CURSOR_MOVEMENT_SUCCESS
,
15376 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15377 CURSOR_MOVEMENT_MUST_SCROLL
,
15378 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15382 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15384 struct window
*w
= XWINDOW (window
);
15385 struct frame
*f
= XFRAME (w
->frame
);
15386 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15389 if (inhibit_try_cursor_movement
)
15393 /* Previously, there was a check for Lisp integer in the
15394 if-statement below. Now, this field is converted to
15395 ptrdiff_t, thus zero means invalid position in a buffer. */
15396 eassert (w
->last_point
> 0);
15397 /* Likewise there was a check whether window_end_vpos is nil or larger
15398 than the window. Now window_end_vpos is int and so never nil, but
15399 let's leave eassert to check whether it fits in the window. */
15400 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15402 /* Handle case where text has not changed, only point, and it has
15403 not moved off the frame. */
15404 if (/* Point may be in this window. */
15405 PT
>= CHARPOS (startp
)
15406 /* Selective display hasn't changed. */
15407 && !current_buffer
->clip_changed
15408 /* Function force-mode-line-update is used to force a thorough
15409 redisplay. It sets either windows_or_buffers_changed or
15410 update_mode_lines. So don't take a shortcut here for these
15412 && !update_mode_lines
15413 && !windows_or_buffers_changed
15414 && !f
->cursor_type_changed
15415 && NILP (Vshow_trailing_whitespace
)
15416 /* This code is not used for mini-buffer for the sake of the case
15417 of redisplaying to replace an echo area message; since in
15418 that case the mini-buffer contents per se are usually
15419 unchanged. This code is of no real use in the mini-buffer
15420 since the handling of this_line_start_pos, etc., in redisplay
15421 handles the same cases. */
15422 && !EQ (window
, minibuf_window
)
15423 && (FRAME_WINDOW_P (f
)
15424 || !overlay_arrow_in_current_buffer_p ()))
15426 int this_scroll_margin
, top_scroll_margin
;
15427 struct glyph_row
*row
= NULL
;
15428 int frame_line_height
= default_line_pixel_height (w
);
15429 int window_total_lines
15430 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15433 debug_method_add (w
, "cursor movement");
15436 /* Scroll if point within this distance from the top or bottom
15437 of the window. This is a pixel value. */
15438 if (scroll_margin
> 0)
15440 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15441 this_scroll_margin
*= frame_line_height
;
15444 this_scroll_margin
= 0;
15446 top_scroll_margin
= this_scroll_margin
;
15447 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15448 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15450 /* Start with the row the cursor was displayed during the last
15451 not paused redisplay. Give up if that row is not valid. */
15452 if (w
->last_cursor_vpos
< 0
15453 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15454 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15457 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15458 if (row
->mode_line_p
)
15460 if (!row
->enabled_p
)
15461 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15464 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15466 int scroll_p
= 0, must_scroll
= 0;
15467 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15469 if (PT
> w
->last_point
)
15471 /* Point has moved forward. */
15472 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15473 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15475 eassert (row
->enabled_p
);
15479 /* If the end position of a row equals the start
15480 position of the next row, and PT is at that position,
15481 we would rather display cursor in the next line. */
15482 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15483 && MATRIX_ROW_END_CHARPOS (row
) == PT
15484 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15485 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15486 && !cursor_row_p (row
))
15489 /* If within the scroll margin, scroll. Note that
15490 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15491 the next line would be drawn, and that
15492 this_scroll_margin can be zero. */
15493 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15494 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15495 /* Line is completely visible last line in window
15496 and PT is to be set in the next line. */
15497 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15498 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15499 && !row
->ends_at_zv_p
15500 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15503 else if (PT
< w
->last_point
)
15505 /* Cursor has to be moved backward. Note that PT >=
15506 CHARPOS (startp) because of the outer if-statement. */
15507 while (!row
->mode_line_p
15508 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15509 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15510 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15511 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15512 row
> w
->current_matrix
->rows
15513 && (row
-1)->ends_in_newline_from_string_p
))))
15514 && (row
->y
> top_scroll_margin
15515 || CHARPOS (startp
) == BEGV
))
15517 eassert (row
->enabled_p
);
15521 /* Consider the following case: Window starts at BEGV,
15522 there is invisible, intangible text at BEGV, so that
15523 display starts at some point START > BEGV. It can
15524 happen that we are called with PT somewhere between
15525 BEGV and START. Try to handle that case. */
15526 if (row
< w
->current_matrix
->rows
15527 || row
->mode_line_p
)
15529 row
= w
->current_matrix
->rows
;
15530 if (row
->mode_line_p
)
15534 /* Due to newlines in overlay strings, we may have to
15535 skip forward over overlay strings. */
15536 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15537 && MATRIX_ROW_END_CHARPOS (row
) == PT
15538 && !cursor_row_p (row
))
15541 /* If within the scroll margin, scroll. */
15542 if (row
->y
< top_scroll_margin
15543 && CHARPOS (startp
) != BEGV
)
15548 /* Cursor did not move. So don't scroll even if cursor line
15549 is partially visible, as it was so before. */
15550 rc
= CURSOR_MOVEMENT_SUCCESS
;
15553 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15554 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15556 /* if PT is not in the glyph row, give up. */
15557 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15560 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15561 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15563 struct glyph_row
*row1
;
15565 /* If rows are bidi-reordered and point moved, back up
15566 until we find a row that does not belong to a
15567 continuation line. This is because we must consider
15568 all rows of a continued line as candidates for the
15569 new cursor positioning, since row start and end
15570 positions change non-linearly with vertical position
15572 /* FIXME: Revisit this when glyph ``spilling'' in
15573 continuation lines' rows is implemented for
15574 bidi-reordered rows. */
15575 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15576 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15579 /* If we hit the beginning of the displayed portion
15580 without finding the first row of a continued
15584 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15587 eassert (row
->enabled_p
);
15592 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15593 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15594 /* Make sure this isn't a header line by any chance, since
15595 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15596 && !row
->mode_line_p
15597 && make_cursor_line_fully_visible_p
)
15599 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15600 && !row
->ends_at_zv_p
15601 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15602 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15603 else if (row
->height
> window_box_height (w
))
15605 /* If we end up in a partially visible line, let's
15606 make it fully visible, except when it's taller
15607 than the window, in which case we can't do much
15610 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15614 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15615 if (!cursor_row_fully_visible_p (w
, 0, 1))
15616 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15618 rc
= CURSOR_MOVEMENT_SUCCESS
;
15622 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15623 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15624 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15626 /* With bidi-reordered rows, there could be more than
15627 one candidate row whose start and end positions
15628 occlude point. We need to let set_cursor_from_row
15629 find the best candidate. */
15630 /* FIXME: Revisit this when glyph ``spilling'' in
15631 continuation lines' rows is implemented for
15632 bidi-reordered rows. */
15637 int at_zv_p
= 0, exact_match_p
= 0;
15639 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15640 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15641 && cursor_row_p (row
))
15642 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15644 /* As soon as we've found the exact match for point,
15645 or the first suitable row whose ends_at_zv_p flag
15646 is set, we are done. */
15649 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15650 w
->cursor
.vpos
)->ends_at_zv_p
;
15652 && w
->cursor
.hpos
>= 0
15653 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15656 struct glyph_row
*candidate
=
15657 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15659 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15660 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15663 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15664 || (INTEGERP (g
->object
)
15665 && (g
->charpos
== PT
15666 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15668 if (at_zv_p
|| exact_match_p
)
15670 rc
= CURSOR_MOVEMENT_SUCCESS
;
15674 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15678 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15679 || row
->continued_p
)
15680 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15681 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15682 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15683 /* If we didn't find any candidate rows, or exited the
15684 loop before all the candidates were examined, signal
15685 to the caller that this method failed. */
15686 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15688 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15689 && !row
->continued_p
))
15690 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15692 rc
= CURSOR_MOVEMENT_SUCCESS
;
15698 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15700 rc
= CURSOR_MOVEMENT_SUCCESS
;
15705 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15706 && MATRIX_ROW_START_CHARPOS (row
) == PT
15707 && cursor_row_p (row
));
15715 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15719 set_vertical_scroll_bar (struct window
*w
)
15721 ptrdiff_t start
, end
, whole
;
15723 /* Calculate the start and end positions for the current window.
15724 At some point, it would be nice to choose between scrollbars
15725 which reflect the whole buffer size, with special markers
15726 indicating narrowing, and scrollbars which reflect only the
15729 Note that mini-buffers sometimes aren't displaying any text. */
15730 if (!MINI_WINDOW_P (w
)
15731 || (w
== XWINDOW (minibuf_window
)
15732 && NILP (echo_area_buffer
[0])))
15734 struct buffer
*buf
= XBUFFER (w
->contents
);
15735 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15736 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15737 /* I don't think this is guaranteed to be right. For the
15738 moment, we'll pretend it is. */
15739 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15743 if (whole
< (end
- start
))
15744 whole
= end
- start
;
15747 start
= end
= whole
= 0;
15749 /* Indicate what this scroll bar ought to be displaying now. */
15750 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15751 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15752 (w
, end
- start
, whole
, start
);
15756 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15757 selected_window is redisplayed.
15759 We can return without actually redisplaying the window if fonts has been
15760 changed on window's frame. In that case, redisplay_internal will retry. */
15763 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15765 struct window
*w
= XWINDOW (window
);
15766 struct frame
*f
= XFRAME (w
->frame
);
15767 struct buffer
*buffer
= XBUFFER (w
->contents
);
15768 struct buffer
*old
= current_buffer
;
15769 struct text_pos lpoint
, opoint
, startp
;
15770 int update_mode_line
;
15773 /* Record it now because it's overwritten. */
15774 bool current_matrix_up_to_date_p
= false;
15775 bool used_current_matrix_p
= false;
15776 /* This is less strict than current_matrix_up_to_date_p.
15777 It indicates that the buffer contents and narrowing are unchanged. */
15778 bool buffer_unchanged_p
= false;
15779 int temp_scroll_step
= 0;
15780 ptrdiff_t count
= SPECPDL_INDEX ();
15782 int centering_position
= -1;
15783 int last_line_misfit
= 0;
15784 ptrdiff_t beg_unchanged
, end_unchanged
;
15785 int frame_line_height
;
15787 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15791 *w
->desired_matrix
->method
= 0;
15794 if (!just_this_one_p
15795 && REDISPLAY_SOME_P ()
15798 && !buffer
->text
->redisplay
15799 && BUF_PT (buffer
) == w
->last_point
)
15802 /* Make sure that both W's markers are valid. */
15803 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15804 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15807 reconsider_clip_changes (w
);
15808 frame_line_height
= default_line_pixel_height (w
);
15810 /* Has the mode line to be updated? */
15811 update_mode_line
= (w
->update_mode_line
15812 || update_mode_lines
15813 || buffer
->clip_changed
15814 || buffer
->prevent_redisplay_optimizations_p
);
15816 if (!just_this_one_p
)
15817 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15818 cleverly elsewhere. */
15819 w
->must_be_updated_p
= true;
15821 if (MINI_WINDOW_P (w
))
15823 if (w
== XWINDOW (echo_area_window
)
15824 && !NILP (echo_area_buffer
[0]))
15826 if (update_mode_line
)
15827 /* We may have to update a tty frame's menu bar or a
15828 tool-bar. Example `M-x C-h C-h C-g'. */
15829 goto finish_menu_bars
;
15831 /* We've already displayed the echo area glyphs in this window. */
15832 goto finish_scroll_bars
;
15834 else if ((w
!= XWINDOW (minibuf_window
)
15835 || minibuf_level
== 0)
15836 /* When buffer is nonempty, redisplay window normally. */
15837 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15838 /* Quail displays non-mini buffers in minibuffer window.
15839 In that case, redisplay the window normally. */
15840 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15842 /* W is a mini-buffer window, but it's not active, so clear
15844 int yb
= window_text_bottom_y (w
);
15845 struct glyph_row
*row
;
15848 for (y
= 0, row
= w
->desired_matrix
->rows
;
15850 y
+= row
->height
, ++row
)
15851 blank_row (w
, row
, y
);
15852 goto finish_scroll_bars
;
15855 clear_glyph_matrix (w
->desired_matrix
);
15858 /* Otherwise set up data on this window; select its buffer and point
15860 /* Really select the buffer, for the sake of buffer-local
15862 set_buffer_internal_1 (XBUFFER (w
->contents
));
15864 current_matrix_up_to_date_p
15865 = (w
->window_end_valid
15866 && !current_buffer
->clip_changed
15867 && !current_buffer
->prevent_redisplay_optimizations_p
15868 && !window_outdated (w
));
15870 /* Run the window-bottom-change-functions
15871 if it is possible that the text on the screen has changed
15872 (either due to modification of the text, or any other reason). */
15873 if (!current_matrix_up_to_date_p
15874 && !NILP (Vwindow_text_change_functions
))
15876 safe_run_hooks (Qwindow_text_change_functions
);
15880 beg_unchanged
= BEG_UNCHANGED
;
15881 end_unchanged
= END_UNCHANGED
;
15883 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15885 specbind (Qinhibit_point_motion_hooks
, Qt
);
15888 = (w
->window_end_valid
15889 && !current_buffer
->clip_changed
15890 && !window_outdated (w
));
15892 /* When windows_or_buffers_changed is non-zero, we can't rely
15893 on the window end being valid, so set it to zero there. */
15894 if (windows_or_buffers_changed
)
15896 /* If window starts on a continuation line, maybe adjust the
15897 window start in case the window's width changed. */
15898 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15899 compute_window_start_on_continuation_line (w
);
15901 w
->window_end_valid
= false;
15902 /* If so, we also can't rely on current matrix
15903 and should not fool try_cursor_movement below. */
15904 current_matrix_up_to_date_p
= false;
15907 /* Some sanity checks. */
15908 CHECK_WINDOW_END (w
);
15909 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15911 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15914 if (mode_line_update_needed (w
))
15915 update_mode_line
= 1;
15917 /* Point refers normally to the selected window. For any other
15918 window, set up appropriate value. */
15919 if (!EQ (window
, selected_window
))
15921 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15922 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15926 new_pt_byte
= BEGV_BYTE
;
15927 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15929 else if (new_pt
> (ZV
- 1))
15932 new_pt_byte
= ZV_BYTE
;
15933 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15936 /* We don't use SET_PT so that the point-motion hooks don't run. */
15937 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15940 /* If any of the character widths specified in the display table
15941 have changed, invalidate the width run cache. It's true that
15942 this may be a bit late to catch such changes, but the rest of
15943 redisplay goes (non-fatally) haywire when the display table is
15944 changed, so why should we worry about doing any better? */
15945 if (current_buffer
->width_run_cache
15946 || (current_buffer
->base_buffer
15947 && current_buffer
->base_buffer
->width_run_cache
))
15949 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15951 if (! disptab_matches_widthtab
15952 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15954 struct buffer
*buf
= current_buffer
;
15956 if (buf
->base_buffer
)
15957 buf
= buf
->base_buffer
;
15958 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
15959 recompute_width_table (current_buffer
, disptab
);
15963 /* If window-start is screwed up, choose a new one. */
15964 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15967 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15969 /* If someone specified a new starting point but did not insist,
15970 check whether it can be used. */
15971 if (w
->optional_new_start
15972 && CHARPOS (startp
) >= BEGV
15973 && CHARPOS (startp
) <= ZV
)
15975 w
->optional_new_start
= 0;
15976 start_display (&it
, w
, startp
);
15977 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15978 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15979 if (IT_CHARPOS (it
) == PT
)
15980 w
->force_start
= 1;
15981 /* IT may overshoot PT if text at PT is invisible. */
15982 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15983 w
->force_start
= 1;
15988 /* Handle case where place to start displaying has been specified,
15989 unless the specified location is outside the accessible range. */
15990 if (w
->force_start
|| window_frozen_p (w
))
15992 /* We set this later on if we have to adjust point. */
15995 w
->force_start
= 0;
15997 w
->window_end_valid
= 0;
15999 /* Forget any recorded base line for line number display. */
16000 if (!buffer_unchanged_p
)
16001 w
->base_line_number
= 0;
16003 /* Redisplay the mode line. Select the buffer properly for that.
16004 Also, run the hook window-scroll-functions
16005 because we have scrolled. */
16006 /* Note, we do this after clearing force_start because
16007 if there's an error, it is better to forget about force_start
16008 than to get into an infinite loop calling the hook functions
16009 and having them get more errors. */
16010 if (!update_mode_line
16011 || ! NILP (Vwindow_scroll_functions
))
16013 update_mode_line
= 1;
16014 w
->update_mode_line
= 1;
16015 startp
= run_window_scroll_functions (window
, startp
);
16018 if (CHARPOS (startp
) < BEGV
)
16019 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16020 else if (CHARPOS (startp
) > ZV
)
16021 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16023 /* Redisplay, then check if cursor has been set during the
16024 redisplay. Give up if new fonts were loaded. */
16025 /* We used to issue a CHECK_MARGINS argument to try_window here,
16026 but this causes scrolling to fail when point begins inside
16027 the scroll margin (bug#148) -- cyd */
16028 if (!try_window (window
, startp
, 0))
16030 w
->force_start
= 1;
16031 clear_glyph_matrix (w
->desired_matrix
);
16032 goto need_larger_matrices
;
16035 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
16037 /* If point does not appear, try to move point so it does
16038 appear. The desired matrix has been built above, so we
16039 can use it here. */
16040 new_vpos
= window_box_height (w
) / 2;
16043 if (!cursor_row_fully_visible_p (w
, 0, 0))
16045 /* Point does appear, but on a line partly visible at end of window.
16046 Move it back to a fully-visible line. */
16047 new_vpos
= window_box_height (w
);
16049 else if (w
->cursor
.vpos
>= 0)
16051 /* Some people insist on not letting point enter the scroll
16052 margin, even though this part handles windows that didn't
16054 int window_total_lines
16055 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16056 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16057 int pixel_margin
= margin
* frame_line_height
;
16058 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16060 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16061 below, which finds the row to move point to, advances by
16062 the Y coordinate of the _next_ row, see the definition of
16063 MATRIX_ROW_BOTTOM_Y. */
16064 if (w
->cursor
.vpos
< margin
+ header_line
)
16066 w
->cursor
.vpos
= -1;
16067 clear_glyph_matrix (w
->desired_matrix
);
16068 goto try_to_scroll
;
16072 int window_height
= window_box_height (w
);
16075 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16076 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16078 w
->cursor
.vpos
= -1;
16079 clear_glyph_matrix (w
->desired_matrix
);
16080 goto try_to_scroll
;
16085 /* If we need to move point for either of the above reasons,
16086 now actually do it. */
16089 struct glyph_row
*row
;
16091 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16092 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16095 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16096 MATRIX_ROW_START_BYTEPOS (row
));
16098 if (w
!= XWINDOW (selected_window
))
16099 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16100 else if (current_buffer
== old
)
16101 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16103 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16105 /* If we are highlighting the region, then we just changed
16106 the region, so redisplay to show it. */
16107 /* FIXME: We need to (re)run pre-redisplay-function! */
16108 /* if (markpos_of_region () >= 0)
16110 clear_glyph_matrix (w->desired_matrix);
16111 if (!try_window (window, startp, 0))
16112 goto need_larger_matrices;
16118 debug_method_add (w
, "forced window start");
16123 /* Handle case where text has not changed, only point, and it has
16124 not moved off the frame, and we are not retrying after hscroll.
16125 (current_matrix_up_to_date_p is nonzero when retrying.) */
16126 if (current_matrix_up_to_date_p
16127 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16128 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16132 case CURSOR_MOVEMENT_SUCCESS
:
16133 used_current_matrix_p
= 1;
16136 case CURSOR_MOVEMENT_MUST_SCROLL
:
16137 goto try_to_scroll
;
16143 /* If current starting point was originally the beginning of a line
16144 but no longer is, find a new starting point. */
16145 else if (w
->start_at_line_beg
16146 && !(CHARPOS (startp
) <= BEGV
16147 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16150 debug_method_add (w
, "recenter 1");
16155 /* Try scrolling with try_window_id. Value is > 0 if update has
16156 been done, it is -1 if we know that the same window start will
16157 not work. It is 0 if unsuccessful for some other reason. */
16158 else if ((tem
= try_window_id (w
)) != 0)
16161 debug_method_add (w
, "try_window_id %d", tem
);
16164 if (f
->fonts_changed
)
16165 goto need_larger_matrices
;
16169 /* Otherwise try_window_id has returned -1 which means that we
16170 don't want the alternative below this comment to execute. */
16172 else if (CHARPOS (startp
) >= BEGV
16173 && CHARPOS (startp
) <= ZV
16174 && PT
>= CHARPOS (startp
)
16175 && (CHARPOS (startp
) < ZV
16176 /* Avoid starting at end of buffer. */
16177 || CHARPOS (startp
) == BEGV
16178 || !window_outdated (w
)))
16180 int d1
, d2
, d3
, d4
, d5
, d6
;
16182 /* If first window line is a continuation line, and window start
16183 is inside the modified region, but the first change is before
16184 current window start, we must select a new window start.
16186 However, if this is the result of a down-mouse event (e.g. by
16187 extending the mouse-drag-overlay), we don't want to select a
16188 new window start, since that would change the position under
16189 the mouse, resulting in an unwanted mouse-movement rather
16190 than a simple mouse-click. */
16191 if (!w
->start_at_line_beg
16192 && NILP (do_mouse_tracking
)
16193 && CHARPOS (startp
) > BEGV
16194 && CHARPOS (startp
) > BEG
+ beg_unchanged
16195 && CHARPOS (startp
) <= Z
- end_unchanged
16196 /* Even if w->start_at_line_beg is nil, a new window may
16197 start at a line_beg, since that's how set_buffer_window
16198 sets it. So, we need to check the return value of
16199 compute_window_start_on_continuation_line. (See also
16201 && XMARKER (w
->start
)->buffer
== current_buffer
16202 && compute_window_start_on_continuation_line (w
)
16203 /* It doesn't make sense to force the window start like we
16204 do at label force_start if it is already known that point
16205 will not be visible in the resulting window, because
16206 doing so will move point from its correct position
16207 instead of scrolling the window to bring point into view.
16209 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
16211 w
->force_start
= 1;
16212 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16217 debug_method_add (w
, "same window start");
16220 /* Try to redisplay starting at same place as before.
16221 If point has not moved off frame, accept the results. */
16222 if (!current_matrix_up_to_date_p
16223 /* Don't use try_window_reusing_current_matrix in this case
16224 because a window scroll function can have changed the
16226 || !NILP (Vwindow_scroll_functions
)
16227 || MINI_WINDOW_P (w
)
16228 || !(used_current_matrix_p
16229 = try_window_reusing_current_matrix (w
)))
16231 IF_DEBUG (debug_method_add (w
, "1"));
16232 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16233 /* -1 means we need to scroll.
16234 0 means we need new matrices, but fonts_changed
16235 is set in that case, so we will detect it below. */
16236 goto try_to_scroll
;
16239 if (f
->fonts_changed
)
16240 goto need_larger_matrices
;
16242 if (w
->cursor
.vpos
>= 0)
16244 if (!just_this_one_p
16245 || current_buffer
->clip_changed
16246 || BEG_UNCHANGED
< CHARPOS (startp
))
16247 /* Forget any recorded base line for line number display. */
16248 w
->base_line_number
= 0;
16250 if (!cursor_row_fully_visible_p (w
, 1, 0))
16252 clear_glyph_matrix (w
->desired_matrix
);
16253 last_line_misfit
= 1;
16255 /* Drop through and scroll. */
16260 clear_glyph_matrix (w
->desired_matrix
);
16265 /* Redisplay the mode line. Select the buffer properly for that. */
16266 if (!update_mode_line
)
16268 update_mode_line
= 1;
16269 w
->update_mode_line
= 1;
16272 /* Try to scroll by specified few lines. */
16273 if ((scroll_conservatively
16274 || emacs_scroll_step
16275 || temp_scroll_step
16276 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16277 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16278 && CHARPOS (startp
) >= BEGV
16279 && CHARPOS (startp
) <= ZV
)
16281 /* The function returns -1 if new fonts were loaded, 1 if
16282 successful, 0 if not successful. */
16283 int ss
= try_scrolling (window
, just_this_one_p
,
16284 scroll_conservatively
,
16286 temp_scroll_step
, last_line_misfit
);
16289 case SCROLLING_SUCCESS
:
16292 case SCROLLING_NEED_LARGER_MATRICES
:
16293 goto need_larger_matrices
;
16295 case SCROLLING_FAILED
:
16303 /* Finally, just choose a place to start which positions point
16304 according to user preferences. */
16309 debug_method_add (w
, "recenter");
16312 /* Forget any previously recorded base line for line number display. */
16313 if (!buffer_unchanged_p
)
16314 w
->base_line_number
= 0;
16316 /* Determine the window start relative to point. */
16317 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16318 it
.current_y
= it
.last_visible_y
;
16319 if (centering_position
< 0)
16321 int window_total_lines
16322 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16325 ? min (scroll_margin
, window_total_lines
/ 4)
16327 ptrdiff_t margin_pos
= CHARPOS (startp
);
16328 Lisp_Object aggressive
;
16331 /* If there is a scroll margin at the top of the window, find
16332 its character position. */
16334 /* Cannot call start_display if startp is not in the
16335 accessible region of the buffer. This can happen when we
16336 have just switched to a different buffer and/or changed
16337 its restriction. In that case, startp is initialized to
16338 the character position 1 (BEGV) because we did not yet
16339 have chance to display the buffer even once. */
16340 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16343 void *it1data
= NULL
;
16345 SAVE_IT (it1
, it
, it1data
);
16346 start_display (&it1
, w
, startp
);
16347 move_it_vertically (&it1
, margin
* frame_line_height
);
16348 margin_pos
= IT_CHARPOS (it1
);
16349 RESTORE_IT (&it
, &it
, it1data
);
16351 scrolling_up
= PT
> margin_pos
;
16354 ? BVAR (current_buffer
, scroll_up_aggressively
)
16355 : BVAR (current_buffer
, scroll_down_aggressively
);
16357 if (!MINI_WINDOW_P (w
)
16358 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16362 /* Setting scroll-conservatively overrides
16363 scroll-*-aggressively. */
16364 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16366 double float_amount
= XFLOATINT (aggressive
);
16368 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16369 if (pt_offset
== 0 && float_amount
> 0)
16371 if (pt_offset
&& margin
> 0)
16374 /* Compute how much to move the window start backward from
16375 point so that point will be displayed where the user
16379 centering_position
= it
.last_visible_y
;
16381 centering_position
-= pt_offset
;
16382 centering_position
-=
16383 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16384 + WINDOW_HEADER_LINE_HEIGHT (w
);
16385 /* Don't let point enter the scroll margin near top of
16387 if (centering_position
< margin
* frame_line_height
)
16388 centering_position
= margin
* frame_line_height
;
16391 centering_position
= margin
* frame_line_height
+ pt_offset
;
16394 /* Set the window start half the height of the window backward
16396 centering_position
= window_box_height (w
) / 2;
16398 move_it_vertically_backward (&it
, centering_position
);
16400 eassert (IT_CHARPOS (it
) >= BEGV
);
16402 /* The function move_it_vertically_backward may move over more
16403 than the specified y-distance. If it->w is small, e.g. a
16404 mini-buffer window, we may end up in front of the window's
16405 display area. Start displaying at the start of the line
16406 containing PT in this case. */
16407 if (it
.current_y
<= 0)
16409 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16410 move_it_vertically_backward (&it
, 0);
16414 it
.current_x
= it
.hpos
= 0;
16416 /* Set the window start position here explicitly, to avoid an
16417 infinite loop in case the functions in window-scroll-functions
16419 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16421 /* Run scroll hooks. */
16422 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16424 /* Redisplay the window. */
16425 if (!current_matrix_up_to_date_p
16426 || windows_or_buffers_changed
16427 || f
->cursor_type_changed
16428 /* Don't use try_window_reusing_current_matrix in this case
16429 because it can have changed the buffer. */
16430 || !NILP (Vwindow_scroll_functions
)
16431 || !just_this_one_p
16432 || MINI_WINDOW_P (w
)
16433 || !(used_current_matrix_p
16434 = try_window_reusing_current_matrix (w
)))
16435 try_window (window
, startp
, 0);
16437 /* If new fonts have been loaded (due to fontsets), give up. We
16438 have to start a new redisplay since we need to re-adjust glyph
16440 if (f
->fonts_changed
)
16441 goto need_larger_matrices
;
16443 /* If cursor did not appear assume that the middle of the window is
16444 in the first line of the window. Do it again with the next line.
16445 (Imagine a window of height 100, displaying two lines of height
16446 60. Moving back 50 from it->last_visible_y will end in the first
16448 if (w
->cursor
.vpos
< 0)
16450 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16452 clear_glyph_matrix (w
->desired_matrix
);
16453 move_it_by_lines (&it
, 1);
16454 try_window (window
, it
.current
.pos
, 0);
16456 else if (PT
< IT_CHARPOS (it
))
16458 clear_glyph_matrix (w
->desired_matrix
);
16459 move_it_by_lines (&it
, -1);
16460 try_window (window
, it
.current
.pos
, 0);
16464 /* Not much we can do about it. */
16468 /* Consider the following case: Window starts at BEGV, there is
16469 invisible, intangible text at BEGV, so that display starts at
16470 some point START > BEGV. It can happen that we are called with
16471 PT somewhere between BEGV and START. Try to handle that case,
16472 and similar ones. */
16473 if (w
->cursor
.vpos
< 0)
16475 /* First, try locating the proper glyph row for PT. */
16476 struct glyph_row
*row
=
16477 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16479 /* Sometimes point is at the beginning of invisible text that is
16480 before the 1st character displayed in the row. In that case,
16481 row_containing_pos fails to find the row, because no glyphs
16482 with appropriate buffer positions are present in the row.
16483 Therefore, we next try to find the row which shows the 1st
16484 position after the invisible text. */
16488 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16491 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16494 Lisp_Object invis_end
=
16495 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16498 if (NATNUMP (invis_end
))
16499 alt_pos
= XFASTINT (invis_end
);
16502 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16506 /* Finally, fall back on the first row of the window after the
16507 header line (if any). This is slightly better than not
16508 displaying the cursor at all. */
16511 row
= w
->current_matrix
->rows
;
16512 if (row
->mode_line_p
)
16515 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16518 if (!cursor_row_fully_visible_p (w
, 0, 0))
16520 /* If vscroll is enabled, disable it and try again. */
16524 clear_glyph_matrix (w
->desired_matrix
);
16528 /* Users who set scroll-conservatively to a large number want
16529 point just above/below the scroll margin. If we ended up
16530 with point's row partially visible, move the window start to
16531 make that row fully visible and out of the margin. */
16532 if (scroll_conservatively
> SCROLL_LIMIT
)
16534 int window_total_lines
16535 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16538 ? min (scroll_margin
, window_total_lines
/ 4)
16540 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16542 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16543 clear_glyph_matrix (w
->desired_matrix
);
16544 if (1 == try_window (window
, it
.current
.pos
,
16545 TRY_WINDOW_CHECK_MARGINS
))
16549 /* If centering point failed to make the whole line visible,
16550 put point at the top instead. That has to make the whole line
16551 visible, if it can be done. */
16552 if (centering_position
== 0)
16555 clear_glyph_matrix (w
->desired_matrix
);
16556 centering_position
= 0;
16562 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16563 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16564 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16566 /* Display the mode line, if we must. */
16567 if ((update_mode_line
16568 /* If window not full width, must redo its mode line
16569 if (a) the window to its side is being redone and
16570 (b) we do a frame-based redisplay. This is a consequence
16571 of how inverted lines are drawn in frame-based redisplay. */
16572 || (!just_this_one_p
16573 && !FRAME_WINDOW_P (f
)
16574 && !WINDOW_FULL_WIDTH_P (w
))
16575 /* Line number to display. */
16576 || w
->base_line_pos
> 0
16577 /* Column number is displayed and different from the one displayed. */
16578 || (w
->column_number_displayed
!= -1
16579 && (w
->column_number_displayed
!= current_column ())))
16580 /* This means that the window has a mode line. */
16581 && (WINDOW_WANTS_MODELINE_P (w
)
16582 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16585 display_mode_lines (w
);
16587 /* If mode line height has changed, arrange for a thorough
16588 immediate redisplay using the correct mode line height. */
16589 if (WINDOW_WANTS_MODELINE_P (w
)
16590 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16592 f
->fonts_changed
= 1;
16593 w
->mode_line_height
= -1;
16594 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16595 = DESIRED_MODE_LINE_HEIGHT (w
);
16598 /* If header line height has changed, arrange for a thorough
16599 immediate redisplay using the correct header line height. */
16600 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16601 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16603 f
->fonts_changed
= 1;
16604 w
->header_line_height
= -1;
16605 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16606 = DESIRED_HEADER_LINE_HEIGHT (w
);
16609 if (f
->fonts_changed
)
16610 goto need_larger_matrices
;
16613 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16615 w
->base_line_pos
= 0;
16616 w
->base_line_number
= 0;
16621 /* When we reach a frame's selected window, redo the frame's menu bar. */
16622 if (update_mode_line
16623 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16625 int redisplay_menu_p
= 0;
16627 if (FRAME_WINDOW_P (f
))
16629 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16630 || defined (HAVE_NS) || defined (USE_GTK)
16631 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16633 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16637 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16639 if (redisplay_menu_p
)
16640 display_menu_bar (w
);
16642 #ifdef HAVE_WINDOW_SYSTEM
16643 if (FRAME_WINDOW_P (f
))
16645 #if defined (USE_GTK) || defined (HAVE_NS)
16646 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16647 redisplay_tool_bar (f
);
16649 if (WINDOWP (f
->tool_bar_window
)
16650 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16651 || !NILP (Vauto_resize_tool_bars
))
16652 && redisplay_tool_bar (f
))
16653 ignore_mouse_drag_p
= 1;
16659 #ifdef HAVE_WINDOW_SYSTEM
16660 if (FRAME_WINDOW_P (f
)
16661 && update_window_fringes (w
, (just_this_one_p
16662 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16663 || w
->pseudo_window_p
)))
16667 if (draw_window_fringes (w
, 1))
16669 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16670 x_draw_right_divider (w
);
16672 x_draw_vertical_border (w
);
16678 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16679 x_draw_bottom_divider (w
);
16680 #endif /* HAVE_WINDOW_SYSTEM */
16682 /* We go to this label, with fonts_changed set, if it is
16683 necessary to try again using larger glyph matrices.
16684 We have to redeem the scroll bar even in this case,
16685 because the loop in redisplay_internal expects that. */
16686 need_larger_matrices
:
16688 finish_scroll_bars
:
16690 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16692 /* Set the thumb's position and size. */
16693 set_vertical_scroll_bar (w
);
16695 /* Note that we actually used the scroll bar attached to this
16696 window, so it shouldn't be deleted at the end of redisplay. */
16697 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16698 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16701 /* Restore current_buffer and value of point in it. The window
16702 update may have changed the buffer, so first make sure `opoint'
16703 is still valid (Bug#6177). */
16704 if (CHARPOS (opoint
) < BEGV
)
16705 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16706 else if (CHARPOS (opoint
) > ZV
)
16707 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16709 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16711 set_buffer_internal_1 (old
);
16712 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16713 shorter. This can be caused by log truncation in *Messages*. */
16714 if (CHARPOS (lpoint
) <= ZV
)
16715 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16717 unbind_to (count
, Qnil
);
16721 /* Build the complete desired matrix of WINDOW with a window start
16722 buffer position POS.
16724 Value is 1 if successful. It is zero if fonts were loaded during
16725 redisplay which makes re-adjusting glyph matrices necessary, and -1
16726 if point would appear in the scroll margins.
16727 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16728 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16732 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16734 struct window
*w
= XWINDOW (window
);
16736 struct glyph_row
*last_text_row
= NULL
;
16737 struct frame
*f
= XFRAME (w
->frame
);
16738 int frame_line_height
= default_line_pixel_height (w
);
16740 /* Make POS the new window start. */
16741 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16743 /* Mark cursor position as unknown. No overlay arrow seen. */
16744 w
->cursor
.vpos
= -1;
16745 overlay_arrow_seen
= 0;
16747 /* Initialize iterator and info to start at POS. */
16748 start_display (&it
, w
, pos
);
16750 /* Display all lines of W. */
16751 while (it
.current_y
< it
.last_visible_y
)
16753 if (display_line (&it
))
16754 last_text_row
= it
.glyph_row
- 1;
16755 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16759 /* Don't let the cursor end in the scroll margins. */
16760 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16761 && !MINI_WINDOW_P (w
))
16763 int this_scroll_margin
;
16764 int window_total_lines
16765 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16767 if (scroll_margin
> 0)
16769 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16770 this_scroll_margin
*= frame_line_height
;
16773 this_scroll_margin
= 0;
16775 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16776 && w
->cursor
.y
< this_scroll_margin
16777 && CHARPOS (pos
) > BEGV
16778 && IT_CHARPOS (it
) < ZV
)
16779 /* rms: considering make_cursor_line_fully_visible_p here
16780 seems to give wrong results. We don't want to recenter
16781 when the last line is partly visible, we want to allow
16782 that case to be handled in the usual way. */
16783 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16785 w
->cursor
.vpos
= -1;
16786 clear_glyph_matrix (w
->desired_matrix
);
16791 /* If bottom moved off end of frame, change mode line percentage. */
16792 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16793 w
->update_mode_line
= 1;
16795 /* Set window_end_pos to the offset of the last character displayed
16796 on the window from the end of current_buffer. Set
16797 window_end_vpos to its row number. */
16800 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16801 adjust_window_ends (w
, last_text_row
, 0);
16803 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16804 w
->window_end_vpos
)));
16808 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16809 w
->window_end_pos
= Z
- ZV
;
16810 w
->window_end_vpos
= 0;
16813 /* But that is not valid info until redisplay finishes. */
16814 w
->window_end_valid
= 0;
16820 /************************************************************************
16821 Window redisplay reusing current matrix when buffer has not changed
16822 ************************************************************************/
16824 /* Try redisplay of window W showing an unchanged buffer with a
16825 different window start than the last time it was displayed by
16826 reusing its current matrix. Value is non-zero if successful.
16827 W->start is the new window start. */
16830 try_window_reusing_current_matrix (struct window
*w
)
16832 struct frame
*f
= XFRAME (w
->frame
);
16833 struct glyph_row
*bottom_row
;
16836 struct text_pos start
, new_start
;
16837 int nrows_scrolled
, i
;
16838 struct glyph_row
*last_text_row
;
16839 struct glyph_row
*last_reused_text_row
;
16840 struct glyph_row
*start_row
;
16841 int start_vpos
, min_y
, max_y
;
16844 if (inhibit_try_window_reusing
)
16848 if (/* This function doesn't handle terminal frames. */
16849 !FRAME_WINDOW_P (f
)
16850 /* Don't try to reuse the display if windows have been split
16852 || windows_or_buffers_changed
16853 || f
->cursor_type_changed
)
16856 /* Can't do this if showing trailing whitespace. */
16857 if (!NILP (Vshow_trailing_whitespace
))
16860 /* If top-line visibility has changed, give up. */
16861 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16862 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16865 /* Give up if old or new display is scrolled vertically. We could
16866 make this function handle this, but right now it doesn't. */
16867 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16868 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16871 /* The variable new_start now holds the new window start. The old
16872 start `start' can be determined from the current matrix. */
16873 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16874 start
= start_row
->minpos
;
16875 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16877 /* Clear the desired matrix for the display below. */
16878 clear_glyph_matrix (w
->desired_matrix
);
16880 if (CHARPOS (new_start
) <= CHARPOS (start
))
16882 /* Don't use this method if the display starts with an ellipsis
16883 displayed for invisible text. It's not easy to handle that case
16884 below, and it's certainly not worth the effort since this is
16885 not a frequent case. */
16886 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16889 IF_DEBUG (debug_method_add (w
, "twu1"));
16891 /* Display up to a row that can be reused. The variable
16892 last_text_row is set to the last row displayed that displays
16893 text. Note that it.vpos == 0 if or if not there is a
16894 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16895 start_display (&it
, w
, new_start
);
16896 w
->cursor
.vpos
= -1;
16897 last_text_row
= last_reused_text_row
= NULL
;
16899 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
16901 /* If we have reached into the characters in the START row,
16902 that means the line boundaries have changed. So we
16903 can't start copying with the row START. Maybe it will
16904 work to start copying with the following row. */
16905 while (IT_CHARPOS (it
) > CHARPOS (start
))
16907 /* Advance to the next row as the "start". */
16909 start
= start_row
->minpos
;
16910 /* If there are no more rows to try, or just one, give up. */
16911 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16912 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16913 || CHARPOS (start
) == ZV
)
16915 clear_glyph_matrix (w
->desired_matrix
);
16919 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16921 /* If we have reached alignment, we can copy the rest of the
16923 if (IT_CHARPOS (it
) == CHARPOS (start
)
16924 /* Don't accept "alignment" inside a display vector,
16925 since start_row could have started in the middle of
16926 that same display vector (thus their character
16927 positions match), and we have no way of telling if
16928 that is the case. */
16929 && it
.current
.dpvec_index
< 0)
16932 if (display_line (&it
))
16933 last_text_row
= it
.glyph_row
- 1;
16937 /* A value of current_y < last_visible_y means that we stopped
16938 at the previous window start, which in turn means that we
16939 have at least one reusable row. */
16940 if (it
.current_y
< it
.last_visible_y
)
16942 struct glyph_row
*row
;
16944 /* IT.vpos always starts from 0; it counts text lines. */
16945 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16947 /* Find PT if not already found in the lines displayed. */
16948 if (w
->cursor
.vpos
< 0)
16950 int dy
= it
.current_y
- start_row
->y
;
16952 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16953 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16955 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16956 dy
, nrows_scrolled
);
16959 clear_glyph_matrix (w
->desired_matrix
);
16964 /* Scroll the display. Do it before the current matrix is
16965 changed. The problem here is that update has not yet
16966 run, i.e. part of the current matrix is not up to date.
16967 scroll_run_hook will clear the cursor, and use the
16968 current matrix to get the height of the row the cursor is
16970 run
.current_y
= start_row
->y
;
16971 run
.desired_y
= it
.current_y
;
16972 run
.height
= it
.last_visible_y
- it
.current_y
;
16974 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16977 FRAME_RIF (f
)->update_window_begin_hook (w
);
16978 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16979 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16980 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16984 /* Shift current matrix down by nrows_scrolled lines. */
16985 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16986 rotate_matrix (w
->current_matrix
,
16988 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16991 /* Disable lines that must be updated. */
16992 for (i
= 0; i
< nrows_scrolled
; ++i
)
16993 (start_row
+ i
)->enabled_p
= false;
16995 /* Re-compute Y positions. */
16996 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16997 max_y
= it
.last_visible_y
;
16998 for (row
= start_row
+ nrows_scrolled
;
17002 row
->y
= it
.current_y
;
17003 row
->visible_height
= row
->height
;
17005 if (row
->y
< min_y
)
17006 row
->visible_height
-= min_y
- row
->y
;
17007 if (row
->y
+ row
->height
> max_y
)
17008 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17009 if (row
->fringe_bitmap_periodic_p
)
17010 row
->redraw_fringe_bitmaps_p
= 1;
17012 it
.current_y
+= row
->height
;
17014 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17015 last_reused_text_row
= row
;
17016 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17020 /* Disable lines in the current matrix which are now
17021 below the window. */
17022 for (++row
; row
< bottom_row
; ++row
)
17023 row
->enabled_p
= row
->mode_line_p
= 0;
17026 /* Update window_end_pos etc.; last_reused_text_row is the last
17027 reused row from the current matrix containing text, if any.
17028 The value of last_text_row is the last displayed line
17029 containing text. */
17030 if (last_reused_text_row
)
17031 adjust_window_ends (w
, last_reused_text_row
, 1);
17032 else if (last_text_row
)
17033 adjust_window_ends (w
, last_text_row
, 0);
17036 /* This window must be completely empty. */
17037 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17038 w
->window_end_pos
= Z
- ZV
;
17039 w
->window_end_vpos
= 0;
17041 w
->window_end_valid
= 0;
17043 /* Update hint: don't try scrolling again in update_window. */
17044 w
->desired_matrix
->no_scrolling_p
= 1;
17047 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17051 else if (CHARPOS (new_start
) > CHARPOS (start
))
17053 struct glyph_row
*pt_row
, *row
;
17054 struct glyph_row
*first_reusable_row
;
17055 struct glyph_row
*first_row_to_display
;
17057 int yb
= window_text_bottom_y (w
);
17059 /* Find the row starting at new_start, if there is one. Don't
17060 reuse a partially visible line at the end. */
17061 first_reusable_row
= start_row
;
17062 while (first_reusable_row
->enabled_p
17063 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17064 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17065 < CHARPOS (new_start
)))
17066 ++first_reusable_row
;
17068 /* Give up if there is no row to reuse. */
17069 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17070 || !first_reusable_row
->enabled_p
17071 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17072 != CHARPOS (new_start
)))
17075 /* We can reuse fully visible rows beginning with
17076 first_reusable_row to the end of the window. Set
17077 first_row_to_display to the first row that cannot be reused.
17078 Set pt_row to the row containing point, if there is any. */
17080 for (first_row_to_display
= first_reusable_row
;
17081 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17082 ++first_row_to_display
)
17084 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17085 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17086 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17087 && first_row_to_display
->ends_at_zv_p
17088 && pt_row
== NULL
)))
17089 pt_row
= first_row_to_display
;
17092 /* Start displaying at the start of first_row_to_display. */
17093 eassert (first_row_to_display
->y
< yb
);
17094 init_to_row_start (&it
, w
, first_row_to_display
);
17096 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17098 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17100 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17101 + WINDOW_HEADER_LINE_HEIGHT (w
));
17103 /* Display lines beginning with first_row_to_display in the
17104 desired matrix. Set last_text_row to the last row displayed
17105 that displays text. */
17106 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17107 if (pt_row
== NULL
)
17108 w
->cursor
.vpos
= -1;
17109 last_text_row
= NULL
;
17110 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17111 if (display_line (&it
))
17112 last_text_row
= it
.glyph_row
- 1;
17114 /* If point is in a reused row, adjust y and vpos of the cursor
17118 w
->cursor
.vpos
-= nrows_scrolled
;
17119 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17122 /* Give up if point isn't in a row displayed or reused. (This
17123 also handles the case where w->cursor.vpos < nrows_scrolled
17124 after the calls to display_line, which can happen with scroll
17125 margins. See bug#1295.) */
17126 if (w
->cursor
.vpos
< 0)
17128 clear_glyph_matrix (w
->desired_matrix
);
17132 /* Scroll the display. */
17133 run
.current_y
= first_reusable_row
->y
;
17134 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17135 run
.height
= it
.last_visible_y
- run
.current_y
;
17136 dy
= run
.current_y
- run
.desired_y
;
17141 FRAME_RIF (f
)->update_window_begin_hook (w
);
17142 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17143 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17144 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17148 /* Adjust Y positions of reused rows. */
17149 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17150 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17151 max_y
= it
.last_visible_y
;
17152 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17155 row
->visible_height
= row
->height
;
17156 if (row
->y
< min_y
)
17157 row
->visible_height
-= min_y
- row
->y
;
17158 if (row
->y
+ row
->height
> max_y
)
17159 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17160 if (row
->fringe_bitmap_periodic_p
)
17161 row
->redraw_fringe_bitmaps_p
= 1;
17164 /* Scroll the current matrix. */
17165 eassert (nrows_scrolled
> 0);
17166 rotate_matrix (w
->current_matrix
,
17168 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17171 /* Disable rows not reused. */
17172 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17173 row
->enabled_p
= false;
17175 /* Point may have moved to a different line, so we cannot assume that
17176 the previous cursor position is valid; locate the correct row. */
17179 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17181 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17182 && !row
->ends_at_zv_p
;
17186 w
->cursor
.y
= row
->y
;
17188 if (row
< bottom_row
)
17190 /* Can't simply scan the row for point with
17191 bidi-reordered glyph rows. Let set_cursor_from_row
17192 figure out where to put the cursor, and if it fails,
17194 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17196 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17199 clear_glyph_matrix (w
->desired_matrix
);
17205 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17206 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17209 && (!BUFFERP (glyph
->object
)
17210 || glyph
->charpos
< PT
);
17214 w
->cursor
.x
+= glyph
->pixel_width
;
17220 /* Adjust window end. A null value of last_text_row means that
17221 the window end is in reused rows which in turn means that
17222 only its vpos can have changed. */
17224 adjust_window_ends (w
, last_text_row
, 0);
17226 w
->window_end_vpos
-= nrows_scrolled
;
17228 w
->window_end_valid
= 0;
17229 w
->desired_matrix
->no_scrolling_p
= 1;
17232 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17242 /************************************************************************
17243 Window redisplay reusing current matrix when buffer has changed
17244 ************************************************************************/
17246 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17247 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17248 ptrdiff_t *, ptrdiff_t *);
17249 static struct glyph_row
*
17250 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17251 struct glyph_row
*);
17254 /* Return the last row in MATRIX displaying text. If row START is
17255 non-null, start searching with that row. IT gives the dimensions
17256 of the display. Value is null if matrix is empty; otherwise it is
17257 a pointer to the row found. */
17259 static struct glyph_row
*
17260 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17261 struct glyph_row
*start
)
17263 struct glyph_row
*row
, *row_found
;
17265 /* Set row_found to the last row in IT->w's current matrix
17266 displaying text. The loop looks funny but think of partially
17269 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17270 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17272 eassert (row
->enabled_p
);
17274 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17283 /* Return the last row in the current matrix of W that is not affected
17284 by changes at the start of current_buffer that occurred since W's
17285 current matrix was built. Value is null if no such row exists.
17287 BEG_UNCHANGED us the number of characters unchanged at the start of
17288 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17289 first changed character in current_buffer. Characters at positions <
17290 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17291 when the current matrix was built. */
17293 static struct glyph_row
*
17294 find_last_unchanged_at_beg_row (struct window
*w
)
17296 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17297 struct glyph_row
*row
;
17298 struct glyph_row
*row_found
= NULL
;
17299 int yb
= window_text_bottom_y (w
);
17301 /* Find the last row displaying unchanged text. */
17302 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17303 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17304 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17307 if (/* If row ends before first_changed_pos, it is unchanged,
17308 except in some case. */
17309 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17310 /* When row ends in ZV and we write at ZV it is not
17312 && !row
->ends_at_zv_p
17313 /* When first_changed_pos is the end of a continued line,
17314 row is not unchanged because it may be no longer
17316 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17317 && (row
->continued_p
17318 || row
->exact_window_width_line_p
))
17319 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17320 needs to be recomputed, so don't consider this row as
17321 unchanged. This happens when the last line was
17322 bidi-reordered and was killed immediately before this
17323 redisplay cycle. In that case, ROW->end stores the
17324 buffer position of the first visual-order character of
17325 the killed text, which is now beyond ZV. */
17326 && CHARPOS (row
->end
.pos
) <= ZV
)
17329 /* Stop if last visible row. */
17330 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17338 /* Find the first glyph row in the current matrix of W that is not
17339 affected by changes at the end of current_buffer since the
17340 time W's current matrix was built.
17342 Return in *DELTA the number of chars by which buffer positions in
17343 unchanged text at the end of current_buffer must be adjusted.
17345 Return in *DELTA_BYTES the corresponding number of bytes.
17347 Value is null if no such row exists, i.e. all rows are affected by
17350 static struct glyph_row
*
17351 find_first_unchanged_at_end_row (struct window
*w
,
17352 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17354 struct glyph_row
*row
;
17355 struct glyph_row
*row_found
= NULL
;
17357 *delta
= *delta_bytes
= 0;
17359 /* Display must not have been paused, otherwise the current matrix
17360 is not up to date. */
17361 eassert (w
->window_end_valid
);
17363 /* A value of window_end_pos >= END_UNCHANGED means that the window
17364 end is in the range of changed text. If so, there is no
17365 unchanged row at the end of W's current matrix. */
17366 if (w
->window_end_pos
>= END_UNCHANGED
)
17369 /* Set row to the last row in W's current matrix displaying text. */
17370 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17372 /* If matrix is entirely empty, no unchanged row exists. */
17373 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17375 /* The value of row is the last glyph row in the matrix having a
17376 meaningful buffer position in it. The end position of row
17377 corresponds to window_end_pos. This allows us to translate
17378 buffer positions in the current matrix to current buffer
17379 positions for characters not in changed text. */
17381 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17382 ptrdiff_t Z_BYTE_old
=
17383 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17384 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17385 struct glyph_row
*first_text_row
17386 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17388 *delta
= Z
- Z_old
;
17389 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17391 /* Set last_unchanged_pos to the buffer position of the last
17392 character in the buffer that has not been changed. Z is the
17393 index + 1 of the last character in current_buffer, i.e. by
17394 subtracting END_UNCHANGED we get the index of the last
17395 unchanged character, and we have to add BEG to get its buffer
17397 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17398 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17400 /* Search backward from ROW for a row displaying a line that
17401 starts at a minimum position >= last_unchanged_pos_old. */
17402 for (; row
> first_text_row
; --row
)
17404 /* This used to abort, but it can happen.
17405 It is ok to just stop the search instead here. KFS. */
17406 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17409 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17414 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17420 /* Make sure that glyph rows in the current matrix of window W
17421 reference the same glyph memory as corresponding rows in the
17422 frame's frame matrix. This function is called after scrolling W's
17423 current matrix on a terminal frame in try_window_id and
17424 try_window_reusing_current_matrix. */
17427 sync_frame_with_window_matrix_rows (struct window
*w
)
17429 struct frame
*f
= XFRAME (w
->frame
);
17430 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17432 /* Preconditions: W must be a leaf window and full-width. Its frame
17433 must have a frame matrix. */
17434 eassert (BUFFERP (w
->contents
));
17435 eassert (WINDOW_FULL_WIDTH_P (w
));
17436 eassert (!FRAME_WINDOW_P (f
));
17438 /* If W is a full-width window, glyph pointers in W's current matrix
17439 have, by definition, to be the same as glyph pointers in the
17440 corresponding frame matrix. Note that frame matrices have no
17441 marginal areas (see build_frame_matrix). */
17442 window_row
= w
->current_matrix
->rows
;
17443 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17444 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17445 while (window_row
< window_row_end
)
17447 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17448 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17450 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17451 frame_row
->glyphs
[TEXT_AREA
] = start
;
17452 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17453 frame_row
->glyphs
[LAST_AREA
] = end
;
17455 /* Disable frame rows whose corresponding window rows have
17456 been disabled in try_window_id. */
17457 if (!window_row
->enabled_p
)
17458 frame_row
->enabled_p
= false;
17460 ++window_row
, ++frame_row
;
17465 /* Find the glyph row in window W containing CHARPOS. Consider all
17466 rows between START and END (not inclusive). END null means search
17467 all rows to the end of the display area of W. Value is the row
17468 containing CHARPOS or null. */
17471 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17472 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17474 struct glyph_row
*row
= start
;
17475 struct glyph_row
*best_row
= NULL
;
17476 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17479 /* If we happen to start on a header-line, skip that. */
17480 if (row
->mode_line_p
)
17483 if ((end
&& row
>= end
) || !row
->enabled_p
)
17486 last_y
= window_text_bottom_y (w
) - dy
;
17490 /* Give up if we have gone too far. */
17491 if (end
&& row
>= end
)
17493 /* This formerly returned if they were equal.
17494 I think that both quantities are of a "last plus one" type;
17495 if so, when they are equal, the row is within the screen. -- rms. */
17496 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17499 /* If it is in this row, return this row. */
17500 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17501 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17502 /* The end position of a row equals the start
17503 position of the next row. If CHARPOS is there, we
17504 would rather consider it displayed in the next
17505 line, except when this line ends in ZV. */
17506 && !row_for_charpos_p (row
, charpos
)))
17507 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17511 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17512 || (!best_row
&& !row
->continued_p
))
17514 /* In bidi-reordered rows, there could be several rows whose
17515 edges surround CHARPOS, all of these rows belonging to
17516 the same continued line. We need to find the row which
17517 fits CHARPOS the best. */
17518 for (g
= row
->glyphs
[TEXT_AREA
];
17519 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17522 if (!STRINGP (g
->object
))
17524 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17526 mindif
= eabs (g
->charpos
- charpos
);
17528 /* Exact match always wins. */
17535 else if (best_row
&& !row
->continued_p
)
17542 /* Try to redisplay window W by reusing its existing display. W's
17543 current matrix must be up to date when this function is called,
17544 i.e. window_end_valid must be nonzero.
17548 >= 1 if successful, i.e. display has been updated
17550 1 means the changes were in front of a newline that precedes
17551 the window start, and the whole current matrix was reused
17552 2 means the changes were after the last position displayed
17553 in the window, and the whole current matrix was reused
17554 3 means portions of the current matrix were reused, while
17555 some of the screen lines were redrawn
17556 -1 if redisplay with same window start is known not to succeed
17557 0 if otherwise unsuccessful
17559 The following steps are performed:
17561 1. Find the last row in the current matrix of W that is not
17562 affected by changes at the start of current_buffer. If no such row
17565 2. Find the first row in W's current matrix that is not affected by
17566 changes at the end of current_buffer. Maybe there is no such row.
17568 3. Display lines beginning with the row + 1 found in step 1 to the
17569 row found in step 2 or, if step 2 didn't find a row, to the end of
17572 4. If cursor is not known to appear on the window, give up.
17574 5. If display stopped at the row found in step 2, scroll the
17575 display and current matrix as needed.
17577 6. Maybe display some lines at the end of W, if we must. This can
17578 happen under various circumstances, like a partially visible line
17579 becoming fully visible, or because newly displayed lines are displayed
17580 in smaller font sizes.
17582 7. Update W's window end information. */
17585 try_window_id (struct window
*w
)
17587 struct frame
*f
= XFRAME (w
->frame
);
17588 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17589 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17590 struct glyph_row
*last_unchanged_at_beg_row
;
17591 struct glyph_row
*first_unchanged_at_end_row
;
17592 struct glyph_row
*row
;
17593 struct glyph_row
*bottom_row
;
17596 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17598 struct text_pos start_pos
;
17600 int first_unchanged_at_end_vpos
= 0;
17601 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17602 struct text_pos start
;
17603 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17606 if (inhibit_try_window_id
)
17610 /* This is handy for debugging. */
17612 #define GIVE_UP(X) \
17614 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17618 #define GIVE_UP(X) return 0
17621 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17623 /* Don't use this for mini-windows because these can show
17624 messages and mini-buffers, and we don't handle that here. */
17625 if (MINI_WINDOW_P (w
))
17628 /* This flag is used to prevent redisplay optimizations. */
17629 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17632 /* This function's optimizations cannot be used if overlays have
17633 changed in the buffer displayed by the window, so give up if they
17635 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17638 /* Verify that narrowing has not changed.
17639 Also verify that we were not told to prevent redisplay optimizations.
17640 It would be nice to further
17641 reduce the number of cases where this prevents try_window_id. */
17642 if (current_buffer
->clip_changed
17643 || current_buffer
->prevent_redisplay_optimizations_p
)
17646 /* Window must either use window-based redisplay or be full width. */
17647 if (!FRAME_WINDOW_P (f
)
17648 && (!FRAME_LINE_INS_DEL_OK (f
)
17649 || !WINDOW_FULL_WIDTH_P (w
)))
17652 /* Give up if point is known NOT to appear in W. */
17653 if (PT
< CHARPOS (start
))
17656 /* Another way to prevent redisplay optimizations. */
17657 if (w
->last_modified
== 0)
17660 /* Verify that window is not hscrolled. */
17661 if (w
->hscroll
!= 0)
17664 /* Verify that display wasn't paused. */
17665 if (!w
->window_end_valid
)
17668 /* Likewise if highlighting trailing whitespace. */
17669 if (!NILP (Vshow_trailing_whitespace
))
17672 /* Can't use this if overlay arrow position and/or string have
17674 if (overlay_arrows_changed_p ())
17677 /* When word-wrap is on, adding a space to the first word of a
17678 wrapped line can change the wrap position, altering the line
17679 above it. It might be worthwhile to handle this more
17680 intelligently, but for now just redisplay from scratch. */
17681 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17684 /* Under bidi reordering, adding or deleting a character in the
17685 beginning of a paragraph, before the first strong directional
17686 character, can change the base direction of the paragraph (unless
17687 the buffer specifies a fixed paragraph direction), which will
17688 require to redisplay the whole paragraph. It might be worthwhile
17689 to find the paragraph limits and widen the range of redisplayed
17690 lines to that, but for now just give up this optimization and
17691 redisplay from scratch. */
17692 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17693 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17696 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17697 only if buffer has really changed. The reason is that the gap is
17698 initially at Z for freshly visited files. The code below would
17699 set end_unchanged to 0 in that case. */
17700 if (MODIFF
> SAVE_MODIFF
17701 /* This seems to happen sometimes after saving a buffer. */
17702 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17704 if (GPT
- BEG
< BEG_UNCHANGED
)
17705 BEG_UNCHANGED
= GPT
- BEG
;
17706 if (Z
- GPT
< END_UNCHANGED
)
17707 END_UNCHANGED
= Z
- GPT
;
17710 /* The position of the first and last character that has been changed. */
17711 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17712 last_changed_charpos
= Z
- END_UNCHANGED
;
17714 /* If window starts after a line end, and the last change is in
17715 front of that newline, then changes don't affect the display.
17716 This case happens with stealth-fontification. Note that although
17717 the display is unchanged, glyph positions in the matrix have to
17718 be adjusted, of course. */
17719 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17720 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17721 && ((last_changed_charpos
< CHARPOS (start
)
17722 && CHARPOS (start
) == BEGV
)
17723 || (last_changed_charpos
< CHARPOS (start
) - 1
17724 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17726 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17727 struct glyph_row
*r0
;
17729 /* Compute how many chars/bytes have been added to or removed
17730 from the buffer. */
17731 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17732 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17733 Z_delta
= Z
- Z_old
;
17734 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17736 /* Give up if PT is not in the window. Note that it already has
17737 been checked at the start of try_window_id that PT is not in
17738 front of the window start. */
17739 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17742 /* If window start is unchanged, we can reuse the whole matrix
17743 as is, after adjusting glyph positions. No need to compute
17744 the window end again, since its offset from Z hasn't changed. */
17745 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17746 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17747 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17748 /* PT must not be in a partially visible line. */
17749 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17750 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17752 /* Adjust positions in the glyph matrix. */
17753 if (Z_delta
|| Z_delta_bytes
)
17755 struct glyph_row
*r1
17756 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17757 increment_matrix_positions (w
->current_matrix
,
17758 MATRIX_ROW_VPOS (r0
, current_matrix
),
17759 MATRIX_ROW_VPOS (r1
, current_matrix
),
17760 Z_delta
, Z_delta_bytes
);
17763 /* Set the cursor. */
17764 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17766 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17771 /* Handle the case that changes are all below what is displayed in
17772 the window, and that PT is in the window. This shortcut cannot
17773 be taken if ZV is visible in the window, and text has been added
17774 there that is visible in the window. */
17775 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17776 /* ZV is not visible in the window, or there are no
17777 changes at ZV, actually. */
17778 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17779 || first_changed_charpos
== last_changed_charpos
))
17781 struct glyph_row
*r0
;
17783 /* Give up if PT is not in the window. Note that it already has
17784 been checked at the start of try_window_id that PT is not in
17785 front of the window start. */
17786 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17789 /* If window start is unchanged, we can reuse the whole matrix
17790 as is, without changing glyph positions since no text has
17791 been added/removed in front of the window end. */
17792 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17793 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17794 /* PT must not be in a partially visible line. */
17795 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17796 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17798 /* We have to compute the window end anew since text
17799 could have been added/removed after it. */
17800 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17801 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17803 /* Set the cursor. */
17804 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17806 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17811 /* Give up if window start is in the changed area.
17813 The condition used to read
17815 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17817 but why that was tested escapes me at the moment. */
17818 if (CHARPOS (start
) >= first_changed_charpos
17819 && CHARPOS (start
) <= last_changed_charpos
)
17822 /* Check that window start agrees with the start of the first glyph
17823 row in its current matrix. Check this after we know the window
17824 start is not in changed text, otherwise positions would not be
17826 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17827 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17830 /* Give up if the window ends in strings. Overlay strings
17831 at the end are difficult to handle, so don't try. */
17832 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17833 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17836 /* Compute the position at which we have to start displaying new
17837 lines. Some of the lines at the top of the window might be
17838 reusable because they are not displaying changed text. Find the
17839 last row in W's current matrix not affected by changes at the
17840 start of current_buffer. Value is null if changes start in the
17841 first line of window. */
17842 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17843 if (last_unchanged_at_beg_row
)
17845 /* Avoid starting to display in the middle of a character, a TAB
17846 for instance. This is easier than to set up the iterator
17847 exactly, and it's not a frequent case, so the additional
17848 effort wouldn't really pay off. */
17849 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17850 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17851 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17852 --last_unchanged_at_beg_row
;
17854 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17857 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17859 start_pos
= it
.current
.pos
;
17861 /* Start displaying new lines in the desired matrix at the same
17862 vpos we would use in the current matrix, i.e. below
17863 last_unchanged_at_beg_row. */
17864 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17866 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17867 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17869 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17873 /* There are no reusable lines at the start of the window.
17874 Start displaying in the first text line. */
17875 start_display (&it
, w
, start
);
17876 it
.vpos
= it
.first_vpos
;
17877 start_pos
= it
.current
.pos
;
17880 /* Find the first row that is not affected by changes at the end of
17881 the buffer. Value will be null if there is no unchanged row, in
17882 which case we must redisplay to the end of the window. delta
17883 will be set to the value by which buffer positions beginning with
17884 first_unchanged_at_end_row have to be adjusted due to text
17886 first_unchanged_at_end_row
17887 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17888 IF_DEBUG (debug_delta
= delta
);
17889 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17891 /* Set stop_pos to the buffer position up to which we will have to
17892 display new lines. If first_unchanged_at_end_row != NULL, this
17893 is the buffer position of the start of the line displayed in that
17894 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17895 that we don't stop at a buffer position. */
17897 if (first_unchanged_at_end_row
)
17899 eassert (last_unchanged_at_beg_row
== NULL
17900 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17902 /* If this is a continuation line, move forward to the next one
17903 that isn't. Changes in lines above affect this line.
17904 Caution: this may move first_unchanged_at_end_row to a row
17905 not displaying text. */
17906 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17907 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17908 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17909 < it
.last_visible_y
))
17910 ++first_unchanged_at_end_row
;
17912 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17913 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17914 >= it
.last_visible_y
))
17915 first_unchanged_at_end_row
= NULL
;
17918 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17920 first_unchanged_at_end_vpos
17921 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17922 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17925 else if (last_unchanged_at_beg_row
== NULL
)
17931 /* Either there is no unchanged row at the end, or the one we have
17932 now displays text. This is a necessary condition for the window
17933 end pos calculation at the end of this function. */
17934 eassert (first_unchanged_at_end_row
== NULL
17935 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17937 debug_last_unchanged_at_beg_vpos
17938 = (last_unchanged_at_beg_row
17939 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17941 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17943 #endif /* GLYPH_DEBUG */
17946 /* Display new lines. Set last_text_row to the last new line
17947 displayed which has text on it, i.e. might end up as being the
17948 line where the window_end_vpos is. */
17949 w
->cursor
.vpos
= -1;
17950 last_text_row
= NULL
;
17951 overlay_arrow_seen
= 0;
17952 while (it
.current_y
< it
.last_visible_y
17953 && !f
->fonts_changed
17954 && (first_unchanged_at_end_row
== NULL
17955 || IT_CHARPOS (it
) < stop_pos
))
17957 if (display_line (&it
))
17958 last_text_row
= it
.glyph_row
- 1;
17961 if (f
->fonts_changed
)
17965 /* Compute differences in buffer positions, y-positions etc. for
17966 lines reused at the bottom of the window. Compute what we can
17968 if (first_unchanged_at_end_row
17969 /* No lines reused because we displayed everything up to the
17970 bottom of the window. */
17971 && it
.current_y
< it
.last_visible_y
)
17974 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17976 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17977 run
.current_y
= first_unchanged_at_end_row
->y
;
17978 run
.desired_y
= run
.current_y
+ dy
;
17979 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17983 delta
= delta_bytes
= dvpos
= dy
17984 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17985 first_unchanged_at_end_row
= NULL
;
17987 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
17990 /* Find the cursor if not already found. We have to decide whether
17991 PT will appear on this window (it sometimes doesn't, but this is
17992 not a very frequent case.) This decision has to be made before
17993 the current matrix is altered. A value of cursor.vpos < 0 means
17994 that PT is either in one of the lines beginning at
17995 first_unchanged_at_end_row or below the window. Don't care for
17996 lines that might be displayed later at the window end; as
17997 mentioned, this is not a frequent case. */
17998 if (w
->cursor
.vpos
< 0)
18000 /* Cursor in unchanged rows at the top? */
18001 if (PT
< CHARPOS (start_pos
)
18002 && last_unchanged_at_beg_row
)
18004 row
= row_containing_pos (w
, PT
,
18005 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18006 last_unchanged_at_beg_row
+ 1, 0);
18008 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18011 /* Start from first_unchanged_at_end_row looking for PT. */
18012 else if (first_unchanged_at_end_row
)
18014 row
= row_containing_pos (w
, PT
- delta
,
18015 first_unchanged_at_end_row
, NULL
, 0);
18017 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18018 delta_bytes
, dy
, dvpos
);
18021 /* Give up if cursor was not found. */
18022 if (w
->cursor
.vpos
< 0)
18024 clear_glyph_matrix (w
->desired_matrix
);
18029 /* Don't let the cursor end in the scroll margins. */
18031 int this_scroll_margin
, cursor_height
;
18032 int frame_line_height
= default_line_pixel_height (w
);
18033 int window_total_lines
18034 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18036 this_scroll_margin
=
18037 max (0, min (scroll_margin
, window_total_lines
/ 4));
18038 this_scroll_margin
*= frame_line_height
;
18039 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18041 if ((w
->cursor
.y
< this_scroll_margin
18042 && CHARPOS (start
) > BEGV
)
18043 /* Old redisplay didn't take scroll margin into account at the bottom,
18044 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18045 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18046 ? cursor_height
+ this_scroll_margin
18047 : 1)) > it
.last_visible_y
)
18049 w
->cursor
.vpos
= -1;
18050 clear_glyph_matrix (w
->desired_matrix
);
18055 /* Scroll the display. Do it before changing the current matrix so
18056 that xterm.c doesn't get confused about where the cursor glyph is
18058 if (dy
&& run
.height
)
18062 if (FRAME_WINDOW_P (f
))
18064 FRAME_RIF (f
)->update_window_begin_hook (w
);
18065 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18066 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18067 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18071 /* Terminal frame. In this case, dvpos gives the number of
18072 lines to scroll by; dvpos < 0 means scroll up. */
18074 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18075 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18076 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18077 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18078 + window_internal_height (w
));
18080 #if defined (HAVE_GPM) || defined (MSDOS)
18081 x_clear_window_mouse_face (w
);
18083 /* Perform the operation on the screen. */
18086 /* Scroll last_unchanged_at_beg_row to the end of the
18087 window down dvpos lines. */
18088 set_terminal_window (f
, end
);
18090 /* On dumb terminals delete dvpos lines at the end
18091 before inserting dvpos empty lines. */
18092 if (!FRAME_SCROLL_REGION_OK (f
))
18093 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18095 /* Insert dvpos empty lines in front of
18096 last_unchanged_at_beg_row. */
18097 ins_del_lines (f
, from
, dvpos
);
18099 else if (dvpos
< 0)
18101 /* Scroll up last_unchanged_at_beg_vpos to the end of
18102 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18103 set_terminal_window (f
, end
);
18105 /* Delete dvpos lines in front of
18106 last_unchanged_at_beg_vpos. ins_del_lines will set
18107 the cursor to the given vpos and emit |dvpos| delete
18109 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18111 /* On a dumb terminal insert dvpos empty lines at the
18113 if (!FRAME_SCROLL_REGION_OK (f
))
18114 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18117 set_terminal_window (f
, 0);
18123 /* Shift reused rows of the current matrix to the right position.
18124 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18126 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18127 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18130 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18131 bottom_vpos
, dvpos
);
18132 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18135 else if (dvpos
> 0)
18137 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18138 bottom_vpos
, dvpos
);
18139 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18140 first_unchanged_at_end_vpos
+ dvpos
);
18143 /* For frame-based redisplay, make sure that current frame and window
18144 matrix are in sync with respect to glyph memory. */
18145 if (!FRAME_WINDOW_P (f
))
18146 sync_frame_with_window_matrix_rows (w
);
18148 /* Adjust buffer positions in reused rows. */
18149 if (delta
|| delta_bytes
)
18150 increment_matrix_positions (current_matrix
,
18151 first_unchanged_at_end_vpos
+ dvpos
,
18152 bottom_vpos
, delta
, delta_bytes
);
18154 /* Adjust Y positions. */
18156 shift_glyph_matrix (w
, current_matrix
,
18157 first_unchanged_at_end_vpos
+ dvpos
,
18160 if (first_unchanged_at_end_row
)
18162 first_unchanged_at_end_row
+= dvpos
;
18163 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18164 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18165 first_unchanged_at_end_row
= NULL
;
18168 /* If scrolling up, there may be some lines to display at the end of
18170 last_text_row_at_end
= NULL
;
18173 /* Scrolling up can leave for example a partially visible line
18174 at the end of the window to be redisplayed. */
18175 /* Set last_row to the glyph row in the current matrix where the
18176 window end line is found. It has been moved up or down in
18177 the matrix by dvpos. */
18178 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18179 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18181 /* If last_row is the window end line, it should display text. */
18182 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18184 /* If window end line was partially visible before, begin
18185 displaying at that line. Otherwise begin displaying with the
18186 line following it. */
18187 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18189 init_to_row_start (&it
, w
, last_row
);
18190 it
.vpos
= last_vpos
;
18191 it
.current_y
= last_row
->y
;
18195 init_to_row_end (&it
, w
, last_row
);
18196 it
.vpos
= 1 + last_vpos
;
18197 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18201 /* We may start in a continuation line. If so, we have to
18202 get the right continuation_lines_width and current_x. */
18203 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18204 it
.hpos
= it
.current_x
= 0;
18206 /* Display the rest of the lines at the window end. */
18207 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18208 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18210 /* Is it always sure that the display agrees with lines in
18211 the current matrix? I don't think so, so we mark rows
18212 displayed invalid in the current matrix by setting their
18213 enabled_p flag to zero. */
18214 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18215 if (display_line (&it
))
18216 last_text_row_at_end
= it
.glyph_row
- 1;
18220 /* Update window_end_pos and window_end_vpos. */
18221 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18223 /* Window end line if one of the preserved rows from the current
18224 matrix. Set row to the last row displaying text in current
18225 matrix starting at first_unchanged_at_end_row, after
18227 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18228 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18229 first_unchanged_at_end_row
);
18230 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18231 adjust_window_ends (w
, row
, 1);
18232 eassert (w
->window_end_bytepos
>= 0);
18233 IF_DEBUG (debug_method_add (w
, "A"));
18235 else if (last_text_row_at_end
)
18237 adjust_window_ends (w
, last_text_row_at_end
, 0);
18238 eassert (w
->window_end_bytepos
>= 0);
18239 IF_DEBUG (debug_method_add (w
, "B"));
18241 else if (last_text_row
)
18243 /* We have displayed either to the end of the window or at the
18244 end of the window, i.e. the last row with text is to be found
18245 in the desired matrix. */
18246 adjust_window_ends (w
, last_text_row
, 0);
18247 eassert (w
->window_end_bytepos
>= 0);
18249 else if (first_unchanged_at_end_row
== NULL
18250 && last_text_row
== NULL
18251 && last_text_row_at_end
== NULL
)
18253 /* Displayed to end of window, but no line containing text was
18254 displayed. Lines were deleted at the end of the window. */
18255 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18256 int vpos
= w
->window_end_vpos
;
18257 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18258 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18261 row
== NULL
&& vpos
>= first_vpos
;
18262 --vpos
, --current_row
, --desired_row
)
18264 if (desired_row
->enabled_p
)
18266 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18269 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18273 eassert (row
!= NULL
);
18274 w
->window_end_vpos
= vpos
+ 1;
18275 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18276 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18277 eassert (w
->window_end_bytepos
>= 0);
18278 IF_DEBUG (debug_method_add (w
, "C"));
18283 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18284 debug_end_vpos
= w
->window_end_vpos
));
18286 /* Record that display has not been completed. */
18287 w
->window_end_valid
= 0;
18288 w
->desired_matrix
->no_scrolling_p
= 1;
18296 /***********************************************************************
18297 More debugging support
18298 ***********************************************************************/
18302 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18303 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18304 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18307 /* Dump the contents of glyph matrix MATRIX on stderr.
18309 GLYPHS 0 means don't show glyph contents.
18310 GLYPHS 1 means show glyphs in short form
18311 GLYPHS > 1 means show glyphs in long form. */
18314 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18317 for (i
= 0; i
< matrix
->nrows
; ++i
)
18318 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18322 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18323 the glyph row and area where the glyph comes from. */
18326 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18328 if (glyph
->type
== CHAR_GLYPH
18329 || glyph
->type
== GLYPHLESS_GLYPH
)
18332 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18333 glyph
- row
->glyphs
[TEXT_AREA
],
18334 (glyph
->type
== CHAR_GLYPH
18338 (BUFFERP (glyph
->object
)
18340 : (STRINGP (glyph
->object
)
18342 : (INTEGERP (glyph
->object
)
18345 glyph
->pixel_width
,
18347 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18351 glyph
->left_box_line_p
,
18352 glyph
->right_box_line_p
);
18354 else if (glyph
->type
== STRETCH_GLYPH
)
18357 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18358 glyph
- row
->glyphs
[TEXT_AREA
],
18361 (BUFFERP (glyph
->object
)
18363 : (STRINGP (glyph
->object
)
18365 : (INTEGERP (glyph
->object
)
18368 glyph
->pixel_width
,
18372 glyph
->left_box_line_p
,
18373 glyph
->right_box_line_p
);
18375 else if (glyph
->type
== IMAGE_GLYPH
)
18378 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18379 glyph
- row
->glyphs
[TEXT_AREA
],
18382 (BUFFERP (glyph
->object
)
18384 : (STRINGP (glyph
->object
)
18386 : (INTEGERP (glyph
->object
)
18389 glyph
->pixel_width
,
18393 glyph
->left_box_line_p
,
18394 glyph
->right_box_line_p
);
18396 else if (glyph
->type
== COMPOSITE_GLYPH
)
18399 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18400 glyph
- row
->glyphs
[TEXT_AREA
],
18403 (BUFFERP (glyph
->object
)
18405 : (STRINGP (glyph
->object
)
18407 : (INTEGERP (glyph
->object
)
18410 glyph
->pixel_width
,
18412 if (glyph
->u
.cmp
.automatic
)
18415 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18416 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18418 glyph
->left_box_line_p
,
18419 glyph
->right_box_line_p
);
18424 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18425 GLYPHS 0 means don't show glyph contents.
18426 GLYPHS 1 means show glyphs in short form
18427 GLYPHS > 1 means show glyphs in long form. */
18430 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18434 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18435 fprintf (stderr
, "==============================================================================\n");
18437 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18438 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18440 MATRIX_ROW_START_CHARPOS (row
),
18441 MATRIX_ROW_END_CHARPOS (row
),
18442 row
->used
[TEXT_AREA
],
18443 row
->contains_overlapping_glyphs_p
,
18445 row
->truncated_on_left_p
,
18446 row
->truncated_on_right_p
,
18448 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18449 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18452 row
->ends_in_middle_of_char_p
,
18453 row
->starts_in_middle_of_char_p
,
18459 row
->visible_height
,
18462 /* The next 3 lines should align to "Start" in the header. */
18463 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18464 row
->end
.overlay_string_index
,
18465 row
->continuation_lines_width
);
18466 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18467 CHARPOS (row
->start
.string_pos
),
18468 CHARPOS (row
->end
.string_pos
));
18469 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18470 row
->end
.dpvec_index
);
18477 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18479 struct glyph
*glyph
= row
->glyphs
[area
];
18480 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18482 /* Glyph for a line end in text. */
18483 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18486 if (glyph
< glyph_end
)
18487 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18489 for (; glyph
< glyph_end
; ++glyph
)
18490 dump_glyph (row
, glyph
, area
);
18493 else if (glyphs
== 1)
18497 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18499 char *s
= alloca (row
->used
[area
] + 4);
18502 for (i
= 0; i
< row
->used
[area
]; ++i
)
18504 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18505 if (i
== row
->used
[area
] - 1
18506 && area
== TEXT_AREA
18507 && INTEGERP (glyph
->object
)
18508 && glyph
->type
== CHAR_GLYPH
18509 && glyph
->u
.ch
== ' ')
18511 strcpy (&s
[i
], "[\\n]");
18514 else if (glyph
->type
== CHAR_GLYPH
18515 && glyph
->u
.ch
< 0x80
18516 && glyph
->u
.ch
>= ' ')
18517 s
[i
] = glyph
->u
.ch
;
18523 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18529 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18530 Sdump_glyph_matrix
, 0, 1, "p",
18531 doc
: /* Dump the current matrix of the selected window to stderr.
18532 Shows contents of glyph row structures. With non-nil
18533 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18534 glyphs in short form, otherwise show glyphs in long form. */)
18535 (Lisp_Object glyphs
)
18537 struct window
*w
= XWINDOW (selected_window
);
18538 struct buffer
*buffer
= XBUFFER (w
->contents
);
18540 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18541 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18542 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18543 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18544 fprintf (stderr
, "=============================================\n");
18545 dump_glyph_matrix (w
->current_matrix
,
18546 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18551 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18552 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18555 struct frame
*f
= XFRAME (selected_frame
);
18556 dump_glyph_matrix (f
->current_matrix
, 1);
18561 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18562 doc
: /* Dump glyph row ROW to stderr.
18563 GLYPH 0 means don't dump glyphs.
18564 GLYPH 1 means dump glyphs in short form.
18565 GLYPH > 1 or omitted means dump glyphs in long form. */)
18566 (Lisp_Object row
, Lisp_Object glyphs
)
18568 struct glyph_matrix
*matrix
;
18571 CHECK_NUMBER (row
);
18572 matrix
= XWINDOW (selected_window
)->current_matrix
;
18574 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18575 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18577 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18582 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18583 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18584 GLYPH 0 means don't dump glyphs.
18585 GLYPH 1 means dump glyphs in short form.
18586 GLYPH > 1 or omitted means dump glyphs in long form.
18588 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18590 (Lisp_Object row
, Lisp_Object glyphs
)
18592 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18593 struct frame
*sf
= SELECTED_FRAME ();
18594 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18597 CHECK_NUMBER (row
);
18599 if (vpos
>= 0 && vpos
< m
->nrows
)
18600 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18601 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18607 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18608 doc
: /* Toggle tracing of redisplay.
18609 With ARG, turn tracing on if and only if ARG is positive. */)
18613 trace_redisplay_p
= !trace_redisplay_p
;
18616 arg
= Fprefix_numeric_value (arg
);
18617 trace_redisplay_p
= XINT (arg
) > 0;
18624 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18625 doc
: /* Like `format', but print result to stderr.
18626 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18627 (ptrdiff_t nargs
, Lisp_Object
*args
)
18629 Lisp_Object s
= Fformat (nargs
, args
);
18630 fprintf (stderr
, "%s", SDATA (s
));
18634 #endif /* GLYPH_DEBUG */
18638 /***********************************************************************
18639 Building Desired Matrix Rows
18640 ***********************************************************************/
18642 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18643 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18645 static struct glyph_row
*
18646 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18648 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18649 struct buffer
*buffer
= XBUFFER (w
->contents
);
18650 struct buffer
*old
= current_buffer
;
18651 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18652 int arrow_len
= SCHARS (overlay_arrow_string
);
18653 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18654 const unsigned char *p
;
18657 int n_glyphs_before
;
18659 set_buffer_temp (buffer
);
18660 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18661 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18662 SET_TEXT_POS (it
.position
, 0, 0);
18664 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18666 while (p
< arrow_end
)
18668 Lisp_Object face
, ilisp
;
18670 /* Get the next character. */
18672 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18675 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18676 if (! ASCII_CHAR_P (it
.c
))
18677 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18681 /* Get its face. */
18682 ilisp
= make_number (p
- arrow_string
);
18683 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18684 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18686 /* Compute its width, get its glyphs. */
18687 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18688 SET_TEXT_POS (it
.position
, -1, -1);
18689 PRODUCE_GLYPHS (&it
);
18691 /* If this character doesn't fit any more in the line, we have
18692 to remove some glyphs. */
18693 if (it
.current_x
> it
.last_visible_x
)
18695 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18700 set_buffer_temp (old
);
18701 return it
.glyph_row
;
18705 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18706 glyphs to insert is determined by produce_special_glyphs. */
18709 insert_left_trunc_glyphs (struct it
*it
)
18711 struct it truncate_it
;
18712 struct glyph
*from
, *end
, *to
, *toend
;
18714 eassert (!FRAME_WINDOW_P (it
->f
)
18715 || (!it
->glyph_row
->reversed_p
18716 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18717 || (it
->glyph_row
->reversed_p
18718 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18720 /* Get the truncation glyphs. */
18722 truncate_it
.current_x
= 0;
18723 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18724 truncate_it
.glyph_row
= &scratch_glyph_row
;
18725 truncate_it
.area
= TEXT_AREA
;
18726 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18727 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18728 truncate_it
.object
= make_number (0);
18729 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18731 /* Overwrite glyphs from IT with truncation glyphs. */
18732 if (!it
->glyph_row
->reversed_p
)
18734 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18736 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18737 end
= from
+ tused
;
18738 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18739 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18740 if (FRAME_WINDOW_P (it
->f
))
18742 /* On GUI frames, when variable-size fonts are displayed,
18743 the truncation glyphs may need more pixels than the row's
18744 glyphs they overwrite. We overwrite more glyphs to free
18745 enough screen real estate, and enlarge the stretch glyph
18746 on the right (see display_line), if there is one, to
18747 preserve the screen position of the truncation glyphs on
18750 struct glyph
*g
= to
;
18753 /* The first glyph could be partially visible, in which case
18754 it->glyph_row->x will be negative. But we want the left
18755 truncation glyphs to be aligned at the left margin of the
18756 window, so we override the x coordinate at which the row
18758 it
->glyph_row
->x
= 0;
18759 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18761 w
+= g
->pixel_width
;
18764 if (g
- to
- tused
> 0)
18766 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18767 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18769 used
= it
->glyph_row
->used
[TEXT_AREA
];
18770 if (it
->glyph_row
->truncated_on_right_p
18771 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18772 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18775 int extra
= w
- it
->truncation_pixel_width
;
18777 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18784 /* There may be padding glyphs left over. Overwrite them too. */
18785 if (!FRAME_WINDOW_P (it
->f
))
18787 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18789 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18796 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18800 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18802 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18803 that back to front. */
18804 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18805 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18806 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18807 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18808 if (FRAME_WINDOW_P (it
->f
))
18811 struct glyph
*g
= to
;
18813 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18815 w
+= g
->pixel_width
;
18818 if (to
- g
- tused
> 0)
18820 if (it
->glyph_row
->truncated_on_right_p
18821 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18822 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18824 int extra
= w
- it
->truncation_pixel_width
;
18826 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18830 while (from
>= end
&& to
>= toend
)
18832 if (!FRAME_WINDOW_P (it
->f
))
18834 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18837 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18838 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18839 while (from
>= end
&& to
>= toend
)
18845 /* Need to free some room before prepending additional
18847 int move_by
= from
- end
+ 1;
18848 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18849 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18851 for ( ; g
>= g0
; g
--)
18853 while (from
>= end
)
18855 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18860 /* Compute the hash code for ROW. */
18862 row_hash (struct glyph_row
*row
)
18865 unsigned hashval
= 0;
18867 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18868 for (k
= 0; k
< row
->used
[area
]; ++k
)
18869 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18870 + row
->glyphs
[area
][k
].u
.val
18871 + row
->glyphs
[area
][k
].face_id
18872 + row
->glyphs
[area
][k
].padding_p
18873 + (row
->glyphs
[area
][k
].type
<< 2));
18878 /* Compute the pixel height and width of IT->glyph_row.
18880 Most of the time, ascent and height of a display line will be equal
18881 to the max_ascent and max_height values of the display iterator
18882 structure. This is not the case if
18884 1. We hit ZV without displaying anything. In this case, max_ascent
18885 and max_height will be zero.
18887 2. We have some glyphs that don't contribute to the line height.
18888 (The glyph row flag contributes_to_line_height_p is for future
18889 pixmap extensions).
18891 The first case is easily covered by using default values because in
18892 these cases, the line height does not really matter, except that it
18893 must not be zero. */
18896 compute_line_metrics (struct it
*it
)
18898 struct glyph_row
*row
= it
->glyph_row
;
18900 if (FRAME_WINDOW_P (it
->f
))
18902 int i
, min_y
, max_y
;
18904 /* The line may consist of one space only, that was added to
18905 place the cursor on it. If so, the row's height hasn't been
18907 if (row
->height
== 0)
18909 if (it
->max_ascent
+ it
->max_descent
== 0)
18910 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18911 row
->ascent
= it
->max_ascent
;
18912 row
->height
= it
->max_ascent
+ it
->max_descent
;
18913 row
->phys_ascent
= it
->max_phys_ascent
;
18914 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18915 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18918 /* Compute the width of this line. */
18919 row
->pixel_width
= row
->x
;
18920 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18921 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18923 eassert (row
->pixel_width
>= 0);
18924 eassert (row
->ascent
>= 0 && row
->height
> 0);
18926 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18927 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18929 /* If first line's physical ascent is larger than its logical
18930 ascent, use the physical ascent, and make the row taller.
18931 This makes accented characters fully visible. */
18932 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18933 && row
->phys_ascent
> row
->ascent
)
18935 row
->height
+= row
->phys_ascent
- row
->ascent
;
18936 row
->ascent
= row
->phys_ascent
;
18939 /* Compute how much of the line is visible. */
18940 row
->visible_height
= row
->height
;
18942 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18943 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18945 if (row
->y
< min_y
)
18946 row
->visible_height
-= min_y
- row
->y
;
18947 if (row
->y
+ row
->height
> max_y
)
18948 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18952 row
->pixel_width
= row
->used
[TEXT_AREA
];
18953 if (row
->continued_p
)
18954 row
->pixel_width
-= it
->continuation_pixel_width
;
18955 else if (row
->truncated_on_right_p
)
18956 row
->pixel_width
-= it
->truncation_pixel_width
;
18957 row
->ascent
= row
->phys_ascent
= 0;
18958 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18959 row
->extra_line_spacing
= 0;
18962 /* Compute a hash code for this row. */
18963 row
->hash
= row_hash (row
);
18965 it
->max_ascent
= it
->max_descent
= 0;
18966 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18970 /* Append one space to the glyph row of iterator IT if doing a
18971 window-based redisplay. The space has the same face as
18972 IT->face_id. Value is non-zero if a space was added.
18974 This function is called to make sure that there is always one glyph
18975 at the end of a glyph row that the cursor can be set on under
18976 window-systems. (If there weren't such a glyph we would not know
18977 how wide and tall a box cursor should be displayed).
18979 At the same time this space let's a nicely handle clearing to the
18980 end of the line if the row ends in italic text. */
18983 append_space_for_newline (struct it
*it
, int default_face_p
)
18985 if (FRAME_WINDOW_P (it
->f
))
18987 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18989 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18990 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18992 /* Save some values that must not be changed.
18993 Must save IT->c and IT->len because otherwise
18994 ITERATOR_AT_END_P wouldn't work anymore after
18995 append_space_for_newline has been called. */
18996 enum display_element_type saved_what
= it
->what
;
18997 int saved_c
= it
->c
, saved_len
= it
->len
;
18998 int saved_char_to_display
= it
->char_to_display
;
18999 int saved_x
= it
->current_x
;
19000 int saved_face_id
= it
->face_id
;
19001 int saved_box_end
= it
->end_of_box_run_p
;
19002 struct text_pos saved_pos
;
19003 Lisp_Object saved_object
;
19006 saved_object
= it
->object
;
19007 saved_pos
= it
->position
;
19009 it
->what
= IT_CHARACTER
;
19010 memset (&it
->position
, 0, sizeof it
->position
);
19011 it
->object
= make_number (0);
19012 it
->c
= it
->char_to_display
= ' ';
19015 /* If the default face was remapped, be sure to use the
19016 remapped face for the appended newline. */
19017 if (default_face_p
)
19018 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19019 else if (it
->face_before_selective_p
)
19020 it
->face_id
= it
->saved_face_id
;
19021 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19022 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19023 /* In R2L rows, we will prepend a stretch glyph that will
19024 have the end_of_box_run_p flag set for it, so there's no
19025 need for the appended newline glyph to have that flag
19027 if (it
->glyph_row
->reversed_p
19028 /* But if the appended newline glyph goes all the way to
19029 the end of the row, there will be no stretch glyph,
19030 so leave the box flag set. */
19031 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19032 it
->end_of_box_run_p
= 0;
19034 PRODUCE_GLYPHS (it
);
19036 it
->override_ascent
= -1;
19037 it
->constrain_row_ascent_descent_p
= 0;
19038 it
->current_x
= saved_x
;
19039 it
->object
= saved_object
;
19040 it
->position
= saved_pos
;
19041 it
->what
= saved_what
;
19042 it
->face_id
= saved_face_id
;
19043 it
->len
= saved_len
;
19045 it
->char_to_display
= saved_char_to_display
;
19046 it
->end_of_box_run_p
= saved_box_end
;
19055 /* Extend the face of the last glyph in the text area of IT->glyph_row
19056 to the end of the display line. Called from display_line. If the
19057 glyph row is empty, add a space glyph to it so that we know the
19058 face to draw. Set the glyph row flag fill_line_p. If the glyph
19059 row is R2L, prepend a stretch glyph to cover the empty space to the
19060 left of the leftmost glyph. */
19063 extend_face_to_end_of_line (struct it
*it
)
19065 struct face
*face
, *default_face
;
19066 struct frame
*f
= it
->f
;
19068 /* If line is already filled, do nothing. Non window-system frames
19069 get a grace of one more ``pixel'' because their characters are
19070 1-``pixel'' wide, so they hit the equality too early. This grace
19071 is needed only for R2L rows that are not continued, to produce
19072 one extra blank where we could display the cursor. */
19073 if ((it
->current_x
>= it
->last_visible_x
19074 + (!FRAME_WINDOW_P (f
)
19075 && it
->glyph_row
->reversed_p
19076 && !it
->glyph_row
->continued_p
))
19077 /* If the window has display margins, we will need to extend
19078 their face even if the text area is filled. */
19079 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19080 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19083 /* The default face, possibly remapped. */
19084 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19086 /* Face extension extends the background and box of IT->face_id
19087 to the end of the line. If the background equals the background
19088 of the frame, we don't have to do anything. */
19089 if (it
->face_before_selective_p
)
19090 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19092 face
= FACE_FROM_ID (f
, it
->face_id
);
19094 if (FRAME_WINDOW_P (f
)
19095 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19096 && face
->box
== FACE_NO_BOX
19097 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19098 #ifdef HAVE_WINDOW_SYSTEM
19101 && !it
->glyph_row
->reversed_p
)
19104 /* Set the glyph row flag indicating that the face of the last glyph
19105 in the text area has to be drawn to the end of the text area. */
19106 it
->glyph_row
->fill_line_p
= 1;
19108 /* If current character of IT is not ASCII, make sure we have the
19109 ASCII face. This will be automatically undone the next time
19110 get_next_display_element returns a multibyte character. Note
19111 that the character will always be single byte in unibyte
19113 if (!ASCII_CHAR_P (it
->c
))
19115 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19118 if (FRAME_WINDOW_P (f
))
19120 /* If the row is empty, add a space with the current face of IT,
19121 so that we know which face to draw. */
19122 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19124 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19125 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19126 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19128 /* Mode line and the header line don't have margins, and
19129 likewise the frame's tool-bar window, if there is any. */
19130 if (!(it
->glyph_row
->mode_line_p
19131 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19132 || (WINDOWP (f
->tool_bar_window
)
19133 && it
->w
== XWINDOW (f
->tool_bar_window
))
19137 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19138 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19140 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19141 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19143 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19145 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19146 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19148 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19149 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19151 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19154 #ifdef HAVE_WINDOW_SYSTEM
19155 if (it
->glyph_row
->reversed_p
)
19157 /* Prepend a stretch glyph to the row, such that the
19158 rightmost glyph will be drawn flushed all the way to the
19159 right margin of the window. The stretch glyph that will
19160 occupy the empty space, if any, to the left of the
19162 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19163 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19164 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19166 int row_width
, stretch_ascent
, stretch_width
;
19167 struct text_pos saved_pos
;
19168 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19170 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19171 row_width
+= g
->pixel_width
;
19172 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
19173 if (stretch_width
> 0)
19176 (((it
->ascent
+ it
->descent
)
19177 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19178 saved_pos
= it
->position
;
19179 memset (&it
->position
, 0, sizeof it
->position
);
19180 saved_avoid_cursor
= it
->avoid_cursor_p
;
19181 it
->avoid_cursor_p
= 1;
19182 saved_face_id
= it
->face_id
;
19183 saved_box_start
= it
->start_of_box_run_p
;
19184 /* The last row's stretch glyph should get the default
19185 face, to avoid painting the rest of the window with
19186 the region face, if the region ends at ZV. */
19187 if (it
->glyph_row
->ends_at_zv_p
)
19188 it
->face_id
= default_face
->id
;
19190 it
->face_id
= face
->id
;
19191 it
->start_of_box_run_p
= 0;
19192 append_stretch_glyph (it
, make_number (0), stretch_width
,
19193 it
->ascent
+ it
->descent
, stretch_ascent
);
19194 it
->position
= saved_pos
;
19195 it
->avoid_cursor_p
= saved_avoid_cursor
;
19196 it
->face_id
= saved_face_id
;
19197 it
->start_of_box_run_p
= saved_box_start
;
19200 #endif /* HAVE_WINDOW_SYSTEM */
19204 /* Save some values that must not be changed. */
19205 int saved_x
= it
->current_x
;
19206 struct text_pos saved_pos
;
19207 Lisp_Object saved_object
;
19208 enum display_element_type saved_what
= it
->what
;
19209 int saved_face_id
= it
->face_id
;
19211 saved_object
= it
->object
;
19212 saved_pos
= it
->position
;
19214 it
->what
= IT_CHARACTER
;
19215 memset (&it
->position
, 0, sizeof it
->position
);
19216 it
->object
= make_number (0);
19217 it
->c
= it
->char_to_display
= ' ';
19220 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19221 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19222 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19223 && !it
->glyph_row
->mode_line_p
19224 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19226 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19227 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19229 for (it
->current_x
= 0; g
< e
; g
++)
19230 it
->current_x
+= g
->pixel_width
;
19232 it
->area
= LEFT_MARGIN_AREA
;
19233 it
->face_id
= default_face
->id
;
19234 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19235 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19237 PRODUCE_GLYPHS (it
);
19238 /* term.c:produce_glyphs advances it->current_x only for
19240 it
->current_x
+= it
->pixel_width
;
19243 it
->current_x
= saved_x
;
19244 it
->area
= TEXT_AREA
;
19247 /* The last row's blank glyphs should get the default face, to
19248 avoid painting the rest of the window with the region face,
19249 if the region ends at ZV. */
19250 if (it
->glyph_row
->ends_at_zv_p
)
19251 it
->face_id
= default_face
->id
;
19253 it
->face_id
= face
->id
;
19254 PRODUCE_GLYPHS (it
);
19256 while (it
->current_x
<= it
->last_visible_x
)
19257 PRODUCE_GLYPHS (it
);
19259 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19260 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19261 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19262 && !it
->glyph_row
->mode_line_p
19263 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19265 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19266 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19268 for ( ; g
< e
; g
++)
19269 it
->current_x
+= g
->pixel_width
;
19271 it
->area
= RIGHT_MARGIN_AREA
;
19272 it
->face_id
= default_face
->id
;
19273 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19274 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19276 PRODUCE_GLYPHS (it
);
19277 it
->current_x
+= it
->pixel_width
;
19280 it
->area
= TEXT_AREA
;
19283 /* Don't count these blanks really. It would let us insert a left
19284 truncation glyph below and make us set the cursor on them, maybe. */
19285 it
->current_x
= saved_x
;
19286 it
->object
= saved_object
;
19287 it
->position
= saved_pos
;
19288 it
->what
= saved_what
;
19289 it
->face_id
= saved_face_id
;
19294 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19295 trailing whitespace. */
19298 trailing_whitespace_p (ptrdiff_t charpos
)
19300 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19303 while (bytepos
< ZV_BYTE
19304 && (c
= FETCH_CHAR (bytepos
),
19305 c
== ' ' || c
== '\t'))
19308 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19310 if (bytepos
!= PT_BYTE
)
19317 /* Highlight trailing whitespace, if any, in ROW. */
19320 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19322 int used
= row
->used
[TEXT_AREA
];
19326 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19327 struct glyph
*glyph
= start
+ used
- 1;
19329 if (row
->reversed_p
)
19331 /* Right-to-left rows need to be processed in the opposite
19332 direction, so swap the edge pointers. */
19334 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19337 /* Skip over glyphs inserted to display the cursor at the
19338 end of a line, for extending the face of the last glyph
19339 to the end of the line on terminals, and for truncation
19340 and continuation glyphs. */
19341 if (!row
->reversed_p
)
19343 while (glyph
>= start
19344 && glyph
->type
== CHAR_GLYPH
19345 && INTEGERP (glyph
->object
))
19350 while (glyph
<= start
19351 && glyph
->type
== CHAR_GLYPH
19352 && INTEGERP (glyph
->object
))
19356 /* If last glyph is a space or stretch, and it's trailing
19357 whitespace, set the face of all trailing whitespace glyphs in
19358 IT->glyph_row to `trailing-whitespace'. */
19359 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19360 && BUFFERP (glyph
->object
)
19361 && (glyph
->type
== STRETCH_GLYPH
19362 || (glyph
->type
== CHAR_GLYPH
19363 && glyph
->u
.ch
== ' '))
19364 && trailing_whitespace_p (glyph
->charpos
))
19366 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19370 if (!row
->reversed_p
)
19372 while (glyph
>= start
19373 && BUFFERP (glyph
->object
)
19374 && (glyph
->type
== STRETCH_GLYPH
19375 || (glyph
->type
== CHAR_GLYPH
19376 && glyph
->u
.ch
== ' ')))
19377 (glyph
--)->face_id
= face_id
;
19381 while (glyph
<= start
19382 && BUFFERP (glyph
->object
)
19383 && (glyph
->type
== STRETCH_GLYPH
19384 || (glyph
->type
== CHAR_GLYPH
19385 && glyph
->u
.ch
== ' ')))
19386 (glyph
++)->face_id
= face_id
;
19393 /* Value is non-zero if glyph row ROW should be
19394 considered to hold the buffer position CHARPOS. */
19397 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19401 if (charpos
== CHARPOS (row
->end
.pos
)
19402 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19404 /* Suppose the row ends on a string.
19405 Unless the row is continued, that means it ends on a newline
19406 in the string. If it's anything other than a display string
19407 (e.g., a before-string from an overlay), we don't want the
19408 cursor there. (This heuristic seems to give the optimal
19409 behavior for the various types of multi-line strings.)
19410 One exception: if the string has `cursor' property on one of
19411 its characters, we _do_ want the cursor there. */
19412 if (CHARPOS (row
->end
.string_pos
) >= 0)
19414 if (row
->continued_p
)
19418 /* Check for `display' property. */
19419 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19420 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19421 struct glyph
*glyph
;
19424 for (glyph
= end
; glyph
>= beg
; --glyph
)
19425 if (STRINGP (glyph
->object
))
19428 = Fget_char_property (make_number (charpos
),
19432 && display_prop_string_p (prop
, glyph
->object
));
19433 /* If there's a `cursor' property on one of the
19434 string's characters, this row is a cursor row,
19435 even though this is not a display string. */
19438 Lisp_Object s
= glyph
->object
;
19440 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19442 ptrdiff_t gpos
= glyph
->charpos
;
19444 if (!NILP (Fget_char_property (make_number (gpos
),
19456 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19458 /* If the row ends in middle of a real character,
19459 and the line is continued, we want the cursor here.
19460 That's because CHARPOS (ROW->end.pos) would equal
19461 PT if PT is before the character. */
19462 if (!row
->ends_in_ellipsis_p
)
19463 result
= row
->continued_p
;
19465 /* If the row ends in an ellipsis, then
19466 CHARPOS (ROW->end.pos) will equal point after the
19467 invisible text. We want that position to be displayed
19468 after the ellipsis. */
19471 /* If the row ends at ZV, display the cursor at the end of that
19472 row instead of at the start of the row below. */
19473 else if (row
->ends_at_zv_p
)
19482 /* Value is non-zero if glyph row ROW should be
19483 used to hold the cursor. */
19486 cursor_row_p (struct glyph_row
*row
)
19488 return row_for_charpos_p (row
, PT
);
19493 /* Push the property PROP so that it will be rendered at the current
19494 position in IT. Return 1 if PROP was successfully pushed, 0
19495 otherwise. Called from handle_line_prefix to handle the
19496 `line-prefix' and `wrap-prefix' properties. */
19499 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19501 struct text_pos pos
=
19502 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19504 eassert (it
->method
== GET_FROM_BUFFER
19505 || it
->method
== GET_FROM_DISPLAY_VECTOR
19506 || it
->method
== GET_FROM_STRING
);
19508 /* We need to save the current buffer/string position, so it will be
19509 restored by pop_it, because iterate_out_of_display_property
19510 depends on that being set correctly, but some situations leave
19511 it->position not yet set when this function is called. */
19512 push_it (it
, &pos
);
19514 if (STRINGP (prop
))
19516 if (SCHARS (prop
) == 0)
19523 it
->string_from_prefix_prop_p
= 1;
19524 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19525 it
->current
.overlay_string_index
= -1;
19526 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19527 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19528 it
->method
= GET_FROM_STRING
;
19529 it
->stop_charpos
= 0;
19531 it
->base_level_stop
= 0;
19533 /* Force paragraph direction to be that of the parent
19535 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19536 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19538 it
->paragraph_embedding
= L2R
;
19540 /* Set up the bidi iterator for this display string. */
19543 it
->bidi_it
.string
.lstring
= it
->string
;
19544 it
->bidi_it
.string
.s
= NULL
;
19545 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19546 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19547 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19548 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19549 it
->bidi_it
.w
= it
->w
;
19550 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19553 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19555 it
->method
= GET_FROM_STRETCH
;
19558 #ifdef HAVE_WINDOW_SYSTEM
19559 else if (IMAGEP (prop
))
19561 it
->what
= IT_IMAGE
;
19562 it
->image_id
= lookup_image (it
->f
, prop
);
19563 it
->method
= GET_FROM_IMAGE
;
19565 #endif /* HAVE_WINDOW_SYSTEM */
19568 pop_it (it
); /* bogus display property, give up */
19575 /* Return the character-property PROP at the current position in IT. */
19578 get_it_property (struct it
*it
, Lisp_Object prop
)
19580 Lisp_Object position
, object
= it
->object
;
19582 if (STRINGP (object
))
19583 position
= make_number (IT_STRING_CHARPOS (*it
));
19584 else if (BUFFERP (object
))
19586 position
= make_number (IT_CHARPOS (*it
));
19587 object
= it
->window
;
19592 return Fget_char_property (position
, prop
, object
);
19595 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19598 handle_line_prefix (struct it
*it
)
19600 Lisp_Object prefix
;
19602 if (it
->continuation_lines_width
> 0)
19604 prefix
= get_it_property (it
, Qwrap_prefix
);
19606 prefix
= Vwrap_prefix
;
19610 prefix
= get_it_property (it
, Qline_prefix
);
19612 prefix
= Vline_prefix
;
19614 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19616 /* If the prefix is wider than the window, and we try to wrap
19617 it, it would acquire its own wrap prefix, and so on till the
19618 iterator stack overflows. So, don't wrap the prefix. */
19619 it
->line_wrap
= TRUNCATE
;
19620 it
->avoid_cursor_p
= 1;
19626 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19627 only for R2L lines from display_line and display_string, when they
19628 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19629 the line/string needs to be continued on the next glyph row. */
19631 unproduce_glyphs (struct it
*it
, int n
)
19633 struct glyph
*glyph
, *end
;
19635 eassert (it
->glyph_row
);
19636 eassert (it
->glyph_row
->reversed_p
);
19637 eassert (it
->area
== TEXT_AREA
);
19638 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19640 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19641 n
= it
->glyph_row
->used
[TEXT_AREA
];
19642 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19643 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19644 for ( ; glyph
< end
; glyph
++)
19645 glyph
[-n
] = *glyph
;
19648 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19649 and ROW->maxpos. */
19651 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19652 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19653 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19655 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19656 lines' rows is implemented for bidi-reordered rows. */
19658 /* ROW->minpos is the value of min_pos, the minimal buffer position
19659 we have in ROW, or ROW->start.pos if that is smaller. */
19660 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19661 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19663 /* We didn't find buffer positions smaller than ROW->start, or
19664 didn't find _any_ valid buffer positions in any of the glyphs,
19665 so we must trust the iterator's computed positions. */
19666 row
->minpos
= row
->start
.pos
;
19669 max_pos
= CHARPOS (it
->current
.pos
);
19670 max_bpos
= BYTEPOS (it
->current
.pos
);
19673 /* Here are the various use-cases for ending the row, and the
19674 corresponding values for ROW->maxpos:
19676 Line ends in a newline from buffer eol_pos + 1
19677 Line is continued from buffer max_pos + 1
19678 Line is truncated on right it->current.pos
19679 Line ends in a newline from string max_pos + 1(*)
19680 (*) + 1 only when line ends in a forward scan
19681 Line is continued from string max_pos
19682 Line is continued from display vector max_pos
19683 Line is entirely from a string min_pos == max_pos
19684 Line is entirely from a display vector min_pos == max_pos
19685 Line that ends at ZV ZV
19687 If you discover other use-cases, please add them here as
19689 if (row
->ends_at_zv_p
)
19690 row
->maxpos
= it
->current
.pos
;
19691 else if (row
->used
[TEXT_AREA
])
19693 int seen_this_string
= 0;
19694 struct glyph_row
*r1
= row
- 1;
19696 /* Did we see the same display string on the previous row? */
19697 if (STRINGP (it
->object
)
19698 /* this is not the first row */
19699 && row
> it
->w
->desired_matrix
->rows
19700 /* previous row is not the header line */
19701 && !r1
->mode_line_p
19702 /* previous row also ends in a newline from a string */
19703 && r1
->ends_in_newline_from_string_p
)
19705 struct glyph
*start
, *end
;
19707 /* Search for the last glyph of the previous row that came
19708 from buffer or string. Depending on whether the row is
19709 L2R or R2L, we need to process it front to back or the
19710 other way round. */
19711 if (!r1
->reversed_p
)
19713 start
= r1
->glyphs
[TEXT_AREA
];
19714 end
= start
+ r1
->used
[TEXT_AREA
];
19715 /* Glyphs inserted by redisplay have an integer (zero)
19716 as their object. */
19718 && INTEGERP ((end
- 1)->object
)
19719 && (end
- 1)->charpos
<= 0)
19723 if (EQ ((end
- 1)->object
, it
->object
))
19724 seen_this_string
= 1;
19727 /* If all the glyphs of the previous row were inserted
19728 by redisplay, it means the previous row was
19729 produced from a single newline, which is only
19730 possible if that newline came from the same string
19731 as the one which produced this ROW. */
19732 seen_this_string
= 1;
19736 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19737 start
= end
+ r1
->used
[TEXT_AREA
];
19739 && INTEGERP ((end
+ 1)->object
)
19740 && (end
+ 1)->charpos
<= 0)
19744 if (EQ ((end
+ 1)->object
, it
->object
))
19745 seen_this_string
= 1;
19748 seen_this_string
= 1;
19751 /* Take note of each display string that covers a newline only
19752 once, the first time we see it. This is for when a display
19753 string includes more than one newline in it. */
19754 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19756 /* If we were scanning the buffer forward when we displayed
19757 the string, we want to account for at least one buffer
19758 position that belongs to this row (position covered by
19759 the display string), so that cursor positioning will
19760 consider this row as a candidate when point is at the end
19761 of the visual line represented by this row. This is not
19762 required when scanning back, because max_pos will already
19763 have a much larger value. */
19764 if (CHARPOS (row
->end
.pos
) > max_pos
)
19765 INC_BOTH (max_pos
, max_bpos
);
19766 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19768 else if (CHARPOS (it
->eol_pos
) > 0)
19769 SET_TEXT_POS (row
->maxpos
,
19770 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19771 else if (row
->continued_p
)
19773 /* If max_pos is different from IT's current position, it
19774 means IT->method does not belong to the display element
19775 at max_pos. However, it also means that the display
19776 element at max_pos was displayed in its entirety on this
19777 line, which is equivalent to saying that the next line
19778 starts at the next buffer position. */
19779 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19780 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19783 INC_BOTH (max_pos
, max_bpos
);
19784 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19787 else if (row
->truncated_on_right_p
)
19788 /* display_line already called reseat_at_next_visible_line_start,
19789 which puts the iterator at the beginning of the next line, in
19790 the logical order. */
19791 row
->maxpos
= it
->current
.pos
;
19792 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19793 /* A line that is entirely from a string/image/stretch... */
19794 row
->maxpos
= row
->minpos
;
19799 row
->maxpos
= it
->current
.pos
;
19802 /* Construct the glyph row IT->glyph_row in the desired matrix of
19803 IT->w from text at the current position of IT. See dispextern.h
19804 for an overview of struct it. Value is non-zero if
19805 IT->glyph_row displays text, as opposed to a line displaying ZV
19809 display_line (struct it
*it
)
19811 struct glyph_row
*row
= it
->glyph_row
;
19812 Lisp_Object overlay_arrow_string
;
19814 void *wrap_data
= NULL
;
19815 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19816 int wrap_row_used
= -1;
19817 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19818 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19819 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19820 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19821 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19823 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19824 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19826 /* We always start displaying at hpos zero even if hscrolled. */
19827 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19829 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19830 >= it
->w
->desired_matrix
->nrows
)
19832 it
->w
->nrows_scale_factor
++;
19833 it
->f
->fonts_changed
= 1;
19837 /* Clear the result glyph row and enable it. */
19838 prepare_desired_row (row
);
19840 row
->y
= it
->current_y
;
19841 row
->start
= it
->start
;
19842 row
->continuation_lines_width
= it
->continuation_lines_width
;
19843 row
->displays_text_p
= 1;
19844 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19845 it
->starts_in_middle_of_char_p
= 0;
19847 /* Arrange the overlays nicely for our purposes. Usually, we call
19848 display_line on only one line at a time, in which case this
19849 can't really hurt too much, or we call it on lines which appear
19850 one after another in the buffer, in which case all calls to
19851 recenter_overlay_lists but the first will be pretty cheap. */
19852 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19854 /* Move over display elements that are not visible because we are
19855 hscrolled. This may stop at an x-position < IT->first_visible_x
19856 if the first glyph is partially visible or if we hit a line end. */
19857 if (it
->current_x
< it
->first_visible_x
)
19859 enum move_it_result move_result
;
19861 this_line_min_pos
= row
->start
.pos
;
19862 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19863 MOVE_TO_POS
| MOVE_TO_X
);
19864 /* If we are under a large hscroll, move_it_in_display_line_to
19865 could hit the end of the line without reaching
19866 it->first_visible_x. Pretend that we did reach it. This is
19867 especially important on a TTY, where we will call
19868 extend_face_to_end_of_line, which needs to know how many
19869 blank glyphs to produce. */
19870 if (it
->current_x
< it
->first_visible_x
19871 && (move_result
== MOVE_NEWLINE_OR_CR
19872 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19873 it
->current_x
= it
->first_visible_x
;
19875 /* Record the smallest positions seen while we moved over
19876 display elements that are not visible. This is needed by
19877 redisplay_internal for optimizing the case where the cursor
19878 stays inside the same line. The rest of this function only
19879 considers positions that are actually displayed, so
19880 RECORD_MAX_MIN_POS will not otherwise record positions that
19881 are hscrolled to the left of the left edge of the window. */
19882 min_pos
= CHARPOS (this_line_min_pos
);
19883 min_bpos
= BYTEPOS (this_line_min_pos
);
19887 /* We only do this when not calling `move_it_in_display_line_to'
19888 above, because move_it_in_display_line_to calls
19889 handle_line_prefix itself. */
19890 handle_line_prefix (it
);
19893 /* Get the initial row height. This is either the height of the
19894 text hscrolled, if there is any, or zero. */
19895 row
->ascent
= it
->max_ascent
;
19896 row
->height
= it
->max_ascent
+ it
->max_descent
;
19897 row
->phys_ascent
= it
->max_phys_ascent
;
19898 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19899 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19901 /* Utility macro to record max and min buffer positions seen until now. */
19902 #define RECORD_MAX_MIN_POS(IT) \
19905 int composition_p = !STRINGP ((IT)->string) \
19906 && ((IT)->what == IT_COMPOSITION); \
19907 ptrdiff_t current_pos = \
19908 composition_p ? (IT)->cmp_it.charpos \
19909 : IT_CHARPOS (*(IT)); \
19910 ptrdiff_t current_bpos = \
19911 composition_p ? CHAR_TO_BYTE (current_pos) \
19912 : IT_BYTEPOS (*(IT)); \
19913 if (current_pos < min_pos) \
19915 min_pos = current_pos; \
19916 min_bpos = current_bpos; \
19918 if (IT_CHARPOS (*it) > max_pos) \
19920 max_pos = IT_CHARPOS (*it); \
19921 max_bpos = IT_BYTEPOS (*it); \
19926 /* Loop generating characters. The loop is left with IT on the next
19927 character to display. */
19930 int n_glyphs_before
, hpos_before
, x_before
;
19932 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19934 /* Retrieve the next thing to display. Value is zero if end of
19936 if (!get_next_display_element (it
))
19938 /* Maybe add a space at the end of this line that is used to
19939 display the cursor there under X. Set the charpos of the
19940 first glyph of blank lines not corresponding to any text
19942 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19943 row
->exact_window_width_line_p
= 1;
19944 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19945 || row
->used
[TEXT_AREA
] == 0)
19947 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19948 row
->displays_text_p
= 0;
19950 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
19951 && (!MINI_WINDOW_P (it
->w
)
19952 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19953 row
->indicate_empty_line_p
= 1;
19956 it
->continuation_lines_width
= 0;
19957 row
->ends_at_zv_p
= 1;
19958 /* A row that displays right-to-left text must always have
19959 its last face extended all the way to the end of line,
19960 even if this row ends in ZV, because we still write to
19961 the screen left to right. We also need to extend the
19962 last face if the default face is remapped to some
19963 different face, otherwise the functions that clear
19964 portions of the screen will clear with the default face's
19965 background color. */
19966 if (row
->reversed_p
19967 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19968 extend_face_to_end_of_line (it
);
19972 /* Now, get the metrics of what we want to display. This also
19973 generates glyphs in `row' (which is IT->glyph_row). */
19974 n_glyphs_before
= row
->used
[TEXT_AREA
];
19977 /* Remember the line height so far in case the next element doesn't
19978 fit on the line. */
19979 if (it
->line_wrap
!= TRUNCATE
)
19981 ascent
= it
->max_ascent
;
19982 descent
= it
->max_descent
;
19983 phys_ascent
= it
->max_phys_ascent
;
19984 phys_descent
= it
->max_phys_descent
;
19986 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19988 if (IT_DISPLAYING_WHITESPACE (it
))
19992 SAVE_IT (wrap_it
, *it
, wrap_data
);
19994 wrap_row_used
= row
->used
[TEXT_AREA
];
19995 wrap_row_ascent
= row
->ascent
;
19996 wrap_row_height
= row
->height
;
19997 wrap_row_phys_ascent
= row
->phys_ascent
;
19998 wrap_row_phys_height
= row
->phys_height
;
19999 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20000 wrap_row_min_pos
= min_pos
;
20001 wrap_row_min_bpos
= min_bpos
;
20002 wrap_row_max_pos
= max_pos
;
20003 wrap_row_max_bpos
= max_bpos
;
20009 PRODUCE_GLYPHS (it
);
20011 /* If this display element was in marginal areas, continue with
20013 if (it
->area
!= TEXT_AREA
)
20015 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20016 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20017 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20018 row
->phys_height
= max (row
->phys_height
,
20019 it
->max_phys_ascent
+ it
->max_phys_descent
);
20020 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20021 it
->max_extra_line_spacing
);
20022 set_iterator_to_next (it
, 1);
20026 /* Does the display element fit on the line? If we truncate
20027 lines, we should draw past the right edge of the window. If
20028 we don't truncate, we want to stop so that we can display the
20029 continuation glyph before the right margin. If lines are
20030 continued, there are two possible strategies for characters
20031 resulting in more than 1 glyph (e.g. tabs): Display as many
20032 glyphs as possible in this line and leave the rest for the
20033 continuation line, or display the whole element in the next
20034 line. Original redisplay did the former, so we do it also. */
20035 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20036 hpos_before
= it
->hpos
;
20039 if (/* Not a newline. */
20041 /* Glyphs produced fit entirely in the line. */
20042 && it
->current_x
< it
->last_visible_x
)
20044 it
->hpos
+= nglyphs
;
20045 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20046 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20047 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20048 row
->phys_height
= max (row
->phys_height
,
20049 it
->max_phys_ascent
+ it
->max_phys_descent
);
20050 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20051 it
->max_extra_line_spacing
);
20052 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
20053 row
->x
= x
- it
->first_visible_x
;
20054 /* Record the maximum and minimum buffer positions seen so
20055 far in glyphs that will be displayed by this row. */
20057 RECORD_MAX_MIN_POS (it
);
20062 struct glyph
*glyph
;
20064 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20066 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20067 new_x
= x
+ glyph
->pixel_width
;
20069 if (/* Lines are continued. */
20070 it
->line_wrap
!= TRUNCATE
20071 && (/* Glyph doesn't fit on the line. */
20072 new_x
> it
->last_visible_x
20073 /* Or it fits exactly on a window system frame. */
20074 || (new_x
== it
->last_visible_x
20075 && FRAME_WINDOW_P (it
->f
)
20076 && (row
->reversed_p
20077 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20078 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20080 /* End of a continued line. */
20083 || (new_x
== it
->last_visible_x
20084 && FRAME_WINDOW_P (it
->f
)
20085 && (row
->reversed_p
20086 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20087 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20089 /* Current glyph is the only one on the line or
20090 fits exactly on the line. We must continue
20091 the line because we can't draw the cursor
20092 after the glyph. */
20093 row
->continued_p
= 1;
20094 it
->current_x
= new_x
;
20095 it
->continuation_lines_width
+= new_x
;
20097 if (i
== nglyphs
- 1)
20099 /* If line-wrap is on, check if a previous
20100 wrap point was found. */
20101 if (wrap_row_used
> 0
20102 /* Even if there is a previous wrap
20103 point, continue the line here as
20104 usual, if (i) the previous character
20105 was a space or tab AND (ii) the
20106 current character is not. */
20108 || IT_DISPLAYING_WHITESPACE (it
)))
20111 /* Record the maximum and minimum buffer
20112 positions seen so far in glyphs that will be
20113 displayed by this row. */
20115 RECORD_MAX_MIN_POS (it
);
20116 set_iterator_to_next (it
, 1);
20117 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20119 if (!get_next_display_element (it
))
20121 row
->exact_window_width_line_p
= 1;
20122 it
->continuation_lines_width
= 0;
20123 row
->continued_p
= 0;
20124 row
->ends_at_zv_p
= 1;
20126 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20128 row
->continued_p
= 0;
20129 row
->exact_window_width_line_p
= 1;
20133 else if (it
->bidi_p
)
20134 RECORD_MAX_MIN_POS (it
);
20135 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20136 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20137 extend_face_to_end_of_line (it
);
20139 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20140 && !FRAME_WINDOW_P (it
->f
))
20142 /* A padding glyph that doesn't fit on this line.
20143 This means the whole character doesn't fit
20145 if (row
->reversed_p
)
20146 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20147 - n_glyphs_before
);
20148 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20150 /* Fill the rest of the row with continuation
20151 glyphs like in 20.x. */
20152 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20153 < row
->glyphs
[1 + TEXT_AREA
])
20154 produce_special_glyphs (it
, IT_CONTINUATION
);
20156 row
->continued_p
= 1;
20157 it
->current_x
= x_before
;
20158 it
->continuation_lines_width
+= x_before
;
20160 /* Restore the height to what it was before the
20161 element not fitting on the line. */
20162 it
->max_ascent
= ascent
;
20163 it
->max_descent
= descent
;
20164 it
->max_phys_ascent
= phys_ascent
;
20165 it
->max_phys_descent
= phys_descent
;
20166 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20167 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20168 extend_face_to_end_of_line (it
);
20170 else if (wrap_row_used
> 0)
20173 if (row
->reversed_p
)
20174 unproduce_glyphs (it
,
20175 row
->used
[TEXT_AREA
] - wrap_row_used
);
20176 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20177 it
->continuation_lines_width
+= wrap_x
;
20178 row
->used
[TEXT_AREA
] = wrap_row_used
;
20179 row
->ascent
= wrap_row_ascent
;
20180 row
->height
= wrap_row_height
;
20181 row
->phys_ascent
= wrap_row_phys_ascent
;
20182 row
->phys_height
= wrap_row_phys_height
;
20183 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20184 min_pos
= wrap_row_min_pos
;
20185 min_bpos
= wrap_row_min_bpos
;
20186 max_pos
= wrap_row_max_pos
;
20187 max_bpos
= wrap_row_max_bpos
;
20188 row
->continued_p
= 1;
20189 row
->ends_at_zv_p
= 0;
20190 row
->exact_window_width_line_p
= 0;
20191 it
->continuation_lines_width
+= x
;
20193 /* Make sure that a non-default face is extended
20194 up to the right margin of the window. */
20195 extend_face_to_end_of_line (it
);
20197 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20199 /* A TAB that extends past the right edge of the
20200 window. This produces a single glyph on
20201 window system frames. We leave the glyph in
20202 this row and let it fill the row, but don't
20203 consume the TAB. */
20204 if ((row
->reversed_p
20205 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20206 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20207 produce_special_glyphs (it
, IT_CONTINUATION
);
20208 it
->continuation_lines_width
+= it
->last_visible_x
;
20209 row
->ends_in_middle_of_char_p
= 1;
20210 row
->continued_p
= 1;
20211 glyph
->pixel_width
= it
->last_visible_x
- x
;
20212 it
->starts_in_middle_of_char_p
= 1;
20213 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20214 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20215 extend_face_to_end_of_line (it
);
20219 /* Something other than a TAB that draws past
20220 the right edge of the window. Restore
20221 positions to values before the element. */
20222 if (row
->reversed_p
)
20223 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20224 - (n_glyphs_before
+ i
));
20225 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20227 /* Display continuation glyphs. */
20228 it
->current_x
= x_before
;
20229 it
->continuation_lines_width
+= x
;
20230 if (!FRAME_WINDOW_P (it
->f
)
20231 || (row
->reversed_p
20232 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20233 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20234 produce_special_glyphs (it
, IT_CONTINUATION
);
20235 row
->continued_p
= 1;
20237 extend_face_to_end_of_line (it
);
20239 if (nglyphs
> 1 && i
> 0)
20241 row
->ends_in_middle_of_char_p
= 1;
20242 it
->starts_in_middle_of_char_p
= 1;
20245 /* Restore the height to what it was before the
20246 element not fitting on the line. */
20247 it
->max_ascent
= ascent
;
20248 it
->max_descent
= descent
;
20249 it
->max_phys_ascent
= phys_ascent
;
20250 it
->max_phys_descent
= phys_descent
;
20255 else if (new_x
> it
->first_visible_x
)
20257 /* Increment number of glyphs actually displayed. */
20260 /* Record the maximum and minimum buffer positions
20261 seen so far in glyphs that will be displayed by
20264 RECORD_MAX_MIN_POS (it
);
20266 if (x
< it
->first_visible_x
)
20267 /* Glyph is partially visible, i.e. row starts at
20268 negative X position. */
20269 row
->x
= x
- it
->first_visible_x
;
20273 /* Glyph is completely off the left margin of the
20274 window. This should not happen because of the
20275 move_it_in_display_line at the start of this
20276 function, unless the text display area of the
20277 window is empty. */
20278 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20281 /* Even if this display element produced no glyphs at all,
20282 we want to record its position. */
20283 if (it
->bidi_p
&& nglyphs
== 0)
20284 RECORD_MAX_MIN_POS (it
);
20286 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20287 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20288 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20289 row
->phys_height
= max (row
->phys_height
,
20290 it
->max_phys_ascent
+ it
->max_phys_descent
);
20291 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20292 it
->max_extra_line_spacing
);
20294 /* End of this display line if row is continued. */
20295 if (row
->continued_p
|| row
->ends_at_zv_p
)
20300 /* Is this a line end? If yes, we're also done, after making
20301 sure that a non-default face is extended up to the right
20302 margin of the window. */
20303 if (ITERATOR_AT_END_OF_LINE_P (it
))
20305 int used_before
= row
->used
[TEXT_AREA
];
20307 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20309 /* Add a space at the end of the line that is used to
20310 display the cursor there. */
20311 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20312 append_space_for_newline (it
, 0);
20314 /* Extend the face to the end of the line. */
20315 extend_face_to_end_of_line (it
);
20317 /* Make sure we have the position. */
20318 if (used_before
== 0)
20319 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20321 /* Record the position of the newline, for use in
20323 it
->eol_pos
= it
->current
.pos
;
20325 /* Consume the line end. This skips over invisible lines. */
20326 set_iterator_to_next (it
, 1);
20327 it
->continuation_lines_width
= 0;
20331 /* Proceed with next display element. Note that this skips
20332 over lines invisible because of selective display. */
20333 set_iterator_to_next (it
, 1);
20335 /* If we truncate lines, we are done when the last displayed
20336 glyphs reach past the right margin of the window. */
20337 if (it
->line_wrap
== TRUNCATE
20338 && ((FRAME_WINDOW_P (it
->f
)
20339 /* Images are preprocessed in produce_image_glyph such
20340 that they are cropped at the right edge of the
20341 window, so an image glyph will always end exactly at
20342 last_visible_x, even if there's no right fringe. */
20343 && (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) || it
->what
== IT_IMAGE
))
20344 ? (it
->current_x
>= it
->last_visible_x
)
20345 : (it
->current_x
> it
->last_visible_x
)))
20347 /* Maybe add truncation glyphs. */
20348 if (!FRAME_WINDOW_P (it
->f
)
20349 || (row
->reversed_p
20350 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20351 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20355 if (!row
->reversed_p
)
20357 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20358 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20363 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20364 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20366 /* Remove any padding glyphs at the front of ROW, to
20367 make room for the truncation glyphs we will be
20368 adding below. The loop below always inserts at
20369 least one truncation glyph, so also remove the
20370 last glyph added to ROW. */
20371 unproduce_glyphs (it
, i
+ 1);
20372 /* Adjust i for the loop below. */
20373 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20376 /* produce_special_glyphs overwrites the last glyph, so
20377 we don't want that if we want to keep that last
20378 glyph, which means it's an image. */
20379 if (it
->current_x
> it
->last_visible_x
)
20381 it
->current_x
= x_before
;
20382 if (!FRAME_WINDOW_P (it
->f
))
20384 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20386 row
->used
[TEXT_AREA
] = i
;
20387 produce_special_glyphs (it
, IT_TRUNCATION
);
20392 row
->used
[TEXT_AREA
] = i
;
20393 produce_special_glyphs (it
, IT_TRUNCATION
);
20395 it
->hpos
= hpos_before
;
20398 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20400 /* Don't truncate if we can overflow newline into fringe. */
20401 if (!get_next_display_element (it
))
20403 it
->continuation_lines_width
= 0;
20404 row
->ends_at_zv_p
= 1;
20405 row
->exact_window_width_line_p
= 1;
20408 if (ITERATOR_AT_END_OF_LINE_P (it
))
20410 row
->exact_window_width_line_p
= 1;
20411 goto at_end_of_line
;
20413 it
->current_x
= x_before
;
20414 it
->hpos
= hpos_before
;
20417 row
->truncated_on_right_p
= 1;
20418 it
->continuation_lines_width
= 0;
20419 reseat_at_next_visible_line_start (it
, 0);
20420 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
20426 bidi_unshelve_cache (wrap_data
, 1);
20428 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20429 at the left window margin. */
20430 if (it
->first_visible_x
20431 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20433 if (!FRAME_WINDOW_P (it
->f
)
20434 || (((row
->reversed_p
20435 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20436 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20437 /* Don't let insert_left_trunc_glyphs overwrite the
20438 first glyph of the row if it is an image. */
20439 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20440 insert_left_trunc_glyphs (it
);
20441 row
->truncated_on_left_p
= 1;
20444 /* Remember the position at which this line ends.
20446 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20447 cannot be before the call to find_row_edges below, since that is
20448 where these positions are determined. */
20449 row
->end
= it
->current
;
20452 row
->minpos
= row
->start
.pos
;
20453 row
->maxpos
= row
->end
.pos
;
20457 /* ROW->minpos and ROW->maxpos must be the smallest and
20458 `1 + the largest' buffer positions in ROW. But if ROW was
20459 bidi-reordered, these two positions can be anywhere in the
20460 row, so we must determine them now. */
20461 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20464 /* If the start of this line is the overlay arrow-position, then
20465 mark this glyph row as the one containing the overlay arrow.
20466 This is clearly a mess with variable size fonts. It would be
20467 better to let it be displayed like cursors under X. */
20468 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20469 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20470 !NILP (overlay_arrow_string
)))
20472 /* Overlay arrow in window redisplay is a fringe bitmap. */
20473 if (STRINGP (overlay_arrow_string
))
20475 struct glyph_row
*arrow_row
20476 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20477 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20478 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20479 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20480 struct glyph
*p2
, *end
;
20482 /* Copy the arrow glyphs. */
20483 while (glyph
< arrow_end
)
20486 /* Throw away padding glyphs. */
20488 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20489 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20495 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20500 eassert (INTEGERP (overlay_arrow_string
));
20501 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20503 overlay_arrow_seen
= 1;
20506 /* Highlight trailing whitespace. */
20507 if (!NILP (Vshow_trailing_whitespace
))
20508 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20510 /* Compute pixel dimensions of this line. */
20511 compute_line_metrics (it
);
20513 /* Implementation note: No changes in the glyphs of ROW or in their
20514 faces can be done past this point, because compute_line_metrics
20515 computes ROW's hash value and stores it within the glyph_row
20518 /* Record whether this row ends inside an ellipsis. */
20519 row
->ends_in_ellipsis_p
20520 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20521 && it
->ellipsis_p
);
20523 /* Save fringe bitmaps in this row. */
20524 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20525 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20526 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20527 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20529 it
->left_user_fringe_bitmap
= 0;
20530 it
->left_user_fringe_face_id
= 0;
20531 it
->right_user_fringe_bitmap
= 0;
20532 it
->right_user_fringe_face_id
= 0;
20534 /* Maybe set the cursor. */
20535 cvpos
= it
->w
->cursor
.vpos
;
20537 /* In bidi-reordered rows, keep checking for proper cursor
20538 position even if one has been found already, because buffer
20539 positions in such rows change non-linearly with ROW->VPOS,
20540 when a line is continued. One exception: when we are at ZV,
20541 display cursor on the first suitable glyph row, since all
20542 the empty rows after that also have their position set to ZV. */
20543 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20544 lines' rows is implemented for bidi-reordered rows. */
20546 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20547 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20548 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20549 && cursor_row_p (row
))
20550 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20552 /* Prepare for the next line. This line starts horizontally at (X
20553 HPOS) = (0 0). Vertical positions are incremented. As a
20554 convenience for the caller, IT->glyph_row is set to the next
20556 it
->current_x
= it
->hpos
= 0;
20557 it
->current_y
+= row
->height
;
20558 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20561 /* The next row should by default use the same value of the
20562 reversed_p flag as this one. set_iterator_to_next decides when
20563 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20564 the flag accordingly. */
20565 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20566 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20567 it
->start
= row
->end
;
20568 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20570 #undef RECORD_MAX_MIN_POS
20573 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20574 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20575 doc
: /* Return paragraph direction at point in BUFFER.
20576 Value is either `left-to-right' or `right-to-left'.
20577 If BUFFER is omitted or nil, it defaults to the current buffer.
20579 Paragraph direction determines how the text in the paragraph is displayed.
20580 In left-to-right paragraphs, text begins at the left margin of the window
20581 and the reading direction is generally left to right. In right-to-left
20582 paragraphs, text begins at the right margin and is read from right to left.
20584 See also `bidi-paragraph-direction'. */)
20585 (Lisp_Object buffer
)
20587 struct buffer
*buf
= current_buffer
;
20588 struct buffer
*old
= buf
;
20590 if (! NILP (buffer
))
20592 CHECK_BUFFER (buffer
);
20593 buf
= XBUFFER (buffer
);
20596 if (NILP (BVAR (buf
, bidi_display_reordering
))
20597 || NILP (BVAR (buf
, enable_multibyte_characters
))
20598 /* When we are loading loadup.el, the character property tables
20599 needed for bidi iteration are not yet available. */
20600 || !NILP (Vpurify_flag
))
20601 return Qleft_to_right
;
20602 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20603 return BVAR (buf
, bidi_paragraph_direction
);
20606 /* Determine the direction from buffer text. We could try to
20607 use current_matrix if it is up to date, but this seems fast
20608 enough as it is. */
20609 struct bidi_it itb
;
20610 ptrdiff_t pos
= BUF_PT (buf
);
20611 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20613 void *itb_data
= bidi_shelve_cache ();
20615 set_buffer_temp (buf
);
20616 /* bidi_paragraph_init finds the base direction of the paragraph
20617 by searching forward from paragraph start. We need the base
20618 direction of the current or _previous_ paragraph, so we need
20619 to make sure we are within that paragraph. To that end, find
20620 the previous non-empty line. */
20621 if (pos
>= ZV
&& pos
> BEGV
)
20622 DEC_BOTH (pos
, bytepos
);
20623 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20624 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20626 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20627 || c
== ' ' || c
== '\t' || c
== '\f')
20629 if (bytepos
<= BEGV_BYTE
)
20634 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20637 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20638 itb
.paragraph_dir
= NEUTRAL_DIR
;
20639 itb
.string
.s
= NULL
;
20640 itb
.string
.lstring
= Qnil
;
20641 itb
.string
.bufpos
= 0;
20642 itb
.string
.from_disp_str
= 0;
20643 itb
.string
.unibyte
= 0;
20644 /* We have no window to use here for ignoring window-specific
20645 overlays. Using NULL for window pointer will cause
20646 compute_display_string_pos to use the current buffer. */
20648 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20649 bidi_unshelve_cache (itb_data
, 0);
20650 set_buffer_temp (old
);
20651 switch (itb
.paragraph_dir
)
20654 return Qleft_to_right
;
20657 return Qright_to_left
;
20665 DEFUN ("move-point-visually", Fmove_point_visually
,
20666 Smove_point_visually
, 1, 1, 0,
20667 doc
: /* Move point in the visual order in the specified DIRECTION.
20668 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20671 Value is the new character position of point. */)
20672 (Lisp_Object direction
)
20674 struct window
*w
= XWINDOW (selected_window
);
20675 struct buffer
*b
= XBUFFER (w
->contents
);
20676 struct glyph_row
*row
;
20678 Lisp_Object paragraph_dir
;
20680 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20681 (!(ROW)->continued_p \
20682 && INTEGERP ((GLYPH)->object) \
20683 && (GLYPH)->type == CHAR_GLYPH \
20684 && (GLYPH)->u.ch == ' ' \
20685 && (GLYPH)->charpos >= 0 \
20686 && !(GLYPH)->avoid_cursor_p)
20688 CHECK_NUMBER (direction
);
20689 dir
= XINT (direction
);
20695 /* If current matrix is up-to-date, we can use the information
20696 recorded in the glyphs, at least as long as the goal is on the
20698 if (w
->window_end_valid
20699 && !windows_or_buffers_changed
20701 && !b
->clip_changed
20702 && !b
->prevent_redisplay_optimizations_p
20703 && !window_outdated (w
)
20704 && w
->cursor
.vpos
>= 0
20705 && w
->cursor
.vpos
< w
->current_matrix
->nrows
20706 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
20708 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
20709 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
20710 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
20712 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
20714 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
20716 SET_PT (g
->charpos
);
20717 w
->cursor
.vpos
= -1;
20718 return make_number (PT
);
20720 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
20724 if (BUFFERP (gpt
->object
))
20727 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
20728 new_pos
+= (row
->reversed_p
? -dir
: dir
);
20730 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
20732 else if (BUFFERP (g
->object
))
20733 new_pos
= g
->charpos
;
20737 w
->cursor
.vpos
= -1;
20738 return make_number (PT
);
20740 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
20742 /* Glyphs inserted at the end of a non-empty line for
20743 positioning the cursor have zero charpos, so we must
20744 deduce the value of point by other means. */
20745 if (g
->charpos
> 0)
20746 SET_PT (g
->charpos
);
20747 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
20749 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
20750 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20753 w
->cursor
.vpos
= -1;
20754 return make_number (PT
);
20757 if (g
== e
|| INTEGERP (g
->object
))
20759 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
20760 goto simulate_display
;
20761 if (!row
->reversed_p
)
20765 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
20766 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
20767 goto simulate_display
;
20771 if (row
->reversed_p
&& !row
->continued_p
)
20773 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20774 w
->cursor
.vpos
= -1;
20775 return make_number (PT
);
20777 g
= row
->glyphs
[TEXT_AREA
];
20778 e
= g
+ row
->used
[TEXT_AREA
];
20779 for ( ; g
< e
; g
++)
20781 if (BUFFERP (g
->object
)
20782 /* Empty lines have only one glyph, which stands
20783 for the newline, and whose charpos is the
20784 buffer position of the newline. */
20785 || ROW_GLYPH_NEWLINE_P (row
, g
)
20786 /* When the buffer ends in a newline, the line at
20787 EOB also has one glyph, but its charpos is -1. */
20788 || (row
->ends_at_zv_p
20789 && !row
->reversed_p
20790 && INTEGERP (g
->object
)
20791 && g
->type
== CHAR_GLYPH
20792 && g
->u
.ch
== ' '))
20794 if (g
->charpos
> 0)
20795 SET_PT (g
->charpos
);
20796 else if (!row
->reversed_p
20797 && row
->ends_at_zv_p
20802 w
->cursor
.vpos
= -1;
20803 return make_number (PT
);
20809 if (!row
->reversed_p
&& !row
->continued_p
)
20811 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20812 w
->cursor
.vpos
= -1;
20813 return make_number (PT
);
20815 e
= row
->glyphs
[TEXT_AREA
];
20816 g
= e
+ row
->used
[TEXT_AREA
] - 1;
20817 for ( ; g
>= e
; g
--)
20819 if (BUFFERP (g
->object
)
20820 || (ROW_GLYPH_NEWLINE_P (row
, g
)
20822 /* Empty R2L lines on GUI frames have the buffer
20823 position of the newline stored in the stretch
20825 || g
->type
== STRETCH_GLYPH
20826 || (row
->ends_at_zv_p
20828 && INTEGERP (g
->object
)
20829 && g
->type
== CHAR_GLYPH
20830 && g
->u
.ch
== ' '))
20832 if (g
->charpos
> 0)
20833 SET_PT (g
->charpos
);
20834 else if (row
->reversed_p
20835 && row
->ends_at_zv_p
20840 w
->cursor
.vpos
= -1;
20841 return make_number (PT
);
20850 /* If we wind up here, we failed to move by using the glyphs, so we
20851 need to simulate display instead. */
20854 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
20856 paragraph_dir
= Qleft_to_right
;
20857 if (EQ (paragraph_dir
, Qright_to_left
))
20859 if (PT
<= BEGV
&& dir
< 0)
20860 xsignal0 (Qbeginning_of_buffer
);
20861 else if (PT
>= ZV
&& dir
> 0)
20862 xsignal0 (Qend_of_buffer
);
20865 struct text_pos pt
;
20867 int pt_x
, target_x
, pixel_width
, pt_vpos
;
20869 bool overshoot_expected
= false;
20870 bool target_is_eol_p
= false;
20872 /* Setup the arena. */
20873 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
20874 start_display (&it
, w
, pt
);
20876 if (it
.cmp_it
.id
< 0
20877 && it
.method
== GET_FROM_STRING
20878 && it
.area
== TEXT_AREA
20879 && it
.string_from_display_prop_p
20880 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
20881 overshoot_expected
= true;
20883 /* Find the X coordinate of point. We start from the beginning
20884 of this or previous line to make sure we are before point in
20885 the logical order (since the move_it_* functions can only
20888 reseat_at_previous_visible_line_start (&it
);
20889 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
20890 if (IT_CHARPOS (it
) != PT
)
20892 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
20893 -1, -1, -1, MOVE_TO_POS
);
20894 /* If we missed point because the character there is
20895 displayed out of a display vector that has more than one
20896 glyph, retry expecting overshoot. */
20897 if (it
.method
== GET_FROM_DISPLAY_VECTOR
20898 && it
.current
.dpvec_index
> 0
20899 && !overshoot_expected
)
20901 overshoot_expected
= true;
20904 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
20905 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
20907 pt_x
= it
.current_x
;
20909 if (dir
> 0 || overshoot_expected
)
20911 struct glyph_row
*row
= it
.glyph_row
;
20913 /* When point is at beginning of line, we don't have
20914 information about the glyph there loaded into struct
20915 it. Calling get_next_display_element fixes that. */
20917 get_next_display_element (&it
);
20918 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
20919 it
.glyph_row
= NULL
;
20920 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
20921 it
.glyph_row
= row
;
20922 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
20923 it, lest it will become out of sync with it's buffer
20925 it
.current_x
= pt_x
;
20928 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
20929 pixel_width
= it
.pixel_width
;
20930 if (overshoot_expected
&& at_eol_p
)
20932 else if (pixel_width
<= 0)
20935 /* If there's a display string (or something similar) at point,
20936 we are actually at the glyph to the left of point, so we need
20937 to correct the X coordinate. */
20938 if (overshoot_expected
)
20941 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
20943 pt_x
+= pixel_width
;
20946 /* Compute target X coordinate, either to the left or to the
20947 right of point. On TTY frames, all characters have the same
20948 pixel width of 1, so we can use that. On GUI frames we don't
20949 have an easy way of getting at the pixel width of the
20950 character to the left of point, so we use a different method
20951 of getting to that place. */
20953 target_x
= pt_x
+ pixel_width
;
20955 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
20957 /* Target X coordinate could be one line above or below the line
20958 of point, in which case we need to adjust the target X
20959 coordinate. Also, if moving to the left, we need to begin at
20960 the left edge of the point's screen line. */
20965 start_display (&it
, w
, pt
);
20966 reseat_at_previous_visible_line_start (&it
);
20967 it
.current_x
= it
.current_y
= it
.hpos
= 0;
20969 move_it_by_lines (&it
, pt_vpos
);
20973 move_it_by_lines (&it
, -1);
20974 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
20975 target_is_eol_p
= true;
20976 /* Under word-wrap, we don't know the x coordinate of
20977 the last character displayed on the previous line,
20978 which immediately precedes the wrap point. To find
20979 out its x coordinate, we try moving to the right
20980 margin of the window, which will stop at the wrap
20981 point, and then reset target_x to point at the
20982 character that precedes the wrap point. This is not
20983 needed on GUI frames, because (see below) there we
20984 move from the left margin one grapheme cluster at a
20985 time, and stop when we hit the wrap point. */
20986 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
20988 void *it_data
= NULL
;
20991 SAVE_IT (it2
, it
, it_data
);
20992 move_it_in_display_line_to (&it
, ZV
, target_x
,
20993 MOVE_TO_POS
| MOVE_TO_X
);
20994 /* If we arrived at target_x, that _is_ the last
20995 character on the previous line. */
20996 if (it
.current_x
!= target_x
)
20997 target_x
= it
.current_x
- 1;
20998 RESTORE_IT (&it
, &it2
, it_data
);
21005 || (target_x
>= it
.last_visible_x
21006 && it
.line_wrap
!= TRUNCATE
))
21009 move_it_by_lines (&it
, 0);
21010 move_it_by_lines (&it
, 1);
21015 /* Move to the target X coordinate. */
21016 #ifdef HAVE_WINDOW_SYSTEM
21017 /* On GUI frames, as we don't know the X coordinate of the
21018 character to the left of point, moving point to the left
21019 requires walking, one grapheme cluster at a time, until we
21020 find ourself at a place immediately to the left of the
21021 character at point. */
21022 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21024 struct text_pos new_pos
;
21025 enum move_it_result rc
= MOVE_X_REACHED
;
21027 if (it
.current_x
== 0)
21028 get_next_display_element (&it
);
21029 if (it
.what
== IT_COMPOSITION
)
21031 new_pos
.charpos
= it
.cmp_it
.charpos
;
21032 new_pos
.bytepos
= -1;
21035 new_pos
= it
.current
.pos
;
21037 while (it
.current_x
+ it
.pixel_width
<= target_x
21038 && (rc
== MOVE_X_REACHED
21039 /* Under word-wrap, move_it_in_display_line_to
21040 stops at correct coordinates, but sometimes
21041 returns MOVE_POS_MATCH_OR_ZV. */
21042 || (it
.line_wrap
== WORD_WRAP
21043 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21045 int new_x
= it
.current_x
+ it
.pixel_width
;
21047 /* For composed characters, we want the position of the
21048 first character in the grapheme cluster (usually, the
21049 composition's base character), whereas it.current
21050 might give us the position of the _last_ one, e.g. if
21051 the composition is rendered in reverse due to bidi
21053 if (it
.what
== IT_COMPOSITION
)
21055 new_pos
.charpos
= it
.cmp_it
.charpos
;
21056 new_pos
.bytepos
= -1;
21059 new_pos
= it
.current
.pos
;
21060 if (new_x
== it
.current_x
)
21062 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21063 MOVE_TO_POS
| MOVE_TO_X
);
21064 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21067 /* The previous position we saw in the loop is the one we
21069 if (new_pos
.bytepos
== -1)
21070 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21071 it
.current
.pos
= new_pos
;
21075 if (it
.current_x
!= target_x
)
21076 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21078 /* When lines are truncated, the above loop will stop at the
21079 window edge. But we want to get to the end of line, even if
21080 it is beyond the window edge; automatic hscroll will then
21081 scroll the window to show point as appropriate. */
21082 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21083 && get_next_display_element (&it
))
21085 struct text_pos new_pos
= it
.current
.pos
;
21087 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21089 set_iterator_to_next (&it
, 0);
21090 if (it
.method
== GET_FROM_BUFFER
)
21091 new_pos
= it
.current
.pos
;
21092 if (!get_next_display_element (&it
))
21096 it
.current
.pos
= new_pos
;
21099 /* If we ended up in a display string that covers point, move to
21100 buffer position to the right in the visual order. */
21103 while (IT_CHARPOS (it
) == PT
)
21105 set_iterator_to_next (&it
, 0);
21106 if (!get_next_display_element (&it
))
21111 /* Move point to that position. */
21112 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21115 return make_number (PT
);
21117 #undef ROW_GLYPH_NEWLINE_P
21121 /***********************************************************************
21123 ***********************************************************************/
21125 /* Redisplay the menu bar in the frame for window W.
21127 The menu bar of X frames that don't have X toolkit support is
21128 displayed in a special window W->frame->menu_bar_window.
21130 The menu bar of terminal frames is treated specially as far as
21131 glyph matrices are concerned. Menu bar lines are not part of
21132 windows, so the update is done directly on the frame matrix rows
21133 for the menu bar. */
21136 display_menu_bar (struct window
*w
)
21138 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21143 /* Don't do all this for graphical frames. */
21145 if (FRAME_W32_P (f
))
21148 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21154 if (FRAME_NS_P (f
))
21156 #endif /* HAVE_NS */
21158 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21159 eassert (!FRAME_WINDOW_P (f
));
21160 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21161 it
.first_visible_x
= 0;
21162 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21163 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21164 if (FRAME_WINDOW_P (f
))
21166 /* Menu bar lines are displayed in the desired matrix of the
21167 dummy window menu_bar_window. */
21168 struct window
*menu_w
;
21169 menu_w
= XWINDOW (f
->menu_bar_window
);
21170 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21172 it
.first_visible_x
= 0;
21173 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21176 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21178 /* This is a TTY frame, i.e. character hpos/vpos are used as
21180 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21182 it
.first_visible_x
= 0;
21183 it
.last_visible_x
= FRAME_COLS (f
);
21186 /* FIXME: This should be controlled by a user option. See the
21187 comments in redisplay_tool_bar and display_mode_line about
21189 it
.paragraph_embedding
= L2R
;
21191 /* Clear all rows of the menu bar. */
21192 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21194 struct glyph_row
*row
= it
.glyph_row
+ i
;
21195 clear_glyph_row (row
);
21196 row
->enabled_p
= true;
21197 row
->full_width_p
= 1;
21200 /* Display all items of the menu bar. */
21201 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21202 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21204 Lisp_Object string
;
21206 /* Stop at nil string. */
21207 string
= AREF (items
, i
+ 1);
21211 /* Remember where item was displayed. */
21212 ASET (items
, i
+ 3, make_number (it
.hpos
));
21214 /* Display the item, pad with one space. */
21215 if (it
.current_x
< it
.last_visible_x
)
21216 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21217 SCHARS (string
) + 1, 0, 0, -1);
21220 /* Fill out the line with spaces. */
21221 if (it
.current_x
< it
.last_visible_x
)
21222 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21224 /* Compute the total height of the lines. */
21225 compute_line_metrics (&it
);
21228 /* Deep copy of a glyph row, including the glyphs. */
21230 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21232 struct glyph
*pointers
[1 + LAST_AREA
];
21233 int to_used
= to
->used
[TEXT_AREA
];
21235 /* Save glyph pointers of TO. */
21236 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21238 /* Do a structure assignment. */
21241 /* Restore original glyph pointers of TO. */
21242 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21244 /* Copy the glyphs. */
21245 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21246 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21248 /* If we filled only part of the TO row, fill the rest with
21249 space_glyph (which will display as empty space). */
21250 if (to_used
> from
->used
[TEXT_AREA
])
21251 fill_up_frame_row_with_spaces (to
, to_used
);
21254 /* Display one menu item on a TTY, by overwriting the glyphs in the
21255 frame F's desired glyph matrix with glyphs produced from the menu
21256 item text. Called from term.c to display TTY drop-down menus one
21259 ITEM_TEXT is the menu item text as a C string.
21261 FACE_ID is the face ID to be used for this menu item. FACE_ID
21262 could specify one of 3 faces: a face for an enabled item, a face
21263 for a disabled item, or a face for a selected item.
21265 X and Y are coordinates of the first glyph in the frame's desired
21266 matrix to be overwritten by the menu item. Since this is a TTY, Y
21267 is the zero-based number of the glyph row and X is the zero-based
21268 glyph number in the row, starting from left, where to start
21269 displaying the item.
21271 SUBMENU non-zero means this menu item drops down a submenu, which
21272 should be indicated by displaying a proper visual cue after the
21276 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21277 int x
, int y
, int submenu
)
21280 struct frame
*f
= SELECTED_FRAME ();
21281 struct window
*w
= XWINDOW (f
->selected_window
);
21282 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21283 struct glyph_row
*row
;
21284 size_t item_len
= strlen (item_text
);
21286 eassert (FRAME_TERMCAP_P (f
));
21288 /* Don't write beyond the matrix's last row. This can happen for
21289 TTY screens that are not high enough to show the entire menu.
21290 (This is actually a bit of defensive programming, as
21291 tty_menu_display already limits the number of menu items to one
21292 less than the number of screen lines.) */
21293 if (y
>= f
->desired_matrix
->nrows
)
21296 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21297 it
.first_visible_x
= 0;
21298 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21299 row
= it
.glyph_row
;
21300 /* Start with the row contents from the current matrix. */
21301 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21302 saved_width
= row
->full_width_p
;
21303 row
->full_width_p
= 1;
21304 saved_reversed
= row
->reversed_p
;
21305 row
->reversed_p
= 0;
21306 row
->enabled_p
= true;
21308 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21310 eassert (x
< f
->desired_matrix
->matrix_w
);
21311 it
.current_x
= it
.hpos
= x
;
21312 it
.current_y
= it
.vpos
= y
;
21313 saved_used
= row
->used
[TEXT_AREA
];
21314 saved_truncated
= row
->truncated_on_right_p
;
21315 row
->used
[TEXT_AREA
] = x
;
21316 it
.face_id
= face_id
;
21317 it
.line_wrap
= TRUNCATE
;
21319 /* FIXME: This should be controlled by a user option. See the
21320 comments in redisplay_tool_bar and display_mode_line about this.
21321 Also, if paragraph_embedding could ever be R2L, changes will be
21322 needed to avoid shifting to the right the row characters in
21323 term.c:append_glyph. */
21324 it
.paragraph_embedding
= L2R
;
21326 /* Pad with a space on the left. */
21327 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21329 /* Display the menu item, pad with spaces to WIDTH. */
21332 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21333 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21335 /* Indicate with " >" that there's a submenu. */
21336 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21337 FRAME_COLS (f
) - 1, -1);
21340 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21341 width
, 0, FRAME_COLS (f
) - 1, -1);
21343 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21344 row
->truncated_on_right_p
= saved_truncated
;
21345 row
->hash
= row_hash (row
);
21346 row
->full_width_p
= saved_width
;
21347 row
->reversed_p
= saved_reversed
;
21350 /***********************************************************************
21352 ***********************************************************************/
21354 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21355 FORCE is non-zero, redisplay mode lines unconditionally.
21356 Otherwise, redisplay only mode lines that are garbaged. Value is
21357 the number of windows whose mode lines were redisplayed. */
21360 redisplay_mode_lines (Lisp_Object window
, bool force
)
21364 while (!NILP (window
))
21366 struct window
*w
= XWINDOW (window
);
21368 if (WINDOWP (w
->contents
))
21369 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21371 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21372 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21374 struct text_pos lpoint
;
21375 struct buffer
*old
= current_buffer
;
21377 /* Set the window's buffer for the mode line display. */
21378 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21379 set_buffer_internal_1 (XBUFFER (w
->contents
));
21381 /* Point refers normally to the selected window. For any
21382 other window, set up appropriate value. */
21383 if (!EQ (window
, selected_window
))
21385 struct text_pos pt
;
21387 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21388 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21391 /* Display mode lines. */
21392 clear_glyph_matrix (w
->desired_matrix
);
21393 if (display_mode_lines (w
))
21396 /* Restore old settings. */
21397 set_buffer_internal_1 (old
);
21398 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21408 /* Display the mode and/or header line of window W. Value is the
21409 sum number of mode lines and header lines displayed. */
21412 display_mode_lines (struct window
*w
)
21414 Lisp_Object old_selected_window
= selected_window
;
21415 Lisp_Object old_selected_frame
= selected_frame
;
21416 Lisp_Object new_frame
= w
->frame
;
21417 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21420 selected_frame
= new_frame
;
21421 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21422 or window's point, then we'd need select_window_1 here as well. */
21423 XSETWINDOW (selected_window
, w
);
21424 XFRAME (new_frame
)->selected_window
= selected_window
;
21426 /* These will be set while the mode line specs are processed. */
21427 line_number_displayed
= 0;
21428 w
->column_number_displayed
= -1;
21430 if (WINDOW_WANTS_MODELINE_P (w
))
21432 struct window
*sel_w
= XWINDOW (old_selected_window
);
21434 /* Select mode line face based on the real selected window. */
21435 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21436 BVAR (current_buffer
, mode_line_format
));
21440 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21442 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21443 BVAR (current_buffer
, header_line_format
));
21447 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21448 selected_frame
= old_selected_frame
;
21449 selected_window
= old_selected_window
;
21451 w
->must_be_updated_p
= true;
21456 /* Display mode or header line of window W. FACE_ID specifies which
21457 line to display; it is either MODE_LINE_FACE_ID or
21458 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21459 display. Value is the pixel height of the mode/header line
21463 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21467 ptrdiff_t count
= SPECPDL_INDEX ();
21469 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21470 /* Don't extend on a previously drawn mode-line.
21471 This may happen if called from pos_visible_p. */
21472 it
.glyph_row
->enabled_p
= false;
21473 prepare_desired_row (it
.glyph_row
);
21475 it
.glyph_row
->mode_line_p
= 1;
21477 /* FIXME: This should be controlled by a user option. But
21478 supporting such an option is not trivial, since the mode line is
21479 made up of many separate strings. */
21480 it
.paragraph_embedding
= L2R
;
21482 record_unwind_protect (unwind_format_mode_line
,
21483 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21485 mode_line_target
= MODE_LINE_DISPLAY
;
21487 /* Temporarily make frame's keyboard the current kboard so that
21488 kboard-local variables in the mode_line_format will get the right
21490 push_kboard (FRAME_KBOARD (it
.f
));
21491 record_unwind_save_match_data ();
21492 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21495 unbind_to (count
, Qnil
);
21497 /* Fill up with spaces. */
21498 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21500 compute_line_metrics (&it
);
21501 it
.glyph_row
->full_width_p
= 1;
21502 it
.glyph_row
->continued_p
= 0;
21503 it
.glyph_row
->truncated_on_left_p
= 0;
21504 it
.glyph_row
->truncated_on_right_p
= 0;
21506 /* Make a 3D mode-line have a shadow at its right end. */
21507 face
= FACE_FROM_ID (it
.f
, face_id
);
21508 extend_face_to_end_of_line (&it
);
21509 if (face
->box
!= FACE_NO_BOX
)
21511 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21512 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21513 last
->right_box_line_p
= 1;
21516 return it
.glyph_row
->height
;
21519 /* Move element ELT in LIST to the front of LIST.
21520 Return the updated list. */
21523 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21525 register Lisp_Object tail
, prev
;
21526 register Lisp_Object tem
;
21530 while (CONSP (tail
))
21536 /* Splice out the link TAIL. */
21538 list
= XCDR (tail
);
21540 Fsetcdr (prev
, XCDR (tail
));
21542 /* Now make it the first. */
21543 Fsetcdr (tail
, list
);
21548 tail
= XCDR (tail
);
21552 /* Not found--return unchanged LIST. */
21556 /* Contribute ELT to the mode line for window IT->w. How it
21557 translates into text depends on its data type.
21559 IT describes the display environment in which we display, as usual.
21561 DEPTH is the depth in recursion. It is used to prevent
21562 infinite recursion here.
21564 FIELD_WIDTH is the number of characters the display of ELT should
21565 occupy in the mode line, and PRECISION is the maximum number of
21566 characters to display from ELT's representation. See
21567 display_string for details.
21569 Returns the hpos of the end of the text generated by ELT.
21571 PROPS is a property list to add to any string we encounter.
21573 If RISKY is nonzero, remove (disregard) any properties in any string
21574 we encounter, and ignore :eval and :propertize.
21576 The global variable `mode_line_target' determines whether the
21577 output is passed to `store_mode_line_noprop',
21578 `store_mode_line_string', or `display_string'. */
21581 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21582 Lisp_Object elt
, Lisp_Object props
, int risky
)
21584 int n
= 0, field
, prec
;
21589 elt
= build_string ("*too-deep*");
21593 switch (XTYPE (elt
))
21597 /* A string: output it and check for %-constructs within it. */
21599 ptrdiff_t offset
= 0;
21601 if (SCHARS (elt
) > 0
21602 && (!NILP (props
) || risky
))
21604 Lisp_Object oprops
, aelt
;
21605 oprops
= Ftext_properties_at (make_number (0), elt
);
21607 /* If the starting string's properties are not what
21608 we want, translate the string. Also, if the string
21609 is risky, do that anyway. */
21611 if (NILP (Fequal (props
, oprops
)) || risky
)
21613 /* If the starting string has properties,
21614 merge the specified ones onto the existing ones. */
21615 if (! NILP (oprops
) && !risky
)
21619 oprops
= Fcopy_sequence (oprops
);
21621 while (CONSP (tem
))
21623 oprops
= Fplist_put (oprops
, XCAR (tem
),
21624 XCAR (XCDR (tem
)));
21625 tem
= XCDR (XCDR (tem
));
21630 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21631 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21633 /* AELT is what we want. Move it to the front
21634 without consing. */
21636 mode_line_proptrans_alist
21637 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21643 /* If AELT has the wrong props, it is useless.
21644 so get rid of it. */
21646 mode_line_proptrans_alist
21647 = Fdelq (aelt
, mode_line_proptrans_alist
);
21649 elt
= Fcopy_sequence (elt
);
21650 Fset_text_properties (make_number (0), Flength (elt
),
21652 /* Add this item to mode_line_proptrans_alist. */
21653 mode_line_proptrans_alist
21654 = Fcons (Fcons (elt
, props
),
21655 mode_line_proptrans_alist
);
21656 /* Truncate mode_line_proptrans_alist
21657 to at most 50 elements. */
21658 tem
= Fnthcdr (make_number (50),
21659 mode_line_proptrans_alist
);
21661 XSETCDR (tem
, Qnil
);
21670 prec
= precision
- n
;
21671 switch (mode_line_target
)
21673 case MODE_LINE_NOPROP
:
21674 case MODE_LINE_TITLE
:
21675 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21677 case MODE_LINE_STRING
:
21678 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21680 case MODE_LINE_DISPLAY
:
21681 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21682 0, prec
, 0, STRING_MULTIBYTE (elt
));
21689 /* Handle the non-literal case. */
21691 while ((precision
<= 0 || n
< precision
)
21692 && SREF (elt
, offset
) != 0
21693 && (mode_line_target
!= MODE_LINE_DISPLAY
21694 || it
->current_x
< it
->last_visible_x
))
21696 ptrdiff_t last_offset
= offset
;
21698 /* Advance to end of string or next format specifier. */
21699 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
21702 if (offset
- 1 != last_offset
)
21704 ptrdiff_t nchars
, nbytes
;
21706 /* Output to end of string or up to '%'. Field width
21707 is length of string. Don't output more than
21708 PRECISION allows us. */
21711 prec
= c_string_width (SDATA (elt
) + last_offset
,
21712 offset
- last_offset
, precision
- n
,
21715 switch (mode_line_target
)
21717 case MODE_LINE_NOPROP
:
21718 case MODE_LINE_TITLE
:
21719 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
21721 case MODE_LINE_STRING
:
21723 ptrdiff_t bytepos
= last_offset
;
21724 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21725 ptrdiff_t endpos
= (precision
<= 0
21726 ? string_byte_to_char (elt
, offset
)
21727 : charpos
+ nchars
);
21729 n
+= store_mode_line_string (NULL
,
21730 Fsubstring (elt
, make_number (charpos
),
21731 make_number (endpos
)),
21735 case MODE_LINE_DISPLAY
:
21737 ptrdiff_t bytepos
= last_offset
;
21738 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21740 if (precision
<= 0)
21741 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
21742 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
21744 STRING_MULTIBYTE (elt
));
21749 else /* c == '%' */
21751 ptrdiff_t percent_position
= offset
;
21753 /* Get the specified minimum width. Zero means
21756 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
21757 field
= field
* 10 + c
- '0';
21759 /* Don't pad beyond the total padding allowed. */
21760 if (field_width
- n
> 0 && field
> field_width
- n
)
21761 field
= field_width
- n
;
21763 /* Note that either PRECISION <= 0 or N < PRECISION. */
21764 prec
= precision
- n
;
21767 n
+= display_mode_element (it
, depth
, field
, prec
,
21768 Vglobal_mode_string
, props
,
21773 ptrdiff_t bytepos
, charpos
;
21775 Lisp_Object string
;
21777 bytepos
= percent_position
;
21778 charpos
= (STRING_MULTIBYTE (elt
)
21779 ? string_byte_to_char (elt
, bytepos
)
21781 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
21782 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
21784 switch (mode_line_target
)
21786 case MODE_LINE_NOPROP
:
21787 case MODE_LINE_TITLE
:
21788 n
+= store_mode_line_noprop (spec
, field
, prec
);
21790 case MODE_LINE_STRING
:
21792 Lisp_Object tem
= build_string (spec
);
21793 props
= Ftext_properties_at (make_number (charpos
), elt
);
21794 /* Should only keep face property in props */
21795 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
21798 case MODE_LINE_DISPLAY
:
21800 int nglyphs_before
, nwritten
;
21802 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
21803 nwritten
= display_string (spec
, string
, elt
,
21808 /* Assign to the glyphs written above the
21809 string where the `%x' came from, position
21813 struct glyph
*glyph
21814 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
21818 for (i
= 0; i
< nwritten
; ++i
)
21820 glyph
[i
].object
= elt
;
21821 glyph
[i
].charpos
= charpos
;
21838 /* A symbol: process the value of the symbol recursively
21839 as if it appeared here directly. Avoid error if symbol void.
21840 Special case: if value of symbol is a string, output the string
21843 register Lisp_Object tem
;
21845 /* If the variable is not marked as risky to set
21846 then its contents are risky to use. */
21847 if (NILP (Fget (elt
, Qrisky_local_variable
)))
21850 tem
= Fboundp (elt
);
21853 tem
= Fsymbol_value (elt
);
21854 /* If value is a string, output that string literally:
21855 don't check for % within it. */
21859 if (!EQ (tem
, elt
))
21861 /* Give up right away for nil or t. */
21871 register Lisp_Object car
, tem
;
21873 /* A cons cell: five distinct cases.
21874 If first element is :eval or :propertize, do something special.
21875 If first element is a string or a cons, process all the elements
21876 and effectively concatenate them.
21877 If first element is a negative number, truncate displaying cdr to
21878 at most that many characters. If positive, pad (with spaces)
21879 to at least that many characters.
21880 If first element is a symbol, process the cadr or caddr recursively
21881 according to whether the symbol's value is non-nil or nil. */
21883 if (EQ (car
, QCeval
))
21885 /* An element of the form (:eval FORM) means evaluate FORM
21886 and use the result as mode line elements. */
21891 if (CONSP (XCDR (elt
)))
21894 spec
= safe__eval (true, XCAR (XCDR (elt
)));
21895 n
+= display_mode_element (it
, depth
, field_width
- n
,
21896 precision
- n
, spec
, props
,
21900 else if (EQ (car
, QCpropertize
))
21902 /* An element of the form (:propertize ELT PROPS...)
21903 means display ELT but applying properties PROPS. */
21908 if (CONSP (XCDR (elt
)))
21909 n
+= display_mode_element (it
, depth
, field_width
- n
,
21910 precision
- n
, XCAR (XCDR (elt
)),
21911 XCDR (XCDR (elt
)), risky
);
21913 else if (SYMBOLP (car
))
21915 tem
= Fboundp (car
);
21919 /* elt is now the cdr, and we know it is a cons cell.
21920 Use its car if CAR has a non-nil value. */
21923 tem
= Fsymbol_value (car
);
21930 /* Symbol's value is nil (or symbol is unbound)
21931 Get the cddr of the original list
21932 and if possible find the caddr and use that. */
21936 else if (!CONSP (elt
))
21941 else if (INTEGERP (car
))
21943 register int lim
= XINT (car
);
21947 /* Negative int means reduce maximum width. */
21948 if (precision
<= 0)
21951 precision
= min (precision
, -lim
);
21955 /* Padding specified. Don't let it be more than
21956 current maximum. */
21958 lim
= min (precision
, lim
);
21960 /* If that's more padding than already wanted, queue it.
21961 But don't reduce padding already specified even if
21962 that is beyond the current truncation point. */
21963 field_width
= max (lim
, field_width
);
21967 else if (STRINGP (car
) || CONSP (car
))
21969 Lisp_Object halftail
= elt
;
21973 && (precision
<= 0 || n
< precision
))
21975 n
+= display_mode_element (it
, depth
,
21976 /* Do padding only after the last
21977 element in the list. */
21978 (! CONSP (XCDR (elt
))
21981 precision
- n
, XCAR (elt
),
21985 if ((len
& 1) == 0)
21986 halftail
= XCDR (halftail
);
21987 /* Check for cycle. */
21988 if (EQ (halftail
, elt
))
21997 elt
= build_string ("*invalid*");
22001 /* Pad to FIELD_WIDTH. */
22002 if (field_width
> 0 && n
< field_width
)
22004 switch (mode_line_target
)
22006 case MODE_LINE_NOPROP
:
22007 case MODE_LINE_TITLE
:
22008 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22010 case MODE_LINE_STRING
:
22011 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22013 case MODE_LINE_DISPLAY
:
22014 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22023 /* Store a mode-line string element in mode_line_string_list.
22025 If STRING is non-null, display that C string. Otherwise, the Lisp
22026 string LISP_STRING is displayed.
22028 FIELD_WIDTH is the minimum number of output glyphs to produce.
22029 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22030 with spaces. FIELD_WIDTH <= 0 means don't pad.
22032 PRECISION is the maximum number of characters to output from
22033 STRING. PRECISION <= 0 means don't truncate the string.
22035 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22036 properties to the string.
22038 PROPS are the properties to add to the string.
22039 The mode_line_string_face face property is always added to the string.
22043 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22044 int field_width
, int precision
, Lisp_Object props
)
22049 if (string
!= NULL
)
22051 len
= strlen (string
);
22052 if (precision
> 0 && len
> precision
)
22054 lisp_string
= make_string (string
, len
);
22056 props
= mode_line_string_face_prop
;
22057 else if (!NILP (mode_line_string_face
))
22059 Lisp_Object face
= Fplist_get (props
, Qface
);
22060 props
= Fcopy_sequence (props
);
22062 face
= mode_line_string_face
;
22064 face
= list2 (face
, mode_line_string_face
);
22065 props
= Fplist_put (props
, Qface
, face
);
22067 Fadd_text_properties (make_number (0), make_number (len
),
22068 props
, lisp_string
);
22072 len
= XFASTINT (Flength (lisp_string
));
22073 if (precision
> 0 && len
> precision
)
22076 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22079 if (!NILP (mode_line_string_face
))
22083 props
= Ftext_properties_at (make_number (0), lisp_string
);
22084 face
= Fplist_get (props
, Qface
);
22086 face
= mode_line_string_face
;
22088 face
= list2 (face
, mode_line_string_face
);
22089 props
= list2 (Qface
, face
);
22091 lisp_string
= Fcopy_sequence (lisp_string
);
22094 Fadd_text_properties (make_number (0), make_number (len
),
22095 props
, lisp_string
);
22100 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22104 if (field_width
> len
)
22106 field_width
-= len
;
22107 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22109 Fadd_text_properties (make_number (0), make_number (field_width
),
22110 props
, lisp_string
);
22111 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22119 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22121 doc
: /* Format a string out of a mode line format specification.
22122 First arg FORMAT specifies the mode line format (see `mode-line-format'
22123 for details) to use.
22125 By default, the format is evaluated for the currently selected window.
22127 Optional second arg FACE specifies the face property to put on all
22128 characters for which no face is specified. The value nil means the
22129 default face. The value t means whatever face the window's mode line
22130 currently uses (either `mode-line' or `mode-line-inactive',
22131 depending on whether the window is the selected window or not).
22132 An integer value means the value string has no text
22135 Optional third and fourth args WINDOW and BUFFER specify the window
22136 and buffer to use as the context for the formatting (defaults
22137 are the selected window and the WINDOW's buffer). */)
22138 (Lisp_Object format
, Lisp_Object face
,
22139 Lisp_Object window
, Lisp_Object buffer
)
22144 struct buffer
*old_buffer
= NULL
;
22146 int no_props
= INTEGERP (face
);
22147 ptrdiff_t count
= SPECPDL_INDEX ();
22149 int string_start
= 0;
22151 w
= decode_any_window (window
);
22152 XSETWINDOW (window
, w
);
22155 buffer
= w
->contents
;
22156 CHECK_BUFFER (buffer
);
22158 /* Make formatting the modeline a non-op when noninteractive, otherwise
22159 there will be problems later caused by a partially initialized frame. */
22160 if (NILP (format
) || noninteractive
)
22161 return empty_unibyte_string
;
22166 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22167 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22168 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22169 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22170 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22171 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22172 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22175 old_buffer
= current_buffer
;
22177 /* Save things including mode_line_proptrans_alist,
22178 and set that to nil so that we don't alter the outer value. */
22179 record_unwind_protect (unwind_format_mode_line
,
22180 format_mode_line_unwind_data
22181 (XFRAME (WINDOW_FRAME (w
)),
22182 old_buffer
, selected_window
, 1));
22183 mode_line_proptrans_alist
= Qnil
;
22185 Fselect_window (window
, Qt
);
22186 set_buffer_internal_1 (XBUFFER (buffer
));
22188 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22192 mode_line_target
= MODE_LINE_NOPROP
;
22193 mode_line_string_face_prop
= Qnil
;
22194 mode_line_string_list
= Qnil
;
22195 string_start
= MODE_LINE_NOPROP_LEN (0);
22199 mode_line_target
= MODE_LINE_STRING
;
22200 mode_line_string_list
= Qnil
;
22201 mode_line_string_face
= face
;
22202 mode_line_string_face_prop
22203 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22206 push_kboard (FRAME_KBOARD (it
.f
));
22207 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22212 len
= MODE_LINE_NOPROP_LEN (string_start
);
22213 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22217 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22218 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22219 empty_unibyte_string
);
22222 unbind_to (count
, Qnil
);
22226 /* Write a null-terminated, right justified decimal representation of
22227 the positive integer D to BUF using a minimal field width WIDTH. */
22230 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22232 register char *p
= buf
;
22240 *p
++ = d
% 10 + '0';
22245 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22256 /* Write a null-terminated, right justified decimal and "human
22257 readable" representation of the nonnegative integer D to BUF using
22258 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22260 static const char power_letter
[] =
22274 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22276 /* We aim to represent the nonnegative integer D as
22277 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22278 ptrdiff_t quotient
= d
;
22280 /* -1 means: do not use TENTHS. */
22284 /* Length of QUOTIENT.TENTHS as a string. */
22290 if (quotient
>= 1000)
22292 /* Scale to the appropriate EXPONENT. */
22295 remainder
= quotient
% 1000;
22299 while (quotient
>= 1000);
22301 /* Round to nearest and decide whether to use TENTHS or not. */
22304 tenths
= remainder
/ 100;
22305 if (remainder
% 100 >= 50)
22312 if (quotient
== 10)
22320 if (remainder
>= 500)
22322 if (quotient
< 999)
22333 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22334 if (tenths
== -1 && quotient
<= 99)
22341 p
= psuffix
= buf
+ max (width
, length
);
22343 /* Print EXPONENT. */
22344 *psuffix
++ = power_letter
[exponent
];
22347 /* Print TENTHS. */
22350 *--p
= '0' + tenths
;
22354 /* Print QUOTIENT. */
22357 int digit
= quotient
% 10;
22358 *--p
= '0' + digit
;
22360 while ((quotient
/= 10) != 0);
22362 /* Print leading spaces. */
22367 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22368 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22369 type of CODING_SYSTEM. Return updated pointer into BUF. */
22371 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22374 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22377 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22378 const unsigned char *eol_str
;
22380 /* The EOL conversion we are using. */
22381 Lisp_Object eoltype
;
22383 val
= CODING_SYSTEM_SPEC (coding_system
);
22386 if (!VECTORP (val
)) /* Not yet decided. */
22388 *buf
++ = multibyte
? '-' : ' ';
22390 eoltype
= eol_mnemonic_undecided
;
22391 /* Don't mention EOL conversion if it isn't decided. */
22396 Lisp_Object eolvalue
;
22398 attrs
= AREF (val
, 0);
22399 eolvalue
= AREF (val
, 2);
22402 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22407 /* The EOL conversion that is normal on this system. */
22409 if (NILP (eolvalue
)) /* Not yet decided. */
22410 eoltype
= eol_mnemonic_undecided
;
22411 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22412 eoltype
= eol_mnemonic_undecided
;
22413 else /* eolvalue is Qunix, Qdos, or Qmac. */
22414 eoltype
= (EQ (eolvalue
, Qunix
)
22415 ? eol_mnemonic_unix
22416 : (EQ (eolvalue
, Qdos
) == 1
22417 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22423 /* Mention the EOL conversion if it is not the usual one. */
22424 if (STRINGP (eoltype
))
22426 eol_str
= SDATA (eoltype
);
22427 eol_str_len
= SBYTES (eoltype
);
22429 else if (CHARACTERP (eoltype
))
22431 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22432 int c
= XFASTINT (eoltype
);
22433 eol_str_len
= CHAR_STRING (c
, tmp
);
22438 eol_str
= invalid_eol_type
;
22439 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22441 memcpy (buf
, eol_str
, eol_str_len
);
22442 buf
+= eol_str_len
;
22448 /* Return a string for the output of a mode line %-spec for window W,
22449 generated by character C. FIELD_WIDTH > 0 means pad the string
22450 returned with spaces to that value. Return a Lisp string in
22451 *STRING if the resulting string is taken from that Lisp string.
22453 Note we operate on the current buffer for most purposes. */
22455 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22457 static const char *
22458 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22459 Lisp_Object
*string
)
22462 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22463 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22464 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22465 produce strings from numerical values, so limit preposterously
22466 large values of FIELD_WIDTH to avoid overrunning the buffer's
22467 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22468 bytes plus the terminating null. */
22469 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22470 struct buffer
*b
= current_buffer
;
22478 if (!NILP (BVAR (b
, read_only
)))
22480 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22485 /* This differs from %* only for a modified read-only buffer. */
22486 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22488 if (!NILP (BVAR (b
, read_only
)))
22493 /* This differs from %* in ignoring read-only-ness. */
22494 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22506 if (command_loop_level
> 5)
22508 p
= decode_mode_spec_buf
;
22509 for (i
= 0; i
< command_loop_level
; i
++)
22512 return decode_mode_spec_buf
;
22520 if (command_loop_level
> 5)
22522 p
= decode_mode_spec_buf
;
22523 for (i
= 0; i
< command_loop_level
; i
++)
22526 return decode_mode_spec_buf
;
22533 /* Let lots_of_dashes be a string of infinite length. */
22534 if (mode_line_target
== MODE_LINE_NOPROP
22535 || mode_line_target
== MODE_LINE_STRING
)
22537 if (field_width
<= 0
22538 || field_width
> sizeof (lots_of_dashes
))
22540 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22541 decode_mode_spec_buf
[i
] = '-';
22542 decode_mode_spec_buf
[i
] = '\0';
22543 return decode_mode_spec_buf
;
22546 return lots_of_dashes
;
22550 obj
= BVAR (b
, name
);
22554 /* %c and %l are ignored in `frame-title-format'.
22555 (In redisplay_internal, the frame title is drawn _before_ the
22556 windows are updated, so the stuff which depends on actual
22557 window contents (such as %l) may fail to render properly, or
22558 even crash emacs.) */
22559 if (mode_line_target
== MODE_LINE_TITLE
)
22563 ptrdiff_t col
= current_column ();
22564 w
->column_number_displayed
= col
;
22565 pint2str (decode_mode_spec_buf
, width
, col
);
22566 return decode_mode_spec_buf
;
22570 #ifndef SYSTEM_MALLOC
22572 if (NILP (Vmemory_full
))
22575 return "!MEM FULL! ";
22582 /* %F displays the frame name. */
22583 if (!NILP (f
->title
))
22584 return SSDATA (f
->title
);
22585 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22586 return SSDATA (f
->name
);
22590 obj
= BVAR (b
, filename
);
22595 ptrdiff_t size
= ZV
- BEGV
;
22596 pint2str (decode_mode_spec_buf
, width
, size
);
22597 return decode_mode_spec_buf
;
22602 ptrdiff_t size
= ZV
- BEGV
;
22603 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22604 return decode_mode_spec_buf
;
22609 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22610 ptrdiff_t topline
, nlines
, height
;
22613 /* %c and %l are ignored in `frame-title-format'. */
22614 if (mode_line_target
== MODE_LINE_TITLE
)
22617 startpos
= marker_position (w
->start
);
22618 startpos_byte
= marker_byte_position (w
->start
);
22619 height
= WINDOW_TOTAL_LINES (w
);
22621 /* If we decided that this buffer isn't suitable for line numbers,
22622 don't forget that too fast. */
22623 if (w
->base_line_pos
== -1)
22626 /* If the buffer is very big, don't waste time. */
22627 if (INTEGERP (Vline_number_display_limit
)
22628 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22630 w
->base_line_pos
= 0;
22631 w
->base_line_number
= 0;
22635 if (w
->base_line_number
> 0
22636 && w
->base_line_pos
> 0
22637 && w
->base_line_pos
<= startpos
)
22639 line
= w
->base_line_number
;
22640 linepos
= w
->base_line_pos
;
22641 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22646 linepos
= BUF_BEGV (b
);
22647 linepos_byte
= BUF_BEGV_BYTE (b
);
22650 /* Count lines from base line to window start position. */
22651 nlines
= display_count_lines (linepos_byte
,
22655 topline
= nlines
+ line
;
22657 /* Determine a new base line, if the old one is too close
22658 or too far away, or if we did not have one.
22659 "Too close" means it's plausible a scroll-down would
22660 go back past it. */
22661 if (startpos
== BUF_BEGV (b
))
22663 w
->base_line_number
= topline
;
22664 w
->base_line_pos
= BUF_BEGV (b
);
22666 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22667 || linepos
== BUF_BEGV (b
))
22669 ptrdiff_t limit
= BUF_BEGV (b
);
22670 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22671 ptrdiff_t position
;
22672 ptrdiff_t distance
=
22673 (height
* 2 + 30) * line_number_display_limit_width
;
22675 if (startpos
- distance
> limit
)
22677 limit
= startpos
- distance
;
22678 limit_byte
= CHAR_TO_BYTE (limit
);
22681 nlines
= display_count_lines (startpos_byte
,
22683 - (height
* 2 + 30),
22685 /* If we couldn't find the lines we wanted within
22686 line_number_display_limit_width chars per line,
22687 give up on line numbers for this window. */
22688 if (position
== limit_byte
&& limit
== startpos
- distance
)
22690 w
->base_line_pos
= -1;
22691 w
->base_line_number
= 0;
22695 w
->base_line_number
= topline
- nlines
;
22696 w
->base_line_pos
= BYTE_TO_CHAR (position
);
22699 /* Now count lines from the start pos to point. */
22700 nlines
= display_count_lines (startpos_byte
,
22701 PT_BYTE
, PT
, &junk
);
22703 /* Record that we did display the line number. */
22704 line_number_displayed
= 1;
22706 /* Make the string to show. */
22707 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
22708 return decode_mode_spec_buf
;
22711 char* p
= decode_mode_spec_buf
;
22712 int pad
= width
- 2;
22718 return decode_mode_spec_buf
;
22724 obj
= BVAR (b
, mode_name
);
22728 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
22734 ptrdiff_t pos
= marker_position (w
->start
);
22735 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22737 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
22739 if (pos
<= BUF_BEGV (b
))
22744 else if (pos
<= BUF_BEGV (b
))
22748 if (total
> 1000000)
22749 /* Do it differently for a large value, to avoid overflow. */
22750 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22752 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22753 /* We can't normally display a 3-digit number,
22754 so get us a 2-digit number that is close. */
22757 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22758 return decode_mode_spec_buf
;
22762 /* Display percentage of size above the bottom of the screen. */
22765 ptrdiff_t toppos
= marker_position (w
->start
);
22766 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
22767 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22769 if (botpos
>= BUF_ZV (b
))
22771 if (toppos
<= BUF_BEGV (b
))
22778 if (total
> 1000000)
22779 /* Do it differently for a large value, to avoid overflow. */
22780 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22782 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22783 /* We can't normally display a 3-digit number,
22784 so get us a 2-digit number that is close. */
22787 if (toppos
<= BUF_BEGV (b
))
22788 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
22790 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22791 return decode_mode_spec_buf
;
22796 /* status of process */
22797 obj
= Fget_buffer_process (Fcurrent_buffer ());
22799 return "no process";
22801 obj
= Fsymbol_name (Fprocess_status (obj
));
22807 ptrdiff_t count
= inhibit_garbage_collection ();
22808 Lisp_Object val
= call1 (intern ("file-remote-p"),
22809 BVAR (current_buffer
, directory
));
22810 unbind_to (count
, Qnil
);
22819 /* coding-system (not including end-of-line format) */
22821 /* coding-system (including end-of-line type) */
22823 int eol_flag
= (c
== 'Z');
22824 char *p
= decode_mode_spec_buf
;
22826 if (! FRAME_WINDOW_P (f
))
22828 /* No need to mention EOL here--the terminal never needs
22829 to do EOL conversion. */
22830 p
= decode_mode_spec_coding (CODING_ID_NAME
22831 (FRAME_KEYBOARD_CODING (f
)->id
),
22833 p
= decode_mode_spec_coding (CODING_ID_NAME
22834 (FRAME_TERMINAL_CODING (f
)->id
),
22837 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
22840 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
22841 #ifdef subprocesses
22842 obj
= Fget_buffer_process (Fcurrent_buffer ());
22843 if (PROCESSP (obj
))
22845 p
= decode_mode_spec_coding
22846 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
22847 p
= decode_mode_spec_coding
22848 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
22850 #endif /* subprocesses */
22853 return decode_mode_spec_buf
;
22860 return SSDATA (obj
);
22867 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
22868 means count lines back from START_BYTE. But don't go beyond
22869 LIMIT_BYTE. Return the number of lines thus found (always
22872 Set *BYTE_POS_PTR to the byte position where we stopped. This is
22873 either the position COUNT lines after/before START_BYTE, if we
22874 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
22878 display_count_lines (ptrdiff_t start_byte
,
22879 ptrdiff_t limit_byte
, ptrdiff_t count
,
22880 ptrdiff_t *byte_pos_ptr
)
22882 register unsigned char *cursor
;
22883 unsigned char *base
;
22885 register ptrdiff_t ceiling
;
22886 register unsigned char *ceiling_addr
;
22887 ptrdiff_t orig_count
= count
;
22889 /* If we are not in selective display mode,
22890 check only for newlines. */
22891 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
22892 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
22896 while (start_byte
< limit_byte
)
22898 ceiling
= BUFFER_CEILING_OF (start_byte
);
22899 ceiling
= min (limit_byte
- 1, ceiling
);
22900 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
22901 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
22905 if (selective_display
)
22907 while (*cursor
!= '\n' && *cursor
!= 015
22908 && ++cursor
!= ceiling_addr
)
22910 if (cursor
== ceiling_addr
)
22915 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
22924 start_byte
+= cursor
- base
;
22925 *byte_pos_ptr
= start_byte
;
22929 while (cursor
< ceiling_addr
);
22931 start_byte
+= ceiling_addr
- base
;
22936 while (start_byte
> limit_byte
)
22938 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
22939 ceiling
= max (limit_byte
, ceiling
);
22940 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
22941 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
22944 if (selective_display
)
22946 while (--cursor
>= ceiling_addr
22947 && *cursor
!= '\n' && *cursor
!= 015)
22949 if (cursor
< ceiling_addr
)
22954 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
22961 start_byte
+= cursor
- base
+ 1;
22962 *byte_pos_ptr
= start_byte
;
22963 /* When scanning backwards, we should
22964 not count the newline posterior to which we stop. */
22965 return - orig_count
- 1;
22968 start_byte
+= ceiling_addr
- base
;
22972 *byte_pos_ptr
= limit_byte
;
22975 return - orig_count
+ count
;
22976 return orig_count
- count
;
22982 /***********************************************************************
22984 ***********************************************************************/
22986 /* Display a NUL-terminated string, starting with index START.
22988 If STRING is non-null, display that C string. Otherwise, the Lisp
22989 string LISP_STRING is displayed. There's a case that STRING is
22990 non-null and LISP_STRING is not nil. It means STRING is a string
22991 data of LISP_STRING. In that case, we display LISP_STRING while
22992 ignoring its text properties.
22994 If FACE_STRING is not nil, FACE_STRING_POS is a position in
22995 FACE_STRING. Display STRING or LISP_STRING with the face at
22996 FACE_STRING_POS in FACE_STRING:
22998 Display the string in the environment given by IT, but use the
22999 standard display table, temporarily.
23001 FIELD_WIDTH is the minimum number of output glyphs to produce.
23002 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23003 with spaces. If STRING has more characters, more than FIELD_WIDTH
23004 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23006 PRECISION is the maximum number of characters to output from
23007 STRING. PRECISION < 0 means don't truncate the string.
23009 This is roughly equivalent to printf format specifiers:
23011 FIELD_WIDTH PRECISION PRINTF
23012 ----------------------------------------
23018 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23019 display them, and < 0 means obey the current buffer's value of
23020 enable_multibyte_characters.
23022 Value is the number of columns displayed. */
23025 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23026 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23027 int field_width
, int precision
, int max_x
, int multibyte
)
23029 int hpos_at_start
= it
->hpos
;
23030 int saved_face_id
= it
->face_id
;
23031 struct glyph_row
*row
= it
->glyph_row
;
23032 ptrdiff_t it_charpos
;
23034 /* Initialize the iterator IT for iteration over STRING beginning
23035 with index START. */
23036 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23037 precision
, field_width
, multibyte
);
23038 if (string
&& STRINGP (lisp_string
))
23039 /* LISP_STRING is the one returned by decode_mode_spec. We should
23040 ignore its text properties. */
23041 it
->stop_charpos
= it
->end_charpos
;
23043 /* If displaying STRING, set up the face of the iterator from
23044 FACE_STRING, if that's given. */
23045 if (STRINGP (face_string
))
23051 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23052 0, &endptr
, it
->base_face_id
, 0);
23053 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23054 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23057 /* Set max_x to the maximum allowed X position. Don't let it go
23058 beyond the right edge of the window. */
23060 max_x
= it
->last_visible_x
;
23062 max_x
= min (max_x
, it
->last_visible_x
);
23064 /* Skip over display elements that are not visible. because IT->w is
23066 if (it
->current_x
< it
->first_visible_x
)
23067 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23068 MOVE_TO_POS
| MOVE_TO_X
);
23070 row
->ascent
= it
->max_ascent
;
23071 row
->height
= it
->max_ascent
+ it
->max_descent
;
23072 row
->phys_ascent
= it
->max_phys_ascent
;
23073 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23074 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23076 if (STRINGP (it
->string
))
23077 it_charpos
= IT_STRING_CHARPOS (*it
);
23079 it_charpos
= IT_CHARPOS (*it
);
23081 /* This condition is for the case that we are called with current_x
23082 past last_visible_x. */
23083 while (it
->current_x
< max_x
)
23085 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23087 /* Get the next display element. */
23088 if (!get_next_display_element (it
))
23091 /* Produce glyphs. */
23092 x_before
= it
->current_x
;
23093 n_glyphs_before
= row
->used
[TEXT_AREA
];
23094 PRODUCE_GLYPHS (it
);
23096 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23099 while (i
< nglyphs
)
23101 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23103 if (it
->line_wrap
!= TRUNCATE
23104 && x
+ glyph
->pixel_width
> max_x
)
23106 /* End of continued line or max_x reached. */
23107 if (CHAR_GLYPH_PADDING_P (*glyph
))
23109 /* A wide character is unbreakable. */
23110 if (row
->reversed_p
)
23111 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23112 - n_glyphs_before
);
23113 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23114 it
->current_x
= x_before
;
23118 if (row
->reversed_p
)
23119 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23120 - (n_glyphs_before
+ i
));
23121 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23126 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23128 /* Glyph is at least partially visible. */
23130 if (x
< it
->first_visible_x
)
23131 row
->x
= x
- it
->first_visible_x
;
23135 /* Glyph is off the left margin of the display area.
23136 Should not happen. */
23140 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23141 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23142 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23143 row
->phys_height
= max (row
->phys_height
,
23144 it
->max_phys_ascent
+ it
->max_phys_descent
);
23145 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23146 it
->max_extra_line_spacing
);
23147 x
+= glyph
->pixel_width
;
23151 /* Stop if max_x reached. */
23155 /* Stop at line ends. */
23156 if (ITERATOR_AT_END_OF_LINE_P (it
))
23158 it
->continuation_lines_width
= 0;
23162 set_iterator_to_next (it
, 1);
23163 if (STRINGP (it
->string
))
23164 it_charpos
= IT_STRING_CHARPOS (*it
);
23166 it_charpos
= IT_CHARPOS (*it
);
23168 /* Stop if truncating at the right edge. */
23169 if (it
->line_wrap
== TRUNCATE
23170 && it
->current_x
>= it
->last_visible_x
)
23172 /* Add truncation mark, but don't do it if the line is
23173 truncated at a padding space. */
23174 if (it_charpos
< it
->string_nchars
)
23176 if (!FRAME_WINDOW_P (it
->f
))
23180 if (it
->current_x
> it
->last_visible_x
)
23182 if (!row
->reversed_p
)
23184 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23185 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23190 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23191 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23193 unproduce_glyphs (it
, ii
+ 1);
23194 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23196 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23198 row
->used
[TEXT_AREA
] = ii
;
23199 produce_special_glyphs (it
, IT_TRUNCATION
);
23202 produce_special_glyphs (it
, IT_TRUNCATION
);
23204 row
->truncated_on_right_p
= 1;
23210 /* Maybe insert a truncation at the left. */
23211 if (it
->first_visible_x
23214 if (!FRAME_WINDOW_P (it
->f
)
23215 || (row
->reversed_p
23216 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23217 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23218 insert_left_trunc_glyphs (it
);
23219 row
->truncated_on_left_p
= 1;
23222 it
->face_id
= saved_face_id
;
23224 /* Value is number of columns displayed. */
23225 return it
->hpos
- hpos_at_start
;
23230 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23231 appears as an element of LIST or as the car of an element of LIST.
23232 If PROPVAL is a list, compare each element against LIST in that
23233 way, and return 1/2 if any element of PROPVAL is found in LIST.
23234 Otherwise return 0. This function cannot quit.
23235 The return value is 2 if the text is invisible but with an ellipsis
23236 and 1 if it's invisible and without an ellipsis. */
23239 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23241 register Lisp_Object tail
, proptail
;
23243 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23245 register Lisp_Object tem
;
23247 if (EQ (propval
, tem
))
23249 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23250 return NILP (XCDR (tem
)) ? 1 : 2;
23253 if (CONSP (propval
))
23255 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23257 Lisp_Object propelt
;
23258 propelt
= XCAR (proptail
);
23259 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23261 register Lisp_Object tem
;
23263 if (EQ (propelt
, tem
))
23265 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23266 return NILP (XCDR (tem
)) ? 1 : 2;
23274 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23275 doc
: /* Non-nil if the property makes the text invisible.
23276 POS-OR-PROP can be a marker or number, in which case it is taken to be
23277 a position in the current buffer and the value of the `invisible' property
23278 is checked; or it can be some other value, which is then presumed to be the
23279 value of the `invisible' property of the text of interest.
23280 The non-nil value returned can be t for truly invisible text or something
23281 else if the text is replaced by an ellipsis. */)
23282 (Lisp_Object pos_or_prop
)
23285 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23286 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23288 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23289 return (invis
== 0 ? Qnil
23291 : make_number (invis
));
23294 /* Calculate a width or height in pixels from a specification using
23295 the following elements:
23298 NUM - a (fractional) multiple of the default font width/height
23299 (NUM) - specifies exactly NUM pixels
23300 UNIT - a fixed number of pixels, see below.
23301 ELEMENT - size of a display element in pixels, see below.
23302 (NUM . SPEC) - equals NUM * SPEC
23303 (+ SPEC SPEC ...) - add pixel values
23304 (- SPEC SPEC ...) - subtract pixel values
23305 (- SPEC) - negate pixel value
23308 INT or FLOAT - a number constant
23309 SYMBOL - use symbol's (buffer local) variable binding.
23312 in - pixels per inch *)
23313 mm - pixels per 1/1000 meter *)
23314 cm - pixels per 1/100 meter *)
23315 width - width of current font in pixels.
23316 height - height of current font in pixels.
23318 *) using the ratio(s) defined in display-pixels-per-inch.
23322 left-fringe - left fringe width in pixels
23323 right-fringe - right fringe width in pixels
23325 left-margin - left margin width in pixels
23326 right-margin - right margin width in pixels
23328 scroll-bar - scroll-bar area width in pixels
23332 Pixels corresponding to 5 inches:
23335 Total width of non-text areas on left side of window (if scroll-bar is on left):
23336 '(space :width (+ left-fringe left-margin scroll-bar))
23338 Align to first text column (in header line):
23339 '(space :align-to 0)
23341 Align to middle of text area minus half the width of variable `my-image'
23342 containing a loaded image:
23343 '(space :align-to (0.5 . (- text my-image)))
23345 Width of left margin minus width of 1 character in the default font:
23346 '(space :width (- left-margin 1))
23348 Width of left margin minus width of 2 characters in the current font:
23349 '(space :width (- left-margin (2 . width)))
23351 Center 1 character over left-margin (in header line):
23352 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23354 Different ways to express width of left fringe plus left margin minus one pixel:
23355 '(space :width (- (+ left-fringe left-margin) (1)))
23356 '(space :width (+ left-fringe left-margin (- (1))))
23357 '(space :width (+ left-fringe left-margin (-1)))
23362 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23363 struct font
*font
, int width_p
, int *align_to
)
23367 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23368 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23371 return OK_PIXELS (0);
23373 eassert (FRAME_LIVE_P (it
->f
));
23375 if (SYMBOLP (prop
))
23377 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23379 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23381 if (unit
[0] == 'i' && unit
[1] == 'n')
23383 else if (unit
[0] == 'm' && unit
[1] == 'm')
23385 else if (unit
[0] == 'c' && unit
[1] == 'm')
23391 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23392 : FRAME_RES_Y (it
->f
));
23395 return OK_PIXELS (ppi
/ pixels
);
23400 #ifdef HAVE_WINDOW_SYSTEM
23401 if (EQ (prop
, Qheight
))
23402 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23403 if (EQ (prop
, Qwidth
))
23404 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23406 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23407 return OK_PIXELS (1);
23410 if (EQ (prop
, Qtext
))
23411 return OK_PIXELS (width_p
23412 ? window_box_width (it
->w
, TEXT_AREA
)
23413 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23415 if (align_to
&& *align_to
< 0)
23418 if (EQ (prop
, Qleft
))
23419 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23420 if (EQ (prop
, Qright
))
23421 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23422 if (EQ (prop
, Qcenter
))
23423 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23424 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23425 if (EQ (prop
, Qleft_fringe
))
23426 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23427 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23428 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23429 if (EQ (prop
, Qright_fringe
))
23430 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23431 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23432 : window_box_right_offset (it
->w
, TEXT_AREA
));
23433 if (EQ (prop
, Qleft_margin
))
23434 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23435 if (EQ (prop
, Qright_margin
))
23436 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23437 if (EQ (prop
, Qscroll_bar
))
23438 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23440 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23441 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23442 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23447 if (EQ (prop
, Qleft_fringe
))
23448 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23449 if (EQ (prop
, Qright_fringe
))
23450 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23451 if (EQ (prop
, Qleft_margin
))
23452 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23453 if (EQ (prop
, Qright_margin
))
23454 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23455 if (EQ (prop
, Qscroll_bar
))
23456 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23459 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
23460 if (EQ (prop
, Qunbound
))
23464 if (INTEGERP (prop
) || FLOATP (prop
))
23466 int base_unit
= (width_p
23467 ? FRAME_COLUMN_WIDTH (it
->f
)
23468 : FRAME_LINE_HEIGHT (it
->f
));
23469 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23474 Lisp_Object car
= XCAR (prop
);
23475 Lisp_Object cdr
= XCDR (prop
);
23479 #ifdef HAVE_WINDOW_SYSTEM
23480 if (FRAME_WINDOW_P (it
->f
)
23481 && valid_image_p (prop
))
23483 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23484 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23486 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23489 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23495 while (CONSP (cdr
))
23497 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23498 font
, width_p
, align_to
))
23501 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23506 if (EQ (car
, Qminus
))
23508 return OK_PIXELS (pixels
);
23511 car
= buffer_local_value_1 (car
, it
->w
->contents
);
23512 if (EQ (car
, Qunbound
))
23516 if (INTEGERP (car
) || FLOATP (car
))
23519 pixels
= XFLOATINT (car
);
23521 return OK_PIXELS (pixels
);
23522 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23523 font
, width_p
, align_to
))
23524 return OK_PIXELS (pixels
* fact
);
23535 /***********************************************************************
23537 ***********************************************************************/
23539 #ifdef HAVE_WINDOW_SYSTEM
23544 dump_glyph_string (struct glyph_string
*s
)
23546 fprintf (stderr
, "glyph string\n");
23547 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23548 s
->x
, s
->y
, s
->width
, s
->height
);
23549 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23550 fprintf (stderr
, " hl = %d\n", s
->hl
);
23551 fprintf (stderr
, " left overhang = %d, right = %d\n",
23552 s
->left_overhang
, s
->right_overhang
);
23553 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23554 fprintf (stderr
, " extends to end of line = %d\n",
23555 s
->extends_to_end_of_line_p
);
23556 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23557 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23560 #endif /* GLYPH_DEBUG */
23562 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23563 of XChar2b structures for S; it can't be allocated in
23564 init_glyph_string because it must be allocated via `alloca'. W
23565 is the window on which S is drawn. ROW and AREA are the glyph row
23566 and area within the row from which S is constructed. START is the
23567 index of the first glyph structure covered by S. HL is a
23568 face-override for drawing S. */
23571 #define OPTIONAL_HDC(hdc) HDC hdc,
23572 #define DECLARE_HDC(hdc) HDC hdc;
23573 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23574 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23577 #ifndef OPTIONAL_HDC
23578 #define OPTIONAL_HDC(hdc)
23579 #define DECLARE_HDC(hdc)
23580 #define ALLOCATE_HDC(hdc, f)
23581 #define RELEASE_HDC(hdc, f)
23585 init_glyph_string (struct glyph_string
*s
,
23587 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23588 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23590 memset (s
, 0, sizeof *s
);
23592 s
->f
= XFRAME (w
->frame
);
23596 s
->display
= FRAME_X_DISPLAY (s
->f
);
23597 s
->window
= FRAME_X_WINDOW (s
->f
);
23598 s
->char2b
= char2b
;
23602 s
->first_glyph
= row
->glyphs
[area
] + start
;
23603 s
->height
= row
->height
;
23604 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23605 s
->ybase
= s
->y
+ row
->ascent
;
23609 /* Append the list of glyph strings with head H and tail T to the list
23610 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23613 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23614 struct glyph_string
*h
, struct glyph_string
*t
)
23628 /* Prepend the list of glyph strings with head H and tail T to the
23629 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23633 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23634 struct glyph_string
*h
, struct glyph_string
*t
)
23648 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23649 Set *HEAD and *TAIL to the resulting list. */
23652 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23653 struct glyph_string
*s
)
23655 s
->next
= s
->prev
= NULL
;
23656 append_glyph_string_lists (head
, tail
, s
, s
);
23660 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23661 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23662 make sure that X resources for the face returned are allocated.
23663 Value is a pointer to a realized face that is ready for display if
23664 DISPLAY_P is non-zero. */
23666 static struct face
*
23667 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23668 XChar2b
*char2b
, int display_p
)
23670 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23675 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23677 if (code
== FONT_INVALID_CODE
)
23680 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23682 /* Make sure X resources of the face are allocated. */
23683 #ifdef HAVE_X_WINDOWS
23687 eassert (face
!= NULL
);
23688 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23695 /* Get face and two-byte form of character glyph GLYPH on frame F.
23696 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23697 a pointer to a realized face that is ready for display. */
23699 static struct face
*
23700 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
23701 XChar2b
*char2b
, int *two_byte_p
)
23706 eassert (glyph
->type
== CHAR_GLYPH
);
23707 face
= FACE_FROM_ID (f
, glyph
->face_id
);
23709 /* Make sure X resources of the face are allocated. */
23710 eassert (face
!= NULL
);
23711 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23718 if (CHAR_BYTE8_P (glyph
->u
.ch
))
23719 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
23721 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
23723 if (code
== FONT_INVALID_CODE
)
23727 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23732 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
23733 Return 1 if FONT has a glyph for C, otherwise return 0. */
23736 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
23740 if (CHAR_BYTE8_P (c
))
23741 code
= CHAR_TO_BYTE8 (c
);
23743 code
= font
->driver
->encode_char (font
, c
);
23745 if (code
== FONT_INVALID_CODE
)
23747 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23752 /* Fill glyph string S with composition components specified by S->cmp.
23754 BASE_FACE is the base face of the composition.
23755 S->cmp_from is the index of the first component for S.
23757 OVERLAPS non-zero means S should draw the foreground only, and use
23758 its physical height for clipping. See also draw_glyphs.
23760 Value is the index of a component not in S. */
23763 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
23767 /* For all glyphs of this composition, starting at the offset
23768 S->cmp_from, until we reach the end of the definition or encounter a
23769 glyph that requires the different face, add it to S. */
23774 s
->for_overlaps
= overlaps
;
23777 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
23779 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
23781 /* TAB in a composition means display glyphs with padding space
23782 on the left or right. */
23785 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
23788 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
23795 s
->font
= s
->face
->font
;
23797 else if (s
->face
!= face
)
23805 if (s
->face
== NULL
)
23807 s
->face
= base_face
->ascii_face
;
23808 s
->font
= s
->face
->font
;
23811 /* All glyph strings for the same composition has the same width,
23812 i.e. the width set for the first component of the composition. */
23813 s
->width
= s
->first_glyph
->pixel_width
;
23815 /* If the specified font could not be loaded, use the frame's
23816 default font, but record the fact that we couldn't load it in
23817 the glyph string so that we can draw rectangles for the
23818 characters of the glyph string. */
23819 if (s
->font
== NULL
)
23821 s
->font_not_found_p
= 1;
23822 s
->font
= FRAME_FONT (s
->f
);
23825 /* Adjust base line for subscript/superscript text. */
23826 s
->ybase
+= s
->first_glyph
->voffset
;
23828 /* This glyph string must always be drawn with 16-bit functions. */
23835 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
23836 int start
, int end
, int overlaps
)
23838 struct glyph
*glyph
, *last
;
23839 Lisp_Object lgstring
;
23842 s
->for_overlaps
= overlaps
;
23843 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23844 last
= s
->row
->glyphs
[s
->area
] + end
;
23845 s
->cmp_id
= glyph
->u
.cmp
.id
;
23846 s
->cmp_from
= glyph
->slice
.cmp
.from
;
23847 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
23848 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23849 lgstring
= composition_gstring_from_id (s
->cmp_id
);
23850 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
23852 while (glyph
< last
23853 && glyph
->u
.cmp
.automatic
23854 && glyph
->u
.cmp
.id
== s
->cmp_id
23855 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
23856 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
23858 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
23860 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
23861 unsigned code
= LGLYPH_CODE (lglyph
);
23863 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
23865 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
23866 return glyph
- s
->row
->glyphs
[s
->area
];
23870 /* Fill glyph string S from a sequence glyphs for glyphless characters.
23871 See the comment of fill_glyph_string for arguments.
23872 Value is the index of the first glyph not in S. */
23876 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
23877 int start
, int end
, int overlaps
)
23879 struct glyph
*glyph
, *last
;
23882 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
23883 s
->for_overlaps
= overlaps
;
23884 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23885 last
= s
->row
->glyphs
[s
->area
] + end
;
23886 voffset
= glyph
->voffset
;
23887 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23888 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
23890 s
->width
= glyph
->pixel_width
;
23892 while (glyph
< last
23893 && glyph
->type
== GLYPHLESS_GLYPH
23894 && glyph
->voffset
== voffset
23895 && glyph
->face_id
== face_id
)
23898 s
->width
+= glyph
->pixel_width
;
23901 s
->ybase
+= voffset
;
23902 return glyph
- s
->row
->glyphs
[s
->area
];
23906 /* Fill glyph string S from a sequence of character glyphs.
23908 FACE_ID is the face id of the string. START is the index of the
23909 first glyph to consider, END is the index of the last + 1.
23910 OVERLAPS non-zero means S should draw the foreground only, and use
23911 its physical height for clipping. See also draw_glyphs.
23913 Value is the index of the first glyph not in S. */
23916 fill_glyph_string (struct glyph_string
*s
, int face_id
,
23917 int start
, int end
, int overlaps
)
23919 struct glyph
*glyph
, *last
;
23921 int glyph_not_available_p
;
23923 eassert (s
->f
== XFRAME (s
->w
->frame
));
23924 eassert (s
->nchars
== 0);
23925 eassert (start
>= 0 && end
> start
);
23927 s
->for_overlaps
= overlaps
;
23928 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23929 last
= s
->row
->glyphs
[s
->area
] + end
;
23930 voffset
= glyph
->voffset
;
23931 s
->padding_p
= glyph
->padding_p
;
23932 glyph_not_available_p
= glyph
->glyph_not_available_p
;
23934 while (glyph
< last
23935 && glyph
->type
== CHAR_GLYPH
23936 && glyph
->voffset
== voffset
23937 /* Same face id implies same font, nowadays. */
23938 && glyph
->face_id
== face_id
23939 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
23943 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
23944 s
->char2b
+ s
->nchars
,
23946 s
->two_byte_p
= two_byte_p
;
23948 eassert (s
->nchars
<= end
- start
);
23949 s
->width
+= glyph
->pixel_width
;
23950 if (glyph
++->padding_p
!= s
->padding_p
)
23954 s
->font
= s
->face
->font
;
23956 /* If the specified font could not be loaded, use the frame's font,
23957 but record the fact that we couldn't load it in
23958 S->font_not_found_p so that we can draw rectangles for the
23959 characters of the glyph string. */
23960 if (s
->font
== NULL
|| glyph_not_available_p
)
23962 s
->font_not_found_p
= 1;
23963 s
->font
= FRAME_FONT (s
->f
);
23966 /* Adjust base line for subscript/superscript text. */
23967 s
->ybase
+= voffset
;
23969 eassert (s
->face
&& s
->face
->gc
);
23970 return glyph
- s
->row
->glyphs
[s
->area
];
23974 /* Fill glyph string S from image glyph S->first_glyph. */
23977 fill_image_glyph_string (struct glyph_string
*s
)
23979 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
23980 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
23982 s
->slice
= s
->first_glyph
->slice
.img
;
23983 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
23984 s
->font
= s
->face
->font
;
23985 s
->width
= s
->first_glyph
->pixel_width
;
23987 /* Adjust base line for subscript/superscript text. */
23988 s
->ybase
+= s
->first_glyph
->voffset
;
23992 /* Fill glyph string S from a sequence of stretch glyphs.
23994 START is the index of the first glyph to consider,
23995 END is the index of the last + 1.
23997 Value is the index of the first glyph not in S. */
24000 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24002 struct glyph
*glyph
, *last
;
24003 int voffset
, face_id
;
24005 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24007 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24008 last
= s
->row
->glyphs
[s
->area
] + end
;
24009 face_id
= glyph
->face_id
;
24010 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24011 s
->font
= s
->face
->font
;
24012 s
->width
= glyph
->pixel_width
;
24014 voffset
= glyph
->voffset
;
24018 && glyph
->type
== STRETCH_GLYPH
24019 && glyph
->voffset
== voffset
24020 && glyph
->face_id
== face_id
);
24022 s
->width
+= glyph
->pixel_width
;
24024 /* Adjust base line for subscript/superscript text. */
24025 s
->ybase
+= voffset
;
24027 /* The case that face->gc == 0 is handled when drawing the glyph
24028 string by calling PREPARE_FACE_FOR_DISPLAY. */
24030 return glyph
- s
->row
->glyphs
[s
->area
];
24033 static struct font_metrics
*
24034 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24036 static struct font_metrics metrics
;
24041 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24042 if (code
== FONT_INVALID_CODE
)
24044 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24049 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24050 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24051 assumed to be zero. */
24054 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24056 *left
= *right
= 0;
24058 if (glyph
->type
== CHAR_GLYPH
)
24062 struct font_metrics
*pcm
;
24064 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24065 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24067 if (pcm
->rbearing
> pcm
->width
)
24068 *right
= pcm
->rbearing
- pcm
->width
;
24069 if (pcm
->lbearing
< 0)
24070 *left
= -pcm
->lbearing
;
24073 else if (glyph
->type
== COMPOSITE_GLYPH
)
24075 if (! glyph
->u
.cmp
.automatic
)
24077 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24079 if (cmp
->rbearing
> cmp
->pixel_width
)
24080 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24081 if (cmp
->lbearing
< 0)
24082 *left
= - cmp
->lbearing
;
24086 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24087 struct font_metrics metrics
;
24089 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24090 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24091 if (metrics
.rbearing
> metrics
.width
)
24092 *right
= metrics
.rbearing
- metrics
.width
;
24093 if (metrics
.lbearing
< 0)
24094 *left
= - metrics
.lbearing
;
24100 /* Return the index of the first glyph preceding glyph string S that
24101 is overwritten by S because of S's left overhang. Value is -1
24102 if no glyphs are overwritten. */
24105 left_overwritten (struct glyph_string
*s
)
24109 if (s
->left_overhang
)
24112 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24113 int first
= s
->first_glyph
- glyphs
;
24115 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24116 x
-= glyphs
[i
].pixel_width
;
24127 /* Return the index of the first glyph preceding glyph string S that
24128 is overwriting S because of its right overhang. Value is -1 if no
24129 glyph in front of S overwrites S. */
24132 left_overwriting (struct glyph_string
*s
)
24135 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24136 int first
= s
->first_glyph
- glyphs
;
24140 for (i
= first
- 1; i
>= 0; --i
)
24143 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24146 x
-= glyphs
[i
].pixel_width
;
24153 /* Return the index of the last glyph following glyph string S that is
24154 overwritten by S because of S's right overhang. Value is -1 if
24155 no such glyph is found. */
24158 right_overwritten (struct glyph_string
*s
)
24162 if (s
->right_overhang
)
24165 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24166 int first
= (s
->first_glyph
- glyphs
24167 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24168 int end
= s
->row
->used
[s
->area
];
24170 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24171 x
+= glyphs
[i
].pixel_width
;
24180 /* Return the index of the last glyph following glyph string S that
24181 overwrites S because of its left overhang. Value is negative
24182 if no such glyph is found. */
24185 right_overwriting (struct glyph_string
*s
)
24188 int end
= s
->row
->used
[s
->area
];
24189 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24190 int first
= (s
->first_glyph
- glyphs
24191 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24195 for (i
= first
; i
< end
; ++i
)
24198 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24201 x
+= glyphs
[i
].pixel_width
;
24208 /* Set background width of glyph string S. START is the index of the
24209 first glyph following S. LAST_X is the right-most x-position + 1
24210 in the drawing area. */
24213 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24215 /* If the face of this glyph string has to be drawn to the end of
24216 the drawing area, set S->extends_to_end_of_line_p. */
24218 if (start
== s
->row
->used
[s
->area
]
24219 && ((s
->row
->fill_line_p
24220 && (s
->hl
== DRAW_NORMAL_TEXT
24221 || s
->hl
== DRAW_IMAGE_RAISED
24222 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24223 || s
->hl
== DRAW_MOUSE_FACE
))
24224 s
->extends_to_end_of_line_p
= 1;
24226 /* If S extends its face to the end of the line, set its
24227 background_width to the distance to the right edge of the drawing
24229 if (s
->extends_to_end_of_line_p
)
24230 s
->background_width
= last_x
- s
->x
+ 1;
24232 s
->background_width
= s
->width
;
24236 /* Compute overhangs and x-positions for glyph string S and its
24237 predecessors, or successors. X is the starting x-position for S.
24238 BACKWARD_P non-zero means process predecessors. */
24241 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24247 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24248 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24258 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24259 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24269 /* The following macros are only called from draw_glyphs below.
24270 They reference the following parameters of that function directly:
24271 `w', `row', `area', and `overlap_p'
24272 as well as the following local variables:
24273 `s', `f', and `hdc' (in W32) */
24276 /* On W32, silently add local `hdc' variable to argument list of
24277 init_glyph_string. */
24278 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24279 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24281 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24282 init_glyph_string (s, char2b, w, row, area, start, hl)
24285 /* Add a glyph string for a stretch glyph to the list of strings
24286 between HEAD and TAIL. START is the index of the stretch glyph in
24287 row area AREA of glyph row ROW. END is the index of the last glyph
24288 in that glyph row area. X is the current output position assigned
24289 to the new glyph string constructed. HL overrides that face of the
24290 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24291 is the right-most x-position of the drawing area. */
24293 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24294 and below -- keep them on one line. */
24295 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24298 s = alloca (sizeof *s); \
24299 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24300 START = fill_stretch_glyph_string (s, START, END); \
24301 append_glyph_string (&HEAD, &TAIL, s); \
24307 /* Add a glyph string for an image glyph to the list of strings
24308 between HEAD and TAIL. START is the index of the image glyph in
24309 row area AREA of glyph row ROW. END is the index of the last glyph
24310 in that glyph row area. X is the current output position assigned
24311 to the new glyph string constructed. HL overrides that face of the
24312 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24313 is the right-most x-position of the drawing area. */
24315 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24318 s = alloca (sizeof *s); \
24319 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24320 fill_image_glyph_string (s); \
24321 append_glyph_string (&HEAD, &TAIL, s); \
24328 /* Add a glyph string for a sequence of character glyphs to the list
24329 of strings between HEAD and TAIL. START is the index of the first
24330 glyph in row area AREA of glyph row ROW that is part of the new
24331 glyph string. END is the index of the last glyph in that glyph row
24332 area. X is the current output position assigned to the new glyph
24333 string constructed. HL overrides that face of the glyph; e.g. it
24334 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24335 right-most x-position of the drawing area. */
24337 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24343 face_id = (row)->glyphs[area][START].face_id; \
24345 s = alloca (sizeof *s); \
24346 char2b = alloca ((END - START) * sizeof *char2b); \
24347 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24348 append_glyph_string (&HEAD, &TAIL, s); \
24350 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24355 /* Add a glyph string for a composite sequence to the list of strings
24356 between HEAD and TAIL. START is the index of the first glyph in
24357 row area AREA of glyph row ROW that is part of the new glyph
24358 string. END is the index of the last glyph in that glyph row area.
24359 X is the current output position assigned to the new glyph string
24360 constructed. HL overrides that face of the glyph; e.g. it is
24361 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24362 x-position of the drawing area. */
24364 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24366 int face_id = (row)->glyphs[area][START].face_id; \
24367 struct face *base_face = FACE_FROM_ID (f, face_id); \
24368 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24369 struct composition *cmp = composition_table[cmp_id]; \
24371 struct glyph_string *first_s = NULL; \
24374 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24376 /* Make glyph_strings for each glyph sequence that is drawable by \
24377 the same face, and append them to HEAD/TAIL. */ \
24378 for (n = 0; n < cmp->glyph_len;) \
24380 s = alloca (sizeof *s); \
24381 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24382 append_glyph_string (&(HEAD), &(TAIL), s); \
24388 n = fill_composite_glyph_string (s, base_face, overlaps); \
24396 /* Add a glyph string for a glyph-string sequence to the list of strings
24397 between HEAD and TAIL. */
24399 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24403 Lisp_Object gstring; \
24405 face_id = (row)->glyphs[area][START].face_id; \
24406 gstring = (composition_gstring_from_id \
24407 ((row)->glyphs[area][START].u.cmp.id)); \
24408 s = alloca (sizeof *s); \
24409 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24410 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24411 append_glyph_string (&(HEAD), &(TAIL), s); \
24413 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24417 /* Add a glyph string for a sequence of glyphless character's glyphs
24418 to the list of strings between HEAD and TAIL. The meanings of
24419 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24421 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24426 face_id = (row)->glyphs[area][START].face_id; \
24428 s = alloca (sizeof *s); \
24429 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24430 append_glyph_string (&HEAD, &TAIL, s); \
24432 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24438 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24439 of AREA of glyph row ROW on window W between indices START and END.
24440 HL overrides the face for drawing glyph strings, e.g. it is
24441 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24442 x-positions of the drawing area.
24444 This is an ugly monster macro construct because we must use alloca
24445 to allocate glyph strings (because draw_glyphs can be called
24446 asynchronously). */
24448 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24451 HEAD = TAIL = NULL; \
24452 while (START < END) \
24454 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24455 switch (first_glyph->type) \
24458 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24462 case COMPOSITE_GLYPH: \
24463 if (first_glyph->u.cmp.automatic) \
24464 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24467 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24471 case STRETCH_GLYPH: \
24472 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24476 case IMAGE_GLYPH: \
24477 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24481 case GLYPHLESS_GLYPH: \
24482 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24492 set_glyph_string_background_width (s, START, LAST_X); \
24499 /* Draw glyphs between START and END in AREA of ROW on window W,
24500 starting at x-position X. X is relative to AREA in W. HL is a
24501 face-override with the following meaning:
24503 DRAW_NORMAL_TEXT draw normally
24504 DRAW_CURSOR draw in cursor face
24505 DRAW_MOUSE_FACE draw in mouse face.
24506 DRAW_INVERSE_VIDEO draw in mode line face
24507 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24508 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24510 If OVERLAPS is non-zero, draw only the foreground of characters and
24511 clip to the physical height of ROW. Non-zero value also defines
24512 the overlapping part to be drawn:
24514 OVERLAPS_PRED overlap with preceding rows
24515 OVERLAPS_SUCC overlap with succeeding rows
24516 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24517 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24519 Value is the x-position reached, relative to AREA of W. */
24522 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24523 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24524 enum draw_glyphs_face hl
, int overlaps
)
24526 struct glyph_string
*head
, *tail
;
24527 struct glyph_string
*s
;
24528 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24529 int i
, j
, x_reached
, last_x
, area_left
= 0;
24530 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24533 ALLOCATE_HDC (hdc
, f
);
24535 /* Let's rather be paranoid than getting a SEGV. */
24536 end
= min (end
, row
->used
[area
]);
24537 start
= clip_to_bounds (0, start
, end
);
24539 /* Translate X to frame coordinates. Set last_x to the right
24540 end of the drawing area. */
24541 if (row
->full_width_p
)
24543 /* X is relative to the left edge of W, without scroll bars
24545 area_left
= WINDOW_LEFT_EDGE_X (w
);
24546 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24547 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24551 area_left
= window_box_left (w
, area
);
24552 last_x
= area_left
+ window_box_width (w
, area
);
24556 /* Build a doubly-linked list of glyph_string structures between
24557 head and tail from what we have to draw. Note that the macro
24558 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24559 the reason we use a separate variable `i'. */
24561 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24563 x_reached
= tail
->x
+ tail
->background_width
;
24567 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24568 the row, redraw some glyphs in front or following the glyph
24569 strings built above. */
24570 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24572 struct glyph_string
*h
, *t
;
24573 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24574 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24575 int check_mouse_face
= 0;
24578 /* If mouse highlighting is on, we may need to draw adjacent
24579 glyphs using mouse-face highlighting. */
24580 if (area
== TEXT_AREA
&& row
->mouse_face_p
24581 && hlinfo
->mouse_face_beg_row
>= 0
24582 && hlinfo
->mouse_face_end_row
>= 0)
24584 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24586 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24587 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24589 check_mouse_face
= 1;
24590 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24591 ? hlinfo
->mouse_face_beg_col
: 0;
24592 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24593 ? hlinfo
->mouse_face_end_col
24594 : row
->used
[TEXT_AREA
];
24598 /* Compute overhangs for all glyph strings. */
24599 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24600 for (s
= head
; s
; s
= s
->next
)
24601 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24603 /* Prepend glyph strings for glyphs in front of the first glyph
24604 string that are overwritten because of the first glyph
24605 string's left overhang. The background of all strings
24606 prepended must be drawn because the first glyph string
24608 i
= left_overwritten (head
);
24611 enum draw_glyphs_face overlap_hl
;
24613 /* If this row contains mouse highlighting, attempt to draw
24614 the overlapped glyphs with the correct highlight. This
24615 code fails if the overlap encompasses more than one glyph
24616 and mouse-highlight spans only some of these glyphs.
24617 However, making it work perfectly involves a lot more
24618 code, and I don't know if the pathological case occurs in
24619 practice, so we'll stick to this for now. --- cyd */
24620 if (check_mouse_face
24621 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24622 overlap_hl
= DRAW_MOUSE_FACE
;
24624 overlap_hl
= DRAW_NORMAL_TEXT
;
24627 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24628 overlap_hl
, dummy_x
, last_x
);
24630 compute_overhangs_and_x (t
, head
->x
, 1);
24631 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24635 /* Prepend glyph strings for glyphs in front of the first glyph
24636 string that overwrite that glyph string because of their
24637 right overhang. For these strings, only the foreground must
24638 be drawn, because it draws over the glyph string at `head'.
24639 The background must not be drawn because this would overwrite
24640 right overhangs of preceding glyphs for which no glyph
24642 i
= left_overwriting (head
);
24645 enum draw_glyphs_face overlap_hl
;
24647 if (check_mouse_face
24648 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24649 overlap_hl
= DRAW_MOUSE_FACE
;
24651 overlap_hl
= DRAW_NORMAL_TEXT
;
24654 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24655 overlap_hl
, dummy_x
, last_x
);
24656 for (s
= h
; s
; s
= s
->next
)
24657 s
->background_filled_p
= 1;
24658 compute_overhangs_and_x (t
, head
->x
, 1);
24659 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24662 /* Append glyphs strings for glyphs following the last glyph
24663 string tail that are overwritten by tail. The background of
24664 these strings has to be drawn because tail's foreground draws
24666 i
= right_overwritten (tail
);
24669 enum draw_glyphs_face overlap_hl
;
24671 if (check_mouse_face
24672 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24673 overlap_hl
= DRAW_MOUSE_FACE
;
24675 overlap_hl
= DRAW_NORMAL_TEXT
;
24677 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24678 overlap_hl
, x
, last_x
);
24679 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24680 we don't have `end = i;' here. */
24681 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24682 append_glyph_string_lists (&head
, &tail
, h
, t
);
24686 /* Append glyph strings for glyphs following the last glyph
24687 string tail that overwrite tail. The foreground of such
24688 glyphs has to be drawn because it writes into the background
24689 of tail. The background must not be drawn because it could
24690 paint over the foreground of following glyphs. */
24691 i
= right_overwriting (tail
);
24694 enum draw_glyphs_face overlap_hl
;
24695 if (check_mouse_face
24696 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24697 overlap_hl
= DRAW_MOUSE_FACE
;
24699 overlap_hl
= DRAW_NORMAL_TEXT
;
24702 i
++; /* We must include the Ith glyph. */
24703 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24704 overlap_hl
, x
, last_x
);
24705 for (s
= h
; s
; s
= s
->next
)
24706 s
->background_filled_p
= 1;
24707 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24708 append_glyph_string_lists (&head
, &tail
, h
, t
);
24710 if (clip_head
|| clip_tail
)
24711 for (s
= head
; s
; s
= s
->next
)
24713 s
->clip_head
= clip_head
;
24714 s
->clip_tail
= clip_tail
;
24718 /* Draw all strings. */
24719 for (s
= head
; s
; s
= s
->next
)
24720 FRAME_RIF (f
)->draw_glyph_string (s
);
24723 /* When focus a sole frame and move horizontally, this sets on_p to 0
24724 causing a failure to erase prev cursor position. */
24725 if (area
== TEXT_AREA
24726 && !row
->full_width_p
24727 /* When drawing overlapping rows, only the glyph strings'
24728 foreground is drawn, which doesn't erase a cursor
24732 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
24733 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
24734 : (tail
? tail
->x
+ tail
->background_width
: x
));
24738 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
24739 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
24743 /* Value is the x-position up to which drawn, relative to AREA of W.
24744 This doesn't include parts drawn because of overhangs. */
24745 if (row
->full_width_p
)
24746 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
24748 x_reached
-= area_left
;
24750 RELEASE_HDC (hdc
, f
);
24755 /* Expand row matrix if too narrow. Don't expand if area
24758 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
24760 if (!it->f->fonts_changed \
24761 && (it->glyph_row->glyphs[area] \
24762 < it->glyph_row->glyphs[area + 1])) \
24764 it->w->ncols_scale_factor++; \
24765 it->f->fonts_changed = 1; \
24769 /* Store one glyph for IT->char_to_display in IT->glyph_row.
24770 Called from x_produce_glyphs when IT->glyph_row is non-null. */
24773 append_glyph (struct it
*it
)
24775 struct glyph
*glyph
;
24776 enum glyph_row_area area
= it
->area
;
24778 eassert (it
->glyph_row
);
24779 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
24781 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24782 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24784 /* If the glyph row is reversed, we need to prepend the glyph
24785 rather than append it. */
24786 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24790 /* Make room for the additional glyph. */
24791 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24793 glyph
= it
->glyph_row
->glyphs
[area
];
24795 glyph
->charpos
= CHARPOS (it
->position
);
24796 glyph
->object
= it
->object
;
24797 if (it
->pixel_width
> 0)
24799 glyph
->pixel_width
= it
->pixel_width
;
24800 glyph
->padding_p
= 0;
24804 /* Assure at least 1-pixel width. Otherwise, cursor can't
24805 be displayed correctly. */
24806 glyph
->pixel_width
= 1;
24807 glyph
->padding_p
= 1;
24809 glyph
->ascent
= it
->ascent
;
24810 glyph
->descent
= it
->descent
;
24811 glyph
->voffset
= it
->voffset
;
24812 glyph
->type
= CHAR_GLYPH
;
24813 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24814 glyph
->multibyte_p
= it
->multibyte_p
;
24815 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24817 /* In R2L rows, the left and the right box edges need to be
24818 drawn in reverse direction. */
24819 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24820 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24824 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24825 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24827 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24828 || it
->phys_descent
> it
->descent
);
24829 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
24830 glyph
->face_id
= it
->face_id
;
24831 glyph
->u
.ch
= it
->char_to_display
;
24832 glyph
->slice
.img
= null_glyph_slice
;
24833 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24836 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24837 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24839 glyph
->bidi_type
= it
->bidi_it
.type
;
24843 glyph
->resolved_level
= 0;
24844 glyph
->bidi_type
= UNKNOWN_BT
;
24846 ++it
->glyph_row
->used
[area
];
24849 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24852 /* Store one glyph for the composition IT->cmp_it.id in
24853 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
24857 append_composite_glyph (struct it
*it
)
24859 struct glyph
*glyph
;
24860 enum glyph_row_area area
= it
->area
;
24862 eassert (it
->glyph_row
);
24864 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24865 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24867 /* If the glyph row is reversed, we need to prepend the glyph
24868 rather than append it. */
24869 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
24873 /* Make room for the new glyph. */
24874 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
24876 glyph
= it
->glyph_row
->glyphs
[it
->area
];
24878 glyph
->charpos
= it
->cmp_it
.charpos
;
24879 glyph
->object
= it
->object
;
24880 glyph
->pixel_width
= it
->pixel_width
;
24881 glyph
->ascent
= it
->ascent
;
24882 glyph
->descent
= it
->descent
;
24883 glyph
->voffset
= it
->voffset
;
24884 glyph
->type
= COMPOSITE_GLYPH
;
24885 if (it
->cmp_it
.ch
< 0)
24887 glyph
->u
.cmp
.automatic
= 0;
24888 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24889 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
24893 glyph
->u
.cmp
.automatic
= 1;
24894 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24895 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
24896 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
24898 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24899 glyph
->multibyte_p
= it
->multibyte_p
;
24900 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24902 /* In R2L rows, the left and the right box edges need to be
24903 drawn in reverse direction. */
24904 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24905 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24909 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24910 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24912 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24913 || it
->phys_descent
> it
->descent
);
24914 glyph
->padding_p
= 0;
24915 glyph
->glyph_not_available_p
= 0;
24916 glyph
->face_id
= it
->face_id
;
24917 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24920 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24921 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24923 glyph
->bidi_type
= it
->bidi_it
.type
;
24925 ++it
->glyph_row
->used
[area
];
24928 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24932 /* Change IT->ascent and IT->height according to the setting of
24936 take_vertical_position_into_account (struct it
*it
)
24940 if (it
->voffset
< 0)
24941 /* Increase the ascent so that we can display the text higher
24943 it
->ascent
-= it
->voffset
;
24945 /* Increase the descent so that we can display the text lower
24947 it
->descent
+= it
->voffset
;
24952 /* Produce glyphs/get display metrics for the image IT is loaded with.
24953 See the description of struct display_iterator in dispextern.h for
24954 an overview of struct display_iterator. */
24957 produce_image_glyph (struct it
*it
)
24961 int glyph_ascent
, crop
;
24962 struct glyph_slice slice
;
24964 eassert (it
->what
== IT_IMAGE
);
24966 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24968 /* Make sure X resources of the face is loaded. */
24969 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24971 if (it
->image_id
< 0)
24973 /* Fringe bitmap. */
24974 it
->ascent
= it
->phys_ascent
= 0;
24975 it
->descent
= it
->phys_descent
= 0;
24976 it
->pixel_width
= 0;
24981 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
24983 /* Make sure X resources of the image is loaded. */
24984 prepare_image_for_display (it
->f
, img
);
24986 slice
.x
= slice
.y
= 0;
24987 slice
.width
= img
->width
;
24988 slice
.height
= img
->height
;
24990 if (INTEGERP (it
->slice
.x
))
24991 slice
.x
= XINT (it
->slice
.x
);
24992 else if (FLOATP (it
->slice
.x
))
24993 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
24995 if (INTEGERP (it
->slice
.y
))
24996 slice
.y
= XINT (it
->slice
.y
);
24997 else if (FLOATP (it
->slice
.y
))
24998 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25000 if (INTEGERP (it
->slice
.width
))
25001 slice
.width
= XINT (it
->slice
.width
);
25002 else if (FLOATP (it
->slice
.width
))
25003 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25005 if (INTEGERP (it
->slice
.height
))
25006 slice
.height
= XINT (it
->slice
.height
);
25007 else if (FLOATP (it
->slice
.height
))
25008 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25010 if (slice
.x
>= img
->width
)
25011 slice
.x
= img
->width
;
25012 if (slice
.y
>= img
->height
)
25013 slice
.y
= img
->height
;
25014 if (slice
.x
+ slice
.width
>= img
->width
)
25015 slice
.width
= img
->width
- slice
.x
;
25016 if (slice
.y
+ slice
.height
> img
->height
)
25017 slice
.height
= img
->height
- slice
.y
;
25019 if (slice
.width
== 0 || slice
.height
== 0)
25022 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25024 it
->descent
= slice
.height
- glyph_ascent
;
25026 it
->descent
+= img
->vmargin
;
25027 if (slice
.y
+ slice
.height
== img
->height
)
25028 it
->descent
+= img
->vmargin
;
25029 it
->phys_descent
= it
->descent
;
25031 it
->pixel_width
= slice
.width
;
25033 it
->pixel_width
+= img
->hmargin
;
25034 if (slice
.x
+ slice
.width
== img
->width
)
25035 it
->pixel_width
+= img
->hmargin
;
25037 /* It's quite possible for images to have an ascent greater than
25038 their height, so don't get confused in that case. */
25039 if (it
->descent
< 0)
25044 if (face
->box
!= FACE_NO_BOX
)
25046 if (face
->box_line_width
> 0)
25049 it
->ascent
+= face
->box_line_width
;
25050 if (slice
.y
+ slice
.height
== img
->height
)
25051 it
->descent
+= face
->box_line_width
;
25054 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25055 it
->pixel_width
+= eabs (face
->box_line_width
);
25056 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25057 it
->pixel_width
+= eabs (face
->box_line_width
);
25060 take_vertical_position_into_account (it
);
25062 /* Automatically crop wide image glyphs at right edge so we can
25063 draw the cursor on same display row. */
25064 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25065 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25067 it
->pixel_width
-= crop
;
25068 slice
.width
-= crop
;
25073 struct glyph
*glyph
;
25074 enum glyph_row_area area
= it
->area
;
25076 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25077 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25079 glyph
->charpos
= CHARPOS (it
->position
);
25080 glyph
->object
= it
->object
;
25081 glyph
->pixel_width
= it
->pixel_width
;
25082 glyph
->ascent
= glyph_ascent
;
25083 glyph
->descent
= it
->descent
;
25084 glyph
->voffset
= it
->voffset
;
25085 glyph
->type
= IMAGE_GLYPH
;
25086 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25087 glyph
->multibyte_p
= it
->multibyte_p
;
25088 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25090 /* In R2L rows, the left and the right box edges need to be
25091 drawn in reverse direction. */
25092 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25093 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25097 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25098 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25100 glyph
->overlaps_vertically_p
= 0;
25101 glyph
->padding_p
= 0;
25102 glyph
->glyph_not_available_p
= 0;
25103 glyph
->face_id
= it
->face_id
;
25104 glyph
->u
.img_id
= img
->id
;
25105 glyph
->slice
.img
= slice
;
25106 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25109 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25110 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25112 glyph
->bidi_type
= it
->bidi_it
.type
;
25114 ++it
->glyph_row
->used
[area
];
25117 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25122 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25123 of the glyph, WIDTH and HEIGHT are the width and height of the
25124 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25127 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25128 int width
, int height
, int ascent
)
25130 struct glyph
*glyph
;
25131 enum glyph_row_area area
= it
->area
;
25133 eassert (ascent
>= 0 && ascent
<= height
);
25135 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25136 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25138 /* If the glyph row is reversed, we need to prepend the glyph
25139 rather than append it. */
25140 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25144 /* Make room for the additional glyph. */
25145 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25147 glyph
= it
->glyph_row
->glyphs
[area
];
25149 glyph
->charpos
= CHARPOS (it
->position
);
25150 glyph
->object
= object
;
25151 glyph
->pixel_width
= width
;
25152 glyph
->ascent
= ascent
;
25153 glyph
->descent
= height
- ascent
;
25154 glyph
->voffset
= it
->voffset
;
25155 glyph
->type
= STRETCH_GLYPH
;
25156 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25157 glyph
->multibyte_p
= it
->multibyte_p
;
25158 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25160 /* In R2L rows, the left and the right box edges need to be
25161 drawn in reverse direction. */
25162 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25163 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25167 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25168 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25170 glyph
->overlaps_vertically_p
= 0;
25171 glyph
->padding_p
= 0;
25172 glyph
->glyph_not_available_p
= 0;
25173 glyph
->face_id
= it
->face_id
;
25174 glyph
->u
.stretch
.ascent
= ascent
;
25175 glyph
->u
.stretch
.height
= height
;
25176 glyph
->slice
.img
= null_glyph_slice
;
25177 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25180 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25181 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25183 glyph
->bidi_type
= it
->bidi_it
.type
;
25187 glyph
->resolved_level
= 0;
25188 glyph
->bidi_type
= UNKNOWN_BT
;
25190 ++it
->glyph_row
->used
[area
];
25193 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25196 #endif /* HAVE_WINDOW_SYSTEM */
25198 /* Produce a stretch glyph for iterator IT. IT->object is the value
25199 of the glyph property displayed. The value must be a list
25200 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25203 1. `:width WIDTH' specifies that the space should be WIDTH *
25204 canonical char width wide. WIDTH may be an integer or floating
25207 2. `:relative-width FACTOR' specifies that the width of the stretch
25208 should be computed from the width of the first character having the
25209 `glyph' property, and should be FACTOR times that width.
25211 3. `:align-to HPOS' specifies that the space should be wide enough
25212 to reach HPOS, a value in canonical character units.
25214 Exactly one of the above pairs must be present.
25216 4. `:height HEIGHT' specifies that the height of the stretch produced
25217 should be HEIGHT, measured in canonical character units.
25219 5. `:relative-height FACTOR' specifies that the height of the
25220 stretch should be FACTOR times the height of the characters having
25221 the glyph property.
25223 Either none or exactly one of 4 or 5 must be present.
25225 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25226 of the stretch should be used for the ascent of the stretch.
25227 ASCENT must be in the range 0 <= ASCENT <= 100. */
25230 produce_stretch_glyph (struct it
*it
)
25232 /* (space :width WIDTH :height HEIGHT ...) */
25233 Lisp_Object prop
, plist
;
25234 int width
= 0, height
= 0, align_to
= -1;
25235 int zero_width_ok_p
= 0;
25237 struct font
*font
= NULL
;
25239 #ifdef HAVE_WINDOW_SYSTEM
25241 int zero_height_ok_p
= 0;
25243 if (FRAME_WINDOW_P (it
->f
))
25245 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25246 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25247 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25251 /* List should start with `space'. */
25252 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25253 plist
= XCDR (it
->object
);
25255 /* Compute the width of the stretch. */
25256 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25257 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25259 /* Absolute width `:width WIDTH' specified and valid. */
25260 zero_width_ok_p
= 1;
25263 #ifdef HAVE_WINDOW_SYSTEM
25264 else if (FRAME_WINDOW_P (it
->f
)
25265 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25267 /* Relative width `:relative-width FACTOR' specified and valid.
25268 Compute the width of the characters having the `glyph'
25271 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25274 if (it
->multibyte_p
)
25275 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25278 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25279 if (! ASCII_CHAR_P (it2
.c
))
25280 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25283 it2
.glyph_row
= NULL
;
25284 it2
.what
= IT_CHARACTER
;
25285 x_produce_glyphs (&it2
);
25286 width
= NUMVAL (prop
) * it2
.pixel_width
;
25288 #endif /* HAVE_WINDOW_SYSTEM */
25289 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25290 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25292 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25293 align_to
= (align_to
< 0
25295 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25296 else if (align_to
< 0)
25297 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25298 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25299 zero_width_ok_p
= 1;
25302 /* Nothing specified -> width defaults to canonical char width. */
25303 width
= FRAME_COLUMN_WIDTH (it
->f
);
25305 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25308 #ifdef HAVE_WINDOW_SYSTEM
25309 /* Compute height. */
25310 if (FRAME_WINDOW_P (it
->f
))
25312 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25313 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25316 zero_height_ok_p
= 1;
25318 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25320 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25322 height
= FONT_HEIGHT (font
);
25324 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25327 /* Compute percentage of height used for ascent. If
25328 `:ascent ASCENT' is present and valid, use that. Otherwise,
25329 derive the ascent from the font in use. */
25330 if (prop
= Fplist_get (plist
, QCascent
),
25331 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25332 ascent
= height
* NUMVAL (prop
) / 100.0;
25333 else if (!NILP (prop
)
25334 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25335 ascent
= min (max (0, (int)tem
), height
);
25337 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25340 #endif /* HAVE_WINDOW_SYSTEM */
25343 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25344 && it
->current_x
+ width
> it
->last_visible_x
)
25346 width
= it
->last_visible_x
- it
->current_x
;
25347 #ifdef HAVE_WINDOW_SYSTEM
25348 /* Subtract one more pixel from the stretch width, but only on
25349 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25350 width
-= FRAME_WINDOW_P (it
->f
);
25354 if (width
> 0 && height
> 0 && it
->glyph_row
)
25356 Lisp_Object o_object
= it
->object
;
25357 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25360 if (!STRINGP (object
))
25361 object
= it
->w
->contents
;
25362 #ifdef HAVE_WINDOW_SYSTEM
25363 if (FRAME_WINDOW_P (it
->f
))
25364 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25368 it
->object
= object
;
25369 it
->char_to_display
= ' ';
25370 it
->pixel_width
= it
->len
= 1;
25372 tty_append_glyph (it
);
25373 it
->object
= o_object
;
25377 it
->pixel_width
= width
;
25378 #ifdef HAVE_WINDOW_SYSTEM
25379 if (FRAME_WINDOW_P (it
->f
))
25381 it
->ascent
= it
->phys_ascent
= ascent
;
25382 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25383 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25384 take_vertical_position_into_account (it
);
25388 it
->nglyphs
= width
;
25391 /* Get information about special display element WHAT in an
25392 environment described by IT. WHAT is one of IT_TRUNCATION or
25393 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25394 non-null glyph_row member. This function ensures that fields like
25395 face_id, c, len of IT are left untouched. */
25398 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25405 temp_it
.object
= make_number (0);
25406 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25408 if (what
== IT_CONTINUATION
)
25410 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25411 if (it
->bidi_it
.paragraph_dir
== R2L
)
25412 SET_GLYPH_FROM_CHAR (glyph
, '/');
25414 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25416 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25418 /* FIXME: Should we mirror GC for R2L lines? */
25419 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25420 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25423 else if (what
== IT_TRUNCATION
)
25425 /* Truncation glyph. */
25426 SET_GLYPH_FROM_CHAR (glyph
, '$');
25428 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25430 /* FIXME: Should we mirror GC for R2L lines? */
25431 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25432 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25438 #ifdef HAVE_WINDOW_SYSTEM
25439 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25440 is turned off, we precede the truncation/continuation glyphs by a
25441 stretch glyph whose width is computed such that these special
25442 glyphs are aligned at the window margin, even when very different
25443 fonts are used in different glyph rows. */
25444 if (FRAME_WINDOW_P (temp_it
.f
)
25445 /* init_iterator calls this with it->glyph_row == NULL, and it
25446 wants only the pixel width of the truncation/continuation
25448 && temp_it
.glyph_row
25449 /* insert_left_trunc_glyphs calls us at the beginning of the
25450 row, and it has its own calculation of the stretch glyph
25452 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25453 && (temp_it
.glyph_row
->reversed_p
25454 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25455 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25457 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25459 if (stretch_width
> 0)
25461 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25462 struct font
*font
=
25463 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25464 int stretch_ascent
=
25465 (((temp_it
.ascent
+ temp_it
.descent
)
25466 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25468 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25469 temp_it
.ascent
+ temp_it
.descent
,
25476 temp_it
.what
= IT_CHARACTER
;
25478 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25479 temp_it
.face_id
= GLYPH_FACE (glyph
);
25480 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25482 PRODUCE_GLYPHS (&temp_it
);
25483 it
->pixel_width
= temp_it
.pixel_width
;
25484 it
->nglyphs
= temp_it
.pixel_width
;
25487 #ifdef HAVE_WINDOW_SYSTEM
25489 /* Calculate line-height and line-spacing properties.
25490 An integer value specifies explicit pixel value.
25491 A float value specifies relative value to current face height.
25492 A cons (float . face-name) specifies relative value to
25493 height of specified face font.
25495 Returns height in pixels, or nil. */
25499 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25500 int boff
, int override
)
25502 Lisp_Object face_name
= Qnil
;
25503 int ascent
, descent
, height
;
25505 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25510 face_name
= XCAR (val
);
25512 if (!NUMBERP (val
))
25513 val
= make_number (1);
25514 if (NILP (face_name
))
25516 height
= it
->ascent
+ it
->descent
;
25521 if (NILP (face_name
))
25523 font
= FRAME_FONT (it
->f
);
25524 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25526 else if (EQ (face_name
, Qt
))
25535 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25537 return make_number (-1);
25539 face
= FACE_FROM_ID (it
->f
, face_id
);
25542 return make_number (-1);
25543 boff
= font
->baseline_offset
;
25544 if (font
->vertical_centering
)
25545 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25548 ascent
= FONT_BASE (font
) + boff
;
25549 descent
= FONT_DESCENT (font
) - boff
;
25553 it
->override_ascent
= ascent
;
25554 it
->override_descent
= descent
;
25555 it
->override_boff
= boff
;
25558 height
= ascent
+ descent
;
25562 height
= (int)(XFLOAT_DATA (val
) * height
);
25563 else if (INTEGERP (val
))
25564 height
*= XINT (val
);
25566 return make_number (height
);
25570 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25571 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25572 and only if this is for a character for which no font was found.
25574 If the display method (it->glyphless_method) is
25575 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25576 length of the acronym or the hexadecimal string, UPPER_XOFF and
25577 UPPER_YOFF are pixel offsets for the upper part of the string,
25578 LOWER_XOFF and LOWER_YOFF are for the lower part.
25580 For the other display methods, LEN through LOWER_YOFF are zero. */
25583 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25584 short upper_xoff
, short upper_yoff
,
25585 short lower_xoff
, short lower_yoff
)
25587 struct glyph
*glyph
;
25588 enum glyph_row_area area
= it
->area
;
25590 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25591 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25593 /* If the glyph row is reversed, we need to prepend the glyph
25594 rather than append it. */
25595 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25599 /* Make room for the additional glyph. */
25600 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25602 glyph
= it
->glyph_row
->glyphs
[area
];
25604 glyph
->charpos
= CHARPOS (it
->position
);
25605 glyph
->object
= it
->object
;
25606 glyph
->pixel_width
= it
->pixel_width
;
25607 glyph
->ascent
= it
->ascent
;
25608 glyph
->descent
= it
->descent
;
25609 glyph
->voffset
= it
->voffset
;
25610 glyph
->type
= GLYPHLESS_GLYPH
;
25611 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25612 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25613 glyph
->u
.glyphless
.len
= len
;
25614 glyph
->u
.glyphless
.ch
= it
->c
;
25615 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25616 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25617 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25618 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25619 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25620 glyph
->multibyte_p
= it
->multibyte_p
;
25621 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25623 /* In R2L rows, the left and the right box edges need to be
25624 drawn in reverse direction. */
25625 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25626 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25630 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25631 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25633 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25634 || it
->phys_descent
> it
->descent
);
25635 glyph
->padding_p
= 0;
25636 glyph
->glyph_not_available_p
= 0;
25637 glyph
->face_id
= face_id
;
25638 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25641 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25642 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25644 glyph
->bidi_type
= it
->bidi_it
.type
;
25646 ++it
->glyph_row
->used
[area
];
25649 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25653 /* Produce a glyph for a glyphless character for iterator IT.
25654 IT->glyphless_method specifies which method to use for displaying
25655 the character. See the description of enum
25656 glyphless_display_method in dispextern.h for the detail.
25658 FOR_NO_FONT is nonzero if and only if this is for a character for
25659 which no font was found. ACRONYM, if non-nil, is an acronym string
25660 for the character. */
25663 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25668 int base_width
, base_height
, width
, height
;
25669 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
25672 /* Get the metrics of the base font. We always refer to the current
25674 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
25675 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25676 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
25677 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
25678 base_height
= it
->ascent
+ it
->descent
;
25679 base_width
= font
->average_width
;
25681 face_id
= merge_glyphless_glyph_face (it
);
25683 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
25685 it
->pixel_width
= THIN_SPACE_WIDTH
;
25687 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25689 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
25691 width
= CHAR_WIDTH (it
->c
);
25694 else if (width
> 4)
25696 it
->pixel_width
= base_width
* width
;
25698 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25704 unsigned int code
[6];
25706 int ascent
, descent
;
25707 struct font_metrics metrics_upper
, metrics_lower
;
25709 face
= FACE_FROM_ID (it
->f
, face_id
);
25710 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25711 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25713 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
25715 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
25716 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
25717 if (CONSP (acronym
))
25718 acronym
= XCAR (acronym
);
25719 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
25723 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
25724 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
25727 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
25728 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
25729 upper_len
= (len
+ 1) / 2;
25730 font
->driver
->text_extents (font
, code
, upper_len
,
25732 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
25737 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
25738 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
25739 upper_xoff
= upper_yoff
= 2; /* the typical case */
25740 if (base_width
>= width
)
25742 /* Align the upper to the left, the lower to the right. */
25743 it
->pixel_width
= base_width
;
25744 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
25748 /* Center the shorter one. */
25749 it
->pixel_width
= width
;
25750 if (metrics_upper
.width
>= metrics_lower
.width
)
25751 lower_xoff
= (width
- metrics_lower
.width
) / 2;
25754 /* FIXME: This code doesn't look right. It formerly was
25755 missing the "lower_xoff = 0;", which couldn't have
25756 been right since it left lower_xoff uninitialized. */
25758 upper_xoff
= (width
- metrics_upper
.width
) / 2;
25762 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
25763 top, bottom, and between upper and lower strings. */
25764 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
25765 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
25766 /* Center vertically.
25767 H:base_height, D:base_descent
25768 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
25770 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
25771 descent = D - H/2 + h/2;
25772 lower_yoff = descent - 2 - ld;
25773 upper_yoff = lower_yoff - la - 1 - ud; */
25774 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
25775 descent
= it
->descent
- (base_height
- height
) / 2;
25776 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
25777 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
25778 - metrics_upper
.descent
);
25779 /* Don't make the height shorter than the base height. */
25780 if (height
> base_height
)
25782 it
->ascent
= ascent
;
25783 it
->descent
= descent
;
25787 it
->phys_ascent
= it
->ascent
;
25788 it
->phys_descent
= it
->descent
;
25790 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
25791 upper_xoff
, upper_yoff
,
25792 lower_xoff
, lower_yoff
);
25794 take_vertical_position_into_account (it
);
25799 Produce glyphs/get display metrics for the display element IT is
25800 loaded with. See the description of struct it in dispextern.h
25801 for an overview of struct it. */
25804 x_produce_glyphs (struct it
*it
)
25806 int extra_line_spacing
= it
->extra_line_spacing
;
25808 it
->glyph_not_available_p
= 0;
25810 if (it
->what
== IT_CHARACTER
)
25813 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25814 struct font
*font
= face
->font
;
25815 struct font_metrics
*pcm
= NULL
;
25816 int boff
; /* Baseline offset. */
25820 /* When no suitable font is found, display this character by
25821 the method specified in the first extra slot of
25822 Vglyphless_char_display. */
25823 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
25825 eassert (it
->what
== IT_GLYPHLESS
);
25826 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
25830 boff
= font
->baseline_offset
;
25831 if (font
->vertical_centering
)
25832 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25834 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
25840 if (it
->override_ascent
>= 0)
25842 it
->ascent
= it
->override_ascent
;
25843 it
->descent
= it
->override_descent
;
25844 boff
= it
->override_boff
;
25848 it
->ascent
= FONT_BASE (font
) + boff
;
25849 it
->descent
= FONT_DESCENT (font
) - boff
;
25852 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
25854 pcm
= get_per_char_metric (font
, &char2b
);
25855 if (pcm
->width
== 0
25856 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
25862 it
->phys_ascent
= pcm
->ascent
+ boff
;
25863 it
->phys_descent
= pcm
->descent
- boff
;
25864 it
->pixel_width
= pcm
->width
;
25868 it
->glyph_not_available_p
= 1;
25869 it
->phys_ascent
= it
->ascent
;
25870 it
->phys_descent
= it
->descent
;
25871 it
->pixel_width
= font
->space_width
;
25874 if (it
->constrain_row_ascent_descent_p
)
25876 if (it
->descent
> it
->max_descent
)
25878 it
->ascent
+= it
->descent
- it
->max_descent
;
25879 it
->descent
= it
->max_descent
;
25881 if (it
->ascent
> it
->max_ascent
)
25883 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25884 it
->ascent
= it
->max_ascent
;
25886 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25887 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25888 extra_line_spacing
= 0;
25891 /* If this is a space inside a region of text with
25892 `space-width' property, change its width. */
25893 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
25895 it
->pixel_width
*= XFLOATINT (it
->space_width
);
25897 /* If face has a box, add the box thickness to the character
25898 height. If character has a box line to the left and/or
25899 right, add the box line width to the character's width. */
25900 if (face
->box
!= FACE_NO_BOX
)
25902 int thick
= face
->box_line_width
;
25906 it
->ascent
+= thick
;
25907 it
->descent
+= thick
;
25912 if (it
->start_of_box_run_p
)
25913 it
->pixel_width
+= thick
;
25914 if (it
->end_of_box_run_p
)
25915 it
->pixel_width
+= thick
;
25918 /* If face has an overline, add the height of the overline
25919 (1 pixel) and a 1 pixel margin to the character height. */
25920 if (face
->overline_p
)
25921 it
->ascent
+= overline_margin
;
25923 if (it
->constrain_row_ascent_descent_p
)
25925 if (it
->ascent
> it
->max_ascent
)
25926 it
->ascent
= it
->max_ascent
;
25927 if (it
->descent
> it
->max_descent
)
25928 it
->descent
= it
->max_descent
;
25931 take_vertical_position_into_account (it
);
25933 /* If we have to actually produce glyphs, do it. */
25938 /* Translate a space with a `space-width' property
25939 into a stretch glyph. */
25940 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
25941 / FONT_HEIGHT (font
));
25942 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
25943 it
->ascent
+ it
->descent
, ascent
);
25948 /* If characters with lbearing or rbearing are displayed
25949 in this line, record that fact in a flag of the
25950 glyph row. This is used to optimize X output code. */
25951 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
25952 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25954 if (! stretched_p
&& it
->pixel_width
== 0)
25955 /* We assure that all visible glyphs have at least 1-pixel
25957 it
->pixel_width
= 1;
25959 else if (it
->char_to_display
== '\n')
25961 /* A newline has no width, but we need the height of the
25962 line. But if previous part of the line sets a height,
25963 don't increase that height. */
25965 Lisp_Object height
;
25966 Lisp_Object total_height
= Qnil
;
25968 it
->override_ascent
= -1;
25969 it
->pixel_width
= 0;
25972 height
= get_it_property (it
, Qline_height
);
25973 /* Split (line-height total-height) list. */
25975 && CONSP (XCDR (height
))
25976 && NILP (XCDR (XCDR (height
))))
25978 total_height
= XCAR (XCDR (height
));
25979 height
= XCAR (height
);
25981 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
25983 if (it
->override_ascent
>= 0)
25985 it
->ascent
= it
->override_ascent
;
25986 it
->descent
= it
->override_descent
;
25987 boff
= it
->override_boff
;
25991 it
->ascent
= FONT_BASE (font
) + boff
;
25992 it
->descent
= FONT_DESCENT (font
) - boff
;
25995 if (EQ (height
, Qt
))
25997 if (it
->descent
> it
->max_descent
)
25999 it
->ascent
+= it
->descent
- it
->max_descent
;
26000 it
->descent
= it
->max_descent
;
26002 if (it
->ascent
> it
->max_ascent
)
26004 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26005 it
->ascent
= it
->max_ascent
;
26007 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26008 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26009 it
->constrain_row_ascent_descent_p
= 1;
26010 extra_line_spacing
= 0;
26014 Lisp_Object spacing
;
26016 it
->phys_ascent
= it
->ascent
;
26017 it
->phys_descent
= it
->descent
;
26019 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26020 && face
->box
!= FACE_NO_BOX
26021 && face
->box_line_width
> 0)
26023 it
->ascent
+= face
->box_line_width
;
26024 it
->descent
+= face
->box_line_width
;
26027 && XINT (height
) > it
->ascent
+ it
->descent
)
26028 it
->ascent
= XINT (height
) - it
->descent
;
26030 if (!NILP (total_height
))
26031 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26034 spacing
= get_it_property (it
, Qline_spacing
);
26035 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26037 if (INTEGERP (spacing
))
26039 extra_line_spacing
= XINT (spacing
);
26040 if (!NILP (total_height
))
26041 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26045 else /* i.e. (it->char_to_display == '\t') */
26047 if (font
->space_width
> 0)
26049 int tab_width
= it
->tab_width
* font
->space_width
;
26050 int x
= it
->current_x
+ it
->continuation_lines_width
;
26051 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26053 /* If the distance from the current position to the next tab
26054 stop is less than a space character width, use the
26055 tab stop after that. */
26056 if (next_tab_x
- x
< font
->space_width
)
26057 next_tab_x
+= tab_width
;
26059 it
->pixel_width
= next_tab_x
- x
;
26061 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26062 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26066 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26067 it
->ascent
+ it
->descent
, it
->ascent
);
26072 it
->pixel_width
= 0;
26077 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26079 /* A static composition.
26081 Note: A composition is represented as one glyph in the
26082 glyph matrix. There are no padding glyphs.
26084 Important note: pixel_width, ascent, and descent are the
26085 values of what is drawn by draw_glyphs (i.e. the values of
26086 the overall glyphs composed). */
26087 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26088 int boff
; /* baseline offset */
26089 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26090 int glyph_len
= cmp
->glyph_len
;
26091 struct font
*font
= face
->font
;
26095 /* If we have not yet calculated pixel size data of glyphs of
26096 the composition for the current face font, calculate them
26097 now. Theoretically, we have to check all fonts for the
26098 glyphs, but that requires much time and memory space. So,
26099 here we check only the font of the first glyph. This may
26100 lead to incorrect display, but it's very rare, and C-l
26101 (recenter-top-bottom) can correct the display anyway. */
26102 if (! cmp
->font
|| cmp
->font
!= font
)
26104 /* Ascent and descent of the font of the first character
26105 of this composition (adjusted by baseline offset).
26106 Ascent and descent of overall glyphs should not be less
26107 than these, respectively. */
26108 int font_ascent
, font_descent
, font_height
;
26109 /* Bounding box of the overall glyphs. */
26110 int leftmost
, rightmost
, lowest
, highest
;
26111 int lbearing
, rbearing
;
26112 int i
, width
, ascent
, descent
;
26113 int left_padded
= 0, right_padded
= 0;
26114 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26116 struct font_metrics
*pcm
;
26117 int font_not_found_p
;
26120 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26121 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26123 if (glyph_len
< cmp
->glyph_len
)
26125 for (i
= 0; i
< glyph_len
; i
++)
26127 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26129 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26134 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26135 : IT_CHARPOS (*it
));
26136 /* If no suitable font is found, use the default font. */
26137 font_not_found_p
= font
== NULL
;
26138 if (font_not_found_p
)
26140 face
= face
->ascii_face
;
26143 boff
= font
->baseline_offset
;
26144 if (font
->vertical_centering
)
26145 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26146 font_ascent
= FONT_BASE (font
) + boff
;
26147 font_descent
= FONT_DESCENT (font
) - boff
;
26148 font_height
= FONT_HEIGHT (font
);
26153 if (! font_not_found_p
)
26155 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26157 pcm
= get_per_char_metric (font
, &char2b
);
26160 /* Initialize the bounding box. */
26163 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26164 ascent
= pcm
->ascent
;
26165 descent
= pcm
->descent
;
26166 lbearing
= pcm
->lbearing
;
26167 rbearing
= pcm
->rbearing
;
26171 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26172 ascent
= FONT_BASE (font
);
26173 descent
= FONT_DESCENT (font
);
26180 lowest
= - descent
+ boff
;
26181 highest
= ascent
+ boff
;
26183 if (! font_not_found_p
26184 && font
->default_ascent
26185 && CHAR_TABLE_P (Vuse_default_ascent
)
26186 && !NILP (Faref (Vuse_default_ascent
,
26187 make_number (it
->char_to_display
))))
26188 highest
= font
->default_ascent
+ boff
;
26190 /* Draw the first glyph at the normal position. It may be
26191 shifted to right later if some other glyphs are drawn
26193 cmp
->offsets
[i
* 2] = 0;
26194 cmp
->offsets
[i
* 2 + 1] = boff
;
26195 cmp
->lbearing
= lbearing
;
26196 cmp
->rbearing
= rbearing
;
26198 /* Set cmp->offsets for the remaining glyphs. */
26199 for (i
++; i
< glyph_len
; i
++)
26201 int left
, right
, btm
, top
;
26202 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26204 struct face
*this_face
;
26208 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26209 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26210 font
= this_face
->font
;
26216 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26218 pcm
= get_per_char_metric (font
, &char2b
);
26221 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26224 width
= pcm
->width
;
26225 ascent
= pcm
->ascent
;
26226 descent
= pcm
->descent
;
26227 lbearing
= pcm
->lbearing
;
26228 rbearing
= pcm
->rbearing
;
26229 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26231 /* Relative composition with or without
26232 alternate chars. */
26233 left
= (leftmost
+ rightmost
- width
) / 2;
26234 btm
= - descent
+ boff
;
26235 if (font
->relative_compose
26236 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26237 || NILP (Faref (Vignore_relative_composition
,
26238 make_number (ch
)))))
26241 if (- descent
>= font
->relative_compose
)
26242 /* One extra pixel between two glyphs. */
26244 else if (ascent
<= 0)
26245 /* One extra pixel between two glyphs. */
26246 btm
= lowest
- 1 - ascent
- descent
;
26251 /* A composition rule is specified by an integer
26252 value that encodes global and new reference
26253 points (GREF and NREF). GREF and NREF are
26254 specified by numbers as below:
26256 0---1---2 -- ascent
26260 9--10--11 -- center
26262 ---3---4---5--- baseline
26264 6---7---8 -- descent
26266 int rule
= COMPOSITION_RULE (cmp
, i
);
26267 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26269 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26270 grefx
= gref
% 3, nrefx
= nref
% 3;
26271 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26273 xoff
= font_height
* (xoff
- 128) / 256;
26275 yoff
= font_height
* (yoff
- 128) / 256;
26278 + grefx
* (rightmost
- leftmost
) / 2
26279 - nrefx
* width
/ 2
26282 btm
= ((grefy
== 0 ? highest
26284 : grefy
== 2 ? lowest
26285 : (highest
+ lowest
) / 2)
26286 - (nrefy
== 0 ? ascent
+ descent
26287 : nrefy
== 1 ? descent
- boff
26289 : (ascent
+ descent
) / 2)
26293 cmp
->offsets
[i
* 2] = left
;
26294 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26296 /* Update the bounding box of the overall glyphs. */
26299 right
= left
+ width
;
26300 if (left
< leftmost
)
26302 if (right
> rightmost
)
26305 top
= btm
+ descent
+ ascent
;
26311 if (cmp
->lbearing
> left
+ lbearing
)
26312 cmp
->lbearing
= left
+ lbearing
;
26313 if (cmp
->rbearing
< left
+ rbearing
)
26314 cmp
->rbearing
= left
+ rbearing
;
26318 /* If there are glyphs whose x-offsets are negative,
26319 shift all glyphs to the right and make all x-offsets
26323 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26324 cmp
->offsets
[i
* 2] -= leftmost
;
26325 rightmost
-= leftmost
;
26326 cmp
->lbearing
-= leftmost
;
26327 cmp
->rbearing
-= leftmost
;
26330 if (left_padded
&& cmp
->lbearing
< 0)
26332 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26333 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26334 rightmost
-= cmp
->lbearing
;
26335 cmp
->rbearing
-= cmp
->lbearing
;
26338 if (right_padded
&& rightmost
< cmp
->rbearing
)
26340 rightmost
= cmp
->rbearing
;
26343 cmp
->pixel_width
= rightmost
;
26344 cmp
->ascent
= highest
;
26345 cmp
->descent
= - lowest
;
26346 if (cmp
->ascent
< font_ascent
)
26347 cmp
->ascent
= font_ascent
;
26348 if (cmp
->descent
< font_descent
)
26349 cmp
->descent
= font_descent
;
26353 && (cmp
->lbearing
< 0
26354 || cmp
->rbearing
> cmp
->pixel_width
))
26355 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26357 it
->pixel_width
= cmp
->pixel_width
;
26358 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26359 it
->descent
= it
->phys_descent
= cmp
->descent
;
26360 if (face
->box
!= FACE_NO_BOX
)
26362 int thick
= face
->box_line_width
;
26366 it
->ascent
+= thick
;
26367 it
->descent
+= thick
;
26372 if (it
->start_of_box_run_p
)
26373 it
->pixel_width
+= thick
;
26374 if (it
->end_of_box_run_p
)
26375 it
->pixel_width
+= thick
;
26378 /* If face has an overline, add the height of the overline
26379 (1 pixel) and a 1 pixel margin to the character height. */
26380 if (face
->overline_p
)
26381 it
->ascent
+= overline_margin
;
26383 take_vertical_position_into_account (it
);
26384 if (it
->ascent
< 0)
26386 if (it
->descent
< 0)
26389 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26390 append_composite_glyph (it
);
26392 else if (it
->what
== IT_COMPOSITION
)
26394 /* A dynamic (automatic) composition. */
26395 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26396 Lisp_Object gstring
;
26397 struct font_metrics metrics
;
26401 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26403 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26406 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26407 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26408 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26409 it
->descent
= it
->phys_descent
= metrics
.descent
;
26410 if (face
->box
!= FACE_NO_BOX
)
26412 int thick
= face
->box_line_width
;
26416 it
->ascent
+= thick
;
26417 it
->descent
+= thick
;
26422 if (it
->start_of_box_run_p
)
26423 it
->pixel_width
+= thick
;
26424 if (it
->end_of_box_run_p
)
26425 it
->pixel_width
+= thick
;
26427 /* If face has an overline, add the height of the overline
26428 (1 pixel) and a 1 pixel margin to the character height. */
26429 if (face
->overline_p
)
26430 it
->ascent
+= overline_margin
;
26431 take_vertical_position_into_account (it
);
26432 if (it
->ascent
< 0)
26434 if (it
->descent
< 0)
26438 append_composite_glyph (it
);
26440 else if (it
->what
== IT_GLYPHLESS
)
26441 produce_glyphless_glyph (it
, 0, Qnil
);
26442 else if (it
->what
== IT_IMAGE
)
26443 produce_image_glyph (it
);
26444 else if (it
->what
== IT_STRETCH
)
26445 produce_stretch_glyph (it
);
26448 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26449 because this isn't true for images with `:ascent 100'. */
26450 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26451 if (it
->area
== TEXT_AREA
)
26452 it
->current_x
+= it
->pixel_width
;
26454 if (extra_line_spacing
> 0)
26456 it
->descent
+= extra_line_spacing
;
26457 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26458 it
->max_extra_line_spacing
= extra_line_spacing
;
26461 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26462 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26463 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26464 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26468 Output LEN glyphs starting at START at the nominal cursor position.
26469 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26470 being updated, and UPDATED_AREA is the area of that row being updated. */
26473 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26474 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26476 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26478 eassert (updated_row
);
26479 /* When the window is hscrolled, cursor hpos can legitimately be out
26480 of bounds, but we draw the cursor at the corresponding window
26481 margin in that case. */
26482 if (!updated_row
->reversed_p
&& chpos
< 0)
26484 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26485 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26489 /* Write glyphs. */
26491 hpos
= start
- updated_row
->glyphs
[updated_area
];
26492 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26493 updated_row
, updated_area
,
26495 DRAW_NORMAL_TEXT
, 0);
26497 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26498 if (updated_area
== TEXT_AREA
26499 && w
->phys_cursor_on_p
26500 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26502 && chpos
< hpos
+ len
)
26503 w
->phys_cursor_on_p
= 0;
26507 /* Advance the output cursor. */
26508 w
->output_cursor
.hpos
+= len
;
26509 w
->output_cursor
.x
= x
;
26514 Insert LEN glyphs from START at the nominal cursor position. */
26517 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26518 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26521 int line_height
, shift_by_width
, shifted_region_width
;
26522 struct glyph_row
*row
;
26523 struct glyph
*glyph
;
26524 int frame_x
, frame_y
;
26527 eassert (updated_row
);
26529 f
= XFRAME (WINDOW_FRAME (w
));
26531 /* Get the height of the line we are in. */
26533 line_height
= row
->height
;
26535 /* Get the width of the glyphs to insert. */
26536 shift_by_width
= 0;
26537 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26538 shift_by_width
+= glyph
->pixel_width
;
26540 /* Get the width of the region to shift right. */
26541 shifted_region_width
= (window_box_width (w
, updated_area
)
26542 - w
->output_cursor
.x
26546 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26547 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26549 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26550 line_height
, shift_by_width
);
26552 /* Write the glyphs. */
26553 hpos
= start
- row
->glyphs
[updated_area
];
26554 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26556 DRAW_NORMAL_TEXT
, 0);
26558 /* Advance the output cursor. */
26559 w
->output_cursor
.hpos
+= len
;
26560 w
->output_cursor
.x
+= shift_by_width
;
26566 Erase the current text line from the nominal cursor position
26567 (inclusive) to pixel column TO_X (exclusive). The idea is that
26568 everything from TO_X onward is already erased.
26570 TO_X is a pixel position relative to UPDATED_AREA of currently
26571 updated window W. TO_X == -1 means clear to the end of this area. */
26574 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26575 enum glyph_row_area updated_area
, int to_x
)
26578 int max_x
, min_y
, max_y
;
26579 int from_x
, from_y
, to_y
;
26581 eassert (updated_row
);
26582 f
= XFRAME (w
->frame
);
26584 if (updated_row
->full_width_p
)
26585 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26586 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26588 max_x
= window_box_width (w
, updated_area
);
26589 max_y
= window_text_bottom_y (w
);
26591 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26592 of window. For TO_X > 0, truncate to end of drawing area. */
26598 to_x
= min (to_x
, max_x
);
26600 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26602 /* Notice if the cursor will be cleared by this operation. */
26603 if (!updated_row
->full_width_p
)
26604 notice_overwritten_cursor (w
, updated_area
,
26605 w
->output_cursor
.x
, -1,
26607 MATRIX_ROW_BOTTOM_Y (updated_row
));
26609 from_x
= w
->output_cursor
.x
;
26611 /* Translate to frame coordinates. */
26612 if (updated_row
->full_width_p
)
26614 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26615 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26619 int area_left
= window_box_left (w
, updated_area
);
26620 from_x
+= area_left
;
26624 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26625 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26626 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26628 /* Prevent inadvertently clearing to end of the X window. */
26629 if (to_x
> from_x
&& to_y
> from_y
)
26632 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26633 to_x
- from_x
, to_y
- from_y
);
26638 #endif /* HAVE_WINDOW_SYSTEM */
26642 /***********************************************************************
26644 ***********************************************************************/
26646 /* Value is the internal representation of the specified cursor type
26647 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26648 of the bar cursor. */
26650 static enum text_cursor_kinds
26651 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26653 enum text_cursor_kinds type
;
26658 if (EQ (arg
, Qbox
))
26659 return FILLED_BOX_CURSOR
;
26661 if (EQ (arg
, Qhollow
))
26662 return HOLLOW_BOX_CURSOR
;
26664 if (EQ (arg
, Qbar
))
26671 && EQ (XCAR (arg
), Qbar
)
26672 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26674 *width
= XINT (XCDR (arg
));
26678 if (EQ (arg
, Qhbar
))
26681 return HBAR_CURSOR
;
26685 && EQ (XCAR (arg
), Qhbar
)
26686 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26688 *width
= XINT (XCDR (arg
));
26689 return HBAR_CURSOR
;
26692 /* Treat anything unknown as "hollow box cursor".
26693 It was bad to signal an error; people have trouble fixing
26694 .Xdefaults with Emacs, when it has something bad in it. */
26695 type
= HOLLOW_BOX_CURSOR
;
26700 /* Set the default cursor types for specified frame. */
26702 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
26707 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
26708 FRAME_CURSOR_WIDTH (f
) = width
;
26710 /* By default, set up the blink-off state depending on the on-state. */
26712 tem
= Fassoc (arg
, Vblink_cursor_alist
);
26715 FRAME_BLINK_OFF_CURSOR (f
)
26716 = get_specified_cursor_type (XCDR (tem
), &width
);
26717 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
26720 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
26722 /* Make sure the cursor gets redrawn. */
26723 f
->cursor_type_changed
= 1;
26727 #ifdef HAVE_WINDOW_SYSTEM
26729 /* Return the cursor we want to be displayed in window W. Return
26730 width of bar/hbar cursor through WIDTH arg. Return with
26731 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
26732 (i.e. if the `system caret' should track this cursor).
26734 In a mini-buffer window, we want the cursor only to appear if we
26735 are reading input from this window. For the selected window, we
26736 want the cursor type given by the frame parameter or buffer local
26737 setting of cursor-type. If explicitly marked off, draw no cursor.
26738 In all other cases, we want a hollow box cursor. */
26740 static enum text_cursor_kinds
26741 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
26742 int *active_cursor
)
26744 struct frame
*f
= XFRAME (w
->frame
);
26745 struct buffer
*b
= XBUFFER (w
->contents
);
26746 int cursor_type
= DEFAULT_CURSOR
;
26747 Lisp_Object alt_cursor
;
26748 int non_selected
= 0;
26750 *active_cursor
= 1;
26753 if (cursor_in_echo_area
26754 && FRAME_HAS_MINIBUF_P (f
)
26755 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
26757 if (w
== XWINDOW (echo_area_window
))
26759 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
26761 *width
= FRAME_CURSOR_WIDTH (f
);
26762 return FRAME_DESIRED_CURSOR (f
);
26765 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26768 *active_cursor
= 0;
26772 /* Detect a nonselected window or nonselected frame. */
26773 else if (w
!= XWINDOW (f
->selected_window
)
26774 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
26776 *active_cursor
= 0;
26778 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
26784 /* Never display a cursor in a window in which cursor-type is nil. */
26785 if (NILP (BVAR (b
, cursor_type
)))
26788 /* Get the normal cursor type for this window. */
26789 if (EQ (BVAR (b
, cursor_type
), Qt
))
26791 cursor_type
= FRAME_DESIRED_CURSOR (f
);
26792 *width
= FRAME_CURSOR_WIDTH (f
);
26795 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26797 /* Use cursor-in-non-selected-windows instead
26798 for non-selected window or frame. */
26801 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
26802 if (!EQ (Qt
, alt_cursor
))
26803 return get_specified_cursor_type (alt_cursor
, width
);
26804 /* t means modify the normal cursor type. */
26805 if (cursor_type
== FILLED_BOX_CURSOR
)
26806 cursor_type
= HOLLOW_BOX_CURSOR
;
26807 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
26809 return cursor_type
;
26812 /* Use normal cursor if not blinked off. */
26813 if (!w
->cursor_off_p
)
26815 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26817 if (cursor_type
== FILLED_BOX_CURSOR
)
26819 /* Using a block cursor on large images can be very annoying.
26820 So use a hollow cursor for "large" images.
26821 If image is not transparent (no mask), also use hollow cursor. */
26822 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26823 if (img
!= NULL
&& IMAGEP (img
->spec
))
26825 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
26826 where N = size of default frame font size.
26827 This should cover most of the "tiny" icons people may use. */
26829 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
26830 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
26831 cursor_type
= HOLLOW_BOX_CURSOR
;
26834 else if (cursor_type
!= NO_CURSOR
)
26836 /* Display current only supports BOX and HOLLOW cursors for images.
26837 So for now, unconditionally use a HOLLOW cursor when cursor is
26838 not a solid box cursor. */
26839 cursor_type
= HOLLOW_BOX_CURSOR
;
26842 return cursor_type
;
26845 /* Cursor is blinked off, so determine how to "toggle" it. */
26847 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
26848 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
26849 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
26851 /* Then see if frame has specified a specific blink off cursor type. */
26852 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
26854 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
26855 return FRAME_BLINK_OFF_CURSOR (f
);
26859 /* Some people liked having a permanently visible blinking cursor,
26860 while others had very strong opinions against it. So it was
26861 decided to remove it. KFS 2003-09-03 */
26863 /* Finally perform built-in cursor blinking:
26864 filled box <-> hollow box
26865 wide [h]bar <-> narrow [h]bar
26866 narrow [h]bar <-> no cursor
26867 other type <-> no cursor */
26869 if (cursor_type
== FILLED_BOX_CURSOR
)
26870 return HOLLOW_BOX_CURSOR
;
26872 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
26875 return cursor_type
;
26883 /* Notice when the text cursor of window W has been completely
26884 overwritten by a drawing operation that outputs glyphs in AREA
26885 starting at X0 and ending at X1 in the line starting at Y0 and
26886 ending at Y1. X coordinates are area-relative. X1 < 0 means all
26887 the rest of the line after X0 has been written. Y coordinates
26888 are window-relative. */
26891 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
26892 int x0
, int x1
, int y0
, int y1
)
26894 int cx0
, cx1
, cy0
, cy1
;
26895 struct glyph_row
*row
;
26897 if (!w
->phys_cursor_on_p
)
26899 if (area
!= TEXT_AREA
)
26902 if (w
->phys_cursor
.vpos
< 0
26903 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
26904 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
26905 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
26908 if (row
->cursor_in_fringe_p
)
26910 row
->cursor_in_fringe_p
= 0;
26911 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
26912 w
->phys_cursor_on_p
= 0;
26916 cx0
= w
->phys_cursor
.x
;
26917 cx1
= cx0
+ w
->phys_cursor_width
;
26918 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
26921 /* The cursor image will be completely removed from the
26922 screen if the output area intersects the cursor area in
26923 y-direction. When we draw in [y0 y1[, and some part of
26924 the cursor is at y < y0, that part must have been drawn
26925 before. When scrolling, the cursor is erased before
26926 actually scrolling, so we don't come here. When not
26927 scrolling, the rows above the old cursor row must have
26928 changed, and in this case these rows must have written
26929 over the cursor image.
26931 Likewise if part of the cursor is below y1, with the
26932 exception of the cursor being in the first blank row at
26933 the buffer and window end because update_text_area
26934 doesn't draw that row. (Except when it does, but
26935 that's handled in update_text_area.) */
26937 cy0
= w
->phys_cursor
.y
;
26938 cy1
= cy0
+ w
->phys_cursor_height
;
26939 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
26942 w
->phys_cursor_on_p
= 0;
26945 #endif /* HAVE_WINDOW_SYSTEM */
26948 /************************************************************************
26950 ************************************************************************/
26952 #ifdef HAVE_WINDOW_SYSTEM
26955 Fix the display of area AREA of overlapping row ROW in window W
26956 with respect to the overlapping part OVERLAPS. */
26959 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
26960 enum glyph_row_area area
, int overlaps
)
26967 for (i
= 0; i
< row
->used
[area
];)
26969 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
26971 int start
= i
, start_x
= x
;
26975 x
+= row
->glyphs
[area
][i
].pixel_width
;
26978 while (i
< row
->used
[area
]
26979 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
26981 draw_glyphs (w
, start_x
, row
, area
,
26983 DRAW_NORMAL_TEXT
, overlaps
);
26987 x
+= row
->glyphs
[area
][i
].pixel_width
;
26997 Draw the cursor glyph of window W in glyph row ROW. See the
26998 comment of draw_glyphs for the meaning of HL. */
27001 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27002 enum draw_glyphs_face hl
)
27004 /* If cursor hpos is out of bounds, don't draw garbage. This can
27005 happen in mini-buffer windows when switching between echo area
27006 glyphs and mini-buffer. */
27007 if ((row
->reversed_p
27008 ? (w
->phys_cursor
.hpos
>= 0)
27009 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27011 int on_p
= w
->phys_cursor_on_p
;
27013 int hpos
= w
->phys_cursor
.hpos
;
27015 /* When the window is hscrolled, cursor hpos can legitimately be
27016 out of bounds, but we draw the cursor at the corresponding
27017 window margin in that case. */
27018 if (!row
->reversed_p
&& hpos
< 0)
27020 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27021 hpos
= row
->used
[TEXT_AREA
] - 1;
27023 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27025 w
->phys_cursor_on_p
= on_p
;
27027 if (hl
== DRAW_CURSOR
)
27028 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27029 /* When we erase the cursor, and ROW is overlapped by other
27030 rows, make sure that these overlapping parts of other rows
27032 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27034 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27036 if (row
> w
->current_matrix
->rows
27037 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27038 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27039 OVERLAPS_ERASED_CURSOR
);
27041 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27042 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27043 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27044 OVERLAPS_ERASED_CURSOR
);
27050 /* Erase the image of a cursor of window W from the screen. */
27056 erase_phys_cursor (struct window
*w
)
27058 struct frame
*f
= XFRAME (w
->frame
);
27059 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27060 int hpos
= w
->phys_cursor
.hpos
;
27061 int vpos
= w
->phys_cursor
.vpos
;
27062 int mouse_face_here_p
= 0;
27063 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27064 struct glyph_row
*cursor_row
;
27065 struct glyph
*cursor_glyph
;
27066 enum draw_glyphs_face hl
;
27068 /* No cursor displayed or row invalidated => nothing to do on the
27070 if (w
->phys_cursor_type
== NO_CURSOR
)
27071 goto mark_cursor_off
;
27073 /* VPOS >= active_glyphs->nrows means that window has been resized.
27074 Don't bother to erase the cursor. */
27075 if (vpos
>= active_glyphs
->nrows
)
27076 goto mark_cursor_off
;
27078 /* If row containing cursor is marked invalid, there is nothing we
27080 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27081 if (!cursor_row
->enabled_p
)
27082 goto mark_cursor_off
;
27084 /* If line spacing is > 0, old cursor may only be partially visible in
27085 window after split-window. So adjust visible height. */
27086 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27087 window_text_bottom_y (w
) - cursor_row
->y
);
27089 /* If row is completely invisible, don't attempt to delete a cursor which
27090 isn't there. This can happen if cursor is at top of a window, and
27091 we switch to a buffer with a header line in that window. */
27092 if (cursor_row
->visible_height
<= 0)
27093 goto mark_cursor_off
;
27095 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27096 if (cursor_row
->cursor_in_fringe_p
)
27098 cursor_row
->cursor_in_fringe_p
= 0;
27099 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27100 goto mark_cursor_off
;
27103 /* This can happen when the new row is shorter than the old one.
27104 In this case, either draw_glyphs or clear_end_of_line
27105 should have cleared the cursor. Note that we wouldn't be
27106 able to erase the cursor in this case because we don't have a
27107 cursor glyph at hand. */
27108 if ((cursor_row
->reversed_p
27109 ? (w
->phys_cursor
.hpos
< 0)
27110 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27111 goto mark_cursor_off
;
27113 /* When the window is hscrolled, cursor hpos can legitimately be out
27114 of bounds, but we draw the cursor at the corresponding window
27115 margin in that case. */
27116 if (!cursor_row
->reversed_p
&& hpos
< 0)
27118 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27119 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27121 /* If the cursor is in the mouse face area, redisplay that when
27122 we clear the cursor. */
27123 if (! NILP (hlinfo
->mouse_face_window
)
27124 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27125 /* Don't redraw the cursor's spot in mouse face if it is at the
27126 end of a line (on a newline). The cursor appears there, but
27127 mouse highlighting does not. */
27128 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27129 mouse_face_here_p
= 1;
27131 /* Maybe clear the display under the cursor. */
27132 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27135 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27138 cursor_glyph
= get_phys_cursor_glyph (w
);
27139 if (cursor_glyph
== NULL
)
27140 goto mark_cursor_off
;
27142 width
= cursor_glyph
->pixel_width
;
27143 left_x
= window_box_left_offset (w
, TEXT_AREA
);
27144 x
= w
->phys_cursor
.x
;
27146 width
-= left_x
- x
;
27147 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27148 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27149 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
27152 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27155 /* Erase the cursor by redrawing the character underneath it. */
27156 if (mouse_face_here_p
)
27157 hl
= DRAW_MOUSE_FACE
;
27159 hl
= DRAW_NORMAL_TEXT
;
27160 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27163 w
->phys_cursor_on_p
= 0;
27164 w
->phys_cursor_type
= NO_CURSOR
;
27169 Display or clear cursor of window W. If ON is zero, clear the
27170 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27171 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27174 display_and_set_cursor (struct window
*w
, bool on
,
27175 int hpos
, int vpos
, int x
, int y
)
27177 struct frame
*f
= XFRAME (w
->frame
);
27178 int new_cursor_type
;
27179 int new_cursor_width
;
27181 struct glyph_row
*glyph_row
;
27182 struct glyph
*glyph
;
27184 /* This is pointless on invisible frames, and dangerous on garbaged
27185 windows and frames; in the latter case, the frame or window may
27186 be in the midst of changing its size, and x and y may be off the
27188 if (! FRAME_VISIBLE_P (f
)
27189 || FRAME_GARBAGED_P (f
)
27190 || vpos
>= w
->current_matrix
->nrows
27191 || hpos
>= w
->current_matrix
->matrix_w
)
27194 /* If cursor is off and we want it off, return quickly. */
27195 if (!on
&& !w
->phys_cursor_on_p
)
27198 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27199 /* If cursor row is not enabled, we don't really know where to
27200 display the cursor. */
27201 if (!glyph_row
->enabled_p
)
27203 w
->phys_cursor_on_p
= 0;
27208 if (!glyph_row
->exact_window_width_line_p
27209 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27210 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27212 eassert (input_blocked_p ());
27214 /* Set new_cursor_type to the cursor we want to be displayed. */
27215 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27216 &new_cursor_width
, &active_cursor
);
27218 /* If cursor is currently being shown and we don't want it to be or
27219 it is in the wrong place, or the cursor type is not what we want,
27221 if (w
->phys_cursor_on_p
27223 || w
->phys_cursor
.x
!= x
27224 || w
->phys_cursor
.y
!= y
27225 || new_cursor_type
!= w
->phys_cursor_type
27226 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27227 && new_cursor_width
!= w
->phys_cursor_width
)))
27228 erase_phys_cursor (w
);
27230 /* Don't check phys_cursor_on_p here because that flag is only set
27231 to zero in some cases where we know that the cursor has been
27232 completely erased, to avoid the extra work of erasing the cursor
27233 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27234 still not be visible, or it has only been partly erased. */
27237 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27238 w
->phys_cursor_height
= glyph_row
->height
;
27240 /* Set phys_cursor_.* before x_draw_.* is called because some
27241 of them may need the information. */
27242 w
->phys_cursor
.x
= x
;
27243 w
->phys_cursor
.y
= glyph_row
->y
;
27244 w
->phys_cursor
.hpos
= hpos
;
27245 w
->phys_cursor
.vpos
= vpos
;
27248 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27249 new_cursor_type
, new_cursor_width
,
27250 on
, active_cursor
);
27254 /* Switch the display of W's cursor on or off, according to the value
27258 update_window_cursor (struct window
*w
, bool on
)
27260 /* Don't update cursor in windows whose frame is in the process
27261 of being deleted. */
27262 if (w
->current_matrix
)
27264 int hpos
= w
->phys_cursor
.hpos
;
27265 int vpos
= w
->phys_cursor
.vpos
;
27266 struct glyph_row
*row
;
27268 if (vpos
>= w
->current_matrix
->nrows
27269 || hpos
>= w
->current_matrix
->matrix_w
)
27272 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27274 /* When the window is hscrolled, cursor hpos can legitimately be
27275 out of bounds, but we draw the cursor at the corresponding
27276 window margin in that case. */
27277 if (!row
->reversed_p
&& hpos
< 0)
27279 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27280 hpos
= row
->used
[TEXT_AREA
] - 1;
27283 display_and_set_cursor (w
, on
, hpos
, vpos
,
27284 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27290 /* Call update_window_cursor with parameter ON_P on all leaf windows
27291 in the window tree rooted at W. */
27294 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27298 if (WINDOWP (w
->contents
))
27299 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27301 update_window_cursor (w
, on_p
);
27303 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27309 Display the cursor on window W, or clear it, according to ON_P.
27310 Don't change the cursor's position. */
27313 x_update_cursor (struct frame
*f
, bool on_p
)
27315 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27320 Clear the cursor of window W to background color, and mark the
27321 cursor as not shown. This is used when the text where the cursor
27322 is about to be rewritten. */
27325 x_clear_cursor (struct window
*w
)
27327 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27328 update_window_cursor (w
, 0);
27331 #endif /* HAVE_WINDOW_SYSTEM */
27333 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27336 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27337 int start_hpos
, int end_hpos
,
27338 enum draw_glyphs_face draw
)
27340 #ifdef HAVE_WINDOW_SYSTEM
27341 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27343 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27347 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27348 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27352 /* Display the active region described by mouse_face_* according to DRAW. */
27355 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27357 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27358 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27360 if (/* If window is in the process of being destroyed, don't bother
27362 w
->current_matrix
!= NULL
27363 /* Don't update mouse highlight if hidden. */
27364 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27365 /* Recognize when we are called to operate on rows that don't exist
27366 anymore. This can happen when a window is split. */
27367 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27369 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27370 struct glyph_row
*row
, *first
, *last
;
27372 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27373 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27375 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27377 int start_hpos
, end_hpos
, start_x
;
27379 /* For all but the first row, the highlight starts at column 0. */
27382 /* R2L rows have BEG and END in reversed order, but the
27383 screen drawing geometry is always left to right. So
27384 we need to mirror the beginning and end of the
27385 highlighted area in R2L rows. */
27386 if (!row
->reversed_p
)
27388 start_hpos
= hlinfo
->mouse_face_beg_col
;
27389 start_x
= hlinfo
->mouse_face_beg_x
;
27391 else if (row
== last
)
27393 start_hpos
= hlinfo
->mouse_face_end_col
;
27394 start_x
= hlinfo
->mouse_face_end_x
;
27402 else if (row
->reversed_p
&& row
== last
)
27404 start_hpos
= hlinfo
->mouse_face_end_col
;
27405 start_x
= hlinfo
->mouse_face_end_x
;
27415 if (!row
->reversed_p
)
27416 end_hpos
= hlinfo
->mouse_face_end_col
;
27417 else if (row
== first
)
27418 end_hpos
= hlinfo
->mouse_face_beg_col
;
27421 end_hpos
= row
->used
[TEXT_AREA
];
27422 if (draw
== DRAW_NORMAL_TEXT
)
27423 row
->fill_line_p
= 1; /* Clear to end of line */
27426 else if (row
->reversed_p
&& row
== first
)
27427 end_hpos
= hlinfo
->mouse_face_beg_col
;
27430 end_hpos
= row
->used
[TEXT_AREA
];
27431 if (draw
== DRAW_NORMAL_TEXT
)
27432 row
->fill_line_p
= 1; /* Clear to end of line */
27435 if (end_hpos
> start_hpos
)
27437 draw_row_with_mouse_face (w
, start_x
, row
,
27438 start_hpos
, end_hpos
, draw
);
27441 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27445 #ifdef HAVE_WINDOW_SYSTEM
27446 /* When we've written over the cursor, arrange for it to
27447 be displayed again. */
27448 if (FRAME_WINDOW_P (f
)
27449 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27451 int hpos
= w
->phys_cursor
.hpos
;
27453 /* When the window is hscrolled, cursor hpos can legitimately be
27454 out of bounds, but we draw the cursor at the corresponding
27455 window margin in that case. */
27456 if (!row
->reversed_p
&& hpos
< 0)
27458 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27459 hpos
= row
->used
[TEXT_AREA
] - 1;
27462 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27463 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27466 #endif /* HAVE_WINDOW_SYSTEM */
27469 #ifdef HAVE_WINDOW_SYSTEM
27470 /* Change the mouse cursor. */
27471 if (FRAME_WINDOW_P (f
))
27473 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27474 if (draw
== DRAW_NORMAL_TEXT
27475 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27476 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27479 if (draw
== DRAW_MOUSE_FACE
)
27480 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27482 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27484 #endif /* HAVE_WINDOW_SYSTEM */
27488 Clear out the mouse-highlighted active region.
27489 Redraw it un-highlighted first. Value is non-zero if mouse
27490 face was actually drawn unhighlighted. */
27493 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27497 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27499 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27503 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27504 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27505 hlinfo
->mouse_face_window
= Qnil
;
27506 hlinfo
->mouse_face_overlay
= Qnil
;
27510 /* Return true if the coordinates HPOS and VPOS on windows W are
27511 within the mouse face on that window. */
27513 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27515 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27517 /* Quickly resolve the easy cases. */
27518 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27519 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27521 if (vpos
< hlinfo
->mouse_face_beg_row
27522 || vpos
> hlinfo
->mouse_face_end_row
)
27524 if (vpos
> hlinfo
->mouse_face_beg_row
27525 && vpos
< hlinfo
->mouse_face_end_row
)
27528 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27530 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27532 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27535 else if ((vpos
== hlinfo
->mouse_face_beg_row
27536 && hpos
>= hlinfo
->mouse_face_beg_col
)
27537 || (vpos
== hlinfo
->mouse_face_end_row
27538 && hpos
< hlinfo
->mouse_face_end_col
))
27543 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27545 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27548 else if ((vpos
== hlinfo
->mouse_face_beg_row
27549 && hpos
<= hlinfo
->mouse_face_beg_col
)
27550 || (vpos
== hlinfo
->mouse_face_end_row
27551 && hpos
> hlinfo
->mouse_face_end_col
))
27559 True if physical cursor of window W is within mouse face. */
27562 cursor_in_mouse_face_p (struct window
*w
)
27564 int hpos
= w
->phys_cursor
.hpos
;
27565 int vpos
= w
->phys_cursor
.vpos
;
27566 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27568 /* When the window is hscrolled, cursor hpos can legitimately be out
27569 of bounds, but we draw the cursor at the corresponding window
27570 margin in that case. */
27571 if (!row
->reversed_p
&& hpos
< 0)
27573 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27574 hpos
= row
->used
[TEXT_AREA
] - 1;
27576 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27581 /* Find the glyph rows START_ROW and END_ROW of window W that display
27582 characters between buffer positions START_CHARPOS and END_CHARPOS
27583 (excluding END_CHARPOS). DISP_STRING is a display string that
27584 covers these buffer positions. This is similar to
27585 row_containing_pos, but is more accurate when bidi reordering makes
27586 buffer positions change non-linearly with glyph rows. */
27588 rows_from_pos_range (struct window
*w
,
27589 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27590 Lisp_Object disp_string
,
27591 struct glyph_row
**start
, struct glyph_row
**end
)
27593 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27594 int last_y
= window_text_bottom_y (w
);
27595 struct glyph_row
*row
;
27600 while (!first
->enabled_p
27601 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27604 /* Find the START row. */
27606 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27609 /* A row can potentially be the START row if the range of the
27610 characters it displays intersects the range
27611 [START_CHARPOS..END_CHARPOS). */
27612 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27613 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27614 /* See the commentary in row_containing_pos, for the
27615 explanation of the complicated way to check whether
27616 some position is beyond the end of the characters
27617 displayed by a row. */
27618 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27619 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27620 && !row
->ends_at_zv_p
27621 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27622 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27623 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27624 && !row
->ends_at_zv_p
27625 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27627 /* Found a candidate row. Now make sure at least one of the
27628 glyphs it displays has a charpos from the range
27629 [START_CHARPOS..END_CHARPOS).
27631 This is not obvious because bidi reordering could make
27632 buffer positions of a row be 1,2,3,102,101,100, and if we
27633 want to highlight characters in [50..60), we don't want
27634 this row, even though [50..60) does intersect [1..103),
27635 the range of character positions given by the row's start
27636 and end positions. */
27637 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27638 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27642 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27643 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27644 /* A glyph that comes from DISP_STRING is by
27645 definition to be highlighted. */
27646 || EQ (g
->object
, disp_string
))
27655 /* Find the END row. */
27657 /* If the last row is partially visible, start looking for END
27658 from that row, instead of starting from FIRST. */
27659 && !(row
->enabled_p
27660 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27662 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27664 struct glyph_row
*next
= row
+ 1;
27665 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27667 if (!next
->enabled_p
27668 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
27669 /* The first row >= START whose range of displayed characters
27670 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27671 is the row END + 1. */
27672 || (start_charpos
< next_start
27673 && end_charpos
< next_start
)
27674 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27675 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27676 && !next
->ends_at_zv_p
27677 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
27678 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27679 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27680 && !next
->ends_at_zv_p
27681 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
27688 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27689 but none of the characters it displays are in the range, it is
27691 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
27692 struct glyph
*s
= g
;
27693 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
27697 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27698 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27699 /* If the buffer position of the first glyph in
27700 the row is equal to END_CHARPOS, it means
27701 the last character to be highlighted is the
27702 newline of ROW, and we must consider NEXT as
27704 || (((!next
->reversed_p
&& g
== s
)
27705 || (next
->reversed_p
&& g
== e
- 1))
27706 && (g
->charpos
== end_charpos
27707 /* Special case for when NEXT is an
27708 empty line at ZV. */
27709 || (g
->charpos
== -1
27710 && !row
->ends_at_zv_p
27711 && next_start
== end_charpos
)))))
27712 /* A glyph that comes from DISP_STRING is by
27713 definition to be highlighted. */
27714 || EQ (g
->object
, disp_string
))
27723 /* The first row that ends at ZV must be the last to be
27725 else if (next
->ends_at_zv_p
)
27734 /* This function sets the mouse_face_* elements of HLINFO, assuming
27735 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
27736 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
27737 for the overlay or run of text properties specifying the mouse
27738 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
27739 before-string and after-string that must also be highlighted.
27740 DISP_STRING, if non-nil, is a display string that may cover some
27741 or all of the highlighted text. */
27744 mouse_face_from_buffer_pos (Lisp_Object window
,
27745 Mouse_HLInfo
*hlinfo
,
27746 ptrdiff_t mouse_charpos
,
27747 ptrdiff_t start_charpos
,
27748 ptrdiff_t end_charpos
,
27749 Lisp_Object before_string
,
27750 Lisp_Object after_string
,
27751 Lisp_Object disp_string
)
27753 struct window
*w
= XWINDOW (window
);
27754 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27755 struct glyph_row
*r1
, *r2
;
27756 struct glyph
*glyph
, *end
;
27757 ptrdiff_t ignore
, pos
;
27760 eassert (NILP (disp_string
) || STRINGP (disp_string
));
27761 eassert (NILP (before_string
) || STRINGP (before_string
));
27762 eassert (NILP (after_string
) || STRINGP (after_string
));
27764 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
27765 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
27767 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27768 /* If the before-string or display-string contains newlines,
27769 rows_from_pos_range skips to its last row. Move back. */
27770 if (!NILP (before_string
) || !NILP (disp_string
))
27772 struct glyph_row
*prev
;
27773 while ((prev
= r1
- 1, prev
>= first
)
27774 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
27775 && prev
->used
[TEXT_AREA
] > 0)
27777 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
27778 glyph
= beg
+ prev
->used
[TEXT_AREA
];
27779 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
27781 || !(EQ (glyph
->object
, before_string
)
27782 || EQ (glyph
->object
, disp_string
)))
27789 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27790 hlinfo
->mouse_face_past_end
= 1;
27792 else if (!NILP (after_string
))
27794 /* If the after-string has newlines, advance to its last row. */
27795 struct glyph_row
*next
;
27796 struct glyph_row
*last
27797 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27799 for (next
= r2
+ 1;
27801 && next
->used
[TEXT_AREA
] > 0
27802 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
27806 /* The rest of the display engine assumes that mouse_face_beg_row is
27807 either above mouse_face_end_row or identical to it. But with
27808 bidi-reordered continued lines, the row for START_CHARPOS could
27809 be below the row for END_CHARPOS. If so, swap the rows and store
27810 them in correct order. */
27813 struct glyph_row
*tem
= r2
;
27819 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
27820 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
27822 /* For a bidi-reordered row, the positions of BEFORE_STRING,
27823 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
27824 could be anywhere in the row and in any order. The strategy
27825 below is to find the leftmost and the rightmost glyph that
27826 belongs to either of these 3 strings, or whose position is
27827 between START_CHARPOS and END_CHARPOS, and highlight all the
27828 glyphs between those two. This may cover more than just the text
27829 between START_CHARPOS and END_CHARPOS if the range of characters
27830 strides the bidi level boundary, e.g. if the beginning is in R2L
27831 text while the end is in L2R text or vice versa. */
27832 if (!r1
->reversed_p
)
27834 /* This row is in a left to right paragraph. Scan it left to
27836 glyph
= r1
->glyphs
[TEXT_AREA
];
27837 end
= glyph
+ r1
->used
[TEXT_AREA
];
27840 /* Skip truncation glyphs at the start of the glyph row. */
27841 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27843 && INTEGERP (glyph
->object
)
27844 && glyph
->charpos
< 0;
27846 x
+= glyph
->pixel_width
;
27848 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27849 or DISP_STRING, and the first glyph from buffer whose
27850 position is between START_CHARPOS and END_CHARPOS. */
27852 && !INTEGERP (glyph
->object
)
27853 && !EQ (glyph
->object
, disp_string
)
27854 && !(BUFFERP (glyph
->object
)
27855 && (glyph
->charpos
>= start_charpos
27856 && glyph
->charpos
< end_charpos
));
27859 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27860 are present at buffer positions between START_CHARPOS and
27861 END_CHARPOS, or if they come from an overlay. */
27862 if (EQ (glyph
->object
, before_string
))
27864 pos
= string_buffer_position (before_string
,
27866 /* If pos == 0, it means before_string came from an
27867 overlay, not from a buffer position. */
27868 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27871 else if (EQ (glyph
->object
, after_string
))
27873 pos
= string_buffer_position (after_string
, end_charpos
);
27874 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27877 x
+= glyph
->pixel_width
;
27879 hlinfo
->mouse_face_beg_x
= x
;
27880 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27884 /* This row is in a right to left paragraph. Scan it right to
27888 end
= r1
->glyphs
[TEXT_AREA
] - 1;
27889 glyph
= end
+ r1
->used
[TEXT_AREA
];
27891 /* Skip truncation glyphs at the start of the glyph row. */
27892 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27894 && INTEGERP (glyph
->object
)
27895 && glyph
->charpos
< 0;
27899 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27900 or DISP_STRING, and the first glyph from buffer whose
27901 position is between START_CHARPOS and END_CHARPOS. */
27903 && !INTEGERP (glyph
->object
)
27904 && !EQ (glyph
->object
, disp_string
)
27905 && !(BUFFERP (glyph
->object
)
27906 && (glyph
->charpos
>= start_charpos
27907 && glyph
->charpos
< end_charpos
));
27910 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27911 are present at buffer positions between START_CHARPOS and
27912 END_CHARPOS, or if they come from an overlay. */
27913 if (EQ (glyph
->object
, before_string
))
27915 pos
= string_buffer_position (before_string
, start_charpos
);
27916 /* If pos == 0, it means before_string came from an
27917 overlay, not from a buffer position. */
27918 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27921 else if (EQ (glyph
->object
, after_string
))
27923 pos
= string_buffer_position (after_string
, end_charpos
);
27924 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27929 glyph
++; /* first glyph to the right of the highlighted area */
27930 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
27931 x
+= g
->pixel_width
;
27932 hlinfo
->mouse_face_beg_x
= x
;
27933 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27936 /* If the highlight ends in a different row, compute GLYPH and END
27937 for the end row. Otherwise, reuse the values computed above for
27938 the row where the highlight begins. */
27941 if (!r2
->reversed_p
)
27943 glyph
= r2
->glyphs
[TEXT_AREA
];
27944 end
= glyph
+ r2
->used
[TEXT_AREA
];
27949 end
= r2
->glyphs
[TEXT_AREA
] - 1;
27950 glyph
= end
+ r2
->used
[TEXT_AREA
];
27954 if (!r2
->reversed_p
)
27956 /* Skip truncation and continuation glyphs near the end of the
27957 row, and also blanks and stretch glyphs inserted by
27958 extend_face_to_end_of_line. */
27960 && INTEGERP ((end
- 1)->object
))
27962 /* Scan the rest of the glyph row from the end, looking for the
27963 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
27964 DISP_STRING, or whose position is between START_CHARPOS
27968 && !INTEGERP (end
->object
)
27969 && !EQ (end
->object
, disp_string
)
27970 && !(BUFFERP (end
->object
)
27971 && (end
->charpos
>= start_charpos
27972 && end
->charpos
< end_charpos
));
27975 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27976 are present at buffer positions between START_CHARPOS and
27977 END_CHARPOS, or if they come from an overlay. */
27978 if (EQ (end
->object
, before_string
))
27980 pos
= string_buffer_position (before_string
, start_charpos
);
27981 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27984 else if (EQ (end
->object
, after_string
))
27986 pos
= string_buffer_position (after_string
, end_charpos
);
27987 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27991 /* Find the X coordinate of the last glyph to be highlighted. */
27992 for (; glyph
<= end
; ++glyph
)
27993 x
+= glyph
->pixel_width
;
27995 hlinfo
->mouse_face_end_x
= x
;
27996 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28000 /* Skip truncation and continuation glyphs near the end of the
28001 row, and also blanks and stretch glyphs inserted by
28002 extend_face_to_end_of_line. */
28006 && INTEGERP (end
->object
))
28008 x
+= end
->pixel_width
;
28011 /* Scan the rest of the glyph row from the end, looking for the
28012 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28013 DISP_STRING, or whose position is between START_CHARPOS
28017 && !INTEGERP (end
->object
)
28018 && !EQ (end
->object
, disp_string
)
28019 && !(BUFFERP (end
->object
)
28020 && (end
->charpos
>= start_charpos
28021 && end
->charpos
< end_charpos
));
28024 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28025 are present at buffer positions between START_CHARPOS and
28026 END_CHARPOS, or if they come from an overlay. */
28027 if (EQ (end
->object
, before_string
))
28029 pos
= string_buffer_position (before_string
, start_charpos
);
28030 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28033 else if (EQ (end
->object
, after_string
))
28035 pos
= string_buffer_position (after_string
, end_charpos
);
28036 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28039 x
+= end
->pixel_width
;
28041 /* If we exited the above loop because we arrived at the last
28042 glyph of the row, and its buffer position is still not in
28043 range, it means the last character in range is the preceding
28044 newline. Bump the end column and x values to get past the
28047 && BUFFERP (end
->object
)
28048 && (end
->charpos
< start_charpos
28049 || end
->charpos
>= end_charpos
))
28051 x
+= end
->pixel_width
;
28054 hlinfo
->mouse_face_end_x
= x
;
28055 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28058 hlinfo
->mouse_face_window
= window
;
28059 hlinfo
->mouse_face_face_id
28060 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28062 !hlinfo
->mouse_face_hidden
, -1);
28063 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28066 /* The following function is not used anymore (replaced with
28067 mouse_face_from_string_pos), but I leave it here for the time
28068 being, in case someone would. */
28070 #if 0 /* not used */
28072 /* Find the position of the glyph for position POS in OBJECT in
28073 window W's current matrix, and return in *X, *Y the pixel
28074 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28076 RIGHT_P non-zero means return the position of the right edge of the
28077 glyph, RIGHT_P zero means return the left edge position.
28079 If no glyph for POS exists in the matrix, return the position of
28080 the glyph with the next smaller position that is in the matrix, if
28081 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28082 exists in the matrix, return the position of the glyph with the
28083 next larger position in OBJECT.
28085 Value is non-zero if a glyph was found. */
28088 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28089 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28091 int yb
= window_text_bottom_y (w
);
28092 struct glyph_row
*r
;
28093 struct glyph
*best_glyph
= NULL
;
28094 struct glyph_row
*best_row
= NULL
;
28097 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28098 r
->enabled_p
&& r
->y
< yb
;
28101 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28102 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28105 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28106 if (EQ (g
->object
, object
))
28108 if (g
->charpos
== pos
)
28115 else if (best_glyph
== NULL
28116 || ((eabs (g
->charpos
- pos
)
28117 < eabs (best_glyph
->charpos
- pos
))
28120 : g
->charpos
> pos
)))
28134 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28138 *x
+= best_glyph
->pixel_width
;
28143 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28146 return best_glyph
!= NULL
;
28148 #endif /* not used */
28150 /* Find the positions of the first and the last glyphs in window W's
28151 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28152 (assumed to be a string), and return in HLINFO's mouse_face_*
28153 members the pixel and column/row coordinates of those glyphs. */
28156 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28157 Lisp_Object object
,
28158 ptrdiff_t startpos
, ptrdiff_t endpos
)
28160 int yb
= window_text_bottom_y (w
);
28161 struct glyph_row
*r
;
28162 struct glyph
*g
, *e
;
28166 /* Find the glyph row with at least one position in the range
28167 [STARTPOS..ENDPOS), and the first glyph in that row whose
28168 position belongs to that range. */
28169 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28170 r
->enabled_p
&& r
->y
< yb
;
28173 if (!r
->reversed_p
)
28175 g
= r
->glyphs
[TEXT_AREA
];
28176 e
= g
+ r
->used
[TEXT_AREA
];
28177 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28178 if (EQ (g
->object
, object
)
28179 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28181 hlinfo
->mouse_face_beg_row
28182 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28183 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28184 hlinfo
->mouse_face_beg_x
= gx
;
28193 e
= r
->glyphs
[TEXT_AREA
];
28194 g
= e
+ r
->used
[TEXT_AREA
];
28195 for ( ; g
> e
; --g
)
28196 if (EQ ((g
-1)->object
, object
)
28197 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28199 hlinfo
->mouse_face_beg_row
28200 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28201 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28202 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28203 gx
+= g1
->pixel_width
;
28204 hlinfo
->mouse_face_beg_x
= gx
;
28216 /* Starting with the next row, look for the first row which does NOT
28217 include any glyphs whose positions are in the range. */
28218 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28220 g
= r
->glyphs
[TEXT_AREA
];
28221 e
= g
+ r
->used
[TEXT_AREA
];
28223 for ( ; g
< e
; ++g
)
28224 if (EQ (g
->object
, object
)
28225 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28234 /* The highlighted region ends on the previous row. */
28237 /* Set the end row. */
28238 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28240 /* Compute and set the end column and the end column's horizontal
28241 pixel coordinate. */
28242 if (!r
->reversed_p
)
28244 g
= r
->glyphs
[TEXT_AREA
];
28245 e
= g
+ r
->used
[TEXT_AREA
];
28246 for ( ; e
> g
; --e
)
28247 if (EQ ((e
-1)->object
, object
)
28248 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28250 hlinfo
->mouse_face_end_col
= e
- g
;
28252 for (gx
= r
->x
; g
< e
; ++g
)
28253 gx
+= g
->pixel_width
;
28254 hlinfo
->mouse_face_end_x
= gx
;
28258 e
= r
->glyphs
[TEXT_AREA
];
28259 g
= e
+ r
->used
[TEXT_AREA
];
28260 for (gx
= r
->x
; e
< g
; ++e
)
28262 if (EQ (e
->object
, object
)
28263 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28265 gx
+= e
->pixel_width
;
28267 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28268 hlinfo
->mouse_face_end_x
= gx
;
28272 #ifdef HAVE_WINDOW_SYSTEM
28274 /* See if position X, Y is within a hot-spot of an image. */
28277 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28279 if (!CONSP (hot_spot
))
28282 if (EQ (XCAR (hot_spot
), Qrect
))
28284 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28285 Lisp_Object rect
= XCDR (hot_spot
);
28289 if (!CONSP (XCAR (rect
)))
28291 if (!CONSP (XCDR (rect
)))
28293 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28295 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28297 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28299 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28303 else if (EQ (XCAR (hot_spot
), Qcircle
))
28305 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28306 Lisp_Object circ
= XCDR (hot_spot
);
28307 Lisp_Object lr
, lx0
, ly0
;
28309 && CONSP (XCAR (circ
))
28310 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28311 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28312 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28314 double r
= XFLOATINT (lr
);
28315 double dx
= XINT (lx0
) - x
;
28316 double dy
= XINT (ly0
) - y
;
28317 return (dx
* dx
+ dy
* dy
<= r
* r
);
28320 else if (EQ (XCAR (hot_spot
), Qpoly
))
28322 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28323 if (VECTORP (XCDR (hot_spot
)))
28325 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28326 Lisp_Object
*poly
= v
->contents
;
28327 ptrdiff_t n
= v
->header
.size
;
28330 Lisp_Object lx
, ly
;
28333 /* Need an even number of coordinates, and at least 3 edges. */
28334 if (n
< 6 || n
& 1)
28337 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28338 If count is odd, we are inside polygon. Pixels on edges
28339 may or may not be included depending on actual geometry of the
28341 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28342 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28344 x0
= XINT (lx
), y0
= XINT (ly
);
28345 for (i
= 0; i
< n
; i
+= 2)
28347 int x1
= x0
, y1
= y0
;
28348 if ((lx
= poly
[i
], !INTEGERP (lx
))
28349 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28351 x0
= XINT (lx
), y0
= XINT (ly
);
28353 /* Does this segment cross the X line? */
28361 if (y
> y0
&& y
> y1
)
28363 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28373 find_hot_spot (Lisp_Object map
, int x
, int y
)
28375 while (CONSP (map
))
28377 if (CONSP (XCAR (map
))
28378 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28386 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28388 doc
: /* Lookup in image map MAP coordinates X and Y.
28389 An image map is an alist where each element has the format (AREA ID PLIST).
28390 An AREA is specified as either a rectangle, a circle, or a polygon:
28391 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28392 pixel coordinates of the upper left and bottom right corners.
28393 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28394 and the radius of the circle; r may be a float or integer.
28395 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28396 vector describes one corner in the polygon.
28397 Returns the alist element for the first matching AREA in MAP. */)
28398 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28406 return find_hot_spot (map
,
28407 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28408 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28412 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28414 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28416 /* Do not change cursor shape while dragging mouse. */
28417 if (!NILP (do_mouse_tracking
))
28420 if (!NILP (pointer
))
28422 if (EQ (pointer
, Qarrow
))
28423 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28424 else if (EQ (pointer
, Qhand
))
28425 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28426 else if (EQ (pointer
, Qtext
))
28427 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28428 else if (EQ (pointer
, intern ("hdrag")))
28429 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28430 else if (EQ (pointer
, intern ("nhdrag")))
28431 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28432 #ifdef HAVE_X_WINDOWS
28433 else if (EQ (pointer
, intern ("vdrag")))
28434 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28436 else if (EQ (pointer
, intern ("hourglass")))
28437 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28438 else if (EQ (pointer
, Qmodeline
))
28439 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28441 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28444 if (cursor
!= No_Cursor
)
28445 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28448 #endif /* HAVE_WINDOW_SYSTEM */
28450 /* Take proper action when mouse has moved to the mode or header line
28451 or marginal area AREA of window W, x-position X and y-position Y.
28452 X is relative to the start of the text display area of W, so the
28453 width of bitmap areas and scroll bars must be subtracted to get a
28454 position relative to the start of the mode line. */
28457 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28458 enum window_part area
)
28460 struct window
*w
= XWINDOW (window
);
28461 struct frame
*f
= XFRAME (w
->frame
);
28462 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28463 #ifdef HAVE_WINDOW_SYSTEM
28464 Display_Info
*dpyinfo
;
28466 Cursor cursor
= No_Cursor
;
28467 Lisp_Object pointer
= Qnil
;
28468 int dx
, dy
, width
, height
;
28470 Lisp_Object string
, object
= Qnil
;
28471 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28473 Lisp_Object mouse_face
;
28474 int original_x_pixel
= x
;
28475 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28476 struct glyph_row
*row
IF_LINT (= 0);
28478 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28483 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28484 returns them in row/column units! */
28485 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28486 &object
, &dx
, &dy
, &width
, &height
);
28488 row
= (area
== ON_MODE_LINE
28489 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28490 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28492 /* Find the glyph under the mouse pointer. */
28493 if (row
->mode_line_p
&& row
->enabled_p
)
28495 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28496 end
= glyph
+ row
->used
[TEXT_AREA
];
28498 for (x0
= original_x_pixel
;
28499 glyph
< end
&& x0
>= glyph
->pixel_width
;
28501 x0
-= glyph
->pixel_width
;
28509 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28510 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28511 returns them in row/column units! */
28512 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28513 &object
, &dx
, &dy
, &width
, &height
);
28518 #ifdef HAVE_WINDOW_SYSTEM
28519 if (IMAGEP (object
))
28521 Lisp_Object image_map
, hotspot
;
28522 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28524 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28526 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28530 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28531 If so, we could look for mouse-enter, mouse-leave
28532 properties in PLIST (and do something...). */
28533 hotspot
= XCDR (hotspot
);
28534 if (CONSP (hotspot
)
28535 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28537 pointer
= Fplist_get (plist
, Qpointer
);
28538 if (NILP (pointer
))
28540 help
= Fplist_get (plist
, Qhelp_echo
);
28543 help_echo_string
= help
;
28544 XSETWINDOW (help_echo_window
, w
);
28545 help_echo_object
= w
->contents
;
28546 help_echo_pos
= charpos
;
28550 if (NILP (pointer
))
28551 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28553 #endif /* HAVE_WINDOW_SYSTEM */
28555 if (STRINGP (string
))
28556 pos
= make_number (charpos
);
28558 /* Set the help text and mouse pointer. If the mouse is on a part
28559 of the mode line without any text (e.g. past the right edge of
28560 the mode line text), use the default help text and pointer. */
28561 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28563 /* Arrange to display the help by setting the global variables
28564 help_echo_string, help_echo_object, and help_echo_pos. */
28567 if (STRINGP (string
))
28568 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28572 help_echo_string
= help
;
28573 XSETWINDOW (help_echo_window
, w
);
28574 help_echo_object
= string
;
28575 help_echo_pos
= charpos
;
28577 else if (area
== ON_MODE_LINE
)
28579 Lisp_Object default_help
28580 = buffer_local_value_1 (Qmode_line_default_help_echo
,
28583 if (STRINGP (default_help
))
28585 help_echo_string
= default_help
;
28586 XSETWINDOW (help_echo_window
, w
);
28587 help_echo_object
= Qnil
;
28588 help_echo_pos
= -1;
28593 #ifdef HAVE_WINDOW_SYSTEM
28594 /* Change the mouse pointer according to what is under it. */
28595 if (FRAME_WINDOW_P (f
))
28597 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28599 || NILP (Vresize_mini_windows
));
28601 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28602 if (STRINGP (string
))
28604 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28606 if (NILP (pointer
))
28607 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28609 /* Change the mouse pointer according to what is under X/Y. */
28611 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28614 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28615 if (!KEYMAPP (map
))
28616 map
= Fget_text_property (pos
, Qkeymap
, string
);
28617 if (!KEYMAPP (map
) && draggable
)
28618 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28621 else if (draggable
)
28622 /* Default mode-line pointer. */
28623 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28628 /* Change the mouse face according to what is under X/Y. */
28629 if (STRINGP (string
))
28631 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28632 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28633 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28638 struct glyph
* tmp_glyph
;
28642 int total_pixel_width
;
28643 ptrdiff_t begpos
, endpos
, ignore
;
28647 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28648 Qmouse_face
, string
, Qnil
);
28654 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28656 endpos
= SCHARS (string
);
28660 /* Calculate the glyph position GPOS of GLYPH in the
28661 displayed string, relative to the beginning of the
28662 highlighted part of the string.
28664 Note: GPOS is different from CHARPOS. CHARPOS is the
28665 position of GLYPH in the internal string object. A mode
28666 line string format has structures which are converted to
28667 a flattened string by the Emacs Lisp interpreter. The
28668 internal string is an element of those structures. The
28669 displayed string is the flattened string. */
28670 tmp_glyph
= row_start_glyph
;
28671 while (tmp_glyph
< glyph
28672 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28673 && begpos
<= tmp_glyph
->charpos
28674 && tmp_glyph
->charpos
< endpos
)))
28676 gpos
= glyph
- tmp_glyph
;
28678 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28679 the highlighted part of the displayed string to which
28680 GLYPH belongs. Note: GSEQ_LENGTH is different from
28681 SCHARS (STRING), because the latter returns the length of
28682 the internal string. */
28683 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
28685 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28686 && begpos
<= tmp_glyph
->charpos
28687 && tmp_glyph
->charpos
< endpos
));
28690 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
28692 /* Calculate the total pixel width of all the glyphs between
28693 the beginning of the highlighted area and GLYPH. */
28694 total_pixel_width
= 0;
28695 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
28696 total_pixel_width
+= tmp_glyph
->pixel_width
;
28698 /* Pre calculation of re-rendering position. Note: X is in
28699 column units here, after the call to mode_line_string or
28700 marginal_area_string. */
28702 vpos
= (area
== ON_MODE_LINE
28703 ? (w
->current_matrix
)->nrows
- 1
28706 /* If GLYPH's position is included in the region that is
28707 already drawn in mouse face, we have nothing to do. */
28708 if ( EQ (window
, hlinfo
->mouse_face_window
)
28709 && (!row
->reversed_p
28710 ? (hlinfo
->mouse_face_beg_col
<= hpos
28711 && hpos
< hlinfo
->mouse_face_end_col
)
28712 /* In R2L rows we swap BEG and END, see below. */
28713 : (hlinfo
->mouse_face_end_col
<= hpos
28714 && hpos
< hlinfo
->mouse_face_beg_col
))
28715 && hlinfo
->mouse_face_beg_row
== vpos
)
28718 if (clear_mouse_face (hlinfo
))
28719 cursor
= No_Cursor
;
28721 if (!row
->reversed_p
)
28723 hlinfo
->mouse_face_beg_col
= hpos
;
28724 hlinfo
->mouse_face_beg_x
= original_x_pixel
28725 - (total_pixel_width
+ dx
);
28726 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
28727 hlinfo
->mouse_face_end_x
= 0;
28731 /* In R2L rows, show_mouse_face expects BEG and END
28732 coordinates to be swapped. */
28733 hlinfo
->mouse_face_end_col
= hpos
;
28734 hlinfo
->mouse_face_end_x
= original_x_pixel
28735 - (total_pixel_width
+ dx
);
28736 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
28737 hlinfo
->mouse_face_beg_x
= 0;
28740 hlinfo
->mouse_face_beg_row
= vpos
;
28741 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
28742 hlinfo
->mouse_face_past_end
= 0;
28743 hlinfo
->mouse_face_window
= window
;
28745 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
28750 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28752 if (NILP (pointer
))
28755 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28756 clear_mouse_face (hlinfo
);
28758 #ifdef HAVE_WINDOW_SYSTEM
28759 if (FRAME_WINDOW_P (f
))
28760 define_frame_cursor1 (f
, cursor
, pointer
);
28766 Take proper action when the mouse has moved to position X, Y on
28767 frame F with regards to highlighting portions of display that have
28768 mouse-face properties. Also de-highlight portions of display where
28769 the mouse was before, set the mouse pointer shape as appropriate
28770 for the mouse coordinates, and activate help echo (tooltips).
28771 X and Y can be negative or out of range. */
28774 note_mouse_highlight (struct frame
*f
, int x
, int y
)
28776 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28777 enum window_part part
= ON_NOTHING
;
28778 Lisp_Object window
;
28780 Cursor cursor
= No_Cursor
;
28781 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
28784 /* When a menu is active, don't highlight because this looks odd. */
28785 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
28786 if (popup_activated ())
28790 if (!f
->glyphs_initialized_p
28791 || f
->pointer_invisible
)
28794 hlinfo
->mouse_face_mouse_x
= x
;
28795 hlinfo
->mouse_face_mouse_y
= y
;
28796 hlinfo
->mouse_face_mouse_frame
= f
;
28798 if (hlinfo
->mouse_face_defer
)
28801 /* Which window is that in? */
28802 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
28804 /* If displaying active text in another window, clear that. */
28805 if (! EQ (window
, hlinfo
->mouse_face_window
)
28806 /* Also clear if we move out of text area in same window. */
28807 || (!NILP (hlinfo
->mouse_face_window
)
28810 && part
!= ON_MODE_LINE
28811 && part
!= ON_HEADER_LINE
))
28812 clear_mouse_face (hlinfo
);
28814 /* Not on a window -> return. */
28815 if (!WINDOWP (window
))
28818 /* Reset help_echo_string. It will get recomputed below. */
28819 help_echo_string
= Qnil
;
28821 /* Convert to window-relative pixel coordinates. */
28822 w
= XWINDOW (window
);
28823 frame_to_window_pixel_xy (w
, &x
, &y
);
28825 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
28826 /* Handle tool-bar window differently since it doesn't display a
28828 if (EQ (window
, f
->tool_bar_window
))
28830 note_tool_bar_highlight (f
, x
, y
);
28835 /* Mouse is on the mode, header line or margin? */
28836 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
28837 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28839 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
28841 #ifdef HAVE_WINDOW_SYSTEM
28842 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28844 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28845 /* Show non-text cursor (Bug#16647). */
28853 #ifdef HAVE_WINDOW_SYSTEM
28854 if (part
== ON_VERTICAL_BORDER
)
28856 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28857 help_echo_string
= build_string ("drag-mouse-1: resize");
28859 else if (part
== ON_RIGHT_DIVIDER
)
28861 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28862 help_echo_string
= build_string ("drag-mouse-1: resize");
28864 else if (part
== ON_BOTTOM_DIVIDER
)
28865 if (! WINDOW_BOTTOMMOST_P (w
)
28867 || NILP (Vresize_mini_windows
))
28869 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28870 help_echo_string
= build_string ("drag-mouse-1: resize");
28873 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28874 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
28875 || part
== ON_SCROLL_BAR
)
28876 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28878 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28881 /* Are we in a window whose display is up to date?
28882 And verify the buffer's text has not changed. */
28883 b
= XBUFFER (w
->contents
);
28884 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
28886 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
28888 struct glyph
*glyph
;
28889 Lisp_Object object
;
28890 Lisp_Object mouse_face
= Qnil
, position
;
28891 Lisp_Object
*overlay_vec
= NULL
;
28892 ptrdiff_t i
, noverlays
;
28893 struct buffer
*obuf
;
28894 ptrdiff_t obegv
, ozv
;
28897 /* Find the glyph under X/Y. */
28898 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
28900 #ifdef HAVE_WINDOW_SYSTEM
28901 /* Look for :pointer property on image. */
28902 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28904 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
28905 if (img
!= NULL
&& IMAGEP (img
->spec
))
28907 Lisp_Object image_map
, hotspot
;
28908 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
28910 && (hotspot
= find_hot_spot (image_map
,
28911 glyph
->slice
.img
.x
+ dx
,
28912 glyph
->slice
.img
.y
+ dy
),
28914 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28918 /* Could check XCAR (hotspot) to see if we enter/leave
28920 If so, we could look for mouse-enter, mouse-leave
28921 properties in PLIST (and do something...). */
28922 hotspot
= XCDR (hotspot
);
28923 if (CONSP (hotspot
)
28924 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28926 pointer
= Fplist_get (plist
, Qpointer
);
28927 if (NILP (pointer
))
28929 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
28930 if (!NILP (help_echo_string
))
28932 help_echo_window
= window
;
28933 help_echo_object
= glyph
->object
;
28934 help_echo_pos
= glyph
->charpos
;
28938 if (NILP (pointer
))
28939 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
28942 #endif /* HAVE_WINDOW_SYSTEM */
28944 /* Clear mouse face if X/Y not over text. */
28946 || area
!= TEXT_AREA
28947 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
28948 /* Glyph's OBJECT is an integer for glyphs inserted by the
28949 display engine for its internal purposes, like truncation
28950 and continuation glyphs and blanks beyond the end of
28951 line's text on text terminals. If we are over such a
28952 glyph, we are not over any text. */
28953 || INTEGERP (glyph
->object
)
28954 /* R2L rows have a stretch glyph at their front, which
28955 stands for no text, whereas L2R rows have no glyphs at
28956 all beyond the end of text. Treat such stretch glyphs
28957 like we do with NULL glyphs in L2R rows. */
28958 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
28959 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
28960 && glyph
->type
== STRETCH_GLYPH
28961 && glyph
->avoid_cursor_p
))
28963 if (clear_mouse_face (hlinfo
))
28964 cursor
= No_Cursor
;
28965 #ifdef HAVE_WINDOW_SYSTEM
28966 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28968 if (area
!= TEXT_AREA
)
28969 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28971 pointer
= Vvoid_text_area_pointer
;
28977 pos
= glyph
->charpos
;
28978 object
= glyph
->object
;
28979 if (!STRINGP (object
) && !BUFFERP (object
))
28982 /* If we get an out-of-range value, return now; avoid an error. */
28983 if (BUFFERP (object
) && pos
> BUF_Z (b
))
28986 /* Make the window's buffer temporarily current for
28987 overlays_at and compute_char_face. */
28988 obuf
= current_buffer
;
28989 current_buffer
= b
;
28995 /* Is this char mouse-active or does it have help-echo? */
28996 position
= make_number (pos
);
28998 if (BUFFERP (object
))
29000 /* Put all the overlays we want in a vector in overlay_vec. */
29001 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29002 /* Sort overlays into increasing priority order. */
29003 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29008 if (NILP (Vmouse_highlight
))
29010 clear_mouse_face (hlinfo
);
29011 goto check_help_echo
;
29014 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29017 cursor
= No_Cursor
;
29019 /* Check mouse-face highlighting. */
29021 /* If there exists an overlay with mouse-face overlapping
29022 the one we are currently highlighting, we have to
29023 check if we enter the overlapping overlay, and then
29024 highlight only that. */
29025 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29026 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29028 /* Find the highest priority overlay with a mouse-face. */
29029 Lisp_Object overlay
= Qnil
;
29030 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29032 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29033 if (!NILP (mouse_face
))
29034 overlay
= overlay_vec
[i
];
29037 /* If we're highlighting the same overlay as before, there's
29038 no need to do that again. */
29039 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29040 goto check_help_echo
;
29041 hlinfo
->mouse_face_overlay
= overlay
;
29043 /* Clear the display of the old active region, if any. */
29044 if (clear_mouse_face (hlinfo
))
29045 cursor
= No_Cursor
;
29047 /* If no overlay applies, get a text property. */
29048 if (NILP (overlay
))
29049 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29051 /* Next, compute the bounds of the mouse highlighting and
29053 if (!NILP (mouse_face
) && STRINGP (object
))
29055 /* The mouse-highlighting comes from a display string
29056 with a mouse-face. */
29060 s
= Fprevious_single_property_change
29061 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29062 e
= Fnext_single_property_change
29063 (position
, Qmouse_face
, object
, Qnil
);
29065 s
= make_number (0);
29067 e
= make_number (SCHARS (object
));
29068 mouse_face_from_string_pos (w
, hlinfo
, object
,
29069 XINT (s
), XINT (e
));
29070 hlinfo
->mouse_face_past_end
= 0;
29071 hlinfo
->mouse_face_window
= window
;
29072 hlinfo
->mouse_face_face_id
29073 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29074 glyph
->face_id
, 1);
29075 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29076 cursor
= No_Cursor
;
29080 /* The mouse-highlighting, if any, comes from an overlay
29081 or text property in the buffer. */
29082 Lisp_Object buffer
IF_LINT (= Qnil
);
29083 Lisp_Object disp_string
IF_LINT (= Qnil
);
29085 if (STRINGP (object
))
29087 /* If we are on a display string with no mouse-face,
29088 check if the text under it has one. */
29089 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29090 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29091 pos
= string_buffer_position (object
, start
);
29094 mouse_face
= get_char_property_and_overlay
29095 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29096 buffer
= w
->contents
;
29097 disp_string
= object
;
29103 disp_string
= Qnil
;
29106 if (!NILP (mouse_face
))
29108 Lisp_Object before
, after
;
29109 Lisp_Object before_string
, after_string
;
29110 /* To correctly find the limits of mouse highlight
29111 in a bidi-reordered buffer, we must not use the
29112 optimization of limiting the search in
29113 previous-single-property-change and
29114 next-single-property-change, because
29115 rows_from_pos_range needs the real start and end
29116 positions to DTRT in this case. That's because
29117 the first row visible in a window does not
29118 necessarily display the character whose position
29119 is the smallest. */
29121 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29122 ? Fmarker_position (w
->start
)
29125 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29126 ? make_number (BUF_Z (XBUFFER (buffer
))
29127 - w
->window_end_pos
)
29130 if (NILP (overlay
))
29132 /* Handle the text property case. */
29133 before
= Fprevious_single_property_change
29134 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29135 after
= Fnext_single_property_change
29136 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29137 before_string
= after_string
= Qnil
;
29141 /* Handle the overlay case. */
29142 before
= Foverlay_start (overlay
);
29143 after
= Foverlay_end (overlay
);
29144 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29145 after_string
= Foverlay_get (overlay
, Qafter_string
);
29147 if (!STRINGP (before_string
)) before_string
= Qnil
;
29148 if (!STRINGP (after_string
)) after_string
= Qnil
;
29151 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29154 : XFASTINT (before
),
29156 ? BUF_Z (XBUFFER (buffer
))
29157 : XFASTINT (after
),
29158 before_string
, after_string
,
29160 cursor
= No_Cursor
;
29167 /* Look for a `help-echo' property. */
29168 if (NILP (help_echo_string
)) {
29169 Lisp_Object help
, overlay
;
29171 /* Check overlays first. */
29172 help
= overlay
= Qnil
;
29173 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29175 overlay
= overlay_vec
[i
];
29176 help
= Foverlay_get (overlay
, Qhelp_echo
);
29181 help_echo_string
= help
;
29182 help_echo_window
= window
;
29183 help_echo_object
= overlay
;
29184 help_echo_pos
= pos
;
29188 Lisp_Object obj
= glyph
->object
;
29189 ptrdiff_t charpos
= glyph
->charpos
;
29191 /* Try text properties. */
29194 && charpos
< SCHARS (obj
))
29196 help
= Fget_text_property (make_number (charpos
),
29200 /* If the string itself doesn't specify a help-echo,
29201 see if the buffer text ``under'' it does. */
29202 struct glyph_row
*r
29203 = MATRIX_ROW (w
->current_matrix
, vpos
);
29204 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29205 ptrdiff_t p
= string_buffer_position (obj
, start
);
29208 help
= Fget_char_property (make_number (p
),
29209 Qhelp_echo
, w
->contents
);
29218 else if (BUFFERP (obj
)
29221 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29226 help_echo_string
= help
;
29227 help_echo_window
= window
;
29228 help_echo_object
= obj
;
29229 help_echo_pos
= charpos
;
29234 #ifdef HAVE_WINDOW_SYSTEM
29235 /* Look for a `pointer' property. */
29236 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29238 /* Check overlays first. */
29239 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29240 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29242 if (NILP (pointer
))
29244 Lisp_Object obj
= glyph
->object
;
29245 ptrdiff_t charpos
= glyph
->charpos
;
29247 /* Try text properties. */
29250 && charpos
< SCHARS (obj
))
29252 pointer
= Fget_text_property (make_number (charpos
),
29254 if (NILP (pointer
))
29256 /* If the string itself doesn't specify a pointer,
29257 see if the buffer text ``under'' it does. */
29258 struct glyph_row
*r
29259 = MATRIX_ROW (w
->current_matrix
, vpos
);
29260 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29261 ptrdiff_t p
= string_buffer_position (obj
, start
);
29263 pointer
= Fget_char_property (make_number (p
),
29264 Qpointer
, w
->contents
);
29267 else if (BUFFERP (obj
)
29270 pointer
= Fget_text_property (make_number (charpos
),
29274 #endif /* HAVE_WINDOW_SYSTEM */
29278 current_buffer
= obuf
;
29283 #ifdef HAVE_WINDOW_SYSTEM
29284 if (FRAME_WINDOW_P (f
))
29285 define_frame_cursor1 (f
, cursor
, pointer
);
29287 /* This is here to prevent a compiler error, about "label at end of
29288 compound statement". */
29295 Clear any mouse-face on window W. This function is part of the
29296 redisplay interface, and is called from try_window_id and similar
29297 functions to ensure the mouse-highlight is off. */
29300 x_clear_window_mouse_face (struct window
*w
)
29302 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29303 Lisp_Object window
;
29306 XSETWINDOW (window
, w
);
29307 if (EQ (window
, hlinfo
->mouse_face_window
))
29308 clear_mouse_face (hlinfo
);
29314 Just discard the mouse face information for frame F, if any.
29315 This is used when the size of F is changed. */
29318 cancel_mouse_face (struct frame
*f
)
29320 Lisp_Object window
;
29321 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29323 window
= hlinfo
->mouse_face_window
;
29324 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29325 reset_mouse_highlight (hlinfo
);
29330 /***********************************************************************
29332 ***********************************************************************/
29334 #ifdef HAVE_WINDOW_SYSTEM
29336 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29337 which intersects rectangle R. R is in window-relative coordinates. */
29340 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29341 enum glyph_row_area area
)
29343 struct glyph
*first
= row
->glyphs
[area
];
29344 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29345 struct glyph
*last
;
29346 int first_x
, start_x
, x
;
29348 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29349 /* If row extends face to end of line write the whole line. */
29350 draw_glyphs (w
, 0, row
, area
,
29351 0, row
->used
[area
],
29352 DRAW_NORMAL_TEXT
, 0);
29355 /* Set START_X to the window-relative start position for drawing glyphs of
29356 AREA. The first glyph of the text area can be partially visible.
29357 The first glyphs of other areas cannot. */
29358 start_x
= window_box_left_offset (w
, area
);
29360 if (area
== TEXT_AREA
)
29363 /* Find the first glyph that must be redrawn. */
29365 && x
+ first
->pixel_width
< r
->x
)
29367 x
+= first
->pixel_width
;
29371 /* Find the last one. */
29375 && x
< r
->x
+ r
->width
)
29377 x
+= last
->pixel_width
;
29383 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29384 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29385 DRAW_NORMAL_TEXT
, 0);
29390 /* Redraw the parts of the glyph row ROW on window W intersecting
29391 rectangle R. R is in window-relative coordinates. Value is
29392 non-zero if mouse-face was overwritten. */
29395 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29397 eassert (row
->enabled_p
);
29399 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29400 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29401 0, row
->used
[TEXT_AREA
],
29402 DRAW_NORMAL_TEXT
, 0);
29405 if (row
->used
[LEFT_MARGIN_AREA
])
29406 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29407 if (row
->used
[TEXT_AREA
])
29408 expose_area (w
, row
, r
, TEXT_AREA
);
29409 if (row
->used
[RIGHT_MARGIN_AREA
])
29410 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29411 draw_row_fringe_bitmaps (w
, row
);
29414 return row
->mouse_face_p
;
29418 /* Redraw those parts of glyphs rows during expose event handling that
29419 overlap other rows. Redrawing of an exposed line writes over parts
29420 of lines overlapping that exposed line; this function fixes that.
29422 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29423 row in W's current matrix that is exposed and overlaps other rows.
29424 LAST_OVERLAPPING_ROW is the last such row. */
29427 expose_overlaps (struct window
*w
,
29428 struct glyph_row
*first_overlapping_row
,
29429 struct glyph_row
*last_overlapping_row
,
29432 struct glyph_row
*row
;
29434 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29435 if (row
->overlapping_p
)
29437 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29440 if (row
->used
[LEFT_MARGIN_AREA
])
29441 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29443 if (row
->used
[TEXT_AREA
])
29444 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29446 if (row
->used
[RIGHT_MARGIN_AREA
])
29447 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29453 /* Return non-zero if W's cursor intersects rectangle R. */
29456 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29458 XRectangle cr
, result
;
29459 struct glyph
*cursor_glyph
;
29460 struct glyph_row
*row
;
29462 if (w
->phys_cursor
.vpos
>= 0
29463 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29464 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29466 && row
->cursor_in_fringe_p
)
29468 /* Cursor is in the fringe. */
29469 cr
.x
= window_box_right_offset (w
,
29470 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29471 ? RIGHT_MARGIN_AREA
29474 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29475 cr
.height
= row
->height
;
29476 return x_intersect_rectangles (&cr
, r
, &result
);
29479 cursor_glyph
= get_phys_cursor_glyph (w
);
29482 /* r is relative to W's box, but w->phys_cursor.x is relative
29483 to left edge of W's TEXT area. Adjust it. */
29484 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29485 cr
.y
= w
->phys_cursor
.y
;
29486 cr
.width
= cursor_glyph
->pixel_width
;
29487 cr
.height
= w
->phys_cursor_height
;
29488 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29489 I assume the effect is the same -- and this is portable. */
29490 return x_intersect_rectangles (&cr
, r
, &result
);
29492 /* If we don't understand the format, pretend we're not in the hot-spot. */
29498 Draw a vertical window border to the right of window W if W doesn't
29499 have vertical scroll bars. */
29502 x_draw_vertical_border (struct window
*w
)
29504 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29506 /* We could do better, if we knew what type of scroll-bar the adjacent
29507 windows (on either side) have... But we don't :-(
29508 However, I think this works ok. ++KFS 2003-04-25 */
29510 /* Redraw borders between horizontally adjacent windows. Don't
29511 do it for frames with vertical scroll bars because either the
29512 right scroll bar of a window, or the left scroll bar of its
29513 neighbor will suffice as a border. */
29514 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29517 /* Note: It is necessary to redraw both the left and the right
29518 borders, for when only this single window W is being
29520 if (!WINDOW_RIGHTMOST_P (w
)
29521 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29523 int x0
, x1
, y0
, y1
;
29525 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29528 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29531 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29534 if (!WINDOW_LEFTMOST_P (w
)
29535 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29537 int x0
, x1
, y0
, y1
;
29539 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29542 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29545 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29550 /* Draw window dividers for window W. */
29553 x_draw_right_divider (struct window
*w
)
29555 struct frame
*f
= WINDOW_XFRAME (w
);
29557 if (w
->mini
|| w
->pseudo_window_p
)
29559 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29561 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29562 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29563 int y0
= WINDOW_TOP_EDGE_Y (w
);
29564 /* The bottom divider prevails. */
29565 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29567 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29572 x_draw_bottom_divider (struct window
*w
)
29574 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29576 if (w
->mini
|| w
->pseudo_window_p
)
29578 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29580 int x0
= WINDOW_LEFT_EDGE_X (w
);
29581 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29582 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29583 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29585 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29589 /* Redraw the part of window W intersection rectangle FR. Pixel
29590 coordinates in FR are frame-relative. Call this function with
29591 input blocked. Value is non-zero if the exposure overwrites
29595 expose_window (struct window
*w
, XRectangle
*fr
)
29597 struct frame
*f
= XFRAME (w
->frame
);
29599 int mouse_face_overwritten_p
= 0;
29601 /* If window is not yet fully initialized, do nothing. This can
29602 happen when toolkit scroll bars are used and a window is split.
29603 Reconfiguring the scroll bar will generate an expose for a newly
29605 if (w
->current_matrix
== NULL
)
29608 /* When we're currently updating the window, display and current
29609 matrix usually don't agree. Arrange for a thorough display
29611 if (w
->must_be_updated_p
)
29613 SET_FRAME_GARBAGED (f
);
29617 /* Frame-relative pixel rectangle of W. */
29618 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29619 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29620 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29621 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29623 if (x_intersect_rectangles (fr
, &wr
, &r
))
29625 int yb
= window_text_bottom_y (w
);
29626 struct glyph_row
*row
;
29627 int cursor_cleared_p
, phys_cursor_on_p
;
29628 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29630 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29631 r
.x
, r
.y
, r
.width
, r
.height
));
29633 /* Convert to window coordinates. */
29634 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29635 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29637 /* Turn off the cursor. */
29638 if (!w
->pseudo_window_p
29639 && phys_cursor_in_rect_p (w
, &r
))
29641 x_clear_cursor (w
);
29642 cursor_cleared_p
= 1;
29645 cursor_cleared_p
= 0;
29647 /* If the row containing the cursor extends face to end of line,
29648 then expose_area might overwrite the cursor outside the
29649 rectangle and thus notice_overwritten_cursor might clear
29650 w->phys_cursor_on_p. We remember the original value and
29651 check later if it is changed. */
29652 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29654 /* Update lines intersecting rectangle R. */
29655 first_overlapping_row
= last_overlapping_row
= NULL
;
29656 for (row
= w
->current_matrix
->rows
;
29661 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29663 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29664 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29665 || (r
.y
>= y0
&& r
.y
< y1
)
29666 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
29668 /* A header line may be overlapping, but there is no need
29669 to fix overlapping areas for them. KFS 2005-02-12 */
29670 if (row
->overlapping_p
&& !row
->mode_line_p
)
29672 if (first_overlapping_row
== NULL
)
29673 first_overlapping_row
= row
;
29674 last_overlapping_row
= row
;
29678 if (expose_line (w
, row
, &r
))
29679 mouse_face_overwritten_p
= 1;
29682 else if (row
->overlapping_p
)
29684 /* We must redraw a row overlapping the exposed area. */
29686 ? y0
+ row
->phys_height
> r
.y
29687 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
29689 if (first_overlapping_row
== NULL
)
29690 first_overlapping_row
= row
;
29691 last_overlapping_row
= row
;
29699 /* Display the mode line if there is one. */
29700 if (WINDOW_WANTS_MODELINE_P (w
)
29701 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
29703 && row
->y
< r
.y
+ r
.height
)
29705 if (expose_line (w
, row
, &r
))
29706 mouse_face_overwritten_p
= 1;
29709 if (!w
->pseudo_window_p
)
29711 /* Fix the display of overlapping rows. */
29712 if (first_overlapping_row
)
29713 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
29716 /* Draw border between windows. */
29717 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29718 x_draw_right_divider (w
);
29720 x_draw_vertical_border (w
);
29722 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29723 x_draw_bottom_divider (w
);
29725 /* Turn the cursor on again. */
29726 if (cursor_cleared_p
29727 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
29728 update_window_cursor (w
, 1);
29732 return mouse_face_overwritten_p
;
29737 /* Redraw (parts) of all windows in the window tree rooted at W that
29738 intersect R. R contains frame pixel coordinates. Value is
29739 non-zero if the exposure overwrites mouse-face. */
29742 expose_window_tree (struct window
*w
, XRectangle
*r
)
29744 struct frame
*f
= XFRAME (w
->frame
);
29745 int mouse_face_overwritten_p
= 0;
29747 while (w
&& !FRAME_GARBAGED_P (f
))
29749 if (WINDOWP (w
->contents
))
29750 mouse_face_overwritten_p
29751 |= expose_window_tree (XWINDOW (w
->contents
), r
);
29753 mouse_face_overwritten_p
|= expose_window (w
, r
);
29755 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
29758 return mouse_face_overwritten_p
;
29763 Redisplay an exposed area of frame F. X and Y are the upper-left
29764 corner of the exposed rectangle. W and H are width and height of
29765 the exposed area. All are pixel values. W or H zero means redraw
29766 the entire frame. */
29769 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
29772 int mouse_face_overwritten_p
= 0;
29774 TRACE ((stderr
, "expose_frame "));
29776 /* No need to redraw if frame will be redrawn soon. */
29777 if (FRAME_GARBAGED_P (f
))
29779 TRACE ((stderr
, " garbaged\n"));
29783 /* If basic faces haven't been realized yet, there is no point in
29784 trying to redraw anything. This can happen when we get an expose
29785 event while Emacs is starting, e.g. by moving another window. */
29786 if (FRAME_FACE_CACHE (f
) == NULL
29787 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
29789 TRACE ((stderr
, " no faces\n"));
29793 if (w
== 0 || h
== 0)
29796 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
29797 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
29807 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
29808 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
29810 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
29811 if (WINDOWP (f
->tool_bar_window
))
29812 mouse_face_overwritten_p
29813 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
29816 #ifdef HAVE_X_WINDOWS
29818 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
29819 if (WINDOWP (f
->menu_bar_window
))
29820 mouse_face_overwritten_p
29821 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
29822 #endif /* not USE_X_TOOLKIT and not USE_GTK */
29826 /* Some window managers support a focus-follows-mouse style with
29827 delayed raising of frames. Imagine a partially obscured frame,
29828 and moving the mouse into partially obscured mouse-face on that
29829 frame. The visible part of the mouse-face will be highlighted,
29830 then the WM raises the obscured frame. With at least one WM, KDE
29831 2.1, Emacs is not getting any event for the raising of the frame
29832 (even tried with SubstructureRedirectMask), only Expose events.
29833 These expose events will draw text normally, i.e. not
29834 highlighted. Which means we must redo the highlight here.
29835 Subsume it under ``we love X''. --gerd 2001-08-15 */
29836 /* Included in Windows version because Windows most likely does not
29837 do the right thing if any third party tool offers
29838 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
29839 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
29841 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29842 if (f
== hlinfo
->mouse_face_mouse_frame
)
29844 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
29845 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
29846 clear_mouse_face (hlinfo
);
29847 note_mouse_highlight (f
, mouse_x
, mouse_y
);
29854 Determine the intersection of two rectangles R1 and R2. Return
29855 the intersection in *RESULT. Value is non-zero if RESULT is not
29859 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
29861 XRectangle
*left
, *right
;
29862 XRectangle
*upper
, *lower
;
29863 int intersection_p
= 0;
29865 /* Rearrange so that R1 is the left-most rectangle. */
29867 left
= r1
, right
= r2
;
29869 left
= r2
, right
= r1
;
29871 /* X0 of the intersection is right.x0, if this is inside R1,
29872 otherwise there is no intersection. */
29873 if (right
->x
<= left
->x
+ left
->width
)
29875 result
->x
= right
->x
;
29877 /* The right end of the intersection is the minimum of
29878 the right ends of left and right. */
29879 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
29882 /* Same game for Y. */
29884 upper
= r1
, lower
= r2
;
29886 upper
= r2
, lower
= r1
;
29888 /* The upper end of the intersection is lower.y0, if this is inside
29889 of upper. Otherwise, there is no intersection. */
29890 if (lower
->y
<= upper
->y
+ upper
->height
)
29892 result
->y
= lower
->y
;
29894 /* The lower end of the intersection is the minimum of the lower
29895 ends of upper and lower. */
29896 result
->height
= (min (lower
->y
+ lower
->height
,
29897 upper
->y
+ upper
->height
)
29899 intersection_p
= 1;
29903 return intersection_p
;
29906 #endif /* HAVE_WINDOW_SYSTEM */
29909 /***********************************************************************
29911 ***********************************************************************/
29914 syms_of_xdisp (void)
29916 Vwith_echo_area_save_vector
= Qnil
;
29917 staticpro (&Vwith_echo_area_save_vector
);
29919 Vmessage_stack
= Qnil
;
29920 staticpro (&Vmessage_stack
);
29922 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
29923 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
29925 message_dolog_marker1
= Fmake_marker ();
29926 staticpro (&message_dolog_marker1
);
29927 message_dolog_marker2
= Fmake_marker ();
29928 staticpro (&message_dolog_marker2
);
29929 message_dolog_marker3
= Fmake_marker ();
29930 staticpro (&message_dolog_marker3
);
29933 defsubr (&Sdump_frame_glyph_matrix
);
29934 defsubr (&Sdump_glyph_matrix
);
29935 defsubr (&Sdump_glyph_row
);
29936 defsubr (&Sdump_tool_bar_row
);
29937 defsubr (&Strace_redisplay
);
29938 defsubr (&Strace_to_stderr
);
29940 #ifdef HAVE_WINDOW_SYSTEM
29941 defsubr (&Stool_bar_height
);
29942 defsubr (&Slookup_image_map
);
29944 defsubr (&Sline_pixel_height
);
29945 defsubr (&Sformat_mode_line
);
29946 defsubr (&Sinvisible_p
);
29947 defsubr (&Scurrent_bidi_paragraph_direction
);
29948 defsubr (&Swindow_text_pixel_size
);
29949 defsubr (&Smove_point_visually
);
29951 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
29952 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
29953 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
29954 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
29955 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
29956 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
29957 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
29958 DEFSYM (Qeval
, "eval");
29959 DEFSYM (QCdata
, ":data");
29960 DEFSYM (Qdisplay
, "display");
29961 DEFSYM (Qspace_width
, "space-width");
29962 DEFSYM (Qraise
, "raise");
29963 DEFSYM (Qslice
, "slice");
29964 DEFSYM (Qspace
, "space");
29965 DEFSYM (Qmargin
, "margin");
29966 DEFSYM (Qpointer
, "pointer");
29967 DEFSYM (Qleft_margin
, "left-margin");
29968 DEFSYM (Qright_margin
, "right-margin");
29969 DEFSYM (Qcenter
, "center");
29970 DEFSYM (Qline_height
, "line-height");
29971 DEFSYM (QCalign_to
, ":align-to");
29972 DEFSYM (QCrelative_width
, ":relative-width");
29973 DEFSYM (QCrelative_height
, ":relative-height");
29974 DEFSYM (QCeval
, ":eval");
29975 DEFSYM (QCpropertize
, ":propertize");
29976 DEFSYM (QCfile
, ":file");
29977 DEFSYM (Qfontified
, "fontified");
29978 DEFSYM (Qfontification_functions
, "fontification-functions");
29979 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
29980 DEFSYM (Qescape_glyph
, "escape-glyph");
29981 DEFSYM (Qnobreak_space
, "nobreak-space");
29982 DEFSYM (Qimage
, "image");
29983 DEFSYM (Qtext
, "text");
29984 DEFSYM (Qboth
, "both");
29985 DEFSYM (Qboth_horiz
, "both-horiz");
29986 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
29987 DEFSYM (QCmap
, ":map");
29988 DEFSYM (QCpointer
, ":pointer");
29989 DEFSYM (Qrect
, "rect");
29990 DEFSYM (Qcircle
, "circle");
29991 DEFSYM (Qpoly
, "poly");
29992 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
29993 DEFSYM (Qgrow_only
, "grow-only");
29994 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
29995 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
29996 DEFSYM (Qposition
, "position");
29997 DEFSYM (Qbuffer_position
, "buffer-position");
29998 DEFSYM (Qobject
, "object");
29999 DEFSYM (Qbar
, "bar");
30000 DEFSYM (Qhbar
, "hbar");
30001 DEFSYM (Qbox
, "box");
30002 DEFSYM (Qhollow
, "hollow");
30003 DEFSYM (Qhand
, "hand");
30004 DEFSYM (Qarrow
, "arrow");
30005 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30007 list_of_error
= list1 (list2 (intern_c_string ("error"),
30008 intern_c_string ("void-variable")));
30009 staticpro (&list_of_error
);
30011 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30012 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30013 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30014 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30016 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30017 staticpro (&echo_buffer
[0]);
30018 staticpro (&echo_buffer
[1]);
30020 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30021 staticpro (&echo_area_buffer
[0]);
30022 staticpro (&echo_area_buffer
[1]);
30024 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30025 staticpro (&Vmessages_buffer_name
);
30027 mode_line_proptrans_alist
= Qnil
;
30028 staticpro (&mode_line_proptrans_alist
);
30029 mode_line_string_list
= Qnil
;
30030 staticpro (&mode_line_string_list
);
30031 mode_line_string_face
= Qnil
;
30032 staticpro (&mode_line_string_face
);
30033 mode_line_string_face_prop
= Qnil
;
30034 staticpro (&mode_line_string_face_prop
);
30035 Vmode_line_unwind_vector
= Qnil
;
30036 staticpro (&Vmode_line_unwind_vector
);
30038 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30040 help_echo_string
= Qnil
;
30041 staticpro (&help_echo_string
);
30042 help_echo_object
= Qnil
;
30043 staticpro (&help_echo_object
);
30044 help_echo_window
= Qnil
;
30045 staticpro (&help_echo_window
);
30046 previous_help_echo_string
= Qnil
;
30047 staticpro (&previous_help_echo_string
);
30048 help_echo_pos
= -1;
30050 DEFSYM (Qright_to_left
, "right-to-left");
30051 DEFSYM (Qleft_to_right
, "left-to-right");
30053 #ifdef HAVE_WINDOW_SYSTEM
30054 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30055 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30056 For example, if a block cursor is over a tab, it will be drawn as
30057 wide as that tab on the display. */);
30058 x_stretch_cursor_p
= 0;
30061 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30062 doc
: /* Non-nil means highlight trailing whitespace.
30063 The face used for trailing whitespace is `trailing-whitespace'. */);
30064 Vshow_trailing_whitespace
= Qnil
;
30066 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30067 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30068 If the value is t, Emacs highlights non-ASCII chars which have the
30069 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30070 or `escape-glyph' face respectively.
30072 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30073 U+2011 (non-breaking hyphen) are affected.
30075 Any other non-nil value means to display these characters as a escape
30076 glyph followed by an ordinary space or hyphen.
30078 A value of nil means no special handling of these characters. */);
30079 Vnobreak_char_display
= Qt
;
30081 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30082 doc
: /* The pointer shape to show in void text areas.
30083 A value of nil means to show the text pointer. Other options are `arrow',
30084 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30085 Vvoid_text_area_pointer
= Qarrow
;
30087 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30088 doc
: /* Non-nil means don't actually do any redisplay.
30089 This is used for internal purposes. */);
30090 Vinhibit_redisplay
= Qnil
;
30092 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30093 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30094 Vglobal_mode_string
= Qnil
;
30096 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30097 doc
: /* Marker for where to display an arrow on top of the buffer text.
30098 This must be the beginning of a line in order to work.
30099 See also `overlay-arrow-string'. */);
30100 Voverlay_arrow_position
= Qnil
;
30102 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30103 doc
: /* String to display as an arrow in non-window frames.
30104 See also `overlay-arrow-position'. */);
30105 Voverlay_arrow_string
= build_pure_c_string ("=>");
30107 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30108 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30109 The symbols on this list are examined during redisplay to determine
30110 where to display overlay arrows. */);
30111 Voverlay_arrow_variable_list
30112 = list1 (intern_c_string ("overlay-arrow-position"));
30114 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30115 doc
: /* The number of lines to try scrolling a window by when point moves out.
30116 If that fails to bring point back on frame, point is centered instead.
30117 If this is zero, point is always centered after it moves off frame.
30118 If you want scrolling to always be a line at a time, you should set
30119 `scroll-conservatively' to a large value rather than set this to 1. */);
30121 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30122 doc
: /* Scroll up to this many lines, to bring point back on screen.
30123 If point moves off-screen, redisplay will scroll by up to
30124 `scroll-conservatively' lines in order to bring point just barely
30125 onto the screen again. If that cannot be done, then redisplay
30126 recenters point as usual.
30128 If the value is greater than 100, redisplay will never recenter point,
30129 but will always scroll just enough text to bring point into view, even
30130 if you move far away.
30132 A value of zero means always recenter point if it moves off screen. */);
30133 scroll_conservatively
= 0;
30135 DEFVAR_INT ("scroll-margin", scroll_margin
,
30136 doc
: /* Number of lines of margin at the top and bottom of a window.
30137 Recenter the window whenever point gets within this many lines
30138 of the top or bottom of the window. */);
30141 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30142 doc
: /* Pixels per inch value for non-window system displays.
30143 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30144 Vdisplay_pixels_per_inch
= make_float (72.0);
30147 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30150 DEFVAR_LISP ("truncate-partial-width-windows",
30151 Vtruncate_partial_width_windows
,
30152 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30153 For an integer value, truncate lines in each window narrower than the
30154 full frame width, provided the window width is less than that integer;
30155 otherwise, respect the value of `truncate-lines'.
30157 For any other non-nil value, truncate lines in all windows that do
30158 not span the full frame width.
30160 A value of nil means to respect the value of `truncate-lines'.
30162 If `word-wrap' is enabled, you might want to reduce this. */);
30163 Vtruncate_partial_width_windows
= make_number (50);
30165 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30166 doc
: /* Maximum buffer size for which line number should be displayed.
30167 If the buffer is bigger than this, the line number does not appear
30168 in the mode line. A value of nil means no limit. */);
30169 Vline_number_display_limit
= Qnil
;
30171 DEFVAR_INT ("line-number-display-limit-width",
30172 line_number_display_limit_width
,
30173 doc
: /* Maximum line width (in characters) for line number display.
30174 If the average length of the lines near point is bigger than this, then the
30175 line number may be omitted from the mode line. */);
30176 line_number_display_limit_width
= 200;
30178 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30179 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30180 highlight_nonselected_windows
= 0;
30182 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30183 doc
: /* Non-nil if more than one frame is visible on this display.
30184 Minibuffer-only frames don't count, but iconified frames do.
30185 This variable is not guaranteed to be accurate except while processing
30186 `frame-title-format' and `icon-title-format'. */);
30188 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30189 doc
: /* Template for displaying the title bar of visible frames.
30190 \(Assuming the window manager supports this feature.)
30192 This variable has the same structure as `mode-line-format', except that
30193 the %c and %l constructs are ignored. It is used only on frames for
30194 which no explicit name has been set \(see `modify-frame-parameters'). */);
30196 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30197 doc
: /* Template for displaying the title bar of an iconified frame.
30198 \(Assuming the window manager supports this feature.)
30199 This variable has the same structure as `mode-line-format' (which see),
30200 and is used only on frames for which no explicit name has been set
30201 \(see `modify-frame-parameters'). */);
30203 = Vframe_title_format
30204 = listn (CONSTYPE_PURE
, 3,
30205 intern_c_string ("multiple-frames"),
30206 build_pure_c_string ("%b"),
30207 listn (CONSTYPE_PURE
, 4,
30208 empty_unibyte_string
,
30209 intern_c_string ("invocation-name"),
30210 build_pure_c_string ("@"),
30211 intern_c_string ("system-name")));
30213 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30214 doc
: /* Maximum number of lines to keep in the message log buffer.
30215 If nil, disable message logging. If t, log messages but don't truncate
30216 the buffer when it becomes large. */);
30217 Vmessage_log_max
= make_number (1000);
30219 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30220 doc
: /* Functions called before redisplay, if window sizes have changed.
30221 The value should be a list of functions that take one argument.
30222 Just before redisplay, for each frame, if any of its windows have changed
30223 size since the last redisplay, or have been split or deleted,
30224 all the functions in the list are called, with the frame as argument. */);
30225 Vwindow_size_change_functions
= Qnil
;
30227 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30228 doc
: /* List of functions to call before redisplaying a window with scrolling.
30229 Each function is called with two arguments, the window and its new
30230 display-start position. Note that these functions are also called by
30231 `set-window-buffer'. Also note that the value of `window-end' is not
30232 valid when these functions are called.
30234 Warning: Do not use this feature to alter the way the window
30235 is scrolled. It is not designed for that, and such use probably won't
30237 Vwindow_scroll_functions
= Qnil
;
30239 DEFVAR_LISP ("window-text-change-functions",
30240 Vwindow_text_change_functions
,
30241 doc
: /* Functions to call in redisplay when text in the window might change. */);
30242 Vwindow_text_change_functions
= Qnil
;
30244 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30245 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30246 Each function is called with two arguments, the window and the end trigger value.
30247 See `set-window-redisplay-end-trigger'. */);
30248 Vredisplay_end_trigger_functions
= Qnil
;
30250 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30251 doc
: /* Non-nil means autoselect window with mouse pointer.
30252 If nil, do not autoselect windows.
30253 A positive number means delay autoselection by that many seconds: a
30254 window is autoselected only after the mouse has remained in that
30255 window for the duration of the delay.
30256 A negative number has a similar effect, but causes windows to be
30257 autoselected only after the mouse has stopped moving. \(Because of
30258 the way Emacs compares mouse events, you will occasionally wait twice
30259 that time before the window gets selected.\)
30260 Any other value means to autoselect window instantaneously when the
30261 mouse pointer enters it.
30263 Autoselection selects the minibuffer only if it is active, and never
30264 unselects the minibuffer if it is active.
30266 When customizing this variable make sure that the actual value of
30267 `focus-follows-mouse' matches the behavior of your window manager. */);
30268 Vmouse_autoselect_window
= Qnil
;
30270 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30271 doc
: /* Non-nil means automatically resize tool-bars.
30272 This dynamically changes the tool-bar's height to the minimum height
30273 that is needed to make all tool-bar items visible.
30274 If value is `grow-only', the tool-bar's height is only increased
30275 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30276 Vauto_resize_tool_bars
= Qt
;
30278 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30279 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30280 auto_raise_tool_bar_buttons_p
= 1;
30282 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30283 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30284 make_cursor_line_fully_visible_p
= 1;
30286 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30287 doc
: /* Border below tool-bar in pixels.
30288 If an integer, use it as the height of the border.
30289 If it is one of `internal-border-width' or `border-width', use the
30290 value of the corresponding frame parameter.
30291 Otherwise, no border is added below the tool-bar. */);
30292 Vtool_bar_border
= Qinternal_border_width
;
30294 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30295 doc
: /* Margin around tool-bar buttons in pixels.
30296 If an integer, use that for both horizontal and vertical margins.
30297 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30298 HORZ specifying the horizontal margin, and VERT specifying the
30299 vertical margin. */);
30300 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30302 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30303 doc
: /* Relief thickness of tool-bar buttons. */);
30304 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30306 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30307 doc
: /* Tool bar style to use.
30309 image - show images only
30310 text - show text only
30311 both - show both, text below image
30312 both-horiz - show text to the right of the image
30313 text-image-horiz - show text to the left of the image
30314 any other - use system default or image if no system default.
30316 This variable only affects the GTK+ toolkit version of Emacs. */);
30317 Vtool_bar_style
= Qnil
;
30319 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30320 doc
: /* Maximum number of characters a label can have to be shown.
30321 The tool bar style must also show labels for this to have any effect, see
30322 `tool-bar-style'. */);
30323 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30325 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30326 doc
: /* List of functions to call to fontify regions of text.
30327 Each function is called with one argument POS. Functions must
30328 fontify a region starting at POS in the current buffer, and give
30329 fontified regions the property `fontified'. */);
30330 Vfontification_functions
= Qnil
;
30331 Fmake_variable_buffer_local (Qfontification_functions
);
30333 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30334 unibyte_display_via_language_environment
,
30335 doc
: /* Non-nil means display unibyte text according to language environment.
30336 Specifically, this means that raw bytes in the range 160-255 decimal
30337 are displayed by converting them to the equivalent multibyte characters
30338 according to the current language environment. As a result, they are
30339 displayed according to the current fontset.
30341 Note that this variable affects only how these bytes are displayed,
30342 but does not change the fact they are interpreted as raw bytes. */);
30343 unibyte_display_via_language_environment
= 0;
30345 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30346 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30347 If a float, it specifies a fraction of the mini-window frame's height.
30348 If an integer, it specifies a number of lines. */);
30349 Vmax_mini_window_height
= make_float (0.25);
30351 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30352 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30353 A value of nil means don't automatically resize mini-windows.
30354 A value of t means resize them to fit the text displayed in them.
30355 A value of `grow-only', the default, means let mini-windows grow only;
30356 they return to their normal size when the minibuffer is closed, or the
30357 echo area becomes empty. */);
30358 Vresize_mini_windows
= Qgrow_only
;
30360 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30361 doc
: /* Alist specifying how to blink the cursor off.
30362 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30363 `cursor-type' frame-parameter or variable equals ON-STATE,
30364 comparing using `equal', Emacs uses OFF-STATE to specify
30365 how to blink it off. ON-STATE and OFF-STATE are values for
30366 the `cursor-type' frame parameter.
30368 If a frame's ON-STATE has no entry in this list,
30369 the frame's other specifications determine how to blink the cursor off. */);
30370 Vblink_cursor_alist
= Qnil
;
30372 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30373 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30374 If non-nil, windows are automatically scrolled horizontally to make
30375 point visible. */);
30376 automatic_hscrolling_p
= 1;
30377 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30379 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30380 doc
: /* How many columns away from the window edge point is allowed to get
30381 before automatic hscrolling will horizontally scroll the window. */);
30382 hscroll_margin
= 5;
30384 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30385 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30386 When point is less than `hscroll-margin' columns from the window
30387 edge, automatic hscrolling will scroll the window by the amount of columns
30388 determined by this variable. If its value is a positive integer, scroll that
30389 many columns. If it's a positive floating-point number, it specifies the
30390 fraction of the window's width to scroll. If it's nil or zero, point will be
30391 centered horizontally after the scroll. Any other value, including negative
30392 numbers, are treated as if the value were zero.
30394 Automatic hscrolling always moves point outside the scroll margin, so if
30395 point was more than scroll step columns inside the margin, the window will
30396 scroll more than the value given by the scroll step.
30398 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30399 and `scroll-right' overrides this variable's effect. */);
30400 Vhscroll_step
= make_number (0);
30402 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30403 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30404 Bind this around calls to `message' to let it take effect. */);
30405 message_truncate_lines
= 0;
30407 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30408 doc
: /* Normal hook run to update the menu bar definitions.
30409 Redisplay runs this hook before it redisplays the menu bar.
30410 This is used to update menus such as Buffers, whose contents depend on
30412 Vmenu_bar_update_hook
= Qnil
;
30414 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30415 doc
: /* Frame for which we are updating a menu.
30416 The enable predicate for a menu binding should check this variable. */);
30417 Vmenu_updating_frame
= Qnil
;
30419 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30420 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30421 inhibit_menubar_update
= 0;
30423 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30424 doc
: /* Prefix prepended to all continuation lines at display time.
30425 The value may be a string, an image, or a stretch-glyph; it is
30426 interpreted in the same way as the value of a `display' text property.
30428 This variable is overridden by any `wrap-prefix' text or overlay
30431 To add a prefix to non-continuation lines, use `line-prefix'. */);
30432 Vwrap_prefix
= Qnil
;
30433 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30434 Fmake_variable_buffer_local (Qwrap_prefix
);
30436 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30437 doc
: /* Prefix prepended to all non-continuation lines at display time.
30438 The value may be a string, an image, or a stretch-glyph; it is
30439 interpreted in the same way as the value of a `display' text property.
30441 This variable is overridden by any `line-prefix' text or overlay
30444 To add a prefix to continuation lines, use `wrap-prefix'. */);
30445 Vline_prefix
= Qnil
;
30446 DEFSYM (Qline_prefix
, "line-prefix");
30447 Fmake_variable_buffer_local (Qline_prefix
);
30449 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30450 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30451 inhibit_eval_during_redisplay
= 0;
30453 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30454 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30455 inhibit_free_realized_faces
= 0;
30458 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30459 doc
: /* Inhibit try_window_id display optimization. */);
30460 inhibit_try_window_id
= 0;
30462 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30463 doc
: /* Inhibit try_window_reusing display optimization. */);
30464 inhibit_try_window_reusing
= 0;
30466 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30467 doc
: /* Inhibit try_cursor_movement display optimization. */);
30468 inhibit_try_cursor_movement
= 0;
30469 #endif /* GLYPH_DEBUG */
30471 DEFVAR_INT ("overline-margin", overline_margin
,
30472 doc
: /* Space between overline and text, in pixels.
30473 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30474 margin to the character height. */);
30475 overline_margin
= 2;
30477 DEFVAR_INT ("underline-minimum-offset",
30478 underline_minimum_offset
,
30479 doc
: /* Minimum distance between baseline and underline.
30480 This can improve legibility of underlined text at small font sizes,
30481 particularly when using variable `x-use-underline-position-properties'
30482 with fonts that specify an UNDERLINE_POSITION relatively close to the
30483 baseline. The default value is 1. */);
30484 underline_minimum_offset
= 1;
30486 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30487 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30488 This feature only works when on a window system that can change
30489 cursor shapes. */);
30490 display_hourglass_p
= 1;
30492 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30493 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30494 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30496 #ifdef HAVE_WINDOW_SYSTEM
30497 hourglass_atimer
= NULL
;
30498 hourglass_shown_p
= 0;
30499 #endif /* HAVE_WINDOW_SYSTEM */
30501 DEFSYM (Qglyphless_char
, "glyphless-char");
30502 DEFSYM (Qhex_code
, "hex-code");
30503 DEFSYM (Qempty_box
, "empty-box");
30504 DEFSYM (Qthin_space
, "thin-space");
30505 DEFSYM (Qzero_width
, "zero-width");
30507 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30508 doc
: /* Function run just before redisplay.
30509 It is called with one argument, which is the set of windows that are to
30510 be redisplayed. This set can be nil (meaning, only the selected window),
30511 or t (meaning all windows). */);
30512 Vpre_redisplay_function
= intern ("ignore");
30514 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30515 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30517 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30518 doc
: /* Char-table defining glyphless characters.
30519 Each element, if non-nil, should be one of the following:
30520 an ASCII acronym string: display this string in a box
30521 `hex-code': display the hexadecimal code of a character in a box
30522 `empty-box': display as an empty box
30523 `thin-space': display as 1-pixel width space
30524 `zero-width': don't display
30525 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30526 display method for graphical terminals and text terminals respectively.
30527 GRAPHICAL and TEXT should each have one of the values listed above.
30529 The char-table has one extra slot to control the display of a character for
30530 which no font is found. This slot only takes effect on graphical terminals.
30531 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30532 `thin-space'. The default is `empty-box'.
30534 If a character has a non-nil entry in an active display table, the
30535 display table takes effect; in this case, Emacs does not consult
30536 `glyphless-char-display' at all. */);
30537 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30538 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30541 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30542 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30543 Vdebug_on_message
= Qnil
;
30545 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30547 Vredisplay__all_windows_cause
30548 = Fmake_vector (make_number (100), make_number (0));
30550 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30552 Vredisplay__mode_lines_cause
30553 = Fmake_vector (make_number (100), make_number (0));
30557 /* Initialize this module when Emacs starts. */
30562 CHARPOS (this_line_start_pos
) = 0;
30564 if (!noninteractive
)
30566 struct window
*m
= XWINDOW (minibuf_window
);
30567 Lisp_Object frame
= m
->frame
;
30568 struct frame
*f
= XFRAME (frame
);
30569 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30570 struct window
*r
= XWINDOW (root
);
30573 echo_area_window
= minibuf_window
;
30575 r
->top_line
= FRAME_TOP_MARGIN (f
);
30576 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30577 r
->total_cols
= FRAME_COLS (f
);
30578 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30579 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30580 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30582 m
->top_line
= FRAME_LINES (f
) - 1;
30583 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30584 m
->total_cols
= FRAME_COLS (f
);
30585 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30586 m
->total_lines
= 1;
30587 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30589 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30590 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30591 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30593 /* The default ellipsis glyphs `...'. */
30594 for (i
= 0; i
< 3; ++i
)
30595 default_invis_vector
[i
] = make_number ('.');
30599 /* Allocate the buffer for frame titles.
30600 Also used for `format-mode-line'. */
30602 mode_line_noprop_buf
= xmalloc (size
);
30603 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30604 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30605 mode_line_target
= MODE_LINE_DISPLAY
;
30608 help_echo_showing_p
= 0;
30611 #ifdef HAVE_WINDOW_SYSTEM
30613 /* Platform-independent portion of hourglass implementation. */
30615 /* Cancel a currently active hourglass timer, and start a new one. */
30617 start_hourglass (void)
30619 struct timespec delay
;
30621 cancel_hourglass ();
30623 if (INTEGERP (Vhourglass_delay
)
30624 && XINT (Vhourglass_delay
) > 0)
30625 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30626 TYPE_MAXIMUM (time_t)),
30628 else if (FLOATP (Vhourglass_delay
)
30629 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30630 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30632 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30636 extern void w32_note_current_window (void);
30637 w32_note_current_window ();
30639 #endif /* HAVE_NTGUI */
30641 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30642 show_hourglass
, NULL
);
30646 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30649 cancel_hourglass (void)
30651 if (hourglass_atimer
)
30653 cancel_atimer (hourglass_atimer
);
30654 hourglass_atimer
= NULL
;
30657 if (hourglass_shown_p
)
30661 #endif /* HAVE_WINDOW_SYSTEM */